/*
    * SPDX-FileCopyrightText: Copyright (c) 2011-2026 Yegor Bugayenko
    * SPDX-License-Identifier: MIT
    */
   package com.qulice.pmd;
   
   import com.jcabi.log.Logger;
   import com.qulice.spi.Environment;
   import com.qulice.spi.Relative;
  import com.qulice.spi.ResourceValidator;
  import com.qulice.spi.Violation;
  import java.io.File;
  import java.util.Collection;
  import java.util.LinkedList;
  import java.util.Locale;
  
  /**
   * Validates source code with PMD.
   * @since 0.3
   */
  public final class PmdValidator implements ResourceValidator {
  
      /**
       * Environment to use.
       */
      private final transient Environment env;
  
      /**
       * Constructor.
       * @param env Environment to use
       */
      public PmdValidator(final Environment env) {
          this.env = env;
      }
  
      @Override
      public Collection<Violation> validate(final Collection<File> files) {
          final Collection<File> sources = this.getNonExcludedFiles(files);
          final Collection<Violation> violations = new LinkedList<>();
          if (sources.isEmpty()) {
              Logger.debug(
                  this,
                  "No files to check with PMD, all %d are excluded",
                  files.size()
              );
          } else {
              final SourceValidator validator = new SourceValidator(this.env.encoding());
              final Collection<PmdError> errors = validator.validate(
                  sources, this.env.basedir().getPath()
              );
              for (final PmdError error : errors) {
                  violations.add(
                      new Violation.Default(
                          this.name(),
                          error.name(),
                          error.fileName(),
                          error.lines(),
                          error.description()
                      )
                  );
              }
          }
          return violations;
      }
  
      @Override
      public String name() {
          return "PMD";
      }
  
      /**
       * Filters out excluded files from further validation.
       * @param files Files to validate
       * @return Relevant source files
       */
      public Collection<File> getNonExcludedFiles(final Collection<File> files) {
          final Collection<File> sources = new LinkedList<>();
          for (final File file : files) {
              final String name = new Relative(this.env.basedir(), file).path();
              if (this.env.exclude("pmd", name)) {
                  continue;
              }
              if (!name.toLowerCase(Locale.ROOT).endsWith(".java")) {
                  continue;
              }
              sources.add(file);
          }
          return sources;
      }
  }