rubocop-packs 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3aa6a83103635cffaf57bbe3187211f14b0981633a55cf04cd73f6261df3d83a
-  data.tar.gz: 8816eab16fe3dd069a3327b8f1569e910ea07a012bb97bead1baf0f7f6cdfc66
+  metadata.gz: caa9570071b5d3b21d447db0959789fbdf5747b352f5b1d5705bd95f0552f722
+  data.tar.gz: 3e739760cb2850057189f4f355417921b0be120cb723f8444e567bdf86ad7392
 SHA512:
-  metadata.gz: 37e828c802da1563049ce07a05e224187bfe8a3d61861f0cc05e774c311a3627d66d6ff116480d44100a9d31ef756bde1ea16777e02e5517e8f31fb0aab77595
-  data.tar.gz: 2e54cf17766e69bfd81663a488f1171a74335dd71c55fbfc55f9d1334f6eeae5d0b0fd5e7134349b42fb61c749520a760fd1902f0dfe19c457c311cba55f10ca
+  metadata.gz: 851f5ca37b72f15b5b763a5272094c0996cd4ae2c1daf6924209eaefc4787e0c9a68c9336c71db949995f7fc95eae89d0597a36af486127d87665b5d7c8431fd
+  data.tar.gz: ebac8a9f6f263d7a3898f12dce5ace40980f52789fe7f6763e56d54ad9de7238b7b0b56eb16bbdbe18af13ddda4b698903c37a11946530c1d2fd4763a4265c96

data/README.md

@@ -61,6 +61,22 @@ Packs/NamespacedUnderPackageName:
   Exclude:
     - lib/example.rb
 ```
+
+## Other Utilities
+`rubocop-packs` also has some API that help you use rubocop in a pack-based context.
+
+### `RuboCop::Packs.auto_generate_rubocop_todo(packs: ParsePackwerk.all)`
+This API will auto-generate a `packs/some_pack/.rubocop_todo.yml`. This allows a pack to own its own exception list. Note that you need to configure `rubocop-packs` with an allow list of cops that can live in per-pack `.rubocop_todo.yml` files:
+```
+# `config/rubocop_packs.rb`
+RuboCop::Packs.configure do |config|
+  # For example:
+  config.permitted_pack_level_cops = ['Packs/NamespaceConvention']
+end
+```
+
+There is a supporting validation to ensure these `packs/*/.rubocop_todo.yml` files only add exceptions to the allow listed set of rules. Run this validation with `RuboCop::packs.validate`, which returns an array of errors.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/rubyatscale/rubocop-packs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Code Of Conduct](CODE_OF_CONDUCT.MD).

data/config/default.yml

@@ -1,3 +1,5 @@
+inherit_from: ./pack_config.yml
+
 Packs/ClassMethodsAsPublicApis:
   Enabled: true
   AcceptableParentClasses:

data/config/pack_config.yml

@@ -0,0 +1,6 @@
+# Relevant documentation:
+#  - Inheriting config from a gem:
+#    - https://docs.rubocop.org/rubocop/configuration.html#inheriting-configuration-from-a-dependency-gem
+#  - ERB in a .rubocop.yml file
+#    - https://docs.rubocop.org/rubocop/configuration.html#pre-processing
+<%= RuboCop::Packs.pack_based_rubocop_todos %>

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

@@ -0,0 +1,25 @@
+# typed: strict
+# frozen_string_literal: true
+
+module RuboCop
+  module Packs
+    module Private
+      class Configuration
+        extend T::Sig
+
+        sig { returns(T::Array[String]) }
+        attr_accessor :permitted_pack_level_cops
+
+        sig { void }
+        def initialize
+          @permitted_pack_level_cops = T.let([], T::Array[String])
+        end
+
+        sig { void }
+        def bust_cache!
+          @permitted_pack_level_cops = []
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/packs/private.rb

@@ -1,9 +1,39 @@
 # typed: strict
 # frozen_string_literal: true
 
+require 'rubocop/packs/private/configuration'
+
 module RuboCop
   module Packs
     module Private
+      extend T::Sig
+
+      sig { void }
+      def self.bust_cache!
+        @rubocop_todo_ymls = nil
+        @loaded_client_configuration = nil
+      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/rubocop_packs.rb')
+        require client_configuration.to_s if client_configuration.exist?
+      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
     end
 
     private_constant :Private

data/lib/rubocop/packs.rb

@@ -14,5 +14,155 @@ module RuboCop
     CONFIG         = T.let(YAML.safe_load(CONFIG_DEFAULT.read).freeze, T.untyped)
 
     private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
+
+    #
+    # 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.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)
+
+          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))
+        rubocop_todo_yml = pack.directory.join('.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
+        end
+
+        next if rubocop_todo.empty?
+
+        rubocop_todo_yml.write(YAML.dump(rubocop_todo))
+      end
+    end
+
+    sig { params(root_pathname: String).returns(String) }
+    # It would be great if rubocop (upstream) could take in a glob for `inherit_from`, which
+    # would allow us to delete this method and this additional complexity.
+    def self.pack_based_rubocop_todos(root_pathname: Bundler.root)
+      rubocop_todos = {}
+      # We do this because when the ERB is evaluated Dir.pwd is at the directory containing the YML.
+      # Ideally rubocop wouldn't change the PWD before invoking this method.
+      Dir.chdir(root_pathname) do
+        ParsePackwerk.all.each do |package|
+          next if package.name == ParsePackwerk::ROOT_PACKAGE_NAME
+
+          rubocop_todo = package.directory.join('.rubocop_todo.yml')
+          next unless rubocop_todo.exist?
+
+          loaded_rubocop_todo = YAML.load_file(rubocop_todo)
+          loaded_rubocop_todo.each do |protection_key, key_config|
+            rubocop_todos[protection_key] ||= { 'Exclude' => [] }
+            rubocop_todos[protection_key]['Exclude'] += key_config['Exclude']
+          end
+        end
+      end
+
+      YAML.dump(rubocop_todos)
+    end
+
+    sig { void }
+    def self.bust_cache!
+      config.bust_cache!
+      Private.bust_cache!
+    end
+
+    sig { params(blk: T.proc.params(arg0: Private::Configuration).void).void }
+    def self.configure(&blk)
+      yield(config)
+    end
+
+    sig { returns(Private::Configuration) }
+    def self.config
+      Private.load_client_configuration
+      @config = T.let(@config, T.nilable(Private::Configuration))
+      @config ||= Private::Configuration.new
+    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|
+        next if !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 { returns(T::Array[String]) }
+    def self.validate
+      errors = []
+      ParsePackwerk.all.each do |package|
+        next if package.name == ParsePackwerk::ROOT_PACKAGE_NAME
+
+        rubocop_todo = package.directory.join('.rubocop_todo.yml')
+        next unless rubocop_todo.exist?
+
+        loaded_rubocop_todo = YAML.load_file(rubocop_todo)
+        loaded_rubocop_todo.each_key do |key|
+          if !config.permitted_pack_level_cops.include?(key)
+            errors << <<~ERROR_MESSAGE
+              #{rubocop_todo} contains invalid configuration for #{key}.
+              Please ensure the only configuration is for package protection exclusions, which are one of the following cops: #{config.permitted_pack_level_cops.inspect}"
+              For ignoring other cops, please instead modify the top-level .rubocop_todo.yml file.
+            ERROR_MESSAGE
+          elsif loaded_rubocop_todo[key].keys != ['Exclude']
+            errors << <<~ERROR_MESSAGE
+              #{rubocop_todo} contains invalid configuration for #{key}.
+              Please ensure the only configuration for #{key} is `Exclude`
+            ERROR_MESSAGE
+          else
+            loaded_rubocop_todo[key]['Exclude'].each do |filepath|
+              next unless ParsePackwerk.package_from_path(filepath).name != package.name
+
+              errors << <<~ERROR_MESSAGE
+                #{rubocop_todo} contains invalid configuration for #{key}.
+                #{filepath} does not belong to #{package.name}. Please ensure you only add exclusions
+                for files within this pack.
+              ERROR_MESSAGE
+            end
+          end
+        end
+      end
+
+      errors
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-packs
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-07 00:00:00.000000000 Z
+date: 2022-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -187,6 +187,7 @@ extra_rdoc_files: []
 files:
 - README.md
 - config/default.yml
+- config/pack_config.yml
 - lib/rubocop-packs.rb
 - lib/rubocop/cop/packs/class_methods_as_public_apis.rb
 - lib/rubocop/cop/packs/namespace_convention.rb
@@ -196,6 +197,7 @@ files:
 - lib/rubocop/packs.rb
 - lib/rubocop/packs/inject.rb
 - lib/rubocop/packs/private.rb
+- lib/rubocop/packs/private/configuration.rb
 - sorbet/config
 - sorbet/rbi/gems/activesupport@7.0.4.rbi
 - sorbet/rbi/gems/ast@2.4.2.rbi