packs 0.0.33 → 0.0.35

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12a077a66bdee9de08cb6bad39307967105ab50754ed11b134634d7b9bbb884b
-  data.tar.gz: c10559613f73c50a0654d99a4013dbf1621616839f9afb70ccffb497c5b22e77
+  metadata.gz: 29b2c810b50fb84aee08f79e49a7d6710b7bf74f8421efd2ce36a12c61bb5cb5
+  data.tar.gz: a183ed44f957f94de6736e0272193e873da6ca7d177a6cbad491682fc73596a8
 SHA512:
-  metadata.gz: e9a3bf9214c632560b6ec21d008e4be56ee27f945e211e3713d18ef0c5988f5a005641ebe7ce2688f38f07607c859032767a5cc407b8ec46fc9f84184277e95d
-  data.tar.gz: befe69448bef9fb04edd3e567178941baab9c1a89b2969eb7114678b2f350e28377a7e9e5bb68d777f674a7119cbc10ec717991d5c70b787fabfb2a63ec08e2b
+  metadata.gz: 5587b5c11a6ffcc20213ddf8c7fc5fd1efe2d82f6d461e70d38c82fa55151956225388f45313cd2a6cda88bc839a6350ee821a3afdb942929f130ef2b5c5165a
+  data.tar.gz: 3c789067155a3ff7a76eade07734f3acf884fecacea1472a1755afcba7f833bef370dd4f359b2761eeceb907615c2cbbf728bdfc0aa61056b17e9f2cb39593e0

data/README.md

@@ -30,7 +30,19 @@ Here are some example integrations with `packs`:
 A ruby [`gem`](https://guides.rubygems.org/what-is-a-gem/) is the Ruby community solution for packaging and distributing Ruby code. A gem is a great place to start new projects, and a great end state for code that's been extracted from an existing codebase. `packs` are intended to help gradually modularize an application that has some conceptual boundaries, but is not yet ready to be factored into gems.
 
 ## Usage
-Make sure to run `bundle binstub packs` to generate `bin/packs` within your application.
+1. Add the gem to your Gemfile and do a `bundle install`
+```
+gem 'packs-rails'
+gem 'packs'
+```
+
+2. Initialize packwerk
+```
+bundle binstub packwerk
+bin/packwerk init
+```
+
+3. Make sure to run `bundle binstub packs` to generate `bin/packs` within your application.
 
 ## CLI Documentation
 ## Describe available commands or one specific command

data/lib/packs/code_ownership_post_processor.rb

@@ -40,7 +40,7 @@ module Packs
       end
     end
 
-    sig { params(file_move_operations: T::Array[Private::FileMoveOperation]).void }
+    sig { override.params(file_move_operations: T::Array[Private::FileMoveOperation]).void }
     def after_move_files!(file_move_operations)
       if @teams.any?
         Logging.section('Code Ownership') do

data/lib/packs/per_file_processor_interface.rb

@@ -10,7 +10,7 @@ module Packs
     sig { abstract.params(file_move_operation: Private::FileMoveOperation).void }
     def before_move_file!(file_move_operation); end
 
-    sig { params(file_move_operations: T::Array[Private::FileMoveOperation]).void }
+    sig { overridable.params(file_move_operations: T::Array[Private::FileMoveOperation]).void }
     def after_move_files!(file_move_operations)
       nil
     end

data/lib/packs/private.rb

@@ -173,6 +173,7 @@ module Packs
         enforce_privacy: package.enforce_privacy,
         enforce_dependencies: package.enforce_dependencies,
         dependencies: package.dependencies,
+        violations: package.violations,
         metadata: package.metadata,
         config: package.config
       )
@@ -195,9 +196,6 @@ module Packs
 
       ParsePackwerk.all.each do |other_package|
         new_dependencies = other_package.dependencies.map { |d| d == pack_name ? new_package_name : d }
-        if other_package.name == parent_name && !new_dependencies.include?(new_package_name)
-          new_dependencies += [new_package_name]
-        end
 
         new_config = other_package.config.dup
         if new_config['ignored_dependencies']
@@ -206,11 +204,18 @@ module Packs
           end
         end
 
+        if other_package.name == parent_name &&
+           !new_dependencies.include?(new_package_name) &&
+           !new_config['ignored_dependencies']&.include?(new_package_name)
+          new_dependencies += [new_package_name]
+        end
+
         new_other_package = ParsePackwerk::Package.new(
           name: other_package.name,
           enforce_privacy: other_package.enforce_privacy,
           enforce_dependencies: other_package.enforce_dependencies,
           dependencies: new_dependencies.uniq.sort,
+          violations: other_package.violations,
           metadata: other_package.metadata,
           config: new_config
         )
@@ -301,6 +306,7 @@ module Packs
         dependencies: (package.dependencies + [dependency_name]).uniq.sort,
         enforce_privacy: package.enforce_privacy,
         enforce_dependencies: package.enforce_dependencies,
+        violations: package.violations,
         metadata: package.metadata,
         config: package.config
       )
@@ -392,6 +398,7 @@ module Packs
           enforce_dependencies: should_enforce_dependencies || false,
           enforce_privacy: enforce_privacy,
           dependencies: [],
+          violations: [],
           metadata: {},
           name: pack_name,
           config: config

data/lib/packs/update_references_post_processor.rb

@@ -0,0 +1,50 @@
+# typed: strict
+
+module Packs
+  class UpdateReferencesPostProcessor
+    include PerFileProcessorInterface
+
+    extend T::Sig
+
+    sig { override.params(file_move_operation: Private::FileMoveOperation).void }
+    def before_move_file!(file_move_operation)
+      nil
+    end
+
+    sig { override.params(file_move_operations: T::Array[Private::FileMoveOperation]).void }
+    def after_move_files!(file_move_operations)
+      return if file_move_operations.empty?
+
+      origin_pack = T.must(file_move_operations.first).origin_pack.name
+      destination_pack = T.must(file_move_operations.first).destination_pack.name
+
+      if self.class.ripgrep_enabled?
+        matching_files = `rg -l --hidden '#{origin_pack}' .`
+        matching_files.split("\n").each do |file_name|
+          substitute_references!(file_name, origin_pack, destination_pack)
+        end
+      else
+        Logging.print('For faster UpdateReferences install ripgrep: https://github.com/BurntSushi/ripgrep/tree/master')
+        Dir.glob('./**/*', File::FNM_DOTMATCH) do |file_name|
+          next if File.directory?(file_name)
+
+          substitute_references!(file_name, origin_pack, destination_pack)
+        end
+      end
+    end
+
+    sig { returns(T::Boolean) }
+    def self.ripgrep_enabled?
+      !!system('which', 'rg', out: File::NULL, err: :out)
+    end
+
+    private
+
+    sig { params(file_name: String, origin_pack: String, destination_pack: String).void }
+    def substitute_references!(file_name, origin_pack, destination_pack)
+      text = File.read(file_name)
+      replace = text.gsub(origin_pack, destination_pack)
+      File.open(file_name, 'w') { |file| file.puts replace }
+    end
+  end
+end

data/lib/packs.rb

@@ -16,6 +16,7 @@ require 'code_ownership'
 require 'packs/private'
 require 'packs/per_file_processor_interface'
 require 'packs/rubocop_post_processor'
+require 'packs/update_references_post_processor'
 require 'packs/code_ownership_post_processor'
 require 'packs/logging'
 require 'packs/configuration'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packs
 version: !ruby/object:Gem::Version
-  version: 0.0.33
+  version: 0.0.35
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-13 00:00:00.000000000 Z
+date: 2023-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: code_ownership
@@ -304,6 +304,7 @@ files:
 - lib/packs/private/pack_relationship_analyzer.rb
 - lib/packs/private/packwerk_wrapper/offenses_aggregator_formatter.rb
 - lib/packs/rubocop_post_processor.rb
+- lib/packs/update_references_post_processor.rb
 - lib/packs/user_event_logger.rb
 homepage: https://github.com/rubyatscale/packs
 licenses: