rubocop-packs 0.0.39 → 0.0.41

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d88f485f918ad13a51e6b07c7d2777b3d6ea1f841bd8c5d00a745b0ef1021e44
-  data.tar.gz: 003f98900ab977a97c55860ca4c8dfc024818a249afdfc43c76aecf17383e639
+  metadata.gz: cbc3a1521c8e2f461543c85b73db1ff0dbe3e70b20a2c4903a224b2f4f8daa7e
+  data.tar.gz: bb5f0503a0fe53fdb20eaaeeb64092916a19338e0d4755ebb2bafe1ef997fe41
 SHA512:
-  metadata.gz: 4df9a6bd0d19b1824cf6927e1fe1076b36042bde212a9859dde4912e2af5e49af53bb941e6cc190eec31483962dae009d956d9050b09f5132ee1cf809de5d5f5
-  data.tar.gz: db92154be004acb720da8ffdba1624dbbfac68a170fc7cbe214a3c5294e7c945ab9ea6308198bbf02ffd1189e823c948632ca086bd3c431b0b6875fb23576c81
+  metadata.gz: 0f53c5cd2a4b42c23c3974de5cbfec3b3b13a60f9fb04f98b6417a05a5da25957d40df9084882e0d68b0f02814139f01f00fe4f9800a7b358d01efd83ed16afb
+  data.tar.gz: b3c17fd5db8be8175aeaeed10e82c844ed5029a1ba04aca29149a44dd017d91dd7472f224a9335d4e8075674a74c7965b8f308f1e00e8d522c936a9b8d1d9ef4

data/README.md

@@ -41,9 +41,6 @@ Packs/RootNamespaceIsPackName:
     - lib/example.rb
 ```
 
-## Pack-Level `package_rubocop.yml` and `package_rubocop_todo.yml` files
-See [ADVANCED_USAGE.md](ADVANCED_USAGE.md)
-
 ## 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

@@ -6,19 +6,15 @@ Packs/ClassMethodsAsPublicApis:
     - Struct
     - OpenStruct
   AcceptableMixins: []
-  FailureMode: default
 
 Packs/RootNamespaceIsPackName:
   Enabled: false
-  FailureMode: default
 
 Packs/TypedPublicApis:
   Enabled: false
-  FailureMode: default
 
 Packs/DocumentedPublicApis:
   Enabled: false
-  FailureMode: default
 
 PackwerkLite/Privacy:
   # It is recommended to use packwerk

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

@@ -7,27 +7,17 @@ module RuboCop
       class Configuration
         extend T::Sig
 
-        sig { returns(T::Array[String]) }
-        attr_accessor :permitted_pack_level_cops
-
-        sig { returns(T::Array[String]) }
-        attr_accessor :required_pack_level_cops
-
         sig { returns(T::Array[String]) }
         attr_accessor :globally_permitted_namespaces
 
         sig { void }
         def initialize
-          @permitted_pack_level_cops = T.let([], T::Array[String])
           @globally_permitted_namespaces = T.let([], T::Array[String])
-          @required_pack_level_cops = T.let([], T::Array[String])
         end
 
         sig { void }
         def bust_cache!
-          @permitted_pack_level_cops = []
           @globally_permitted_namespaces = []
-          @required_pack_level_cops = []
         end
       end
     end

data/lib/rubocop/packs/private.rb

@@ -11,7 +11,6 @@ module RuboCop
 
       sig { void }
       def self.bust_cache!
-        @rubocop_todo_ymls = nil
         @loaded_client_configuration = nil
       end
 
@@ -24,161 +23,6 @@ module RuboCop
         client_configuration = Bundler.root.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("**/#{PACK_LEVEL_RUBOCOP_TODO_YML}")
-          todo_files.map do |todo_file|
-            YAML.load_file(todo_file)
-          end
-        end
-      end
-
-      sig { params(package: ::Packs::Pack).returns(T::Array[String]) }
-      def self.validate_rubocop_todo_yml(package)
-        errors = []
-        rubocop_todo = package.relative_path.join(PACK_LEVEL_RUBOCOP_TODO_YML)
-        return errors unless rubocop_todo.exist?
-
-        loaded_rubocop_todo = YAML.load_file(rubocop_todo)
-        loaded_rubocop_todo.each_key do |key|
-          if !Packs.config.permitted_pack_level_cops.include?(key)
-            errors << <<~ERROR_MESSAGE
-              #{rubocop_todo} contains invalid configuration for #{key}.
-              Please only configure the following cops on a per-pack basis: #{Packs.config.permitted_pack_level_cops.inspect}"
-              For ignoring other cops, please instead modify the top-level #{PACK_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|
-              pack = ::Packs.for_file(filepath)
-              next unless pack && pack.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
-
-        errors
-      end
-
-      sig { params(package: ::Packs::Pack).returns(T::Array[String]) }
-      def self.validate_rubocop_yml(package)
-        errors = []
-        rubocop_yml = package.relative_path.join(PACK_LEVEL_RUBOCOP_YML)
-        return errors unless rubocop_yml.exist?
-
-        loaded_rubocop_yml = YAML.load_file(rubocop_yml)
-        missing_keys = Packs.config.required_pack_level_cops - loaded_rubocop_yml.keys
-        missing_keys.each do |key|
-          errors << <<~ERROR_MESSAGE
-            #{rubocop_yml} is missing configuration for #{key}.
-          ERROR_MESSAGE
-        end
-
-        loaded_rubocop_yml.each_key do |key|
-          if !Packs.config.permitted_pack_level_cops.include?(key)
-            errors << <<~ERROR_MESSAGE
-              #{rubocop_yml} contains invalid configuration for #{key}.
-              Please only configure the following cops on a per-pack basis: #{Packs.config.permitted_pack_level_cops.inspect}"
-              For ignoring other cops, please instead modify the top-level .rubocop.yml file.
-            ERROR_MESSAGE
-          elsif (loaded_rubocop_yml[key].keys - %w[Enabled FailureMode]).any?
-            errors << <<~ERROR_MESSAGE
-              #{rubocop_yml} contains invalid configuration for #{key}.
-              Please ensure the only configuration for #{key} is `Enabled` and `FailureMode`
-            ERROR_MESSAGE
-          end
-        end
-
-        errors
-      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 { params(package: ::Packs::Pack).returns(T::Array[String]) }
-      def self.validate_failure_mode_strict(package)
-        errors = T.let([], T::Array[String])
-
-        Packs.config.permitted_pack_level_cops.each do |cop|
-          excludes = exclude_for_rule(cop)
-
-          rubocop_yml = package.relative_path.join(PACK_LEVEL_RUBOCOP_YML)
-
-          next unless rubocop_yml.exist?
-
-          loaded_rubocop_yml = YAML.load_file(rubocop_yml)
-          next unless loaded_rubocop_yml[cop] && loaded_rubocop_yml[cop]['FailureMode'] == 'strict'
-
-          excludes_for_package = excludes.select do |exclude|
-            pack = ::Packs.for_file(exclude)
-            pack && pack.name == package.name
-          end
-          next if excludes_for_package.empty?
-
-          formatted_excludes = excludes_for_package.map { |ex| "`#{ex}`" }.join(', ')
-          errors << "#{package.name} has set `#{cop}` to `FailureMode: strict` in `packs/some_pack/#{PACK_LEVEL_RUBOCOP_YML}`, forbidding new exceptions. Please either remove #{formatted_excludes} from the top-level and pack-specific `#{PACK_LEVEL_RUBOCOP_TODO_YML}` files or remove `FailureMode: strict`."
-        end
-
-        errors
-      end
-
-      sig { params(args: T.untyped).void }
-      def self.execute_rubocop(args)
-        RuboCop::CLI.new.run(args)
-      end
-
-      sig { params(paths: T::Array[String], cop_names: T::Array[String]).returns(T::Array[Offense]) }
-      def self.offenses_for(paths:, cop_names:)
-        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 = [*paths, "--only=#{cop_arguments}", '--format=json', '--out=tmp/rubocop-output']
-        FileUtils.mkdir_p('tmp')
-        puts "Executing: bundle exec rubocop #{args.join(' ')}"
-        Private.execute_rubocop(args)
-        output = Pathname.new('tmp/rubocop-output')
-        json = JSON.parse(Pathname.new('tmp/rubocop-output').read)
-        output.delete
-        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
     end
 
     private_constant :Private

data/lib/rubocop/packs.rb

@@ -7,131 +7,11 @@ 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)
-    # that make this approach not possible. Therefore, for pack level rubocops, we name them in a way that mirrors packwerk `package_todo.yml` files
-    # for consistency and to ensure that thes are not read by rubocop except via the ERB templating mechanism.
-    PACK_LEVEL_RUBOCOP_YML = 'package_rubocop.yml'
-    PACK_LEVEL_RUBOCOP_TODO_YML = 'package_rubocop_todo.yml'
-
     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)
 
     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[::Packs::Pack], files: T::Array[String]).void }
-    def self.regenerate_todo(packs: [], files: [])
-      # Delete the old pack-level rubocop todo files so that we can regenerate the new one from scratch
-      packs.each do |pack|
-        rubocop_todo_yml = pack.relative_path.join(PACK_LEVEL_RUBOCOP_TODO_YML)
-        rubocop_todo_yml.delete if rubocop_todo_yml.exist?
-      end
-
-      paths = packs.empty? ? files : packs.map(&:name)
-
-      cop_names = config.permitted_pack_level_cops.select do |cop_name|
-        YAML.load_file('.rubocop.yml').fetch(cop_name, {})['Enabled']
-      end
-
-      offenses = Private.offenses_for(
-        paths: paths,
-        cop_names: cop_names
-      )
-
-      offenses.group_by(&:pack).each do |pack, offenses_for_pack|
-        next if pack.nil?
-        next if !pack.relative_path.join(PACK_LEVEL_RUBOCOP_YML).exist?
-
-        rubocop_todo_yml = pack.relative_path.join(PACK_LEVEL_RUBOCOP_TODO_YML)
-        if rubocop_todo_yml.exist?
-          rubocop_todo = YAML.load_file(rubocop_todo_yml)
-        else
-          rubocop_todo = {}
-        end
-
-        offenses_for_pack.group_by(&:filepath).each do |filepath, offenses_by_filepath|
-          offenses_by_filepath.map(&:cop_name).uniq.each do |cop_name|
-            rubocop_todo[cop_name] ||= { 'Exclude' => [] }
-            rubocop_todo[cop_name]['Exclude'] << filepath
-          end
-        end
-
-        next if rubocop_todo.empty?
-
-        rubocop_todo_yml.write(YAML.dump(rubocop_todo))
-      end
-    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[::Packs::Pack]).void }
-    def self.set_default_rubocop_yml(packs:)
-      packs.each do |pack|
-        rubocop_yml = pack.relative_path.join(PACK_LEVEL_RUBOCOP_YML)
-        rubocop_yml_hash = {}
-        config.required_pack_level_cops.each do |cop|
-          rubocop_yml_hash[cop] = { 'Enabled' => true }
-        end
-
-        formatted_yml = YAML.dump(rubocop_yml_hash).
-          # Find lines of the form \nCopDepartment/CopName: and add a new line before it.
-          gsub(%r{^(\w+/\w+:)}, "\n\\1").
-          # Remove the `---` header at the top of the file
-          gsub("---\n\n", '')
-
-        rubocop_yml.write(formatted_yml)
-      end
-    end
-
-    # 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.
-    sig { params(root_pathname: String).returns(String) }
-    def self.pack_based_rubocop_config(root_pathname: Bundler.root)
-      rubocop_config = {}
-      # 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
-        ::Packs.all.each do |package|
-          rubocop_todo = package.relative_path.join(PACK_LEVEL_RUBOCOP_TODO_YML)
-          if rubocop_todo.exist?
-            loaded_rubocop_todo = YAML.load_file(rubocop_todo)
-            loaded_rubocop_todo.each do |cop_name, key_config|
-              rubocop_config[cop_name] ||= {}
-              rubocop_config[cop_name]['Exclude'] ||= []
-              rubocop_config[cop_name]['Exclude'] += key_config['Exclude']
-            end
-          end
-
-          pack_rubocop = package.relative_path.join(PACK_LEVEL_RUBOCOP_YML)
-          next unless pack_rubocop.exist?
-
-          loaded_pack_rubocop = YAML.load_file(pack_rubocop)
-          loaded_pack_rubocop.each do |cop_name, key_config|
-            rubocop_config[cop_name] ||= {}
-
-            if key_config['Enabled']
-              rubocop_config[cop_name]['Include'] ||= []
-              rubocop_config[cop_name]['Include'] << package.relative_path.join('**/*').to_s
-            else
-              rubocop_config[cop_name]['Exclude'] ||= []
-              rubocop_config[cop_name]['Exclude'] << package.relative_path.join('**/*').to_s
-            end
-          end
-        end
-      end
-
-      YAML.dump(rubocop_config)
-    end
-
     sig { void }
     def self.bust_cache!
       config.bust_cache!
@@ -149,28 +29,5 @@ module RuboCop
       @config = T.let(@config, T.nilable(Private::Configuration))
       @config ||= Private::Configuration.new
     end
-
-    # We can remove this function once package_protections is fully deprecated
-    sig { params(rule: String).returns(T::Set[String]) }
-    def self.exclude_for_rule(rule)
-      Private.exclude_for_rule(rule)
-    end
-
-    #
-    # Note: when we add per-pack `.rubocop.yml` files, we'll want to add some validations here
-    # to restrict what cops are permitted to be configured in those files.
-    # We might also want further (configurable?) constraints *requiring* that the "permitted pack level cops" be specified explicitly.
-    #
-    sig { returns(T::Array[String]) }
-    def self.validate
-      errors = T.let([], T::Array[String])
-      ::Packs.all.each do |package|
-        errors += Private.validate_rubocop_todo_yml(package)
-        errors += Private.validate_rubocop_yml(package)
-        errors += Private.validate_failure_mode_strict(package)
-      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.39
+  version: 0.0.41
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-09 00:00:00.000000000 Z
+date: 2023-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -201,8 +201,6 @@ extra_rdoc_files: []
 files:
 - README.md
 - config/default.yml
-- config/erb_populated_data.yml
-- config/pack_config.yml
 - lib/rubocop-packs.rb
 - lib/rubocop/cop/packs/class_methods_as_public_apis.rb
 - lib/rubocop/cop/packs/documented_public_apis.rb

data/config/erb_populated_data.yml

@@ -1,7 +0,0 @@
-# We do this inherit *after* setting the defaults so that pack-specific rubocops can override the defaults
-# 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_config %>

data/config/pack_config.yml

@@ -1,6 +0,0 @@
-# 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
-inherit_from: ./erb_populated_data.yml