packwerk 3.2.0 → 3.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98dd65426866ebc6f1421486a1a8573ea539dc143c448cd6632b77c5ca5ef5d8
-  data.tar.gz: 960fe5383ebd4ebadfc05698a64bd2537b1cf9c03525cd1780ff1f27ea5bd468
+  metadata.gz: 9172cfed0b1190af4ece801d73138cdaba7cd9aaad8fdb90537b2d6a03d597bb
+  data.tar.gz: 946267b723dff18a00a2948d4f9d5c8766018ae815b50fa542ba450bdc29c718
 SHA512:
-  metadata.gz: d91230970adbcfb9deaedd33a6745531b5245f929da676fb382ae0b661777777e522c14876ba9ace23d2f39dd4f72e528bc0543c1ecaaa463ba293113efab1bd
-  data.tar.gz: d2e1cbb00dc3dcaa1a92548f506124e0f05b4b8fa9f5c5837fa271ffb2e3847277fae8945b13cae0a05223540c386ead8efb7e8108436af2732c9525f9b00b4c
+  metadata.gz: a7ec7b0f03a55f713b24d9aec7e6cadfb7138087685ee698f7a35c64209638168d91ee7de44a174543271b4252173007d64a16b0bd5f00348dd0554a76c34bb1
+  data.tar.gz: ccc7785fcef8f061923c72f122dbf7f7c9ebab1e7c4cc9d2e6c2a8a643ac0da8f7594c17c2823b2bcc7845dd255d886a6b85eabe0ce68176a8b1ff57097c7278

data/lib/packwerk/association_inspector.rb

@@ -19,19 +19,27 @@ module Packwerk
       CustomAssociations
     )
 
-    sig { params(inflector: T.class_of(ActiveSupport::Inflector), custom_associations: CustomAssociations).void }
-    def initialize(inflector:, custom_associations: Set.new)
+    sig do
+      params(
+        inflector: T.class_of(ActiveSupport::Inflector),
+        custom_associations: CustomAssociations,
+        excluded_files: T::Set[String]
+      ).void
+    end
+    def initialize(inflector:, custom_associations: Set.new, excluded_files: Set.new)
       @inflector = inflector
       @associations = T.let(RAILS_ASSOCIATIONS + custom_associations, CustomAssociations)
+      @excluded_files = T.let(excluded_files, T::Set[String])
     end
 
     sig do
       override
-        .params(node: AST::Node, ancestors: T::Array[AST::Node])
+        .params(node: AST::Node, ancestors: T::Array[AST::Node], relative_file: String)
         .returns(T.nilable(String))
     end
-    def constant_name_from_node(node, ancestors:)
+    def constant_name_from_node(node, ancestors:, relative_file:)
       return unless NodeHelpers.method_call?(node)
+      return if excluded?(relative_file)
       return unless association?(node)
 
       arguments = NodeHelpers.method_arguments(node)
@@ -48,6 +56,11 @@ module Packwerk
 
     private
 
+    sig { params(relative_file: String).returns(T::Boolean) }
+    def excluded?(relative_file)
+      @excluded_files.include?(relative_file)
+    end
+
     sig { params(node: AST::Node).returns(T::Boolean) }
     def association?(node)
       method_name = NodeHelpers.method_name(node)

data/lib/packwerk/checker.rb

@@ -11,7 +11,7 @@ module Packwerk
     class << self
       extend T::Sig
 
-      sig { params(base: Class).void }
+      sig { params(base: T::Class[T.anything]).void }
       def included(base)
         checkers << base
       end
@@ -34,9 +34,9 @@ module Packwerk
         require("packwerk/reference_checking/checkers/dependency_checker")
       end
 
-      sig { returns(T::Array[Class]) }
+      sig { returns(T::Array[T::Class[T.anything]]) }
       def checkers
-        @checkers ||= T.let([], T.nilable(T::Array[Class]))
+        @checkers ||= T.let([], T.nilable(T::Array[T::Class[T.anything]]))
       end
 
       sig { params(name: String).returns(Checker) }

data/lib/packwerk/configuration.rb

@@ -54,6 +54,9 @@ module Packwerk
     sig { returns(T::Array[Symbol]) }
     attr_reader(:custom_associations)
 
+    sig { returns(T::Array[String]) }
+    attr_reader(:associations_exclude)
+
     sig { returns(T.nilable(String)) }
     attr_reader(:config_path)
 
@@ -76,6 +79,7 @@ module Packwerk
       @root_path = T.let(File.expand_path(root), String)
       @package_paths = T.let(configs["package_paths"] || "**/", T.any(String, T::Array[String]))
       @custom_associations = T.let((configs["custom_associations"] || []).map(&:to_sym), T::Array[Symbol])
+      @associations_exclude = T.let(configs["associations_exclude"] || [], T::Array[String])
       @parallel = T.let(configs.key?("parallel") ? configs["parallel"] : true, T::Boolean)
       @cache_enabled = T.let(configs.key?("cache") ? configs["cache"] : false, T::Boolean)
       @cache_directory = T.let(Pathname.new(configs["cache_directory"] || "tmp/cache/packwerk"), Pathname)

data/lib/packwerk/const_node_inspector.rb

@@ -9,10 +9,10 @@ module Packwerk
 
     sig do
       override
-        .params(node: AST::Node, ancestors: T::Array[AST::Node])
+        .params(node: AST::Node, ancestors: T::Array[AST::Node], relative_file: String)
         .returns(T.nilable(String))
     end
-    def constant_name_from_node(node, ancestors:)
+    def constant_name_from_node(node, ancestors:, relative_file:)
       return nil unless NodeHelpers.constant?(node)
 
       parent = ancestors.first

data/lib/packwerk/constant_name_inspector.rb

@@ -13,10 +13,10 @@ module Packwerk
 
     sig do
       abstract
-        .params(node: ::AST::Node, ancestors: T::Array[::AST::Node])
+        .params(node: ::AST::Node, ancestors: T::Array[::AST::Node], relative_file: String)
         .returns(T.nilable(String))
     end
-    def constant_name_from_node(node, ancestors:); end
+    def constant_name_from_node(node, ancestors:, relative_file:); end
   end
 
   private_constant :ConstantNameInspector

data/lib/packwerk/offenses_formatter.rb

@@ -20,7 +20,7 @@ module Packwerk
     class << self
       extend T::Sig
 
-      sig { params(base: Class).void }
+      sig { params(base: T::Class[T.anything]).void }
       def included(base)
         offenses_formatters << base
       end
@@ -43,9 +43,9 @@ module Packwerk
         require("packwerk/formatters/default_offenses_formatter")
       end
 
-      sig { returns(T::Array[Class]) }
+      sig { returns(T::Array[T::Class[T.anything]]) }
       def offenses_formatters
-        @offenses_formatters ||= T.let([], T.nilable(T::Array[Class]))
+        @offenses_formatters ||= T.let([], T.nilable(T::Array[T::Class[T.anything]]))
       end
 
       sig { params(name: String).returns(OffensesFormatter) }

data/lib/packwerk/package.rb

@@ -42,7 +42,7 @@ module Packwerk
     def package_path?(path)
       return true if root?
 
-      path.start_with?(@name)
+      path.start_with?(@name + "/")
     end
 
     sig { params(other: T.untyped).returns(T.nilable(Integer)) }

data/lib/packwerk/package_todo.rb

@@ -113,10 +113,7 @@ module Packwerk
     sig { params(package: String, violations: Entry).returns(T::Boolean) }
     def stale_violation_for_package?(package, violations:)
       violations.any? do |constant_name, entries_for_constant|
-        new_entries_violation_types = T.cast(
-          new_entries.dig(package, constant_name, "violations"),
-          T.nilable(T::Array[String]),
-        )
+        new_entries_violation_types = new_entries.dig(package, constant_name, "violations")
         # If there are no NEW entries that match the old entries `for_files`,
         # new_entries is from the list of violations we get when we check this file.
         # If this list is empty, we also must have stale violations.

data/lib/packwerk/parsers/factory.rb

@@ -24,7 +24,7 @@ module Packwerk
       def initialize
         @ruby_parser = T.let(nil, T.nilable(ParserInterface))
         @erb_parser = T.let(nil, T.nilable(ParserInterface))
-        @erb_parser_class = T.let(nil, T.nilable(Class))
+        @erb_parser_class = T.let(nil, T.nilable(T::Class[T.anything]))
       end
 
       sig { params(path: String).returns(T.nilable(ParserInterface)) }
@@ -37,12 +37,12 @@ module Packwerk
         end
       end
 
-      sig { returns(Class) }
+      sig { returns(T::Class[T.anything]) }
       def erb_parser_class
         @erb_parser_class ||= Erb
       end
 
-      sig { params(klass: T.nilable(Class)).void }
+      sig { params(klass: T.nilable(T::Class[T.anything])).void }
       def erb_parser_class=(klass)
         @erb_parser_class = klass
         @erb_parser = nil

data/lib/packwerk/parsers/ruby.rb

@@ -19,6 +19,13 @@ module Packwerk
           super(builder)
           super.diagnostics.all_errors_are_fatal = true
         end
+
+        private
+
+        sig { params(error: Prism::ParseError).returns(T::Boolean) }
+        def valid_error?(error)
+          error.type != :invalid_yield
+        end
       end
 
       class TolerateInvalidUtf8Builder < Parser::Builders::Default

data/lib/packwerk/reference_extractor.rb

@@ -80,7 +80,12 @@ module Packwerk
       constant_name = T.let(nil, T.nilable(String))
 
       @constant_name_inspectors.each do |inspector|
-        constant_name = inspector.constant_name_from_node(node, ancestors: ancestors)
+        constant_name = inspect_node(
+          inspector,
+          node: node,
+          ancestors: ancestors,
+          relative_file: relative_file
+        )
 
         break if constant_name
       end
@@ -97,6 +102,29 @@ module Packwerk
 
     private
 
+    sig do
+      params(
+        inspector: ConstantNameInspector,
+        node: Parser::AST::Node,
+        ancestors: T::Array[Parser::AST::Node],
+        relative_file: String
+      ).returns(T.nilable(String))
+    end
+    def inspect_node(inspector, node:, ancestors:, relative_file:)
+      inspector.constant_name_from_node(node, ancestors: ancestors, relative_file: relative_file)
+    rescue ArgumentError => error
+      if error.message == "unknown keyword: :relative_file"
+        T.unsafe(inspector).constant_name_from_node(node, ancestors: ancestors).tap do
+          warn(<<~MSG.squish)
+            #{T.cast(inspector, Object).class}#reference_from_node without a relative_file: keyword
+            argument is deprecated and will be required in Packwerk 3.1.1.
+          MSG
+        end
+      else
+        raise
+      end
+    end
+
     sig do
       params(
         constant_name: String,

data/lib/packwerk/reference_offense.rb

@@ -23,7 +23,7 @@ module Packwerk
         .void
     end
     def initialize(reference:, violation_type:, message:, location: nil)
-      super(file: reference.relative_path, message: message, location: location)
+      super(file: T.must(reference.relative_path), message: message, location: location)
       @reference = reference
       @violation_type = violation_type
     end

data/lib/packwerk/run_context.rb

@@ -15,14 +15,13 @@ module Packwerk
         params(configuration: Configuration).returns(RunContext)
       end
       def from_configuration(configuration)
-        inflector = ActiveSupport::Inflector
-
         new(
           root_path: configuration.root_path,
           load_paths: configuration.load_paths,
           package_paths: configuration.package_paths,
-          inflector: inflector,
+          inflector: ActiveSupport::Inflector,
           custom_associations: configuration.custom_associations,
+          associations_exclude: configuration.associations_exclude,
           cache_enabled: configuration.cache_enabled?,
           cache_directory: configuration.cache_directory,
           config_path: configuration.config_path,
@@ -39,6 +38,7 @@ module Packwerk
         config_path: T.nilable(String),
         package_paths: T.nilable(T.any(T::Array[String], String)),
         custom_associations: AssociationInspector::CustomAssociations,
+        associations_exclude: T::Array[String],
         checkers: T::Array[Checker],
         cache_enabled: T::Boolean,
       ).void
@@ -51,6 +51,7 @@ module Packwerk
       config_path: nil,
       package_paths: nil,
       custom_associations: [],
+      associations_exclude: [],
       checkers: Checker.all,
       cache_enabled: false
     )
@@ -59,6 +60,7 @@ module Packwerk
       @package_paths = package_paths
       @inflector = inflector
       @custom_associations = custom_associations
+      @associations_exclude = associations_exclude
       @checkers = checkers
       @cache_enabled = cache_enabled
       @cache_directory = cache_directory
@@ -128,9 +130,18 @@ module Packwerk
     def constant_name_inspectors
       [
         ConstNodeInspector.new,
-        AssociationInspector.new(inflector: @inflector, custom_associations: @custom_associations),
+        AssociationInspector.new(
+          inflector: @inflector,
+          custom_associations: @custom_associations,
+          excluded_files: relative_files_for_globs(@associations_exclude),
+        ),
       ]
     end
+
+    sig { params(relative_globs: T::Array[String]).returns(FilesForProcessing::RelativeFileSet) }
+    def relative_files_for_globs(relative_globs)
+      Set.new(relative_globs.flat_map { |glob| Dir[glob] })
+    end
   end
 
   private_constant :RunContext

data/lib/packwerk/validator.rb

@@ -18,7 +18,7 @@ module Packwerk
     class << self
       extend T::Sig
 
-      sig { params(base: Class).void }
+      sig { params(base: T::Class[T.anything]).void }
       def included(base)
         validators << base
       end
@@ -36,9 +36,9 @@ module Packwerk
         require("packwerk/validators/dependency_validator")
       end
 
-      sig { returns(T::Array[Class]) }
+      sig { returns(T::Array[T::Class[T.anything]]) }
       def validators
-        @validators ||= T.let([], T.nilable(T::Array[Class]))
+        @validators ||= T.let([], T.nilable(T::Array[T::Class[T.anything]]))
       end
     end
 

data/lib/packwerk/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Packwerk
-  VERSION = "3.2.0"
+  VERSION = "3.2.2"
 end

data/lib/packwerk.rb

@@ -4,6 +4,7 @@
 require "sorbet-runtime"
 require "active_support"
 require "fileutils"
+require "stringio"
 
 # Provides String#pluralize
 require "active_support/core_ext/string"

data/sorbet/config

@@ -1,3 +1,4 @@
 --dir
 .
 --enable-experimental-requires-ancestor
+--ignore=/vendor/bundle