spectus 3.1.3 → 3.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee7d9fda32871f2db5571569f0b85a63edb9cdd4abb7149059bca0e218383a07
-  data.tar.gz: 530aefebbfedcea834fec61c14e79b79a4e71930a059c51de314c85c8264a299
+  metadata.gz: 73306cc997a51543203fcfbec28fedae74de8ca9f382040db66d1c6aebbfc4bd
+  data.tar.gz: c9d9365b33cc4cca9cb54630306f9320c254a42ad64161d8a609107eeb8f95e3
 SHA512:
-  metadata.gz: 42d8f625fd2f0057416a41e3c46decefee155a24679443851882c36513fc8765c1ca437800ee94a031a11edf30ff81758f36e87e08959dbbefd64cc8d94ffbd9
-  data.tar.gz: b6607f0a2309f8dae7ceac5e8dc82bd2733b6289610a5b67ae258889395c15e496de38a13978726670a371bb9668eaf3a4f83e576d94e102f5b3b603d2ae558a
+  metadata.gz: 5cdfb58c6e5e3b748f8c5071f354793618a6e6e00053e3139175c5afde4cbc2fd39a419fbe516970354a6eaaee585637077d6dcc65b1d3ba7ae5412f26dcce60
+  data.tar.gz: 8211f7d6955d70067071a691bfa80b1f640930c01db4cec6433534141c3f7c7a4e386ee82c80f00941b3c6a04426d2266be7cdb416960e04c5e8a36b0f35bc95

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 🚥
@@ -39,13 +39,21 @@ There are several scenarios:
 
 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.
+* 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, and can be classified respectively as:
+Both results share a common interface.
 
-* ✅ a _success_, ⚠️ a _warning_ or 💡 an _info_;
-* ❌ a _failure_ or 💥 an _error_.
+Passed expectations can be classified as:
+
+* ✅ success
+* ⚠️ warning
+* 💡 info
+
+Failed expectations can be classified as:
+
+* ❌ failure
+* 💥 error
 
 ## Code Isolation
 
@@ -141,8 +149,8 @@ The optional `blank?` method is not implemented (unlike in [Ruby on Rails](https
 
 ### More Examples
 
-A full list of unit tests can 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)
 
 ## Contact
 
@@ -162,7 +170,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/requirement_level/base.rb

@@ -32,37 +32,22 @@ module Spectus
 
       # The result of the expectation.
       #
-      # @return [Result::Fail, Result::Pass] The test result.
+      # @raise [Result::Fail] The expectation is `false`.
+      # @return [Result::Pass] The expectation is `true`.
       def call
-        pass? ? pass! : fail!
+        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)
       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
-        {
-          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
-
       # @return [Symbol] The requirement level.
       def level
         self.class.name.split("::").fetch(-1).upcase.to_sym
@@ -79,6 +64,5 @@ module Spectus
   end
 end
 
+require_relative File.join("..", "result")
 require_relative File.join("..", "exam")
-require_relative File.join("..", "result", "fail")
-require_relative File.join("..", "result", "pass")

data/lib/spectus/result.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+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)
+    end
+  end
+end
+
+require_relative File.join("result", "fail")
+require_relative File.join("result", "pass")

data/lib/spectus/result/common.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module Spectus
-  # Namespace for the results.
   module Result
     # Common collection of methods for Result's classes.
     module Common
@@ -50,6 +49,13 @@ module Spectus
         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?

data/lib/spectus/result/fail.rb

@@ -8,6 +8,11 @@ module Spectus
     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?
@@ -15,13 +20,6 @@ module Spectus
         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?

data/lib/spectus/result/pass.rb

@@ -8,6 +8,11 @@ module Spectus
     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?
@@ -17,13 +22,6 @@ module Spectus
         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?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spectus
 version: !ruby/object:Gem::Version
-  version: 3.1.3
+  version: 3.1.4
 platform: ruby
 authors:
 - Cyril Kato
@@ -179,6 +179,7 @@ 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/common.rb
 - lib/spectus/result/fail.rb
 - lib/spectus/result/pass.rb