spectus 3.1.4 → 3.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73306cc997a51543203fcfbec28fedae74de8ca9f382040db66d1c6aebbfc4bd
-  data.tar.gz: c9d9365b33cc4cca9cb54630306f9320c254a42ad64161d8a609107eeb8f95e3
+  metadata.gz: 99e857c2dbe2b02d961770b40bd9119fa115665105c99f0a6eb813266e9b72be
+  data.tar.gz: 6f54bf36215f3f662257cffd68e420051f83f6de13d15d9dca60ffb7e89b9c0f
 SHA512:
-  metadata.gz: 5cdfb58c6e5e3b748f8c5071f354793618a6e6e00053e3139175c5afde4cbc2fd39a419fbe516970354a6eaaee585637077d6dcc65b1d3ba7ae5412f26dcce60
-  data.tar.gz: 8211f7d6955d70067071a691bfa80b1f640930c01db4cec6433534141c3f7c7a4e386ee82c80f00941b3c6a04426d2266be7cdb416960e04c5e8a36b0f35bc95
+  metadata.gz: 5d6b1e7a99bc5d6b52760a8f5fa37f58d485bda7fbf08d9790f78944375d46807366cc9c0232f5f0bb25940b668f89b8a153b78940204ee8e0c54cdc371dacd4
+  data.tar.gz: 658aaa685fe75ea3fd06c92b0ddca3066efb841cf3c0aa4b252f7d2a9f797ea9f44791ff441bc72bfc76f95fd3f3c532a8b4a1b74e40ea832f6c72ffcbff9b3d

data/README.md

@@ -1,7 +1,6 @@
 # Spectus
 
 [![Build Status](https://api.travis-ci.org/fixrb/spectus.svg?branch=main)][travis]
-[![Code Climate](https://codeclimate.com/github/fixrb/spectus/badges/gpa.svg)][codeclimate]
 [![Gem Version](https://badge.fury.io/rb/spectus.svg)][gem]
 [![Inline docs](https://inch-ci.org/github/fixrb/spectus.svg?branch=main)][inchpages]
 [![Documentation](https://img.shields.io/:yard-docs-38c800.svg)][rubydoc]
@@ -18,69 +17,14 @@ gem "spectus"
 
 And then execute:
 
-    $ bundle
+```sh
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install spectus
-
-## Expectation
-
-An expectation is an assertion that is either `true` or `false`.
-
-There are several scenarios:
-
-| Requirement levels        | **MUST** | **SHOULD** | **MAY** |
-| ------------------------- | -------- | ---------- | ------- |
-| Implemented & Matched     | `true`   | `true`     | `true`  |
-| Implemented & Not matched | `false`  | `true`     | `false` |
-| Implemented & Exception   | `false`  | `false`    | `false` |
-| Not implemented           | `false`  | `false`    | `true`  |
-
-Thus,
-
-* when an assertion is `true`, a `Spectus::Result::Pass` instance is returned;
-* when an assertion is `false`, a `Spectus::Result::Fail` exception is raised.
-
-Both results share a common interface.
-
-Passed expectations can be classified as:
-
-* ✅ success
-* ⚠️ warning
-* 💡 info
-
-Failed expectations can be classified as:
-
-* ❌ failure
-* 💥 error
-
-## Code Isolation
-
-When executing expectations, side-effects may occur.
-Because they may or may not be desired, each requirement level has 2 versions:
-
-* if it does not end with `!`, its test is performed without isolation;
-* if it ends with `!`, its test is performed in isolation.
-
-Example of test without isolation:
-
-```ruby
-include Spectus
-greeting = "Hello, world!"
-it { greeting.gsub!("world", "Alice") }.MUST eql "Hello, Alice!"
-# => Spectus::Result::Pass(actual: "Hello, Alice!", error: nil, expected: "Hello, Alice!", got: true, matcher: :eql, negate: false, level: :MUST, valid: true)
-greeting # => "Hello, Alice!"
-```
-
-Example of test in isolation:
-
-```ruby
-include Spectus
-greeting = "Hello, world!"
-it { greeting.gsub!("world", "Alice") }.MUST! eql "Hello, Alice!"
-# => Spectus::Result::Pass(actual: "Hello, Alice!", error: nil, expected: "Hello, Alice!", got: true, matcher: :eql, negate: false, level: :MUST, valid: true)
-greeting # => "Hello, world!"
+```sh
+gem install spectus
 ```
 
 ## Usage
@@ -152,6 +96,34 @@ The optional `blank?` method is not implemented (unlike in [Ruby on Rails](https
 A full list of unit tests can be viewed (and executed) here:
 [./test.rb](https://github.com/fixrb/spectus/blob/main/test.rb)
 
+## Code Isolation
+
+When executing expectations, side-effects may occur.
+Because they may or may not be desired, each requirement level has 2 versions:
+
+* if it does not end with `!`, its test is performed without isolation;
+* if it ends with `!`, its test is performed in isolation.
+
+Example of test without isolation:
+
+```ruby
+include Spectus
+greeting = "Hello, world!"
+it { greeting.gsub!("world", "Alice") }.MUST eql "Hello, Alice!"
+# => Spectus::Result::Pass(actual: "Hello, Alice!", error: nil, expected: "Hello, Alice!", got: true, matcher: :eql, negate: false, level: :MUST, valid: true)
+greeting # => "Hello, Alice!"
+```
+
+Example of test in isolation:
+
+```ruby
+include Spectus
+greeting = "Hello, world!"
+it { greeting.gsub!("world", "Alice") }.MUST! eql "Hello, Alice!"
+# => Spectus::Result::Pass(actual: "Hello, Alice!", error: nil, expected: "Hello, Alice!", got: true, matcher: :eql, negate: false, level: :MUST, valid: true)
+greeting # => "Hello, world!"
+```
+
 ## Contact
 
 * Home page: https://github.com/fixrb/spectus
@@ -163,7 +135,7 @@ __Spectus__ 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/spectus) is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 ***
 
@@ -176,6 +148,5 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 [gem]: https://rubygems.org/gems/spectus
 [travis]: https://travis-ci.org/fixrb/spectus
-[codeclimate]: https://codeclimate.com/github/fixrb/spectus
 [inchpages]: https://inch-ci.org/github/fixrb/spectus
 [rubydoc]: https://rubydoc.info/gems/spectus/frames

data/lib/spectus/expectation_target.rb

@@ -19,11 +19,12 @@ module Spectus
     # definition is an absolute requirement of the specification.
     #
     # @example _Absolute requirement_ definition
-    #   it { 'foo'.upcase }.MUST eql 'FOO'
+    #   it { "foo".upcase }.MUST eql 'FOO'
     #
     # @param matcher [#matches?] The matcher.
     #
-    # @return [Result::Fail, Result::Pass] Report if the spec pass or fail.
+    # @return [Spectus::Result::Fail, Spectus::Result::Pass] Report if the spec
+    #   pass or fail.
     def MUST(matcher)
       RequirementLevel::Must.new(
         callable:   callable,
@@ -34,7 +35,7 @@ module Spectus
     end
 
     # @example _Absolute requirement_ definition with isolation
-    #   it { 'foo'.upcase }.MUST! eql 'FOO'
+    #   it { "foo".upcase }.MUST! eql 'FOO'
     #
     # @see MUST
     def MUST!(matcher)
@@ -50,11 +51,12 @@ module Spectus
     # definition is an absolute prohibition of the specification.
     #
     # @example _Absolute prohibition_ definition
-    #   it { 'foo'.size }.MUST_NOT equal 42
+    #   it { "foo".size }.MUST_NOT equal 42
     #
     # @param matcher [#matches?] The matcher.
     #
-    # @return [Result::Fail, Result::Pass] Report if the spec pass or fail.
+    # @return [Spectus::Result::Fail, Spectus::Result::Pass] Report if the spec
+    #   pass or fail.
     def MUST_NOT(matcher)
       RequirementLevel::Must.new(
         callable:   callable,
@@ -65,7 +67,7 @@ module Spectus
     end
 
     # @example _Absolute prohibition_ definition with isolation
-    #   it { 'foo'.size }.MUST_NOT! equal 42
+    #   it { "foo".size }.MUST_NOT! equal 42
     #
     # @see MUST_NOT
     def MUST_NOT!(matcher)
@@ -83,11 +85,12 @@ module Spectus
     # carefully weighed before choosing a different course.
     #
     # @example _Recommended_ definition
-    #   it { 'foo'.valid_encoding? }.SHOULD equal true
+    #   it { "foo".valid_encoding? }.SHOULD equal true
     #
     # @param matcher [#matches?] The matcher.
     #
-    # @return [Result::Fail, Result::Pass] Report if the spec pass or fail.
+    # @return [Spectus::Result::Fail, Spectus::Result::Pass] Report if the spec
+    #   pass or fail.
     def SHOULD(matcher)
       RequirementLevel::Should.new(
         callable:   callable,
@@ -98,7 +101,7 @@ module Spectus
     end
 
     # @example _Recommended_ definition with isolation
-    #   it { 'foo'.valid_encoding? }.SHOULD! equal true
+    #   it { "foo".valid_encoding? }.SHOULD! equal true
     #
     # @see SHOULD
     def SHOULD!(matcher)
@@ -117,11 +120,12 @@ module Spectus
     # before implementing any behavior described with this label.
     #
     # @example _Not recommended_ definition
-    #   it { ''.blank? }.SHOULD_NOT raise_exception NoMethodError
+    #   it { "".blank? }.SHOULD_NOT raise_exception NoMethodError
     #
     # @param matcher [#matches?] The matcher.
     #
-    # @return [Result::Fail, Result::Pass] Report if the spec pass or fail.
+    # @return [Spectus::Result::Fail, Spectus::Result::Pass] Report if the spec
+    #   pass or fail.
     def SHOULD_NOT(matcher)
       RequirementLevel::Should.new(
         callable:   callable,
@@ -132,7 +136,7 @@ module Spectus
     end
 
     # @example _Not recommended_ definition with isolation
-    #   it { ''.blank? }.SHOULD_NOT! raise_exception NoMethodError
+    #   it { "".blank? }.SHOULD_NOT! raise_exception NoMethodError
     #
     # @see SHOULD_NOT
     def SHOULD_NOT!(matcher)
@@ -157,11 +161,11 @@ module Spectus
     # option provides.)
     #
     # @example _Optional_ definition
-    #   it { 'foo'.bar }.MAY match /^foo$/
+    #   it { "foo".bar }.MAY match /^foo$/
     #
     # @param matcher [#matches?] The matcher.
     #
-    # @return [Result::Fail, Result::Pass] Report if the spec pass or fail.
+    # @return [Spectus::Result::Fail, Spectus::Result::Pass] Report if the spec pass or fail.
     def MAY(matcher)
       RequirementLevel::May.new(
         callable:   callable,
@@ -172,7 +176,7 @@ module Spectus
     end
 
     # @example _Optional_ definition with isolation
-    #   it { 'foo'.bar }.MAY! match /^foo$/
+    #   it { "foo".bar }.MAY! match /^foo$/
     #
     # @see MAY
     def MAY!(matcher)

data/lib/spectus/requirement_level/base.rb

@@ -32,18 +32,19 @@ module Spectus
 
       # The result of the expectation.
       #
-      # @raise [Result::Fail] The expectation is `false`.
-      # @return [Result::Pass] The expectation is `true`.
+      # @raise [Spectus::Result::Fail] The expectation is `false`.
+      # @return [Spectus::Result::Pass] The expectation is `true`.
       def call
-        Result.call(pass?,
-                    actual:   exam.actual,
-                    error:    exam.exception,
-                    expected: matcher.expected,
-                    got:      exam.got,
-                    negate:   negate?,
-                    valid:    exam.valid?,
-                    matcher:  matcher.class.to_sym,
-                    level:    level)
+        Result.call(pass?).with(
+          actual:   exam.actual,
+          error:    exam.exception,
+          expected: matcher.expected,
+          got:      exam.got,
+          negate:   negate?,
+          valid:    exam.valid?,
+          matcher:  matcher.class.to_sym,
+          level:    level
+        )
       end
 
       protected
@@ -64,5 +65,5 @@ module Spectus
   end
 end
 
-require_relative File.join("..", "result")
 require_relative File.join("..", "exam")
+require_relative File.join("..", "result")

data/lib/spectus/result.rb

@@ -3,10 +3,13 @@
 module Spectus
   # Namespace for the results.
   module Result
-    # @raise [Fail] A failed spec result.
-    # @return [Pass] A passed spec result.
-    def self.call(is_passed, **details)
-      (is_passed ? Pass : Fail).call(**details)
+    # @param is_passed [Boolean] The value of an assertion.
+    # @return [Class<Spectus::Result::Pass>, Class<Spectus::Result::Fail>] The
+    #   class of the result.
+    # @example Get the pass class result.
+    #   call(true) # => Pass
+    def self.call(is_passed)
+      is_passed ? Pass : Fail
     end
   end
 end

data/lib/spectus/result/fail.rb

@@ -1,74 +1,11 @@
 # frozen_string_literal: true
 
-require_relative "common"
+require "expresenter/fail"
 
 module Spectus
   module Result
     # The class that is responsible for reporting that the expectation is false.
-    class Fail < ::StandardError
-      include Common
-
-      # @raise [Fail] A failed spec result.
-      def self.call(**details)
-        raise new(**details)
-      end
-
-      # Did the test fail?
-      #
-      # @return [Boolean] The spec passed or failed?
-      def failed?
-        true
-      end
-
-      # The state of failure.
-      #
-      # @return [Boolean] The test was a failure?
-      def failure?
-        !error?
-      end
-
-      # The state of info.
-      #
-      # @return [Boolean] The test was an info?
-      def info?
-        false
-      end
-
-      # The state of warning.
-      #
-      # @return [Boolean] The test was a warning?
-      def warning?
-        false
-      end
-
-      # Identify the state of the result.
-      #
-      # @return [Symbol] The identifier of the state.
-      def to_sym
-        failure? ? :failure : :error
-      end
-
-      # Express the result with one char.
-      #
-      # @return [String] The char that identify the result.
-      def char
-        if failure?
-          "F"
-        else
-          "E"
-        end
-      end
-
-      # Express the result with one emoji.
-      #
-      # @return [String] The emoji that identify the result.
-      def emoji
-        if failure?
-          "❌"
-        else
-          "💥"
-        end
-      end
+    class Fail < ::Expresenter::Fail
     end
   end
 end

data/lib/spectus/result/pass.rb

@@ -1,83 +1,11 @@
 # frozen_string_literal: true
 
-require_relative "common"
+require "expresenter/pass"
 
 module Spectus
   module Result
     # The class that is responsible for reporting that the expectation is true.
-    class Pass
-      include Common
-
-      # @return [Pass] A passed spec result.
-      def self.call(**details)
-        new(**details)
-      end
-
-      alias message to_s
-
-      # Did the test fail?
-      #
-      # @return [Boolean] The spec passed or failed?
-      def failed?
-        false
-      end
-
-      # The state of failure.
-      #
-      # @return [Boolean] The test was a failure?
-      def failure?
-        false
-      end
-
-      # The state of info.
-      #
-      # @return [Boolean] The test was an info?
-      def info?
-        !error.nil?
-      end
-
-      # The state of warning.
-      #
-      # @return [Boolean] The test was a warning?
-      def warning?
-        got.equal?(false)
-      end
-
-      # Identify the state of the result.
-      #
-      # @return [Symbol] The identifier of the state.
-      def to_sym
-        return :success if success?
-        return :warning if warning?
-
-        :info
-      end
-
-      # Express the result with one char.
-      #
-      # @return [String] The char that identify the result.
-      def char
-        if success?
-          "."
-        elsif warning?
-          "W"
-        else
-          "I"
-        end
-      end
-
-      # Express the result with one emoji.
-      #
-      # @return [String] The emoji that identify the result.
-      def emoji
-        if success?
-          "✅"
-        elsif warning?
-          "⚠️"
-        else
-          "💡"
-        end
-      end
+    class Pass < ::Expresenter::Pass
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spectus
 version: !ruby/object:Gem::Version
-  version: 3.1.4
+  version: 3.3.3
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-11 00:00:00.000000000 Z
+date: 2021-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: defi
@@ -16,28 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.4
+        version: 2.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.4
+        version: 2.0.5
+- !ruby/object:Gem::Dependency
+  name: expresenter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: matchi
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.0.2
 - !ruby/object:Gem::Dependency
   name: brutal
   requirement: !ruby/object:Gem::Requirement
@@ -180,7 +194,6 @@ files:
 - lib/spectus/requirement_level/must.rb
 - lib/spectus/requirement_level/should.rb
 - lib/spectus/result.rb
-- lib/spectus/result/common.rb
 - lib/spectus/result/fail.rb
 - lib/spectus/result/pass.rb
 homepage: https://github.com/fixrb/spectus
@@ -202,7 +215,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 library with RFC 2119's requirement levels \U0001F6A5"

data/lib/spectus/result/common.rb

@@ -1,180 +0,0 @@
-# frozen_string_literal: true
-
-module Spectus
-  module Result
-    # Common collection of methods for Result's classes.
-    module Common
-      # @return [#object_id] Returned value by the challenged subject.
-      attr_reader :actual
-
-      # @return [Exception, nil] Any possible raised exception.
-      attr_reader :error
-
-      # @return [#object_id] The expected value.
-      attr_reader :expected
-
-      # @return [#object_id] The result of the boolean comparison between the
-      #   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
-
-      # Common 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
-      #   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
-
-        super(to_s) if failed?
-      end
-
-      # Did the test pass?
-      #
-      # @return [Boolean] The spec passed or failed?
-      def passed?
-        !failed?
-      end
-
-      # The value of the negate instance variable.
-      #
-      # @return [Boolean] Evaluated to a negative assertion?
-      def negate?
-        @negate
-      end
-
-      # The state of error.
-      #
-      # @return [Boolean] The test raised an error?
-      def error?
-        !error.nil?
-      end
-
-      # The state of success.
-      #
-      # @return [Boolean] The test was a success?
-      def success?
-        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" : ""
-      end
-
-      # The summary of the result.
-      #
-      # @return [String] A string representing the summary of the result.
-      def summary
-        if error?
-          error.message
-        elsif actual.is_a?(::Exception)
-          actual.message
-        elsif actual == expected
-          "expected#{maybe_negate} to #{definition}"
-        else
-          "expected #{actual.inspect}#{maybe_negate} to #{definition}"
-        end
-      end
-
-      # Express the result with one colored char.
-      #
-      # @return [String] The colored char that identify the result.
-      def colored_char
-        color(char)
-      end
-
-      # The colored string representation of the result.
-      #
-      # @return [String] A string representing the result.
-      def colored_string
-        color(to_s)
-      end
-
-      # The representation of the result.
-      #
-      # @return [String] A string representing the result.
-      def to_s
-        "#{titre}: #{summary}."
-      end
-
-      # Titre for the result.
-      #
-      # @return [String] A string representing the titre.
-      def titre
-        if error?
-          error.class.name
-        else
-          to_sym.to_s.capitalize
-        end
-      end
-
-      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
-      end
-    end
-  end
-end