packwerk 1.0.2 → 1.2.0

data/dev.yml

@@ -3,7 +3,7 @@ name: packwerk
 type: ruby
 
 up:
-  - ruby: 2.6.6
+  - ruby: 3.0.0
   - bundler
 
 commands:

data/exe/packwerk

@@ -3,4 +3,4 @@
 
 require "packwerk"
 
-Packwerk::Cli.new(style: Packwerk::OutputStyles::Coloured).run(ARGV.dup)
+Packwerk::Cli.new(style: Packwerk::OutputStyles::Coloured.new).run(ARGV.dup)

data/gemfiles/Gemfile-rails-6-0

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+source("https://rubygems.org")
+
+gemspec path: ".."
+
+# Specify the same dependency sources as the application Gemfile
+
+gem("spring")
+gem("rails", '~> 6.0.0')
+gem("constant_resolver", require: false)
+gem("sorbet-runtime", require: false)
+gem("rubocop-performance", require: false)
+gem("rubocop-sorbet", require: false)
+gem("mocha", require: false)
+gem("rubocop-shopify", require: false)
+gem("tapioca", require: false)
+
+group :development do
+  gem("byebug", require: false)
+  gem("minitest-focus", require: false)
+end

data/lib/packwerk.rb

@@ -3,40 +3,79 @@
 
 require "sorbet-runtime"
 require "active_support"
-require "constant_resolver"
-
-require "packwerk/offense"
-
-require "packwerk/application_validator"
-require "packwerk/association_inspector"
-require "packwerk/checking_deprecated_references"
-require "packwerk/cli"
-require "packwerk/configuration"
-require "packwerk/const_node_inspector"
-require "packwerk/constant_discovery"
-require "packwerk/dependency_checker"
-require "packwerk/deprecated_references"
-require "packwerk/files_for_processing"
-require "packwerk/file_processor"
-require "packwerk/formatters/progress_formatter"
-require "packwerk/generators/application_validation"
-require "packwerk/generators/configuration_file"
-require "packwerk/generators/inflections_file"
-require "packwerk/generators/root_package"
-require "packwerk/graph"
-require "packwerk/inflector"
-require "packwerk/node_processor"
-require "packwerk/node_visitor"
-require "packwerk/output_styles"
-require "packwerk/package"
-require "packwerk/package_set"
-require "packwerk/parsers"
-require "packwerk/privacy_checker"
-require "packwerk/reference_extractor"
-require "packwerk/run_context"
-require "packwerk/updating_deprecated_references"
-require "packwerk/version"
-require "packwerk/violation_type"
+require "fileutils"
 
 module Packwerk
+  extend ActiveSupport::Autoload
+
+  autoload :ApplicationLoadPaths
+  autoload :ApplicationValidator
+  autoload :AssociationInspector
+  autoload :OffenseCollection
+  autoload :Checker
+  autoload :Cli
+  autoload :Configuration
+  autoload :ConstantDiscovery
+  autoload :ConstantNameInspector
+  autoload :ConstNodeInspector
+  autoload :DependencyChecker
+  autoload :DeprecatedReferences
+  autoload :FileProcessor
+  autoload :FilesForProcessing
+  autoload :Graph
+  autoload :Inflector
+  autoload :Node
+  autoload :NodeProcessor
+  autoload :NodeProcessorFactory
+  autoload :NodeVisitor
+  autoload :Offense
+  autoload :OffensesFormatter
+  autoload :OutputStyle
+  autoload :Package
+  autoload :PackageSet
+  autoload :ParsedConstantDefinitions
+  autoload :Parsers
+  autoload :ParseRun
+  autoload :PrivacyChecker
+  autoload :Reference
+  autoload :ReferenceExtractor
+  autoload :ReferenceOffense
+  autoload :Result
+  autoload :RunContext
+  autoload :Version
+  autoload :ViolationType
+
+  module Inflections
+    extend ActiveSupport::Autoload
+
+    autoload :Custom
+    autoload :Default
+  end
+
+  module OutputStyles
+    extend ActiveSupport::Autoload
+
+    autoload :Coloured
+    autoload :Plain
+  end
+
+  autoload_under "commands" do
+    autoload :OffenseProgressMarker
+  end
+
+  module Formatters
+    extend ActiveSupport::Autoload
+
+    autoload :OffensesFormatter
+    autoload :ProgressFormatter
+  end
+
+  module Generators
+    extend ActiveSupport::Autoload
+
+    autoload :ApplicationValidation
+    autoload :ConfigurationFile
+    autoload :InflectionsFile
+    autoload :RootPackage
+  end
 end

data/lib/packwerk/application_load_paths.rb

@@ -28,8 +28,9 @@ module Packwerk
           .select { |railtie| railtie.is_a?(Rails::Engine) }
           .push(Rails.application)
           .flat_map do |engine|
-          (engine.config.autoload_paths + engine.config.eager_load_paths + engine.config.autoload_once_paths).uniq
-        end
+            paths = (engine.config.autoload_paths + engine.config.eager_load_paths + engine.config.autoload_once_paths)
+            paths.map(&:to_s).uniq
+          end
       end
 
       sig do

data/lib/packwerk/application_validator.rb

@@ -6,11 +6,6 @@ require "constant_resolver"
 require "pathname"
 require "yaml"
 
-require "packwerk/package_set"
-require "packwerk/graph"
-require "packwerk/inflector"
-require "packwerk/application_load_paths"
-
 module Packwerk
   class ApplicationValidator
     def initialize(config_file_path:, configuration:)
@@ -32,19 +27,10 @@ module Packwerk
         check_acyclic_graph,
         check_package_manifest_paths,
         check_valid_package_dependencies,
-        check_root_package_exist,
+        check_root_package_exists,
       ]
 
-      results.reject!(&:ok?)
-
-      if results.empty?
-        Result.new(true)
-      else
-        Result.new(
-          false,
-          results.map(&:error_value).join("\n===\n")
-        )
-      end
+      merge_results(results)
     end
 
     def check_autoload_path_cache
@@ -65,51 +51,37 @@ module Packwerk
     def check_package_manifests_for_privacy
       privacy_settings = package_manifests_settings_for("enforce_privacy")
 
-      autoload_paths = @configuration.load_paths
-
       resolver = ConstantResolver.new(
         root_path: @configuration.root_path,
-        load_paths: autoload_paths
+        load_paths: @configuration.load_paths
       )
 
-      errors = []
+      results = []
 
-      privacy_settings.each do |filepath, setting|
+      privacy_settings.each do |config_file_path, setting|
         next unless setting.is_a?(Array)
+        constants = setting
 
-        setting.each do |constant|
-          # make sure the constant can be loaded
-          constant.constantize # rubocop:disable Sorbet/ConstantsFromStrings
-          context = resolver.resolve(constant)
-
-          unless context
-            errors << "#{constant}, listed in #{filepath.inspect}, could not be resolved"
-            next
-          end
-
-          expected_filename = constant.underscore + ".rb"
+        assert_constants_can_be_loaded(constants)
 
-          # We don't support all custom inflections yet, so we may accidentally resolve constants to the
-          # file that defines their parent namespace. This restriction makes sure that we don't.
-          next if context.location.end_with?(expected_filename)
+        constant_locations = constants.map { |c| [c, resolver.resolve(c)&.location] }
 
-          errors << "Explicitly private constants need to have their own files.\n"\
-            "#{constant}, listed in #{filepath.inspect}, was resolved to #{context.location.inspect}.\n"\
-            "It should be in something like #{expected_filename.inspect}"
+        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
 
-      if errors.empty?
-        Result.new(true)
-      else
-        Result.new(false, errors.join("\n---\n"))
-      end
+      merge_results(results, separator: "\n---\n")
     end
 
     def check_package_manifest_syntax
       errors = []
 
-      package_manifests(package_glob).each do |f|
+      package_manifests.each do |f|
         hash = YAML.load_file(f)
         next unless hash
 
@@ -124,26 +96,26 @@ module Packwerk
 
         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}"
+            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}"
+            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}"
+            errors << "'public_path' option must be a string in #{f.inspect}: #{hash["public_path"].inspect}"
           end
         end
 
         next unless hash.key?("dependencies")
         next if hash["dependencies"].is_a?(Array)
 
-        errors << "Invalid 'dependencies' option in #{f.inspect}: #{hash['dependencies'].inspect}"
+        errors << "Invalid 'dependencies' option in #{f.inspect}: #{hash["dependencies"].inspect}"
       end
 
       if errors.empty?
@@ -193,24 +165,16 @@ module Packwerk
         end
       end
 
-      errors = results.reject(&:ok?)
-
-      if errors.empty?
-        Result.new(true)
-      else
-        Result.new(
-          false,
-          "Inflections specified in #{inflections_file} don't line up with application!\n" +
-            errors.map(&:error_value).join("\n")
-        )
-      end
+      merge_results(
+        results,
+        separator: "\n",
+        errors_headline: "Inflections specified in #{inflections_file} don't line up with application!\n"
+      )
     end
 
     def check_acyclic_graph
-      packages = Packwerk::PackageSet.load_all_from(".")
-
-      edges = packages.flat_map do |package|
-        package.dependencies.map { |dependency| [package, packages.fetch(dependency)] }
+      edges = package_set.flat_map do |package|
+        package.dependencies.map { |dependency| [package, package_set.fetch(dependency)] }
       end
       dependency_graph = Packwerk::Graph.new(*edges)
 
@@ -225,7 +189,7 @@ module Packwerk
       cycle_strings = dependency_graph.cycles.map do |cycle|
         cycle_strings = cycle.map(&:to_s)
         cycle_strings << cycle.first.to_s
-        "\t- #{cycle_strings.join(' → ')}"
+        "\t- #{cycle_strings.join(" → ")}"
       end
 
       if dependency_graph.acyclic?
@@ -297,7 +261,7 @@ module Packwerk
       end
     end
 
-    def check_root_package_exist
+    def check_root_package_exists
       root_package_path = File.join(@configuration.root_path, "package.yml")
       all_packages_manifests = package_manifests(package_glob)
 
@@ -316,8 +280,7 @@ module Packwerk
     private
 
     def package_manifests_settings_for(setting)
-      package_manifests(package_glob)
-        .map { |f| [f, (YAML.load_file(File.join(f)) || {})[setting]] }
+      package_manifests.map { |f| [f, (YAML.load_file(File.join(f)) || {})[setting]] }
     end
 
     def format_yaml_strings(list)
@@ -328,13 +291,17 @@ module Packwerk
       @configuration.package_paths || "**"
     end
 
-    def package_manifests(glob_pattern)
+    def package_manifests(glob_pattern = package_glob)
       PackageSet.package_paths(@configuration.root_path, glob_pattern)
         .map { |f| File.realpath(f) }
     end
 
     def relative_paths(paths)
-      paths.map { |path| Pathname.new(path).relative_path_from(@configuration.root_path) }
+      paths.map { |path| relative_path(path) }
+    end
+
+    def relative_path(path)
+      Pathname.new(path).relative_path_from(@configuration.root_path)
     end
 
     def invalid_package_path?(path)
@@ -344,5 +311,54 @@ module Packwerk
       package_path = File.join(@configuration.root_path, path, Packwerk::PackageSet::PACKAGE_CONFIG_FILENAME)
       !File.file?(package_path)
     end
+
+    def assert_constants_can_be_loaded(constants)
+      constants.each(&:constantize)
+      nil
+    end
+
+    def private_constant_unresolvable(name, config_file_path)
+      explicit_filepath = (name.start_with?("::") ? name[2..-1] : name).underscore + ".rb"
+
+      Result.new(
+        false,
+        "'#{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
+
+    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(true)
+      else
+        Result.new(
+          false,
+          "'#{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
+
+    def package_set
+      @package_set ||= Packwerk::PackageSet.load_all_from(@configuration.root_path, package_pathspec: package_glob)
+    end
+
+    def merge_results(results, separator: "\n===\n", errors_headline: "")
+      results.reject!(&:ok?)
+
+      if results.empty?
+        Result.new(true)
+      else
+        Result.new(
+          false,
+          errors_headline + results.map(&:error_value).join(separator)
+        )
+      end
+    end
   end
 end

data/lib/packwerk/association_inspector.rb

@@ -1,26 +1,35 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
-require "packwerk/constant_name_inspector"
-require "packwerk/node"
-
 module Packwerk
   # Extracts the implicit constant reference from an active record association
   class AssociationInspector
+    extend T::Sig
     include ConstantNameInspector
 
-    RAILS_ASSOCIATIONS = %i(
-      belongs_to
-      has_many
-      has_one
-      has_and_belongs_to_many
-    ).to_set
+    CustomAssociations = T.type_alias { T.any(T::Array[Symbol], T::Set[Symbol]) }
+
+    RAILS_ASSOCIATIONS = T.let(
+      %i(
+        belongs_to
+        has_many
+        has_one
+        has_and_belongs_to_many
+      ).to_set,
+      CustomAssociations
+    )
 
+    sig { params(inflector: Inflector, custom_associations: CustomAssociations).void }
     def initialize(inflector:, custom_associations: Set.new)
       @inflector = inflector
-      @associations = RAILS_ASSOCIATIONS + custom_associations
+      @associations = T.let(RAILS_ASSOCIATIONS + custom_associations, CustomAssociations)
     end
 
+    sig do
+      override
+        .params(node: AST::Node, ancestors: T::Array[AST::Node])
+        .returns(T.nilable(String))
+    end
     def constant_name_from_node(node, ancestors:)
       return unless Node.method_call?(node)
       return unless association?(node)
@@ -38,11 +47,13 @@ module Packwerk
 
     private
 
+    sig { params(node: AST::Node).returns(T::Boolean) }
     def association?(node)
       method_name = Node.method_name(node)
       @associations.include?(method_name)
     end
 
+    sig { params(arguments: T::Array[AST::Node]).returns(T.nilable(AST::Node)) }
     def custom_class_name(arguments)
       association_options = arguments.detect { |n| Node.hash?(n) }
       return unless association_options
@@ -50,6 +61,7 @@ module Packwerk
       Node.value_from_hash(association_options, :class_name)
     end
 
+    sig { params(arguments: T::Array[AST::Node]).returns(T.any(T.nilable(Symbol), T.nilable(String))) }
     def association_name(arguments)
       return unless Node.symbol?(arguments[0])