Class: Viaduct::Builder

Inherits:
Object
  • Object
show all
Defined in:
lib/viaduct/builder.rb

Instance Method Summary collapse

Constructor Details

#initialize(&block) ⇒ Builder

Initializes the builder. An optional block can be passed which will be evaluated in the context of the instance.



5
6
7
 
# File 'lib/viaduct/builder.rb', line 5

def initialize(&block)
  instance_eval(&block) if block_given?
end

Instance Method Details

#call(env) ⇒ Object

Runs the builder stack with the given environment.



75
76
77
 
# File 'lib/viaduct/builder.rb', line 75

def call(env)
  to_app(env).call(env)
end

#delete(index) ⇒ Object

Deletes the given middleware object or index



69
70
71
72
 
# File 'lib/viaduct/builder.rb', line 69

def delete(index)
  index = self.index(index) unless index.is_a?(Integer)
  stack.delete_at(index)
end

#flatten ⇒ Object

Returns a mergeable version of the builder. If ‘use` is called with the return value of this method, then the stack will merge, instead of being treated as a separate single middleware.



12
13
14
15
16
 
# File 'lib/viaduct/builder.rb', line 12

def flatten
  lambda do |env|
    self.call(env)
  end
end

#index(object) ⇒ Integer

Returns the numeric index for the given middleware object.

Parameters:

  • object (Object) —

    The item to find the index for

Returns:

  • (Integer) 


83
84
85
86
87
88
89
90
 
# File 'lib/viaduct/builder.rb', line 83

def index(object)
  stack.each_with_index do |item, i|
    return i if item[0] == object
    return i if item[0].respond_to?(:name) && item[0].name == object
  end

  nil
end

#insert(index, middleware, *args, &block) ⇒ Object Also known as: insert_before

Inserts a middleware at the given index or directly before the given middleware object.



41
42
43
44
45
 
# File 'lib/viaduct/builder.rb', line 41

def insert(index, middleware, *args, &block)
  index = self.index(index) unless index.is_a?(Integer)
  raise "no such middleware to insert before: #{index.inspect}" unless index
  stack.insert(index, [middleware, args, block])
end

#insert_after(index, middleware, *args, &block) ⇒ Object

Inserts a middleware after the given index or middleware object.



50
51
52
53
54
 
# File 'lib/viaduct/builder.rb', line 50

def insert_after(index, middleware, *args, &block)
  index = self.index(index) unless index.is_a?(Integer)
  raise "no such middleware to insert after: #{index.inspect}" unless index
  insert(index + 1, middleware, *args, &block)
end

#replace(index, middleware, *args, &block) ⇒ Object

Replaces the given middlware object or index with the new middleware.



58
59
60
61
62
63
64
65
66
 
# File 'lib/viaduct/builder.rb', line 58

def replace(index, middleware, *args, &block)
  if index.is_a?(Integer)
    delete(index)
    insert(index, middleware, *args, &block)
  else
    insert_before(index, middleware, *args, &block)
    delete(index)
  end
end

#use(middleware, *args, &block) ⇒ Object

Adds a middleware class to the middleware stack. Any additional args and a block, if given, are saved and passed to the initializer of the middleware.

Parameters:

  • middleware (Class) —

    The middleware class



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/viaduct/builder.rb', line 23

def use(middleware, *args, &block)
  # Prepend with a environment setter if args are given
  if !args.empty? && args.first.is_a?(Hash) && middleware != Env::Set
    self.use(Env::Set, args.shift, &block)
  end

  if middleware.kind_of?(Builder)
    # Merge in the other builder's stack into our own
    self.stack.concat(middleware.stack)
  else
    self.stack << [middleware, args, block]
  end

  self
end