packwerk 1.3.0 → 2.0.0

data/lib/packwerk/reference_checking/checkers/privacy_checker.rb

@@ -0,0 +1,58 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Packwerk
+  module ReferenceChecking
+    module Checkers
+      # Checks whether a given reference references a private constant of another package.
+      class PrivacyChecker
+        extend T::Sig
+        include Checker
+
+        sig { override.returns(Packwerk::ViolationType) }
+        def violation_type
+          ViolationType::Privacy
+        end
+
+        sig do
+          override
+            .params(reference: Packwerk::Reference)
+            .returns(T::Boolean)
+        end
+        def invalid_reference?(reference)
+          return false if reference.constant.public?
+
+          privacy_option = reference.constant.package.enforce_privacy
+          return false if enforcement_disabled?(privacy_option)
+
+          return false unless privacy_option == true ||
+            explicitly_private_constant?(reference.constant, explicitly_private_constants: privacy_option)
+
+          true
+        end
+
+        private
+
+        sig do
+          params(
+            constant: ConstantDiscovery::ConstantContext,
+            explicitly_private_constants: T::Array[String]
+          ).returns(T::Boolean)
+        end
+        def explicitly_private_constant?(constant, explicitly_private_constants:)
+          explicitly_private_constants.include?(constant.name) ||
+            # nested constants
+            explicitly_private_constants.any? { |epc| constant.name.start_with?(epc + "::") }
+        end
+
+        sig do
+          params(privacy_option: T.nilable(T.any(T::Boolean, T::Array[String])))
+            .returns(T::Boolean)
+        end
+        def enforcement_disabled?(privacy_option)
+          [false, nil].include?(privacy_option)
+        end
+      end
+    end
+  end
+end

data/lib/packwerk/reference_checking/reference_checker.rb

@@ -0,0 +1,33 @@
+# typed: true
+# frozen_string_literal: true
+
+module Packwerk
+  module ReferenceChecking
+    class ReferenceChecker
+      extend T::Sig
+
+      def initialize(checkers)
+        @checkers = checkers
+      end
+
+      sig do
+        params(
+          reference: T.any(Packwerk::Reference, Packwerk::Offense)
+        ).returns(T::Array[Packwerk::Offense])
+      end
+      def call(reference)
+        return [reference] if reference.is_a?(Packwerk::Offense)
+
+        @checkers.each_with_object([]) do |checker, violations|
+          next unless checker.invalid_reference?(reference)
+          offense = Packwerk::ReferenceOffense.new(
+            location: reference.source_location,
+            reference: reference,
+            violation_type: checker.violation_type
+          )
+          violations << offense
+        end
+      end
+    end
+  end
+end

data/lib/packwerk/reference_extractor.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 module Packwerk
-  # extracts a possible constant reference from a given AST node
+  # Extracts a possible constant reference from a given AST node.
   class ReferenceExtractor
     extend T::Sig
 
@@ -59,7 +59,7 @@ module Packwerk
 
       return if source_package == constant.package
 
-      Reference.new(source_package, relative_path, constant)
+      Reference.new(source_package, relative_path, constant, Node.location(node))
     end
 
     def local_reference?(constant_name, name_location, namespace_path)

data/lib/packwerk/reference_offense.rb

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 module Packwerk
+  # An offense related to a {Packwerk::Reference}.
   class ReferenceOffense < Offense
     extend T::Sig
     extend T::Helpers

data/lib/packwerk/run_context.rb

@@ -4,6 +4,7 @@
 require "constant_resolver"
 
 module Packwerk
+  # Holds the context of a Packwerk run across multiple files.
   class RunContext
     extend T::Sig
 
@@ -17,13 +18,13 @@ module Packwerk
     )
 
     DEFAULT_CHECKERS = [
-      ::Packwerk::DependencyChecker,
-      ::Packwerk::PrivacyChecker,
+      ::Packwerk::ReferenceChecking::Checkers::DependencyChecker,
+      ::Packwerk::ReferenceChecking::Checkers::PrivacyChecker,
     ]
 
     class << self
       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,
@@ -50,9 +51,12 @@ module Packwerk
       @checker_classes = checker_classes
     end
 
-    sig { params(file: String).returns(T::Array[T.nilable(::Packwerk::Offense)]) }
+    sig { params(file: String).returns(T::Array[Packwerk::Offense]) }
     def process_file(file:)
-      file_processor.call(file)
+      references = file_processor.call(file)
+
+      reference_checker = ReferenceChecking::ReferenceChecker.new(checkers)
+      references.flat_map { |reference| reference_checker.call(reference) }
     end
 
     private
@@ -66,7 +70,6 @@ module Packwerk
     def node_processor_factory
       NodeProcessorFactory.new(
         context_provider: context_provider,
-        checkers: checkers,
         root_path: root_path,
         constant_name_inspectors: constant_name_inspectors
       )
@@ -94,7 +97,7 @@ module Packwerk
       ::Packwerk::PackageSet.load_all_from(root_path, package_pathspec: package_paths)
     end
 
-    sig { returns(T::Array[Checker]) }
+    sig { returns(T::Array[ReferenceChecking::Checkers::Checker]) }
     def checkers
       checker_classes.map(&:new)
     end

data/lib/packwerk/sanity_checker.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: strict
 # frozen_string_literal: true
 
 module Packwerk

data/lib/packwerk/spring_command.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+# typed: false
+
+require "spring/commands"
+
+module Packwerk
+  class SpringCommand
+    def env(*)
+      # Packwerk needs to run in a test environment, which has a set of autoload paths that are
+      # often a superset of the dev/prod paths (for example, test/support/helpers)
+      "test"
+    end
+
+    def exec_name
+      "packwerk"
+    end
+
+    def gem_name
+      "packwerk"
+    end
+
+    def call
+      load(Gem.bin_path(gem_name, exec_name))
+    end
+  end
+
+  Spring.register_command("packwerk", SpringCommand.new)
+end

data/lib/packwerk/version.rb

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

data/lib/packwerk/violation_type.rb

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 module Packwerk

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,18 +15,15 @@ module Packwerk
   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
@@ -36,7 +36,6 @@ module Packwerk
   autoload :ParsedConstantDefinitions
   autoload :Parsers
   autoload :ParseRun
-  autoload :PrivacyChecker
   autoload :Reference
   autoload :ReferenceExtractor
   autoload :ReferenceOffense
@@ -45,13 +44,6 @@ module Packwerk
   autoload :Version
   autoload :ViolationType
 
-  module Inflections
-    extend ActiveSupport::Autoload
-
-    autoload :Custom
-    autoload :Default
-  end
-
   module OutputStyles
     extend ActiveSupport::Autoload
 
@@ -74,7 +66,20 @@ module Packwerk
     extend ActiveSupport::Autoload
 
     autoload :ConfigurationFile
-    autoload :InflectionsFile
     autoload :RootPackage
   end
+
+  module ReferenceChecking
+    extend ActiveSupport::Autoload
+
+    autoload :ReferenceChecker
+
+    module Checkers
+      extend ActiveSupport::Autoload
+
+      autoload :Checker
+      autoload :DependencyChecker
+      autoload :PrivacyChecker
+    end
+  end
 end

data/packwerk.gemspec

@@ -44,11 +44,13 @@ Gem::Specification.new do |spec|
   spec.add_dependency("constant_resolver")
   spec.add_dependency("parallel")
   spec.add_dependency("sorbet-runtime")
+  spec.add_dependency("bundler")
 
-  spec.add_development_dependency("bundler")
   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")
 
   # For Ruby parsing
   spec.add_dependency("ast")

data/service.yml

@@ -1,3 +1 @@
 classification: library
-slack_channels:
-- core-stewardship

data/sorbet/rbi/gems/psych@3.3.2.rbi

@@ -0,0 +1,24 @@
+# typed: true
+
+# DO NOT EDIT MANUALLY
+# This is an autogenerated file for types exported from the `psych` gem.
+# Please instead update this file by running `bin/tapioca gem psych`.
+
+::RUBY19 = T.let(T.unsafe(nil), TrueClass)
+
+class Object < ::BasicObject
+  include ::ActiveSupport::ToJsonWithActiveSupportEncoder
+  include ::Kernel
+  include ::JSON::Ext::Generator::GeneratorMethods::Object
+  include ::ActiveSupport::Tryable
+  include ::Minitest::Expectations
+  include ::Mocha::ParameterMatchers::InstanceMethods
+  include ::Mocha::Inspect::ObjectMethods
+  include ::Mocha::ObjectMethods
+
+  def to_yaml(options = T.unsafe(nil)); end
+
+  class << self
+    def yaml_tag(url); end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packwerk
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Shopify Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-07 00:00:00.000000000 Z
+date: 2021-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -73,7 +73,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: psych
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: ast
   requirement: !ruby/object:Gem::Requirement
@@ -181,6 +195,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby-version"
+- CHANGELOG.md
 - CODEOWNERS
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
@@ -190,6 +205,7 @@ files:
 - README.md
 - Rakefile
 - TROUBLESHOOT.md
+- UPGRADING.md
 - USAGE.md
 - bin/console
 - bin/m
@@ -206,28 +222,21 @@ files:
 - lib/packwerk/application_load_paths.rb
 - lib/packwerk/application_validator.rb
 - lib/packwerk/association_inspector.rb
-- lib/packwerk/checker.rb
 - lib/packwerk/cli.rb
 - lib/packwerk/configuration.rb
 - lib/packwerk/const_node_inspector.rb
 - lib/packwerk/constant_discovery.rb
 - lib/packwerk/constant_name_inspector.rb
-- lib/packwerk/dependency_checker.rb
 - lib/packwerk/deprecated_references.rb
 - lib/packwerk/file_processor.rb
 - lib/packwerk/files_for_processing.rb
 - 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
@@ -246,13 +255,17 @@ files:
 - lib/packwerk/parsers/erb.rb
 - lib/packwerk/parsers/factory.rb
 - lib/packwerk/parsers/ruby.rb
-- lib/packwerk/privacy_checker.rb
 - lib/packwerk/reference.rb
+- lib/packwerk/reference_checking/checkers/checker.rb
+- lib/packwerk/reference_checking/checkers/dependency_checker.rb
+- lib/packwerk/reference_checking/checkers/privacy_checker.rb
+- lib/packwerk/reference_checking/reference_checker.rb
 - lib/packwerk/reference_extractor.rb
 - lib/packwerk/reference_offense.rb
 - lib/packwerk/result.rb
 - lib/packwerk/run_context.rb
 - lib/packwerk/sanity_checker.rb
+- lib/packwerk/spring_command.rb
 - lib/packwerk/version.rb
 - lib/packwerk/violation_type.rb
 - library.yml
@@ -301,6 +314,7 @@ files:
 - sorbet/rbi/gems/parlour@6.0.0.rbi
 - sorbet/rbi/gems/parser@3.0.0.0.rbi
 - sorbet/rbi/gems/pry@0.14.0.rbi
+- sorbet/rbi/gems/psych@3.3.2.rbi
 - sorbet/rbi/gems/racc@1.5.2.rbi
 - sorbet/rbi/gems/rack-test@1.1.0.rbi
 - sorbet/rbi/gems/rack@2.2.3.rbi

data/lib/packwerk/checker.rb

@@ -1,17 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-module Packwerk
-  module Checker
-    extend T::Sig
-    extend T::Helpers
-
-    interface!
-
-    sig { returns(ViolationType).abstract }
-    def violation_type; end
-
-    sig { params(reference: Reference).returns(T::Boolean).abstract }
-    def invalid_reference?(reference); end
-  end
-end

data/lib/packwerk/dependency_checker.rb

@@ -1,26 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-module Packwerk
-  class DependencyChecker
-    extend T::Sig
-    include Checker
-
-    sig { override.returns(ViolationType) }
-    def violation_type
-      ViolationType::Dependency
-    end
-
-    sig do
-      override
-        .params(reference: Packwerk::Reference)
-        .returns(T::Boolean)
-    end
-    def invalid_reference?(reference)
-      return false unless reference.source_package
-      return false unless reference.source_package.enforce_dependencies?
-      return false if reference.source_package.dependency?(reference.constant.package)
-      true
-    end
-  end
-end

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