rspec-forward 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e27a0fd49193261eaee3dce78cf62baf5466ecdf4026b016f7715008fea3b629
-  data.tar.gz: b01d40a1b73bcf6cf870e10b25aad20bbf5def7d20e536a8dfb1db415b3c6189
+  metadata.gz: 1b3205b7050cdf8f0bef33291f5015b5e345757ea3ebfa39338f370e7bdcb071
+  data.tar.gz: 473a350e1c4f61586f7804d23a29c854045a96c5ce7848d0350c80d007132514
 SHA512:
-  metadata.gz: a7ee7bd5497d5cc0a72683a6824a16ffbbb387ef0ec65da077340b8d73e8f364da430a5625aca8884033315bceefb96b2706972b6302595047ba45b82d86e0ff
-  data.tar.gz: b5f350f737944f9b6c408c52dba44df02e096a1e98f8dc84f36d0ebae628d54ee4b141936f1e009b2d5f69de1ecefd13d11296a7d3b10a48f86c23c1f13f1333
+  metadata.gz: a0682f9ce361a22f8b9115d1edee289f09b0c5dd4d87591f361690fc065505db1d38492805291ccad5486a0eb616e6430f5387e6781f98b73a89a6c0aecdbbfb
+  data.tar.gz: 0b14a346a42976da92a7f7534aae05edab58d1b25633ddf3cb34b71f5ccaef6e738e6ff11026f8325d613b8da485858d1a617616f1fe047a8aad13f539ea8a1e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rspec-forward (0.1.3)
+    rspec-forward (0.1.4)
       rspec-mocks (~> 3.10)
 
 GEM

data/README.md

@@ -1,15 +1,14 @@
 # RSpec::Forward
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rspec/forward`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+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:
 
 ```ruby
-gem 'rspec-forward'
+gem "rspec-forward"
 ```
 
 And then execute:
@@ -20,20 +19,110 @@ 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:
+
+```ruby
+RSpec.configure do |config|
+  # ...
+  config.include RSpec::Forward
+  # ...
+end
+```
+
+If you are using [Spring](https://github.com/rails/spring) for your Rails
+development, make sure the daemon is restarted after the instalation step is
+complete: `spring stop`.
+
 ## Usage
 
-TODO: Write usage instructions here
+Assume you have a Method Object with `#call` method defined like this:
 
-## Development
+```ruby
+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) # => 8
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Gem `rspec-forward` adds matcher `forward_to_instance` to verify if the
+call using Class Methods is properly building the instance of the calss and
+forwarding the method call to expected instance method.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```ruby
+require "rails_helper"
 
-## Contributing
+RSpec.describe Add do
+  describe "#call" do
+    let(:service) { described_class.new(3, 5) }
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rspec-forward. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rspec-forward/blob/master/CODE_OF_CONDUCT.md).
+    it "adds numbers" do
+      expect(service.call).to eq 8
+    end
+  end
+
+  describe ".call" do
+    subject { described_class }
+
+    it { should forward_to_instance(:call).with_2_args }
+  end
+end
+```
+
+If you would rather not use the old, deprecated
+`should` syntax in RSpec, replace the above exaple with the following:
+
+```ruby
+describe ".call" do
+  let(:object) { described_class }
+
+  it "passes arguments to instance" do
+    expect(object)
+      .to forward_to_instance(:call)
+      .with_2_args
+  end
+end
+```
+
+Possible calls to the matcher include the following:
+
+```ruby
+it { should forward_to_instance(:call).with_no_args }
+it { should forward_to_instance(:call).with_1_arg }
+it { should forward_to_instance(:call).with_2_args }
+it { should forward_to_instance(:call).with_3_args }
+# ...
+
+it { should forward_to_instance(:call).with_named(:foo, :bar) }
+it { should forward_to_instance(:call).with_1_arg_and_named(:foo) }
+it { should forward_to_instance(:call).with_2_args_and_named(:foo) }
+it { should forward_to_instance(:call).with_3_args_and_named(:foo, :bar) }
+```
+
+TODO: Explain `forward_to_instance_build(...)`
+
+## 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/adlugopolski/rspec-forward.
 
 ## License
 
@@ -41,4 +130,6 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## 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](https://github.com/[USERNAME]/rspec-forward/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the RSpec::Forward project's codebases, issue
+trackers, chat rooms and mailing lists is expected to follow the [code of
+conduct](https://github.com/adlugopolski/rspec-forward/blob/master/CODE_OF_CONDUCT.md).

data/lib/rspec/forward/forward_methods.rb

@@ -3,15 +3,28 @@ module ::RSpec
     module ForwardMethods
       0.upto(10) do |index|
         define_method format("with_%<count>d_args", count: index) do
+          @kwargs = {}
           @args = Array.new(index, :arg)
           self
         end
+
+        name = format("with_%<count>d_args_and_named", count: index)
+
+        define_method name do |*kwargs|
+          @args = Array.new(index, :arg)
+          @kwargs = Hash[kwargs.map { [_1, _1] }]
+          self
+        end
       end
 
       def with_1_arg
         with_1_args
       end
 
+      def with_1_arg_and_named(*args, **kwargs)
+        with_1_args_and_named(*args, **kwargs)
+      end
+
       def with_no_args
         with_0_args
       end
@@ -22,9 +35,9 @@ module ::RSpec
         self
       end
 
-      def with_named(**kwargs)
+      def with_named(*kwargs)
         @args = []
-        @kwargs = kwargs
+        @kwargs = Hash[kwargs.map { [_1, _1] }]
         self
       end
 

data/lib/rspec/forward/forward_to_instance.rb

@@ -13,6 +13,13 @@ module ::RSpec
       def matches?(actual)
         matches_for?(actual, :return)
       end
+
+      def description
+        <<~TXT.gsub(/\n+/, " ")
+          to pass the arguments to the constructor of instance and return
+          the value returned by the instance method
+        TXT
+      end
     end
   end
 end

data/lib/rspec/forward/forward_to_instance_build.rb

@@ -15,6 +15,13 @@ module ::RSpec
 
         matches_for?(actual, instance)
       end
+
+      def description
+        <<~TXT.gsub(/\n+/, " ")
+          to pass the arguments to the constructor of instance, execute
+          provided instance method and return the instance of the class
+        TXT
+      end
     end
   end
 end

data/lib/rspec/forward/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module Forward
-    VERSION = "0.1.3"
+    VERSION = "0.1.4"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-forward
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Aleksader Długopolski