packwerk-extensions 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24439a703540da854784770755e1343825565c3803e5f445d2e201a2641b830c
-  data.tar.gz: 2abc2d11f203b5c4f779cffcd9b918950f196e8077f38ffd6607c48984e8142f
+  metadata.gz: ec06b679c031e028a1dca4bb93e0cac394f13a3af2e86a19892efcf5e26ce6fe
+  data.tar.gz: 98835c87573ac3b47f13a50c9de8e9af6370c7f88debf12a24578e0040d87324
 SHA512:
-  metadata.gz: 1174851513f542ffb1cffc27adab3f7cb7a8b0daa018476d57ce06547521727ee88c0c722b504d1ff81e2fe154b5a15073d99a7d05ce99f2057c98788e9484f5
-  data.tar.gz: db04d45d6cb81beb4b198fafee35246cb5aa53ef53d74ef4d399860339c0b8a95c8098fa32ef529e7ba5dc872d74715d2da030c45c57e1fbe237b1aae4d8643d
+  metadata.gz: 6e37b7e13b22e77dc428a3d3bd210a6dea8c5eddbac5baf9c0ce31ae207b6b5e9bcfdf0cb9c3a1c041524c20a4a3f0a0affb9d08e90f105d78b28746b67ae7d5
+  data.tar.gz: ff5c5b5d73118ac391a086c13edb8733f0b682e4c87e404e4aaa3a5fc7e7736b655a1ed15e18e059758e854fa895cedb67d81eb93889d7767ad16a778b300d82

data/README.md

@@ -5,7 +5,7 @@
 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.
-- A `folder_visibility` checker that allows packages to their sibling packs and parent pack (to be used in an application that uses folder packs)
+- A `folder_privacy` checker that allows packages to their sibling packs and parent pack (to be used in an application that uses folder packs)
 - A `layer` (formerly `architecture`) checker that allows packages to specify their "layer" and requires that each layer only communicate with layers below it.
 
 ## Installation
@@ -25,7 +25,7 @@ Alternatively, you can require individual checkers:
 require:
   - packwerk/privacy/checker
   - packwerk/visibility/checker
-  - packwerk/folder_visibility/checker
+  - packwerk/folder_privacy/checker
   - packwerk/layer/checker
 ```
 
@@ -43,7 +43,7 @@ enforce_privacy: true
 
 Setting `enforce_privacy` to `true` will make all references to private constants in your package a violation.
 
-Setting `enforce_privacy` to `strict` will forbid all references to private constants in your package. **This includes violations that have been added to other packages' `package_todo.yml` files.** 
+Setting `enforce_privacy` to `strict` will forbid all references to private constants in your package. **This includes violations that have been added to other packages' `package_todo.yml` files.**
 
 Note: You will need to remove all existing privacy violations before setting `enforce_privacy` to `strict`.
 
@@ -171,16 +171,16 @@ visible_to:
 ```
 
 ## Folder-Visibility Checker
-The folder visibility checker can be used to allow a package to be private to their sibling packs and parent packs and will create todos if used by any other package.
+The folder privacy checker can be used to allow a package to be private to their sibling packs and parent packs and will create todos if used by any other package.
 
-To enforce visibility for your package, set `enforce_folder_visibility` to `true` on your pack.
+To enforce folder privacy for your package, set `enforce_folder_privacy` to `true` on your pack.
 
 ```yaml
 # components/merchandising/package.yml
-enforce_folder_visibility: true
+enforce_folder_privacy: true
 ```
 
-Here is an example of paths and whether their use of `packs/b/packs/e` is OK or not, assuming that protects itself via `enforce_folder_visibility`
+Here is an example of paths and whether their use of `packs/b/packs/e` is OK or not, assuming that protects itself via `enforce_folder_privacy`
 
 ```
 .                         OK (parent of parent)
@@ -226,7 +226,7 @@ The "Layer Checker" was formerly named "Architecture Checker". The associated ke
 
   # replace 'architecture_layers' with 'layers' in packwerk.yml
   sed -i '' 's/architecture_layers/layers/g' ./packwerk.yml
-  
+
   # replace 'enforce_architecture' with 'enforce_layers' in package.yml files
   `rg -l 'enforce_architecture' -g 'package.yml' | xargs sed -i '' 's,enforce_architecture,enforce_layers,g'`
 

data/lib/packwerk/{folder_visibility → folder_privacy}/checker.rb

@@ -1,16 +1,16 @@
 # typed: strict
 # frozen_string_literal: true
 
-require 'packwerk/folder_visibility/package'
-require 'packwerk/folder_visibility/validator'
+require 'packwerk/folder_privacy/package'
+require 'packwerk/folder_privacy/validator'
 
 module Packwerk
-  module FolderVisibility
+  module FolderPrivacy
     class Checker
       extend T::Sig
       include Packwerk::Checker
 
-      VIOLATION_TYPE = T.let('folder_visibility', String)
+      VIOLATION_TYPE = T.let('folder_privacy', String)
 
       sig { override.returns(String) }
       def violation_type
@@ -26,7 +26,7 @@ module Packwerk
         referencing_package = reference.package
         referenced_package = reference.constant.package
 
-        return false if enforcement_disabled?(Package.from(referenced_package).enforce_folder_visibility)
+        return false if enforcement_disabled?(Package.from(referenced_package).enforce_folder_privacy)
 
         # the root pack is parent folder of all packs, so we short-circuit this here
         referencing_package_is_root_pack = referencing_package.name == '.'
@@ -48,7 +48,7 @@ module Packwerk
       end
       def strict_mode_violation?(listed_offense)
         publishing_package = listed_offense.reference.constant.package
-        publishing_package.config['enforce_folder_visibility'] == 'strict'
+        publishing_package.config['enforce_folder_privacy'] == 'strict'
       end
 
       sig do
@@ -60,7 +60,7 @@ module Packwerk
         source_desc = "'#{reference.package}'"
 
         message = <<~MESSAGE
-          Folder Visibility violation: '#{reference.constant.name}' belongs to '#{reference.constant.package}', which is not visible to #{source_desc} as it is not a sibling pack or parent pack.
+          Folder Privacy violation: '#{reference.constant.name}' belongs to '#{reference.constant.package}', which is private to #{source_desc} as it is not a sibling pack or parent pack.
           Is there a different package to use instead, or should '#{reference.constant.package}' also be visible to #{source_desc}?
 
           #{standard_help_message(reference)}

data/lib/packwerk/{folder_visibility → folder_privacy}/package.rb

@@ -2,11 +2,11 @@
 # frozen_string_literal: true
 
 module Packwerk
-  module FolderVisibility
+  module FolderPrivacy
     class Package < T::Struct
       extend T::Sig
 
-      const :enforce_folder_visibility, T.nilable(T.any(T::Boolean, String))
+      const :enforce_folder_privacy, T.nilable(T.any(T::Boolean, String))
 
       class << self
         extend T::Sig
@@ -14,7 +14,7 @@ module Packwerk
         sig { params(package: ::Packwerk::Package).returns(Package) }
         def from(package)
           Package.new(
-            enforce_folder_visibility: package.config['enforce_folder_visibility']
+            enforce_folder_privacy: package.config['enforce_folder_privacy']
           )
         end
       end

data/lib/packwerk/{folder_visibility → folder_privacy}/validator.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 module Packwerk
-  module FolderVisibility
+  module FolderPrivacy
     class Validator
       extend T::Sig
       include Packwerk::Validator
@@ -13,14 +13,14 @@ module Packwerk
       def call(package_set, configuration)
         results = T.let([], T::Array[Result])
 
-        package_manifests_settings_for(configuration, 'enforce_folder_visibility').each do |config, setting|
+        package_manifests_settings_for(configuration, 'enforce_folder_privacy').each do |config, setting|
           next if setting.nil?
 
           next if [TrueClass, FalseClass].include?(setting.class) || setting == 'strict'
 
           results << Result.new(
             ok: false,
-            error_value: "\tInvalid 'enforce_folder_visibility' option: #{setting.inspect} in #{config.inspect}"
+            error_value: "\tInvalid 'enforce_folder_privacy' option: #{setting.inspect} in #{config.inspect}"
           )
         end
 
@@ -29,7 +29,7 @@ module Packwerk
 
       sig { override.returns(T::Array[String]) }
       def permitted_keys
-        %w[enforce_folder_visibility]
+        %w[enforce_folder_privacy]
       end
     end
   end

data/lib/packwerk-extensions.rb

@@ -6,7 +6,7 @@ require 'packwerk'
 
 require 'packwerk/privacy/checker'
 require 'packwerk/visibility/checker'
-require 'packwerk/folder_visibility/checker'
+require 'packwerk/folder_privacy/checker'
 require 'packwerk/layer/checker'
 
 module Packwerk

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packwerk-extensions
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-03 00:00:00.000000000 Z
+date: 2024-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: packwerk
@@ -187,9 +187,9 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/packwerk-extensions.rb
-- lib/packwerk/folder_visibility/checker.rb
-- lib/packwerk/folder_visibility/package.rb
-- lib/packwerk/folder_visibility/validator.rb
+- lib/packwerk/folder_privacy/checker.rb
+- lib/packwerk/folder_privacy/package.rb
+- lib/packwerk/folder_privacy/validator.rb
 - lib/packwerk/layer/checker.rb
 - lib/packwerk/layer/config.rb
 - lib/packwerk/layer/layers.rb
@@ -224,7 +224,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: A collection of extensions for packwerk packages.