package_protections 2.5.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58f01e3852a51048fe302838f5c9cfae1d116789a0cf590484f1f5a38f018215
-  data.tar.gz: 9676ca99110ee87a03963b2391a7c449396bb2b8dfbaa4b0bc585c74632bbe8c
+  metadata.gz: 0c09fbdc359d1dc28d4168fc0041dc385ea8a5b78c77436c598d5f6fd3eb24d6
+  data.tar.gz: 7ab7d9d30955c98c8213434b80923a96602a2489e2b822b9e8f75f3ff25145e8
 SHA512:
-  metadata.gz: d90ddaf7d29c7bef8e50fd1c9e18e9921c24799b820dc6db5da2bfaf16ab3380612e2e320fb5198aa9085c448e58e826d437e5966fe25a2721db241cfdca1789
-  data.tar.gz: bbc96e01cac4e6232500c9466f37db3a522a4c50767f3e7f9c9bed60595055cd467cfa0ecfe98afd3ee3bf6de3be06e0b06a1f8d205314d4bcb760a071333ec2
+  metadata.gz: 0027653c627faaacdc1e7dfe57342d10130b93cd833a5083091c54fbc48ba106366768671ce703cdf5c4576dcd53db10a39cc59f0262fc18b06153d00ddcc284
+  data.tar.gz: 1494769fd3a1120add3da651cba6b0c826cc990890669810eb1532404ef1e2820470628bc89a77794589b819ed557da9cb3127910deebe2780854d560760ad9d

data/lib/package_protections/private.rb

@@ -121,41 +121,6 @@ module PackageProtections
       @loaded_client_configuration = false
     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/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/rubocop_protection_interface.rb

@@ -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|

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
   #
@@ -121,6 +164,6 @@ module PackageProtections
   sig { void }
   def self.bust_cache!
     Private.bust_cache!
-    RubocopProtectionInterface.bust_rubocop_todo_yml_cache
+    RuboCop::Packs.bust_cache!
   end
 end

metadata

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