class Spectator::FormalArguments(Args, Splat, DoubleSplat)

• Spectator::FormalArguments(Args, Splat, DoubleSplat)
• Spectator::AbstractArguments
• Reference
• Object

Overview

Arguments passed into a method.

Args must be a NamedTuple type representing the standard arguments. Splat must be a Tuple type representing the extra positional arguments. DoubleSplat must be a NamedTuple type representing extra keyword arguments.

Defined in:

spectator/mocks/formal_arguments.cr

Constructors

• .new(args : Args, splat_name : Symbol | Nil, splat : Splat, kwargs : DoubleSplat)

  Creates arguments used in a method call.

• .new(args : Args, kwargs : DoubleSplat)

  Creates arguments used in a method call.

Class Method Summary

• .build(args : NamedTuple, splat_name : Symbol, splat : Tuple, kwargs = NamedTuple.new)

  Captures arguments passed to a call.

• .build(args = NamedTuple.new, kwargs = NamedTuple.new)

  Captures arguments passed to a call.

• .none : AbstractArguments

  Instance of empty arguments.

Instance Method Summary

• #==(other : AbstractArguments)

  Checks if this set of arguments and another are equal.

• #===(other : Arguments)

  Checks if another set of arguments matches this set of arguments.

• #===(other : FormalArguments)

  Checks if another set of arguments matches this set of arguments.

• #[](index : Int)

  Returns the positional argument at the specified index.

• #[](arg : Symbol)

  Returns the specified named argument.

• #args : Args

  Positional arguments.

• #kwargs : DoubleSplat

  Keyword arguments.

• #named : NamedTuple

  Returns all named positional and keyword arguments as a named tuple.

• #positional : Tuple

  Returns all arguments and splatted arguments as a tuple.

• #splat : Splat

  Additional positional arguments.

• #splat_name : Symbol | Nil

  Name of the splat argument, if used.

• #to_s(io : IO) : Nil

  Constructs a string representation of the arguments.

Constructor Detail

Class Method Detail

Instance Method Detail