package_protections 0.64.0 → 0.65.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1b60522d3be3ff25aaab73a4c0e6d4d0585657663352b9c353d6df3307287c4
-  data.tar.gz: 8b57faaea71bfb8b64f842b7e2ec40cdc313bc2c674243a698c9dc7bcbc21b56
+  metadata.gz: d88381cc31fe478662a2be25b85704c798c2b890aca03fd399d38c3e3e4036f7
+  data.tar.gz: d1451e08e65506b3524ae32eaad2b6e8375cf600e6b11bb381426fc0e15490fd
 SHA512:
-  metadata.gz: e35ac2ae85c9459f3e480ba9939bf7e5db0902049c3643620e3ba2478a443c87dfe1ac1c9029254d7f616ac0d4821df3d07625e332a431349ff4860d5f46e64e
-  data.tar.gz: c90972ea3fbf86c36ea1492948fa56cd42e2b38731f6e9410c69296286d43310e7104413ccb20206392e1546e3b82c23ea25ba16defe09960718b7dadb63189f
+  metadata.gz: fa85b6989d368a73734516df0e26bc5132024c70da4f4562db0ef868a289101441d640d8d39d65502696cd91dbf9066d5214cd10e20b4d19e894c6ef1372d251
+  data.tar.gz: a877190298f30b829e18f5626f15ac9af3175a852a339cb36b474e4760805c8e3265cc008cd7f4edb64917ba49231633faad7e6763a952ac493005849897fff8

data/README.md

@@ -128,6 +128,18 @@ PackageProtections.set_defaults!(packages)
 PackageProtections.set_defaults!(packages.select{|p| p.package_name == 'packs/my_package'})
 ```
 
+## Custom Protections
+
+It's possible to create your own custom protections that go through this interface. To do this, you just need to implement a protection and configure `PackageProtections`.
+
+```ruby
+PackageProtections.configure do |config|
+  config.protections += [MyCustomProtection]
+end
+```
+
+In this example, `MyCustomProtection` needs to implement the `PackageProtections::ProtectionInterface` (for protections powered by `packwerk` that look at new and existing violations) OR `PackageProtections::RubocopProtectionInterface` (for protections powered by `rubocop` that look at the AST). It's recommended to take a look at the existing protections as examples. If you're having any trouble with this, please file an issue and we'll be glad to help.
+
 ## Incorporating into your CI Pipeline
 Your CI pipeline can execute the public API ta and fail if there are any offenses.
 

data/lib/package_protections/private/configuration.rb

@@ -0,0 +1,38 @@
+# typed: strict
+
+module PackageProtections
+  module Private
+    class Configuration
+      extend T::Sig
+
+      sig { params(protections: T::Array[ProtectionInterface]).void }
+      attr_writer :protections
+
+      sig { void }
+      def initialize
+        @protections = T.let(default_protections, T::Array[ProtectionInterface])
+      end
+
+      sig { returns(T::Array[ProtectionInterface]) }
+      def protections
+        @protections
+      end
+
+      sig { void }
+      def bust_cache!
+        @protections = default_protections
+      end
+
+      sig { returns(T::Array[ProtectionInterface]) }
+      def default_protections
+        [
+          Private::OutgoingDependencyProtection.new,
+          Private::IncomingPrivacyProtection.new,
+          Private::TypedApiProtection.new,
+          Private::MultipleNamespacesProtection.new,
+          Private::VisibilityProtection.new
+        ]
+      end
+    end
+  end
+end

data/lib/package_protections/private.rb

@@ -9,6 +9,7 @@ require 'package_protections/private/outgoing_dependency_protection'
 require 'package_protections/private/metadata_modifiers'
 require 'package_protections/private/multiple_namespaces_protection'
 require 'package_protections/private/visibility_protection'
+require 'package_protections/private/configuration'
 
 module PackageProtections
   #
@@ -18,6 +19,12 @@ module PackageProtections
   module Private
     extend T::Sig
 
+    sig { returns(Private::Configuration) }
+    def self.config
+      @config = T.let(@config, T.nilable(Configuration))
+      @config ||= Private::Configuration.new
+    end
+
     sig do
       params(
         packages: T::Array[ParsePackwerk::Package],
@@ -138,6 +145,7 @@ module PackageProtections
     def self.bust_cache!
       @protected_packages_indexed_by_name = nil
       @private_cop_config = nil
+      config.bust_cache!
     end
 
     sig { params(identifier: Identifier).returns(T::Hash[T.untyped, T.untyped]) }

data/lib/package_protections.rb

@@ -38,20 +38,18 @@ module PackageProtections
   # Implementation of rubocop-based protections
   require 'rubocop/cop/package_protections/namespaced_under_package_name'
 
-  #
-  # These are all of the concrete implementations of the `ProtectionInterface`.
-  # This list is added to when a new protection is created, but in the future,
-  # this list may be injected by the client.
-  #
+  class << self
+    extend T::Sig
+
+    sig { params(blk: T.proc.params(arg0: Private::Configuration).void).void }
+    def configure(&blk)
+      yield(Private.config)
+    end
+  end
+
   sig { returns(T::Array[ProtectionInterface]) }
   def self.all
-    [
-      Private::OutgoingDependencyProtection.new,
-      Private::IncomingPrivacyProtection.new,
-      Private::TypedApiProtection.new,
-      Private::MultipleNamespacesProtection.new,
-      Private::VisibilityProtection.new
-    ]
+    Private.config.protections
   end
 
   #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: package_protections
 version: !ruby/object:Gem::Version
-  version: 0.64.0
+  version: 0.65.0
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-04 00:00:00.000000000 Z
+date: 2022-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -178,6 +178,7 @@ files:
 - lib/package_protections/per_file_violation.rb
 - lib/package_protections/private.rb
 - lib/package_protections/private/colorized_string.rb
+- lib/package_protections/private/configuration.rb
 - lib/package_protections/private/incoming_privacy_protection.rb
 - lib/package_protections/private/metadata_modifiers.rb
 - lib/package_protections/private/multiple_namespaces_protection.rb