packwerk-extensions 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43b45f3f9f067f3d9693ef9d51a39c0c5f50af96e11ddb5091a5cafdaa0dbb60
-  data.tar.gz: 418c9911e1a3032d4b03c01af4876871b8d0420471927f9f3818f4d069a1e1c9
+  metadata.gz: 11f152d73195983779e15ac10eb5af3f99b94b5a349a57b92c9cf91054192c84
+  data.tar.gz: 4c2f4e77c228b45faecc415235b1cb8228d3b8f6b50cdd561c1700605506d622
 SHA512:
-  metadata.gz: b9b9ce5577d448c8da70fc9acece7bf0ad789200a352874e3a48e2be15cb8bf7e0eeb25c9f74c3563f7a675f4afbc0843cc5ebb6a1c4d6bc35cdba1f0458d2cc
-  data.tar.gz: 0e3c69059991de5039f312fbe099add8f2edb0ae9a79a439c4e4d22e626cccb44a57c02f3d33b8f590b5963b36965d0e2218f729996d0474563bd95841af86f8
+  metadata.gz: 9557efbe49651e123920eebdf84f4fd09da937fb822c73eb7848633fd8b17f64f0a53be5a24a75515f366c5f2d9621ff7e33bd483b70b060620b18a5563be1e2
+  data.tar.gz: dc9384c7c35d1424301212d95a5fce9becffb6e791784e3c53f4a010a30421a5acaf988fe332386c03457b86c5b09404a65d254d4a9790d75e2ad9bd57ca9cf8

data/README.md

@@ -2,11 +2,6 @@
 
 `packwerk-extensions` is a home for checker extensions for [packwerk](https://github.com/Shopify/packwerk) 3.
 
-Note that packwerk has not yet released packwerk 3. If you'd like to use `packwerk-extensions`, you'll need to point your `Gemfile` at the `packwerk` `main` branch:
-```ruby
-gem 'packwerk', github: 'Shopify/packwerk', branch: 'main'
-```
-
 Currently, it ships the following checkers to help improve the boundaries between packages. These checkers are:
 - A `privacy` checker that ensures other packages are using your package's public API
 - A `visibility` checker that allows packages to be private except to an explicit group of other packages.
@@ -14,10 +9,13 @@ Currently, it ships the following checkers to help improve the boundaries betwee
 
 ## Installation
 
+Add `packwerk-extensions` to your `Gemfile`.
+
 To register all checkers included in this gem, add the following to your `packwerk.yml`:
 
 ```yaml
-require: packwerk-extensions
+require:
+  - packwerk-extensions
 ```
 
 Alternatively, you can require individual checkers:
@@ -60,7 +58,7 @@ public_path: my/custom/path/
 Sometimes it is desirable to only enforce privacy on a subset of constants in a package. You can do so by defining a `private_constants` list in your package.yml. Note that `enforce_privacy` must be set to `true` or `'strict'` for this to work.
 
 ### Package Privacy violation
-A constant that is private to its package has been referenced from outside of the package. Constants are declared private in their package’s `package.yml`.
+Packwerk thinks something is a privacy violation if you're referencing a constant, class, or module defined in the private implementation (i.e. not the public folder) of another package. We care about these because we want to make sure we only use parts of a package that have been exposed as public API.
 
 #### Interpreting Privacy violation
 

data/lib/packwerk/privacy/checker.rb

@@ -32,6 +32,8 @@ module Packwerk
         privacy_option = privacy_package.enforce_privacy
         return false if enforcement_disabled?(privacy_option)
 
+        return false if privacy_package.ignored_private_constants.include?(reference.constant.name)
+
         explicitly_private_constant?(reference.constant, explicitly_private_constants: privacy_package.private_constants)
       end
 

data/lib/packwerk/privacy/package.rb

@@ -10,6 +10,7 @@ module Packwerk
       const :user_defined_public_path, T.nilable(String)
       const :enforce_privacy, T.nilable(T.any(T::Boolean, String))
       const :private_constants, T::Array[String]
+      const :ignored_private_constants, T::Array[String]
 
       sig { params(path: String).returns(T::Boolean) }
       def public_path?(path)
@@ -25,7 +26,8 @@ module Packwerk
             public_path: public_path_for(package),
             user_defined_public_path: user_defined_public_path(package),
             enforce_privacy: package.config['enforce_privacy'],
-            private_constants: package.config['private_constants'] || []
+            private_constants: package.config['private_constants'] || [],
+            ignored_private_constants: package.config['ignored_private_constants'] || []
           )
         end
 

data/lib/packwerk/privacy/validator.rb

@@ -42,7 +42,8 @@ module Packwerk
         results = T.let([], T::Array[Result])
         resolver = ConstantResolver.new(
           root_path: configuration.root_path,
-          load_paths: configuration.load_paths
+          load_paths: configuration.load_paths,
+          inflector: ActiveSupport::Inflector
         )
 
         private_constants_setting.each do |config_file_path, setting|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packwerk-extensions
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-02 00:00:00.000000000 Z
+date: 2023-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: packwerk