packwerk 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9af43a5e2d624ca5d6b38bfa3c9e65d1d12b1b9cc148a153563ebd55d3b6c82a
-  data.tar.gz: 6dee0dac16640632fb272c72ebe024a36c6a85ba23748b2ab5886279cccd863c
+  metadata.gz: d72fbde4259baa5a5e7f8bc2ca4406d9bc6a835051efafefc23ef6ef3ae13f32
+  data.tar.gz: 65bff304e2be348e16800b0d4f65ab33a1b5fb84ab15ba495e03904d099be4a0
 SHA512:
-  metadata.gz: 197f933a60a46aba470ee66a2c04bbabcf1ff3c3386665551dbb7b8241b9357d73e7576de7edd7c322249b8d45cfc0b282616e0f9a5a665d4560964632a66806
-  data.tar.gz: ec903a206f47df277d6187afc5c17a9cfa1591446afb249f2ba62171f7c56ba8687ce403041db451eb8ea0dba842feb26cc7c32e9ff600b93e60e49eafb4584f
+  metadata.gz: e25488e4af51932d503d4120e458fe92bc4ae2945ca8009219e01f4f2e7756e0430a0d9a6176f01d864d55644f262a06fb88494234b43aae43ba254437d7fb49
+  data.tar.gz: 2c821f3e11a16c52d84f7f4e68f01e788e95d5723fd77305f69e15aba07f5f1f81ea43e9c60b6c00ca4503df036eb2b3ea0e0ae1378f0c584d7252614064f9d9

data/.github/workflows/ci.yml

@@ -1,6 +1,11 @@
 name: CI
 
-on: [push, pull_request]
+on:
+  push:
+    branches:
+      - main
+      - '*-stable'
+  pull_request:
 
 jobs:
   tests:
@@ -12,10 +17,10 @@ jobs:
           - gemfiles/Gemfile-rails-6-0
           - gemfiles/Gemfile-rails-6-1
         ruby:
-          - 2.7
-          - 3.0
-          - 3.1
-          - 3.2
+          - "2.7"
+          - "3.0"
+          - "3.1"
+          - "3.2"
     env:
       BUNDLE_GEMFILE: ${{ matrix.gemfile }}
     name: "Tests: Ruby ${{ matrix.ruby }} ${{ matrix.gemfile }}"
@@ -27,7 +32,30 @@ jobs:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
       - name: Run tests
-        run: bin/rake
+        run: bin/rake test
+  loading-tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        gemfile:
+          - Gemfile
+        ruby:
+          - "2.7"
+          - "3.0"
+          - "3.1"
+          - "3.2"
+    env:
+      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+    name: "Loading Tests: Ruby ${{ matrix.ruby }} ${{ matrix.gemfile }}"
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run tests
+        run: bin/rake test:loading
   lint:
     runs-on: ubuntu-latest
     name: Lint
@@ -36,7 +64,7 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.1
+          ruby-version: "3.1"
           bundler-cache: true
       - name: Run style checks
         run: bin/rubocop
@@ -48,7 +76,7 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.1
+          ruby-version: "3.1"
           # bundler-cache: true
       - name: Run static type checks
         run: |

data/.ruby-version

@@ -1 +1 @@
-3.2.1
+3.2.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    packwerk (3.0.1)
+    packwerk (3.1.0)
       activesupport (>= 6.0)
       ast
       better_html
@@ -60,23 +60,27 @@ GEM
       method_source (>= 0.6.7)
       rake (>= 0.9.2.2)
     method_source (1.0.0)
-    mini_portile2 (2.8.0)
+    mini_portile2 (2.8.4)
     minitest (5.16.2)
     minitest-focus (1.3.1)
       minitest (>= 4, < 6)
     mocha (1.14.0)
     netrc (0.11.0)
-    nokogiri (1.13.8)
-      mini_portile2 (~> 2.8.0)
+    nokogiri (1.15.3)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
+    nokogiri (1.15.3-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.15.3-x86_64-linux)
       racc (~> 1.4)
     parallel (1.22.1)
-    parser (3.1.2.1)
+    parser (3.2.2.0)
       ast (~> 2.4.1)
     prettier_print (0.1.0)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    racc (1.6.0)
+    racc (1.7.1)
     rack (2.2.4)
     rack-test (2.0.2)
       rack (>= 1.3)
@@ -178,6 +182,7 @@ PLATFORMS
   ruby
   x86_64-darwin
   x86_64-darwin-20
+  x86_64-linux
 
 DEPENDENCIES
   byebug

data/README.md

@@ -58,10 +58,12 @@ Read [USAGE.md](USAGE.md) for usage once Packwerk is installed on your project.
 Various third parties have built tooling on top of packwerk. Here's a selection of some that might prove useful:
 
 - https://github.com/bellroy/graphwerk draws a graph of your package dependencies
-- https://github.com/Gusto/packwerk-vscode integrates packwerk into Visual Studio Code so you can see violations right in your editor
-- https://github.com/Gusto/stimpack sets up Rails autoloading, as well as `rspec` and `FactoryBot` integration, for packages arranged in a flat list. Stimpack is quite convenient, but for autoloading we recommend to use `Rails::Engine`s instead.
+- https://github.com/rubyatscale/packwerk-vscode integrates packwerk into Visual Studio Code so you can see violations right in your editor
+- https://github.com/vinted/packwerk-intellij integrates packwerk into RubyMine so you can see violations right in your editor
+- https://github.com/rubyatscale/packs-rails sets up Rails autoloading, as well as `rspec` and `FactoryBot` integration, for packages arranged in a flat list. packs-rails is quite convenient, but for autoloading we recommend to use `Rails::Engine`s instead.
 - https://github.com/rubyatscale/danger-packwerk integrates packwerk with [danger.systems](https://danger.systems) to provide packwerk feedback as Github inline PR comments
 - https://github.com/rubyatscale/packwerk-extensions contains extensions for packwerk, including a checker for packwerk that allows you to enforce public API boundaries. This was originally extracted from `packwerk` itself.
+- https://github.com/alexevanczuk/packs is a Rust implementation of packwerk that has experimental support for non-Rails, non-Zeitwerk applications.
 
 ## Development
 

data/Rakefile

@@ -6,7 +6,16 @@ require "rake/testtask"
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.test_files = FileList["test/**/*_test.rb"].reject do |file|
+    file.include?("test/loading/")
+  end
+  t.warning = false
+end
+
+Rake::TestTask.new("test:loading") do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/loading/**/*_test.rb"]
   t.warning = false
 end
 

data/USAGE.md

@@ -172,6 +172,8 @@ Then, when you run `bin/packwerk check`, new violations will cause the following
 packs/referencing_package cannot have dependency violations on packs/defining_package because strict mode is enabled for dependency violations in packs/referencing_package/package.yml
 ```
 
+Once the `strict` mode is enabled on a package, running `bin/packwerk update-todo` will not add new violations in the package_todo.yml file and the command will return an error.
+
 ## Checking for violations
 
 After enforcing the boundary checks for a package, you may execute:
@@ -188,6 +190,10 @@ You can also specify packages for a shorter run time. When checking against pack
 
     bin/packwerk check --packages=components/your_package,components/your_other_package
 
+Using the following command line option you can also enable or disable parallel processing. It is enabled by default.
+
+    bin/packwerk check --[no-]parallel
+
 ![](static/packwerk_check.gif)
 
 In order to keep the package system valid at each version of the application, we recommend running `bin/packwerk check` in your CI pipeline.

data/dev.yml

@@ -3,7 +3,7 @@ name: packwerk
 type: ruby
 
 up:
-  - ruby: 3.2.1
+  - ruby: 3.2.2
   - bundler
 
 commands:

data/lib/packwerk/application_validator.rb

@@ -11,6 +11,9 @@ module Packwerk
   class ApplicationValidator
     include Validator
     extend T::Sig
+    extend ActiveSupport::Autoload
+
+    autoload :Helpers
 
     sig { params(package_set: PackageSet, configuration: Configuration).returns(Validator::Result) }
     def check_all(package_set, configuration)

data/lib/packwerk/checker.rb

@@ -13,14 +13,13 @@ module Packwerk
 
       sig { params(base: Class).void }
       def included(base)
-        @checkers ||= T.let(@checkers, T.nilable(T::Array[Class]))
-        @checkers ||= []
-        @checkers << base
+        checkers << base
       end
 
       sig { returns(T::Array[Checker]) }
       def all
-        T.unsafe(@checkers).map(&:new)
+        load_defaults
+        T.cast(checkers.map(&:new), T::Array[Checker])
       end
 
       sig { params(violation_type: String).returns(Checker) }
@@ -30,6 +29,16 @@ module Packwerk
 
       private
 
+      sig { void }
+      def load_defaults
+        require("packwerk/reference_checking/checkers/dependency_checker")
+      end
+
+      sig { returns(T::Array[Class]) }
+      def checkers
+        @checkers ||= T.let([], T.nilable(T::Array[Class]))
+      end
+
       sig { params(name: String).returns(Checker) }
       def checker_by_violation_type(name)
         @checker_by_violation_type ||= T.let(Checker.all.to_h do |checker|

data/lib/packwerk/cli.rb

@@ -1,8 +1,6 @@
 # typed: strict
 # frozen_string_literal: true
 
-require "optparse"
-
 module Packwerk
   # A command-line interface to Packwerk.
   class Cli
@@ -46,184 +44,23 @@ module Packwerk
 
     sig { params(args: T::Array[String]).returns(T::Boolean) }
     def execute_command(args)
-      subcommand = args.shift
-      case subcommand
-      when "init"
-        init
-      when "check"
-        output_result(parse_run(args).check)
-      when "update-todo", "update"
-        output_result(parse_run(args).update_todo)
-      when "validate"
-        validate(args)
-      when "version"
-        @out.puts(Packwerk::VERSION)
-        true
-      when nil, "help"
-        usage
-      else
-        @err_out.puts(
-          "'#{subcommand}' is not a packwerk command. See `packwerk help`."
-        )
-        false
-      end
-    end
-
-    private
-
-    sig { returns(T::Boolean) }
-    def init
-      @out.puts("📦 Initializing Packwerk...")
-
-      generate_configs
-    end
-
-    sig { returns(T::Boolean) }
-    def generate_configs
-      configuration_file = Generators::ConfigurationFile.generate(
-        root: @configuration.root_path,
-        out: @out
-      )
-
-      root_package = Generators::RootPackage.generate(root: @configuration.root_path, out: @out)
-
-      success = configuration_file && root_package
-
-      result = if success
-        <<~EOS
-
-          🎉 Packwerk is ready to be used. You can start defining packages and run `bin/packwerk check`.
-          For more information on how to use Packwerk, see: https://github.com/Shopify/packwerk/blob/main/USAGE.md
-        EOS
-      else
-        <<~EOS
-
-          ⚠️  Packwerk is not ready to be used.
-          Please check output and refer to https://github.com/Shopify/packwerk/blob/main/USAGE.md for more information.
-        EOS
-      end
-
-      @out.puts(result)
-      success
-    end
-
-    sig { returns(T::Boolean) }
-    def usage
-      @err_out.puts(<<~USAGE)
-        Usage: #{$PROGRAM_NAME} <subcommand>
-
-        Subcommands:
-          init - set up packwerk
-          check - run all checks
-          update-todo - update package_todo.yml files
-          validate - verify integrity of packwerk and package configuration
-          version - output packwerk version
-          help  - display help information about packwerk
-      USAGE
-      true
-    end
-
-    sig { params(result: Result).returns(T::Boolean) }
-    def output_result(result)
-      @out.puts
-      @out.puts(result.message)
-      result.status
-    end
-
-    sig do
-      params(
-        relative_file_paths: T::Array[String],
-        ignore_nested_packages: T::Boolean
-      ).returns(FilesForProcessing)
-    end
-    def fetch_files_to_process(relative_file_paths, ignore_nested_packages)
-      files_for_processing = FilesForProcessing.fetch(
-        relative_file_paths: relative_file_paths,
-        ignore_nested_packages: ignore_nested_packages,
-        configuration: @configuration
-      )
-      @out.puts(<<~MSG.squish) if files_for_processing.files.empty?
-        No files found or given.
-        Specify files or check the include and exclude glob in the config file.
-      MSG
-
-      files_for_processing
-    end
-
-    sig { params(_paths: T::Array[String]).returns(T::Boolean) }
-    def validate(_paths)
-      result = T.let(nil, T.nilable(Validator::Result))
-
-      @progress_formatter.started_validation do
-        result = validator.check_all(package_set, @configuration)
-
-        list_validation_errors(result)
-      end
-
-      T.must(result).ok?
-    end
-
-    sig { returns(ApplicationValidator) }
-    def validator
-      ApplicationValidator.new
-    end
-
-    sig { returns(PackageSet) }
-    def package_set
-      PackageSet.load_all_from(
-        @configuration.root_path,
-        package_pathspec: @configuration.package_paths
-      )
-    end
-
-    sig { params(result: Validator::Result).void }
-    def list_validation_errors(result)
-      @out.puts
-      if result.ok?
-        @out.puts("Validation successful 🎉")
+      command = args.shift || "help"
+      command_class = Commands.for(command)
+
+      if command_class
+        command_class.new(
+          args,
+          configuration: @configuration,
+          out: @out,
+          err_out: @err_out,
+          progress_formatter: @progress_formatter,
+          offenses_formatter: @offenses_formatter,
+        ).run
       else
-        @out.puts("Validation failed ❗")
-        @out.puts
-        @out.puts(result.error_value)
-      end
-    end
-
-    sig { params(args: T::Array[String]).returns(ParseRun) }
-    def parse_run(args)
-      relative_file_paths = T.let([], T::Array[String])
-      ignore_nested_packages = nil
-      formatter = @offenses_formatter
+        @err_out.puts("'#{command}' is not a packwerk command. See `packwerk help`.",)
 
-      if args.any? { |arg| arg.include?("--packages") }
-        OptionParser.new do |parser|
-          parser.on("--packages=PACKAGESLIST", Array, "package names, comma separated") do |p|
-            relative_file_paths = p
-          end
-        end.parse!(args)
-        ignore_nested_packages = true
-      else
-        relative_file_paths = args
-        ignore_nested_packages = false
-      end
-
-      if args.any? { |arg| arg.include?("--offenses-formatter") }
-        OptionParser.new do |parser|
-          parser.on("--offenses-formatter=FORMATTER", String,
-            "identifier of offenses formatter to use") do |formatter_identifier|
-            formatter = OffensesFormatter.find(formatter_identifier)
-          end
-        end.parse!(args)
+        false
       end
-
-      files_for_processing = fetch_files_to_process(relative_file_paths, ignore_nested_packages)
-
-      ParseRun.new(
-        relative_file_set: files_for_processing.files,
-        file_set_specified: files_for_processing.files_specified?,
-        configuration: @configuration,
-        progress_formatter: @progress_formatter,
-        offenses_formatter: formatter
-      )
     end
   end
 end

data/lib/packwerk/commands/base_command.rb

@@ -0,0 +1,69 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Packwerk
+  module Commands
+    class BaseCommand
+      extend T::Sig
+      extend T::Helpers
+      abstract!
+
+      @description = T.let("", String)
+
+      class << self
+        extend T::Sig
+
+        sig { params(description: T.nilable(String)).returns(String) }
+        def description(description = nil)
+          if description
+            @description = description
+          else
+            @description
+          end
+        end
+      end
+
+      sig do
+        params(
+          args: T::Array[String],
+          configuration: Configuration,
+          out: T.any(StringIO, IO),
+          err_out: T.any(StringIO, IO),
+          progress_formatter: Formatters::ProgressFormatter,
+          offenses_formatter: OffensesFormatter,
+        ).void
+      end
+      def initialize(args, configuration:, out:, err_out:, progress_formatter:, offenses_formatter:)
+        @args = args
+        @configuration = configuration
+        @out = out
+        @err_out = err_out
+        @progress_formatter = progress_formatter
+        @offenses_formatter = offenses_formatter
+      end
+
+      sig { abstract.returns(T::Boolean) }
+      def run; end
+
+      private
+
+      sig { returns(T::Array[String]) }
+      attr_reader :args
+
+      sig { returns(Configuration) }
+      attr_reader :configuration
+
+      sig { returns(T.any(StringIO, IO)) }
+      attr_reader :out
+
+      sig { returns(T.any(StringIO, IO)) }
+      attr_reader :err_out
+
+      sig { returns(Formatters::ProgressFormatter) }
+      attr_reader :progress_formatter
+
+      sig { returns(OffensesFormatter) }
+      attr_reader :offenses_formatter
+    end
+  end
+end

data/lib/packwerk/commands/check_command.rb

@@ -0,0 +1,60 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Packwerk
+  module Commands
+    class CheckCommand < BaseCommand
+      extend T::Sig
+      include UsesParseRun
+
+      description "run all checks"
+
+      sig { override.returns(T::Boolean) }
+      def run
+        if @files_for_processing.files.empty?
+          out.puts(<<~MSG.squish)
+            No files found or given.
+            Specify files or check the include and exclude glob in the config file.
+          MSG
+
+          true
+        end
+
+        all_offenses = T.let([], T::Array[Offense])
+        on_interrupt = T.let(-> { progress_formatter.interrupted }, T.proc.void)
+
+        progress_formatter.started_inspection(@files_for_processing.files) do
+          all_offenses = parse_run.find_offenses(run_context, on_interrupt: on_interrupt) do |offenses|
+            failed = offenses.any? { |offense| !offense_collection.listed?(offense) }
+            progress_formatter.increment_progress(failed)
+          end
+        end
+        offense_collection.add_offenses(all_offenses)
+
+        messages = [
+          offenses_formatter.show_offenses(offense_collection.outstanding_offenses),
+          offenses_formatter.show_stale_violations(offense_collection, @files_for_processing.files),
+          offenses_formatter.show_strict_mode_violations(offense_collection.strict_mode_violations),
+        ]
+
+        out.puts(messages.select(&:present?).join("\n") + "\n")
+
+        offense_collection.outstanding_offenses.empty? &&
+          !offense_collection.stale_violations?(@files_for_processing.files) &&
+          offense_collection.strict_mode_violations.empty?
+      end
+
+      private
+
+      sig { returns(RunContext) }
+      def run_context
+        @run_context ||= T.let(RunContext.from_configuration(configuration), T.nilable(RunContext))
+      end
+
+      sig { returns(OffenseCollection) }
+      def offense_collection
+        @offense_collection ||= T.let(OffenseCollection.new(configuration.root_path), T.nilable(OffenseCollection))
+      end
+    end
+  end
+end

data/lib/packwerk/commands/help_command.rb

@@ -0,0 +1,33 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Packwerk
+  module Commands
+    class HelpCommand < BaseCommand
+      extend T::Sig
+
+      description "display help information about packwerk"
+
+      sig { override.returns(T::Boolean) }
+      def run
+        err_out.puts(<<~USAGE)
+          Usage: #{$PROGRAM_NAME} <subcommand>
+
+          Subcommands:
+          #{command_help_lines}
+        USAGE
+
+        true
+      end
+
+      private
+
+      sig { returns(String) }
+      def command_help_lines
+        Commands.all.map do |command|
+          "  #{command.name} - #{command.description}"
+        end.join("\n")
+      end
+    end
+  end
+end

data/lib/packwerk/commands/init_command.rb

@@ -0,0 +1,42 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Packwerk
+  module Commands
+    class InitCommand < BaseCommand
+      extend T::Sig
+
+      description "set up packwerk"
+
+      sig { override.returns(T::Boolean) }
+      def run
+        out.puts("📦 Initializing Packwerk...")
+
+        configuration_file = Generators::ConfigurationFile.generate(
+          root: configuration.root_path,
+          out: out
+        )
+
+        root_package = Generators::RootPackage.generate(root: configuration.root_path, out: out)
+
+        success = configuration_file && root_package
+
+        if success
+          out.puts(<<~EOS)
+
+            🎉 Packwerk is ready to be used. You can start defining packages and run `bin/packwerk check`.
+            For more information on how to use Packwerk, see: https://github.com/Shopify/packwerk/blob/main/USAGE.md
+          EOS
+        else
+          out.puts(<<~EOS)
+
+            ⚠️  Packwerk is not ready to be used.
+            Please check output and refer to https://github.com/Shopify/packwerk/blob/main/USAGE.md for more information.
+          EOS
+        end
+
+        success
+      end
+    end
+  end
+end