spectus 3.1.1 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1134fea1ff1f7050cf3d31bff77f305a56aab47dc104ac0a3507d29624d792e
-  data.tar.gz: e7e48de3820fb930b7e6a1069448290f0b3aea5e5a6872460ac4a9f24b29559b
+  metadata.gz: 91207456a98d2640cdeb0dbf52ce04c532f72060c904aa15474f2eb86eb67481
+  data.tar.gz: 26e7073807fa4bb734eb8e349682c41d2b23bd83c11012818ce443b5615089e3
 SHA512:
-  metadata.gz: 0efec970b35a265413175c6e9d513e549c61293018b102bbfb2299485ba7a73e96cb964013fe5652025c5b462464b55430c525eac87a8a4da3485db57e5f3b15
-  data.tar.gz: c84b2d084f6cd68086ffdd36c81df6a8b2cbcf9e6777a51d1480e048b1afc4a862bda2cf6f268ed81cd10fb1f746019bd7616a372b3394a02675c17307cb1a78
+  metadata.gz: '018827c15c82d74b1af062e57768809c89f6ad18e2b389b4150ae318f12fdbadd6709eff232483d67a7e9aa0234d008ade347503066b78c522f7291fa515f809'
+  data.tar.gz: a57c6cfaf4b7292ca768fc309e61a025d85de984cf62af8f0a88c0b37d58189732babf03e3a8a6eed208838518af088d1d53448cc5c6c71842db1e52f0c60ab7

data/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014-2019 Cyril Kato
+Copyright (c) 2014-2021 Cyril Kato
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,9 +1,9 @@
 # Spectus
 
-[![Build Status](https://api.travis-ci.org/fixrb/spectus.svg?branch=master)][travis]
+[![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=master)][inchpages]
+[![Inline docs](https://inch-ci.org/github/fixrb/spectus.svg?branch=main)][inchpages]
 [![Documentation](https://img.shields.io/:yard-docs-38c800.svg)][rubydoc]
 
 > Expectation library with [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt)'s requirement levels 🚥
@@ -13,7 +13,7 @@
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'spectus'
+gem "spectus"
 ```
 
 And then execute:
@@ -24,57 +24,6 @@ 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 expectation is `true`, a `Spectus::Result::Pass` instance is returned;
-* when an expectation is `false`, a `Spectus::Result::Fail` exception is raised.
-
-Both results share a common interface, and can be classified respectively as:
-
-* a ✅ _success_, a ⚠️ _warning_ or an 💡 _info_;
-* a ❌ _failure_ or an 💥 _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!"
-```
-
 ## Usage
 
 To begin with, let's include __Spectus__:
@@ -88,7 +37,7 @@ include Spectus
 Given the "`ルビー`" object, when it receives `valid_encoding?` method, then it **MUST** be `true`:
 
 ```ruby
-it { 'ルビー'.valid_encoding? }.MUST be_true
+it { "ルビー".valid_encoding? }.MUST be_true
 # => Spectus::Result::Pass(actual: true, error: nil, expected: nil, got: true, matcher: :be_true, negate: false, level: :MUST, valid: true)
 ```
 
@@ -99,7 +48,7 @@ The result of the test shows that the spec passed.
 Given the "`foo`" object, when it receives `length` method, then it **MUST NOT** raise the `NoMethodError` exception:
 
 ```ruby
-it { 'foo'.length }.MUST_NOT raise_exception NoMethodError
+it { "foo".length }.MUST_NOT raise_exception NoMethodError
 # => Spectus::Result::Pass(actual: 3, error: nil, expected: NoMethodError, got: true, matcher: :raise_exception, negate: true, level: :MUST, valid: true)
 ```
 
@@ -122,7 +71,7 @@ However, because there isn't any exception, the result of the test shows that th
 Given the "`1`" object, when it receives `+(1)` method, then it **SHOULD NOT** return the "`11`" value:
 
 ```ruby
-it { '1' + 1 }.SHOULD_NOT eql '11'
+it { "1" + 1 }.SHOULD_NOT eql "11"
 # raise Spectus::Result::Fail(actual: nil, error: #<TypeError: no implicit conversion of Integer into String>, expected: "11", got: nil, matcher: :eql, negate: true, level: :SHOULD, valid: false)
 ```
 
@@ -133,7 +82,7 @@ There was a `TypeError` exception, the result of the test shows that the spec fa
 Given the "`foo`" object, when it receives `blank?` method, then it **MAY** be `false`:
 
 ```ruby
-it { 'foo'.blank? }.MAY be_false
+it { "foo".blank? }.MAY be_false
 # => Spectus::Result::Pass(actual: nil, error: #<NoMethodError: undefined method `blank?' for "foo":String>, expected: nil, got: nil, matcher: :be_false, negate: false, level: :MAY, valid: false)
 ```
 
@@ -141,20 +90,42 @@ The optional `blank?` method is not implemented (unlike in [Ruby on Rails](https
 
 ### More Examples
 
-An exhaustive list of examples can also be viewed here:
-[test.rb](https://github.com/fixrb/spectus/blob/master/test.rb)
+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
 * Bugs/issues: https://github.com/fixrb/spectus/issues
 
-## Rubies
-
-* [MRI](https://www.ruby-lang.org/)
-* [Rubinius](https://rubinius.com/)
-* [JRuby](https://www.jruby.org/)
-
 ## Versioning
 
 __Spectus__ follows [Semantic Versioning 2.0](https://semver.org/).
@@ -168,7 +139,7 @@ The gem is available as open source under the terms of the [MIT License](https:/
 <p>
   This project is sponsored by:<br />
   <a href="https://sashite.com/"><img
-    src="https://github.com/fixrb/spectus/raw/master/img/sashite.png"
+    src="https://github.com/fixrb/spectus/raw/main/img/sashite.png"
     alt="Sashite" /></a>
 </p>
 

data/lib/spectus.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'matchi/helper'
+require "matchi/helper"
 
 # Namespace for the Spectus library.
 #
@@ -23,4 +23,4 @@ module Spectus
   end
 end
 
-require_relative File.join('spectus', 'expectation_target')
+require_relative File.join("spectus", "expectation_target")

data/lib/spectus/exam.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'defi'
+require "defi"
 
 module Spectus
   # This class evaluate the expectation with the passed block.

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)
@@ -193,6 +197,6 @@ module Spectus
   end
 end
 
-require_relative File.join('requirement_level', 'must')
-require_relative File.join('requirement_level', 'should')
-require_relative File.join('requirement_level', 'may')
+require_relative File.join("requirement_level", "must")
+require_relative File.join("requirement_level", "should")
+require_relative File.join("requirement_level", "may")

data/lib/spectus/requirement_level/base.rb

@@ -32,26 +32,10 @@ module Spectus
 
       # The result of the expectation.
       #
-      # @return [Result::Fail, Result::Pass] The test result.
+      # @raise [Spectus::Result::Fail] The expectation is `false`.
+      # @return [Spectus::Result::Pass] The expectation is `true`.
       def call
-        pass? ? pass! : fail!
-      end
-
-      protected
-
-      # @return [Result::Pass] A passed spec result.
-      def pass!
-        Result::Pass.new(**details)
-      end
-
-      # @raise [Result::Fail] A failed spec result.
-      def fail!
-        raise Result::Fail.new(**details)
-      end
-
-      # @return [Hash] List of parameters.
-      def details
-        {
+        Result.call(pass?).with(
           actual:   exam.actual,
           error:    exam.exception,
           expected: matcher.expected,
@@ -60,12 +44,14 @@ module Spectus
           valid:    exam.valid?,
           matcher:  matcher.class.to_sym,
           level:    level
-        }
+        )
       end
 
+      protected
+
       # @return [Symbol] The requirement level.
       def level
-        self.class.name.split('::').fetch(-1).upcase.to_sym
+        self.class.name.split("::").fetch(-1).upcase.to_sym
       end
 
       # @note The boolean comparison between the actual value and the expected
@@ -79,6 +65,5 @@ module Spectus
   end
 end
 
-require_relative File.join('..', 'exam')
-require_relative File.join('..', 'result', 'fail')
-require_relative File.join('..', 'result', 'pass')
+require_relative File.join("..", "exam")
+require_relative File.join("..", "result")

data/lib/spectus/requirement_level/may.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'must'
+require_relative "must"
 
 module Spectus
   module RequirementLevel

data/lib/spectus/requirement_level/must.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'base'
+require_relative "base"
 
 module Spectus
   module RequirementLevel

data/lib/spectus/requirement_level/should.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'must'
+require_relative "must"
 
 module Spectus
   module RequirementLevel

data/lib/spectus/result.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Spectus
+  # Namespace for the results.
+  module Result
+    # @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
+
+require_relative File.join("result", "fail")
+require_relative File.join("result", "pass")

data/lib/spectus/result/fail.rb

@@ -1,76 +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
-
-      # Did the test fail?
-      #
-      # @return [Boolean] The spec passed or failed?
-      def failed?
-        true
-      end
-
-      # Did the test pass?
-      #
-      # @return [Boolean] The spec passed or failed?
-      def passed?
-        !failed?
-      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,85 +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
-
-      alias message to_s
-
-      # Did the test fail?
-      #
-      # @return [Boolean] The spec passed or failed?
-      def failed?
-        false
-      end
-
-      # Did the test pass?
-      #
-      # @return [Boolean] The spec passed or failed?
-      def passed?
-        !failed?
-      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.1
+  version: 3.3.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-30 00:00:00.000000000 Z
+date: 2021-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: defi
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.3
+        version: 2.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.3
+        version: 2.0.4
+- !ruby/object:Gem::Dependency
+  name: expresenter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: matchi
   requirement: !ruby/object:Gem::Requirement
@@ -42,46 +56,46 @@ dependencies:
   name: brutal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-md
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -108,34 +122,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-thread_safety
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
 description: "Expectation library with RFC 2119's requirement levels \U0001F6A5"
 email: contact@cyril.email
 executables: []
@@ -151,7 +193,7 @@ files:
 - lib/spectus/requirement_level/may.rb
 - lib/spectus/requirement_level/must.rb
 - lib/spectus/requirement_level/should.rb
-- lib/spectus/result/common.rb
+- lib/spectus/result.rb
 - lib/spectus/result/fail.rb
 - lib/spectus/result/pass.rb
 homepage: https://github.com/fixrb/spectus
@@ -173,7 +215,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: "Expectation library with RFC 2119's requirement levels \U0001F6A5"

data/lib/spectus/result/common.rb

@@ -1,174 +0,0 @@
-# frozen_string_literal: true
-
-module Spectus
-  # Namespace for the results.
-  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
-
-      # 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