Class: Toys::Middleware::Spec

Inherits:
Object
  • Object
show all
Defined in:
lib/toys/middleware.rb

Overview

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



228
229
230
 
# File 'lib/toys/middleware.rb', line 228

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



243
244
245
 
# File 'lib/toys/middleware.rb', line 243

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



235
236
237
 
# File 'lib/toys/middleware.rb', line 235

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



220
221
222
 
# File 'lib/toys/middleware.rb', line 220

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



213
214
215
 
# File 'lib/toys/middleware.rb', line 213

def object
  @object
end

Instance Method Details

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

Equality check

Parameters:

  • other (Object)

Returns:

  • (Boolean) 


251
252
253
254
255
256
257
258
 
# File 'lib/toys/middleware.rb', line 251

def ==(other)
  other.is_a?(Spec) &&
    object.eql?(other.object) &&
    name.eql?(other.name) &&
    args.eql?(other.args) &&
    kwargs.eql?(other.kwargs) &&
    block.eql?(other.block)
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:



198
199
200
201
202
203
204
205
206
207
 
# File 'lib/toys/middleware.rb', line 198

def build(lookup)
  return @object unless @object.nil?
  if @name.is_a?(::String) || @name.is_a?(::Symbol)
    klass = lookup&.lookup(@name)
    raise ::NameError, "Unknown middleware name #{@name.inspect}" if klass.nil?
  else
    klass = @name
  end
  Compat.instantiate(klass, @args, @kwargs, @block)
end

#hash ⇒ Integer

Return the hash code

Returns:

  • (Integer) 


266
267
268
 
# File 'lib/toys/middleware.rb', line 266

def hash
  [object, name, args, kwargs, block].hash
end