rubocop-rspec-guide 0.2.0

data/lib/rubocop/cop/rspec_guide/invariant_examples.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpecGuide
+      # Detects examples that repeat in all leaf contexts.
+      # These invariants should be extracted to shared_examples.
+      #
+      # @example
+      #   # bad
+      #   describe 'Validator' do
+      #     context 'with valid data' do
+      #       it 'responds to valid?' do
+      #         expect(subject).to respond_to(:valid?)
+      #       end
+      #     end
+      #
+      #     context 'with invalid data' do
+      #       it 'responds to valid?' do
+      #         expect(subject).to respond_to(:valid?)
+      #       end
+      #     end
+      #
+      #     context 'with empty data' do
+      #       it 'responds to valid?' do
+      #         expect(subject).to respond_to(:valid?)
+      #       end
+      #     end
+      #   end
+      #
+      #   # good
+      #   shared_examples 'a validator' do
+      #     it 'responds to valid?' do
+      #       expect(subject).to respond_to(:valid?)
+      #     end
+      #   end
+      #
+      #   describe 'Validator' do
+      #     context 'with valid data' do
+      #       it_behaves_like 'a validator'
+      #     end
+      #
+      #     context 'with invalid data' do
+      #       it_behaves_like 'a validator'
+      #     end
+      #
+      #     context 'with empty data' do
+      #       it_behaves_like 'a validator'
+      #     end
+      #   end
+      #
+      class InvariantExamples < Base
+        MSG = "Example `%<description>s` repeats in all %<count>d leaf contexts. " \
+              "Consider extracting to shared_examples as an interface invariant."
+
+        # @!method example_with_description?(node)
+        def_node_matcher :example_with_description?, <<~PATTERN
+          (block
+            (send nil? {:it :specify :example} (str $_description))
+            ...)
+        PATTERN
+
+        # @!method context_or_describe?(node)
+        def_node_matcher :context_or_describe?, <<~PATTERN
+          (block
+            (send nil? {:describe :context} ...)
+            ...)
+        PATTERN
+
+        # @!method top_level_describe?(node)
+        def_node_matcher :top_level_describe?, <<~PATTERN
+          (block
+            (send nil? :describe ...)
+            ...)
+        PATTERN
+
+        def on_block(node)
+          return unless top_level_describe?(node)
+
+          # Find all leaf contexts (contexts with no nested contexts)
+          leaf_contexts = find_leaf_contexts(node)
+
+          min_leaf_contexts = cop_config["MinLeafContexts"] || 3
+          return if leaf_contexts.size < min_leaf_contexts
+
+          # Collect example descriptions from each leaf
+          examples_by_leaf = leaf_contexts.map do |leaf|
+            collect_example_descriptions(leaf)
+          end
+
+          # Find descriptions that appear in ALL leaves
+          common_descriptions = examples_by_leaf.reduce(:&)
+          return if common_descriptions.nil? || common_descriptions.empty?
+
+          # Add offenses for all examples with common descriptions
+          leaf_contexts.each do |leaf|
+            leaf.each_descendant(:block) do |example_node|
+              example_with_description?(example_node) do |description|
+                if common_descriptions.include?(description)
+                  add_offense(
+                    example_node,
+                    message: format(MSG, description: description, count: leaf_contexts.size)
+                  )
+                end
+              end
+            end
+          end
+        end
+
+        private
+
+        def find_leaf_contexts(node)
+          leaves = []
+
+          node.each_descendant(:block) do |child|
+            next unless context_or_describe?(child)
+
+            # Check if this context has nested contexts
+            has_nested = child.each_descendant(:block).any? do |nested|
+              context_or_describe?(nested) && nested != child
+            end
+
+            leaves << child unless has_nested
+          end
+
+          leaves
+        end
+
+        def collect_example_descriptions(context_node)
+          descriptions = []
+
+          context_node.each_descendant(:block) do |child|
+            example_with_description?(child) do |description|
+              descriptions << description
+            end
+          end
+
+          descriptions.uniq
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/rspec/guide/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module RSpec
+    module Guide
+      VERSION = "0.2.0"
+    end
+  end
+end

data/lib/rubocop/rspec/guide.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "guide/version"
+
+module RuboCop
+  module RSpec
+    module Guide
+      class Error < StandardError; end
+      # Your code goes here...
+    end
+  end
+end

data/lib/rubocop-rspec-guide.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "rubocop"
+require "rubocop-rspec"
+
+require_relative "rubocop/rspec/guide/version"
+require_relative "rubocop/cop/rspec_guide/characteristics_and_contexts"
+require_relative "rubocop/cop/rspec_guide/duplicate_let_values"
+require_relative "rubocop/cop/rspec_guide/duplicate_before_hooks"
+require_relative "rubocop/cop/rspec_guide/invariant_examples"
+require_relative "rubocop/cop/rspec_guide/happy_path_first"
+require_relative "rubocop/cop/rspec_guide/context_setup"
+require_relative "rubocop/cop/factory_bot_guide/dynamic_attributes_for_time_and_random"

data/sig/rubocop/rspec/guide.rbs

@@ -0,0 +1,8 @@
+module RuboCop
+  module RSpec
+    module Guide
+      VERSION: String
+      # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+    end
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-rspec-guide
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Alexey Matskevich
+bindir: exe
+cert_chain: []
+date: 1980-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.20'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+description: A collection of custom RuboCop cops that enforce best practices from
+  the RSpec style guide, including context structure, testing patterns, and FactoryBot
+  usage.
+email:
+- github_job@mackevich.addymail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".standard.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- config/default.yml
+- devbox.json
+- devbox.lock
+- lib/rubocop-rspec-guide.rb
+- lib/rubocop/cop/factory_bot_guide/dynamic_attributes_for_time_and_random.rb
+- lib/rubocop/cop/rspec_guide/characteristics_and_contexts.rb
+- lib/rubocop/cop/rspec_guide/context_setup.rb
+- lib/rubocop/cop/rspec_guide/duplicate_before_hooks.rb
+- lib/rubocop/cop/rspec_guide/duplicate_let_values.rb
+- lib/rubocop/cop/rspec_guide/happy_path_first.rb
+- lib/rubocop/cop/rspec_guide/invariant_examples.rb
+- lib/rubocop/rspec/guide.rb
+- lib/rubocop/rspec/guide/version.rb
+- sig/rubocop/rspec/guide.rbs
+homepage: https://github.com/rspec-guide/rubocop-rspec-guide
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/rspec-guide/rubocop-rspec-guide
+  source_code_uri: https://github.com/rspec-guide/rubocop-rspec-guide
+  changelog_uri: https://github.com/rspec-guide/rubocop-rspec-guide/blob/master/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.1
+specification_version: 4
+summary: Custom RuboCop cops based on the RSpec best practices guide
+test_files: []