rubocop-rspec-guide 0.2.1 → 0.4.0

data/benchmark/compare_versions.rb

@@ -0,0 +1,136 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Benchmark to compare performance before and after RSpec::Base integration
+# This shows the impact of using rubocop-rspec Language API
+
+require "benchmark"
+require "rubocop"
+
+SAMPLE_CODE = <<~RUBY
+  describe 'UserService' do
+    context 'when user is admin' do
+      let(:user) { create(:user, :admin) }
+      let(:service) { UserService.new(user) }
+
+      before { setup_admin_permissions }
+
+      it 'has admin access' do
+        expect(service.admin?).to be true
+      end
+    end
+
+    context 'when user is regular' do
+      let(:user) { create(:user) }
+      let(:service) { UserService.new(user) }
+
+      before { setup_admin_permissions }
+
+      it 'does not have admin access' do
+        expect(service.admin?).to be false
+      end
+    end
+  end
+RUBY
+
+puts "=" * 80
+puts "Performance Comparison: Before vs After RSpec::Base Integration"
+puts "=" * 80
+puts
+
+source = RuboCop::ProcessedSource.new(SAMPLE_CODE, RUBY_VERSION.to_f)
+
+config = RuboCop::Config.new(
+  {
+    "RSpec" => {
+      "Enabled" => true,
+      "Language" => {
+        "ExampleGroups" => {
+          "Regular" => %w[describe context feature example_group],
+          "Skipped" => %w[xdescribe xcontext xfeature],
+          "Focused" => %w[fdescribe fcontext ffeature]
+        },
+        "Examples" => {
+          "Regular" => %w[it specify example scenario its],
+          "Focused" => %w[fit fspecify fexample fscenario focus],
+          "Skipped" => %w[xit xspecify xexample xscenario skip],
+          "Pending" => %w[pending]
+        },
+        "Helpers" => %w[let let! let_it_be let_it_be!],
+        "Hooks" => %w[prepend_before before append_before around prepend_after after append_after],
+        "Subjects" => %w[subject subject!]
+      }
+    }
+  }
+)
+
+# Test individual matcher performance
+iterations = 10_000
+
+puts "Testing node matcher performance (#{iterations} iterations):"
+puts "-" * 80
+
+require_relative "../lib/rubocop-rspec-guide"
+
+# Initialize RSpec Language config
+RuboCop::RSpec::Language.config = config["RSpec"]["Language"]
+
+Benchmark.bm(45) do |x|
+  # Test let? matcher
+  cop = RuboCop::Cop::RSpecGuide::DuplicateLetValues.new(config)
+  let_nodes = []
+
+  source.ast.each_node(:block) do |node|
+    let_nodes << node if cop.let?(node)
+  end
+
+  x.report("let? matcher (finds #{let_nodes.size} nodes)") do
+    iterations.times do
+      source.ast.each_node(:block) do |node|
+        cop.let?(node)
+      end
+    end
+  end
+
+  # Test example_group? matcher
+  cop2 = RuboCop::Cop::RSpecGuide::MinimumBehavioralCoverage.new(config)
+  group_nodes = []
+
+  source.ast.each_node(:block) do |node|
+    group_nodes << node if cop2.example_group?(node)
+  end
+
+  x.report("example_group? matcher (finds #{group_nodes.size} nodes)") do
+    iterations.times do
+      source.ast.each_node(:block) do |node|
+        cop2.example_group?(node)
+      end
+    end
+  end
+
+  # Test hook? matcher
+  cop3 = RuboCop::Cop::RSpecGuide::DuplicateBeforeHooks.new(config)
+  hook_nodes = []
+
+  source.ast.each_node(:block) do |node|
+    hook_nodes << node if cop3.hook?(node)
+  end
+
+  x.report("hook? matcher (finds #{hook_nodes.size} nodes)") do
+    iterations.times do
+      source.ast.each_node(:block) do |node|
+        cop3.hook?(node)
+      end
+    end
+  end
+end
+
+puts
+puts "=" * 80
+puts "Summary:"
+puts "=" * 80
+puts "✅ Current implementation uses RuboCop::Cop::RSpec::Base"
+puts "✅ Leverages well-tested rubocop-rspec Language API"
+puts "✅ Supports let_it_be and let_it_be! out of the box"
+puts "✅ Consistent with rubocop-rspec ecosystem"
+puts "=" * 80

data/benchmark/cops_benchmark.rb

@@ -0,0 +1,428 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "benchmark_helper"
+
+# Benchmark all RSpecGuide cops
+puts "=" * 80
+puts "RuboCop RSpec Guide - Cops Performance Benchmark"
+puts "=" * 80
+puts ""
+
+# Configure benchmark timing based on environment
+#   FULL_BENCHMARK=1 - Full mode: longer warmup/measurement for accuracy (~5 minutes)
+#   Default - Quick mode: shorter warmup/measurement for fast feedback (~1 minute)
+if ENV["FULL_BENCHMARK"]
+  WARMUP_TIME = 2
+  MEASUREMENT_TIME = 5
+  puts "Mode: FULL (accurate measurements, ~5 minutes)"
+else
+  WARMUP_TIME = 1
+  MEASUREMENT_TIME = 2
+  puts "Mode: QUICK (fast feedback, ~1 minute)"
+  puts "Tip: Use FULL_BENCHMARK=1 for more accurate measurements"
+end
+puts ""
+
+# Benchmark MinimumBehavioralCoverage
+Benchmark.ips do |x|
+  x.config(time: MEASUREMENT_TIME, warmup: WARMUP_TIME)
+
+  source_with_violation = <<~RUBY
+    RSpec.describe User do
+      context "when user is valid" do
+        it "saves successfully" do
+          expect(user.save).to be true
+        end
+      end
+    end
+  RUBY
+
+  source_without_violation = <<~RUBY
+    RSpec.describe User do
+      context "when user is valid" do
+        it "saves successfully" do
+          expect(user.save).to be true
+        end
+      end
+
+      context "when user is invalid" do
+        it "does not save" do
+          expect(user.save).to be false
+        end
+      end
+    end
+  RUBY
+
+  x.report("MinimumBehavioralCoverage (with violation)") do
+    BenchmarkHelper.run_cop(
+      RuboCop::Cop::RSpecGuide::MinimumBehavioralCoverage,
+      source_with_violation
+    )
+  end
+
+  x.report("MinimumBehavioralCoverage (without violation)") do
+    BenchmarkHelper.run_cop(
+      RuboCop::Cop::RSpecGuide::MinimumBehavioralCoverage,
+      source_without_violation
+    )
+  end
+
+  x.compare!
+end
+
+puts "\n"
+
+# Benchmark HappyPathFirst
+Benchmark.ips do |x|
+  x.config(time: MEASUREMENT_TIME, warmup: WARMUP_TIME)
+
+  source_with_violation = <<~RUBY
+    RSpec.describe User do
+      context "when email is invalid" do
+        it "returns error" do
+          expect(user.valid?).to be false
+        end
+      end
+
+      context "when email is valid" do
+        it "is valid" do
+          expect(user.valid?).to be true
+        end
+      end
+    end
+  RUBY
+
+  source_without_violation = <<~RUBY
+    RSpec.describe User do
+      context "when email is valid" do
+        it "is valid" do
+          expect(user.valid?).to be true
+        end
+      end
+
+      context "when email is invalid" do
+        it "returns error" do
+          expect(user.valid?).to be false
+        end
+      end
+    end
+  RUBY
+
+  x.report("HappyPathFirst (with violation)") do
+    BenchmarkHelper.run_cop(
+      RuboCop::Cop::RSpecGuide::HappyPathFirst,
+      source_with_violation
+    )
+  end
+
+  x.report("HappyPathFirst (without violation)") do
+    BenchmarkHelper.run_cop(
+      RuboCop::Cop::RSpecGuide::HappyPathFirst,
+      source_without_violation
+    )
+  end
+
+  x.compare!
+end
+
+puts "\n"
+
+# Benchmark ContextSetup
+Benchmark.ips do |x|
+  x.config(time: MEASUREMENT_TIME, warmup: WARMUP_TIME)
+
+  source_with_violation = <<~RUBY
+    RSpec.describe User do
+      context "when user is admin" do
+        it "has admin privileges" do
+          user = create(:user, :admin)
+          expect(user.admin?).to be true
+        end
+      end
+    end
+  RUBY
+
+  source_without_violation = <<~RUBY
+    RSpec.describe User do
+      context "when user is admin" do
+        let(:user) { create(:user, :admin) }
+
+        it "has admin privileges" do
+          expect(user.admin?).to be true
+        end
+      end
+    end
+  RUBY
+
+  x.report("ContextSetup (with violation)") do
+    BenchmarkHelper.run_cop(
+      RuboCop::Cop::RSpecGuide::ContextSetup,
+      source_with_violation
+    )
+  end
+
+  x.report("ContextSetup (without violation)") do
+    BenchmarkHelper.run_cop(
+      RuboCop::Cop::RSpecGuide::ContextSetup,
+      source_without_violation
+    )
+  end
+
+  x.compare!
+end
+
+puts "\n"
+
+# Benchmark DuplicateLetValues
+Benchmark.ips do |x|
+  x.config(time: MEASUREMENT_TIME, warmup: WARMUP_TIME)
+
+  source_with_violation = <<~RUBY
+    RSpec.describe Calculator do
+      context "with positive numbers" do
+        let(:value) { 42 }
+
+        it "works" do
+          expect(value).to eq(42)
+        end
+      end
+
+      context "with negative numbers" do
+        let(:value) { 42 }
+
+        it "works differently" do
+          expect(value).to eq(42)
+        end
+      end
+    end
+  RUBY
+
+  source_without_violation = <<~RUBY
+    RSpec.describe Calculator do
+      let(:default_value) { 42 }
+
+      context "with positive numbers" do
+        let(:value) { default_value }
+
+        it "works" do
+          expect(value).to eq(42)
+        end
+      end
+
+      context "with negative numbers" do
+        let(:value) { -default_value }
+
+        it "works differently" do
+          expect(value).to eq(-42)
+        end
+      end
+    end
+  RUBY
+
+  x.report("DuplicateLetValues (with violation)") do
+    BenchmarkHelper.run_cop(
+      RuboCop::Cop::RSpecGuide::DuplicateLetValues,
+      source_with_violation
+    )
+  end
+
+  x.report("DuplicateLetValues (without violation)") do
+    BenchmarkHelper.run_cop(
+      RuboCop::Cop::RSpecGuide::DuplicateLetValues,
+      source_without_violation
+    )
+  end
+
+  x.compare!
+end
+
+puts "\n"
+
+# Benchmark DuplicateBeforeHooks
+Benchmark.ips do |x|
+  x.config(time: MEASUREMENT_TIME, warmup: WARMUP_TIME)
+
+  source_with_violation = <<~RUBY
+    RSpec.describe Service do
+      context "with feature enabled" do
+        before do
+          setup_database
+        end
+
+        it "works" do
+          expect(service.call).to be_success
+        end
+      end
+
+      context "with feature disabled" do
+        before do
+          setup_database
+        end
+
+        it "still works" do
+          expect(service.call).to be_success
+        end
+      end
+    end
+  RUBY
+
+  source_without_violation = <<~RUBY
+    RSpec.describe Service do
+      before do
+        setup_database
+      end
+
+      context "with feature enabled" do
+        it "works" do
+          expect(service.call).to be_success
+        end
+      end
+
+      context "with feature disabled" do
+        it "still works" do
+          expect(service.call).to be_success
+        end
+      end
+    end
+  RUBY
+
+  x.report("DuplicateBeforeHooks (with violation)") do
+    BenchmarkHelper.run_cop(
+      RuboCop::Cop::RSpecGuide::DuplicateBeforeHooks,
+      source_with_violation
+    )
+  end
+
+  x.report("DuplicateBeforeHooks (without violation)") do
+    BenchmarkHelper.run_cop(
+      RuboCop::Cop::RSpecGuide::DuplicateBeforeHooks,
+      source_without_violation
+    )
+  end
+
+  x.compare!
+end
+
+puts "\n"
+
+# Benchmark InvariantExamples
+Benchmark.ips do |x|
+  x.config(time: MEASUREMENT_TIME, warmup: WARMUP_TIME)
+
+  source_with_violation = <<~RUBY
+    RSpec.describe Calculator do
+      context "with integers" do
+        it "adds numbers" do
+          expect(calculator.add(1, 2)).to eq(3)
+        end
+
+        it "returns numeric result" do
+          expect(calculator.add(1, 2)).to be_a(Numeric)
+        end
+      end
+
+      context "with floats" do
+        it "adds numbers" do
+          expect(calculator.add(1.5, 2.5)).to eq(4.0)
+        end
+
+        it "returns numeric result" do
+          expect(calculator.add(1.5, 2.5)).to be_a(Numeric)
+        end
+      end
+    end
+  RUBY
+
+  source_without_violation = <<~RUBY
+    RSpec.describe Calculator do
+      shared_examples "returns numeric result" do
+        it "returns numeric result" do
+          expect(result).to be_a(Numeric)
+        end
+      end
+
+      context "with integers" do
+        let(:result) { calculator.add(1, 2) }
+
+        it "adds numbers" do
+          expect(result).to eq(3)
+        end
+
+        include_examples "returns numeric result"
+      end
+
+      context "with floats" do
+        let(:result) { calculator.add(1.5, 2.5) }
+
+        it "adds numbers" do
+          expect(result).to eq(4.0)
+        end
+
+        include_examples "returns numeric result"
+      end
+    end
+  RUBY
+
+  x.report("InvariantExamples (with violation)") do
+    BenchmarkHelper.run_cop(
+      RuboCop::Cop::RSpecGuide::InvariantExamples,
+      source_with_violation
+    )
+  end
+
+  x.report("InvariantExamples (without violation)") do
+    BenchmarkHelper.run_cop(
+      RuboCop::Cop::RSpecGuide::InvariantExamples,
+      source_without_violation
+    )
+  end
+
+  x.compare!
+end
+
+puts "\n"
+
+# Benchmark DynamicAttributeEvaluation
+Benchmark.ips do |x|
+  x.config(time: MEASUREMENT_TIME, warmup: WARMUP_TIME)
+
+  source_with_violation = <<~RUBY
+    FactoryBot.define do
+      factory :user do
+        created_at { Time.current }
+        random_number { rand(1..100) }
+      end
+    end
+  RUBY
+
+  source_without_violation = <<~RUBY
+    FactoryBot.define do
+      factory :user do
+        created_at { -> { Time.current } }
+        random_number { -> { rand(1..100) } }
+      end
+    end
+  RUBY
+
+  x.report("DynamicAttributeEvaluation (with violation)") do
+    BenchmarkHelper.run_cop(
+      RuboCop::Cop::FactoryBotGuide::DynamicAttributeEvaluation,
+      source_with_violation
+    )
+  end
+
+  x.report("DynamicAttributeEvaluation (without violation)") do
+    BenchmarkHelper.run_cop(
+      RuboCop::Cop::FactoryBotGuide::DynamicAttributeEvaluation,
+      source_without_violation
+    )
+  end
+
+  x.compare!
+end
+
+puts "\n"
+puts "=" * 80
+puts "Benchmark completed!"
+puts "=" * 80

data/benchmark/cops_performance.rb

@@ -0,0 +1,109 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "benchmark"
+require "rubocop"
+require_relative "../lib/rubocop-rspec-guide"
+
+# Sample RSpec code for benchmarking
+SAMPLE_CODE = <<~RUBY
+  describe 'UserService' do
+    context 'when user is admin' do
+      let(:user) { create(:user, :admin) }
+      let(:service) { UserService.new(user) }
+
+      before { setup_admin_permissions }
+
+      it 'has admin access' do
+        expect(service.admin?).to be true
+      end
+
+      it 'can modify settings' do
+        expect(service.can_modify_settings?).to be true
+      end
+    end
+
+    context 'when user is regular' do
+      let(:user) { create(:user) }
+      let(:service) { UserService.new(user) }
+
+      before { setup_admin_permissions }
+
+      it 'does not have admin access' do
+        expect(service.admin?).to be false
+      end
+
+      it 'cannot modify settings' do
+        expect(service.can_modify_settings?).to be false
+      end
+    end
+  end
+RUBY
+
+puts "=" * 80
+puts "RuboCop RSpec Cops Performance Benchmark"
+puts "=" * 80
+puts "Sample code: #{SAMPLE_CODE.lines.count} lines"
+puts "Ruby version: #{RUBY_VERSION}"
+puts "RuboCop version: #{RuboCop::Version.version}"
+puts "=" * 80
+puts
+
+# Parse the code once
+source = RuboCop::ProcessedSource.new(SAMPLE_CODE, RUBY_VERSION.to_f)
+
+# Create config
+config = RuboCop::Config.new(
+  {
+    "RSpec" => {
+      "Enabled" => true,
+      "Language" => {
+        "ExampleGroups" => {
+          "Regular" => %w[describe context]
+        },
+        "Examples" => {
+          "Regular" => %w[it]
+        },
+        "Helpers" => %w[let let!],
+        "Hooks" => %w[before after],
+        "Subjects" => %w[subject]
+      }
+    }
+  }
+)
+
+cops = [
+  RuboCop::Cop::RSpecGuide::MinimumBehavioralCoverage,
+  RuboCop::Cop::RSpecGuide::HappyPathFirst,
+  RuboCop::Cop::RSpecGuide::ContextSetup,
+  RuboCop::Cop::RSpecGuide::DuplicateLetValues,
+  RuboCop::Cop::RSpecGuide::DuplicateBeforeHooks,
+  RuboCop::Cop::RSpecGuide::InvariantExamples
+]
+
+iterations = 1000
+
+Benchmark.bm(40) do |x|
+  cops.each do |cop_class|
+    x.report(cop_class.badge.to_s) do
+      iterations.times do
+        cop = cop_class.new(config)
+        commissioner = RuboCop::Cop::Commissioner.new([cop], [], raise_error: false)
+        commissioner.investigate(source)
+      end
+    end
+  end
+
+  x.report("All 6 cops together") do
+    iterations.times do
+      cop_instances = cops.map { |c| c.new(config) }
+      commissioner = RuboCop::Cop::Commissioner.new(cop_instances, [], raise_error: false)
+      commissioner.investigate(source)
+    end
+  end
+end
+
+puts
+puts "=" * 80
+puts "Benchmark complete! (#{iterations} iterations per cop)"
+puts "=" * 80