packwerk 2.0.0 → 2.2.0

data/lib/packwerk/run_context.rb

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 require "constant_resolver"
@@ -8,76 +8,107 @@ module Packwerk
   class RunContext
     extend T::Sig
 
-    attr_reader(
-      :root_path,
-      :load_paths,
-      :package_paths,
-      :inflector,
-      :custom_associations,
-      :checker_classes,
-    )
-
-    DEFAULT_CHECKERS = [
-      ::Packwerk::ReferenceChecking::Checkers::DependencyChecker,
-      ::Packwerk::ReferenceChecking::Checkers::PrivacyChecker,
-    ]
+    DEFAULT_CHECKERS = T.let([
+      ::Packwerk::ReferenceChecking::Checkers::DependencyChecker.new,
+      ::Packwerk::ReferenceChecking::Checkers::PrivacyChecker.new,
+    ], T::Array[ReferenceChecking::Checkers::Checker])
 
     class << self
+      extend T::Sig
+
+      sig do
+        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,
-          custom_associations: configuration.custom_associations
+          custom_associations: configuration.custom_associations,
+          cache_enabled: configuration.cache_enabled?,
+          cache_directory: configuration.cache_directory,
+          config_path: configuration.config_path,
         )
       end
     end
 
+    sig do
+      params(
+        root_path: String,
+        load_paths: T::Hash[String, Module],
+        inflector: T.class_of(ActiveSupport::Inflector),
+        cache_directory: Pathname,
+        config_path: T.nilable(String),
+        package_paths: T.nilable(T.any(T::Array[String], String)),
+        custom_associations: AssociationInspector::CustomAssociations,
+        checkers: T::Array[ReferenceChecking::Checkers::Checker],
+        cache_enabled: T::Boolean,
+      ).void
+    end
     def initialize(
       root_path:,
       load_paths:,
+      inflector:,
+      cache_directory:,
+      config_path: nil,
       package_paths: nil,
-      inflector: nil,
       custom_associations: [],
-      checker_classes: DEFAULT_CHECKERS
+      checkers: DEFAULT_CHECKERS,
+      cache_enabled: false
     )
       @root_path = root_path
       @load_paths = load_paths
       @package_paths = package_paths
       @inflector = inflector
       @custom_associations = custom_associations
-      @checker_classes = checker_classes
+      @checkers = checkers
+      @cache_enabled = cache_enabled
+      @cache_directory = cache_directory
+      @config_path = config_path
+
+      @file_processor = T.let(nil, T.nilable(FileProcessor))
+      @context_provider = T.let(nil, T.nilable(ConstantDiscovery))
+      # We need to initialize this before we fork the process, see https://github.com/Shopify/packwerk/issues/182
+      @cache = T.let(
+        Cache.new(enable_cache: @cache_enabled, cache_directory: @cache_directory, config_path: @config_path), Cache
+      )
     end
 
-    sig { params(file: String).returns(T::Array[Packwerk::Offense]) }
-    def process_file(file:)
-      references = file_processor.call(file)
+    sig { params(absolute_file: String).returns(T::Array[Packwerk::Offense]) }
+    def process_file(absolute_file:)
+      processed_file = file_processor.call(absolute_file)
+
+      references = ReferenceExtractor.get_fully_qualified_references_from(
+        processed_file.unresolved_references,
+        context_provider
+      )
+      reference_checker = ReferenceChecking::ReferenceChecker.new(@checkers)
 
-      reference_checker = ReferenceChecking::ReferenceChecker.new(checkers)
-      references.flat_map { |reference| reference_checker.call(reference) }
+      processed_file.offenses + references.flat_map { |reference| reference_checker.call(reference) }
     end
 
     private
 
     sig { returns(FileProcessor) }
     def file_processor
-      @file_processor ||= FileProcessor.new(node_processor_factory: node_processor_factory)
+      @file_processor ||= FileProcessor.new(node_processor_factory: node_processor_factory, cache: @cache)
     end
 
     sig { returns(NodeProcessorFactory) }
     def node_processor_factory
       NodeProcessorFactory.new(
         context_provider: context_provider,
-        root_path: root_path,
+        root_path: @root_path,
         constant_name_inspectors: constant_name_inspectors
       )
     end
 
     sig { returns(ConstantDiscovery) }
     def context_provider
-      ::Packwerk::ConstantDiscovery.new(
+      @context_provider ||= ::Packwerk::ConstantDiscovery.new(
         constant_resolver: resolver,
         packages: package_set
       )
@@ -86,27 +117,22 @@ module Packwerk
     sig { returns(ConstantResolver) }
     def resolver
       ConstantResolver.new(
-        root_path: root_path,
-        load_paths: load_paths,
-        inflector: inflector,
+        root_path: @root_path,
+        load_paths: @load_paths,
+        inflector: @inflector,
       )
     end
 
     sig { returns(PackageSet) }
     def package_set
-      ::Packwerk::PackageSet.load_all_from(root_path, package_pathspec: package_paths)
-    end
-
-    sig { returns(T::Array[ReferenceChecking::Checkers::Checker]) }
-    def checkers
-      checker_classes.map(&:new)
+      ::Packwerk::PackageSet.load_all_from(@root_path, package_pathspec: @package_paths)
     end
 
     sig { returns(T::Array[ConstantNameInspector]) }
     def constant_name_inspectors
       [
         ::Packwerk::ConstNodeInspector.new,
-        ::Packwerk::AssociationInspector.new(inflector: inflector, custom_associations: custom_associations),
+        ::Packwerk::AssociationInspector.new(inflector: @inflector, custom_associations: @custom_associations),
       ]
     end
   end

data/lib/packwerk/spring_command.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# typed: false
+# typed: true
 
 require "spring/commands"
 

data/lib/packwerk/unresolved_reference.rb

@@ -0,0 +1,10 @@
+# typed: true
+# frozen_string_literal: true
+
+module Packwerk
+  # An unresolved reference from a file in one package to a constant that may be defined in a different package.
+  # Unresolved means that we know how it's referred to in the file,
+  # and we have enough context on that reference to figure out the fully qualified reference such that we
+  # can produce a Reference in a separate pass. However, we have not yet resolved it to its fully qualified version.
+  UnresolvedReference = Struct.new(:constant_name, :namespace_path, :relative_path, :source_location)
+end

data/lib/packwerk/version.rb

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

data/lib/packwerk.rb

@@ -15,6 +15,7 @@ module Packwerk
   autoload :ApplicationValidator
   autoload :AssociationInspector
   autoload :OffenseCollection
+  autoload :Cache
   autoload :Cli
   autoload :Configuration
   autoload :ConstantDiscovery
@@ -36,6 +37,7 @@ module Packwerk
   autoload :ParsedConstantDefinitions
   autoload :Parsers
   autoload :ParseRun
+  autoload :UnresolvedReference
   autoload :Reference
   autoload :ReferenceExtractor
   autoload :ReferenceOffense

data/packwerk.gemspec

@@ -41,16 +41,18 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.6"
 
   spec.add_dependency("activesupport", ">= 5.2")
-  spec.add_dependency("constant_resolver")
+  spec.add_dependency("constant_resolver", ">=0.2.0")
   spec.add_dependency("parallel")
-  spec.add_dependency("sorbet-runtime")
+  spec.add_dependency("sorbet-runtime", ">=0.5.9914")
   spec.add_dependency("bundler")
+  spec.add_dependency("digest")
 
   spec.add_development_dependency("rake")
   spec.add_development_dependency("sorbet")
   spec.add_development_dependency("m")
   # https://github.com/ruby/psych/pull/487
   spec.add_development_dependency("psych", "~> 3")
+  spec.add_development_dependency("zeitwerk")
 
   # For Ruby parsing
   spec.add_dependency("ast")

data/sorbet/config

@@ -1,2 +1,3 @@
 --dir
 .
+--enable-experimental-requires-ancestor

data/sorbet/rbi/gems/tapioca@0.4.19.rbi

@@ -562,7 +562,7 @@ module Tapioca::GenericTypeRegistry
     def name_of(constant); end
     sig { params(object: BasicObject).returns(Integer) }
     def object_id_of(object); end
-    sig { params(constant: T.untyped, type_variable_type: T.enum([:type_member, :type_template]), type_variable: T::Types::TypeVariable, fixed: T.untyped, lower: T.untyped, upper: T.untyped).void }
+    sig { params(constant: T.untyped, type_variable_type: T.deprecated_enum([:type_member, :type_template]), type_variable: T::Types::TypeVariable, fixed: T.untyped, lower: T.untyped, upper: T.untyped).void }
     def register_type_variable(constant, type_variable_type, type_variable, fixed, lower, upper); end
     sig { params(type_variable_type: Symbol, variance: Symbol, fixed: T.untyped, lower: T.untyped, upper: T.untyped).returns(String) }
     def serialize_type_variable(type_variable_type, variance, fixed, lower, upper); end

data/sorbet/tapioca/require.rb

@@ -3,7 +3,7 @@
 # This is an autogenerated file for explicit gem requires.
 # Please instead update this file by running `tapioca require`.
 
-# typed: false
+# typed: strict
 
 require "ast"
 require "ast/node"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packwerk
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Shopify Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-08 00:00:00.000000000 Z
+date: 2022-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
@@ -54,6 +54,20 @@ dependencies:
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.9914
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.9914
+- !ruby/object:Gem::Dependency
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: digest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -136,6 +150,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  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'
 - !ruby/object:Gem::Dependency
   name: ast
   requirement: !ruby/object:Gem::Requirement
@@ -222,6 +250,7 @@ files:
 - lib/packwerk/application_load_paths.rb
 - lib/packwerk/application_validator.rb
 - lib/packwerk/association_inspector.rb
+- lib/packwerk/cache.rb
 - lib/packwerk/cli.rb
 - lib/packwerk/configuration.rb
 - lib/packwerk/const_node_inspector.rb
@@ -254,6 +283,7 @@ files:
 - lib/packwerk/parsers.rb
 - lib/packwerk/parsers/erb.rb
 - lib/packwerk/parsers/factory.rb
+- lib/packwerk/parsers/parser_interface.rb
 - lib/packwerk/parsers/ruby.rb
 - lib/packwerk/reference.rb
 - lib/packwerk/reference_checking/checkers/checker.rb
@@ -266,6 +296,7 @@ files:
 - lib/packwerk/run_context.rb
 - lib/packwerk/sanity_checker.rb
 - lib/packwerk/spring_command.rb
+- lib/packwerk/unresolved_reference.rb
 - lib/packwerk/version.rb
 - lib/packwerk/violation_type.rb
 - library.yml