packwerk 3.2.1 → 3.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8766d43b92fcc7bedad92604cde48e11433afdf474b21515f363b595c7fae23
-  data.tar.gz: 0d386a1d690b6c07d41a6d63b0907f38d57fffd87d2ab370ee580cbcd0826a17
+  metadata.gz: 9172cfed0b1190af4ece801d73138cdaba7cd9aaad8fdb90537b2d6a03d597bb
+  data.tar.gz: 946267b723dff18a00a2948d4f9d5c8766018ae815b50fa542ba450bdc29c718
 SHA512:
-  metadata.gz: a64ccf65829b48691341b0abc09013213bd266ca9d2ec7a37fa1735856ae6b707d904ad75012c91bcd5a6d3ec4991ed6d7f1545140232d34f6d27452f5ac5a27
-  data.tar.gz: f231695cf34fc0fb109d70efcff6874d5268b70c4af80688813734448f5c3d1ee3a705dbe3ece0bbb156733585f581f941917ed43f1666bb58f9617932858e18
+  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/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/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/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/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/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Packwerk
-  VERSION = "3.2.1"
+  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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packwerk
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 3.2.2
 platform: ruby
 authors:
 - Shopify Inc.
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-02 00:00:00.000000000 Z
+date: 2024-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -150,20 +150,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: railties
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: |
   Sets package level boundaries between a specified set of ruby
   constants to minimize cross-boundary referencing and dependency.
@@ -314,7 +300,7 @@ metadata:
   source_code_uri: https://github.com/Shopify/packwerk
   changelog_uri: https://github.com/Shopify/packwerk/releases
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -322,15 +308,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key: 
+rubygems_version: 3.5.23
+signing_key:
 specification_version: 4
 summary: Packages for applications based on the zeitwerk autoloader
 test_files: []