package_protections 2.0.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e7bd9febdd0619b714c112033b8bf61958e04368e8fb0c0e5f3498de54e988c
-  data.tar.gz: a0f7c5f79f3eb1279d084045c115345424dd2acfa22954eed321d2cf220bd40b
+  metadata.gz: f503d714980699ad618258d74bb41489328aedce9e8201bfc7e1a5a086e0bdf9
+  data.tar.gz: d3cc2f5d197322d29dff1b794f889bc74b2a79e431e8bf7b70ec1d4e81cfabd4
 SHA512:
-  metadata.gz: b8ff41de5e829270999baa91dc8df0fb3e810c6e8be39358cdbc6fd188a9d79ddf138f19b935a13360106c2a5e6c8300edffdf5fedf71e39c52826d2a6050a9e
-  data.tar.gz: f255780ea5ed693e66edcd028b4b8247419c612afddd1790f53078ecec3ca274e456c6ed16e62a0d83158c853f2be25282250c5b40b93b069da504469d25acf8
+  metadata.gz: 6198bc334e103a52eeac5110fab05a21a72b6ed22f33b7ef455b23cb6cbb93fea9ed0b9f2a9ff122ad80ddc587d21fdbb7b7398ed6aef94ad9ad5470666932da
+  data.tar.gz: c1fd8d5e56cd37b29304dd467effef8a8cb062ed059ffa434cfff6a4c1300a191612042457139b8715737b7b2a732b44b2d2a0b1c961e934773ae9e4da093544

data/lib/package_protections/private/configuration.rb

@@ -35,6 +35,8 @@ 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

@@ -128,6 +128,39 @@ 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
   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,20 +1,23 @@
 # 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
 
@@ -27,18 +30,6 @@ 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
 
@@ -128,3 +119,7 @@ module PackageProtections
     RubocopProtectionInterface.bust_rubocop_todo_yml_cache
   end
 end
+
+if defined?(Rubocop)
+  require 'rubocop/cop/package_protections'
+end

data/lib/rubocop/cop/package_protections.rb

@@ -0,0 +1,13 @@
+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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: package_protections
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-12 00:00:00.000000000 Z
+date: 2022-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,6 +80,20 @@ 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
@@ -191,6 +205,7 @@ 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