packwerk 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d72fbde4259baa5a5e7f8bc2ca4406d9bc6a835051efafefc23ef6ef3ae13f32
-  data.tar.gz: 65bff304e2be348e16800b0d4f65ab33a1b5fb84ab15ba495e03904d099be4a0
+  metadata.gz: 98dd65426866ebc6f1421486a1a8573ea539dc143c448cd6632b77c5ca5ef5d8
+  data.tar.gz: 960fe5383ebd4ebadfc05698a64bd2537b1cf9c03525cd1780ff1f27ea5bd468
 SHA512:
-  metadata.gz: e25488e4af51932d503d4120e458fe92bc4ae2945ca8009219e01f4f2e7756e0430a0d9a6176f01d864d55644f262a06fb88494234b43aae43ba254437d7fb49
-  data.tar.gz: 2c821f3e11a16c52d84f7f4e68f01e788e95d5723fd77305f69e15aba07f5f1f81ea43e9c60b6c00ca4503df036eb2b3ea0e0ae1378f0c584d7252614064f9d9
+  metadata.gz: d91230970adbcfb9deaedd33a6745531b5245f929da676fb382ae0b661777777e522c14876ba9ace23d2f39dd4f72e528bc0543c1ecaaa463ba293113efab1bd
+  data.tar.gz: d2e1cbb00dc3dcaa1a92548f506124e0f05b4b8fa9f5c5837fa271ffb2e3847277fae8945b13cae0a05223540c386ead8efb7e8108436af2732c9525f9b00b4c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    packwerk (3.1.0)
+    packwerk (3.2.0)
       activesupport (>= 6.0)
       ast
       better_html
@@ -9,6 +9,7 @@ PATH
       constant_resolver (>= 0.2.0)
       parallel
       parser
+      prism (>= 0.24.0)
       sorbet-runtime (>= 0.5.9914)
       zeitwerk (>= 2.6.1)
 
@@ -60,14 +61,12 @@ GEM
       method_source (>= 0.6.7)
       rake (>= 0.9.2.2)
     method_source (1.0.0)
-    mini_portile2 (2.8.4)
     minitest (5.16.2)
     minitest-focus (1.3.1)
       minitest (>= 4, < 6)
     mocha (1.14.0)
     netrc (0.11.0)
-    nokogiri (1.15.3)
-      mini_portile2 (~> 2.8.2)
+    nokogiri (1.15.3-arm64-darwin)
       racc (~> 1.4)
     nokogiri (1.15.3-x86_64-darwin)
       racc (~> 1.4)
@@ -77,6 +76,7 @@ GEM
     parser (3.2.2.0)
       ast (~> 2.4.1)
     prettier_print (0.1.0)
+    prism (0.24.0)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -179,7 +179,7 @@ GEM
     zeitwerk (2.6.4)
 
 PLATFORMS
-  ruby
+  arm64-darwin-21
   x86_64-darwin
   x86_64-darwin-20
   x86_64-linux

data/USAGE.md

@@ -20,7 +20,6 @@
   * [Understanding how to respond to new violations](#understanding-how-to-respond-to-new-violations)
 * [Recording existing violations](#recording-existing-violations)
   * [Understanding the package todo file](#understanding-the-package-todo-file)
-  * [Understanding the list of deprecated references](#understanding-the-list-of-deprecated-references)
 * [Loading extensions](#loading-extensions)
 
 ## What problem does Packwerk solve?
@@ -42,7 +41,7 @@ A package is a folder containing autoloaded code. To decide whether code belongs
 
 Package principles help to guide the organization of classes in a large system. These principles can also be applied to packages in large and complex codebases.
 
-The [package principles](https://en.wikipedia.org/wiki/Package_principles) page on Wikipedia does a good job explaining what well designed packages look like.
+They are well described in Robert Martin's [Design Principles and Design Patterns](https://drive.google.com/file/d/0BwhCYaYDn8EgODUxZTJhOWEtMTZlMi00OWRiLTg0ZmEtZWQ5ODRlY2RmNDlk/view) (right after the SOLID principles).
 
 ## Getting started
 
@@ -165,7 +164,7 @@ It will be a dependency violation when `components/shop_identity` tries to refer
 
 #### Using strict mode
 
-Once there are no more violations in a package, you can turn on `strict` mode, which will prevent new violations from being added to the package's `package_todo.yml`. To use this, simply change `enforce_dependencies: true` to `enforce_dependencies: strict` in your `package.yml`.
+You can turn on `strict` mode to prevent new violations from being added to the package's `package_todo.yml`. To use this, simply change `enforce_dependencies: true` to `enforce_dependencies: strict` in your `package.yml`.
 
 Then, when you run `bin/packwerk check`, new violations will cause the following error to be displayed:
 ```

data/lib/packwerk/checker.rb

@@ -51,8 +51,8 @@ module Packwerk
     sig { abstract.returns(String) }
     def violation_type; end
 
-    sig { abstract.params(listed_offense: ReferenceOffense).returns(T::Boolean) }
-    def strict_mode_violation?(listed_offense); end
+    sig { abstract.params(offense: ReferenceOffense).returns(T::Boolean) }
+    def strict_mode_violation?(offense); end
 
     sig { abstract.params(reference: Reference).returns(T::Boolean) }
     def invalid_reference?(reference); end

data/lib/packwerk/commands/check_command.rb

@@ -31,17 +31,19 @@ module Packwerk
         end
         offense_collection.add_offenses(all_offenses)
 
+        unlisted_strict_mode_violations = offense_collection.unlisted_strict_mode_violations
+
         messages = [
           offenses_formatter.show_offenses(offense_collection.outstanding_offenses),
           offenses_formatter.show_stale_violations(offense_collection, @files_for_processing.files),
-          offenses_formatter.show_strict_mode_violations(offense_collection.strict_mode_violations),
+          offenses_formatter.show_strict_mode_violations(unlisted_strict_mode_violations),
         ]
 
         out.puts(messages.select(&:present?).join("\n") + "\n")
 
         offense_collection.outstanding_offenses.empty? &&
           !offense_collection.stale_violations?(@files_for_processing.files) &&
-          offense_collection.strict_mode_violations.empty?
+          unlisted_strict_mode_violations.empty?
       end
 
       private

data/lib/packwerk/file_processor.rb

@@ -59,7 +59,7 @@ module Packwerk
         For now, you can add this file to `packwerk.yml` `exclude` list.
         Please file an issue and include this error message and stacktrace:
 
-        #{e.message} #{e.backtrace}"
+        #{e.message} #{e.backtrace&.join("\n")}"
       MSG
 
       offense = Parsers::ParseResult.new(file: relative_file, message: message)

data/lib/packwerk/generators/templates/package.yml

@@ -2,8 +2,8 @@
 # Please validate the configuration using `packwerk validate` (for Rails applications) or running the auto generated
 # test case (for non-Rails projects). You can then use `packwerk check` to check your code.
 
-# Turn on dependency checks for this package
-enforce_dependencies: true
+# Change to `true` to turn on dependency checks for this package
+enforce_dependencies: false
 
 # A list of this package's dependencies
 # Note that packages in this list require their own `package.yml` file

data/lib/packwerk/parsers/ruby.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 require "parser"
-require "parser/current"
+require "prism"
 
 module Packwerk
   module Parsers
@@ -11,7 +11,7 @@ module Packwerk
 
       include ParserInterface
 
-      class RaiseExceptionsParser < Parser::CurrentRuby
+      class RaiseExceptionsParser < Prism::Translation::Parser
         extend T::Sig
 
         sig { params(builder: T.untyped).void }

data/lib/packwerk/reference_checking/checkers/dependency_checker.rb

@@ -47,9 +47,9 @@ module Packwerk
           EOS
         end
 
-        sig { override.params(listed_offense: ReferenceOffense).returns(T::Boolean) }
-        def strict_mode_violation?(listed_offense)
-          referencing_package = listed_offense.reference.package
+        sig { override.params(offense: ReferenceOffense).returns(T::Boolean) }
+        def strict_mode_violation?(offense)
+          referencing_package = offense.reference.package
           referencing_package.config["enforce_dependencies"] == "strict"
         end
 

data/lib/packwerk/version.rb

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

data/packwerk.gemspec

@@ -50,6 +50,7 @@ Gem::Specification.new do |spec|
   # For Ruby parsing
   spec.add_dependency("ast")
   spec.add_dependency("parser")
+  spec.add_dependency("prism", ">= 0.24.0") # 0.24.0 fixes a performance issue with the parser translator
 
   # For ERB parsing
   spec.add_dependency("better_html")