Feature/Mock core (#2)

bestwebua · web-flow · commit 41c801472a80 · 2024-11-04T11:59:01.000+01:00
* Implemented mock core
* Added integration tests
* Updated circleci/codeclimate configs
* Updated project documentation
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -112,20 +112,20 @@ jobs:
             ./cc-test-reporter before-build
             bundle exec rspec
 
-      # - run:
-      #     name: Creating CodeClimate test coverage report
-      #     command: |
-      #       ./cc-test-reporter format-coverage -t simplecov -o "coverage/codeclimate.$CIRCLE_NODE_INDEX.json"
+      - run:
+          name: Creating CodeClimate test coverage report
+          command: |
+            ./cc-test-reporter format-coverage -t simplecov -o "coverage/codeclimate.$CIRCLE_NODE_INDEX.json"
 
       - store_artifacts:
           name: Saving Simplecov coverage artifacts
           path: ~/ruby-rspec-mock/coverage
           destination: coverage
 
-      # - deploy:
-      #     name: Uploading CodeClimate test coverage report
-      #     command: |
-      #       ./cc-test-reporter sum-coverage --output - --parts $CIRCLE_NODE_TOTAL coverage/codeclimate.*.json | ./cc-test-reporter upload-coverage --debug --input -
+      - deploy:
+          name: Uploading CodeClimate test coverage report
+          command: |
+            ./cc-test-reporter sum-coverage --output - --parts $CIRCLE_NODE_TOTAL coverage/codeclimate.*.json | ./cc-test-reporter upload-coverage --debug --input -
 
   compatibility-ruby:
     parameters:
diff --git a/.codeclimate.yml b/.codeclimate.yml
@@ -9,7 +9,7 @@ checks:
 plugins:
   rubocop:
     enabled: true
-    channel: rubocop-1-65
+    channel: rubocop-1-66
     config:
       file: .circleci/linter_configs/.rubocop.yml
 
diff --git a/.reek.yml b/.reek.yml
@@ -3,3 +3,12 @@
 detectors:
   IrresponsibleModule:
     enabled: false
+
+  BooleanParameter:
+    exclude:
+      - RSpec::Mock::Context#respond_to_missing?
+
+  ManualDispatch:
+    exclude:
+      - RSpec::Mock::Context#method_missing
+      - RSpec::Mock::Context#respond_to_missing?
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # Seamless migration from third-party mocks to RSpec built-in mocking framework
 
-[![Maintainability](https://api.codeclimate.com/v1/badges/5ea9da61ef468b8ad4c4/maintainability)](https://codeclimate.com/github/mocktools/ruby-rspec-mock/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/5ea9da61ef468b8ad4c4/test_coverage)](https://codeclimate.com/github/mocktools/ruby-rspec-mock/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/8a7a9ca7f590838bf02f/maintainability)](https://codeclimate.com/github/mocktools/ruby-rspec-mock/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/8a7a9ca7f590838bf02f/test_coverage)](https://codeclimate.com/github/mocktools/ruby-rspec-mock/test_coverage)
 [![CircleCI](https://circleci.com/gh/mocktools/ruby-rspec-mock/tree/master.svg?style=svg)](https://circleci.com/gh/mocktools/ruby-rspec-mock/tree/master)
 [![Gem Version](https://badge.fury.io/rb/rspec-mock.svg)](https://badge.fury.io/rb/rspec-mock)
 [![Downloads](https://img.shields.io/gem/dt/rspec-mock.svg?colorA=004d99&colorB=0073e6)](https://rubygems.org/gems/rspec-mock)
diff --git a/lib/rspec/core/configuration.rb b/lib/rspec/core/configuration.rb
@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Core
+    class Configuration
+      include RSpec::Mock::Configuration
+    end
+  end
+end
diff --git a/lib/rspec/mock/configuration.rb b/lib/rspec/mock/configuration.rb
@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Mock
+    module Configuration
+      def rspec_mock
+        RSpec::Mocks.configuration.tap do |config|
+          yield config if block_given?
+        end
+      end
+    end
+  end
+end
diff --git a/lib/rspec/mock/context.rb b/lib/rspec/mock/context.rb
@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Mock
+    class Context
+      include RSpec::Mocks::ExampleMethods
+      include RSpec::Matchers
+
+      def initialize(example_group)
+        @example_group = example_group
+      end
+
+      def method_missing(method, *args, &block)
+        if @example_group.respond_to?(method)
+          @example_group.send(method, *args, &block)
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?(method, include_private = false)
+        @example_group.respond_to?(method, include_private) || super
+      end
+    end
+  end
+end
diff --git a/lib/rspec/mock/core.rb b/lib/rspec/mock/core.rb
@@ -1,7 +1,17 @@
 # frozen_string_literal: true
 
+require 'rspec/core'
+require 'rspec/mocks'
+
 module RSpec
   module Mock
+    require_relative 'configuration'
+    require_relative 'context'
+    require_relative 'methods'
     require_relative 'version'
   end
+
+  module Core
+    require_relative '../core/configuration'
+  end
 end
diff --git a/lib/rspec/mock/methods.rb b/lib/rspec/mock/methods.rb
@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Mock
+    module Methods
+      def rspec_mock(&block)
+        return unless block_given?
+
+        RSpec::Mocks.with_temporary_scope do
+          RSpec::Mock::Context.new(self).instance_eval(&block)
+        end
+      end
+    end
+  end
+end
diff --git a/spec/rspec/mock/configuration_spec.rb b/spec/rspec/mock/configuration_spec.rb
@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+RSpec.describe RSpec::Mock::Configuration do
+  let(:test_class) do
+    Class.new do
+      include RSpec::Mock::Configuration
+    end
+  end
+
+  let(:instance) { test_class.new }
+  let(:mock_config) { instance_double('RSpec::Mocks::Configuration') }
+
+  before { allow(RSpec::Mocks).to receive(:configuration).and_return(mock_config) }
+
+  describe '#rspec_mock' do
+    context 'when block is given' do
+      it 'yields the configuration object' do
+        expect(mock_config).to receive(:tap).and_yield(mock_config)
+        expect { |block| instance.rspec_mock(&block) }.to yield_with_args(mock_config)
+      end
+    end
+
+    context 'when no block is given' do
+      it 'returns the configuration object' do
+        expect(mock_config).to receive(:tap)
+        expect(instance.rspec_mock).to be_nil
+      end
+    end
+  end
+end
diff --git a/spec/rspec/mock/context_spec.rb b/spec/rspec/mock/context_spec.rb
@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+RSpec.describe RSpec::Mock::Context do
+  let(:example_group) { double('ExampleGroup') } # rubocop:disable RSpec/VerifiedDoubles
+  let(:context) { described_class.new(example_group) }
+
+  describe '#initialize' do
+    it 'stores the example group' do
+      expect(context.instance_variable_get(:@example_group)).to eq(example_group)
+    end
+  end
+
+  describe '#method_missing' do
+    context 'when example group responds to the method' do
+      it 'delegates the method to example group' do
+        expect(example_group).to receive(:respond_to?).with(:some_method).and_return(true)
+        expect(example_group).to receive(:some_method).with('arg1', 'arg2').and_return('result')
+
+        result = context.some_method('arg1', 'arg2')
+        expect(result).to eq('result')
+      end
+    end
+
+    context 'when example group does not respond to the method' do
+      it 'raises NoMethodError' do
+        expect(example_group).to receive(:respond_to?).with(:unknown_method)
+        expect { context.unknown_method }.to raise_error(NoMethodError)
+      end
+    end
+  end
+
+  describe '#respond_to_missing?' do
+    context 'when example group responds to the method' do
+      it 'returns true' do
+        expect(example_group).to receive(:respond_to?).with(:some_method, false).and_return(true)
+        expect(context.respond_to?(:some_method)).to be(true)
+      end
+    end
+
+    context 'when example group does not respond to the method' do
+      it 'returns false' do
+        expect(example_group).to receive(:respond_to?).with(:unknown_method, false).and_return(false)
+        expect(context.respond_to?(:unknown_method)).to be(false)
+      end
+    end
+  end
+end
diff --git a/spec/rspec/mock/methods_spec.rb b/spec/rspec/mock/methods_spec.rb
@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+RSpec.describe RSpec::Mock::Methods do
+  let(:test_class) do
+    Class.new do
+      include RSpec::Mock::Methods
+    end
+  end
+
+  let(:instance) { test_class.new }
+
+  describe '#rspec_mock' do
+    let(:mock_context) { instance_double(RSpec::Mock::Context) }
+
+    before do
+      allow(RSpec::Mock::Context).to receive(:new).and_return(mock_context)
+      allow(mock_context).to receive(:instance_eval)
+    end
+
+    context 'when block is given' do
+      it 'executes within temporary scope, creates context and evaluates the block' do
+        expect(RSpec::Mocks).to receive(:with_temporary_scope).and_yield
+        expect(RSpec::Mock::Context).to receive(:new).with(instance).and_return(mock_context)
+        expect(mock_context).to receive(:instance_eval)
+        instance.rspec_mock { nil }
+      end
+    end
+
+    context 'when no block is given' do
+      it 'does not create context or temporary scope' do
+        expect(RSpec::Mock::Context).not_to receive(:new)
+        expect(RSpec::Mocks).not_to receive(:with_temporary_scope)
+        expect(instance.rspec_mock).to be_nil
+      end
+    end
+  end
+end
diff --git a/spec/rspec/mock_spec.rb b/spec/rspec/mock_spec.rb
@@ -1,7 +1,42 @@
 # frozen_string_literal: true
 
-RSpec.describe RSpec::Mock do
-  it 'has a version number' do
-    expect(described_class::VERSION).not_to be_nil
+RSpec.describe 'integration' do # rubocop:disable RSpec/DescribeClass
+  subject(:service) { test_class.call(*args, **kwargs) }
+
+  let(:test_class) do
+    Class.new do
+      def self.call(*args, **kwargs)
+        { args: args, kwargs: kwargs }
+      end
+    end
+  end
+  let(:args) { [1, 2, 3] }
+  let(:kwargs) { { a: 1, b: 2 } }
+  let(:expected_result) { { args: args, kwargs: kwargs } }
+
+  context 'with before block' do
+    before do
+      rspec_mock do
+        allow(test_class)
+          .to receive(:call)
+          .with(*args, **kwargs)
+          .and_call_original
+      end
+    end
+
+    it { is_expected.to eq(expected_result) }
+  end
+
+  context 'without before block' do
+    it do
+      rspec_mock do
+        expect(test_class)
+          .to receive(:call)
+          .with(*args, **kwargs)
+          .and_call_original
+
+        expect(service).to eq(expected_result)
+      end
+    end
   end
 end
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
@@ -15,5 +15,11 @@
   config.disable_monkey_patching!
   config.order = :random
 
+  config.rspec_mock do |mock|
+    mock.verify_partial_doubles = true
+  end
+
+  config.include RSpec::Mock::Methods
+
   ::Kernel.srand(config.seed)
 end
