use_packwerk 0.54.0 → 0.56.0

data/lib/use_packwerk/private.rb

@@ -18,25 +18,26 @@ module UsePackwerk
       # This results in the pack not being found, but when we write the package YML it writes to the same place,
       # causing a behaviorally confusing diff.
       # We ignore trailing slashes as an ergonomic feature to the user.
-      pack_name.gsub(/\/$/, '')
+      pack_name.gsub(%r{/$}, '')
     end
 
     sig do
       params(
         file: String,
         find: Pathname,
-        replace_with: Pathname,
+        replace_with: Pathname
       ).void
     end
     def self.replace_in_file(file:, find:, replace_with:)
       file = Pathname.new(file)
       return if !file.exist?
+
       count = 0
       file.write(file.read.gsub(find.to_s) do
         count += 1
         replace_with.to_s
       end)
-      Logging.print "Replaced #{count} occurrence(s) of #{find} in #{file.to_s}" if count > 0
+      Logging.print "Replaced #{count} occurrence(s) of #{find} in #{file}" if count > 0
     end
 
     sig do
@@ -48,12 +49,7 @@ module UsePackwerk
     end
     def self.create_pack!(pack_name:, enforce_privacy:, enforce_dependencies:)
       Logging.section('👋 Hi!') do
-        intro = <<~INTRO
-          You are creating 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
+        intro = UsePackwerk.config.user_event_logger.before_create_pack(pack_name)
         Logging.print_bold_green(intro)
       end
 
@@ -64,19 +60,7 @@ module UsePackwerk
       add_readme_todo(package)
 
       Logging.section('Next steps') do
-        next_steps = <<~NEXT_STEPS
-          Your next steps might be:
-
-          1) Move files into your pack with `bin/use_packwerk move #{pack_name} path/to/file.rb`
-
-          2) 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.
-
-          3) Update TODO lists for rubocop implemented protections. See #{UsePackwerk.config.documentation_link} for more info
-
-          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
+        next_steps = UsePackwerk.config.user_event_logger.after_create_pack(pack_name)
 
         Logging.print_bold_green(next_steps)
       end
@@ -91,9 +75,9 @@ module UsePackwerk
     end
     def self.move_to_pack!(pack_name:, paths_relative_to_root:, per_file_processors: [])
       pack_name = Private.clean_pack_name(pack_name)
-      package = ParsePackwerk.all.find { |package| package.name == pack_name }
+      package = ParsePackwerk.all.find { |p| p.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/`")
+        raise StandardError, "Can not find package with name #{pack_name}. Make sure the argument is of the form `packs/my_pack/`"
       end
 
       add_public_directory(package)
@@ -118,9 +102,9 @@ 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('**/*.*').reject do |path|
-                path.to_s.include?(ParsePackwerk::PACKAGE_YML_NAME) ||
-                path.to_s.include?(ParsePackwerk::DEPRECATED_REFERENCES_YML_NAME)
+              origin_pathname.glob('**/*.*').reject do |origin_path|
+                origin_path.to_s.include?(ParsePackwerk::PACKAGE_YML_NAME) ||
+                  origin_path.to_s.include?(ParsePackwerk::DEPRECATED_REFERENCES_YML_NAME)
               end
             else
               origin_pathname
@@ -130,7 +114,7 @@ module UsePackwerk
             FileMoveOperation.new(
               origin_pathname: origin_pathname,
               destination_pathname: FileMoveOperation.destination_pathname_for_package_move(origin_pathname, package_location),
-              destination_pack: package,
+              destination_pack: package
             )
           end
           file_move_operations.each do |file_move_operation|
@@ -140,89 +124,87 @@ module UsePackwerk
         end
       end
 
-      per_file_processors.each do |per_file_processor|
-        per_file_processor.print_final_message!
-      end
+      per_file_processors.each(&:print_final_message!)
     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: []
-  )
-    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
-
-    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)
+    sig do
+      params(
+        pack_name: String,
+        parent_name: String,
+        per_file_processors: T::Array[PerFileProcessorInterface]
+      ).void
     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,
+    def self.move_to_parent!(
+      pack_name:,
+      parent_name:,
+      per_file_processors: []
     )
+      pack_name = Private.clean_pack_name(pack_name)
+      package = ParsePackwerk.all.find { |p| p.name == pack_name }
+      if package.nil?
+        raise StandardError, "Can not find package with name #{pack_name}. Make sure the argument is of the form `packs/my_pack/`"
+      end
 
-    # 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?
+      parent_name = Private.clean_pack_name(parent_name)
+      parent_package = ParsePackwerk.all.find { |p| p.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
 
-    ParsePackwerk.bust_cache!
+      # 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
 
-    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_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!
 
-      new_other_package = ParsePackwerk::Package.new(
-        name: other_package.name,
-        enforce_privacy: other_package.enforce_dependencies,
-        enforce_dependencies: other_package.enforce_dependencies,
-        dependencies: new_dependencies.uniq.sort,
-        metadata: other_package.metadata,
+      # Move everything from the old pack to the new one
+      move_to_pack!(
+        pack_name: new_package_name,
+        paths_relative_to_root: [package.directory.to_s],
+        per_file_processors: per_file_processors
       )
 
-      ParsePackwerk.write_package_yml!(new_other_package)
-    end
+      # 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?
 
-    sorbet_config = Pathname.new('sorbet/config')
-    if sorbet_config.exist?
-      UsePackwerk.replace_in_file(
-        file: sorbet_config.to_s,
-        find: package.directory.join('spec'),
-        replace_with: new_package.directory.join('spec'),
-      )
+      ParsePackwerk.bust_cache!
+
+      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_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,
+          metadata: other_package.metadata
+        )
+
+        ParsePackwerk.write_package_yml!(new_other_package)
+      end
+
+      sorbet_config = Pathname.new('sorbet/config')
+      if sorbet_config.exist?
+        UsePackwerk.replace_in_file(
+          file: sorbet_config.to_s,
+          find: package.directory.join('spec'),
+          replace_with: new_package.directory.join('spec')
+        )
+      end
     end
-  end
 
     sig do
       params(
@@ -242,7 +224,6 @@ module UsePackwerk
             end
           end
 
-
           file_move_operations = file_paths.map do |path|
             package = T.must(ParsePackwerk.package_from_path(path))
             origin_pathname = Pathname.new(path).cleanpath
@@ -250,7 +231,7 @@ module UsePackwerk
             FileMoveOperation.new(
               origin_pathname: origin_pathname,
               destination_pathname: FileMoveOperation.destination_pathname_for_new_public_api(origin_pathname),
-              destination_pack: package,
+              destination_pack: package
             )
           end
 
@@ -272,15 +253,15 @@ module UsePackwerk
       all_packages = ParsePackwerk.all
 
       pack_name = Private.clean_pack_name(pack_name)
-      package = all_packages.find { |package| package.name == pack_name }
+      package = all_packages.find { |p| p.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/`")
+        raise StandardError, "Can not find package with name #{pack_name}. Make sure the argument is of the form `packs/my_pack/`"
       end
 
       dependency_name = Private.clean_pack_name(dependency_name)
-      package_dependency = all_packages.find { |package| package.name == dependency_name }
+      package_dependency = all_packages.find { |p| p.name == dependency_name }
       if package_dependency.nil?
-        raise StandardError.new("Can not find package with name #{dependency_name}. Make sure the argument is of the form `packs/my_pack/`")
+        raise StandardError, "Can not find package with name #{dependency_name}. Make sure the argument is of the form `packs/my_pack/`"
       end
 
       new_package = ParsePackwerk::Package.new(
@@ -288,7 +269,7 @@ module UsePackwerk
         dependencies: (package.dependencies + [dependency_name]).uniq.sort,
         enforce_privacy: package.enforce_privacy,
         enforce_dependencies: package.enforce_dependencies,
-        metadata: package.metadata,
+        metadata: package.metadata
       )
       ParsePackwerk.write_package_yml!(new_package)
     end
@@ -322,63 +303,29 @@ module UsePackwerk
         # use git mv so that git knows that it was a move
         FileUtils.mv(origin, destination)
       elsif !origin.exist? && destination.exist?
-        Logging.print ColorizedString.new("[SKIP] Not moving #{origin.to_s}, does not exist, (#{destination.to_s} already exists)").red
+        Logging.print ColorizedString.new("[SKIP] Not moving #{origin}, does not exist, (#{destination} already exists)").red
       else
-        Logging.print ColorizedString.new("[SKIP] Not moving #{origin.to_s}, does not exist").red
+        Logging.print ColorizedString.new("[SKIP] Not moving #{origin}, does not exist").red
       end
     end
 
-    sig { params(package: ParsePackwerk::Package).void  }
+    sig { params(package: ParsePackwerk::Package).void }
     def self.add_public_directory(package)
       public_directory = package.directory.join('app/public')
 
       if public_directory.glob('**/**.rb').none?
         FileUtils.mkdir_p(public_directory)
-        todo_md = <<~TODO
-          This directory holds your public API!
-
-          Any classes, constants, or modules that you want other packs to use and you intend to support should go in here.
-          Anything that is considered private should go in other folders.
-
-          If another pack uses classes, constants, or modules that are not in your public folder, it will be considered a "privacy violation" by packwerk.
-          You can prevent other packs from using private API by using package_protections.
-
-          Want to find how your private API is being used today?
-          Try running: `bin/use_packwerk list_top_privacy_violations #{package.name}`
-
-          Want to move something into this folder?
-          Try running: `bin/use_packwerk make_public #{package.name}/path/to/file.rb`
-
-          One more thing -- feel free to delete this file and replace it with a README.md describing your package in the main package directory.
-
-          See #{UsePackwerk.config.documentation_link} for more info!
-        TODO
+        todo_md = UsePackwerk.config.user_event_logger.on_create_public_directory_todo(package.name)
         public_directory.join('TODO.md').write(todo_md)
       end
     end
 
-    sig { params(package: ParsePackwerk::Package).void  }
+    sig { params(package: ParsePackwerk::Package).void }
     def self.add_readme_todo(package)
       pack_directory = package.directory
 
       if !pack_directory.join('README.md').exist?
-        readme_todo_md = <<~TODO
-          Welcome to `#{package.name}`!
-
-          If you're the author, please consider replacing this file with a README.md, which may contain:
-          - What your pack is and does
-          - How you expect people to use your pack
-          - Example usage of your pack's public API (which lives in `#{package.name}/app/public`)
-          - Limitations, risks, and important considerations of usage
-          - How to get in touch with eng and other stakeholders for questions or issues pertaining to this pack (note: it is recommended to add ownership in `#{package.name}/package.yml` under the `owner` metadata key)
-          - What SLAs/SLOs (service level agreements/objectives), if any, your package provides
-          - When in doubt, keep it simple
-          - Anything else you may want to include!
-
-          README.md files are under version control and should change as your public API changes. 
-
-          See #{UsePackwerk.config.documentation_link} for more info!
-        TODO
+        readme_todo_md = UsePackwerk.config.user_event_logger.on_create_readme_todo(package.name)
         pack_directory.join('README_TODO.md').write(readme_todo_md)
       end
     end
@@ -392,13 +339,10 @@ module UsePackwerk
     end
     def self.create_pack_if_not_exists!(pack_name:, enforce_privacy:, enforce_dependencies:)
       if PERMITTED_PACK_LOCATIONS.none? { |permitted_location| pack_name.start_with?(permitted_location) }
-        raise StandardError.new("UsePackwerk only supports packages in the the following directories: #{PERMITTED_PACK_LOCATIONS.inspect}. Please make sure to pass in the name of the pack including the full directory path, e.g. `packs/my_pack`.")
+        raise StandardError, "UsePackwerk only supports packages in the the following directories: #{PERMITTED_PACK_LOCATIONS.inspect}. Please make sure to pass in the name of the pack including the full directory path, e.g. `packs/my_pack`."
       end
 
-      existing_package = ParsePackwerk.all.find { |package| package.name == pack_name }
-
-      package_location = Pathname.new(pack_name)
-
+      existing_package = ParsePackwerk.all.find { |p| p.name == pack_name }
       if existing_package.nil?
         should_enforce_dependenceies = enforce_dependencies.nil? ? UsePackwerk.config.enforce_dependencies : enforce_dependencies
 
@@ -409,7 +353,7 @@ module UsePackwerk
           metadata: {
             'owner' => 'MyTeam'
           },
-          name: pack_name,
+          name: pack_name
         )
 
         ParsePackwerk.write_package_yml!(package)
@@ -417,7 +361,7 @@ module UsePackwerk
         package = rewrite_package_with_original_packwerk_values(package)
 
         current_contents = package.yml.read
-        new_contents = current_contents.gsub("MyTeam", "MyTeam # specify your team here, or delete this key if this package is not owned by one team")
+        new_contents = current_contents.gsub('MyTeam', 'MyTeam # specify your team here, or delete this key if this package is not owned by one team')
         package.yml.write(new_contents)
         existing_package = package
       end
@@ -428,19 +372,37 @@ 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 })
+      package_with_protection_defaults = T.must(ParsePackwerk.all.find { |p| p.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(
         enforce_dependencies: original_package.enforce_dependencies,
         enforce_privacy: original_package.enforce_privacy,
         dependencies: original_package.dependencies,
         metadata: package_with_protection_defaults.metadata,
-        name: original_package.name,
+        name: original_package.name
       )
 
       ParsePackwerk.write_package_yml!(package)
       package
     end
+
+    sig { void }
+    def self.load_client_configuration
+      @loaded_client_configuration ||= T.let(false, T.nilable(T::Boolean))
+      return if @loaded_client_configuration
+
+      @loaded_client_configuration = true
+      client_configuration = Pathname.pwd.join('config/use_packwerk.rb')
+      require client_configuration.to_s if client_configuration.exist?
+    end
+
+    sig { void }
+    def self.bust_cache!
+      UsePackwerk.config.bust_cache!
+      # This comes explicitly after `PackageProtections.config.bust_cache!` because
+      # otherwise `PackageProtections.config` will attempt to reload the client configuratoin.
+      @loaded_client_configuration = false
+    end
   end
 
   private_constant :Private

data/lib/use_packwerk/rubocop_post_processor.rb

@@ -15,7 +15,7 @@ module UsePackwerk
         UsePackwerk.replace_in_file(
           file: rubocop_todo.to_s,
           find: relative_path_to_origin,
-          replace_with: relative_path_to_destination,
+          replace_with: relative_path_to_destination
         )
       end
 
@@ -26,23 +26,23 @@ module UsePackwerk
           new_origin_rubocop_todo = loaded_origin_rubocop_todo.dup
 
           loaded_origin_rubocop_todo.each do |cop_name, cop_config|
-            if cop_config['Exclude'].include?(relative_path_to_origin.to_s)
-              new_origin_rubocop_todo[cop_name]['Exclude'] = cop_config['Exclude'] - [relative_path_to_origin.to_s]
-              origin_rubocop_todo.write(YAML.dump(new_origin_rubocop_todo))
-              
-              destination_rubocop_todo = file_move_operation.destination_pack.directory.join('.rubocop_todo.yml')
-              if destination_rubocop_todo.exist?
-                new_destination_rubocop_todo = YAML.load_file(destination_rubocop_todo).dup
-              else
-                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))
+            next unless cop_config['Exclude'].include?(relative_path_to_origin.to_s)
+
+            new_origin_rubocop_todo[cop_name]['Exclude'] = cop_config['Exclude'] - [relative_path_to_origin.to_s]
+            origin_rubocop_todo.write(YAML.dump(new_origin_rubocop_todo))
+
+            destination_rubocop_todo = file_move_operation.destination_pack.directory.join('.rubocop_todo.yml')
+            if destination_rubocop_todo.exist?
+              new_destination_rubocop_todo = YAML.load_file(destination_rubocop_todo).dup
+            else
+              new_destination_rubocop_todo = {}
             end
-          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
         end
       end
     end