Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mocktools/ruby-rspec-mock
RSpec dual mocking compatibility. Use RSpec's mocks as secondary, alongside a primary, alternative mocking library.
https://github.com/mocktools/ruby-rspec-mock
developer-tools hacktoberfest mock mocktools rspec rspec-mock rspec-rails rspec-testing ruby rubygem testing
Last synced: 3 months ago
JSON representation
RSpec dual mocking compatibility. Use RSpec's mocks as secondary, alongside a primary, alternative mocking library.
- Host: GitHub
- URL: https://github.com/mocktools/ruby-rspec-mock
- Owner: mocktools
- License: mit
- Created: 2024-11-03T17:20:21.000Z (3 months ago)
- Default Branch: master
- Last Pushed: 2024-11-04T11:07:09.000Z (3 months ago)
- Last Synced: 2024-11-04T11:21:11.799Z (3 months ago)
- Topics: developer-tools, hacktoberfest, mock, mocktools, rspec, rspec-mock, rspec-rails, rspec-testing, ruby, rubygem, testing
- Language: Ruby
- Homepage:
- Size: 24.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Seamless migration from third-party mocks to RSpec built-in mocking framework
[](https://codeclimate.com/github/mocktools/ruby-rspec-mock/maintainability)
[](https://codeclimate.com/github/mocktools/ruby-rspec-mock/test_coverage)
[](https://circleci.com/gh/mocktools/ruby-rspec-mock/tree/master)
[](https://badge.fury.io/rb/rspec-mock)
[](https://rubygems.org/gems/rspec-mock)
[](LICENSE.txt)
[](CODE_OF_CONDUCT.md)
`rspec-mock` is a lightweight gem designed to ease the transition to RSpec's built-in mocking framework by allowing developers to use RSpec's mocks as secondary, alongside a primary, alternative mocking library. This setup enables new code to leverage RSpec’s built-in mocks directly, while still supporting legacy code that relies on an external mocking library.
## Table of Contents
- [Features](#features)
- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
- [Configuration](#configuration)
- [Integration](#integration)
- [Contributing](#contributing)
- [License](#license)
- [Code of Conduct](#code-of-conduct)
- [Credits](#credits)
- [Versioning](#versioning)
- [Changelog](CHANGELOG.md)
## Features
- Dual Mocking Compatibility: Use RSpec’s built-in mock framework as a secondary, with your primary mock of choice (e.g., Mocha, FlexMock).
- Seamless Transition: Adopt `RSpec::Mocks` in new tests gradually, without disrupting existing tests dependent on an alternative mocking library.
- Simplified Migration Path: Makes it easy to phase out external mocking libraries over time, moving towards a more unified, RSpec-native mocking approach.
## Requirements
Ruby MRI 2.5.0+
## Installation
Add this line to your application's `Gemfile`:
```ruby
group :test do
gem 'rspec-mock', require: false
end
```
And then execute:
```bash
bundle
```
Or install it yourself as:
```bash
gem install rspec-mock
```
## Usage
### Configuration
```ruby
# spec/support/config/rspec_mock.rb
require 'rspec/mock'
RSpec.configure do |config|
config.rspec_mock do |mock|
mock.verify_partial_doubles = true
end
config.include RSpec::Mock::Methods
end
```
### Integration
```ruby
# spec/spec_helper.rb
RSpec.configure do |config|
config.mock_framework = :flexmock
end
# spec/sandbox_spec.rb
RSpec.describe Sandbox do
describe '.call' do
subject(:service) { described_class.call(*args, **kwargs) }
let(:args) { [1, 2, 3] }
let(:kwargs) { { a: 1, b: 2 } }
let(:expected_result) { { args:, kwargs: } }
context 'when multiple mocks' do
before do
flexmock(described_class)
.should_receive(:new)
.with(*args, **kwargs)
.pass_thru
rspec_mock do
allow(described_class)
.to receive(:call)
.with(*args, **kwargs)
.and_call_original
end
end
it { is_expected.to eq(expected_result) }
end
context 'when single mock' do
it do
rspec_mock do
expect(described_class)
.to receive(:call)
.with(*args, **kwargs)
.and_call_original
expect(service).to eq(expected_result)
end
end
end
end
end
```
## Contributing
Bug reports and pull requests are welcome on GitHub at . This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. Please check the [open tickets](https://github.com/mocktools/ruby-rspec-mock/issues). Be sure to follow Contributor Code of Conduct below and our [Contributing Guidelines](CONTRIBUTING.md).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the RSpec::Mock project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).
## Credits
- [The Contributors](https://github.com/mocktools/ruby-rspec-mock/graphs/contributors) for code and awesome suggestions
- [The Stargazers](https://github.com/mocktools/ruby-rspec-mock/stargazers) for showing their support
## Versioning
RSpec::Mock uses [Semantic Versioning 2.0.0](https://semver.org)