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

      # Identify the state of the result.
      #
      # @return [String] the char that identify the state of the result.
      def to_char
        if got
          '.'
        else
          'I'
        end
      end
    end
  end
end