package_protections 2.5.0 → 2.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15fbea313e27bfc23cc01afc2bbae8e5851a3008b376952c05868cf50dfe3603
-  data.tar.gz: 0dfd11a1d3985011213dac38f6e60e46f8891ead717fd273b11ece18056929a9
+  metadata.gz: db265db203f34615ababcc47b7c18ac926cc2dde00c87ff6e7e88ada45eca909
+  data.tar.gz: 9a4d401d4b3c6806e047cf34ee37e92a68c53f59cbf3a18b2a048233388e18e1
 SHA512:
-  metadata.gz: 89215ad6809c4dc4de07dc07f87cbbd7f163feeed780c23ca43ea93e4fa0e47b9a0fcda22a183b6df8eb72c7624c0435998eb9b378b1bc425bf9e5b6432c724b
-  data.tar.gz: da424f1faa7130c10d8dd07cdcc3d94a6c9c9f69ed1ca892703ca604de112fcb4878308e244fea894b5039cfd25f0f8c79447cebd06197401a80e6420fbd770c
+  metadata.gz: d89ef740b11b54d759cc4548279a45bf4c924ed215ef7cb07b0203cf8cf14aaff8b33d363f3e50c58a440fc71fa35d93dc7443ee965999d3c95c7be53fe0eb39
+  data.tar.gz: d0abae5dfc74ab2b66b9e32ef9f22b31cd5ad1c2d3e37c42a779d7b1d773aaa3cccc8099d298cad36a219c18b693fe17f997db1f0f929207793f25bc16ab27b0

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,58 +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]]))
-      @rubocop_todo_ymls ||= begin
-        todo_files = Pathname.glob('**/.rubocop_todo.yml')
-        todo_files.map do |todo_file|
-          YAML.load_file(todo_file)
-        end
-      end
-    end
-
-    sig { void }
-    def self.bust_rubocop_todo_yml_cache
-      @rubocop_todo_ymls = nil
-    end
-
-    sig { params(rule: String).returns(T::Set[String]) }
-    def self.exclude_for_rule(rule)
-      excludes = T.let(Set.new, T::Set[String])
-
-      Private.rubocop_todo_ymls.each do |todo_yml|
-        next if !todo_yml
-
-        config = todo_yml[rule]
-        next if config.nil?
-
-        exclude_list = config['Exclude']
-        next if exclude_list.nil?
-
-        excludes += exclude_list
-      end
-
-      excludes
-    end
-
     sig { void }
     def self.load_client_configuration
       @loaded_client_configuration ||= T.let(false, T.nilable(T::Boolean))

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
 
@@ -75,18 +75,13 @@ module PackageProtections
       []
     end
 
-    sig { void }
-    def self.bust_rubocop_todo_yml_cache
-      Private.bust_rubocop_todo_yml_cache
-    end
-
     sig do
       override.params(
         protected_packages: T::Array[ProtectedPackage]
       ).returns(T::Array[Offense])
     end
     def get_offenses_for_existing_violations(protected_packages)
-      exclude_list = Private.exclude_for_rule(cop_name)
+      exclude_list = RuboCop::Packs.exclude_for_rule(cop_name)
       offenses = []
 
       protected_packages.each do |package|
@@ -135,7 +130,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,18 +118,9 @@ 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!
-    RubocopProtectionInterface.bust_rubocop_todo_yml_cache
+    RuboCop::Packs.bust_cache!
   end
 end

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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: package_protections
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.5.2
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-07 00:00:00.000000000 Z
+date: 2022-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport