RSpec::Forward
Gem rspec-forward adds simple matchers to verify short hand class proxy
method forwarding when using Method Object pattern.
Installation
Add this line to your application's Gemfile:
gem "rspec-forward"And then execute:
$ bundle install
Or install it yourself as:
$ gem install rspec-forward
Next, include matchers in your spec/rails_helper.rb or spec/spec_helper.rb in the
RSpec.configure block:
RSpec.configure do |config|
# ...
config.include RSpec::Forward
# ...
endIf you are using Spring for your Rails
development, make sure the daemon is restarted after the instalation step is
complete: spring stop.
Usage
Forwarding from class method to instance of the same class
Assume you have a Method Object with #call method defined like this:
class Add
def self.call(...)
new(...).call
end
def initialize(addend1, addend2)
@addend1 = addend1
@addend2 = addend2
end
def call
@addend1 + @addend2
end
end
Add.call(3, 5) # => 8Gem rspec-forward adds matcher forward_to_instance to verify if the
call using Class Methods is properly building the instance of the class and
forwarding the method call to expected instance method.
require "rails_helper"
RSpec.describe Add do
describe "#call" do
let(:service) { described_class.new(3, 5) }
it "adds numbers" do
expect(service.call).to eq 8
end
end
describe ".call" do
let(:klass) { described_class }
it "passes arguments to instance" do
expect(klass)
.to forward_to_instance(:call)
.with_2_args
end
end
endPossible calls to the matcher include the following:
it { is_expected.to forward_to_instance(:call).with_no_args }
it { is_expected.to forward_to_instance(:call).with_1_arg }
it { is_expected.to forward_to_instance(:call).with_2_args }
it { is_expected.to forward_to_instance(:call).with_3_args }
it { is_expected.to forward_to_instance(:call).with_named(:foo, :bar) }
it { is_expected.to forward_to_instance(:call).with_1_arg_and_named(:foo) }
it { is_expected.to forward_to_instance(:call).with_2_args_and_named(:foo) }
it { is_expected.to forward_to_instance(:call).with_3_args_and_named(:foo, :bar) }TODO: Explain forward_to_instance_build(...)
Forwarding from method to another class
Assume you have a method which just passes all args to another class.
class Add
def self.call(addend1, addend2)
@addend1 + @addend2
end
end
class Other
def add(...)
Add.call(...)
end
end
Add.call(3, 5) # => 8[...]
TODO: Explain usage.
Development
After checking out the repo, run bundle install to install dependencies. Then, run
bundle exec rspec to run the tests.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/marzdrel/rspec-forward.
License
The gem is available as open source under the terms of the MIT License.
Code of Conduct
Everyone interacting in the RSpec::Forward project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.