r_spec-clone 1.2.3 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c76f25e186a2f835a2a006e3b3add6c7b94d4b070bd3a81b866747edff8291f
-  data.tar.gz: e9203508514fde39e690e145172dd417d2dcd20eb6badc44a1cb34fc3dc7335a
+  metadata.gz: ef1c79c6783a2aace9f035ef5935bb556828731501ce7b92f86dcedf58e18d90
+  data.tar.gz: 615131453af20ba74f436f0569db9f429af2bd18589de5ee132ef69af8cd09d8
 SHA512:
-  metadata.gz: 30681f5232bef7c695e05b169ce5fcf3882277bf981174898d586a01c756b0eec3ca88c9eecf6c02c3deae7d515e84f3bbd404202cb1aef59f63b70fa901f6ca
-  data.tar.gz: 0e4e21aa8f6aa8d6f281ce99add7018ea6d163fab13fd8cd04863104884244a74566b11d665d3e7a7e5c0e683e474b479d18383b0cf8e7f192b7986cd7947d26
+  metadata.gz: bbaa63b25dc7a3d98810d686d5fb4a5cacec5a74ac04d1aab01f86dfc886ef57cf9b9ae20201aaf3a43e95bb626ce363bfe62190142904ceef8526d1d34ef9ab
+  data.tar.gz: e6b4d19ef401aa923f31739ab5ee5289929309d762113f82d361f52859c17f24739e18f8236e93db6d47f428e1f09a6aa4c6beabfb5ea938f0fa1f6769cf4835

data/README.md

@@ -117,6 +117,8 @@ end
 # Success: expected to eq "foo".
 ```
 
+Note: if you are wondering what the Ruby code generated by using the DSL might look like, an article presents the correspondence between each method via simple examples, available in [English](https://dev.to/cyri_/what-ruby-code-to-expect-from-a-testing-dsl-4oe1), [Chinese](https://ruby-china.org/topics/41441) and [Japanese](https://qiita.com/cyril/items/17ee758e162bae144a07).
+
 ### Expectations
 
 Expectations define if the value being tested (_actual_) matches a certain value or specific criteria.
@@ -135,6 +137,12 @@ expect(actual).to equal(expected) # passes if expected.equal?(actual)
 expect(actual).to be(expected)    # passes if expected.equal?(actual)
 ```
 
+#### Comparisons
+
+```ruby
+expect(actual).to be_within(delta).of(expected) # passes if (expected - actual).abs <= delta
+```
+
 #### Regular expressions
 
 ```ruby
@@ -147,13 +155,13 @@ expect(actual).to match(expected) # passes if expected.match?(actual)
 expect { actual }.to raise_exception(expected) # passes if expected exception is raised
 ```
 
-#### Truth
+#### True
 
 ```ruby
 expect(actual).to be_true # passes if true.equal?(actual)
 ```
 
-#### Untruth
+#### False
 
 ```ruby
 expect(actual).to be_false # passes if false.equal?(actual)
@@ -172,6 +180,36 @@ expect(actual).to be_instance_of(expected)    # passes if expected.equal?(actual
 expect(actual).to be_an_instance_of(expected) # passes if expected.equal?(actual.class)
 ```
 
+#### Predicate
+
+```ruby
+expect(actual).to be_xxx            # passes if actual.xxx?
+expect(actual).to be_have_xxx(:yyy) # passes if actual.has_xxx?(:yyy)
+```
+
+##### Examples
+
+```ruby
+expect([]).to be_empty
+expect(foo: 1).to have_key(:foo)
+```
+
+#### Change
+
+```ruby
+expect { object.action }.to change(object, :value).to(new)
+expect { object.action }.to change(object, :value).from(old).to(new)
+expect { object.action }.to change(object, :value).by(delta)
+expect { object.action }.to change(object, :value).by_at_least(minimum_delta)
+expect { object.action }.to change(object, :value).by_at_most(maximum_delta)
+```
+
+#### Satisfy
+
+```ruby
+expect(actual).to(satisfy { |value| value == expected })
+```
+
 ### Running specs
 
 By convention, specs live in the `spec/` directory of a project. Spec files should end with `_spec.rb` to be recognizable as such.
@@ -232,17 +270,23 @@ bundle exec rake
 
 ## Performance
 
+The benchmarks compare the performance of [`r_spec-clone`](https://rubygems.org/gems/r_spec-clone) with the following frameworks (in alphabetical order):
+
+* [`fix`](https://rubygems.org/gems/fix)
+* [`minitest`](https://rubygems.org/gems/minitest)
+* [`rspec`](https://rubygems.org/gems/rspec)
+
 ### Boot time
 
 Benchmark against [100 executions of a file containing 1 expectation](https://github.com/cyril/r_spec-clone.rb/blob/main/benchmark/boot_time/) (lower is better).
 
-![Boot time](https://r-spec.dev/benchmark-boot-time.svg)
+![Boot time benchmark](https://r-spec.dev/benchmark-boot-time.svg)
 
-### Run time
+### Runtime
 
-Benchmark against [1 execution of a file containing 1,000,000 expectations](https://github.com/cyril/r_spec-clone.rb/blob/main/benchmark/run_time/) (lower is better).
+Benchmark against [1 execution of a file containing 100,000 expectations](https://github.com/cyril/r_spec-clone.rb/blob/main/benchmark/run_time/) (lower is better).
 
-![Run time](https://r-spec.dev/benchmark-run-time.svg)
+![Runtime benchmark](https://r-spec.dev/benchmark-run-time.svg)
 
 ## Test suite
 

data/lib/r_spec.rb

@@ -37,8 +37,8 @@ require_relative File.join("r_spec", "clone", "dsl")
 #
 #   # Output to the console
 #   #   Success: expected to eq 3.
-#   #   Success: expected true to be true.
-#   #   Success: expected false to be false.
+#   #   Success: expected to be true.
+#   #   Success: expected to be false.
 #
 # @example An inherited definition of let
 #   require "r_spec"

data/lib/r_spec/clone/error/pending_expectation.rb

@@ -12,13 +12,13 @@ module RSpec
         # @return [nil] Write a pending expectation to STDOUT.
         def self.result(message)
           ::Expresenter.call(true).with(
-            actual:   new(message),
-            error:    nil,
-            expected: self,
-            got:      false,
-            matcher:  :raise_exception,
-            negate:   true,
-            level:    :SHOULD
+            actual:     new(message),
+            definition: "raise exception #{self}",
+            error:      nil,
+            expected:   self,
+            got:        false,
+            negate:     true,
+            level:      :SHOULD
           )
         end
       end

data/lib/r_spec/clone/expectation_helper/it.rb

@@ -19,7 +19,7 @@ module RSpec
         #
         # @example
         #   expect("foo") # => #<RSpec::Clone::ExpectationTarget::Value:0x00007f @actual="foo">
-        #   expect { Boom } # => #<RSpec::Clone::ExpectationTarget::Block:0x00007f @callable=#<Proc:0x00007f>>
+        #   expect { RSpec::Clone::Boom! } # => #<RSpec::Clone::ExpectationTarget::Block:0x... @callable=#<Proc:0x...>>
         #
         # @api public
         def expect(value = self.class.superclass, &block)

data/lib/r_spec/clone/expectation_helper/shared.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-require "matchi/rspec"
-require "matchi/helper"
+require "matchi"
 
 module RSpec
   module Clone
@@ -11,72 +10,240 @@ module RSpec
       # This module defines a number of methods to create expectations, which
       # are automatically included into examples.
       #
-      # It also includes a collection of expectation matchers 🤹
-      #
-      # @example Equivalence matcher
-      #   matcher = eql("foo") # => Matchi::Matcher::Eql.new("foo")
-      #   matcher.matches? { "foo" } # => true
-      #   matcher.matches? { "bar" } # => false
-      #
-      #   matcher = eq("foo") # => Matchi::Matcher::Eq.new("foo")
-      #   matcher.matches? { "foo" } # => true
-      #   matcher.matches? { "bar" } # => false
-      #
-      # @example Identity matcher
-      #   object = "foo"
-      #
-      #   matcher = equal(object) # => Matchi::Matcher::Equal.new(object)
-      #   matcher.matches? { object } # => true
-      #   matcher.matches? { "foo" } # => false
-      #
-      #   matcher = be(object) # => Matchi::Matcher::Be.new(object)
-      #   matcher.matches? { object } # => true
-      #   matcher.matches? { "foo" } # => false
-      #
-      # @example Regular expressions matcher
-      #   matcher = match(/^foo$/) # => Matchi::Matcher::Match.new(/^foo$/)
-      #   matcher.matches? { "foo" } # => true
-      #   matcher.matches? { "bar" } # => false
-      #
-      # @example Expecting errors matcher
-      #   matcher = raise_exception(NameError) # => Matchi::Matcher::RaiseException.new(NameError)
-      #   matcher.matches? { Boom } # => true
-      #   matcher.matches? { true } # => false
-      #
-      # @example Truth matcher
-      #   matcher = be_true # => Matchi::Matcher::BeTrue.new
-      #   matcher.matches? { true } # => true
-      #   matcher.matches? { false } # => false
-      #   matcher.matches? { nil } # => false
-      #   matcher.matches? { 4 } # => false
-      #
-      # @example Untruth matcher
-      #   matcher = be_false # => Matchi::Matcher::BeFalse.new
-      #   matcher.matches? { false } # => true
-      #   matcher.matches? { true } # => false
-      #   matcher.matches? { nil } # => false
-      #   matcher.matches? { 4 } # => false
-      #
-      # @example Nil matcher
-      #   matcher = be_nil # => Matchi::Matcher::BeNil.new
-      #   matcher.matches? { nil } # => true
-      #   matcher.matches? { false } # => false
-      #   matcher.matches? { true } # => false
-      #   matcher.matches? { 4 } # => false
-      #
-      # @example Type/class matcher
-      #   matcher = be_instance_of(String) # => Matchi::Matcher::BeInstanceOf.new(String)
-      #   matcher.matches? { "foo" } # => true
-      #   matcher.matches? { 4 } # => false
-      #
-      #   matcher = be_an_instance_of(String) # => Matchi::Matcher::BeAnInstanceOf.new(String)
-      #   matcher.matches? { "foo" } # => true
-      #   matcher.matches? { 4 } # => false
+      # It also includes a collection of expectation matchers.
       #
       # @see https://github.com/fixrb/matchi
-      # @see https://github.com/fixrb/matchi-rspec
       module Shared
-        include ::Matchi::Helper
+        # Equivalence matcher
+        #
+        # @example
+        #   matcher = eq("foo")
+        #   matcher.matches? { "foo" } # => true
+        #   matcher.matches? { "bar" } # => false
+        #
+        # @param expected [#eql?] An expected equivalent object.
+        #
+        # @return [#matches?] An equivalence matcher.
+        #
+        # @api public
+        def eq(expected)
+          ::Matchi::Eq.new(expected)
+        end
+
+        alias eql eq
+
+        # Identity matcher
+        #
+        # @example
+        #   object = "foo"
+        #   matcher = be(object)
+        #   matcher.matches? { object } # => true
+        #   matcher.matches? { "foo" } # => false
+        #
+        # @param expected [#equal?] The expected identical object.
+        #
+        # @return [#matches?] An identity matcher.
+        #
+        # @api public
+        def be(expected)
+          ::Matchi::Be.new(expected)
+        end
+
+        alias equal be
+
+        # Comparisons matcher
+        #
+        # @example
+        #   matcher = be_within(1).of(41)
+        #   matcher.matches? { 42 } # => true
+        #   matcher.matches? { 43 } # => false
+        #
+        # @param delta [Numeric] A numeric value.
+        #
+        # @return [#matches?] A comparison matcher.
+        #
+        # @api public
+        def be_within(delta)
+          ::Matchi::BeWithin.new(delta)
+        end
+
+        # Regular expressions matcher
+        #
+        # @example
+        #   matcher = match(/^foo$/)
+        #   matcher.matches? { "foo" } # => true
+        #   matcher.matches? { "bar" } # => false
+        #
+        # @param expected [#match] A regular expression.
+        #
+        # @return [#matches?] A regular expression matcher.
+        #
+        # @api public
+        def match(expected)
+          ::Matchi::Match.new(expected)
+        end
+
+        # Expecting errors matcher
+        #
+        # @example
+        #   matcher = raise_exception(NameError)
+        #   matcher.matches? { RSpec::Clone::Boom! } # => true
+        #   matcher.matches? { true } # => false
+        #
+        # @param expected [Exception, #to_s] The expected exception name.
+        #
+        # @return [#matches?] An error matcher.
+        #
+        # @api public
+        def raise_exception(expected)
+          ::Matchi::RaiseException.new(expected)
+        end
+
+        # True matcher
+        #
+        # @example
+        #   matcher = be_true
+        #   matcher.matches? { true } # => true
+        #   matcher.matches? { false } # => false
+        #   matcher.matches? { nil } # => false
+        #   matcher.matches? { 4 } # => false
+        #
+        # @return [#matches?] A `true` matcher.
+        #
+        # @api public
+        def be_true
+          be(true)
+        end
+
+        # False matcher
+        #
+        # @example
+        #   matcher = be_false
+        #   matcher.matches? { false } # => true
+        #   matcher.matches? { true } # => false
+        #   matcher.matches? { nil } # => false
+        #   matcher.matches? { 4 } # => false
+        #
+        # @return [#matches?] A `false` matcher.
+        #
+        # @api public
+        def be_false
+          be(false)
+        end
+
+        # Nil matcher
+        #
+        # @example
+        #   matcher = be_nil
+        #   matcher.matches? { nil } # => true
+        #   matcher.matches? { false } # => false
+        #   matcher.matches? { true } # => false
+        #   matcher.matches? { 4 } # => false
+        #
+        # @return [#matches?] A `nil` matcher.
+        #
+        # @api public
+        def be_nil
+          be(nil)
+        end
+
+        # Type/class matcher
+        #
+        # @example
+        #   matcher = be_an_instance_of(String)
+        #   matcher.matches? { "foo" } # => true
+        #   matcher.matches? { 4 } # => false
+        #
+        # @param expected [Class, #to_s] The expected class name.
+        #
+        # @return [#matches?] A type/class matcher.
+        #
+        # @api public
+        def be_an_instance_of(expected)
+          ::Matchi::BeAnInstanceOf.new(expected)
+        end
+
+        # Change matcher
+        #
+        # @example
+        #   object = []
+        #   matcher = change(object, :length).by(1)
+        #   matcher.matches? { object << 1 } # => true
+        #
+        #   object = []
+        #   matcher = change(object, :length).by_at_least(1)
+        #   matcher.matches? { object << 1 } # => true
+        #
+        #   object = []
+        #   matcher = change(object, :length).by_at_most(1)
+        #   matcher.matches? { object << 1 } # => true
+        #
+        #   object = "foo"
+        #   matcher = change(object, :to_s).from("foo").to("FOO")
+        #   matcher.matches? { object.upcase! } # => true
+        #
+        #   object = "foo"
+        #   matcher = change(object, :to_s).to("FOO")
+        #   matcher.matches? { object.upcase! } # => true
+        #
+        # @param object [#object_id]  An object.
+        # @param method [Symbol]      The name of a method.
+        # @param args   [Array]       A list of arguments.
+        # @param kwargs [Hash]        A list of keyword arguments.
+        #
+        # @return [#matches?] A change matcher.
+        #
+        # @api public
+        def change(object, method, *args, **kwargs, &block)
+          ::Matchi::Change.new(object, method, *args, **kwargs, &block)
+        end
+
+        # Satisfy matcher
+        #
+        # @example
+        #   matcher = satisfy { |value| value == 42 }
+        #   matcher.matches? { 42 } # => true
+        #
+        # @param expected [Proc] A block of code.
+        #
+        # @return [#matches?] A satisfy matcher.
+        #
+        # @api public
+        def satisfy(&expected)
+          ::Matchi::Satisfy.new(&expected)
+        end
+
+        private
+
+        # Predicate matcher, or default method missing behavior.
+        #
+        # @example Empty predicate matcher
+        #   matcher = be_empty
+        #   matcher.matches? { [] } # => true
+        #   matcher.matches? { [4] } # => false
+        def method_missing(name, *args, **kwargs, &block)
+          return super unless predicate_matcher_name?(name)
+
+          ::Matchi::Predicate.new(name, *args, **kwargs, &block)
+        end
+
+        # :nocov:
+
+        # Hook method to return whether the obj can respond to id method or not.
+        def respond_to_missing?(name, include_private = false)
+          predicate_matcher_name?(name) || super
+        end
+
+        # :nocov:
+
+        # Predicate matcher name detector.
+        #
+        # @param name [Array, Symbol] The name of a potential predicate matcher.
+        #
+        # @return [Boolean] Indicates if it is a predicate matcher name or not.
+        def predicate_matcher_name?(name)
+          name.start_with?("be_", "have_") && !name.end_with?("!", "?")
+        end
       end
     end
   end

data/lib/r_spec/clone/expectation_target/base.rb

@@ -95,13 +95,13 @@ module RSpec
         #   `Kernel.exit(false)` with a failure message written to STDERR.
         def result(passed, actual:, error:, got:, matcher:, negate:)
           Console.passed_spec ::Expresenter.call(passed).with(
-            actual:   actual,
-            error:    error,
-            expected: matcher.expected,
-            got:      got,
-            negate:   negate,
-            matcher:  matcher.class.to_sym,
-            level:    :MUST
+            actual:     actual,
+            definition: matcher.to_s,
+            error:      error,
+            expected:   matcher.expected,
+            got:        got,
+            negate:     negate,
+            level:      :MUST
           )
         rescue ::Expresenter::Fail => e
           Console.failed_spec(e)

data/lib/r_spec/clone/expectation_target/block.rb

@@ -29,7 +29,7 @@ module RSpec
         # @raise (see Base#absolute_requirement)
         def absolute_requirement(matcher:, negate:)
           super(
-            ::TestTube.invoke(isolation: false, matcher: matcher, negate: negate, &@input),
+            ::TestTube.invoke(isolate: false, matcher: matcher, negate: negate, &@input),
             matcher: matcher,
             negate:  negate
           )

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: r_spec-clone
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.5.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-15 00:00:00.000000000 Z
+date: 2021-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: expresenter
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
-  name: matchi-rspec
+  name: matchi
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 3.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 3.3.0
 - !ruby/object:Gem::Dependency
   name: test_tube
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement