rubocop-rspec_parity 1.3.4 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b634068a8fe93d9576c210988a5ebab48f22f25058cf7c50e21710de1b7fb775
-  data.tar.gz: 9ac6bd2fc8503e43013e25e03413cb32dd8eb3d6ee44480f1a243f41e006781f
+  metadata.gz: 6a5de925a1a0fb2a5857e4c6b8e021abeac3fe0e7f792c536497db7468382375
+  data.tar.gz: 32c20a277a217ffa24a011ae7fa178ea81c5db9d99a74076686d56504d243043
 SHA512:
-  metadata.gz: ab0f3101fd7603ec83438f91772b6991446c9fbb2102cc32ebb948a02df1cfe8a6217e71b2629ba695135b717322d9ba6bd686bfe1a9f58fbe292ea1b70357ba
-  data.tar.gz: d30491decd3a61710bf1c873bbd268aad7d5a40e6d209b46676bf469871c54087e13a6111a47ad83437d5becb6416e5075cec6ca6a0e00a7b7657c873bb44ce2
+  metadata.gz: 177de764d463e227cf080453bec0d526a339f8c86dc10cb75a86a6d03b7bc49cfb5a69837949285b9e5e9d016e355b1eb0b4b72e5e8beb80b3fef07bd98fd5dd
+  data.tar.gz: d3dd4830f5c4640f2af0fa407552b0c81bd0fac8d5a933498eebd4b6c4536138cf06f92a903024de08977dadb55ebcd4b530e4e7bdaa0108bb6cfa380e12fc05

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [1.4.0] - 2026-03-03
+
+Added: `FileHasSpec` cop that checks each app file has a corresponding spec file
+Added: Department-level shared configuration (`SpecFilePathMappings`, `DescribeAliases`, `SkipMethodDescribeFor`) for all RSpecParity cops
+
+## [1.3.5] - 2026-03-02
+
+Fixed: `PublicMethodHasSpec` now correctly recognizes `private` declarations inside `included do`, `class_eval do`, and `module_eval do` blocks as visibility scopes
+
 ## [1.3.4] - 2026-02-23
 
 Added: `PublicMethodHasSpec` now treats methods inside `class_methods do` blocks (ActiveSupport::Concern) as class methods, expecting `.method_name` in specs

data/config/default.yml

@@ -1,5 +1,13 @@
 # Default configuration for rubocop-rspec_parity
 
+# Department-level shared configuration for all RSpecParity cops.
+# Cop-level settings override these when explicitly set per-cop.
+RSpecParity:
+  SpecFilePathMappings:
+    'app/': ['spec/']
+  DescribeAliases: {}
+  SkipMethodDescribeFor: []
+
 RSpecParity/FileHasSpec:
   Description: 'Checks that each Ruby file in the app directory has a corresponding spec file.'
   Enabled: true
@@ -13,8 +21,6 @@ RSpecParity/FileHasSpec:
 RSpecParity/PublicMethodHasSpec:
   Description: 'Checks that each public method has a corresponding spec test.'
   Enabled: true
-  SkipMethodDescribeFor: []
-  DescribeAliases: {}
   Include:
     - 'app/**/*.rb'
   Exclude:
@@ -26,8 +32,6 @@ RSpecParity/SufficientContexts:
   Description: 'Ensures specs have at least as many contexts as the method has branches.'
   Enabled: true
   IgnoreMemoization: true
-  SkipMethodDescribeFor: []
-  DescribeAliases: {}
   Include:
     - 'app/**/*.rb'
   Exclude:

data/lib/rubocop/cop/rspec_parity/department_config.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpecParity
+      # Shared module for reading department-level configuration.
+      # Provides config resolution (cop-level > department-level > default),
+      # spec file path mappings, and shared describe aliases / skip paths.
+      module DepartmentConfig
+        private
+
+        def department_config
+          @department_config ||= config["RSpecParity"] || {}
+        end
+
+        def spec_file_path_mappings
+          resolve_config("SpecFilePathMappings", { "app/" => ["spec/"] })
+        end
+
+        def shared_describe_aliases
+          resolve_config("DescribeAliases", {})
+        end
+
+        def shared_skip_method_describe_paths
+          resolve_config("SkipMethodDescribeFor", [])
+        end
+
+        def expected_spec_paths(source_path = nil) # rubocop:disable Metrics/MethodLength
+          source_path ||= processed_source.file_path
+          return [] unless source_path
+
+          paths = []
+          spec_file_path_mappings.each do |source_dir, spec_dirs|
+            next unless path_matches_mapping?(source_path, source_dir)
+
+            Array(spec_dirs).each do |spec_dir|
+              spec_path = substitute_path(source_path, source_dir, spec_dir)
+              paths << spec_path if spec_path
+            end
+          end
+          paths.uniq
+        end
+
+        def matches_any_mapping?(source_path)
+          spec_file_path_mappings.any? do |source_dir, _|
+            path_matches_mapping?(source_path, source_dir)
+          end
+        end
+
+        def relative_spec_path(spec_path)
+          source_path = processed_source.file_path
+          return spec_path unless source_path
+
+          root = find_project_root(source_path)
+          root ? spec_path.sub("#{root}/", "") : spec_path
+        end
+
+        def resolve_config(key, default)
+          if cop_config.key?(key)
+            cop_config[key]
+          elsif department_config.key?(key)
+            department_config[key]
+          else
+            default
+          end
+        end
+
+        def path_matches_mapping?(source_path, source_dir)
+          source_path.include?("/#{source_dir}") || source_path.start_with?(source_dir)
+        end
+
+        def substitute_path(source_path, source_dir, spec_dir)
+          result = if source_path.include?("/#{source_dir}")
+                     source_path.sub("/#{source_dir}", "/#{spec_dir}")
+                   elsif source_path.start_with?(source_dir)
+                     source_path.sub(source_dir, spec_dir)
+                   end
+          result&.sub(/\.rb$/, "_spec.rb")
+        end
+
+        def find_project_root(source_path)
+          spec_file_path_mappings.each_key do |source_dir|
+            first_dir = source_dir.split("/").first
+            parts = source_path.split("/")
+            dir_index = parts.index(first_dir)
+            next unless dir_index&.positive?
+
+            return parts[0...dir_index].join("/")
+          end
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rspec_parity/file_has_spec.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpecParity
+      # Checks that each Ruby file in the app directory has a corresponding spec file.
+      #
+      # @example
+      #   # bad - app/models/user.rb exists but spec/models/user_spec.rb does not
+      #
+      #   # good - app/models/user.rb has a matching spec/models/user_spec.rb
+      #
+      class FileHasSpec < Base
+        include DepartmentConfig
+
+        MSG = "Missing spec file. Expected %<spec_path>s to exist"
+
+        def on_new_investigation
+          return unless should_check_file?
+
+          spec_paths = expected_spec_paths
+          return if spec_paths.empty?
+          return if spec_paths.any? { |path| File.exist?(path) }
+
+          add_offense(
+            processed_source.ast || processed_source.tokens.first,
+            message: format(MSG, spec_path: relative_spec_path(spec_paths.first))
+          )
+        end
+
+        private
+
+        def should_check_file?
+          path = processed_source.file_path
+          return false unless path && !path.end_with?("_spec.rb")
+
+          matches_any_mapping?(path)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rspec_parity/public_method_has_spec.rb

@@ -13,6 +13,7 @@ module RuboCop
       #   # good - public method `perform` has describe '#perform' in spec
       #
       class PublicMethodHasSpec < Base # rubocop:disable Metrics/ClassLength
+        include DepartmentConfig
         include SpecFileFinder
 
         MSG = "Missing spec for public method `%<method_name>s`. " \
@@ -24,12 +25,6 @@ module RuboCop
         EXCLUDED_PATTERNS = [/^before_/, /^after_/, /^around_/, /^validate_/, /^autosave_/].freeze
         VISIBILITY_METHODS = { private: :private, protected: :protected, public: :public }.freeze
 
-        def initialize(config = nil, options = nil)
-          super
-          @skip_method_describe_paths = cop_config.fetch("SkipMethodDescribeFor", [])
-          @describe_aliases = cop_config.fetch("DescribeAliases", {})
-        end
-
         def on_def(node)
           return unless checkable_method?(node) && public_method?(node)
           return if inside_inner_class?(node)
@@ -134,7 +129,8 @@ module RuboCop
 
         def find_enclosing_scope(node)
           node.each_ancestor.find do |n|
-            n.class_type? || n.module_type? || n.sclass_type? || class_methods_block?(n)
+            n.class_type? || n.module_type? || n.sclass_type? || class_methods_block?(n) || included_block?(n) ||
+              eval_block?(n)
           end
         end
 
@@ -142,6 +138,14 @@ module RuboCop
           node.block_type? && node.send_node.method_name == :class_methods
         end
 
+        def included_block?(node)
+          node.block_type? && node.send_node.method_name == :included
+        end
+
+        def eval_block?(node)
+          node.block_type? && %i[class_eval module_eval].include?(node.send_node.method_name)
+        end
+
         def find_class_or_module(node)
           node.each_ancestor.find { |n| n.class_type? || n.module_type? }
         end
@@ -198,8 +202,7 @@ module RuboCop
           class_name = extract_class_name(node)
           return unless class_name
 
-          base_spec_path = expected_spec_path
-          spec_paths = find_valid_spec_files(class_name, base_spec_path)
+          spec_paths = find_valid_spec_files(class_name, expected_spec_paths)
           return if spec_paths.empty?
 
           method_name = node.method_name.to_s
@@ -263,30 +266,14 @@ module RuboCop
           ]
         end
 
-        def expected_spec_path
-          processed_source.file_path&.sub("/app/", "/spec/")&.sub(/\.rb$/, "_spec.rb")
-        end
-
-        def relative_spec_path(spec_path)
-          root = find_project_root
-          root ? spec_path.sub("#{root}/", "") : spec_path
-        end
-
-        def find_project_root
-          path = processed_source.file_path
-          return nil if path.nil?
-
-          app_index = path.split("/").index("app")
-          app_index ? path.split("/")[0...app_index].join("/") : nil
-        end
-
         def matches_skip_path?
-          return false if @skip_method_describe_paths.empty?
+          skip_paths = shared_skip_method_describe_paths
+          return false if skip_paths.empty?
 
           file_path = processed_source.file_path
           return false unless file_path
 
-          @skip_method_describe_paths.any? do |pattern|
+          skip_paths.any? do |pattern|
             # Match against both absolute path and relative path
             File.fnmatch?(pattern, file_path, File::FNM_PATHNAME | File::FNM_EXTGLOB) ||
               File.fnmatch?(pattern, extract_relative_path(file_path), File::FNM_PATHNAME | File::FNM_EXTGLOB)

data/lib/rubocop/cop/rspec_parity/spec_file_finder.rb

@@ -46,22 +46,24 @@ module RuboCop
           filename.split("_").map(&:capitalize).join
         end
 
-        def find_valid_spec_files(class_name, base_spec_path)
-          return [] unless base_spec_path
+        def find_valid_spec_files(class_name, base_spec_paths) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+          base_spec_paths = Array(base_spec_paths)
+          return [] if base_spec_paths.empty?
 
           valid_files = []
 
-          # Always include the base spec file if it exists (maintains original behavior)
-          valid_files << base_spec_path if File.exist?(base_spec_path)
+          base_spec_paths.each do |base_spec_path|
+            next unless base_spec_path
 
-          # Also check for wildcard spec files (e.g., user_updates_spec.rb)
-          # But only include them if they describe the correct class
-          spec_dir = File.dirname(base_spec_path)
-          base_name = File.basename(base_spec_path, "_spec.rb")
-          wildcard_files = Dir.glob(File.join(spec_dir, "#{base_name}_*_spec.rb"))
+            valid_files << base_spec_path if File.exist?(base_spec_path)
 
-          wildcard_files.each do |file|
-            valid_files << file if File.exist?(file) && spec_describes_class?(file, class_name)
+            spec_dir = File.dirname(base_spec_path)
+            base_name = File.basename(base_spec_path, "_spec.rb")
+            wildcard_files = Dir.glob(File.join(spec_dir, "#{base_name}_*_spec.rb"))
+
+            wildcard_files.each do |file|
+              valid_files << file if File.exist?(file) && spec_describes_class?(file, class_name)
+            end
           end
 
           valid_files.uniq
@@ -82,7 +84,7 @@ module RuboCop
         end
 
         def describe_aliases_for(describe_key)
-          value = @describe_aliases[describe_key]
+          value = shared_describe_aliases[describe_key]
           return [] unless value
 
           Array(value).map(&:to_s)

data/lib/rubocop/cop/rspec_parity/sufficient_contexts.rb

@@ -38,6 +38,7 @@ module RuboCop
       #   context 'when creating a regular user' do
       #   end
       class SufficientContexts < Base # rubocop:disable Metrics/ClassLength
+        include DepartmentConfig
         include SpecFileFinder
 
         MSG = "Method `%<method_name>s` has %<branches>d %<branch_word>s but only %<contexts>d %<context_word>s " \
@@ -65,8 +66,6 @@ module RuboCop
         def initialize(config = nil, options = nil)
           super
           @ignore_memoization = cop_config.fetch("IgnoreMemoization", true)
-          @skip_method_describe_paths = cop_config.fetch("SkipMethodDescribeFor", [])
-          @describe_aliases = cop_config.fetch("DescribeAliases", {})
         end
 
         def on_def(node)
@@ -89,8 +88,7 @@ module RuboCop
           class_name = extract_class_name(node)
           return unless class_name
 
-          base_spec_path = spec_file_path
-          spec_files = find_valid_spec_files(class_name, base_spec_path)
+          spec_files = find_valid_spec_files(class_name, expected_spec_paths)
           return if spec_files.empty?
 
           # Aggregate contexts from all valid spec files
@@ -143,12 +141,6 @@ module RuboCop
           processed_source.path
         end
 
-        def spec_file_path
-          path = processed_source.path
-          # Handle both absolute and relative paths
-          path.sub(%r{/app/}, "/spec/").sub(%r{^app/}, "spec/").sub(/\.rb$/, "_spec.rb")
-        end
-
         def count_branches(node)
           branches = 0
           elsif_nodes = collect_elsif_nodes(node)
@@ -372,12 +364,13 @@ module RuboCop
         end
 
         def matches_skip_path?
-          return false if @skip_method_describe_paths.empty?
+          skip_paths = shared_skip_method_describe_paths
+          return false if skip_paths.empty?
 
           path = processed_source.path
           return false unless path
 
-          @skip_method_describe_paths.any? do |pattern|
+          skip_paths.any? do |pattern|
             File.fnmatch?(pattern, path, File::FNM_PATHNAME | File::FNM_EXTGLOB)
           end
         end

data/lib/rubocop/rspec_parity/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module RSpecParity
-    VERSION = "1.3.4"
+    VERSION = "1.4.0"
   end
 end

data/lib/rubocop_rspec_parity.rb

@@ -5,5 +5,7 @@ require "rubocop"
 require_relative "rubocop/rspec_parity"
 require_relative "rubocop/rspec_parity/version"
 require_relative "rubocop/rspec_parity/plugin"
+require_relative "rubocop/cop/rspec_parity/department_config"
+require_relative "rubocop/cop/rspec_parity/file_has_spec"
 require_relative "rubocop/cop/rspec_parity/public_method_has_spec"
 require_relative "rubocop/cop/rspec_parity/sufficient_contexts"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec_parity
 version: !ruby/object:Gem::Version
-  version: 1.3.4
+  version: 1.4.0
 platform: ruby
 authors:
 - Povilas Jurcys
@@ -54,6 +54,8 @@ files:
 - Rakefile
 - config/default.yml
 - lib/rubocop-rspec_parity.rb
+- lib/rubocop/cop/rspec_parity/department_config.rb
+- lib/rubocop/cop/rspec_parity/file_has_spec.rb
 - lib/rubocop/cop/rspec_parity/public_method_has_spec.rb
 - lib/rubocop/cop/rspec_parity/spec_file_finder.rb
 - lib/rubocop/cop/rspec_parity/sufficient_contexts.rb