use_packwerk 0.51.0 → 0.53.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2b4528c3f2bf62833a4e6098e9f316e02ac3d26174738805c42da0461109415
-  data.tar.gz: 1d96176b9238a26ba97b82c5d231826f0a8485b8969bd9b74b13ed785cfbe917
+  metadata.gz: 4e5318956ac8b8fef165830d798565e79f0ef230686671fd0f66b81074b3d369
+  data.tar.gz: 8902e5d32f23d10916829928a1eff0c4d6e2b48163bf55a06f52fb32bdcfb544
 SHA512:
-  metadata.gz: b2580a1e2bf19166f41e67ee0c6ad42052da9b49c3754251e9f898ba3839b41d29c68e97bc2a35ccd01b799078a6e6ebe2a00ec705e39b7e785c4b50169e35af
-  data.tar.gz: 923ebb508fcfc122d1a1e01c7a2a6e2849258bcfb99bc2d543bea3fecd43e7f64d9467c003034d167ba9f3c4e9f6b3091284915d7e0f98cbfbd8dd45d9dee940
+  metadata.gz: 672a7e528294e21fe993ebeb2c9c22c048163374d15483a7cdc203a1c14f336a768538c68ab75febb77ee3eb1da0bd694aec1f32ea80ca621ddcade02798abb4
+  data.tar.gz: bcd5e51dfe5d3060babca2c650534ed1f8c55acb9e61f5e492c2adcd10a70998fbaa3b2cc014f3c5c9732159188b82b2e6bd6115d2b3cd155e15771ab5dee5f4

data/lib/use_packwerk/cli.rb

@@ -67,5 +67,15 @@ module UsePackwerk
         per_file_processors: [UsePackwerk::RubocopPostProcessor.new, UsePackwerk::CodeOwnershipPostProcessor.new],
       )
     end
+
+    desc "move_to_parent packs/parent_pack packs/child_pack", "Pass in a parent pack and another pack to be made as a child to the parent pack!"
+    sig { params(parent_name: String, pack_name: String).void }
+    def move_to_parent(parent_name, pack_name)
+      UsePackwerk.move_to_parent!(
+        parent_name: parent_name,
+        pack_name: pack_name,
+        per_file_processors: [UsePackwerk::RubocopPostProcessor.new, UsePackwerk::CodeOwnershipPostProcessor.new],
+      )
+    end
   end
 end

data/lib/use_packwerk/logging.rb

@@ -9,24 +9,29 @@ module UsePackwerk
     sig { params(title: String, block: T.proc.void).void }
     def self.section(title, &block)
       print_divider
-      puts ColorizedString.new("#{title}").green.bold
-      puts "\n"
+      out ColorizedString.new("#{title}").green.bold
+      out "\n"
       yield
     end
 
     sig { params(text: String).void }
     def self.print_bold_green(text)
-      puts ColorizedString.new(text).green.bold
+      out ColorizedString.new(text).green.bold
     end
 
     sig { params(text: String).void }
     def self.print(text)
-      puts text
+      out text
     end
 
     sig { void }
     def self.print_divider
-      puts '=' * 100
+      out '=' * 100
+    end
+
+    sig { params(str: String).void }
+    def self.out(str)
+      puts str
     end
   end
 end

data/lib/use_packwerk/private/file_move_operation.rb

@@ -16,37 +16,37 @@ module UsePackwerk
 
       sig { params(origin_pathname: Pathname, new_package_root: Pathname).returns(Pathname) }
       def self.destination_pathname_for_package_move(origin_pathname, new_package_root)
-        parts = origin_pathname.to_s.split('/')
-        toplevel_directory = parts[0]
+        origin_pack = T.must(ParsePackwerk.package_from_path(origin_pathname))
 
-        case toplevel_directory.to_s
-        # This allows us to move files from monolith to packs
-        when 'app', 'spec', 'lib'
+        new_implementation = nil
+        if origin_pack.name == ParsePackwerk::ROOT_PACKAGE_NAME
           new_package_root.join(origin_pathname).cleanpath
-        # This allows us to move files from packs to packs
-        when *PERMITTED_PACK_LOCATIONS # parts looks like ['packs', 'organisms', 'app', 'services', 'bird_like', 'eagle.rb']
-          new_package_root.join(T.must(parts[2..]).join('/')).cleanpath
         else
-          raise StandardError.new("Don't know how to find destination path for #{origin_pathname.inspect}")
+          Pathname.new(origin_pathname.to_s.gsub(origin_pack.name, new_package_root.to_s)).cleanpath
         end
       end
 
       sig { params(origin_pathname: Pathname).returns(Pathname) }
       def self.destination_pathname_for_new_public_api(origin_pathname)
-        parts = origin_pathname.to_s.split('/')
-        toplevel_directory = Pathname.new(parts[0])
 
-        case toplevel_directory.to_s
-        # This allows us to make API in the monolith public
-        when 'app', 'spec'
-          toplevel_directory.join('public').join(T.must(parts[2..]).join('/')).cleanpath
-        # This allows us to make API in existing packs public
-        when *PERMITTED_PACK_LOCATIONS # parts looks like ['packs', 'organisms', 'app', 'services', 'bird_like', 'eagle.rb']
-          pack_name = Pathname.new(parts[1])
-          toplevel_directory.join(pack_name).join('app/public').join(T.must(parts[4..]).join('/')).cleanpath
+        origin_pack = T.must(ParsePackwerk.package_from_path(origin_pathname))
+        if origin_pack.name == ParsePackwerk::ROOT_PACKAGE_NAME
+          filepath_without_pack_name = origin_pathname.to_s
         else
-          raise StandardError.new("Don't know how to find destination path for #{origin_pathname.inspect}")
+          filepath_without_pack_name = origin_pathname.to_s.gsub("#{origin_pack.name}/", '')
         end
+
+        # We join the pack name with the rest of the path...
+        path_parts = filepath_without_pack_name.split("/")
+        Pathname.new(origin_pack.name).join(
+          # ... keeping the "app" or "spec"
+          T.must(path_parts[0]),
+          # ... substituting "controllers," "services," etc. with "public"
+          'public',
+          # ... then the rest is the same
+          T.must(path_parts[2..]).join("/")
+        # and we take the cleanpath so `./app/...` becomes `app/...`
+        ).cleanpath
       end
 
       sig { returns(FileMoveOperation) }

data/lib/use_packwerk/private.rb

@@ -96,16 +96,6 @@ module UsePackwerk
         raise StandardError.new("Can not find package with name #{pack_name}. Make sure the argument is of the form `packs/my_pack/`")
       end
 
-      Logging.section('👋 Hi!') do
-        intro = <<~INTRO
-          You are moving a file to a pack, which is great. Check out #{UsePackwerk.config.documentation_link} for more info!
-
-          Please bring any questions or issues you have in your development process to #ruby-modularity or #product-infrastructure.
-          We'd be happy to try to help through pairing, accepting feedback, changing our process, changing our tools, and more.
-        INTRO
-        Logging.print_bold_green(intro)
-      end
-
       add_public_directory(package)
       add_readme_todo(package)
       package_location = package.directory
@@ -128,7 +118,10 @@ module UsePackwerk
             # Later, if we choose to go back to moving whole directories at a time, it should be a refactor and all tests should still pass
             #
             if origin_pathname.directory?
-              origin_pathname.glob('**/*.{rb,rake,erb}')
+              origin_pathname.glob('**/*.*').reject do |path|
+                path.to_s.include?(ParsePackwerk::PACKAGE_YML_NAME) ||
+                path.to_s.include?(ParsePackwerk::DEPRECATED_REFERENCES_YML_NAME)
+              end
             else
               origin_pathname
             end
@@ -150,26 +143,62 @@ module UsePackwerk
       per_file_processors.each do |per_file_processor|
         per_file_processor.print_final_message!
       end
+    end
 
-      Logging.section('Next steps') do
-        next_steps = <<~NEXT_STEPS
-          Your next steps might be:
-
-          1) Run `bin/packwerk update-deprecations` to update the violations. Make sure to run `spring stop` if you've added new load paths (new top-level directories) in your pack.
-
-          2) Update TODO lists for rubocop implemented protections. See #{UsePackwerk.config.documentation_link} for more info
-
-          3) Touch base with each team who owns files involved in this move
-
-          4) Expose public API in #{pack_name}/app/public. Try `bin/use_packwerk make_public #{pack_name}/path/to/file.rb`
-
-          5) Update your readme at #{pack_name}/README.md
-        NEXT_STEPS
+  sig do
+    params(
+      pack_name: String,
+      parent_name: String,
+      per_file_processors: T::Array[PerFileProcessorInterface],
+    ).void
+  end
+  def self.move_to_parent!(
+    pack_name:,
+    parent_name:,
+    per_file_processors: []
+  )
+    pack_name = Private.clean_pack_name(pack_name)
+    package = ParsePackwerk.all.find { |package| package.name == pack_name }
+    if package.nil?
+      raise StandardError.new("Can not find package with name #{pack_name}. Make sure the argument is of the form `packs/my_pack/`")
+    end
 
-        Logging.print_bold_green(next_steps)
-      end
+    parent_name = Private.clean_pack_name(parent_name)
+    parent_package = ParsePackwerk.all.find { |package| package.name == parent_name }
+    if parent_package.nil?
+      parent_package = create_pack_if_not_exists!(pack_name: parent_name, enforce_privacy: true, enforce_dependencies: true)
     end
 
+    # First we create a new pack that has the exact same properties of the old one!
+    package_last_name = package.directory.basename
+    new_package_name = parent_package.directory.join(package_last_name).to_s
+ 
+    new_package = ParsePackwerk::Package.new(
+      name: new_package_name,
+      enforce_privacy: package.enforce_dependencies,
+      enforce_dependencies: package.enforce_dependencies,
+      dependencies: package.dependencies,
+      metadata: package.metadata,
+    )
+    ParsePackwerk.write_package_yml!(new_package)
+    ParsePackwerk.bust_cache!
+
+    # Move everything from the old pack to the new one
+    self.move_to_pack!(
+      pack_name: new_package_name,
+      paths_relative_to_root: [package.directory.to_s],
+      per_file_processors: per_file_processors,
+    )
+
+    # Then delete the old package.yml and deprecated_references.yml files
+    package.yml.delete
+    deprecated_references_file = ParsePackwerk::DeprecatedReferences.for(package).pathname
+    deprecated_references_file.delete if deprecated_references_file.exist?
+
+    # Add a dependency from parent to child
+    self.add_dependency!(pack_name: parent_name, dependency_name: new_package_name)
+  end
+
     sig do
       params(
         paths_relative_to_root: T::Array[String],
@@ -177,19 +206,12 @@ module UsePackwerk
       ).void
     end
     def self.make_public!(paths_relative_to_root:, per_file_processors:)
-      Logging.section('Making files public') do
-        intro = <<~INTRO
-          You are moving some files into public API. See #{UsePackwerk.config.documentation_link} for other utilities!
-        INTRO
-        Logging.print_bold_green(intro)
-      end
-
       if paths_relative_to_root.any?
         Logging.section('File Operations') do
           file_paths = paths_relative_to_root.flat_map do |path|
             origin_pathname = Pathname.new(path).cleanpath
             if origin_pathname.directory?
-              origin_pathname.glob('**/*.rb').map(&:to_s)
+              origin_pathname.glob('**/*.*').map(&:to_s)
             else
               path
             end
@@ -197,19 +219,7 @@ module UsePackwerk
 
 
           file_move_operations = file_paths.map do |path|
-            parts = path.to_s.split('/')
-            first_part_of_path = T.must(parts[0])
-
-            if Pathname.new(first_part_of_path).dirname.join(ParsePackwerk::PACKAGE_YML_NAME).exist?
-              package_location = Pathname.new('.')
-            elsif PERMITTED_PACK_LOCATIONS.include?(first_part_of_path)
-              package_location = Pathname.new(first_part_of_path).join(T.must(parts[1]))
-            else
-              raise StandardError.new('Can only make files in the monolith or in existing packs public')
-            end
-
-            package = ParsePackwerk::Package.from(package_location.join(ParsePackwerk::PACKAGE_YML_NAME))
-
+            package = T.must(ParsePackwerk.package_from_path(path))
             origin_pathname = Pathname.new(path).cleanpath
 
             FileMoveOperation.new(
@@ -225,22 +235,6 @@ module UsePackwerk
           end
         end
       end
-      
-      Logging.section('Next steps') do
-        next_steps = <<~NEXT_STEPS
-          Your next steps might be:
-
-          1) Run `bin/packwerk update-deprecations` to update the violations. Make sure to run `spring stop` if you've added new load paths (new top-level directories) in your pack.
-
-          2) Update TODO lists for rubocop implemented protections. See #{UsePackwerk.config.documentation_link} for more info
-
-          3) Work to migrate clients of private API to your new public API
-
-          4) Update your README at packs/your_package_name/README.md
-        NEXT_STEPS
-
-        Logging.print_bold_green(next_steps)
-      end
     end
 
     sig do
@@ -250,13 +244,6 @@ module UsePackwerk
       ).void
     end
     def self.add_dependency!(pack_name:, dependency_name:)
-      Logging.section('Adding a dependency') do
-        intro = <<~INTRO
-          You are adding a dependency. See #{UsePackwerk.config.documentation_link} for other utilities!
-        INTRO
-        Logging.print_bold_green(intro)
-      end
-
       all_packages = ParsePackwerk.all
 
       pack_name = Private.clean_pack_name(pack_name)
@@ -279,18 +266,6 @@ module UsePackwerk
         metadata: package.metadata,
       )
       ParsePackwerk.write_package_yml!(new_package)
-      
-      Logging.section('Next steps') do
-        next_steps = <<~NEXT_STEPS
-          Your next steps might be:
-
-          1) Run `bin/packwerk validate` to ensure you haven't introduced a cyclic dependency
-
-          2) Run `bin/packwerk update-deprecations` to update the violations.
-        NEXT_STEPS
-
-        Logging.print_bold_green(next_steps)
-      end
     end
 
     sig { params(file_move_operation: FileMoveOperation, per_file_processors: T::Array[UsePackwerk::PerFileProcessorInterface]).void }
@@ -427,6 +402,7 @@ module UsePackwerk
 
     sig { params(original_package: ParsePackwerk::Package).returns(ParsePackwerk::Package) }
     def self.rewrite_package_with_original_packwerk_values(original_package)
+      ParsePackwerk.bust_cache!
       package_with_protection_defaults = T.must(ParsePackwerk.all.find { |package| package.name == original_package.name })
       # PackageProtections also sets `enforce_privacy` and `enforce_dependency` to be true, so we set these back down to their original values
       package = ParsePackwerk::Package.new(

data/lib/use_packwerk/rubocop_post_processor.rb

@@ -34,9 +34,11 @@ module UsePackwerk
               if destination_rubocop_todo.exist?
                 new_destination_rubocop_todo = YAML.load_file(destination_rubocop_todo).dup
               else
-                new_destination_rubocop_todo = { cop_name => { 'Exclude' => [] } }
+                new_destination_rubocop_todo = {}
               end
 
+              new_destination_rubocop_todo[cop_name] ||= { 'Exclude' => [] }
+
               new_destination_rubocop_todo[cop_name]['Exclude'] += [relative_path_to_destination.to_s]
               destination_rubocop_todo.write(YAML.dump(new_destination_rubocop_todo))
             end

data/lib/use_packwerk.rb

@@ -61,11 +61,39 @@ module UsePackwerk
     paths_relative_to_root: [],
     per_file_processors: []
   )
+    Logging.section('👋 Hi!') do
+      intro = <<~INTRO
+        You are moving a file to a pack, which is great. Check out #{UsePackwerk.config.documentation_link} for more info!
+
+        Please bring any questions or issues you have in your development process to #ruby-modularity or #product-infrastructure.
+        We'd be happy to try to help through pairing, accepting feedback, changing our process, changing our tools, and more.
+      INTRO
+      Logging.print_bold_green(intro)
+    end
+
     Private.move_to_pack!(
       pack_name: pack_name,
       paths_relative_to_root: paths_relative_to_root,
       per_file_processors: per_file_processors,
     )
+
+    Logging.section('Next steps') do
+      next_steps = <<~NEXT_STEPS
+        Your next steps might be:
+
+        1) Run `bin/packwerk update-deprecations` to update the violations. Make sure to run `spring stop` if you've added new load paths (new top-level directories) in your pack.
+
+        2) Update TODO lists for rubocop implemented protections. See #{UsePackwerk.config.documentation_link} for more info
+
+        3) Touch base with each team who owns files involved in this move
+
+        4) Expose public API in #{pack_name}/app/public. Try `bin/use_packwerk make_public #{pack_name}/path/to/file.rb`
+
+        5) Update your readme at #{pack_name}/README.md
+      NEXT_STEPS
+
+      Logging.print_bold_green(next_steps)
+    end
   end
 
   sig do
@@ -78,10 +106,33 @@ module UsePackwerk
     paths_relative_to_root: [],
     per_file_processors: []
   )
+    Logging.section('Making files public') do
+      intro = <<~INTRO
+        You are moving some files into public API. See #{UsePackwerk.config.documentation_link} for other utilities!
+      INTRO
+      Logging.print_bold_green(intro)
+    end
+
     Private.make_public!(
       paths_relative_to_root: paths_relative_to_root,
       per_file_processors: per_file_processors
     )
+  
+    Logging.section('Next steps') do
+      next_steps = <<~NEXT_STEPS
+        Your next steps might be:
+
+        1) Run `bin/packwerk update-deprecations` to update the violations. Make sure to run `spring stop` if you've added new load paths (new top-level directories) in your pack.
+
+        2) Update TODO lists for rubocop implemented protections. See #{UsePackwerk.config.documentation_link} for more info
+
+        3) Work to migrate clients of private API to your new public API
+
+        4) Update your README at packs/your_package_name/README.md
+      NEXT_STEPS
+
+      Logging.print_bold_green(next_steps)
+    end
   end
 
   sig do
@@ -94,10 +145,70 @@ module UsePackwerk
     pack_name:,
     dependency_name:
   )
+    Logging.section('Adding a dependency') do
+      intro = <<~INTRO
+        You are adding a dependency. See #{UsePackwerk.config.documentation_link} for other utilities!
+      INTRO
+      Logging.print_bold_green(intro)
+    end
+
     Private.add_dependency!(
       pack_name: pack_name,
       dependency_name: dependency_name
     )
+
+    Logging.section('Next steps') do
+      next_steps = <<~NEXT_STEPS
+        Your next steps might be:
+
+        1) Run `bin/packwerk validate` to ensure you haven't introduced a cyclic dependency
+
+        2) Run `bin/packwerk update-deprecations` to update the violations.
+      NEXT_STEPS
+
+      Logging.print_bold_green(next_steps)
+    end
+  end
+
+  sig do
+    params(
+      pack_name: String,
+      parent_name: String,
+      per_file_processors: T::Array[PerFileProcessorInterface],
+    ).void
+  end
+  def self.move_to_parent!(
+    pack_name:,
+    parent_name:,
+    per_file_processors: []
+  )
+    Logging.section('👋 Hi!') do
+      intro = <<~INTRO
+        You are moving one pack to be a child of a different pack. Check out #{UsePackwerk.config.documentation_link} for more info!
+
+        Please bring any questions or issues you have in your development process to #ruby-modularity or #product-infrastructure.
+        We'd be happy to try to help through pairing, accepting feedback, changing our process, changing our tools, and more.
+      INTRO
+      Logging.print_bold_green(intro)
+    end
+
+    Private.move_to_parent!(
+      pack_name: pack_name,
+      parent_name: parent_name,
+      per_file_processors: per_file_processors,
+    )
+
+    Logging.section('Next steps') do
+      next_steps = <<~NEXT_STEPS
+        Your next steps might be:
+
+        1) Delete the old pack when things look good: `rm -rf #{pack_name}`
+
+        2) Run `bin/packwerk update-deprecations` to update the violations. Make sure to run `spring stop` first.
+      NEXT_STEPS
+
+      Logging.print_bold_green(next_steps)
+    end
   end
 
   sig do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: use_packwerk
 version: !ruby/object:Gem::Version
-  version: 0.51.0
+  version: 0.53.0
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-03 00:00:00.000000000 Z
+date: 2022-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize