¿Dónde coloca sus archivos de middleware Rack y requiere?

Question

Estoy en el proceso de refacturación de una lógica integrada en una aplicación de Rails en middleware, y una de las molestias con las que me he encontrado es una aparente falta de convención sobre dónde ubicarlas.

Actualmente me he decidido por app/middleware pero podría fácilmente moverlo a vendor/middleware o tal vez vendor/plugins/middleware ...

El mayor problema es tener que requerir los archivos individuales en la parte superior de config/environment.rb

require "app/middleware/system_message" 
require "app/middleware/rack_backstage" 

o si no recibo errores constantes no inicializados en las líneas config.middleware.use. Eso podría ser complicado muy rápidamente. Prefiero que esto esté guardado en un inicializador en alguna parte.

¿Hay un lugar convencional para poner esto?

---

La respuesta específica que estoy buscando con esta recompensa es: donde puedo poner las líneas requerir para que no se saturan el archivo environment.rb pero todavía se cargan antes de la config.middleware.use llamadas? Todo lo que he probado conduce a errores constantes no inicializados.

---

actualización: Ahora que estamos usando Rails 3.0, que tratar a una aplicación Rails como cualquier otra aplicación del estante; los archivos de código para middleware van en lib (o una gema listada en Gemfile) y se requieren y cargan en config.ru.

Answer 1

A partir de Rails 3.2, Rack middleware pertenece al directorio de la aplicación/middleware.

Funciona "out-of-the-box" sin ningún requerimiento explícito.

Ejemplo rápido:

estoy usando una clase middleware llamado CanonicalHost que se implementa en app/middleware/canonical_host.rb. He añadido la siguiente línea a production.rb (nota que la clase middleware se da de forma explícita, en lugar de como una cadena entre comillas, que funciona para cualquier archivos de configuración específicos del entorno):

config.middleware.use CanonicalHost, "example.com" 

Si está agregando middleware a application.rb, deberá incluir comillas, según @mltsy's comment.

config.middleware.use "CanonicalHost", "example.com" 

Answer 2

No tengo conocimiento de una convención, pero ¿por qué no ponerla en el directorio /lib? Los archivos allí se cargan automáticamente por Rails.

Answer 3

Puede crear un inicializador que requiera los archivos necesarios y luego dejar los archivos donde desee.

Según this, los inicializadores se ejecutan antes de cargar el middleware del rack.

Answer 4

La solución de trabajo que tengo hasta ahora se está moviendo el middleware requiere a config/middleware.rb y requiriendo ese archivo en environment.rb, reduciéndolo a un solo requieren que puedo vivir.

Todavía me gustaría escuchar cómo otras personas han resuelto este problema aparentemente básico de agregar middleware a Rails.

Answer 5

para los carriles 3:

#config/application.rb 
require 'lib/rack/my_adapter.rb' 
module MyApp 
    class Application < Rails::Application 
    config.middleware.use Rack::MyAdapter 
    end 
end 

Answer 6

Usted puede ponerlo en lib/tableized/file_name.rb. Siempre que la clase que está tratando de cargar sea detectable por su nombre de archivo, Rails cargará automáticamente el archivo necesario. Así, por ejemplo:

config.middleware.use "MyApp::TotallyAwesomeMiddleware" 

Se podría tener en:

lib/my_app/totally_awesome_middleware.rb 

rieles atrapa const_missing y attemts para cargar los archivos correspondientes a las constantes que faltan automáticamente. Solo asegúrate de que coincidan tus nombres y tu salsa.Carriles incluso proporciona ayudantes ingeniosas que te ayudarán a identificar la ruta de un archivo fácilmente:

>> ChrisHeald::StdLib.to_s.tableize.singularize 
=> "chris_heald/std_lib" 

Así que mi stdlib vive en lib/chris_heald/std_lib.rb, y se cargan automáticamente cuando hacen referencia a él en el código.

Answer 7

En mi Rails 3.2 aplicación, yo era capaz de conseguir mi carga middleware TrafficCop poniéndolo en app/middleware/traffic_cop.rb, tal como se describe @MikeJarema. Luego añade esta línea a mi config/application.rb, tal como se indica:

config.middleware.use TrafficCop 

Sin embargo, al inicio de la aplicación, seguí recibiendo este error:

uninitialized constant MyApp::Application::TrafficCop 

La especificación expresa el espacio de nombres raíz no ayudó tampoco:

config.middleware.use ::TrafficCop 
# uninitialized constant TrafficCop 

Por alguna razón (que todavía tengo que descubrir), en este punto en el ciclo de vida de los carriles, app/middleware no se incluyó en las rutas de carga. Si eliminé la línea config.middleware.use y ejecuté la consola, pude acceder a la constante TrafficCop sin ningún problema. Pero no pudo encontrarlo en app/middleware en el momento de la configuración.

que fija esta encerrando el nombre de la clase middleware entre comillas, así:

config.middleware.use "TrafficCop" 

De esta manera, evitaría el error uninitialized constant, ya que los carriles no está tratando de encontrar la clase TrafficCop por el momento. Pero cuando comienza a construir la pila de middleware, la cadena se mantendrá constante. En este momento, app/middleware se encuentra en las rutas de carga, por lo que la clase se cargará correctamente.