rspec-forward 0.1.3 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e27a0fd49193261eaee3dce78cf62baf5466ecdf4026b016f7715008fea3b629
-  data.tar.gz: b01d40a1b73bcf6cf870e10b25aad20bbf5def7d20e536a8dfb1db415b3c6189
+  metadata.gz: 60586a2b506f34e4fe653293535ece8b206d47923a3fef6b0c2adfa5b82005ce
+  data.tar.gz: 6c3384494e394a33996bc1580f15d3a3ae6d7a1976b196e98fd2ad1f73672c2a
 SHA512:
-  metadata.gz: a7ee7bd5497d5cc0a72683a6824a16ffbbb387ef0ec65da077340b8d73e8f364da430a5625aca8884033315bceefb96b2706972b6302595047ba45b82d86e0ff
-  data.tar.gz: b5f350f737944f9b6c408c52dba44df02e096a1e98f8dc84f36d0ebae628d54ee4b141936f1e009b2d5f69de1ecefd13d11296a7d3b10a48f86c23c1f13f1333
+  metadata.gz: 39019b0a6c054365e0f5e26d39f3081e07d91db3a42bcbf60d57f3907cd92761cf530e905916227f5919c2959a6e3f7c984960e3fc068ddc216159a2f324a6b2
+  data.tar.gz: 46d07febe0734cc50532a5cf8c3772541153c47e98391c7f8a2b30f9b97670a8e98c633d02e22edacda53ace9b828f80cf6a4b243e5f2c14f703b66b3d479408

data/.ruby-version

@@ -0,0 +1 @@
+3.0.0

data/Gemfile.lock

@@ -1,17 +1,17 @@
 PATH
   remote: .
   specs:
-    rspec-forward (0.1.3)
-      rspec-mocks (~> 3.10)
+    rspec-forward (0.1.6)
+      rspec-mocks (~> 3.9)
 
 GEM
   remote: https://rubygems.org/
   specs:
     coderay (1.1.3)
     diff-lcs (1.4.4)
-    ffi (1.15.0)
-    formatador (0.2.5)
-    guard (2.16.2)
+    ffi (1.15.3)
+    formatador (0.3.0)
+    guard (2.17.0)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
       lumberjack (>= 1.0.12, < 2.0)
@@ -25,7 +25,7 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    listen (3.4.1)
+    listen (3.5.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     lumberjack (1.2.8)
@@ -34,26 +34,26 @@ GEM
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    pry (0.14.0)
+    pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     rake (12.3.3)
-    rb-fsevent (0.10.4)
+    rb-fsevent (0.11.0)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
       rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.0)
+    rspec-core (3.10.1)
       rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.0)
+    rspec-support (3.10.2)
     shellany (0.0.1)
     thor (1.1.0)
 
@@ -68,4 +68,4 @@ DEPENDENCIES
   rspec-forward!
 
 BUNDLED WITH
-   2.1.4
+   2.2.3

data/Guardfile

@@ -4,7 +4,7 @@
 GUARD_OPTIONS = {
   failed_mode: :keep,
   cmd: "rspec --order rand:$RANDOM",
-  title: "RSpec",
+  title: "RSpec"
 }.freeze
 
 guard :rspec, GUARD_OPTIONS do
@@ -15,11 +15,11 @@ guard :rspec, GUARD_OPTIONS do
   watch(%r{^lib/(.+)\.rb$}) do |m|
     "spec/#{m[1]}_spec.rb"
   end
-  
+
   watch("spec/spec_helper.rb") do
     "spec"
   end
-  
+
   watch(%r{^spec/support/(.+)\.rb$}) do
     "spec"
   end

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,108 @@ 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 class 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(:klass) { described_class }
+
+  it "passes arguments to instance" do
+    expect(klass)
+      .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/marzdrel/rspec-forward.
 
 ## License
 
@@ -41,4 +128,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/marzdrel/rspec-forward/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -3,11 +3,13 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec
 
+# rubocop:disable Security/Eval
 def gemspec
-  @gemspec ||= eval(File.read("rspec-forward.gemspec"), binding, ".gemspec")
+  @_gemspec ||= eval(File.read("rspec-forward.gemspec"), binding, ".gemspec")
 end
+# rubocop:enable Security/Eval
 
 desc "Validate the gemspec"
 task :gemspec do
@@ -15,7 +17,7 @@ task :gemspec do
 end
 
 desc "Build the gem"
-task :gem => :gemspec do
+task gem: :gemspec do
   sh "gem build #{gemspec.name}.gemspec"
 
   FileUtils.mkdir_p "pkg"

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.6"
   end
 end

data/rspec-forward.gemspec

@@ -3,16 +3,16 @@ require_relative "lib/rspec/forward/version"
 Gem::Specification.new do |spec|
   spec.name = "rspec-forward"
   spec.version = RSpec::Forward::VERSION
-  spec.authors= ["Aleksader Długopolski"]
-  spec.email = ["ad@dotpro.org"]
+  spec.authors = ["Marz Drel"]
+  spec.email = ["marzdrel@dotpro.org"]
 
   spec.summary = <<~TXT.gsub(/[[:space:]]+/, " ").strip
-    Set of RSpec matchers for checking class method to instnace 
+    Set of RSpec matchers for checking class method to instance
     method forwarding.
   TXT
 
   spec.description = <<~TXT.gsub(/[[:space:]]+/, " ").strip
-    Set of RSpec matchers for checking class method to instnace 
+    Set of RSpec matchers for checking class method to instance
     method forwarding.
   TXT
 
@@ -23,16 +23,16 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
   # spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = 
-    "https://github.com/adlugopolski/rspec-forward"
+  spec.metadata["source_code_uri"] =
+    "https://github.com/marzdrel/rspec-forward"
 
-  spec.metadata["changelog_uri"] = 
-    "https://github.com/adlugopolski/rspec-forward/blob/master/CHANGELOG.md"
+  spec.metadata["changelog_uri"] =
+    "https://github.com/marzdrel/rspec-forward/blob/master/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
 
-  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
 
@@ -40,7 +40,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "rspec-mocks", "~> 3.10"
+  spec.add_runtime_dependency "rspec-mocks", "~> 3.9"
   spec.add_development_dependency "guard", "~> 2.16"
   spec.add_development_dependency "guard-rspec", "~> 4.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-forward
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.6
 platform: ruby
 authors:
-- Aleksader Długopolski
-autorequire: 
+- Marz Drel
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-14 00:00:00.000000000 Z
+date: 2022-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-mocks
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -52,15 +52,16 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.7'
-description: Set of RSpec matchers for checking class method to instnace method forwarding.
+description: Set of RSpec matchers for checking class method to instance method forwarding.
 email:
-- ad@dotpro.org
+- marzdrel@dotpro.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -77,13 +78,13 @@ files:
 - lib/rspec/forward/forward_to_instance_build.rb
 - lib/rspec/forward/version.rb
 - rspec-forward.gemspec
-homepage: 
+homepage:
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/adlugopolski/rspec-forward
-  changelog_uri: https://github.com/adlugopolski/rspec-forward/blob/master/CHANGELOG.md
-post_install_message: 
+  source_code_uri: https://github.com/marzdrel/rspec-forward
+  changelog_uri: https://github.com/marzdrel/rspec-forward/blob/master/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -98,8 +99,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
-summary: Set of RSpec matchers for checking class method to instnace method forwarding.
+summary: Set of RSpec matchers for checking class method to instance method forwarding.
 test_files: []