expresenter 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fa35d343813c6913d049086af460babf8a5a84b18c7058853fe956c50a3f143
-  data.tar.gz: cbcd35e730fd41b653b7ea944a3b2d0861229e204919747e60940074964aa97d
+  metadata.gz: 3460d51122770c7fdd769a71726f8ac91f7ee55d2a97008aac27137aaeb09a43
+  data.tar.gz: 2dfe5bac23440dd3a48e75d103da7dd3e12809936f7d3df02a299d7023328286
 SHA512:
-  metadata.gz: 6d4e83fd46dc38ac64bae7ebf4577a0d964d11aa49e4ff88c573e294d943a3c450dc2212678b97d6976f7bc3850936db0df3f946b80da22e0d00615c76d48f97
-  data.tar.gz: 4ad82f7aa266fc139e166821a3b18766c24c50ef5ee92fad16f013d8b4240cfd6ea135e105606dab014ea9afffccb8036b669950d0b8254cf576913aa363dba1
+  metadata.gz: d50f24c95d16d6417422c15c060c81b42d9e77f9426c3c7466c066f13f9de76a4e1f1c7dd73c70485e099b20a3e05c94c07c4c640fd796c1d927a217d764acfe
+  data.tar.gz: 7f8c9d1c7e6979766be2600d1db0b630ff9ab377f9223e5d8e8b4e874dfb6bd57ec3326a0c16fbf416034c7307c2b056d18bb8b151bdb32edbdd4763e919d427

data/README.md

@@ -1,7 +1,6 @@
 # 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]
@@ -18,11 +17,15 @@ gem "expresenter"
 
 And then execute:
 
-    $ bundle
+```sh
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install expresenter
+```sh
+gem install expresenter
+```
 
 ## Usage
 
@@ -88,10 +91,9 @@ 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.colored_char # => "\e[32m.\e[0m"
-result.colored_string # => "\e[32mSuccess: expected \"FOO\" not to eql \"foo\".\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.titre # => "Success"
@@ -102,27 +104,26 @@ 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.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.valid? # => true
+result.inspect # => "Expresenter::Fail(actual: \"foo\", error: #<Exception: BOOM>, expected: 42, got: true, matcher: :eql, negate: true, level: :MUST, valid: true)"
+result.definition # => "eql 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
@@ -144,7 +145,7 @@ Expresenter.call(false).with(actual: "foo", error: Exception.new("BOOM"), expect
 > 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'
+>         1: from /Users/cyril/github/fixrb/expresenter/lib/expresenter/fail.rb:19:in `with'
 > Expresenter::Fail (Exception: BOOM.)
 
 ### More Examples
@@ -157,19 +158,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).
 
 ***
 
@@ -182,6 +177,5 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 [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/common.rb

@@ -3,6 +3,8 @@
 module Expresenter
   # Common collection of methods.
   module Common
+    SPACE = " "
+
     # @return [#object_id] Returned value by the challenged subject.
     attr_reader :actual
 
@@ -76,14 +78,7 @@ module Expresenter
     #
     # @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" : ""
+      [matcher, expected&.inspect].compact.join(SPACE)
     end
 
     # The summary of the result.
@@ -95,9 +90,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 +107,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 +130,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,12 @@ require_relative "common"
 module Expresenter
   # The class that is responsible for reporting that an expectation is false.
   class Fail < ::StandardError
+    FAILURE_CHAR  = "F"
+    FAILURE_EMOJI = "❌"
+
+    ERROR_CHAR    = "E"
+    ERROR_EMOJI   = "💥"
+
     include Common
 
     # @param (see Fail#initialize)
@@ -83,9 +89,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 +100,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,15 @@ require_relative "common"
 module Expresenter
   # The class that is responsible for reporting that an expectation is true.
   class Pass
+    INFO_CHAR     = "I"
+    INFO_EMOJI    = "💡"
+
+    SUCCESS_CHAR  = "."
+    SUCCESS_EMOJI = "✅"
+
+    WARNING_CHAR  = "W"
+    WARNING_EMOJI = "⚠️"
+
     include Common
 
     # @param (see Pass#initialize)
@@ -71,10 +80,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 +94,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 +107,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.2.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-12 00:00:00.000000000 Z
+date: 2021-05-30 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.