Class: Toys::Middleware::Spec

Inherits:
Object
  • Object
show all
Defined in:
core-docs/toys/middleware.rb

Overview

Defined in the toys-core gem

A middleware specification, including the middleware class and the arguments to pass to the constructor.

Use spec to create a middleware spec.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#args ⇒ Array? (readonly)

Returns:

  • (Array) —

    the positional arguments to be passed to a middleware class constructor, or the empty array if there are no positional arguments

  • (nil) —

    if this spec wraps a middleware object



181
182
183
 
# File 'core-docs/toys/middleware.rb', line 181

def args
  @args
end

#block ⇒ Proc? (readonly)

Returns:

  • (Proc) —

    if there is a block argument to be passed to a middleware class constructor

  • (nil) —

    if there is no block argument, or this spec wraps a middleware object



196
197
198
 
# File 'core-docs/toys/middleware.rb', line 196

def block
  @block
end

#kwargs ⇒ Hash? (readonly)

Returns:

  • (Hash) —

    the keyword arguments to be passed to a middleware class constructor, or the empty hash if there are no keyword arguments

  • (nil) —

    if this spec wraps a middleware object



188
189
190
 
# File 'core-docs/toys/middleware.rb', line 188

def kwargs
  @kwargs
end

#name ⇒ String, ... (readonly)

Returns:

  • (String, Symbol) —

    if this spec represents a middleware name

  • (Class) —

    if this spec represents a middleware class

  • (nil) —

    if this spec wraps a middleware object



173
174
175
 
# File 'core-docs/toys/middleware.rb', line 173

def name
  @name
end

#object ⇒ Toys::Middleware? (readonly)

Returns:

  • (Toys::Middleware) —

    if this spec wraps a middleware object

  • (nil) —

    if this spec represents a class to instantiate



166
167
168
 
# File 'core-docs/toys/middleware.rb', line 166

def object
  @object
end

Instance Method Details

#==(other) ⇒ Boolean Also known as: eql?

Equality check

Parameters:

  • other (Object)

Returns:

  • (Boolean) 


204
205
206
 
# File 'core-docs/toys/middleware.rb', line 204

def ==(other)
  # Source available in the toys-core gem
end

#build(lookup) ⇒ Toys::Middleware

Builds a middleware for this spec, given a ModuleLookup for middleware.

If this spec wraps an existing middleware object, returns that object. Otherwise, constructs a middleware object from the spec.

Parameters:

Returns:



158
159
160
 
# File 'core-docs/toys/middleware.rb', line 158

def build(lookup)
  # Source available in the toys-core gem
end

#hash ⇒ Integer

Return the hash code

Returns:

  • (Integer) 


214
215
216
 
# File 'core-docs/toys/middleware.rb', line 214

def hash
  # Source available in the toys-core gem
end