packwerk 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4ac6768688fbeb5f3933d1ec71772d6266b800bbfa51fb3d27131d35eba1dbe
-  data.tar.gz: f7c6406ca6ab82789410b998415e483f762f2e43a689921457c91e8eca743536
+  metadata.gz: ced63ca0995c039913777f3e8ba1aac428970d8fc515b1629c9212f71baab34b
+  data.tar.gz: 331b0a5f30e7104b4eb3e44920739ea592e7e3dc7df3dca339a74260fa13d62b
 SHA512:
-  metadata.gz: '09a96a3337917f29e5b49440e41457e49d0dcb66fe9d94d428472f80694232bebe8019d0aefe88704ca4284d7b5b3ee21cad001b5338a0978e733ff9752192dc'
-  data.tar.gz: 7863556c9cf8f9132d522c30e2905df58d7015e314a7d452b642e2eb163bd827fc5ff8947b7f3a926a9a0d647f5cb27ba8eba1a48b6190d6f8bee6f83bb02293
+  metadata.gz: a487a501ca28d341a888eea2e0ec13c4831897680ce1d17bef2a4943408ff718d75cffe9a50030fd93d7a2388d161c7a3cd946a0764930f89016c2f2c81e5306
+  data.tar.gz: d4685f869617c8b1141125fcaacbde96839be3d239aa2422db6f76dbcb485f42fcde97e0c6aaa580ef4abcd847ebbfd9979fe4896f0bc5c7421d104673346981

data/Gemfile.lock

@@ -87,11 +87,12 @@ GIT
 PATH
   remote: .
   specs:
-    packwerk (1.1.3)
+    packwerk (1.2.0)
       activesupport (>= 5.2)
       ast
       better_html
       constant_resolver
+      parallel
       parser
       sorbet-runtime
 
@@ -134,16 +135,16 @@ GEM
     marcel (1.0.0)
     method_source (1.0.0)
     mini_mime (1.0.3)
-    mini_portile2 (2.5.0)
+    mini_portile2 (2.5.1)
     minitest (5.14.4)
     minitest-focus (1.2.1)
       minitest (>= 4, < 6)
     mocha (1.12.0)
     nio4r (2.5.7)
-    nokogiri (1.11.2)
+    nokogiri (1.11.5)
       mini_portile2 (~> 2.5.0)
       racc (~> 1.4)
-    nokogiri (1.11.2-x86_64-darwin)
+    nokogiri (1.11.5-x86_64-darwin)
       racc (~> 1.4)
     parallel (1.20.1)
     parlour (6.0.0)
@@ -168,7 +169,7 @@ GEM
     rainbow (3.0.0)
     rake (13.0.3)
     regexp_parser (2.1.1)
-    rexml (3.2.4)
+    rexml (3.2.5)
     rubocop (1.12.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)

data/USAGE.md

@@ -1,22 +1,22 @@
 # Packwerk usage
 
 ## Table of Contents
-* [What problem does Packwerk solve?](#What-problem-does-Packwerk-solve?)
-* [What is a package?](#What-is-a-package?)
-  * [Package principles](#Package-principles)
-* [Getting started](#Getting-started)
-* [Setting up the configuration file](#Setting-up-the-configuration-file)
-  * [Inflections](#Inflections)
-* [Validating the package system](#Validating-the-package-system)
-* [Defining packages](#Defining-packages)
-  * [Package metadata](#Package-metadata)
-* [Types of boundary checks](#Types-of-boundary-checks)
-  * [Enforcing privacy boundary](#Enforcing-privacy-boundary)
-    * [Using public folders](#Using-public-folders)
-  * [Enforcing dependency boundary](#Enforcing-dependency-boundary)
-* [Checking for violations](#Checking-for-violations)
-* [Recording existing violations](#Recording-existing-violations)
-  * [Understanding the list of deprecated references](#Understanding-the-list-of-deprecated-references)
+* [What problem does Packwerk solve?](#what-problem-does-packwerk-solve)
+* [What is a package?](#what-is-a-package)
+  * [Package principles](#package-principles)
+* [Getting started](#getting-started)
+* [Setting up the configuration file](#setting-up-the-configuration-file)
+  * [Inflections](#inflections)
+* [Validating the package system](#validating-the-package-system)
+* [Defining packages](#defining-packages)
+  * [Package metadata](#package-metadata)
+* [Types of boundary checks](#types-of-boundary-checks)
+  * [Enforcing privacy boundary](#enforcing-privacy-boundary)
+    * [Using public folders](#using-public-folders)
+  * [Enforcing dependency boundary](#enforcing-dependency-boundary)
+* [Checking for violations](#checking-for-violations)
+* [Recording existing violations](#recording-existing-violations)
+  * [Understanding the list of deprecated references](#understanding-the-list-of-deprecated-references)
 
 ## What problem does Packwerk solve?
 Large applications need clear boundaries to avoid turning into a [ball of mud](https://en.wikipedia.org/wiki/Big_ball_of_mud). However, Ruby does not provide a good solution to enforcing boundaries between code.
@@ -66,6 +66,7 @@ Packwerk reads from the `packwerk.yml` configuration file in the root directory.
 | package_paths        | **/                                       | a single pattern or a list of patterns to find package configuration files, see: [Defining packages](#Defining-packages) |
 | load_paths           | All application autoload paths            | list of load paths |
 | custom_associations  | N/A                                       | list of custom associations, if any |
+| parallel             | true                                      | when true, fork code parsing out to subprocesses |
 
 ### Using a custom ERB parser
 

data/lib/packwerk.rb

@@ -3,43 +3,79 @@
 
 require "sorbet-runtime"
 require "active_support"
-require "constant_resolver"
 require "fileutils"
 
-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_style"
-require "packwerk/output_styles/plain"
-require "packwerk/output_styles/coloured"
-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"
-
 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/lib/packwerk/application_validator.rb

@@ -6,11 +6,6 @@ require "constant_resolver"
 require "pathname"
 require "yaml"
 
-require "packwerk/package_set"
-require "packwerk/graph"
-require "packwerk/inflector"
-require "packwerk/application_load_paths"
-
 module Packwerk
   class ApplicationValidator
     def initialize(config_file_path:, configuration:)

data/lib/packwerk/association_inspector.rb

@@ -1,9 +1,6 @@
 # typed: strict
 # frozen_string_literal: true
 
-require "packwerk/constant_name_inspector"
-require "packwerk/node"
-
 module Packwerk
   # Extracts the implicit constant reference from an active record association
   class AssociationInspector

data/lib/packwerk/checker.rb

@@ -1,9 +1,6 @@
 # typed: true
 # frozen_string_literal: true
 
-require "sorbet-runtime"
-require "packwerk/reference_lister"
-
 module Packwerk
   module Checker
     extend T::Sig
@@ -14,10 +11,7 @@ module Packwerk
     sig { returns(ViolationType).abstract }
     def violation_type; end
 
-    sig { params(reference: Reference, reference_lister: ReferenceLister).returns(T::Boolean).abstract }
-    def invalid_reference?(reference, reference_lister); end
-
-    sig { params(reference: Reference).returns(String).abstract }
-    def message_for(reference); end
+    sig { params(reference: Reference).returns(T::Boolean).abstract }
+    def invalid_reference?(reference); end
   end
 end

data/lib/packwerk/cli.rb

@@ -1,48 +1,32 @@
 # typed: true
 # frozen_string_literal: true
-require "benchmark"
-require "sorbet-runtime"
-
-require "packwerk/application_load_paths"
-require "packwerk/application_validator"
-require "packwerk/configuration"
-require "packwerk/files_for_processing"
-require "packwerk/formatters/offenses_formatter"
-require "packwerk/formatters/progress_formatter"
-require "packwerk/inflector"
-require "packwerk/output_style"
-require "packwerk/output_styles/plain"
-require "packwerk/run_context"
-require "packwerk/updating_deprecated_references"
-require "packwerk/checking_deprecated_references"
-require "packwerk/commands/detect_stale_violations_command"
-require "packwerk/commands/update_deprecations_command"
-require "packwerk/commands/offense_progress_marker"
 
 module Packwerk
   class Cli
     extend T::Sig
-    include OffenseProgressMarker
 
     sig do
       params(
-        run_context: T.nilable(Packwerk::RunContext),
         configuration: T.nilable(Configuration),
         out: T.any(StringIO, IO),
         err_out: T.any(StringIO, IO),
-        style: Packwerk::OutputStyle
+        style: Packwerk::OutputStyle,
+        offenses_formatter: T.nilable(Packwerk::OffensesFormatter)
       ).void
     end
-    def initialize(run_context: nil, configuration: nil, out: $stdout, err_out: $stderr, style: OutputStyles::Plain.new)
+    def initialize(
+      configuration: nil,
+      out: $stdout,
+      err_out: $stderr,
+      style: OutputStyles::Plain.new,
+      offenses_formatter: nil
+    )
       @out = out
       @err_out = err_out
       @style = style
       @configuration = configuration || Configuration.from_path
-      @run_context = run_context || Packwerk::RunContext.from_configuration(
-        @configuration,
-        reference_lister: ::Packwerk::CheckingDeprecatedReferences.new(@configuration.root_path),
-      )
       @progress_formatter = Formatters::ProgressFormatter.new(@out, style: style)
+      @offenses_formatter = offenses_formatter || Formatters::OffensesFormatter.new(style: @style)
     end
 
     sig { params(args: T::Array[String]).returns(T.noreturn) }
@@ -60,13 +44,13 @@ module Packwerk
       when "generate_configs"
         generate_configs
       when "check"
-        check(args)
+        output_result(parse_run(args).check)
       when "detect-stale-violations"
-        detect_stale_violations(args)
+        output_result(parse_run(args).detect_stale_violations)
       when "update"
         update(args)
       when "update-deprecations"
-        update_deprecations(args)
+        output_result(parse_run(args).update_deprecations)
       when "validate"
         validate(args)
       when nil, "help"
@@ -143,54 +127,10 @@ module Packwerk
 
     def update(paths)
       warn("`packwerk update` is deprecated in favor of `packwerk update-deprecations`.")
-      update_deprecations(paths)
-    end
-
-    def update_deprecations(paths)
-      update_deprecations = Commands::UpdateDeprecationsCommand.new(
-        files: fetch_files_to_process(paths),
-        configuration: @configuration,
-        offenses_formatter: offenses_formatter,
-        progress_formatter: @progress_formatter
-      )
-      result = update_deprecations.run
-      @out.puts
-      @out.puts(result.message)
-      result.status
-    end
-
-    def check(paths)
-      files = fetch_files_to_process(paths)
-
-      @progress_formatter.started(files)
-
-      all_offenses = T.let([], T.untyped)
-      execution_time = Benchmark.realtime do
-        files.each do |path|
-          @run_context.process_file(file: path).tap do |offenses|
-            mark_progress(offenses: offenses, progress_formatter: @progress_formatter)
-            all_offenses.concat(offenses)
-          end
-        end
-      rescue Interrupt
-        @out.puts
-        @out.puts("Manually interrupted. Violations caught so far are listed below:")
-      end
-
-      @progress_formatter.finished(execution_time)
-      @out.puts
-      @out.puts(offenses_formatter.show_offenses(all_offenses))
-
-      all_offenses.empty?
+      output_result(parse_run(paths).update_deprecations)
     end
 
-    def detect_stale_violations(paths)
-      detect_stale_violations = Commands::DetectStaleViolationsCommand.new(
-        files: fetch_files_to_process(paths),
-        configuration: @configuration,
-        progress_formatter: @progress_formatter
-      )
-      result = detect_stale_violations.run
+    def output_result(result)
       @out.puts
       @out.puts(result.message)
       result.status
@@ -240,8 +180,13 @@ module Packwerk
       end
     end
 
-    def offenses_formatter
-      @offenses_formatter ||= Formatters::OffensesFormatter.new(style: @style)
+    def parse_run(paths)
+      ParseRun.new(
+        files: fetch_files_to_process(paths),
+        configuration: @configuration,
+        progress_formatter: @progress_formatter,
+        offenses_formatter: @offenses_formatter
+      )
     end
   end
 end

data/lib/packwerk/configuration.rb

@@ -47,8 +47,13 @@ module Packwerk
       @custom_associations = configs["custom_associations"] || []
       @load_paths = configs["load_paths"] || []
       @inflections_file = File.expand_path(configs["inflections_file"] || "config/inflections.yml", @root_path)
+      @parallel = configs.key?("parallel") ? configs["parallel"] : true
 
       @config_path = config_path
     end
+
+    def parallel?
+      @parallel
+    end
   end
 end

data/lib/packwerk/const_node_inspector.rb

@@ -1,8 +1,6 @@
 # typed: strict
 # frozen_string_literal: true
 
-require "packwerk/constant_name_inspector"
-
 module Packwerk
   # Extracts a constant name from an AST node of type :const
   class ConstNodeInspector

data/lib/packwerk/constant_discovery.rb

@@ -1,6 +1,8 @@
 # typed: true
 # frozen_string_literal: true
 
+require "constant_resolver"
+
 module Packwerk
   # Get information about (partially qualified) constants without loading the application code.
   # Information gathered: Fully qualified name, path to file containing the definition, package,