package_protections 2.5.0 → 2.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15fbea313e27bfc23cc01afc2bbae8e5851a3008b376952c05868cf50dfe3603
-  data.tar.gz: 0dfd11a1d3985011213dac38f6e60e46f8891ead717fd273b11ece18056929a9
+  metadata.gz: 58f01e3852a51048fe302838f5c9cfae1d116789a0cf590484f1f5a38f018215
+  data.tar.gz: 9676ca99110ee87a03963b2391a7c449396bb2b8dfbaa4b0bc585c74632bbe8c
 SHA512:
-  metadata.gz: 89215ad6809c4dc4de07dc07f87cbbd7f163feeed780c23ca43ea93e4fa0e47b9a0fcda22a183b6df8eb72c7624c0435998eb9b378b1bc425bf9e5b6432c724b
-  data.tar.gz: da424f1faa7130c10d8dd07cdcc3d94a6c9c9f69ed1ca892703ca604de112fcb4878308e244fea894b5039cfd25f0f8c79447cebd06197401a80e6420fbd770c
+  metadata.gz: d90ddaf7d29c7bef8e50fd1c9e18e9921c24799b820dc6db5da2bfaf16ab3380612e2e320fb5198aa9085c448e58e826d437e5966fe25a2721db241cfdca1789
+  data.tar.gz: bbc96e01cac4e6232500c9466f37db3a522a4c50767f3e7f9c9bed60595055cd467cfa0ecfe98afd3ee3bf6de3be06e0b06a1f8d205314d4bcb760a071333ec2

data/README.md

@@ -54,21 +54,14 @@ This protection ensures that all files within `app/public` are typed at level `s
 This helps ensure that your package is only creating one namespace (based on folder hierarchy). This helps organize the public API of your pack into one place.
 This protection only looks at files in `packs/your_pack/app` (it ignores spec files).
 This protection is implemented via Rubocop -- expect to see results for this when running `rubocop` however you normally do. To add to the TODO list, add to `.rubocop_todo.yml`
-Lastly – this protection can be configured by setting `global_namespaces` within the `package.yml`, e.g.:
-```
-enforce_privacy: true
-enforce_dependencies: true
-metadata:
-  protections:
-    # ... nothing changes here
-  global_namespaces:
-    - MyNamespace
-    - MyOtherNamespace
-    - MyThirdNamespace
-    # ... etc.
+Lastly – this protection can be configured by setting `globally_permitted_namespaces`, e.g.:
+```ruby
+PackageProtections.configure do |config|
+  config.globally_permitted_namespaces = ['SomeGlobalNamespace']
+end
 ```
 
-It's encouraged to limit the number of global namespaces your package exposes, and to make sure your global namespaces are as specific to your domain as possible.
+If you've worked through all of the TODOs for this cop and are able to set the value to `fail_on_any`, you can also set `automatic_pack_namespace` which will support your pack having one global namespace without extra subdirectories. That is, instead of `packs/foo/app/services/foo/bar.rb`, you can use `packs/foo/app/services/bar.rb` and still have it define `Foo::Bar`. [See the `stimpack` README.md](https://github.com/rubyatscale/stimpack#readme) for more information.
 
 ### `prevent_other_packages_from_using_this_package_without_explicit_visibility`
 *This is only available if your package has `enforce_privacy` set to `true`!*

data/lib/package_protections/private.rb

@@ -115,23 +115,12 @@ module PackageProtections
     sig { void }
     def self.bust_cache!
       @protected_packages_indexed_by_name = nil
-      @private_cop_config = nil
       PackageProtections.config.bust_cache!
       # This comes explicitly after `PackageProtections.config.bust_cache!` because
       # otherwise `PackageProtections.config` will attempt to reload the client configuratoin.
       @loaded_client_configuration = false
     end
 
-    sig { params(identifier: Identifier).returns(T::Hash[T.untyped, T.untyped]) }
-    def self.private_cop_config(identifier)
-      @private_cop_config ||= T.let(@private_cop_config, T.nilable(T::Hash[T.untyped, T.untyped]))
-      @private_cop_config ||= begin
-        protected_packages = all_protected_packages
-        protection = T.cast(PackageProtections.with_identifier(identifier), PackageProtections::RubocopProtectionInterface)
-        protected_packages.to_h { |p| [p.name, protection.custom_cop_config(p)] }
-      end
-    end
-
     sig { returns(T::Array[T::Hash[T.untyped, T.untyped]]) }
     def self.rubocop_todo_ymls
       @rubocop_todo_ymls = T.let(@rubocop_todo_ymls, T.nilable(T::Array[T::Hash[T.untyped, T.untyped]]))

data/lib/package_protections/rubocop_protection_interface.rb

@@ -57,9 +57,9 @@ module PackageProtections
     # but a default is provided.
     ############################################################################
     sig do
-      params(package: ProtectedPackage).returns(T::Hash[T.untyped, T.untyped])
+      returns(T::Hash[T.untyped, T.untyped])
     end
-    def custom_cop_config(package)
+    def custom_cop_config
       {}
     end
 
@@ -135,7 +135,8 @@ module PackageProtections
         CopConfig.new(
           name: cop_name,
           enabled: include_paths.any?,
-          include_paths: include_paths
+          include_paths: include_paths,
+          metadata: custom_cop_config
         )
       ]
     end

data/lib/package_protections.rb

@@ -118,15 +118,6 @@ module PackageProtections
     Private.rubocop_yml(root_pathname: root_pathname)
   end
 
-  #
-  # Do not use this method -- it's meant to be used by Rubocop cops to get directory-specific
-  # parameters without needing to have directory-specific .rubocop.yml files.
-  #
-  sig { params(identifier: Identifier).returns(T::Hash[T.untyped, T.untyped]) }
-  def self.private_cop_config(identifier)
-    Private.private_cop_config(identifier)
-  end
-
   sig { void }
   def self.bust_cache!
     Private.bust_cache!

data/lib/rubocop/cop/package_protections/only_class_methods.rb

@@ -33,6 +33,15 @@ module RuboCop
           ]
         end
 
+        sig do
+          override.returns(T::Hash[T.untyped, T.untyped])
+        end
+        def custom_cop_config
+          {
+            'AcceptableParentClasses' => ::PackageProtections.config.acceptable_parent_classes
+          }
+        end
+
         sig { override.returns(String) }
         def identifier
           IDENTIFIER

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: package_protections
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.5.1
 platform: ruby
 authors:
 - Gusto Engineers