spectus 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7979abd1117a7e7320e221ef8723e818f7e1b3f8f7ac05e8913f65fdb2a7c615
-  data.tar.gz: b163fee339e12eec5712802159f361558f596ffa720cc87ccb26822883c40c36
+  metadata.gz: 91207456a98d2640cdeb0dbf52ce04c532f72060c904aa15474f2eb86eb67481
+  data.tar.gz: 26e7073807fa4bb734eb8e349682c41d2b23bd83c11012818ce443b5615089e3
 SHA512:
-  metadata.gz: d4970d21d63e784d7257472a9ccee1f3d33f31e61d79030239a620a5a2f8569d039672c35429aa42c8db4c55c184f3bd7512921fb08246ad03ceed9b48b53b71
-  data.tar.gz: a41655c8c03ed03650677d8eae4d1fc4bb412bf4a4a66bc5076950181a6f6c9d123cd74f5a90127299d835f9249d07343463804bdbf276b8ad854c14bf0539c5
+  metadata.gz: '018827c15c82d74b1af062e57768809c89f6ad18e2b389b4150ae318f12fdbadd6709eff232483d67a7e9aa0234d008ade347503066b78c522f7291fa515f809'
+  data.tar.gz: a57c6cfaf4b7292ca768fc309e61a025d85de984cf62af8f0a88c0b37d58189732babf03e3a8a6eed208838518af088d1d53448cc5c6c71842db1e52f0c60ab7

data/README.md

@@ -38,7 +38,7 @@ Given the "`ルビー`" object, when it receives `valid_encoding?` method, then
 
 ```ruby
 it { "ルビー".valid_encoding? }.MUST be_true
-# => Expresenter::Pass(actual: true, error: nil, expected: nil, got: true, matcher: :be_true, negate: false, level: :MUST, valid: true)
+# => Spectus::Result::Pass(actual: true, error: nil, expected: nil, got: true, matcher: :be_true, negate: false, level: :MUST, valid: true)
 ```
 
 The result of the test shows that the spec passed.
@@ -49,7 +49,7 @@ Given the "`foo`" object, when it receives `length` method, then it **MUST NOT**
 
 ```ruby
 it { "foo".length }.MUST_NOT raise_exception NoMethodError
-# => Expresenter::Pass(actual: 3, error: nil, expected: NoMethodError, got: true, matcher: :raise_exception, negate: true, level: :MUST, valid: true)
+# => Spectus::Result::Pass(actual: 3, error: nil, expected: NoMethodError, got: true, matcher: :raise_exception, negate: true, level: :MUST, valid: true)
 ```
 
 The result of the test shows that the spec passed.
@@ -60,7 +60,7 @@ Given the `BasicObject` object, when it receives `superclass` method, then it **
 
 ```ruby
 it { BasicObject.superclass }.SHOULD equal NilClass
-# => Expresenter::Pass(actual: nil, error: nil, expected: NilClass, got: false, matcher: :equal, negate: false, level: :SHOULD, valid: false)
+# => Spectus::Result::Pass(actual: nil, error: nil, expected: NilClass, got: false, matcher: :equal, negate: false, level: :SHOULD, valid: false)
 ```
 
 Instead of the expected `NilClass` class, its sole instance (which is `nil`) was returned.
@@ -72,7 +72,7 @@ Given the "`1`" object, when it receives `+(1)` method, then it **SHOULD NOT** r
 
 ```ruby
 it { "1" + 1 }.SHOULD_NOT eql "11"
-# raise Expresenter::Fail(actual: nil, error: #<TypeError: no implicit conversion of Integer into String>, expected: "11", got: nil, matcher: :eql, negate: true, level: :SHOULD, valid: false)
+# 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)
 ```
 
 There was a `TypeError` exception, the result of the test shows that the spec failed.
@@ -83,7 +83,7 @@ Given the "`foo`" object, when it receives `blank?` method, then it **MAY** be `
 
 ```ruby
 it { "foo".blank? }.MAY be_false
-# => Expresenter::Pass(actual: nil, error: #<NoMethodError: undefined method `blank?' for "foo":String>, expected: nil, got: nil, matcher: :be_false, negate: false, level: :MAY, valid: 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)
 ```
 
 The optional `blank?` method is not implemented (unlike in [Ruby on Rails](https://api.rubyonrails.org/classes/Object.html#method-i-blank-3F), for instance), so the result of the test shows that the spec passed.
@@ -107,7 +107,7 @@ Example of test without isolation:
 include Spectus
 greeting = "Hello, world!"
 it { greeting.gsub!("world", "Alice") }.MUST eql "Hello, Alice!"
-# => Expresenter::Pass(actual: "Hello, Alice!", error: nil, expected: "Hello, Alice!", got: true, matcher: :eql, negate: false, level: :MUST, valid: true)
+# => Spectus::Result::Pass(actual: "Hello, Alice!", error: nil, expected: "Hello, Alice!", got: true, matcher: :eql, negate: false, level: :MUST, valid: true)
 greeting # => "Hello, Alice!"
 ```
 
@@ -117,7 +117,7 @@ Example of test in isolation:
 include Spectus
 greeting = "Hello, world!"
 it { greeting.gsub!("world", "Alice") }.MUST! eql "Hello, Alice!"
-# => Expresenter::Pass(actual: "Hello, Alice!", error: nil, expected: "Hello, Alice!", got: true, matcher: :eql, negate: false, level: :MUST, valid: true)
+# => Spectus::Result::Pass(actual: "Hello, Alice!", error: nil, expected: "Hello, Alice!", got: true, matcher: :eql, negate: false, level: :MUST, valid: true)
 greeting # => "Hello, world!"
 ```
 

data/lib/spectus.rb

@@ -6,14 +6,14 @@ require "matchi/helper"
 #
 # @example It MUST equal 42.
 #   require 'spectus'
-#   it { 42 }.MUST equal 42 # => #<Expresenter::Pass...>
+#   it { 42 }.MUST equal 42 # => #<Spectus::Result::Pass...>
 module Spectus
   include ::Matchi::Helper
 
   # Expectations are built with this method.
   #
   # @example An _absolute requirement_ definition.
-  #   it { 42 }.MUST equal 42 # => #<Expresenter::Pass...>
+  #   it { 42 }.MUST equal 42 # => #<Spectus::Result::Pass...>
   #
   # @param input [Proc] The code to test.
   #

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 [Expresenter::Fail, Expresenter::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 [Expresenter::Fail, Expresenter::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 [Expresenter::Fail, Expresenter::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 [Expresenter::Fail, Expresenter::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 [Expresenter::Fail, Expresenter::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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "expresenter"
-
 module Spectus
   # Namespace for the requirement levels.
   module RequirementLevel
@@ -34,10 +32,10 @@ module Spectus
 
       # The result of the expectation.
       #
-      # @raise [Expresenter::Fail] The expectation is `false`.
-      # @return [Expresenter::Pass] The expectation is `true`.
+      # @raise [Spectus::Result::Fail] The expectation is `false`.
+      # @return [Spectus::Result::Pass] The expectation is `true`.
       def call
-        ::Expresenter.call(pass?).with(
+        Result.call(pass?).with(
           actual:   exam.actual,
           error:    exam.exception,
           expected: matcher.expected,
@@ -68,3 +66,4 @@ module Spectus
 end
 
 require_relative File.join("..", "exam")
+require_relative File.join("..", "result")

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "expresenter/fail"
+
+module Spectus
+  module Result
+    # The class that is responsible for reporting that the expectation is false.
+    class Fail < ::Expresenter::Fail
+    end
+  end
+end

data/lib/spectus/result/pass.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "expresenter/pass"
+
+module Spectus
+  module Result
+    # The class that is responsible for reporting that the expectation is true.
+    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.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-11 00:00:00.000000000 Z
+date: 2021-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: defi
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: matchi
   requirement: !ruby/object:Gem::Requirement
@@ -193,6 +193,9 @@ files:
 - lib/spectus/requirement_level/may.rb
 - lib/spectus/requirement_level/must.rb
 - lib/spectus/requirement_level/should.rb
+- lib/spectus/result.rb
+- lib/spectus/result/fail.rb
+- lib/spectus/result/pass.rb
 homepage: https://github.com/fixrb/spectus
 licenses:
 - MIT