rubocop-packs 0.0.24 → 0.0.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86c7a0f38ce8943c88c771c4516e63885c5b400ca9c9084b88bed7573b157afd
-  data.tar.gz: b34b6c97ce2c969aaee9269f383b98a200103871f5ffc3936ae19c0ea7b742f3
+  metadata.gz: 8bd2b6fe8873467709b0d319443a7cfc13441869c1b93f9ad03120880539da6a
+  data.tar.gz: 442ab7d01be0e1d6f0f762d317e2594cad7cae0d12de5ef06949e6668e1b41f4
 SHA512:
-  metadata.gz: 4a8d92eec135704409fb4eb76fe25dc5118c197e9c0256546958758734dff552c77bbcda5495d8eb788bde648c1335734823e34d5bfb5f283c9fa6a6e9207024
-  data.tar.gz: 5a56441cdf2b6dd335a39db3defd87df4360f388431ee1ef7d883bb50c712f156515fdc0556b2ce05c82be4312bffbc4ca69a85825e56d49880f0cd60bfd5e5e
+  metadata.gz: 1555cca928585f81cd62ec8a055b828a7be4b384b4af89bf4af4e9d61de7eae2ac1b7affe1a258dc26b863aca4b74d714660645c45bc74f2c662e8cf21375a43
+  data.tar.gz: 7fa7e16536caa4712fa34508782c0480790b5db7fa2bf9cf4243cbafd5622887142057b1ffbccf941dcf44abfb11fe1077aa1d90b77a75834775b9c8ffe08940

data/lib/rubocop/packs/private/offense.rb

@@ -0,0 +1,19 @@
+# typed: strict
+
+module RuboCop
+  module Packs
+    module Private
+      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
+    end
+  end
+end

data/lib/rubocop/packs/private.rb

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 require 'rubocop/packs/private/configuration'
+require 'rubocop/packs/private/offense'
 
 module RuboCop
   module Packs
@@ -154,6 +155,28 @@ module RuboCop
         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
+
       sig { params(block: T.untyped).returns(String) }
       def self.with_captured_stdout(&block)
         original_stdout = $stdout  # capture previous value of $stdout

data/lib/rubocop/packs.rb

@@ -5,6 +5,8 @@ require 'rubocop/packs/private'
 
 module RuboCop
   module Packs
+    extend T::Sig
+
     # Pack-level rubocop and rubocop_todo YML files are named differently because they are not integrated
     # into rubocop in the standard way. For example, we could call these the standard `.rubocop.yml` and
     # `.rubocop_todo.yml`. However, this introduces a number of path relativity issues (https://docs.rubocop.org/rubocop/configuration.html#path-relativity)
@@ -13,66 +15,39 @@ module RuboCop
     PACK_LEVEL_RUBOCOP_YML = 'package_rubocop.yml'
     PACK_LEVEL_RUBOCOP_TODO_YML = 'package_rubocop_todo.yml'
 
-    class Error < StandardError; end
-    extend T::Sig
-
-    # Your code goes here...
     PROJECT_ROOT   = T.let(Pathname.new(__dir__).parent.parent.expand_path.freeze, Pathname)
     CONFIG_DEFAULT = T.let(PROJECT_ROOT.join('config', 'default.yml').freeze, Pathname)
     CONFIG         = T.let(YAML.safe_load(CONFIG_DEFAULT.read).freeze, T.untyped)
 
     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
     # exclusions with the closest ancestor `.rubocop_todo.yml`
     #
-    sig { params(packs: T::Array[ParsePackwerk::Package]).void }
-    def self.regenerate_todo(packs:)
-      offenses = offenses_for(
-        paths: packs.map(&:name).reject { |name| name == ParsePackwerk::ROOT_PACKAGE_NAME },
+    sig { params(packs: T::Array[ParsePackwerk::Package], files: T::Array[String]).void }
+    def self.regenerate_todo(packs: [], files: [])
+      paths = packs.empty? ? files : packs.map(&:name).reject { |name| name == ParsePackwerk::ROOT_PACKAGE_NAME }
+      offenses = Private.offenses_for(
+        paths: paths,
         cop_names: config.permitted_pack_level_cops
       )
 
       offenses.group_by(&:pack).each do |pack, offenses_for_pack|
+        next if pack.name == ParsePackwerk::ROOT_PACKAGE_NAME
+        next if !pack.directory.join(PACK_LEVEL_RUBOCOP_YML).exist?
+
         rubocop_todo_yml = pack.directory.join(PACK_LEVEL_RUBOCOP_TODO_YML)
-        rubocop_todo_yml.delete if rubocop_todo_yml.exist?
-        rubocop_todo = {}
+        # If the user is passing in packs, then regenerate from scratch.
+        if packs.any? && rubocop_todo_yml.exist?
+          rubocop_todo_yml.delete
+          rubocop_todo = {}
+        elsif rubocop_todo_yml.exist?
+          rubocop_todo = YAML.load_file(rubocop_todo_yml)
+        else
+          rubocop_todo = {}
+        end
 
         offenses_for_pack.each do |offense|
           rubocop_todo[offense.cop_name] ||= { 'Exclude' => [] }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-packs
 version: !ruby/object:Gem::Version
-  version: 0.0.24
+  version: 0.0.25
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-18 00:00:00.000000000 Z
+date: 2022-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -202,6 +202,7 @@ files:
 - lib/rubocop/packs/inject.rb
 - lib/rubocop/packs/private.rb
 - lib/rubocop/packs/private/configuration.rb
+- lib/rubocop/packs/private/offense.rb
 - lib/rubocop/packwerk_lite.rb
 homepage: https://github.com/rubyatscale/rubocop-packs
 licenses: