io.codemodder.IncludesExcludes Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of codemodder-base Show documentation
Base framework for writing codemods in Java
There is a newer version: 0.98.6
package io.codemodder;

import com.google.common.annotations.VisibleForTesting;
import java.io.File;
import java.nio.file.FileSystems;
import java.util.*;

/** This is the main interaction point with types for detecting if a path should be included. */
public interface IncludesExcludes {

  /** Do we have any includes that include this file? */
  boolean shouldInspect(File file);

  /** Do we have any includes that match the file and line number? */
  LineIncludesExcludes getIncludesExcludesForFile(File file);

  class Default implements IncludesExcludes {

    private final List pathIncludes;
    private final List pathExcludes;

    public Default(final List pathIncludes, final List pathExcludes) {
      this.pathIncludes = pathIncludes;
      this.pathExcludes = pathExcludes;
    }

    @Override
    public boolean shouldInspect(final File file) {
      /*
       * Dependency manifests must always be inspected so that we can inject dependencies. If you wish to disable
       * dependency injection, you can do so by disabling the pom-changing rule (pixee:java/mvn-dependency-injection).
       */
      if ("pom.xml".equalsIgnoreCase(file.getName())) {
        return true;
      }
      if (!pathIncludes.isEmpty()) {
        for (PathMatcher pathInclude : pathIncludes) {
          if (pathInclude.matches(file)) {
            // if there is an exclude, we honor that
            for (PathMatcher pathExclude : pathExcludes) {
              if (pathExclude.matches(file)) {
                if (!pathExclude.targetsLine()) {
                  return false;
                }
              }
            }
            return true;
          }
        }
        return false;
      }

      for (PathMatcher pathExclude : pathExcludes) {
        if (!pathExclude.targetsLine() && pathExclude.matches(file)) {
          return false;
        }
      }
      return true;
    }

    @Override
    public LineIncludesExcludes getIncludesExcludesForFile(final File file) {
      final Set allowedLines = new HashSet<>();
      for (PathMatcher pathInclude : pathIncludes) {
        if (pathInclude.targetsLine()) {
          if (pathInclude.matches(file)) {
            allowedLines.add(Objects.requireNonNull(pathInclude.line()));
          }
        }
      }

      final Set disallowedLines = new HashSet<>();
      for (PathMatcher pathExclude : pathExcludes) {
        if (pathExclude.targetsLine()) {
          if (pathExclude.matches(file)) {
            disallowedLines.add(Objects.requireNonNull(pathExclude.line()));
          }
        }
      }

      if (!allowedLines.isEmpty() && !disallowedLines.isEmpty()) {
        throw new IllegalArgumentException(
            "can't have both include and exclude targetining individual lines for a file");
      }

      if (allowedLines.isEmpty() && disallowedLines.isEmpty()) {
        return new LineIncludesExcludes.MatchesEverything();
      }

      if (!allowedLines.isEmpty()) {
        return LineIncludesExcludes.fromIncludedLines(allowedLines);
      }
      return LineIncludesExcludes.fromExcludedLines(disallowedLines);
    }

    @Override
    public String toString() {
      return "Includes: " + pathIncludes + "\nExcludes: " + pathExcludes;
    }
  }

  /**
   * Create an {@link IncludesExcludes}.
   *
   * @throws NullPointerException if any value is null
   */
  static IncludesExcludes withSettings(
      final File repositoryRoot,
      final List includePatterns,
      final List excludePatterns) {

    Objects.requireNonNull(repositoryRoot, "repositoryRoot");
    Objects.requireNonNull(includePatterns, "includePatterns");
    Objects.requireNonNull(includePatterns, "excludePatterns");

    if (noPatternsSpecified(includePatterns, excludePatterns)) {
      return new MatchesEverything();
    }
    List pathIncludes = new ArrayList<>();
    List pathExcludes = new ArrayList<>();
    for (String includePattern : includePatterns) {
      pathIncludes.add(parsePattern(repositoryRoot, includePattern));
    }

    for (String excludePattern : excludePatterns) {
      pathExcludes.add(parsePattern(repositoryRoot, excludePattern));
    }

    return new Default(pathIncludes, pathExcludes);
  }

  @VisibleForTesting
  static PathMatcher parsePattern(final File repositoryRoot, String pattern) {
    // validate and sanitize
    Objects.requireNonNull(pattern);
    pattern = pattern.trim();

    // trim leading slash if user provided one
    if (!pattern.startsWith("/")) {
      pattern = "/" + pattern;
    }

    // determine if this targets a line
    int lineSeparatorIndex = pattern.indexOf(':');

    final Integer line;
    final String pathPatternPart;

    // if it targets a line, get the path and line separately
    if (lineSeparatorIndex != -1) {
      pathPatternPart = pattern.substring(0, lineSeparatorIndex);
      line = Integer.parseInt(pattern.substring(lineSeparatorIndex + 1));
    } else {
      pathPatternPart = pattern;
      line = null;
    }
    try {
      return new PathMatcher(FileSystems.getDefault(), repositoryRoot, pathPatternPart, line);
    } catch (Exception e) {
      throw new IllegalArgumentException("couldn't get canonical path", e);
    }
  }

  private static boolean noPatternsSpecified(
      final List includePatterns, final List excludePatterns) {
    return includePatterns.isEmpty() && excludePatterns.isEmpty();
  }

  /** Matches every file, indicates that the codemods should use their own filtering. */
  class MatchesEverything implements IncludesExcludes {
    @Override
    public boolean shouldInspect(final File file) {
      return true;
    }

    @Override
    public LineIncludesExcludes getIncludesExcludesForFile(final File file) {
      return new LineIncludesExcludes.MatchesEverything();
    }
  }

  /** Return an {@link IncludesExcludes} that matches all files and lines. */
  static IncludesExcludes any() {
    return new MatchesEverything();
  }
}