rubocop-packs 0.0.22 → 0.0.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29bc317ca9e4c37dca1d9d9c3f2f734fde84eceb37bb3482351d18af19991b5b
-  data.tar.gz: 6093679682bef57592958637bfc18ad7f310744b0715e4278364d9e74da4a0bf
+  metadata.gz: 906e2ee0ee85e6c02849013bd37034fe6f0f3d8e99ba1597767da463e9f864a4
+  data.tar.gz: eeec895514ef54dd70846947ecfd37e5577e842938ea93fc220c4d0b086c1247
 SHA512:
-  metadata.gz: 8c5727dca42988c966d1bd9e690499284a6426aa99929b6cbec3ff8b5cfc13f8375f03cbdb14a211eb25ac265dc38c2d4e71860507a0474cb4202c8ddd86cc8a
-  data.tar.gz: 834246c4402b8f969196ece18718d386d94ab3a428d7317b54f4cad8ec72a860c14ffbb633b802c921415f355cfa602fbbd98a8fe9373289e91ab142b6315ab8
+  metadata.gz: 481e3a029eaa4e69e0a5f6cf5736356e0f3dd1bb602c7ef24bda112486fb1c1fcfa7e48b40ff2f7bb2eaa38dbf2d3093d2ac4d3603c8d604876efb5213eef53c
+  data.tar.gz: 9c0901dd0da0d2365e53488e1d12d281f407cb271db4c35013046548a2bfbc80cc25f0f47e4d4bec79ba043fca4fb0d37d331ad431a947e5dfd4131ce8b2779c

data/lib/rubocop/packs/private.rb

@@ -146,6 +146,23 @@ module RuboCop
 
         errors
       end
+
+      sig { params(args: T.untyped).returns(String) }
+      def self.execute_rubocop(args)
+        with_captured_stdout do
+          RuboCop::CLI.new.run(args)
+        end
+      end
+
+      sig { params(block: T.untyped).returns(String) }
+      def self.with_captured_stdout(&block)
+        original_stdout = $stdout  # capture previous value of $stdout
+        $stdout = StringIO.new     # assign a string buffer to $stdout
+        yield                      # perform the body of the user code
+        $stdout.string             # return the contents of the string buffer
+      ensure
+        $stdout = original_stdout  # restore $stdout to its previous value
+      end
     end
 
     private_constant :Private

data/lib/rubocop/packs.rb

@@ -23,6 +23,40 @@ module RuboCop
 
     private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
 
+    class Offense < T::Struct
+      extend T::Sig
+
+      const :cop_name, String
+      const :filepath, String
+
+      sig { returns(ParsePackwerk::Package) }
+      def pack
+        ParsePackwerk.package_from_path(filepath)
+      end
+    end
+
+    sig { params(paths: T::Array[String], cop_names: T::Array[String]).returns(T::Array[Offense]) }
+    def self.offenses_for(paths:, cop_names:)
+      path_arguments = paths.join(' ')
+      cop_arguments = cop_names.join(',')
+      # I think we can potentially use `RuboCop::CLI.new(args)` for this to avoid shelling out and starting another process that needs to reload the bundle
+      args = [path_arguments, "--only=#{cop_arguments}", '--format=json']
+      puts "Executing: bundle exec rubocop #{args.join(' ')}"
+      json = JSON.parse(Private.execute_rubocop(args))
+      offenses = T.let([], T::Array[Offense])
+      json['files'].each do |file_hash|
+        filepath = file_hash['path']
+        file_hash['offenses'].each do |offense_hash|
+          offenses << Offense.new(
+            cop_name: offense_hash['cop_name'],
+            filepath: filepath
+          )
+        end
+      end
+
+      offenses
+    end
+
     #
     # Ideally, this is API that is available to us via `rubocop` itself.
     # That is: the ability to preserve the location of `.rubocop_todo.yml` files and associate
@@ -30,40 +64,22 @@ module RuboCop
     #
     sig { params(packs: T::Array[ParsePackwerk::Package]).void }
     def self.auto_generate_rubocop_todo(packs:)
-      pack_arguments = packs.map(&:name).join(' ')
-      cop_arguments = config.permitted_pack_level_cops.join(',')
-      command = "bundle exec rubocop #{pack_arguments} --only=#{cop_arguments} --format=json"
-      puts "Executing: #{command}"
-      json = JSON.parse(`#{command}`)
-      new_rubocop_todo_exclusions = {}
-      json['files'].each do |file_hash|
-        filepath = file_hash['path']
-        pack = ParsePackwerk.package_from_path(filepath)
-        next if pack.name == ParsePackwerk::ROOT_PACKAGE_NAME
-
-        file_hash['offenses'].each do |offense_hash|
-          cop_name = offense_hash['cop_name']
-          next unless config.permitted_pack_level_cops.include?(cop_name)
+      offenses = offenses_for(
+        paths: packs.map(&:name).reject { |name| name == ParsePackwerk::ROOT_PACKAGE_NAME },
+        cop_names: config.permitted_pack_level_cops
+      )
 
-          new_rubocop_todo_exclusions[pack.name] ||= {}
-          new_rubocop_todo_exclusions[pack.name][filepath] ||= []
-          new_rubocop_todo_exclusions[pack.name][filepath] << cop_name
-        end
-      end
-
-      new_rubocop_todo_exclusions.each do |pack_name, file_hash|
-        pack = T.must(ParsePackwerk.find(pack_name))
+      offenses.group_by(&:pack).each do |pack, offenses_for_pack|
         rubocop_todo_yml = pack.directory.join(PACK_LEVEL_RUBOCOP_TODO_YML)
         if rubocop_todo_yml.exist?
           rubocop_todo = YAML.load_file(rubocop_todo_yml)
         else
           rubocop_todo = {}
         end
-        file_hash.each do |file, failing_cops|
-          failing_cops.each do |failing_cop|
-            rubocop_todo[failing_cop] ||= { 'Exclude' => [] }
-            rubocop_todo[failing_cop]['Exclude'] << file
-          end
+
+        offenses_for_pack.each do |offense|
+          rubocop_todo[offense.cop_name] ||= { 'Exclude' => [] }
+          rubocop_todo[offense.cop_name]['Exclude'] << offense.filepath
         end
 
         next if rubocop_todo.empty?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-packs
 version: !ruby/object:Gem::Version
-  version: 0.0.22
+  version: 0.0.23
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-15 00:00:00.000000000 Z
+date: 2022-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport