Fix bug with root package protections (#12)

* Fix bug where root package protections have false failures

* bump version

Author: Alex Evanczuk

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    package_protections (1.1.0)
+    package_protections (1.1.1)
       activesupport
       parse_packwerk
       rubocop
@@ -67,7 +67,7 @@ GEM
       parser (>= 3.0.1.1)
     rubocop-rspec (2.8.0)
       rubocop (~> 1.19)
-    rubocop-sorbet (0.6.10)
+    rubocop-sorbet (0.6.11)
       rubocop (>= 0.90.0)
     ruby-progressbar (1.11.0)
     sorbet (0.5.9588)

lib/package_protections/rubocop_protection_interface.rb

@@ -108,7 +108,7 @@ def get_offenses_for_existing_violations(protected_packages)
           T.absurd(violation_behavior)
         end
 
-        package.original_package.directory.glob('**/**/*.*').each do |relative_path_to_file|
+        package.original_package.directory.glob(included_globs_for_pack).each do |relative_path_to_file|
           next unless exclude_list.include?(relative_path_to_file.to_s)
 
           file = relative_path_to_file.to_s

package_protections.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = 'package_protections'
-  spec.version       = '1.1.0'
+  spec.version       = '1.1.1'
   spec.authors       = ['Gusto Engineers']
   spec.email         = ['[email protected]']
   spec.summary       = 'Package protections for Rails apps'

sorbet/rbi/manual.rbi

@@ -0,0 +1,8 @@
+# typed: true
+
+class Pathname
+  sig do
+    params(p1: T::Array[String], p2: Integer).returns(T::Array[Pathname])
+  end
+  def glob(p1, p2=0, &blk); end
+end

spec/package_protections_spec.rb

@@ -665,9 +665,7 @@ def offense(
             expect(offenses).to contain_exactly(0).offenses
           end
 
-          # Note -- to simplify implementation, we look at *any* files in the exclude list.
-          # There shouldn't be much of a reason to add to this list with files that the cop doesn't look at in the first place
-          it 'fails when there are files from private implementation in the rubocop TODO list' do
+          it 'succeeds when there are files from private implementation in the rubocop TODO list' do
             apples_package_yml_with_typed_api_protection_set_to_fail_on_any
             write_file('packs/apples/app/services/tool.rb', '')
             write_file('.rubocop_todo.yml', <<~YML.strip)
@@ -677,11 +675,7 @@ def offense(
             YML
 
             offenses = PackageProtections.get_offenses(packages: get_packages, new_violations: [])
-            expect(offenses).to contain_exactly(1).offense
-            expect(offenses).to include_offense offense(
-              'packs/apples',
-              'packs/apples/app/services/tool.rb should be `typed: strict`', 'packs/apples/app/services/tool.rb', 'prevent_this_package_from_exposing_an_untyped_api'
-            )
+            expect(offenses).to contain_exactly(0).offense
           end
 
           it 'fails if there is a public API file in the rubocop TODO list' do
@@ -715,6 +709,23 @@ def offense(
             offenses = PackageProtections.get_offenses(packages: get_packages, new_violations: [])
             expect(offenses).to contain_exactly(0).offenses
           end
+
+          context 'when the pack with the protection is the root pack' do
+            it 'succeeds if there is a different pack\'s public API file in the rubocop TODO list' do
+              write_package_yml('.', protections: { 'prevent_this_package_from_exposing_an_untyped_api' => 'fail_on_any' })
+
+              write_file('app/public/tool.rb', '')
+              write_file('packs/other_pack/app/public/tool.rb', '')
+              write_file('.rubocop_todo.yml', <<~YML.strip)
+                PackageProtections/TypedPublicApi:
+                  Exclude:
+                    - packs/other_pack/app/public/tool.rb
+              YML
+
+              offenses = PackageProtections.get_offenses(packages: get_packages, new_violations: [])
+              expect(offenses).to contain_exactly(0).offenses
+            end
+          end
         end
       end