spectus 3.0.10 → 3.1.0

data/lib/spectus/result/pass.rb

@@ -1,56 +1,83 @@
 # frozen_string_literal: true
 
-require_relative 'base'
+require_relative 'common'
 
 module Spectus
   module Result
     # The class that is responsible for reporting that the expectation is true.
     class Pass
-      include Base
+      include Common
 
-      # @!attribute [r] message
+      alias message to_s
+
+      # Did the test fail?
       #
-      # @return [String] The message that describe the state.
-      attr_reader :message
+      # @return [Boolean] The spec passed or failed?
+      def failed?
+        false
+      end
 
-      # The value of the expectation of the spec.
+      # Did the test pass?
       #
-      # @return [Boolean] The spec was true.
-      def result?
-        true
+      # @return [Boolean] The spec passed or failed?
+      def passed?
+        !failed?
       end
 
-      # The state of success.
+      # The state of failure.
       #
-      # @return [Boolean] The test was a success.
-      def success?
-        got.equal?(true)
+      # @return [Boolean] The test was a failure?
+      def failure?
+        false
       end
 
       # The state of info.
       #
-      # @return [Boolean] The test was an info.
+      # @return [Boolean] The test was an info?
       def info?
-        !success?
+        !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
-        success? ? :success : :info
+        return :success if success?
+        return :warning if warning?
+
+        :info
       end
 
       # Express the result with one char.
       #
-      # @param color [Boolean] Enable the color.
-      #
       # @return [String] The char that identify the result.
-      def to_char(color = false)
+      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?
-          color ? "\e[32m.\e[0m" : '.'
+          '✅'
+        elsif warning?
+          '⚠️'
         else
-          color ? "\e[33mI\e[0m" : 'I'
+          '💡'
         end
       end
     end

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: spectus
 version: !ruby/object:Gem::Version
-  version: 3.0.10
+  version: 3.1.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-08 00:00:00.000000000 Z
+date: 2019-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: aw
+  name: defi
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.6
+        version: 2.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.6
+        version: 2.0.3
 - !ruby/object:Gem::Dependency
-  name: defi
+  name: matchi
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.5
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.5
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
-  name: matchi
+  name: brutal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.4
-  type: :runtime
+        version: '0.4'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.4
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -136,7 +136,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: Expectation library with RFC 2119's requirement levels.
+description: "Expectation library with RFC 2119's requirement levels \U0001F6A5"
 email: contact@cyril.email
 executables: []
 extensions: []
@@ -145,17 +145,15 @@ files:
 - LICENSE.md
 - README.md
 - lib/spectus.rb
+- lib/spectus/exam.rb
 - lib/spectus/expectation_target.rb
-- lib/spectus/matchers.rb
-- lib/spectus/report.rb
 - lib/spectus/requirement_level/base.rb
-- lib/spectus/requirement_level/high.rb
-- lib/spectus/requirement_level/low.rb
-- lib/spectus/requirement_level/medium.rb
-- lib/spectus/result/base.rb
+- 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/fail.rb
 - lib/spectus/result/pass.rb
-- lib/spectus/sandbox.rb
 homepage: https://github.com/fixrb/spectus
 licenses:
 - MIT
@@ -175,8 +173,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Expectation library with RFC 2119's requirement levels.
+summary: "Expectation library with RFC 2119's requirement levels \U0001F6A5"
 test_files: []

data/lib/spectus/matchers.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-require 'matchi'
-
-module Spectus
-  # The module includes the list of matcher methods.
-  #
-  # @api public
-  #
-  module Matchers
-    ::Matchi::Matchers.constants.each do |const|
-      name = const.to_s
-                  .gsub(/::/, '/')
-                  .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
-                  .gsub(/([a-z\d])([A-Z])/, '\1_\2')
-                  .downcase
-
-      # Define a method for the given matcher.
-      #
-      # @example Given the `Matchi::Matchers::Equal::Matcher` matcher, its
-      #   method would be:
-      #
-      #   def equal(expected)
-      #     Matchi::Matchers::Equal::Matcher.new(expected)
-      #   end
-      #
-      # @return [#matches?] The matcher.
-      define_method name do |*args|
-        ::Matchi::Matchers.const_get(const)::Matcher.new(*args)
-      end
-    end
-  end
-end

data/lib/spectus/report.rb

@@ -1,92 +0,0 @@
-# frozen_string_literal: true
-
-module Spectus
-  # The class that is responsible for reporting the result of the test.
-  #
-  # @api private
-  #
-  class Report
-    # Initialize the report class.
-    #
-    # @param matcher [#matches?] The matcher.
-    # @param negate  [Boolean]   Evaluate to a negative assertion.
-    # @param state   [Sandbox]   The sandbox that tested the code.
-    # @param result  [Boolean]   The result of the test.
-    def initialize(matcher, negate, state, result)
-      @matcher = matcher
-      @negate  = negate
-      @state   = state
-      @result  = result
-    end
-
-    # @!attribute [r] matcher
-    #
-    # @return [#matches?] The matcher.
-    attr_reader :matcher
-
-    # The value of the negate instance variable.
-    #
-    # @return [Boolean] Evaluated to a negative assertion or not.
-    def negate?
-      @negate
-    end
-
-    # @!attribute [r] state
-    #
-    # @return [Sandbox] The sandbox that tested the code.
-    attr_reader :state
-
-    # @!attribute [r] result
-    #
-    # @return [Boolean] The result of the test.
-    attr_reader :result
-
-    # The message.
-    #
-    # @return [String] The message that describe the state.
-    def to_s
-      "#{title}: #{summary}#{maybe_exception}."
-    end
-
-    # The title of the state.
-    #
-    # @return [String] The title of the state.
-    def title
-      if result
-        state.got ? 'Pass' : 'Info'
-      else
-        state.exception.nil? ? 'Failure' : 'Error'
-      end
-    end
-
-    # The summary of the state.
-    #
-    # @return [String] The summary of the state.
-    def summary
-      return state.exception.message unless state.valid? || state.exception.nil?
-
-      "Expected #{state.actual.inspect}#{maybe_negate} to #{definition}"
-    end
-
-    # The negation, if any.
-    #
-    # @return [String] The negation, or an empty string.
-    def maybe_negate
-      negate? ? ' not' : ''
-    end
-
-    # The type of exception, if any.
-    #
-    # @return [String] The type of exception, or an empty string.
-    def maybe_exception
-      state.exception.nil? ? '' : " (#{state.exception.class})"
-    end
-
-    # The readable definition.
-    #
-    # @return [String] The readable definition string.
-    def definition
-      matcher.to_s
-    end
-  end
-end

data/lib/spectus/requirement_level/high.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-
-module Spectus
-  module RequirementLevel
-    # High requirement level's class.
-    #
-    # @api private
-    #
-    class High < Base
-      # Evaluate the expectation.
-      #
-      # @return [Result::Fail, Result::Pass] Report if the high expectation
-      #   pass or fail.
-      def result(isolation = false)
-        state = sandbox(isolation)
-
-        if state.valid?
-          pass!(state)
-        else
-          fail!(state)
-        end
-      end
-    end
-  end
-end

data/lib/spectus/requirement_level/low.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-
-module Spectus
-  module RequirementLevel
-    # Low requirement level's class.
-    #
-    # @api private
-    #
-    class Low < Base
-      # Evaluate the expectation.
-      #
-      # @return [Result::Fail, Result::Pass] Report if the low expectation
-      #   pass or fail.
-      def result(isolation = false)
-        state = sandbox(isolation)
-
-        if state.valid? || state.exception.is_a?(::NoMethodError)
-          pass!(state)
-        else
-          fail!(state)
-        end
-      end
-    end
-  end
-end

data/lib/spectus/requirement_level/medium.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-
-module Spectus
-  module RequirementLevel
-    # Medium requirement level's class.
-    #
-    # @api private
-    #
-    class Medium < Base
-      # Evaluate the expectation.
-      #
-      # @return [Result::Fail, Result::Pass] Report if the medium expectation
-      #   pass or fail.
-      def result(isolation = false)
-        state = sandbox(isolation)
-
-        if state.valid? || state.exception.nil?
-          pass!(state)
-        else
-          fail!(state)
-        end
-      end
-    end
-  end
-end

data/lib/spectus/result/base.rb

@@ -1,112 +0,0 @@
-# frozen_string_literal: true
-
-module Spectus
-  # Namespace for the results.
-  #
-  # @api private
-  #
-  module Result
-    # Result base's module.
-    #
-    module Base
-      # Initialize the result class.
-      #
-      # @param message    [#to_s] It is describing the actual/error value.
-      # @param subject    [#object_id] The untrusted object to be tested.
-      # @param challenge  [Defi::Challenge] The challenge for the subject.
-      # @param actual     [#object_id] The value that the subject return through
-      #   its challenge.
-      # @param expected   [#matches?] The definition of the expected value.
-      # @param got        [#object_id] The result of the boolean comparison
-      #   between the actual value and the expected value.
-      # @param error      [#exception, nil] Any possible raised exception.
-      # @param level      [:High, :Medium, :Low] The level of the expectation.
-      # @param negate     [Boolean] Evaluate to a negative assertion.
-      # @param valid      [Boolean] Report if the test was true or false.
-      def initialize(message, subject, challenge, actual, expected, got, error,
-                     level, negate, valid)
-
-        @message    = message.to_s
-        @subject    = subject
-        @challenge  = challenge
-        @actual     = actual
-        @expected   = expected
-        @got        = got
-        @error      = error
-        @level      = level
-        @negate     = negate
-        @valid      = valid
-      end
-
-      # @!attribute [r] subject
-      #
-      # @return [#object_id] The untrusted object to be tested.
-      attr_reader :subject
-
-      # @!attribute [r] challenge
-      #
-      # @return [Symbol] The method to call on the subject.
-      attr_reader :challenge
-
-      # @!attribute [r] actual
-      #
-      # @return [#object_id] The value that the subject return through its
-      #   challenge.
-      attr_reader :actual
-
-      # @!attribute [r] expected
-      #
-      # @return [#matches?] The definition of the expected value.
-      attr_reader :expected
-
-      # @!attribute [r] got
-      #
-      # @return [#object_id] The result of the boolean comparison between the
-      #   actual value and the expected value.
-      attr_reader :got
-
-      # @!attribute [r] error
-      #
-      # @return [#exception, nil] Any possible raised exception.
-      attr_reader :error
-
-      # @!attribute [r] level
-      #
-      # @return [:High, :Medium, :Low] The level of the expectation.
-      attr_reader :level
-
-      # The value of the negate instance variable.
-      #
-      # @return [Boolean] Evaluated to a negative assertion or not.
-      def negate?
-        @negate
-      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
-
-      # Properties of the result.
-      #
-      # @return [Hash] The properties of the result.
-      def to_h
-        {
-          subject:    subject,
-          challenge:  challenge.to_h,
-          actual:     actual,
-          expected:   expected.to_h,
-          got:        got,
-          error:      error,
-          level:      level,
-          negate:     negate?,
-          valid:      valid?,
-          result:     result?
-        }
-      end
-    end
-  end
-end