Contents

# frozen_string_literal: true

require_relative 'base'

module Spectus
  module Result
    # The class that is responsible for reporting that the expectation is true.
    class Pass
      include Base

      # @!attribute [r] message
      #
      # @return [String] The message that describe the state.
      attr_reader :message

      # The value of the expectation of the spec.
      #
      # @return [Boolean] The spec was true.
      def result?
        true
      end

      # The state of success.
      #
      # @return [Boolean] The test was a success.
      def success?
        got.equal?(true)
      end

      # The state of info.
      #
      # @return [Boolean] The test was an info.
      def info?
        !success?
      end

      # Identify the state of the result.
      #
      # @return [Symbol] The identifier of the state.
      def to_sym
        success? ? :success : :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)
        if success?
          color ? "\e[32m.\e[0m" : '.'
        else
          color ? "\e[33mI\e[0m" : 'I'
        end
      end
    end
  end
end

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
spectus-3.0.10	lib/spectus/result/pass.rb
spectus-3.0.9	lib/spectus/result/pass.rb
spectus-3.0.8	lib/spectus/result/pass.rb
spectus-3.0.7	lib/spectus/result/pass.rb