use_packwerk 0.52.0 → 0.53.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 546e7007cad88d3e42ed331cbb5aa054a880d4c11724786a394bc8fde8f7085a
-  data.tar.gz: ef02e6ce782b74c8537b838f9d2d7d61991b0197fd28f9e6e6fb6d9ff0a6247e
+  metadata.gz: 4e5318956ac8b8fef165830d798565e79f0ef230686671fd0f66b81074b3d369
+  data.tar.gz: 8902e5d32f23d10916829928a1eff0c4d6e2b48163bf55a06f52fb32bdcfb544
 SHA512:
-  metadata.gz: db8a175fa8ddcf0e4fe54cb57d5215ea9786ed7a67a0318f2e3377ce06f959ed48bd07f7501c861f73881d1ee460aac7d053e954efc08792d502b320bbd6c990
-  data.tar.gz: f0817b39a8e600723ab17fe6d8caaae2d279c074608f861f971db2efcafc24cffaccbff6e2f5b9715c6db6e277e6c670c6fe8425a1bb0f312690323dc9ac42d5
+  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.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
@@ -213,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
@@ -238,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)
@@ -267,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 }

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.52.0
+  version: 0.53.0
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-15 00:00:00.000000000 Z
+date: 2022-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize