Come creare e utilizzare un modulo utilizzando Ruby on Rails 3?

Sto usando Ruby on Rails 3 e vorrei spostare del codice personalizzato e condiviso in un modulo.

1. Quale sintassi dovrei usare per scrivere il codice del modulo?
2. In quale cartella della mia applicazione devo posizionare il file del modulo?
3. Come devo includere quel modulo in una o più classi di controller?
4. Quale altra azione, se del caso, devo utilizzare il modulo personalizzato ovunque nella mia applicazione?
5. Come posso chiamare i metodi nel modulo dalla mia applicazione?

Grazie in anticipo.

Per 1. Un modulo viene creato / aperto semplicemente dicendo:

module MyModule
  def first_module_method
  end
end

Per 2. La libcartella. Se vuoi organizzare i tuoi moduli nella libcartella, puoi inserirli nei moduli stessi. Ad esempio, se volessi una sottocartella, i super_modulestuoi moduli sarebbero definiti come segue:

module SuperModules
  module MyModule
    def first_module_method
    end
  end
end

A 3./5. Quando includi il modulo in una classe puoi semplicemente chiamare i metodi dei moduli come se fossero definiti all'interno della classe:

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

Per 4. Innanzitutto, assicurati che il tuo modulo sia realmente necessario in ogni classe della tua applicazione. In caso contrario, ha senso includerlo solo dove è necessario per non gonfiare le classi che non ne hanno comunque bisogno. Se vuoi davvero il modulo ovunque, includi lo sguardo alla gerarchia delle classi delle tue classi nell'app. Vuoi il modulo in tutti i modelli? Potresti aprire ActiveRecord :: Base e aggiungere il tuo modulo lì.

A> 1. Puoi usare la stessa sintassi di qualsiasi altra classe ruby. Ad esempio, sto definendo un modulo VehicleClassifer che utilizzerà il metodo classify_vehicle per classificare un veicolo in base al numero di ruote che riceve come input.

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

A> 2. I moduli sono generalmente archiviati nella cartella / lib.

le domande 3,4,5 hanno più o meno la stessa risposta. Puoi usare

class SomeController < ApplicationController
  include VehicleClassfier

  def index 
    classify_vehicle(4)  
  end
end

nella classe che stai utilizzando il modulo e avrai accesso a tutti i metodi del modulo.

Inoltre, nel caso in cui sia necessario utilizzare un modulo tramite l'app, è possibile includerlo nel controller dell'applicazione.