expresenter 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3d9ca739d1a34b11ea226e77c5c3e5110ca38fb8d3f3d16b9497c69233d4447
-  data.tar.gz: a1678358865fb1a8441c9e0837bc3fe1ff683edb9dc9ffa4b4f4d44e56a27696
+  metadata.gz: b293c0c6ffd15b336c00fcc841647e6d244623346dd86ab6cf319c05cfc7d909
+  data.tar.gz: 3901ec01f1277302150665002b97c157ba26846bf08e344bd364fbb7fdec874d
 SHA512:
-  metadata.gz: 7d6d061a3d4b0d7027cc096610dad1d2e2dbdb73aab181493567f51dc81f27210e5cf05e4e1dab6255583d7ee2a563abda6d320fe9f6655dfd6e93bf8fa4fc26
-  data.tar.gz: b737a22e6218ae12a67540360b19086f997d01f1a2d9f57bd0a4eb2ad7a978f7d83de078ade37241bcf86c1fa0102eaed374094eb053683fe50f804197bd3083
+  metadata.gz: db88b4f5c706ae1aaf48fdf6b2b45aa0ab4d0fe1f5a557331e51b8b9c9333f07305ec1f6d5f3287a34ed39e20396fd2d4879f5b186e94e9653420604a1d2ca3d
+  data.tar.gz: 04c1db7b8ea904a67397305f111bde2e4dadac40c6cdd392cb855b3b4db24a8ae904c92cfe07332cdc137cceea57481d9d920803941722b3e8749db16d0b346b

data/README.md

@@ -66,7 +66,6 @@ The following parameters are required to instantiate the result:
 * `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`).
 
@@ -75,7 +74,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", error: nil, expected: "foo", got: true, negate: true, matcher: :eql, level: :MUST)
 
 result.failed? # => false
 result.failure? # => false
@@ -88,8 +87,7 @@ 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.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.colored_char # => "\e[32m.\e[0m"
@@ -102,7 +100,7 @@ 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)
+result = Expresenter.call(false).new(actual: "foo", error: Exception.new("BOOM"), expected: 42, got: true, negate: true, matcher: :eql, level: :MUST)
 
 result.failed? # => true
 result.failure? # => false
@@ -115,8 +113,7 @@ result.passed? # => false
 result.negate? # => true
 result.error? # => true
 result.success? # => true
-result.valid? # => true
-result.inspect # => "Expresenter::Fail(actual: \"foo\", error: #<Exception: BOOM>, expected: 42, got: true, matcher: :eql, negate: true, level: :MUST, valid: 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.summary # => "BOOM"
 result.colored_char # => "\e[31mE\e[0m"
@@ -133,13 +130,13 @@ 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", 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)
 ```
 
 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", error: Exception.new("BOOM"), expected: 42, got: true, negate: true, matcher: :eql, level: :MUST)
 ```
 
 > Traceback (most recent call last):

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::Pass(actual: "FOO", error: nil, expected: "foo", got: true, matcher: :eql, negate: true, level: :MUST, valid: true)
+#   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)
 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,6 +3,7 @@
 module Expresenter
   # Common collection of methods.
   module Common
+    # White space.
     SPACE = " "
 
     # @return [#object_id] Returned value by the challenged subject.
@@ -52,14 +53,6 @@ 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.
@@ -70,8 +63,7 @@ module Expresenter
                     "got: #{got.inspect}, "           \
                     "matcher: #{matcher.inspect}, "   \
                     "negate: #{negate?.inspect}, "    \
-                    "level: #{level.inspect}, "       \
-                    "valid: #{valid?.inspect})"       \
+                    "level: #{level.inspect}"         \
     end
 
     # The readable definition.

data/lib/expresenter/fail.rb

@@ -5,10 +5,16 @@ 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
@@ -27,18 +33,14 @@ module Expresenter
     # @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:)
-
+    def initialize(actual:, error:, expected:, got:, negate:, matcher:, level:)
       @actual   = actual
       @error    = error
       @expected = expected
       @got      = got
       @negate   = negate
-      @valid    = valid
       @matcher  = matcher
       @level    = level
 

data/lib/expresenter/pass.rb

@@ -5,13 +5,22 @@ 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
@@ -32,18 +41,14 @@ module Expresenter
     # @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:)
-
+    def initialize(actual:, error:, expected:, got:, negate:, matcher:, level:)
       @actual   = actual
       @error    = error
       @expected = expected
       @got      = got
       @negate   = negate
-      @valid    = valid
       @matcher  = matcher
       @level    = level
     end

metadata

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