packwerk-extensions 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 386976d614f05a729cca841349279d58275a040efc1ed557f986bde6e12ed121
-  data.tar.gz: 5b185ef7ffd80fc5729be39de4ae42183ae0c327f28795731981b1cd4c85054c
+  metadata.gz: 4f96f84e834641849b005e20027231c6baf405ac64d5f1c0ac8ae1915aa33fb8
+  data.tar.gz: ccaa5606cb9b40bcab5954ebb1e61450f72b14b2c2a40d67fbdf0b5145b52a29
 SHA512:
-  metadata.gz: 50b1c9dfeedb990ee1288e9cdcde59590e03dd92e94f57806ce9b81572a2eb74da0fb5bf397068e6ce511ed884b0fc64f0c2bc7d020a00c7c573079449ba5aa7
-  data.tar.gz: 28380895e41326a78a159708ea3a79d98be283fdd5d35169746d522e3d88331d49fd88877badd4e67a72edf9c9db7311052c2a264c468f36b1874a1c620f284e
+  metadata.gz: d8918928b822a0d5e229f550dec48e18faf056c93b7626c63d85a132f4fa0dcf3dc122f5dfefebf60bc807db4f184f170ba1c89afd36194ab0987b487ae1b5c9
+  data.tar.gz: 7dc8f0bf1b44412934321db1e54fb802535f2257b59adccd7194ca750230e46bc0f2bf8752f727c13f0d262c67c3441370a62d40bd16cd161bcc64773586c264

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/architecture/package.rb

@@ -36,10 +36,12 @@ module Packwerk
 
           # This allows the layer to be inferred based on the package root
           package_root = package.name.split('/').first
-          if package_root && layers.names.include?(package_root)
+          if config['layer']
+            layer = config['layer']
+          elsif package_root && layers.names.include?(package_root)
             layer = package_root
           else
-            layer = config['layer']
+            layer = nil
           end
 
           Package.new(

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.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-24 00:00:00.000000000 Z
+date: 2023-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: packwerk