expresenter 1.1.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fa35d343813c6913d049086af460babf8a5a84b18c7058853fe956c50a3f143
-  data.tar.gz: cbcd35e730fd41b653b7ea944a3b2d0861229e204919747e60940074964aa97d
+  metadata.gz: 7681f55eec320e3a594a0dd3bf83bed059059c4fe0786c21702d100cdcff4686
+  data.tar.gz: 120bfa0781682b31af511528a1271118329745a0348e11a9508eb20daf55c082
 SHA512:
-  metadata.gz: 6d4e83fd46dc38ac64bae7ebf4577a0d964d11aa49e4ff88c573e294d943a3c450dc2212678b97d6976f7bc3850936db0df3f946b80da22e0d00615c76d48f97
-  data.tar.gz: 4ad82f7aa266fc139e166821a3b18766c24c50ef5ee92fad16f013d8b4240cfd6ea135e105606dab014ea9afffccb8036b669950d0b8254cf576913aa363dba1
+  metadata.gz: 9b9618acf9d062eacc9ac69ac3bca457fa6bbf7172baca826ee77f21365ef994e356fbf03b983fc39403a23fdecc7abdaa32ea4e5837a1260e5bf1696f8fb60c
+  data.tar.gz: 02a640a1f52ea92dce4e1fc8c88128142fb3ca9f2e14b811ba654008ce769f92c0d2137b88dd734a9bf91d8b68be758c0b6d862c3cf11d8b9aef4fc87bb02646

data/README.md

@@ -1,10 +1,10 @@
 # Expresenter
 
-[![Build Status](https://api.travis-ci.org/fixrb/expresenter.svg?branch=main)][travis]
-[![Code Climate](https://codeclimate.com/github/fixrb/expresenter/badges/gpa.svg)][codeclimate]
-[![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.
 
@@ -18,11 +18,15 @@ gem "expresenter"
 
 And then execute:
 
-    $ bundle
+```sh
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install expresenter
+```sh
+gem install expresenter
+```
 
 ## Usage
 
@@ -59,12 +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?
-* `valid`: Report if the test was `true` or `false`.
-* `matcher`: The symbol representing a matcher.
 * `level`: The requirement level (`:MUST`, `:SHOULD` or `:MAY`).
 
 #### Examples
@@ -72,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, valid: 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
@@ -85,44 +88,40 @@ result.passed? # => true
 result.negate? # => true
 result.error? # => false
 result.success? # => true
-result.valid? # => true
-result.inspect # => "Expresenter::Pass(actual: \"FOO\", error: nil, expected: \"foo\", got: true, matcher: :eql, negate: true, level: :MUST, valid: true)"
-result.definition # => "eql \"foo\""
-result.maybe_negate # => " not"
-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[32mSuccess: 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, valid: true, matcher: :eql, level: :MUST)
-
-actual.failed? # => true
-actual.failure? # => false
-actual.info? # => false
-actual.warning? # => false
-actual.to_sym # => :error
-actual.char # => "E"
-actual.emoji # => "💥"
-actual.passed? # => false
-actual.negate? # => true
-actual.error? # => true
-actual.success? # => true
-actual.valid? # => true
-actual.inspect # => "Expresenter::Fail(actual: \"foo\", error: #<Exception: BOOM>, expected: 42, got: true, matcher: :eql, negate: true, level: :MUST, valid: true)"
-actual.definition # => "eql 42"
-actual.maybe_negate # => " not"
-actual.summary # => "BOOM"
-actual.colored_char # => "\e[32mE\e[0m"
-actual.colored_string # => "\e[32mException: BOOM.\e[0m"
-actual.message # => "Exception: BOOM."
-actual.to_s # => "Exception: BOOM."
-actual.titre # => "Exception"
+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
+result.info? # => false
+result.warning? # => false
+result.to_sym # => :error
+result.char # => "E"
+result.emoji # => "💥"
+result.passed? # => false
+result.negate? # => true
+result.error? # => true
+result.success? # => true
+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"
+result.message # => "Exception: BOOM."
+result.to_s # => "Exception: BOOM."
+result.titre # => "Exception"
 ```
 
 ### Return or Raise
@@ -132,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, valid: true, matcher: :eql, level: :MUST) # => Expresenter::Pass(actual: "FOO", error: nil, expected: "foo", got: true, matcher: :eql, negate: true, level: :MUST, valid: true)
+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, valid: 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:12: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
@@ -157,19 +157,13 @@ A full list of unit tests can be viewed (and executed) here:
 * Home page: https://github.com/fixrb/expresenter
 * Bugs/issues: https://github.com/fixrb/expresenter/issues
 
-## Rubies
-
-* [MRI](https://www.ruby-lang.org/)
-* [Rubinius](https://rubinius.com/)
-* [JRuby](https://www.jruby.org/)
-
 ## Versioning
 
 __Expresenter__ follows [Semantic Versioning 2.0](https://semver.org/).
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The [gem](https://rubygems.org/gems/expresenter) is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 ***
 
@@ -179,9 +173,3 @@ The gem is available as open source under the terms of the [MIT License](https:/
     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
-[codeclimate]: https://codeclimate.com/github/fixrb/expresenter
-[inchpages]: https://inch-ci.org/github/fixrb/expresenter
-[rubydoc]: https://rubydoc.info/gems/expresenter/frames

data/lib/expresenter.rb

@@ -3,10 +3,12 @@
 # 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, valid: true, matcher: :eql, 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.
+  #
   # @return [Class<Pass>, Class<Fail>] The class of the result.
+  #
   # @example Get the pass class result.
   #   call(true) # => Pass
   def self.call(is_passed)

data/lib/expresenter/common.rb

@@ -3,9 +3,15 @@
 module Expresenter
   # Common collection of methods.
   module Common
+    # White space.
+    SPACE = " "
+
     # @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
 
@@ -16,9 +22,6 @@ module Expresenter
     #   actual value and the expected value through the matcher.
     attr_reader :got
 
-    # @return [#object_id] The matcher.
-    attr_reader :matcher
-
     # @return [:MUST, :SHOULD, :MAY] The requirement level of the expectation.
     attr_reader :level
 
@@ -50,40 +53,17 @@ module Expresenter
       got.equal?(true)
     end
 
-    # The value of the boolean comparison between the actual value and the
-    # expected value.
-    #
-    # @return [Boolean] The test was true or false?
-    def valid?
-      @valid
-    end
-
     # A string containing a human-readable representation of the result.
     #
     # @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}, "       \
-                    "valid: #{valid?.inspect})"       \
-    end
-
-    # The readable definition.
-    #
-    # @return [String] A readable string of the definition.
-    def definition
-      [matcher, expected&.inspect].compact.join(" ")
-    end
-
-    # The negation, if any.
-    #
-    # @return [String] The negation, or an empty string.
-    def maybe_negate
-      negate? ? " not" : ""
+      "#{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.
@@ -95,9 +75,9 @@ module Expresenter
       elsif actual.is_a?(::Exception)
         actual.message
       elsif actual == expected
-        "expected#{maybe_negate} to #{definition}"
+        ["expected", negation, "to", definition].compact.join(SPACE)
       else
-        "expected #{actual.inspect}#{maybe_negate} to #{definition}"
+        ["expected", actual.inspect, negation, "to", definition].compact.join(SPACE)
       end
     end
 
@@ -112,7 +92,7 @@ module Expresenter
     #
     # @return [String] A string representing the result.
     def colored_string
-      color(to_s)
+      color(to_bold_s)
     end
 
     # The representation of the result.
@@ -135,18 +115,18 @@ module Expresenter
 
     protected
 
-    def color(str)
-      if success?
-        "\e[32m#{str}\e[0m"
-      elsif info?
-        "\e[36m#{str}\e[0m"
-      elsif warning?
-        "\e[33m#{str}\e[0m"
-      elsif failure?
-        "\e[35m#{str}\e[0m"
-      else
-        "\e[31m#{str}\e[0m"
-      end
+    # The negation, if any.
+    #
+    # @return [String, nil] The negation, or an empty string.
+    def negation
+      "not" if negate?
+    end
+
+    # The representation of the result with the title in bold.
+    #
+    # @return [String] A string representing the result with the title in bold.
+    def to_bold_s
+      "\e[1m#{titre}\e[22m: #{summary}."
     end
   end
 end

data/lib/expresenter/fail.rb

@@ -5,6 +5,18 @@ require_relative "common"
 module Expresenter
   # The class that is responsible for reporting that an expectation is false.
   class Fail < ::StandardError
+    # Char representing a failure.
+    FAILURE_CHAR  = "F"
+
+    # Emoji representing a failure.
+    FAILURE_EMOJI = "❌"
+
+    # Char representing an error.
+    ERROR_CHAR    = "E"
+
+    # Emoji representing an error.
+    ERROR_EMOJI   = "💥"
+
     include Common
 
     # @param (see Fail#initialize)
@@ -15,26 +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 valid    [Boolean] Report if the test was true or false?
-    # @param matcher  [Symbol] The matcher.
-    # @param level    [:MUST, :SHOULD, :MAY] The requirement level.
-    def initialize(actual:, error:, expected:, got:, negate:, valid:,
-                   matcher:, level:)
-
-      @actual   = actual
-      @error    = error
-      @expected = expected
-      @got      = got
-      @negate   = negate
-      @valid    = valid
-      @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
@@ -83,9 +92,9 @@ module Expresenter
     # @return [String] The char that identify the result.
     def char
       if failure?
-        "F"
+        FAILURE_CHAR
       else
-        "E"
+        ERROR_CHAR
       end
     end
 
@@ -94,9 +103,19 @@ module Expresenter
     # @return [String] The emoji that identify the result.
     def emoji
       if failure?
-        "❌"
+        FAILURE_EMOJI
+      else
+        ERROR_EMOJI
+      end
+    end
+
+    protected
+
+    def color(str)
+      if failure?
+        "\e[35m#{str}\e[0m" # purple
       else
-        "💥"
+        "\e[31m#{str}\e[0m" # red
       end
     end
   end

data/lib/expresenter/pass.rb

@@ -5,6 +5,24 @@ require_relative "common"
 module Expresenter
   # The class that is responsible for reporting that an expectation is true.
   class Pass
+    # Char representing an info.
+    INFO_CHAR     = "I"
+
+    # Emoji representing an info.
+    INFO_EMOJI    = "💡"
+
+    # Char representing a success.
+    SUCCESS_CHAR  = "."
+
+    # Emoji representing a success.
+    SUCCESS_EMOJI = "✅"
+
+    # Char representing a warning.
+    WARNING_CHAR  = "W"
+
+    # Emoji representing a warning.
+    WARNING_EMOJI = "⚠️"
+
     include Common
 
     # @param (see Pass#initialize)
@@ -18,25 +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 valid    [Boolean] Report if the test was true or false?
-    # @param matcher  [Symbol] The matcher.
     # @param level    [:MUST, :SHOULD, :MAY] The requirement level.
-    def initialize(actual:, error:, expected:, got:, negate:, valid:,
-                   matcher:, level:)
-
-      @actual   = actual
-      @error    = error
-      @expected = expected
-      @got      = got
-      @negate   = negate
-      @valid    = valid
-      @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?
@@ -71,10 +86,13 @@ module Expresenter
     #
     # @return [Symbol] The identifier of the state.
     def to_sym
-      return :success if success?
-      return :warning if warning?
-
-      :info
+      if success?
+        :success
+      elsif warning?
+        :warning
+      else
+        :info
+      end
     end
 
     # Express the result with one char.
@@ -82,11 +100,11 @@ module Expresenter
     # @return [String] The char that identify the result.
     def char
       if success?
-        "."
+        SUCCESS_CHAR
       elsif warning?
-        "W"
+        WARNING_CHAR
       else
-        "I"
+        INFO_CHAR
       end
     end
 
@@ -95,11 +113,23 @@ module Expresenter
     # @return [String] The emoji that identify the result.
     def emoji
       if success?
-        "✅"
+        SUCCESS_EMOJI
+      elsif warning?
+        WARNING_EMOJI
+      else
+        INFO_EMOJI
+      end
+    end
+
+    protected
+
+    def color(str)
+      if success?
+        "\e[32m#{str}\e[0m" # green
       elsif warning?
-        "⚠️"
+        "\e[33m#{str}\e[0m" # yellow
       else
-        "💡"
+        "\e[36m#{str}\e[0m" # blue
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: expresenter
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-12 00:00:00.000000000 Z
+date: 2021-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: brutal
@@ -167,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Expectation result presenter.