package_protections 2.5.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db265db203f34615ababcc47b7c18ac926cc2dde00c87ff6e7e88ada45eca909
-  data.tar.gz: 9a4d401d4b3c6806e047cf34ee37e92a68c53f59cbf3a18b2a048233388e18e1
+  metadata.gz: 217ae8f6eee7f084ff39ce7c4cf0bb06a08c361abff49e411d730a3a79592b71
+  data.tar.gz: 21a4eea2876078f531a67d3705e7a0d38c11b3bf87cd265e552bda9e8661638a
 SHA512:
-  metadata.gz: d89ef740b11b54d759cc4548279a45bf4c924ed215ef7cb07b0203cf8cf14aaff8b33d363f3e50c58a440fc71fa35d93dc7443ee965999d3c95c7be53fe0eb39
-  data.tar.gz: d0abae5dfc74ab2b66b9e32ef9f22b31cd5ad1c2d3e37c42a779d7b1d773aaa3cccc8099d298cad36a219c18b693fe17f997db1f0f929207793f25bc16ab27b0
+  metadata.gz: 1633812b257db230cf9f0244c8dd397197d4feb98f37abcd9906e5660adbfb7985c82fc6758254f99771726d49d3796c2e30438a54bd14a75c9ed3b64dbca1a0
+  data.tar.gz: e1aafb82c4a5a93425cbfc28135bae436b792681f6cbd8257f95e2d51d985a436e80d191313d2959a3e9c37423f970608109bca773a5ffe0ad01af3d6214b6da

data/README.md

@@ -56,7 +56,7 @@ This protection only looks at files in `packs/your_pack/app` (it ignores spec fi
 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 `globally_permitted_namespaces`, e.g.:
 ```ruby
-PackageProtections.configure do |config|
+RuboCop::Packs.configure do |config|
   config.globally_permitted_namespaces = ['SomeGlobalNamespace']
 end
 ```

data/lib/package_protections/protected_package.rb

@@ -13,14 +13,7 @@ module PackageProtections
     sig { params(original_package: ParsePackwerk::Package).returns(ProtectedPackage) }
     def self.from(original_package)
       metadata = original_package.metadata['protections'] || {}
-
       valid_identifiers = PackageProtections.all.map(&:identifier)
-      invalid_identifiers = metadata.keys - valid_identifiers
-
-      if invalid_identifiers.any?
-        raise IncorrectPublicApiUsageError.new("Invalid configuration for package `#{original_package.name}`. The metadata keys #{invalid_identifiers.inspect} are not valid behaviors under the `protection` metadata namespace. Valid keys are #{valid_identifiers.inspect}. See https://github.com/rubyatscale/package_protections#readme for more info") # rubocop:disable Style/RaiseArgs
-      end
-
       protections = {}
       metadata.each_key do |protection_key|
         protection = PackageProtections.with_identifier(protection_key)
@@ -32,18 +25,8 @@ module PackageProtections
       end
 
       unspecified_protections = valid_identifiers - protections.keys
-      protections_requiring_explicit_configuration = T.let([], T::Array[Identifier])
       unspecified_protections.each do |protection_key|
-        protection = PackageProtections.with_identifier(protection_key)
-        if !protection.default_behavior.fail_never?
-          protections_requiring_explicit_configuration << protection.identifier
-        end
-        protections[protection_key] = protection.default_behavior
-      end
-
-      if protections_requiring_explicit_configuration.any?
-        error = "All protections must explicitly set unless their default behavior is `fail_never`. Missing protections: #{protections_requiring_explicit_configuration.join(', ')}"
-        raise IncorrectPublicApiUsageError, error
+        protections[protection_key] = PackageProtections.with_identifier(protection_key).default_behavior
       end
 
       new(
@@ -55,13 +38,7 @@ module PackageProtections
 
     sig { params(protection: ProtectionInterface, metadata: T::Hash[T.untyped, T.untyped], package: ParsePackwerk::Package).returns(ViolationBehavior) }
     def self.get_violation_behavior(protection, metadata, package)
-      behavior = ViolationBehavior.from_raw_value(metadata[protection.identifier])
-      unmet_preconditions = protection.unmet_preconditions_for_behavior(behavior, package)
-      if !unmet_preconditions.nil?
-        raise IncorrectPublicApiUsageError.new("#{protection.identifier} protection does not have the valid preconditions. #{unmet_preconditions}. See https://github.com/rubyatscale/package_protections#readme for more info") # rubocop:disable Style/RaiseArgs
-      end
-
-      behavior
+      ViolationBehavior.from_raw_value(metadata[protection.identifier])
     end
 
     sig { params(key: Identifier).returns(ViolationBehavior) }

data/lib/package_protections.rb

@@ -91,6 +91,49 @@ module PackageProtections
     ).compact
   end
 
+  sig do
+    returns(T::Array[String])
+  end
+  def self.validate!
+    errors = T.let([], T::Array[String])
+    valid_identifiers = PackageProtections.all.map(&:identifier)
+
+    ParsePackwerk.all.each do |p|
+      metadata = p.metadata['protections'] || {}
+
+      # Validate that there are no invalid keys
+      invalid_identifiers = metadata.keys - valid_identifiers
+      if invalid_identifiers.any?
+        errors << "Invalid configuration for package `#{p.name}`. The metadata keys #{invalid_identifiers.inspect} are not a valid behavior under the `protection` metadata namespace. Valid keys are #{valid_identifiers.inspect}. See https://github.com/rubyatscale/package_protections#readme for more info"
+      end
+
+      # Validate that all protections requiring configuration have explicit configuration
+      unspecified_protections = valid_identifiers - metadata.keys
+      protections_requiring_explicit_configuration = unspecified_protections.reject do |protection_key|
+        protection = PackageProtections.with_identifier(protection_key)
+        protection.default_behavior.fail_never?
+      end
+
+      protections_requiring_explicit_configuration.each do |protection_identifier|
+        errors << "All protections must explicitly set unless their default behavior is `fail_never`. Missing protection #{protection_identifier} for package #{p.name}."
+      end
+
+      # Validate that all protections have all preconditions met
+      metadata.each do |protection_identifier, value|
+        next if !valid_identifiers.include?(protection_identifier)
+
+        behavior = ViolationBehavior.from_raw_value(value)
+        protection = PackageProtections.with_identifier(protection_identifier)
+        unmet_preconditions = protection.unmet_preconditions_for_behavior(behavior, p)
+        if unmet_preconditions
+          errors << "#{protection_identifier} protection does not have the valid preconditions in #{p.name}. #{unmet_preconditions}. See https://github.com/rubyatscale/package_protections#readme for more info"
+        end
+      end
+    end
+
+    errors
+  end
+
   #
   # PackageProtections.set_defaults! sets any unset protections to their default enforcement
   #

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

@@ -34,7 +34,7 @@ module RuboCop
               enabled: include_packs.any?,
               metadata: {
                 'IncludePacks' => include_packs,
-                'GloballyPermittedNamespaces' => ::PackageProtections.config.globally_permitted_namespaces
+                'GloballyPermittedNamespaces' => ::RuboCop::Packs.config.globally_permitted_namespaces
               }
             )
           ]
@@ -57,23 +57,19 @@ module RuboCop
 
         sig { override.params(behavior: ::PackageProtections::ViolationBehavior, package: ParsePackwerk::Package).returns(T.nilable(String)) }
         def unmet_preconditions_for_behavior(behavior, package)
-          if !behavior.enabled? && !package.metadata['global_namespaces'].nil?
-            "Invalid configuration for package `#{package.name}`. `#{identifier}` must be turned on to use `global_namespaces` configuration."
-          else
-            # We don't need to validate if the behavior is currentely fail_never
-            return if behavior.fail_never?
+          # We don't need to validate if the behavior is currentely fail_never
+          return if behavior.fail_never?
 
-            # The reason for this is precondition is the `MultipleNamespacesProtection` assumes this to work properly.
-            # To remove this precondition, we need to modify `MultipleNamespacesProtection` to be more generalized!
-            is_root_package = package.name == ParsePackwerk::ROOT_PACKAGE_NAME
-            in_allowed_directory = ::PackageProtections::EXPECTED_PACK_DIRECTORIES.any? do |expected_package_directory|
-              package.directory.to_s.start_with?(expected_package_directory)
-            end
-            if in_allowed_directory || is_root_package
-              nil
-            else
-              "Package #{package.name} must be located in one of #{::PackageProtections::EXPECTED_PACK_DIRECTORIES.join(', ')} (or be the root) to use this protection"
-            end
+          # The reason for this is precondition is the `MultipleNamespacesProtection` assumes this to work properly.
+          # To remove this precondition, we need to modify `MultipleNamespacesProtection` to be more generalized!
+          is_root_package = package.name == ParsePackwerk::ROOT_PACKAGE_NAME
+          in_allowed_directory = ::PackageProtections::EXPECTED_PACK_DIRECTORIES.any? do |expected_package_directory|
+            package.directory.to_s.start_with?(expected_package_directory)
+          end
+          if in_allowed_directory || is_root_package
+            nil
+          else
+            "Package #{package.name} must be located in one of #{::PackageProtections::EXPECTED_PACK_DIRECTORIES.join(', ')} (or be the root) to use this protection"
           end
         end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: package_protections
 version: !ruby/object:Gem::Version
-  version: 2.5.2
+  version: 3.1.0
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-09 00:00:00.000000000 Z
+date: 2022-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -232,7 +232,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Package protections for Rails apps