packwerk 2.2.2 → 3.0.0

data/lib/packwerk/application_validator.rb

@@ -9,234 +9,107 @@ module Packwerk
   # Checks the structure of the application and its packwerk configuration to make sure we can run a check and deliver
   # correct results.
   class ApplicationValidator
+    include Validator
     extend T::Sig
 
-    sig do
-      params(
-        config_file_path: String,
-        configuration: Configuration,
-        environment: String
-      ).void
-    end
-    def initialize(config_file_path:, configuration:, environment:)
-      @config_file_path = config_file_path
-      @configuration = configuration
-      @environment = environment
-      @package_set = T.let(PackageSet.load_all_from(@configuration.root_path, package_pathspec: package_glob),
-        PackageSet)
-    end
-
-    class Result < T::Struct
-      extend T::Sig
-
-      const :ok, T::Boolean
-      const :error_value, T.nilable(String)
-
-      sig { returns(T::Boolean) }
-      def ok?
-        ok
-      end
+    sig { params(package_set: PackageSet, configuration: Configuration).returns(Validator::Result) }
+    def check_all(package_set, configuration)
+      results = Validator.all.flat_map { |validator| validator.call(package_set, configuration) }
+      merge_results(results)
     end
 
-    sig { returns(Result) }
-    def check_all
+    sig { override.params(package_set: PackageSet, configuration: Configuration).returns(Validator::Result) }
+    def call(package_set, configuration)
       results = [
-        check_package_manifests_for_privacy,
-        check_package_manifest_syntax,
-        check_application_structure,
-        check_acyclic_graph,
-        check_package_manifest_paths,
-        check_valid_package_dependencies,
-        check_root_package_exists,
+        check_package_manifest_syntax(configuration),
+        check_application_structure(configuration),
+        check_package_manifest_paths(configuration),
+        check_root_package_exists(configuration),
       ]
 
-      merge_results(results)
+      merge_results(results, separator: "\n❓ ")
     end
 
-    sig { returns(Result) }
-    def check_package_manifests_for_privacy
-      privacy_settings = package_manifests_settings_for("enforce_privacy")
-
-      resolver = ConstantResolver.new(
-        root_path: @configuration.root_path,
-        load_paths: @configuration.load_paths
-      )
-
-      results = T.let([], T::Array[Result])
-
-      privacy_settings.each do |config_file_path, setting|
-        next unless setting.is_a?(Array)
-
-        constants = setting
-
-        results += assert_constants_can_be_loaded(constants, config_file_path)
-
-        constant_locations = constants.map { |c| [c, resolver.resolve(c)&.location] }
-
-        constant_locations.each do |name, location|
-          results << if location
-            check_private_constant_location(name, location, config_file_path)
-          else
-            private_constant_unresolvable(name, config_file_path)
-          end
-        end
-      end
-
-      merge_results(results, separator: "\n---\n")
+    sig { override.returns(T::Array[String]) }
+    def permitted_keys
+      [
+        "metadata",
+      ]
     end
 
-    sig { returns(Result) }
-    def check_package_manifest_syntax
+    sig { params(configuration: Configuration).returns(Validator::Result) }
+    def check_package_manifest_syntax(configuration)
       errors = []
 
-      package_manifests.each do |f|
-        hash = YAML.load_file(f)
+      package_manifests(configuration).each do |manifest|
+        hash = YAML.load_file(manifest)
         next unless hash
 
-        known_keys = ["enforce_privacy", "enforce_dependencies", "public_path", "dependencies", "metadata"]
+        known_keys = Validator.all.flat_map(&:permitted_keys)
         unknown_keys = hash.keys - known_keys
 
         unless unknown_keys.empty?
-          errors << "Unknown keys in #{f}: #{unknown_keys.inspect}\n"\
-            "If you think a key should be included in your package.yml, please "\
-            "open an issue in https://github.com/Shopify/packwerk"
-        end
-
-        if hash.key?("enforce_privacy")
-          unless [TrueClass, FalseClass, Array].include?(hash["enforce_privacy"].class)
-            errors << "Invalid 'enforce_privacy' option in #{f.inspect}: #{hash["enforce_privacy"].inspect}"
-          end
-        end
-
-        if hash.key?("enforce_dependencies")
-          unless [TrueClass, FalseClass].include?(hash["enforce_dependencies"].class)
-            errors << "Invalid 'enforce_dependencies' option in #{f.inspect}: #{hash["enforce_dependencies"].inspect}"
-          end
-        end
-
-        if hash.key?("public_path")
-          unless hash["public_path"].is_a?(String)
-            errors << "'public_path' option must be a string in #{f.inspect}: #{hash["public_path"].inspect}"
-          end
+          errors << "\tUnknown keys: #{unknown_keys.inspect} in #{manifest.inspect}"
         end
-
-        next unless hash.key?("dependencies")
-        next if hash["dependencies"].is_a?(Array)
-
-        errors << "Invalid 'dependencies' option in #{f.inspect}: #{hash["dependencies"].inspect}"
       end
 
       if errors.empty?
-        Result.new(ok: true)
+        Validator::Result.new(ok: true)
       else
-        Result.new(ok: false, error_value: errors.join("\n---\n"))
+        merge_results(
+          errors.map { |error| Validator::Result.new(ok: false, error_value: error) },
+          separator: "\n",
+          before_errors: "Malformed syntax in the following manifests:\n\n",
+          after_errors: "\n",
+        )
       end
     end
 
-    sig { returns(Result) }
-    def check_application_structure
+    sig { params(configuration: Configuration).returns(Validator::Result) }
+    def check_application_structure(configuration)
       resolver = ConstantResolver.new(
-        root_path: @configuration.root_path.to_s,
-        load_paths: @configuration.load_paths
+        root_path: configuration.root_path.to_s,
+        load_paths: configuration.load_paths
       )
 
       begin
         resolver.file_map
-        Result.new(ok: true)
+        Validator::Result.new(ok: true)
       rescue => e
-        Result.new(ok: false, error_value: e.message)
-      end
-    end
-
-    sig { returns(Result) }
-    def check_acyclic_graph
-      edges = @package_set.flat_map do |package|
-        package.dependencies.map { |dependency| [package, @package_set.fetch(dependency)] }
-      end
-      dependency_graph = Graph.new(*T.unsafe(edges))
-
-      cycle_strings = build_cycle_strings(dependency_graph.cycles)
-
-      if dependency_graph.acyclic?
-        Result.new(ok: true)
-      else
-        Result.new(
-          ok: false,
-          error_value: <<~EOS
-            Expected the package dependency graph to be acyclic, but it contains the following cycles:
-
-            #{cycle_strings.join("\n")}
-          EOS
-        )
+        Validator::Result.new(ok: false, error_value: e.message)
       end
     end
 
-    sig { returns(Result) }
-    def check_package_manifest_paths
-      all_package_manifests = package_manifests("**/")
-      package_paths_package_manifests = package_manifests(package_glob)
+    sig { params(configuration: Configuration).returns(Validator::Result) }
+    def check_package_manifest_paths(configuration)
+      all_package_manifests = package_manifests(configuration, "**/")
+      package_paths_package_manifests = package_manifests(configuration, package_glob(configuration))
 
       difference = all_package_manifests - package_paths_package_manifests
 
       if difference.empty?
-        Result.new(ok: true)
+        Validator::Result.new(ok: true)
       else
-        Result.new(
+        Validator::Result.new(
           ok: false,
           error_value: <<~EOS
             Expected package paths for all package.ymls to be specified, but paths were missing for the following manifests:
 
-            #{relative_paths(difference).join("\n")}
-          EOS
-        )
-      end
-    end
-
-    sig { returns(Result) }
-    def check_valid_package_dependencies
-      packages_dependencies = package_manifests_settings_for("dependencies")
-        .delete_if { |_, deps| deps.nil? }
-
-      packages_with_invalid_dependencies =
-        packages_dependencies.each_with_object([]) do |(package, dependencies), invalid_packages|
-          invalid_dependencies = dependencies.filter { |path| invalid_package_path?(path) }
-          invalid_packages << [package, invalid_dependencies] if invalid_dependencies.any?
-        end
-
-      if packages_with_invalid_dependencies.empty?
-        Result.new(ok: true)
-      else
-        error_locations = packages_with_invalid_dependencies.map do |package, invalid_dependencies|
-          package ||= @configuration.root_path
-          package_path = Pathname.new(package).relative_path_from(@configuration.root_path)
-          all_invalid_dependencies = invalid_dependencies.map { |d| "  - #{d}" }
-
-          <<~EOS
-            #{package_path}:
-            #{all_invalid_dependencies.join("\n")}
-          EOS
-        end
-
-        Result.new(
-          ok: false,
-          error_value: <<~EOS
-            These dependencies do not point to valid packages:
-
-            #{error_locations.join("\n")}
+            #{relative_paths(configuration, difference).join("\n")}
           EOS
         )
       end
     end
 
-    sig { returns(Result) }
-    def check_root_package_exists
-      root_package_path = File.join(@configuration.root_path, "package.yml")
-      all_packages_manifests = package_manifests(package_glob)
+    sig { params(configuration: Configuration).returns(Validator::Result) }
+    def check_root_package_exists(configuration)
+      root_package_path = File.join(configuration.root_path, "package.yml")
+      all_packages_manifests = package_manifests(configuration, package_glob(configuration))
 
       if all_packages_manifests.include?(root_package_path)
-        Result.new(ok: true)
+        Validator::Result.new(ok: true)
       else
-        Result.new(
+        Validator::Result.new(
           ok: false,
           error_value: <<~EOS
             A root package does not exist. Create an empty `package.yml` at the root directory.
@@ -247,120 +120,16 @@ module Packwerk
 
     private
 
-    # Convert the cycles:
-    #
-    #   [[a, b, c], [b, c]]
-    #
-    # to the string:
-    #
-    #   ["a -> b -> c -> a", "b -> c -> b"]
-    sig { params(cycles: T.untyped).returns(T::Array[String]) }
-    def build_cycle_strings(cycles)
-      cycles.map do |cycle|
-        cycle_strings = cycle.map(&:to_s)
-        cycle_strings << cycle.first.to_s
-        "\t- #{cycle_strings.join(" → ")}"
-      end
-    end
-
-    sig { params(setting: T.untyped).returns(T.untyped) }
-    def package_manifests_settings_for(setting)
-      package_manifests.map { |f| [f, (YAML.load_file(File.join(f)) || {})[setting]] }
-    end
-
     sig { params(list: T.untyped).returns(T.untyped) }
     def format_yaml_strings(list)
       list.sort.map { |p| "- \"#{p}\"" }.join("\n")
     end
 
-    sig { returns(T.any(T::Array[String], String)) }
-    def package_glob
-      @configuration.package_paths || "**"
-    end
-
-    sig { params(glob_pattern: T.any(T::Array[String], String)).returns(T::Array[String]) }
-    def package_manifests(glob_pattern = package_glob)
-      PackageSet.package_paths(@configuration.root_path, glob_pattern, @configuration.exclude)
-        .map { |f| File.realpath(f) }
-    end
-
-    sig { params(paths: T::Array[String]).returns(T::Array[Pathname]) }
-    def relative_paths(paths)
-      paths.map { |path| relative_path(path) }
-    end
-
-    sig { params(path: String).returns(Pathname) }
-    def relative_path(path)
-      Pathname.new(path).relative_path_from(@configuration.root_path)
-    end
-
-    sig { params(path: T.untyped).returns(T::Boolean) }
-    def invalid_package_path?(path)
-      # Packages at the root can be implicitly specified as "."
-      return false if path == "."
-
-      package_path = File.join(@configuration.root_path, path, PackageSet::PACKAGE_CONFIG_FILENAME)
-      !File.file?(package_path)
-    end
-
-    sig { params(constants: T.untyped, config_file_path: String).returns(T::Array[Result]) }
-    def assert_constants_can_be_loaded(constants, config_file_path)
-      constants.map do |constant|
-        if !constant.start_with?("::")
-          Result.new(
-            ok: false,
-            error_value: "'#{constant}', listed in the 'enforce_privacy' option in #{config_file_path}, is invalid.\n"\
-              "Private constants need to be prefixed with the top-level namespace operator `::`."
-          )
-        else
-          constant.try(&:constantize) && Result.new(ok: true)
-        end
-      end
-    end
-
-    sig { params(name: T.untyped, config_file_path: T.untyped).returns(Result) }
-    def private_constant_unresolvable(name, config_file_path)
-      explicit_filepath = (name.start_with?("::") ? name[2..-1] : name).underscore + ".rb"
-
-      Result.new(
-        ok: false,
-        error_value: "'#{name}', listed in #{config_file_path}, could not be resolved.\n"\
-          "This is probably because it is an autovivified namespace - a namespace module that doesn't have a\n"\
-          "file explicitly defining it. Packwerk currently doesn't support declaring autovivified namespaces as\n"\
-          "private. Add a #{explicit_filepath} file to explicitly define the constant."
-      )
-    end
-
-    sig { params(name: T.untyped, location: T.untyped, config_file_path: T.untyped).returns(Result) }
-    def check_private_constant_location(name, location, config_file_path)
-      declared_package = @package_set.package_from_path(relative_path(config_file_path))
-      constant_package = @package_set.package_from_path(location)
-
-      if constant_package == declared_package
-        Result.new(ok: true)
-      else
-        Result.new(
-          ok: false,
-          error_value: "'#{name}' is declared as private in the '#{declared_package}' package but appears to be "\
-            "defined\nin the '#{constant_package}' package. Packwerk resolved it to #{location}."
-        )
-      end
-    end
-
-    sig do
-      params(results: T::Array[Result], separator: String, errors_headline: String).returns(Result)
-    end
-    def merge_results(results, separator: "\n===\n", errors_headline: "")
-      results.reject!(&:ok?)
-
-      if results.empty?
-        Result.new(ok: true)
-      else
-        Result.new(
-          ok: false,
-          error_value: errors_headline + results.map(&:error_value).join(separator)
-        )
-      end
+    sig { params(configuration: Configuration, paths: T::Array[String]).returns(T::Array[Pathname]) }
+    def relative_paths(configuration, paths)
+      paths.map { |path| relative_path(configuration, path) }
     end
   end
+
+  private_constant :ApplicationValidator
 end

data/lib/packwerk/association_inspector.rb

@@ -70,4 +70,6 @@ module Packwerk
       NodeHelpers.literal_value(association_name_node)
     end
   end
+
+  private_constant :AssociationInspector
 end

data/lib/packwerk/cache.rb

@@ -21,10 +21,10 @@ module Packwerk
           cache_contents_json = JSON.parse(serialized_cache_contents)
           unresolved_references = cache_contents_json["unresolved_references"].map do |json|
             UnresolvedReference.new(
-              json["constant_name"],
-              json["namespace_path"],
-              json["relative_path"],
-              Node::Location.new(json["source_location"]["line"], json["source_location"]["column"],)
+              constant_name: json["constant_name"],
+              namespace_path: json["namespace_path"],
+              relative_path: json["relative_path"],
+              source_location: Node::Location.new(json["source_location"]["line"], json["source_location"]["column"],)
             )
           end
 
@@ -169,8 +169,9 @@ module Packwerk
           puts(out)
         end
       end
-  end
+    end
   end
 
+  private_constant :Cache
   private_constant :Debug
 end

data/lib/packwerk/checker.rb

@@ -0,0 +1,54 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Packwerk
+  module Checker
+    extend T::Sig
+    extend T::Helpers
+
+    abstract!
+
+    class << self
+      extend T::Sig
+
+      sig { params(base: Class).void }
+      def included(base)
+        @checkers ||= T.let(@checkers, T.nilable(T::Array[Class]))
+        @checkers ||= []
+        @checkers << base
+      end
+
+      sig { returns(T::Array[Checker]) }
+      def all
+        T.unsafe(@checkers).map(&:new)
+      end
+
+      sig { params(violation_type: String).returns(Checker) }
+      def find(violation_type)
+        checker_by_violation_type(violation_type)
+      end
+
+      private
+
+      sig { params(name: String).returns(Checker) }
+      def checker_by_violation_type(name)
+        @checker_by_violation_type ||= T.let(Checker.all.to_h do |checker|
+                                               [checker.violation_type, checker]
+                                             end, T.nilable(T::Hash[String, Checker]))
+        @checker_by_violation_type.fetch(name)
+      end
+    end
+
+    sig { abstract.returns(String) }
+    def violation_type; end
+
+    sig { abstract.params(listed_offense: ReferenceOffense).returns(T::Boolean) }
+    def strict_mode_violation?(listed_offense); end
+
+    sig { abstract.params(reference: Reference).returns(T::Boolean) }
+    def invalid_reference?(reference); end
+
+    sig { abstract.params(reference: Reference).returns(String) }
+    def message(reference); end
+  end
+end

data/lib/packwerk/cli/result.rb

@@ -0,0 +1,11 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Packwerk
+  class Cli
+    class Result < T::Struct
+      const :message, String
+      const :status, T::Boolean
+    end
+  end
+end

data/lib/packwerk/cli.rb

@@ -14,8 +14,8 @@ module Packwerk
         out: T.any(StringIO, IO),
         err_out: T.any(StringIO, IO),
         environment: String,
-        style: Packwerk::OutputStyle,
-        offenses_formatter: T.nilable(Packwerk::OffensesFormatter)
+        style: OutputStyle,
+        offenses_formatter: T.nilable(OffensesFormatter)
       ).void
     end
     def initialize(
@@ -33,7 +33,7 @@ module Packwerk
       @configuration = T.let(configuration || Configuration.from_path, Configuration)
       @progress_formatter = T.let(Formatters::ProgressFormatter.new(@out, style: style), Formatters::ProgressFormatter)
       @offenses_formatter = T.let(
-        offenses_formatter || Formatters::OffensesFormatter.new(style: @style),
+        offenses_formatter || @configuration.offenses_formatter,
         OffensesFormatter
       )
     end
@@ -52,12 +52,13 @@ module Packwerk
         init
       when "check"
         output_result(parse_run(args).check)
-      when "detect-stale-violations"
-        output_result(parse_run(args).detect_stale_violations)
-      when "update-deprecations"
-        output_result(parse_run(args).update_deprecations)
+      when "update-todo", "update"
+        output_result(parse_run(args).update_todo)
       when "validate"
         validate(args)
+      when "version"
+        @out.puts(Packwerk::VERSION)
+        true
       when nil, "help"
         usage
       else
@@ -79,12 +80,12 @@ module Packwerk
 
     sig { returns(T::Boolean) }
     def generate_configs
-      configuration_file = Packwerk::Generators::ConfigurationFile.generate(
+      configuration_file = Generators::ConfigurationFile.generate(
         root: @configuration.root_path,
         out: @out
       )
 
-      root_package = Packwerk::Generators::RootPackage.generate(root: @configuration.root_path, out: @out)
+      root_package = Generators::RootPackage.generate(root: @configuration.root_path, out: @out)
 
       success = configuration_file && root_package
 
@@ -114,8 +115,9 @@ module Packwerk
         Subcommands:
           init - set up packwerk
           check - run all checks
-          update-deprecations - update deprecated_references.yml files
+          update-todo - update package_todo.yml files
           validate - verify integrity of packwerk and package configuration
+          version - output packwerk version
           help  - display help information about packwerk
       USAGE
       true
@@ -132,72 +134,95 @@ module Packwerk
       params(
         relative_file_paths: T::Array[String],
         ignore_nested_packages: T::Boolean
-      ).returns(FilesForProcessing::RelativeFileSet)
+      ).returns(FilesForProcessing)
     end
     def fetch_files_to_process(relative_file_paths, ignore_nested_packages)
-      relative_file_set = FilesForProcessing.fetch(
+      files_for_processing = FilesForProcessing.fetch(
         relative_file_paths: relative_file_paths,
         ignore_nested_packages: ignore_nested_packages,
         configuration: @configuration
       )
-      abort("No files found or given. "\
-        "Specify files or check the include and exclude glob in the config file.") if relative_file_set.empty?
-      relative_file_set
+      @out.puts(<<~MSG.squish) if files_for_processing.files.empty?
+        No files found or given.
+        Specify files or check the include and exclude glob in the config file.
+      MSG
+
+      files_for_processing
     end
 
     sig { params(_paths: T::Array[String]).returns(T::Boolean) }
     def validate(_paths)
+      result = T.let(nil, T.nilable(Validator::Result))
+
       @progress_formatter.started_validation do
-        result = checker.check_all
+        result = validator.check_all(package_set, @configuration)
 
         list_validation_errors(result)
-
-        return result.ok?
       end
+
+      T.must(result).ok?
     end
 
     sig { returns(ApplicationValidator) }
-    def checker
-      Packwerk::ApplicationValidator.new(
-        config_file_path: @configuration.config_path,
-        configuration: @configuration,
-        environment: @environment,
+    def validator
+      ApplicationValidator.new
+    end
+
+    sig { returns(PackageSet) }
+    def package_set
+      PackageSet.load_all_from(
+        @configuration.root_path,
+        package_pathspec: @configuration.package_paths
       )
     end
 
-    sig { params(result: ApplicationValidator::Result).void }
+    sig { params(result: Validator::Result).void }
     def list_validation_errors(result)
       @out.puts
       if result.ok?
         @out.puts("Validation successful 🎉")
       else
         @out.puts("Validation failed ❗")
+        @out.puts
         @out.puts(result.error_value)
       end
     end
 
-    sig { params(params: T.untyped).returns(ParseRun) }
-    def parse_run(params)
+    sig { params(args: T::Array[String]).returns(ParseRun) }
+    def parse_run(args)
       relative_file_paths = T.let([], T::Array[String])
       ignore_nested_packages = nil
+      formatter = @offenses_formatter
 
-      if params.any? { |p| p.include?("--packages") }
+      if args.any? { |arg| arg.include?("--packages") }
         OptionParser.new do |parser|
           parser.on("--packages=PACKAGESLIST", Array, "package names, comma separated") do |p|
             relative_file_paths = p
           end
-        end.parse!(params)
+        end.parse!(args)
         ignore_nested_packages = true
       else
-        relative_file_paths = params
+        relative_file_paths = args
         ignore_nested_packages = false
       end
 
+      if args.any? { |arg| arg.include?("--offenses-formatter") }
+        OptionParser.new do |parser|
+          parser.on("--offenses-formatter=FORMATTER", String,
+            "identifier of offenses formatter to use") do |formatter_identifier|
+            formatter = OffensesFormatter.find(formatter_identifier)
+          end
+        end.parse!(args)
+      end
+
+      files_for_processing = fetch_files_to_process(relative_file_paths, ignore_nested_packages)
+
       ParseRun.new(
-        relative_file_set: fetch_files_to_process(relative_file_paths, ignore_nested_packages),
+        relative_file_set: files_for_processing.files,
+        file_set_specified: files_for_processing.files_specified?,
         configuration: @configuration,
         progress_formatter: @progress_formatter,
-        offenses_formatter: @offenses_formatter
+        offenses_formatter: formatter
       )
     end
   end