packwerk 2.2.1 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7968dbdc908eb500726b8af244e0de8e44075b86409eef871003d47174a139d
-  data.tar.gz: 48037d44dbb482841e64c218a22b98978e5e6dac2dd277b10b2989c508daaa26
+  metadata.gz: 6e1c2cdab1129d016428019597dc9f19dbf0836d0c545a13ce780486bf9fbba1
+  data.tar.gz: d9556ef773c776283a30f8e22308f0068e4d1a4ea918e81af44a0e126c0ca62e
 SHA512:
-  metadata.gz: 8e3c43a046bb108cc76fde787fbdd5d67475c0feba647e9653e6f7e9fc2fc0082994f09791a4fc870e639f3a964ab2727fd3216601f6dad3f69ccdf3059fb0ee
-  data.tar.gz: 66433d48c993ce76edb6eb2bf08d7ce6a474efcac790e4b42628a1f2371b09be579b7eb58dc84aaef2614e6779302e34f80559dfc179d48141aeb2b2f99e41d3
+  metadata.gz: 74cb6f2c95a7d51dc8e5199a47601b53897c29cfd6dde5d0c0ada40566d19bf0f9d0f0fcf9209dbe5b9e0ccbbcfcac9c1282fa74377af0b8e6cee63e75204948
+  data.tar.gz: d03e35ab0975d457a9202d2df2f697372f22f5a4072880dc7d308b87581ffd5a30446b8b235b221da0655cd4b31be58552b0a3f658e15a8c48d78cdee23f9794

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    packwerk (2.2.1)
+    packwerk (2.2.2)
       activesupport (>= 5.2)
       ast
       better_html
@@ -10,6 +10,7 @@ PATH
       parallel
       parser
       sorbet-runtime (>= 0.5.9914)
+      zeitwerk (>= 2.6.1)
 
 GEM
   remote: https://rubygems.org/
@@ -261,7 +262,7 @@ GEM
     yard-sorbet (0.6.1)
       sorbet-runtime (>= 0.5)
       yard (>= 0.9)
-    zeitwerk (2.6.0)
+    zeitwerk (2.6.6)
 
 PLATFORMS
   ruby

data/lib/packwerk/application_load_paths.rb

@@ -21,7 +21,7 @@ module Packwerk
       sig { returns(T::Hash[String, Module]) }
       def extract_application_autoload_paths
         Rails.autoloaders.inject({}) do |h, loader|
-          h.merge(loader.root_dirs)
+          h.merge(loader.dirs(namespaces: true))
         end
       end
 

data/lib/packwerk/cli.rb

@@ -50,8 +50,6 @@ module Packwerk
       case subcommand
       when "init"
         init
-      when "generate_configs"
-        generate_configs
       when "check"
         output_result(parse_run(args).check)
       when "detect-stale-violations"
@@ -61,19 +59,11 @@ module Packwerk
       when "validate"
         validate(args)
       when nil, "help"
-        @err_out.puts(<<~USAGE)
-          Usage: #{$PROGRAM_NAME} <subcommand>
-
-          Subcommands:
-            init - set up packwerk
-            check - run all checks
-            update-deprecations - update deprecated references
-            validate - verify integrity of packwerk and package configuration
-            help  - display help information about packwerk
-        USAGE
-        true
+        usage
       else
-        @err_out.puts("'#{subcommand}' is not a packwerk command. See `packwerk help`.")
+        @err_out.puts(
+          "'#{subcommand}' is not a packwerk command. See `packwerk help`."
+        )
         false
       end
     end
@@ -116,6 +106,21 @@ module Packwerk
       success
     end
 
+    sig { returns(T::Boolean) }
+    def usage
+      @err_out.puts(<<~USAGE)
+        Usage: #{$PROGRAM_NAME} <subcommand>
+
+        Subcommands:
+          init - set up packwerk
+          check - run all checks
+          update-deprecations - update deprecated_references.yml files
+          validate - verify integrity of packwerk and package configuration
+          help  - display help information about packwerk
+      USAGE
+      true
+    end
+
     sig { params(result: Result).returns(T::Boolean) }
     def output_result(result)
       @out.puts

data/lib/packwerk/deprecated_references.rb

@@ -84,7 +84,7 @@ module Packwerk
     sig { void }
     def dump
       if @new_entries.empty?
-        File.delete(@filepath) if File.exist?(@filepath)
+        delete_if_exists
       else
         prepare_entries_for_dump
         message = <<~MESSAGE
@@ -102,6 +102,11 @@ module Packwerk
       end
     end
 
+    sig { void }
+    def delete_if_exists
+      File.delete(@filepath) if File.exist?(@filepath)
+    end
+
     private
 
     sig { returns(EntriesType) }

data/lib/packwerk/offense_collection.rb

@@ -57,11 +57,10 @@ module Packwerk
       end
     end
 
-    sig { void }
-    def dump_deprecated_references_files
-      @deprecated_references.each do |_, deprecated_references_file|
-        deprecated_references_file.dump
-      end
+    sig { params(package_set: Packwerk::PackageSet).void }
+    def persist_deprecated_references_files(package_set)
+      dump_deprecated_references_files
+      cleanup_extra_deprecated_references_files(package_set)
     end
 
     sig { returns(T::Array[Packwerk::Offense]) }
@@ -71,6 +70,23 @@ module Packwerk
 
     private
 
+    sig { params(package_set: Packwerk::PackageSet).void }
+    def cleanup_extra_deprecated_references_files(package_set)
+      packages_without_todos = (package_set.packages.values - @deprecated_references.keys)
+
+      packages_without_todos.each do |package|
+        Packwerk::DeprecatedReferences.new(
+          package,
+          deprecated_references_file_for(package),
+        ).delete_if_exists
+      end
+    end
+
+    sig { void }
+    def dump_deprecated_references_files
+      @deprecated_references.each_value(&:dump)
+    end
+
     sig { params(package: Packwerk::Package).returns(Packwerk::DeprecatedReferences) }
     def deprecated_references_for(package)
       @deprecated_references[package] ||= Packwerk::DeprecatedReferences.new(

data/lib/packwerk/parse_run.rb

@@ -34,7 +34,13 @@ module Packwerk
 
     sig { returns(Result) }
     def detect_stale_violations
-      offense_collection = find_offenses
+      warn(<<~WARNING.squish)
+        DEPRECATION WARNING: `detect-stale-violation` is deprecated,
+        the output of `check` includes stale references.
+      WARNING
+
+      run_context = Packwerk::RunContext.from_configuration(@configuration)
+      offense_collection = find_offenses(run_context)
 
       result_status = !offense_collection.stale_violations?(@relative_file_set)
       message = @offenses_formatter.show_stale_violations(offense_collection, @relative_file_set)
@@ -44,8 +50,9 @@ module Packwerk
 
     sig { returns(Result) }
     def update_deprecations
-      offense_collection = find_offenses
-      offense_collection.dump_deprecated_references_files
+      run_context = Packwerk::RunContext.from_configuration(@configuration)
+      offense_collection = find_offenses(run_context)
+      offense_collection.persist_deprecated_references_files(run_context.package_set)
 
       message = <<~EOS
         #{@offenses_formatter.show_offenses(offense_collection.errors)}
@@ -57,7 +64,8 @@ module Packwerk
 
     sig { returns(Result) }
     def check
-      offense_collection = find_offenses(show_errors: true)
+      run_context = Packwerk::RunContext.from_configuration(@configuration)
+      offense_collection = find_offenses(run_context, show_errors: true)
 
       messages = [
         @offenses_formatter.show_offenses(offense_collection.outstanding_offenses),
@@ -72,12 +80,11 @@ module Packwerk
 
     private
 
-    sig { params(show_errors: T::Boolean).returns(OffenseCollection) }
-    def find_offenses(show_errors: false)
+    sig { params(run_context: Packwerk::RunContext, show_errors: T::Boolean).returns(OffenseCollection) }
+    def find_offenses(run_context, show_errors: false)
       offense_collection = OffenseCollection.new(@configuration.root_path)
       @progress_formatter.started(@relative_file_set)
 
-      run_context = Packwerk::RunContext.from_configuration(@configuration)
       all_offenses = T.let([], T::Array[Offense])
 
       process_file = T.let(->(relative_file) do

data/lib/packwerk/run_context.rb

@@ -71,6 +71,7 @@ module Packwerk
 
       @file_processor = T.let(nil, T.nilable(FileProcessor))
       @context_provider = T.let(nil, T.nilable(ConstantDiscovery))
+      @package_set = T.let(nil, T.nilable(PackageSet))
       # We need to initialize this before we fork the process, see https://github.com/Shopify/packwerk/issues/182
       @cache = T.let(
         Cache.new(enable_cache: @cache_enabled, cache_directory: @cache_directory, config_path: @config_path), Cache
@@ -90,6 +91,11 @@ module Packwerk
       processed_file.offenses + references.flat_map { |reference| reference_checker.call(reference) }
     end
 
+    sig { returns(PackageSet) }
+    def package_set
+      @package_set ||= ::Packwerk::PackageSet.load_all_from(@root_path, package_pathspec: @package_paths)
+    end
+
     private
 
     sig { returns(FileProcessor) }
@@ -123,11 +129,6 @@ module Packwerk
       )
     end
 
-    sig { returns(PackageSet) }
-    def package_set
-      ::Packwerk::PackageSet.load_all_from(@root_path, package_pathspec: @package_paths)
-    end
-
     sig { returns(T::Array[ConstantNameInspector]) }
     def constant_name_inspectors
       [

data/lib/packwerk/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Packwerk
-  VERSION = "2.2.1"
+  VERSION = "2.2.2"
 end

data/packwerk.gemspec

@@ -45,6 +45,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency("constant_resolver", ">= 0.2.0")
   spec.add_dependency("parallel")
   spec.add_dependency("sorbet-runtime", ">= 0.5.9914")
+  spec.add_dependency("zeitwerk", ">= 2.6.1")
 
   # For Ruby parsing
   spec.add_dependency("ast")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packwerk
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.2.2
 platform: ruby
 authors:
 - Shopify Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-18 00:00:00.000000000 Z
+date: 2022-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.9914
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.1
 - !ruby/object:Gem::Dependency
   name: ast
   requirement: !ruby/object:Gem::Requirement