shard-spectator/src/spectator/pass_result.cr

require "./result"

module Spectator
  # Outcome that indicates running an example was successful.
  class PassResult < Result
    # Calls the `pass` method on *visitor*.
    def accept(visitor)
      visitor.pass(self)
    end

    # Calls the `pass` method on *visitor*.
    def accept(visitor, &)
      visitor.pass(yield self)
    end

    # Indicates whether the example passed.
    def pass? : Bool
      true
    end

    # Indicates whether the example failed.
    def fail? : Bool
      false
    end

    # One-word description of the result.
    def to_s(io : IO) : Nil
      io << "pass"
    end

    # Creates a JSON object from the result information.
    def to_json(json : JSON::Builder)
      super
      json.field("status", "passed")
    end
  end
end