Allow package protections to self configure (#28)

* Revert "Use autoload when possible to lazily require internal dependencies (#22)"

This reverts commit 0f56f9c.

* Load client configuration when initializing config

* bump version

* use .rb suffix

* use guard clause

Author: Alex Evanczuk

Gemfile.lock

@@ -1,13 +1,12 @@
 PATH
   remote: .
   specs:
-    package_protections (2.1.1)
+    package_protections (2.2.0)
       activesupport
       parse_packwerk
       rubocop
       rubocop-sorbet
       sorbet-runtime
-      zeitwerk
 
 GEM
   remote: https://rubygems.org/
@@ -109,7 +108,6 @@ GEM
     yard-sorbet (0.6.1)
       sorbet-runtime (>= 0.5)
       yard (>= 0.9)
-    zeitwerk (2.6.0)
 
 PLATFORMS
   ruby

lib/package_protections.rb

@@ -1,23 +1,20 @@
 # frozen_string_literal: true
 
 # typed: strict
-
 require 'sorbet-runtime'
-
 require 'open3'
 require 'set'
 require 'parse_packwerk'
+require 'rubocop'
+require 'rubocop-sorbet'
 
-require 'zeitwerk'
-loader = T.unsafe(Zeitwerk::Loader).for_gem
-loader.ignore("#{__dir__}/rubocop")
-loader.setup
-
+#
 # Welcome to PackageProtections!
 # See https://github.com/rubyatscale/package_protections#readme for more info
 #
 # This file is a reference for the available API to `package_protections`, but all implementation details are private
 # (which is why we delegate to `Private` for the actual implementation).
+#
 module PackageProtections
   extend T::Sig
 
@@ -30,6 +27,18 @@ module PackageProtections
   # This is currently the only handled exception that `PackageProtections` will throw.
   class IncorrectPublicApiUsageError < StandardError; end
 
+  require 'package_protections/offense'
+  require 'package_protections/violation_behavior'
+  require 'package_protections/protected_package'
+  require 'package_protections/per_file_violation'
+  require 'package_protections/protection_interface'
+  require 'package_protections/rubocop_protection_interface'
+  require 'package_protections/private'
+
+  # Implementation of rubocop-based protections
+  require 'rubocop/cop/package_protections/namespaced_under_package_name'
+  require 'rubocop/cop/package_protections/typed_public_api'
+
   class << self
     extend T::Sig
 
@@ -46,6 +55,7 @@ def self.all
 
   sig { returns(Private::Configuration) }
   def self.config
+    Private.load_client_configuration
     @config = T.let(@config, T.nilable(Private::Configuration))
     @config ||= Private::Configuration.new
   end
@@ -119,7 +129,3 @@ def self.bust_cache!
     RubocopProtectionInterface.bust_rubocop_todo_yml_cache
   end
 end
-
-if defined?(Rubocop)
-  require 'rubocop/cop/package_protections'
-end

lib/package_protections/private.rb

@@ -117,6 +117,9 @@ 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]) }
@@ -161,6 +164,16 @@ def self.exclude_for_rule(rule)
 
       excludes
     end
+
+    sig { void }
+    def self.load_client_configuration
+      @loaded_client_configuration ||= T.let(false, T.nilable(T::Boolean))
+      return if @loaded_client_configuration
+
+      @loaded_client_configuration = true
+      client_configuration = Pathname.pwd.join('config/package_protections.rb')
+      require client_configuration.to_s if client_configuration.exist?
+    end
   end
 
   private_constant :Private

lib/package_protections/private/configuration.rb

@@ -35,8 +35,6 @@ def bust_cache!
 
       sig { returns(T::Array[ProtectionInterface]) }
       def default_protections
-        require 'rubocop/cop/package_protections'
-
         [
           Private::OutgoingDependencyProtection.new,
           Private::IncomingPrivacyProtection.new,

lib/rubocop/cop/package_protections.rb

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = 'package_protections'
-  spec.version       = '2.1.1'
+  spec.version       = '2.2.0'
   spec.authors       = ['Gusto Engineers']
   spec.email         = ['[email protected]']
   spec.summary       = 'Package protections for Rails apps'
@@ -26,7 +26,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'rubocop'
   spec.add_dependency 'rubocop-sorbet'
   spec.add_dependency 'sorbet-runtime'
-  spec.add_dependency 'zeitwerk'
 
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'

package_protections.gemspec

@@ -2,9 +2,9 @@
 #   srb rbi todo
 
 # typed: strong
-module ::Zeitwerk::Loader; end
+module ::RuboCop::RSpec::ExpectOffense; end
 module RSpec::Matchers; end
-module RuboCop::RSpec::ExpectOffense; end
+
 class Hash
   def to_yaml; end
 end

sorbet/rbi/todo.rbi

@@ -1330,4 +1330,20 @@ def get_new_violations
                                                          })
     end
   end
+
+  describe 'configuration' do
+    context 'app has a user defined configuration' do
+      before do
+        write_file('config/package_protections.rb', <<~CONFIGURATION)
+          PackageProtections.configure do |config|
+            config.globally_permitted_namespaces = ['MyNamespace']
+          end
+        CONFIGURATION
+      end
+
+      it 'properly configures package protections' do
+        expect(PackageProtections.config.globally_permitted_namespaces).to eq(['MyNamespace'])
+      end
+    end
+  end
 end

spec/package_protections_spec.rb

@@ -1,7 +1,6 @@
 require 'pry'
-require 'rubocop/cop/package_protections'
-require 'rubocop/rspec/support'
 require 'package_protections'
+require 'rubocop/rspec/support'
 require 'package_protections/rspec/support'
 
 RSpec.configure do |config|