package_protections 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7471704e495c4ffe4e849be40a9fad64eed08e3980e9d630300eeae5c8e0d006
-  data.tar.gz: dbb34a83f3b4f7ed1a3327d36ac2dd5191d17bba0206ebfa06344d056c35b43a
+  metadata.gz: 209662f8b4bb58c12b998627275107715b1b92f72250dd57275a830db2b3ee28
+  data.tar.gz: 72dfeeca3bc2e0d83af7d7274fb7574b9d50fa41df594a56673a997b7ca5c63f
 SHA512:
-  metadata.gz: 77012017f0440763480a9f02ab289254870b9d937ff72cfa8f665331b04195cf01e1724562796d1a74414d38c855fa95710879d6efe105367792a3cf7b1bf60b
-  data.tar.gz: 48cb93ff9ec6b2b4785587c795fb6571ff55ade4de471c93b38fa3244113b4d4b0ecd6f431d335754ad4d5c6e7d23e3ec6701c71d0fca1328848dcf5a1f27836
+  metadata.gz: f21c828d5523d288a4b4bbc297efc15ef54cbc8e34871d3338cbeccf12254b5c21e20613a22f7a950edaf27f4052b27db4ffc86d34378eb254760618895245d2
+  data.tar.gz: 6cf01a48f348a4d297a3153b6129bb139f78206d46daf29bc5b543a84debc309780645ddb6979e8375b8cdf8affcdd4f70af3eea02eb33d07a2445b3ec8f1ba9

data/lib/package_protections/private/configuration.rb

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

data/lib/package_protections/private.rb

@@ -117,6 +117,9 @@ module PackageProtections
       @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]) }
@@ -128,6 +131,49 @@ module PackageProtections
         protected_packages.map { |p| [p.name, protection.custom_cop_config(p)] }.to_h
       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|
+        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))
+      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

data/lib/package_protections/rubocop_protection_interface.rb

@@ -71,20 +71,7 @@ module PackageProtections
 
     sig { void }
     def self.bust_rubocop_todo_yml_cache
-      @rubocop_todo_yml = nil
-    end
-
-    sig { returns(T.untyped) }
-    def self.rubocop_todo_yml
-      @rubocop_todo_yml = T.let(@rubocop_todo_yml, T.untyped)
-      @rubocop_todo_yml ||= begin
-        todo_file = Pathname.new('.rubocop_todo.yml')
-        if todo_file.exist?
-          YAML.load_file(todo_file)
-        else
-          {}
-        end
-      end
+      Private.bust_rubocop_todo_yml_cache
     end
 
     sig do
@@ -93,7 +80,7 @@ module PackageProtections
       ).returns(T::Array[Offense])
     end
     def get_offenses_for_existing_violations(protected_packages)
-      exclude_list = exclude_for_rule(cop_name)
+      exclude_list = Private.exclude_for_rule(cop_name)
       offenses = []
 
       protected_packages.each do |package|
@@ -146,13 +133,5 @@ module PackageProtections
         )
       ]
     end
-
-    private
-
-    sig { params(rule: String).returns(T::Set[String]) }
-    def exclude_for_rule(rule)
-      rule_config = RubocopProtectionInterface.rubocop_todo_yml[rule] || {}
-      Set.new(rule_config['Exclude'] || [])
-    end
   end
 end

data/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 @@ module PackageProtections
 
   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 @@ module PackageProtections
     RubocopProtectionInterface.bust_rubocop_todo_yml_cache
   end
 end
-
-if defined?(Rubocop)
-  require 'rubocop/cop/package_protections'
-end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: package_protections
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-21 00:00:00.000000000 Z
+date: 2022-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,20 +80,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: zeitwerk
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -205,7 +191,6 @@ files:
 - lib/package_protections/rspec/support.rb
 - lib/package_protections/rubocop_protection_interface.rb
 - lib/package_protections/violation_behavior.rb
-- lib/rubocop/cop/package_protections.rb
 - lib/rubocop/cop/package_protections/namespaced_under_package_name.rb
 - lib/rubocop/cop/package_protections/namespaced_under_package_name/desired_zeitwerk_api.rb
 - lib/rubocop/cop/package_protections/typed_public_api.rb

data/lib/rubocop/cop/package_protections.rb

@@ -1,13 +0,0 @@
-require 'rubocop'
-require 'rubocop-sorbet'
-
-module RuboCop
-  module Cop
-    module PackageProtections
-      autoload :NamespacedUnderPackageName, 'rubocop/cop/package_protections/namespaced_under_package_name'
-      autoload :TypedPublicApi, 'rubocop/cop/package_protections/typed_public_api'
-    end
-  end
-end
-
-# Implementation of rubocop-based protections