use_packwerk 0.58.0 → 0.59.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b7822b93de980f116e8215d6fa79dd77f5435781a48c356e3f8b38a6be66424
-  data.tar.gz: 8791b2a49c41bbd2464e87895acf103f8ce26d76a38e631789d5b849e12e419c
+  metadata.gz: 5668eac8a84c8916b9e0febeccfce83f995738cd1189244a02b8228a3f79a90e
+  data.tar.gz: 4efad32163af39f18136b78d91aaa49973308ad72c1174fa3484aa0771afb625
 SHA512:
-  metadata.gz: 323d988c645a37414dc9d4c04b7932e61bd5712df6cea0313790fa8afcdec0a20fb5d46ea360906364db8988af1126459b1e40bfe6eff425c39f5ca6a3eccb32
-  data.tar.gz: 9bea356bd9587f6d7804b19eeb5f3f1b32b6a5601c1e97091d89e48e1f40cba24a1677afabb04c791ba1d5d9ab568dd78f210010b6c1fbc983f61a787708034b
+  metadata.gz: 4f17271b52acaf492b3bd602e586f83d376500da576ecf3ab9ab0cf65c42e3bb392427ffde85a83009fbdaca8fccb2ea7f30d2e636c9d90ca7ee2b4dce2e882a
+  data.tar.gz: b8e08da292f989b198d3c1ec1e2bd5fb9e0be3fb86bc09fc3a376a390b4cde650ee4b1ec6c628f03e75e76cc1f18d280a7c27b8336bfc24b62403b0d0e184f70

data/README.md

@@ -43,6 +43,12 @@ If no pack name is passed in, this will list out violations across all packs.
 
 This can be used to quickly modify a `package.yml` file and add a dependency. It also cleans up the list of dependencies to sort the list and remove redundant entries.
 
+### Setting up Spring
+
+[Spring](https://github.com/rails/spring) is a preloader for Rails. Although `use_packwerk` itself does not use `Rails`, this can help speed up running commands like `bin/packs` by caching the bundle.
+Firstly, spring needs to know about the `bin/packs` command when spring is loading. To do that, add `require 'use_packwerk/spring_command'` to `config/spring.rb` in your application.
+Secondly, to enable Spring, first run `bin/spring binstub packs` which will "springify" the generated binstub.
+
 ### Releasing
 Releases happen automatically through github actions once a version update is committed to `main`.
 

data/lib/use_packwerk/private/packwerk_wrapper/offenses_aggregator_formatter.rb

@@ -0,0 +1,34 @@
+# typed: strict
+
+module UsePackwerk
+  module Private
+    module PackwerkWrapper
+      #
+      # This formatter simply collects offenses so we can feed them into PackageProtections
+      #
+      class OffensesAggregatorFormatter
+        extend T::Sig
+        include Packwerk::OffensesFormatter
+
+        sig { returns(T::Array[Packwerk::ReferenceOffense]) }
+        attr_reader :aggregated_offenses
+
+        sig { void }
+        def initialize
+          @aggregated_offenses = T.let([], T::Array[Packwerk::ReferenceOffense])
+        end
+
+        sig { override.params(offenses: T::Array[T.nilable(Packwerk::Offense)]).returns(String) }
+        def show_offenses(offenses)
+          @aggregated_offenses = T.unsafe(offenses)
+          ''
+        end
+
+        sig { override.params(offense_collection: Packwerk::OffenseCollection).returns(String) }
+        def show_stale_violations(offense_collection)
+          ''
+        end
+      end
+    end
+  end
+end

data/lib/use_packwerk/private/packwerk_wrapper.rb

@@ -0,0 +1,71 @@
+# typed: strict
+
+require 'packwerk'
+require 'use_packwerk/private/packwerk_wrapper/offenses_aggregator_formatter'
+
+module UsePackwerk
+  module Private
+    module PackwerkWrapper
+      extend T::Sig
+
+      sig { params(argv: T.untyped, formatter: Packwerk::OffensesFormatter).void }
+      def self.packwerk_cli_run_safely(argv, formatter)
+        with_safe_exit_if_no_files_found do
+          packwerk_cli(formatter).run(argv)
+        end
+      end
+
+      #
+      # execute_command is like `run` except it does not `exit`
+      #
+      sig { params(argv: T.untyped, formatter: T.nilable(Packwerk::OffensesFormatter)).void }
+      def self.packwerk_cli_execute_safely(argv, formatter = nil)
+        with_safe_exit_if_no_files_found do
+          packwerk_cli(formatter).execute_command(argv)
+        end
+      end
+
+      sig { params(block: T.proc.returns(T.untyped)).void }
+      def self.with_safe_exit_if_no_files_found(&block)
+        block.call
+      rescue SystemExit => e
+        # Packwerk should probably exit positively here rather than raising an error -- there should be no
+        # errors if the user has excluded all files being checked.
+        unless e.message == 'No files found or given. Specify files or check the include and exclude glob in the config file.'
+          raise
+        end
+      end
+
+      sig { params(formatter: T.nilable(Packwerk::OffensesFormatter)).returns(Packwerk::Cli) }
+      def self.packwerk_cli(formatter)
+        # This is mostly copied from exe/packwerk within the packwerk gem, but we use our own formatters
+        # Note that packwerk does not allow you to pass in your own progress formatter currently
+        ENV['RAILS_ENV'] = 'test'
+
+        style = Packwerk::OutputStyles::Coloured.new
+        Packwerk::Cli.new(style: style, offenses_formatter: formatter)
+      end
+
+      sig { params(files: T::Array[String]).returns(T::Array[Packwerk::ReferenceOffense]) }
+      def self.get_offenses_for_files(files)
+        formatter = OffensesAggregatorFormatter.new
+        packwerk_cli_execute_safely(['check', *files], formatter)
+        formatter.aggregated_offenses.compact
+      end
+
+      sig { params(files: T::Array[String]).returns(T::Array[Packwerk::ReferenceOffense]) }
+      def self.get_offenses_for_files_by_package(files)
+        packages = package_names_for_files(files)
+        argv = ['check', '--packages', packages.join(',')]
+        formatter = OffensesAggregatorFormatter.new
+        packwerk_cli_execute_safely(argv, formatter)
+        formatter.aggregated_offenses.compact
+      end
+
+      sig { params(files: T::Array[String]).returns(T::Array[String]) }
+      def self.package_names_for_files(files)
+        files.map { |f| ParsePackwerk.package_from_path(f)&.name }.compact.uniq
+      end
+    end
+  end
+end

data/lib/use_packwerk/private.rb

@@ -8,6 +8,7 @@ require 'sorbet-runtime'
 require 'use_packwerk/private/file_move_operation'
 require 'use_packwerk/private/pack_relationship_analyzer'
 require 'use_packwerk/private/interactive_cli'
+require 'use_packwerk/private/packwerk_wrapper'
 
 module UsePackwerk
   module Private

data/lib/use_packwerk/spring_command.rb

@@ -0,0 +1,28 @@
+# typed: true
+# frozen_string_literal: true
+
+require 'spring/commands'
+
+module UsePackwerk
+  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
+      'packs'
+    end
+
+    def gem_name
+      'use_packwerk'
+    end
+
+    def call
+      load(Gem.bin_path(gem_name, exec_name))
+    end
+  end
+
+  Spring.register_command('packs', SpringCommand.new)
+end

data/lib/use_packwerk.rb

@@ -219,4 +219,30 @@ module UsePackwerk
   def self.bust_cache!
     Private.bust_cache!
   end
+
+  #
+  # execute_command is like `run` except it does not `exit`
+  #
+  sig { params(argv: T.untyped, formatter: T.nilable(Packwerk::OffensesFormatter)).void }
+  def self.execute(argv, formatter = nil)
+    Private::PackwerkWrapper.with_safe_exit_if_no_files_found do
+      Private::PackwerkWrapper.packwerk_cli(formatter).execute_command(argv)
+    end
+  end
+
+  sig { params(files: T::Array[String]).returns(T::Array[Packwerk::ReferenceOffense]) }
+  def self.get_offenses_for_files(files)
+    formatter = Private::PackwerkWrapper::OffensesAggregatorFormatter.new
+    Private::PackwerkWrapper.packwerk_cli_execute_safely(['check', *files], formatter)
+    formatter.aggregated_offenses.compact
+  end
+
+  sig { params(files: T::Array[String]).returns(T::Array[Packwerk::ReferenceOffense]) }
+  def self.get_offenses_for_files_by_package(files)
+    packages = Private::PackwerkWrapper.package_names_for_files(files)
+    argv = ['check', '--packages', packages.join(',')]
+    formatter = Private::PackwerkWrapper::OffensesAggregatorFormatter.new
+    Private::PackwerkWrapper.packwerk_cli_execute_safely(argv, formatter)
+    formatter.aggregated_offenses.compact
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: use_packwerk
 version: !ruby/object:Gem::Version
-  version: 0.58.0
+  version: 0.59.0
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-17 00:00:00.000000000 Z
+date: 2022-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: code_ownership
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: packwerk
+  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: parse_packwerk
   requirement: !ruby/object:Gem::Requirement
@@ -301,7 +315,10 @@ files:
 - lib/use_packwerk/private/interactive_cli/use_cases/update_deprecations.rb
 - lib/use_packwerk/private/interactive_cli/use_cases/validate.rb
 - lib/use_packwerk/private/pack_relationship_analyzer.rb
+- lib/use_packwerk/private/packwerk_wrapper.rb
+- lib/use_packwerk/private/packwerk_wrapper/offenses_aggregator_formatter.rb
 - lib/use_packwerk/rubocop_post_processor.rb
+- lib/use_packwerk/spring_command.rb
 - lib/use_packwerk/user_event_logger.rb
 homepage: https://github.com/rubyatscale/use_packwerk
 licenses: