packwerk 1.4.0 → 2.1.1

data/lib/packwerk/run_context.rb

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 require "constant_resolver"
@@ -8,76 +8,105 @@ 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 = ::Packwerk::Inflector.from_file(configuration.inflections_file)
+        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::Array[String],
+        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)
-
-      reference_checker = ReferenceChecking::ReferenceChecker.new(checkers)
-      references.flat_map { |reference| reference_checker.call(reference) }
+    sig { params(absolute_file: String).returns(T::Array[Packwerk::Offense]) }
+    def process_file(absolute_file:)
+      unresolved_references_and_offenses = file_processor.call(absolute_file)
+      references_and_offenses = ReferenceExtractor.get_fully_qualified_references_and_offenses_from(
+        unresolved_references_and_offenses,
+        context_provider
+      )
+      reference_checker = ReferenceChecking::ReferenceChecker.new(@checkers)
+      references_and_offenses.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 +115,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 = "1.4.0"
+  VERSION = "2.1.1"
 end

data/lib/packwerk.rb

@@ -5,6 +5,9 @@ require "sorbet-runtime"
 require "active_support"
 require "fileutils"
 
+# Provides String#pluralize
+require "active_support/core_ext/string"
+
 module Packwerk
   extend ActiveSupport::Autoload
 
@@ -12,6 +15,7 @@ module Packwerk
   autoload :ApplicationValidator
   autoload :AssociationInspector
   autoload :OffenseCollection
+  autoload :Cache
   autoload :Cli
   autoload :Configuration
   autoload :ConstantDiscovery
@@ -21,7 +25,6 @@ module Packwerk
   autoload :FileProcessor
   autoload :FilesForProcessing
   autoload :Graph
-  autoload :Inflector
   autoload :Node
   autoload :NodeProcessor
   autoload :NodeProcessorFactory
@@ -34,6 +37,7 @@ module Packwerk
   autoload :ParsedConstantDefinitions
   autoload :Parsers
   autoload :ParseRun
+  autoload :UnresolvedReference
   autoload :Reference
   autoload :ReferenceExtractor
   autoload :ReferenceOffense
@@ -42,13 +46,6 @@ module Packwerk
   autoload :Version
   autoload :ViolationType
 
-  module Inflections
-    extend ActiveSupport::Autoload
-
-    autoload :Custom
-    autoload :Default
-  end
-
   module OutputStyles
     extend ActiveSupport::Autoload
 
@@ -71,7 +68,6 @@ module Packwerk
     extend ActiveSupport::Autoload
 
     autoload :ConfigurationFile
-    autoload :InflectionsFile
     autoload :RootPackage
   end
 

data/packwerk.gemspec

@@ -45,6 +45,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency("parallel")
   spec.add_dependency("sorbet-runtime")
   spec.add_dependency("bundler")
+  spec.add_dependency("digest")
 
   spec.add_development_dependency("rake")
   spec.add_development_dependency("sorbet")

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: 1.4.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Shopify Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-24 00:00:00.000000000 Z
+date: 2022-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: digest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -195,6 +209,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby-version"
+- CHANGELOG.md
 - CODEOWNERS
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
@@ -204,6 +219,7 @@ files:
 - README.md
 - Rakefile
 - TROUBLESHOOT.md
+- UPGRADING.md
 - USAGE.md
 - bin/console
 - bin/m
@@ -220,6 +236,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
@@ -231,15 +248,10 @@ files:
 - lib/packwerk/formatters/offenses_formatter.rb
 - lib/packwerk/formatters/progress_formatter.rb
 - lib/packwerk/generators/configuration_file.rb
-- lib/packwerk/generators/inflections_file.rb
 - lib/packwerk/generators/root_package.rb
-- lib/packwerk/generators/templates/inflections.yml
 - lib/packwerk/generators/templates/package.yml
 - lib/packwerk/generators/templates/packwerk.yml.erb
 - lib/packwerk/graph.rb
-- lib/packwerk/inflections/custom.rb
-- lib/packwerk/inflections/default.rb
-- lib/packwerk/inflector.rb
 - lib/packwerk/node.rb
 - lib/packwerk/node_processor.rb
 - lib/packwerk/node_processor_factory.rb
@@ -257,6 +269,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
@@ -269,6 +282,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

data/lib/packwerk/generators/inflections_file.rb

@@ -1,43 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-module Packwerk
-  module Generators
-    class InflectionsFile
-      extend T::Sig
-
-      class << self
-        def generate(root:, out:)
-          new(root, out: out).generate
-        end
-      end
-
-      def initialize(root, out: $stdout)
-        @root = root
-        @out = out
-      end
-
-      sig { returns(T::Boolean) }
-      def generate
-        ruby_inflection_file_exist = Dir.glob("#{@root}/**/inflections.rb").any?
-        yaml_inflection_file_exist = Dir.glob("#{@root}/**/inflections.yml").any?
-
-        if !ruby_inflection_file_exist || yaml_inflection_file_exist
-          return true
-        end
-
-        @out.puts("📦 Generating `inflections.yml` file...")
-
-        destination_file_path = File.join(@root, "config")
-        FileUtils.mkdir_p(destination_file_path)
-
-        source_file_path = File.join(__dir__, "/templates/inflections.yml")
-        FileUtils.cp(source_file_path, destination_file_path)
-
-        @out.puts("✅ `inflections.yml` generated in #{destination_file_path}")
-
-        true
-      end
-    end
-  end
-end

data/lib/packwerk/generators/templates/inflections.yml

@@ -1,6 +0,0 @@
-# List your inflections in this file instead of `inflections.rb`
-# See steps to set up custom inflections:
-# https://github.com/Shopify/packwerk/blob/main/USAGE.md#Inflections
-
-# acronym:
-#   - "GraphQL"

data/lib/packwerk/inflections/custom.rb

@@ -1,33 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-require "yaml"
-
-module Packwerk
-  module Inflections
-    class Custom
-      SUPPORTED_INFLECTION_METHODS = %w(acronym human irregular plural singular uncountable)
-
-      attr_accessor :inflections
-
-      def initialize(custom_inflection_file = nil)
-        if custom_inflection_file && File.exist?(custom_inflection_file)
-          @inflections = YAML.load_file(custom_inflection_file) || {}
-
-          invalid_inflections = @inflections.keys - SUPPORTED_INFLECTION_METHODS
-          raise ArgumentError, "Unsupported inflection types: #{invalid_inflections}" if invalid_inflections.any?
-        else
-          @inflections = []
-        end
-      end
-
-      def apply_to(inflections_object)
-        @inflections.each do |inflection_type, inflections|
-          inflections.each do |inflection|
-            inflections_object.public_send(inflection_type, *Array(inflection))
-          end
-        end
-      end
-    end
-  end
-end

data/lib/packwerk/inflections/default.rb

@@ -1,73 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-module Packwerk
-  module Inflections
-    module Default
-      class << self
-        def apply_to(inflections_object)
-          # copied from active_support/inflections
-          # https://github.com/rails/rails/blob/d2ae2c3103e93783971d5356d0b3fd1b4070d6cf/activesupport/lib/active_support/inflections.rb#L12
-          inflections_object.plural(/$/, "s")
-          inflections_object.plural(/s$/i, "s")
-          inflections_object.plural(/^(ax|test)is$/i, '\1es')
-          inflections_object.plural(/(octop|vir)us$/i, '\1i')
-          inflections_object.plural(/(octop|vir)i$/i, '\1i')
-          inflections_object.plural(/(alias|status)$/i, '\1es')
-          inflections_object.plural(/(bu)s$/i, '\1ses')
-          inflections_object.plural(/(buffal|tomat)o$/i, '\1oes')
-          inflections_object.plural(/([ti])um$/i, '\1a')
-          inflections_object.plural(/([ti])a$/i, '\1a')
-          inflections_object.plural(/sis$/i, "ses")
-          inflections_object.plural(/(?:([^f])fe|([lr])f)$/i, '\1\2ves')
-          inflections_object.plural(/(hive)$/i, '\1s')
-          inflections_object.plural(/([^aeiouy]|qu)y$/i, '\1ies')
-          inflections_object.plural(/(x|ch|ss|sh)$/i, '\1es')
-          inflections_object.plural(/(matr|vert|ind)(?:ix|ex)$/i, '\1ices')
-          inflections_object.plural(/^(m|l)ouse$/i, '\1ice')
-          inflections_object.plural(/^(m|l)ice$/i, '\1ice')
-          inflections_object.plural(/^(ox)$/i, '\1en')
-          inflections_object.plural(/^(oxen)$/i, '\1')
-          inflections_object.plural(/(quiz)$/i, '\1zes')
-
-          inflections_object.singular(/s$/i, "")
-          inflections_object.singular(/(ss)$/i, '\1')
-          inflections_object.singular(/(n)ews$/i, '\1ews')
-          inflections_object.singular(/([ti])a$/i, '\1um')
-          inflections_object.singular(/((a)naly|(b)a|(d)iagno|(p)arenthe|(p)rogno|(s)ynop|(t)he)(sis|ses)$/i, '\1sis')
-          inflections_object.singular(/(^analy)(sis|ses)$/i, '\1sis')
-          inflections_object.singular(/([^f])ves$/i, '\1fe')
-          inflections_object.singular(/(hive)s$/i, '\1')
-          inflections_object.singular(/(tive)s$/i, '\1')
-          inflections_object.singular(/([lr])ves$/i, '\1f')
-          inflections_object.singular(/([^aeiouy]|qu)ies$/i, '\1y')
-          inflections_object.singular(/(s)eries$/i, '\1eries')
-          inflections_object.singular(/(m)ovies$/i, '\1ovie')
-          inflections_object.singular(/(x|ch|ss|sh)es$/i, '\1')
-          inflections_object.singular(/^(m|l)ice$/i, '\1ouse')
-          inflections_object.singular(/(bus)(es)?$/i, '\1')
-          inflections_object.singular(/(o)es$/i, '\1')
-          inflections_object.singular(/(shoe)s$/i, '\1')
-          inflections_object.singular(/(cris|test)(is|es)$/i, '\1is')
-          inflections_object.singular(/^(a)x[ie]s$/i, '\1xis')
-          inflections_object.singular(/(octop|vir)(us|i)$/i, '\1us')
-          inflections_object.singular(/(alias|status)(es)?$/i, '\1')
-          inflections_object.singular(/^(ox)en/i, '\1')
-          inflections_object.singular(/(vert|ind)ices$/i, '\1ex')
-          inflections_object.singular(/(matr)ices$/i, '\1ix')
-          inflections_object.singular(/(quiz)zes$/i, '\1')
-          inflections_object.singular(/(database)s$/i, '\1')
-
-          inflections_object.irregular("person", "people")
-          inflections_object.irregular("man", "men")
-          inflections_object.irregular("child", "children")
-          inflections_object.irregular("sex", "sexes")
-          inflections_object.irregular("move", "moves")
-          inflections_object.irregular("zombie", "zombies")
-
-          inflections_object.uncountable(%w(equipment information rice money species series fish sheep jeans police))
-        end
-      end
-    end
-  end
-end

data/lib/packwerk/inflector.rb

@@ -1,49 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-require "active_support/inflector"
-
-module Packwerk
-  # A custom inflector used, among other things, to map between constant names and file names.
-  class Inflector
-    class << self
-      extend T::Sig
-
-      def default
-        @default ||= new(custom_inflector: Inflections::Custom.new)
-      end
-
-      sig { params(inflections_file: String).returns(::Packwerk::Inflector) }
-      def from_file(inflections_file)
-        new(custom_inflector: Inflections::Custom.new(inflections_file))
-      end
-    end
-
-    extend T::Sig
-    include ::ActiveSupport::Inflector # For #camelize, #classify, #pluralize, #singularize
-
-    sig do
-      params(
-        custom_inflector: Inflections::Custom
-      ).void
-    end
-    def initialize(custom_inflector:)
-      @inflections = ::ActiveSupport::Inflector::Inflections.new
-
-      Inflections::Default.apply_to(@inflections)
-      custom_inflector.apply_to(@inflections)
-    end
-
-    def pluralize(word, count = nil)
-      if count == 1
-        singularize(word)
-      else
-        super(word)
-      end
-    end
-
-    def inflections(_ = nil)
-      @inflections
-    end
-  end
-end