¿Cómo crear y usar un módulo usando Ruby on Rails 3?

Estoy usando Ruby on Rails 3 y me gustaría mover un código personalizado y compartido en un módulo.

1. ¿Qué sintaxis debo utilizar para escribir el código del módulo?
2. ¿En qué carpeta de mi aplicación tengo que colocar el archivo del módulo?
3. ¿Cómo tengo que incluir ese módulo en una o más clases de controlador?
4. ¿Qué otra acción, si corresponde, tengo que usar el módulo personalizado en cualquier lugar de mi aplicación?
5. ¿Cómo puedo llamar a métodos en el módulo desde mi aplicación?

Gracias por adelantado.

Para 1. Un módulo se crea / abre simplemente diciendo:

module MyModule
  def first_module_method
  end
end

Para 2. La libcarpeta. Si desea organizar sus módulos en la libcarpeta, puede ponerlos en módulos. Por ejemplo, si quisiera una subcarpeta, super_modulessus módulos se definirían de la siguiente manera:

module SuperModules
  module MyModule
    def first_module_method
    end
  end
end

Hasta el 3./5. Al incluir el módulo en una clase, simplemente puede llamar a los métodos de los módulos como si estuvieran definidos dentro de la clase:

class MyClass
  include MyModule
  def some_method
    first_module_method #calls module method
  end
end

Para 4. Primero, asegúrese de que su módulo sea realmente necesario en cada clase de su aplicación. Si no es así, tiene sentido incluirlo solo donde sea necesario para no inflar las clases que no lo necesitan de todos modos. Si realmente desea que el módulo esté en todas partes, incluya un vistazo a la jerarquía de clases de sus clases en la aplicación. ¿Quieres el módulo en todos los modelos? Puede abrir ActiveRecord :: Base y agregar su módulo allí.

A> 1. Puede utilizar la misma sintaxis que cualquier otra clase de ruby. Por ejemplo, estoy definiendo un módulo VehicleClassifer que utilizará el método classify_vehicle para clasificar un vehículo en función del número de ruedas que recibe como entrada.

module VehicleClassifer
  def classify_vehicle(number_of_wheels)
    VehicleType.where("number_of_wheels = ?", number_of_wheels)
  end
end

A> 2. Los módulos generalmente se almacenan en la carpeta / lib.

las preguntas 3, 4, 5 tienen más o menos la misma respuesta. puedes usar

class SomeController < ApplicationController
  include VehicleClassfier

  def index 
    classify_vehicle(4)  
  end
end

en la clase que está utilizando el módulo y tendrá acceso a todos los métodos del módulo.

Además, en caso de que necesite utilizar un módulo en su aplicación, puede incluirlo en el controlador de su aplicación.