expresenter 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b293c0c6ffd15b336c00fcc841647e6d244623346dd86ab6cf319c05cfc7d909
-  data.tar.gz: 3901ec01f1277302150665002b97c157ba26846bf08e344bd364fbb7fdec874d
+  metadata.gz: 7681f55eec320e3a594a0dd3bf83bed059059c4fe0786c21702d100cdcff4686
+  data.tar.gz: 120bfa0781682b31af511528a1271118329745a0348e11a9508eb20daf55c082
 SHA512:
-  metadata.gz: db88b4f5c706ae1aaf48fdf6b2b45aa0ab4d0fe1f5a557331e51b8b9c9333f07305ec1f6d5f3287a34ed39e20396fd2d4879f5b186e94e9653420604a1d2ca3d
-  data.tar.gz: 04c1db7b8ea904a67397305f111bde2e4dadac40c6cdd392cb855b3b4db24a8ae904c92cfe07332cdc137cceea57481d9d920803941722b3e8749db16d0b346b
+  metadata.gz: 9b9618acf9d062eacc9ac69ac3bca457fa6bbf7172baca826ee77f21365ef994e356fbf03b983fc39403a23fdecc7abdaa32ea4e5837a1260e5bf1696f8fb60c
+  data.tar.gz: 02a640a1f52ea92dce4e1fc8c88128142fb3ca9f2e14b811ba654008ce769f92c0d2137b88dd734a9bf91d8b68be758c0b6d862c3cf11d8b9aef4fc87bb02646

data/README.md

@@ -1,9 +1,10 @@
 # Expresenter
 
-[![Build Status](https://api.travis-ci.org/fixrb/expresenter.svg?branch=main)][travis]
-[![Gem Version](https://badge.fury.io/rb/expresenter.svg)][gem]
-[![Inline docs](https://inch-ci.org/github/fixrb/expresenter.svg?branch=main)][inchpages]
-[![Documentation](https://img.shields.io/:yard-docs-38c800.svg)][rubydoc]
+[![Version](https://img.shields.io/github/v/tag/fixrb/expresenter?label=Version&logo=github)](https://github.com/fixrb/expresenter/releases)
+[![Yard documentation](https://img.shields.io/badge/Yard-documentation-blue.svg?logo=github)](https://rubydoc.info/github/fixrb/expresenter/main)
+[![CI](https://github.com/fixrb/expresenter/workflows/CI/badge.svg?branch=main)](https://github.com/fixrb/expresenter/actions?query=workflow%3Aci+branch%3Amain)
+[![RuboCop](https://github.com/fixrb/expresenter/workflows/RuboCop/badge.svg?branch=main)](https://github.com/fixrb/expresenter/actions?query=workflow%3Arubocop+branch%3Amain)
+[![License](https://img.shields.io/github/license/fixrb/expresenter?label=License&logo=github)](https://github.com/fixrb/expresenter/raw/main/LICENSE.md)
 
 > Expectation result presenter.
 
@@ -62,11 +63,11 @@ Failed expectations can be classified as:
 The following parameters are required to instantiate the result:
 
 * `actual`: Returned value by the challenged subject.
+* `definition`: A readable string of the matcher and any expected values.
 * `error`: Any possible raised exception.
 * `expected`: The expected value.
 * `got`: The result of the boolean comparison between the actual value and the expected value through the matcher.
 * `negate`: Evaluated to a negative assertion?
-* `matcher`: The symbol representing a matcher.
 * `level`: The requirement level (`:MUST`, `:SHOULD` or `:MAY`).
 
 #### Examples
@@ -74,7 +75,7 @@ The following parameters are required to instantiate the result:
 A passed expectation:
 
 ```ruby
-result = Expresenter.call(true).new(actual: "FOO", error: nil, expected: "foo", got: true, negate: true, matcher: :eql, level: :MUST)
+result = Expresenter.call(true).new(actual: "FOO", definition: 'eq "foo"', error: nil, expected: "foo", got: true, negate: true, level: :MUST)
 
 result.failed? # => false
 result.failure? # => false
@@ -87,20 +88,20 @@ result.passed? # => true
 result.negate? # => true
 result.error? # => false
 result.success? # => true
-result.inspect # => "Expresenter::Pass(actual: \"FOO\", error: nil, expected: \"foo\", got: true, matcher: :eql, negate: true, level: :MUST)"
-result.definition # => "eql \"foo\""
-result.summary # => "expected \"FOO\" not to eql \"foo\""
+result.inspect # => "Expresenter::Pass(actual: \"FOO\", definition: \"eq \\\"foo\\\"\", error: nil, expected: \"foo\", got: true, negate: true, level: :MUST)"
+result.definition # => "eq \"foo\""
+result.summary # => "expected \"FOO\" not to eq \"foo\""
 result.colored_char # => "\e[32m.\e[0m"
-result.colored_string # => "\e[32m\e[1mSuccess\e[22m: expected \"FOO\" not to eql \"foo\".\e[0m"
-result.message # => "Success: expected \"FOO\" not to eql \"foo\"."
-result.to_s # => "Success: expected \"FOO\" not to eql \"foo\"."
+result.colored_string # => "\e[32m\e[1mSuccess\e[22m: expected \"FOO\" not to eq \"foo\".\e[0m"
+result.message # => "Success: expected \"FOO\" not to eq \"foo\"."
+result.to_s # => "Success: expected \"FOO\" not to eq \"foo\"."
 result.titre # => "Success"
 ```
 
 A failed expectation:
 
 ```ruby
-result = Expresenter.call(false).new(actual: "foo", error: Exception.new("BOOM"), expected: 42, got: true, negate: true, matcher: :eql, level: :MUST)
+result = Expresenter.call(false).new(actual: "foo", definition: "eq 42", error: Exception.new("BOOM"), expected: 42, got: true, negate: true, level: :MUST)
 
 result.failed? # => true
 result.failure? # => false
@@ -113,8 +114,8 @@ result.passed? # => false
 result.negate? # => true
 result.error? # => true
 result.success? # => true
-result.inspect # => "Expresenter::Fail(actual: \"foo\", error: #<Exception: BOOM>, expected: 42, got: true, matcher: :eql, negate: true, level: :MUST)"
-result.definition # => "eql 42"
+result.inspect # => "Expresenter::Fail(actual: \"foo\", definition: \"eq 42\", error: #<Exception: BOOM>, expected: 42, got: true, negate: true, level: :MUST)"
+result.definition # => "eq 42"
 result.summary # => "BOOM"
 result.colored_char # => "\e[31mE\e[0m"
 result.colored_string # => "\e[31m\e[1mException\e[22m: BOOM.\e[0m"
@@ -130,19 +131,20 @@ To return the results which pass, and to raise the results which fail, the `with
 In this example, the result passes, the instance is therefore returned:
 
 ```ruby
-Expresenter.call(true).with(actual: "FOO", error: nil, expected: "foo", got: true, negate: true, matcher: :eql, level: :MUST) # => Expresenter::Pass(actual: "FOO", error: nil, expected: "foo", got: true, matcher: :eql, negate: true, level: :MUST)
+Expresenter.call(true).with(actual: "FOO", definition: 'eq "foo"', error: nil, expected: "foo", got: true, negate: true, level: :MUST) # => Expresenter::Pass(actual: "FOO", definition: "eq \"foo\"", error: nil, expected: "foo", got: true, negate: true, level: :MUST)
 ```
 
 In this example, the result fails, so the exception is raised:
 
 ```ruby
-Expresenter.call(false).with(actual: "foo", error: Exception.new("BOOM"), expected: 42, got: true, negate: true, matcher: :eql, level: :MUST)
+Expresenter.call(false).with(actual: "foo", definition: "eq 40", error: Exception.new("BOOM"), expected: 42, got: true, negate: true, level: :MUST)
 ```
 
 > Traceback (most recent call last):
->         3: from ./bin/console:7:in `<main>'
->         2: from (irb):1
->         1: from /Users/cyril/github/fixrb/expresenter/lib/expresenter/fail.rb:19:in `with'
+>         4: from ./bin/console:7:in `<main>'
+>         3: from (irb):42
+>         2: from (irb):43:in `rescue in irb_binding'
+>         1: from /Users/cyril/github/fixrb/expresenter/lib/expresenter/fail.rb:25:in `with'
 > Expresenter::Fail (Exception: BOOM.)
 
 ### More Examples
@@ -171,8 +173,3 @@ The [gem](https://rubygems.org/gems/expresenter) is available as open source und
     src="https://github.com/fixrb/expresenter/raw/main/img/sashite.png"
     alt="Sashite" /></a>
 </p>
-
-[gem]: https://rubygems.org/gems/expresenter
-[travis]: https://travis-ci.org/fixrb/expresenter
-[inchpages]: https://inch-ci.org/github/fixrb/expresenter
-[rubydoc]: https://rubydoc.info/gems/expresenter/frames

data/lib/expresenter.rb

@@ -3,7 +3,7 @@
 # Namespace for the Expresenter library.
 #
 # @example A passed expectation result presenter.
-#   Expresenter.call(true).with(actual: "FOO", error: nil, expected: "foo", got: true, negate: true, matcher: :eql, level: :MUST) # => Expresenter::Pass(actual: "FOO", error: nil, expected: "foo", got: true, matcher: :eql, negate: true, level: :MUST)
+#   Expresenter.call(true).with(actual: "FOO", definition: 'eql "foo"', error: nil, expected: "foo", got: true, negate: true, level: :MUST) # => Expresenter::Pass(actual: "FOO", definition: "eql \"foo\"", error: nil, expected: "foo", got: true, negate: true, level: :MUST)
 module Expresenter
   # @param is_passed [Boolean] The value of an assertion.
   #

data/lib/expresenter/common.rb

@@ -9,6 +9,9 @@ module Expresenter
     # @return [#object_id] Returned value by the challenged subject.
     attr_reader :actual
 
+    # @return [String] A readable string of the matcher and any expected values.
+    attr_reader :definition
+
     # @return [Exception, nil] Any possible raised exception.
     attr_reader :error
 
@@ -19,9 +22,6 @@ module Expresenter
     #   actual value and the expected value through the matcher.
     attr_reader :got
 
-    # @return [Symbol] The matcher.
-    attr_reader :matcher
-
     # @return [:MUST, :SHOULD, :MAY] The requirement level of the expectation.
     attr_reader :level
 
@@ -57,20 +57,13 @@ module Expresenter
     #
     # @return [String] The human-readable representation of the result.
     def inspect
-      "#{self.class}(actual: #{actual.inspect}, "     \
-                    "error: #{error.inspect}, "       \
-                    "expected: #{expected.inspect}, " \
-                    "got: #{got.inspect}, "           \
-                    "matcher: #{matcher.inspect}, "   \
-                    "negate: #{negate?.inspect}, "    \
-                    "level: #{level.inspect}"         \
-    end
-
-    # The readable definition.
-    #
-    # @return [String] A readable string of the definition.
-    def definition
-      [matcher.to_s.tr("_", " "), expected&.inspect].compact.join(SPACE)
+      "#{self.class}(actual: #{actual.inspect}, " \
+        "definition: #{definition.inspect}, "     \
+        "error: #{error.inspect}, "               \
+        "expected: #{expected.inspect}, "         \
+        "got: #{got.inspect}, "                   \
+        "negate: #{negate?.inspect}, "            \
+        "level: #{level.inspect})"
     end
 
     # The summary of the result.

data/lib/expresenter/fail.rb

@@ -27,22 +27,23 @@ module Expresenter
 
     # Initialize method.
     #
-    # @param actual   [#object_id] Returned value by the challenged subject.
-    # @param error    [Exception, nil] Any possible raised exception.
-    # @param expected [#object_id] The expected value.
-    # @param got      [Boolean, nil] The result of the boolean comparison
+    # @param actual     [#object_id] Returned value by the challenged subject.
+    # @param definition [String] A readable string of the matcher and any
+    #   expected values.
+    # @param error      [Exception, nil] Any possible raised exception.
+    # @param expected   [#object_id] The expected value.
+    # @param got        [Boolean, nil] The result of the boolean comparison
     #   between the actual value and the expected value through the matcher.
-    # @param negate   [Boolean] Evaluated to a negative assertion?
-    # @param matcher  [Symbol] The matcher.
-    # @param level    [:MUST, :SHOULD, :MAY] The requirement level.
-    def initialize(actual:, error:, expected:, got:, negate:, matcher:, level:)
-      @actual   = actual
-      @error    = error
-      @expected = expected
-      @got      = got
-      @negate   = negate
-      @matcher  = matcher
-      @level    = level
+    # @param negate     [Boolean] Evaluated to a negative assertion?
+    # @param level      [:MUST, :SHOULD, :MAY] The requirement level.
+    def initialize(actual:, definition:, error:, expected:, got:, negate:, level:)
+      @actual     = actual
+      @definition = definition
+      @error      = error
+      @expected   = expected
+      @got        = got
+      @negate     = negate
+      @level      = level
 
       super(to_s)
     end

data/lib/expresenter/pass.rb

@@ -36,21 +36,22 @@ module Expresenter
     # Initialize method.
     #
     # @param actual   [#object_id] Returned value by the challenged subject.
+    # @param definition [String] A readable string of the matcher and any
+    #   expected values.
     # @param error    [Exception, nil] Any possible raised exception.
     # @param expected [#object_id] The expected value.
     # @param got      [Boolean, nil] The result of the boolean comparison
     #   between the actual value and the expected value through the matcher.
     # @param negate   [Boolean] Evaluated to a negative assertion?
-    # @param matcher  [Symbol] The matcher.
     # @param level    [:MUST, :SHOULD, :MAY] The requirement level.
-    def initialize(actual:, error:, expected:, got:, negate:, matcher:, level:)
-      @actual   = actual
-      @error    = error
-      @expected = expected
-      @got      = got
-      @negate   = negate
-      @matcher  = matcher
-      @level    = level
+    def initialize(actual:, definition:, error:, expected:, got:, negate:, level:)
+      @actual     = actual
+      @definition = definition
+      @error      = error
+      @expected   = expected
+      @got        = got
+      @negate     = negate
+      @level      = level
     end
 
     # Did the test fail?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: expresenter
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-19 00:00:00.000000000 Z
+date: 2021-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: brutal