packwerk 1.1.0 → 1.2.0

data/lib/packwerk/parse_run.rb

@@ -0,0 +1,104 @@
+# typed: true
+# frozen_string_literal: true
+
+require "benchmark"
+require "parallel"
+
+module Packwerk
+  class ParseRun
+    extend T::Sig
+
+    def initialize(
+      files:,
+      configuration:,
+      progress_formatter: Formatters::ProgressFormatter.new(StringIO.new),
+      offenses_formatter: Formatters::OffensesFormatter.new
+    )
+      @configuration = configuration
+      @progress_formatter = progress_formatter
+      @offenses_formatter = offenses_formatter
+      @files = files
+    end
+
+    def detect_stale_violations
+      offense_collection = find_offenses
+
+      result_status = !offense_collection.stale_violations?
+      message = if result_status
+        "No stale violations detected"
+      else
+        "There were stale violations found, please run `packwerk update-deprecations`"
+      end
+
+      Result.new(message: message, status: result_status)
+    end
+
+    def update_deprecations
+      offense_collection = find_offenses
+      offense_collection.dump_deprecated_references_files
+
+      message = <<~EOS
+        #{@offenses_formatter.show_offenses(offense_collection.errors)}
+        ✅ `deprecated_references.yml` has been updated.
+      EOS
+
+      Result.new(message: message, status: offense_collection.errors.empty?)
+    end
+
+    def check
+      offense_collection = find_offenses(show_errors: true)
+      message = @offenses_formatter.show_offenses(offense_collection.outstanding_offenses)
+      Result.new(message: message, status: offense_collection.outstanding_offenses.empty?)
+    end
+
+    private
+
+    def find_offenses(show_errors: false)
+      offense_collection = OffenseCollection.new(@configuration.root_path)
+      @progress_formatter.started(@files)
+
+      run_context = Packwerk::RunContext.from_configuration(@configuration)
+      all_offenses = T.let([], T.untyped)
+
+      process_file = -> (path) do
+        run_context.process_file(file: path).tap do |offenses|
+          failed = show_errors && offenses.any? { |offense| !offense_collection.listed?(offense) }
+          update_progress(failed: failed)
+        end
+      end
+
+      execution_time = Benchmark.realtime do
+        all_offenses = if @configuration.parallel?
+          Parallel.flat_map(@files, &process_file)
+        else
+          serial_find_offenses(&process_file)
+        end
+      end
+
+      @progress_formatter.finished(execution_time)
+
+      all_offenses.each { |offense| offense_collection.add_offense(offense) }
+      offense_collection
+    end
+
+    def serial_find_offenses
+      all_offenses = T.let([], T.untyped)
+      @files.each do |path|
+        offenses = yield path
+        all_offenses.concat(offenses)
+      end
+      all_offenses
+    rescue Interrupt
+      @progress_formatter.interrupted
+      all_offenses
+    end
+
+    def update_progress(failed: false)
+      if failed
+        @progress_formatter.mark_as_failed
+      else
+        @progress_formatter.mark_as_inspected
+      end
+    end
+  end
+end

data/lib/packwerk/parsed_constant_definitions.rb

@@ -3,8 +3,6 @@
 
 require "ast/node"
 
-require "packwerk/node"
-
 module Packwerk
   class ParsedConstantDefinitions
     def initialize(root_node:)
@@ -28,8 +26,8 @@ module Packwerk
 
       fully_qualified_constant_name = "::#{constant_name}"
 
-      possible_namespaces = namespace_path.reduce([""]) do |acc, current|
-        acc << acc.last + "::" + current
+      possible_namespaces = namespace_path.each_with_object([""]) do |current, acc|
+        acc << "#{acc.last}::#{current}" if acc.last && current
       end
 
       possible_namespaces.map { |namespace| namespace + fully_qualified_constant_name }

data/lib/packwerk/parsers/erb.rb

@@ -6,8 +6,6 @@ require "better_html"
 require "better_html/parser"
 require "parser/source/buffer"
 
-require "packwerk/parsers"
-
 module Packwerk
   module Parsers
     class Erb

data/lib/packwerk/parsers/factory.rb

@@ -3,8 +3,6 @@
 
 require "singleton"
 
-require "packwerk/parsers"
-
 module Packwerk
   module Parsers
     class Factory
@@ -31,7 +29,7 @@ module Packwerk
       end
 
       def erb_parser_class
-        @erb_parser_class || Erb
+        @erb_parser_class ||= Erb
       end
 
       def erb_parser_class=(klass)

data/lib/packwerk/parsers.rb

@@ -1,8 +1,6 @@
 # typed: true
 # frozen_string_literal: true
 
-require "packwerk/offense"
-
 module Packwerk
   module Parsers
     autoload :Erb, "packwerk/parsers/erb"

data/lib/packwerk/privacy_checker.rb

@@ -1,46 +1,51 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
-require "packwerk/violation_type"
-require "packwerk/checker"
-
 module Packwerk
   class PrivacyChecker
+    extend T::Sig
     include Checker
 
+    sig { override.returns(Packwerk::ViolationType) }
     def violation_type
       ViolationType::Privacy
     end
 
-    def invalid_reference?(reference, reference_lister)
-      return if reference.constant.public?
+    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 if enforcement_disabled?(privacy_option)
+      return false if enforcement_disabled?(privacy_option)
 
-      return unless privacy_option == true ||
+      return false unless privacy_option == true ||
         explicitly_private_constant?(reference.constant, explicitly_private_constants: privacy_option)
 
-      return if reference_lister.listed?(reference, violation_type: violation_type)
-
       true
     end
 
-    def message_for(reference)
-      source_desc = reference.source_package ? "'#{reference.source_package}'" : "here"
-      "Privacy violation: '#{reference.constant.name}' is private to '#{reference.constant.package}' but " \
-        "referenced from #{source_desc}.\n" \
-        "Is there a public entrypoint in '#{reference.constant.package.public_path}' that you can use instead?"
-    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

data/lib/packwerk/reference_extractor.rb

@@ -1,14 +1,6 @@
 # typed: true
 # frozen_string_literal: true
 
-require "sorbet-runtime"
-
-require "packwerk/constant_discovery"
-require "packwerk/constant_name_inspector"
-require "packwerk/node"
-require "packwerk/parsed_constant_definitions"
-require "packwerk/reference"
-
 module Packwerk
   # extracts a possible constant reference from a given AST node
   class ReferenceExtractor

data/lib/packwerk/reference_offense.rb

@@ -0,0 +1,49 @@
+# typed: true
+# frozen_string_literal: true
+
+module Packwerk
+  class ReferenceOffense < Offense
+    extend T::Sig
+    extend T::Helpers
+
+    attr_reader :reference, :violation_type
+
+    sig do
+      params(
+        reference: Packwerk::Reference,
+        violation_type: Packwerk::ViolationType,
+        location: T.nilable(Node::Location)
+      )
+        .void
+    end
+    def initialize(reference:, violation_type:, location: nil)
+      super(file: reference.relative_path, message: build_message(reference, violation_type), location: location)
+      @reference = reference
+      @violation_type = violation_type
+    end
+
+    private
+
+    def build_message(reference, violation_type)
+      violation_message = case violation_type
+      when ViolationType::Privacy
+        source_desc = reference.source_package ? "'#{reference.source_package}'" : "here"
+        "Privacy violation: '#{reference.constant.name}' is private to '#{reference.constant.package}' but " \
+        "referenced from #{source_desc}.\n" \
+        "Is there a public entrypoint in '#{reference.constant.package.public_path}' that you can use instead?"
+      when ViolationType::Dependency
+        "Dependency violation: #{reference.constant.name} belongs to '#{reference.constant.package}', but " \
+        "'#{reference.source_package}' does not specify a dependency on " \
+        "'#{reference.constant.package}'.\n" \
+        "Are we missing an abstraction?\n" \
+        "Is the code making the reference, and the referenced constant, in the right packages?\n"
+      end
+
+      <<~EOS
+        #{violation_message}
+        Inference details: this is a reference to #{reference.constant.name} which seems to be defined in #{reference.constant.location}.
+        To receive help interpreting or resolving this error message, see: https://github.com/Shopify/packwerk/blob/main/TROUBLESHOOT.md#Troubleshooting-violations
+      EOS
+    end
+  end
+end

data/lib/packwerk/result.rb

@@ -0,0 +1,9 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Packwerk
+  class Result < T::Struct
+    prop :message, String
+    prop :status, T::Boolean
+  end
+end

data/lib/packwerk/run_context.rb

@@ -3,17 +3,6 @@
 
 require "constant_resolver"
 
-require "packwerk/association_inspector"
-require "packwerk/constant_discovery"
-require "packwerk/const_node_inspector"
-require "packwerk/dependency_checker"
-require "packwerk/file_processor"
-require "packwerk/inflector"
-require "packwerk/package_set"
-require "packwerk/privacy_checker"
-require "packwerk/reference_extractor"
-require "packwerk/node_processor_factory"
-
 module Packwerk
   class RunContext
     extend T::Sig
@@ -27,23 +16,20 @@ module Packwerk
       :checker_classes,
     )
 
-    attr_accessor :reference_lister
-
     DEFAULT_CHECKERS = [
       ::Packwerk::DependencyChecker,
       ::Packwerk::PrivacyChecker,
     ]
 
     class << self
-      def from_configuration(configuration, reference_lister:)
+      def from_configuration(configuration)
         inflector = ::Packwerk::Inflector.from_file(configuration.inflections_file)
         new(
           root_path: configuration.root_path,
           load_paths: configuration.load_paths,
           package_paths: configuration.package_paths,
           inflector: inflector,
-          custom_associations: configuration.custom_associations,
-          reference_lister: reference_lister,
+          custom_associations: configuration.custom_associations
         )
       end
     end
@@ -54,8 +40,7 @@ module Packwerk
       package_paths: nil,
       inflector: nil,
       custom_associations: [],
-      checker_classes: DEFAULT_CHECKERS,
-      reference_lister:
+      checker_classes: DEFAULT_CHECKERS
     )
       @root_path = root_path
       @load_paths = load_paths
@@ -63,7 +48,6 @@ module Packwerk
       @inflector = inflector
       @custom_associations = custom_associations
       @checker_classes = checker_classes
-      @reference_lister = reference_lister
     end
 
     sig { params(file: String).returns(T::Array[T.nilable(::Packwerk::Offense)]) }
@@ -84,8 +68,7 @@ module Packwerk
         context_provider: context_provider,
         checkers: checkers,
         root_path: root_path,
-        constant_name_inspectors: constant_name_inspectors,
-        reference_lister: reference_lister
+        constant_name_inspectors: constant_name_inspectors
       )
     end
 

data/lib/packwerk/sanity_checker.rb

@@ -1,8 +1,6 @@
-# typed: ignore
+# typed: false
 # frozen_string_literal: true
 
-require "packwerk/application_validator"
-
 module Packwerk
   # To do: This alias and file should be removed as it is deprecated
   warn("DEPRECATION WARNING: Packwerk::SanityChecker is deprecated, use Packwerk::ApplicationValidator instead.")

data/lib/packwerk/spring_command.rb

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

data/lib/packwerk/version.rb

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

data/lib/packwerk/violation_type.rb

@@ -1,8 +1,6 @@
 # typed: true
 # frozen_string_literal: true
 
-require "sorbet-runtime"
-
 module Packwerk
   class ViolationType < T::Enum
     enums do

data/lib/packwerk.rb

@@ -3,40 +3,79 @@
 
 require "sorbet-runtime"
 require "active_support"
-require "constant_resolver"
-
-require "packwerk/offense"
-
-require "packwerk/application_validator"
-require "packwerk/association_inspector"
-require "packwerk/checking_deprecated_references"
-require "packwerk/cli"
-require "packwerk/configuration"
-require "packwerk/const_node_inspector"
-require "packwerk/constant_discovery"
-require "packwerk/dependency_checker"
-require "packwerk/deprecated_references"
-require "packwerk/files_for_processing"
-require "packwerk/file_processor"
-require "packwerk/formatters/progress_formatter"
-require "packwerk/generators/application_validation"
-require "packwerk/generators/configuration_file"
-require "packwerk/generators/inflections_file"
-require "packwerk/generators/root_package"
-require "packwerk/graph"
-require "packwerk/inflector"
-require "packwerk/node_processor"
-require "packwerk/node_visitor"
-require "packwerk/output_styles"
-require "packwerk/package"
-require "packwerk/package_set"
-require "packwerk/parsers"
-require "packwerk/privacy_checker"
-require "packwerk/reference_extractor"
-require "packwerk/run_context"
-require "packwerk/updating_deprecated_references"
-require "packwerk/version"
-require "packwerk/violation_type"
+require "fileutils"
 
 module Packwerk
+  extend ActiveSupport::Autoload
+
+  autoload :ApplicationLoadPaths
+  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
+  autoload :NodeVisitor
+  autoload :Offense
+  autoload :OffensesFormatter
+  autoload :OutputStyle
+  autoload :Package
+  autoload :PackageSet
+  autoload :ParsedConstantDefinitions
+  autoload :Parsers
+  autoload :ParseRun
+  autoload :PrivacyChecker
+  autoload :Reference
+  autoload :ReferenceExtractor
+  autoload :ReferenceOffense
+  autoload :Result
+  autoload :RunContext
+  autoload :Version
+  autoload :ViolationType
+
+  module Inflections
+    extend ActiveSupport::Autoload
+
+    autoload :Custom
+    autoload :Default
+  end
+
+  module OutputStyles
+    extend ActiveSupport::Autoload
+
+    autoload :Coloured
+    autoload :Plain
+  end
+
+  autoload_under "commands" do
+    autoload :OffenseProgressMarker
+  end
+
+  module Formatters
+    extend ActiveSupport::Autoload
+
+    autoload :OffensesFormatter
+    autoload :ProgressFormatter
+  end
+
+  module Generators
+    extend ActiveSupport::Autoload
+
+    autoload :ApplicationValidation
+    autoload :ConfigurationFile
+    autoload :InflectionsFile
+    autoload :RootPackage
+  end
 end

data/library.yml

@@ -3,4 +3,4 @@ name: Packwerk
 stewards:
 - "@Shopify/kernel-architecture-patterns"
 slack_channels:
-- architecture-patterns
+- code-foundations

data/packwerk.gemspec

@@ -42,6 +42,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency("activesupport", ">= 5.2")
   spec.add_dependency("constant_resolver")
+  spec.add_dependency("parallel")
   spec.add_dependency("sorbet-runtime")
 
   spec.add_development_dependency("bundler")

data/service.yml

@@ -1,6 +1,3 @@
-# https://services.shopify.io/services/packwerk/production
-org_line: Kernel
-owners: Shopify/kernel-architecture-patterns
 classification: library
 slack_channels:
-  - architecture-patterns
+- core-stewardship

data/shipit.rubygems.yml

@@ -1 +1,5 @@
-# default configs
+dependencies:
+  override: []
+deploy:
+  override:
+  - release-gem packwerk.gemspec rake release