Module: Jets::Middleware

Extended by:
Memoist
Included in:
Application
Defined in:
lib/jets/middleware/configurator.rb,
lib/jets/middleware.rb,
lib/jets/middleware/layer.rb,
lib/jets/middleware/stack.rb,
lib/jets/middleware/default_stack.rb

Overview

Based on Rails MiddlewareStackProxy

Configurator is a recorder for the Jets middleware stack that allows you to configure middlewares in your application. It works basically as a command recorder, saving each command to be applied after initialization over the default middleware stack, so you can add, swap, or remove any middleware in Jets.

You can add your own middlewares by using the config.middleware.use method:

config.middleware.use Magical::Unicorns

This will put the Magical::Unicorns middleware on the end of the stack. You can use insert_before if you wish to add a middleware before another:

config.middleware.insert_before Rack::Head, Magical::Unicorns

There’s also insert_after which will insert a middleware after another:

config.middleware.insert_after Rack::Head, Magical::Unicorns

Middlewares can also be completely swapped out and replaced with others:

config.middleware.swap ActionDispatch::Flash, Magical::Unicorns

And finally they can also be removed from the stack completely:

config.middleware.delete ActionDispatch::Flash

Defined Under Namespace

Classes: Configurator, DefaultStack, Layer, Stack

Instance Method Summary collapse

Instance Method Details

#build_stack ⇒ Object

Called in Jets::Booter to build middleware stack only once during bootup



21
22
23
 
# File 'lib/jets/middleware.rb', line 21

def build_stack
  middlewares
end

#call(env) ⇒ Object 



10
11
12
13
 
# File 'lib/jets/middleware.rb', line 10

def call(env)
  stack = middlewares.build(endpoint)
  stack.call(env)
end

#config_middleware ⇒ Object 



34
35
36
 
# File 'lib/jets/middleware.rb', line 34

def config_middleware
  Jets.config.middleware # returns Jets::Middleware::Configurator
end

#default_stack ⇒ Object 



30
31
32
 
# File 'lib/jets/middleware.rb', line 30

def default_stack
  Jets::Middleware::DefaultStack.new(Jets.config, Jets.application).build_stack # returns Jets::Middleware::Stack
end

#endpoint ⇒ Object

Final middleware in the stack



16
17
18
 
# File 'lib/jets/middleware.rb', line 16

def endpoint
  Jets::Controller::Middleware::Main
end

#middlewares ⇒ Object 



25
26
27
 
# File 'lib/jets/middleware.rb', line 25

def middlewares
  config_middleware.merge_into(default_stack) # returns Jets::Middleware::Stack
end