rubocop-packs 0.0.13 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ae6001b8bc58c5541d1869363e9506de8e28326d449eb2eff7733391c62d9cb
-  data.tar.gz: 07557221e1ac695c3eb5e1170dd6f0b3d45d4116d579cc56aaed94ac4ffee8f4
+  metadata.gz: be0363ed2023527b2c25a80a934abac48fd8e75c5c9b8f3882e0391305f2544c
+  data.tar.gz: 3a082b0eb17b5bf25a2cbba0fbe01322b7d56598512102551c87635bbaea2df9
 SHA512:
-  metadata.gz: 1b262c2ded4ce2705f28b3d9a70b9a0a0a39864d53b198946f5b5da2de8b0dec29a1d1b9acbcf782e87f649dbc09f461d8f64ade2aa54f31f4ebfff1d3441212
-  data.tar.gz: a9f4b9085ef8de3d7a2d6ed45fd105ac54fe2bcd4d6c013c8f6178ab88318aefb0e7ba58b9f49480d02d2bafb8bf9bbd49458e36e02e6e2a79e136f90a72c10f
+  metadata.gz: 06a8046673579208dbe40a4f46b9cb11ff7360af8712736b794b0e66cfc9ec0411f9cdf837bf2acfd03c2f11cbeb82b6ff9291ca768824ffe2fc19f0d15d7e17
+  data.tar.gz: 9debb88541b7c1e9506078c4de88ca6507d6f2b3fab95226269c70265a438c15533f1fae6dfc7a13b0707a93ec269093ec3fe0561a06047c83d05ed7e635fa18

data/lib/rubocop/cop/packs/namespace_convention.rb

@@ -11,6 +11,8 @@ module RuboCop
       # Note that this cop doesn't necessarily expect you to be using stimpack (https://github.com/rubyatscale/stimpack),
       # but it does expect packs to live in the organizational structure as described in the README.md of that gem.
       #
+      # This allows packs to opt in and also prevent *other* files from sitting in their namespace.
+      #
       # @example
       #
       #   # bad
@@ -47,7 +49,7 @@ module RuboCop
 
           allowed_global_namespaces = Set.new([
                                                 namespace_context.expected_namespace,
-                                                *cop_config['GloballyPermittedNamespaces']
+                                                *RuboCop::Packs.config.globally_permitted_namespaces
                                               ])
 
           package_name = package_for_path.name
@@ -57,36 +59,18 @@ module RuboCop
           if allowed_global_namespaces.include?(actual_namespace)
             # No problem!
           else
-            package_enforces_namespaces = (cop_config['IncludePacks'] || []).include?(package_for_path.name)
             expected_namespace = namespace_context.expected_namespace
             relative_desired_path = namespace_context.expected_filepath
-            pack_owning_this_namespace = namespaces_to_packs[actual_namespace]
-
-            if package_enforces_namespaces
-              add_offense(
-                source_range(processed_source.buffer, 1, 0),
-                message: format(
-                  'Based on the filepath, this file defines `%<current_fully_qualified_constant>s`, but it should be namespaced as `%<expected_namespace>s::%<current_fully_qualified_constant>s` with path `%<expected_path>s`.',
-                  package_name: package_name,
-                  expected_namespace: expected_namespace,
-                  expected_path: relative_desired_path,
-                  current_fully_qualified_constant: current_fully_qualified_constant
-                )
+            add_offense(
+              source_range(processed_source.buffer, 1, 0),
+              message: format(
+                'Based on the filepath, this file defines `%<current_fully_qualified_constant>s`, but it should be namespaced as `%<expected_namespace>s::%<current_fully_qualified_constant>s` with path `%<expected_path>s`.',
+                package_name: package_name,
+                expected_namespace: expected_namespace,
+                expected_path: relative_desired_path,
+                current_fully_qualified_constant: current_fully_qualified_constant
               )
-            elsif pack_owning_this_namespace
-              add_offense(
-                source_range(processed_source.buffer, 1, 0),
-                message: format(
-                  'Based on the filepath, this file defines `%<current_fully_qualified_constant>s`. `%<pack_owning_this_namespace>s` prevents other packs from sitting in the `%<actual_namespace>s` namespace. This should be namespaced under `%<expected_namespace>s` with path `%<expected_path>s`.',
-                  package_name: package_name,
-                  pack_owning_this_namespace: pack_owning_this_namespace,
-                  expected_namespace: expected_namespace,
-                  actual_namespace: actual_namespace,
-                  current_fully_qualified_constant: current_fully_qualified_constant,
-                  expected_path: relative_desired_path
-                )
-              )
-            end
+            )
           end
         end
 
@@ -104,23 +88,6 @@ module RuboCop
           @desired_zeitwerk_api ||= T.let(nil, T.nilable(DesiredZeitwerkApi))
           @desired_zeitwerk_api ||= DesiredZeitwerkApi.new
         end
-
-        sig { returns(T::Hash[String, String]) }
-        def namespaces_to_packs
-          @namespaces_to_packs = T.let(nil, T.nilable(T::Hash[String, String]))
-          @namespaces_to_packs ||= begin
-            all_packs_enforcing_namespaces = ParsePackwerk.all.select do |p|
-              (cop_config['IncludePacks'] || []).include?(p.name)
-            end
-
-            namespaces_to_packs = {}
-            all_packs_enforcing_namespaces.each do |package|
-              namespaces_to_packs[desired_zeitwerk_api.get_pack_based_namespace(package)] = package.name
-            end
-
-            namespaces_to_packs
-          end
-        end
       end
     end
   end

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

@@ -10,14 +10,24 @@ module RuboCop
         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

@@ -34,6 +34,118 @@ module RuboCop
           end
         end
       end
+
+      sig { params(package: ParsePackwerk::Package).returns(T::Array[String]) }
+      def self.validate_rubocop_todo_yml(package)
+        errors = []
+        rubocop_todo = package.directory.join('.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 .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|
+              return [] 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
+
+        errors
+      end
+
+      sig { params(package: ParsePackwerk::Package).returns(T::Array[String]) }
+      def self.validate_rubocop_yml(package)
+        errors = []
+        rubocop_yml = package.directory.join('.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: ParsePackwerk::Package).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.directory.join('.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|
+            ParsePackwerk.package_from_path(exclude).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/.rubocop.yml`, forbidding new exceptions. Please either remove #{formatted_excludes} from the top-level and pack-specific `.rubocop_todo.yml` files or remove `FailureMode: strict`."
+        end
+
+        errors
+      end
     end
 
     private_constant :Private

data/lib/rubocop/packs.rb

@@ -107,59 +107,26 @@ module RuboCop
       @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)
-      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
+      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 = []
+      errors = T.let([], T::Array[String])
       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
+        errors += Private.validate_rubocop_todo_yml(package)
+        errors += Private.validate_rubocop_yml(package)
+        errors += Private.validate_failure_mode_strict(package)
       end
 
       errors

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-packs
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.14
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-24 00:00:00.000000000 Z
+date: 2022-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -203,46 +203,6 @@ files:
 - lib/rubocop/packs/private.rb
 - lib/rubocop/packs/private/configuration.rb
 - lib/rubocop/packwerk_lite.rb
-- sorbet/config
-- sorbet/rbi/gems/activesupport@7.0.4.rbi
-- sorbet/rbi/gems/ast@2.4.2.rbi
-- sorbet/rbi/gems/coderay@1.1.3.rbi
-- sorbet/rbi/gems/concurrent-ruby@1.1.10.rbi
-- sorbet/rbi/gems/diff-lcs@1.5.0.rbi
-- sorbet/rbi/gems/i18n@1.12.0.rbi
-- sorbet/rbi/gems/json@2.6.2.rbi
-- sorbet/rbi/gems/method_source@1.0.0.rbi
-- sorbet/rbi/gems/minitest@5.16.3.rbi
-- sorbet/rbi/gems/netrc@0.11.0.rbi
-- sorbet/rbi/gems/parallel@1.22.1.rbi
-- sorbet/rbi/gems/parse_packwerk@0.12.1.rbi
-- sorbet/rbi/gems/parser@3.1.2.1.rbi
-- sorbet/rbi/gems/pry@0.14.1.rbi
-- sorbet/rbi/gems/rainbow@3.1.1.rbi
-- sorbet/rbi/gems/rake@13.0.6.rbi
-- sorbet/rbi/gems/rbi@0.0.16.rbi
-- sorbet/rbi/gems/regexp_parser@2.6.0.rbi
-- sorbet/rbi/gems/rexml@3.2.5.rbi
-- sorbet/rbi/gems/rspec-core@3.11.0.rbi
-- sorbet/rbi/gems/rspec-expectations@3.11.1.rbi
-- sorbet/rbi/gems/rspec-mocks@3.11.1.rbi
-- sorbet/rbi/gems/rspec-support@3.11.1.rbi
-- sorbet/rbi/gems/rspec@3.11.0.rbi
-- sorbet/rbi/gems/rubocop-ast@1.21.0.rbi
-- sorbet/rbi/gems/rubocop-extension-generator@0.5.1.rbi
-- sorbet/rbi/gems/rubocop-sorbet@0.6.11.rbi
-- sorbet/rbi/gems/rubocop@1.36.0.rbi
-- sorbet/rbi/gems/ruby-progressbar@1.11.0.rbi
-- sorbet/rbi/gems/spoom@1.1.12.rbi
-- sorbet/rbi/gems/tapioca@0.10.2.rbi
-- sorbet/rbi/gems/thor@1.2.1.rbi
-- sorbet/rbi/gems/tzinfo@2.0.5.rbi
-- sorbet/rbi/gems/unicode-display_width@2.3.0.rbi
-- sorbet/rbi/gems/unparser@0.6.5.rbi
-- sorbet/rbi/gems/webrick@1.7.0.rbi
-- sorbet/rbi/gems/yard-sorbet@0.7.0.rbi
-- sorbet/rbi/gems/yard@0.9.28.rbi
-- sorbet/rbi/todo.rbi
 homepage: https://github.com/rubyatscale/rubocop-packs
 licenses:
 - MIT

data/sorbet/config

@@ -1,3 +0,0 @@
---dir
-.
---ignore=/vendor/bundle