Wie erstelle und verwende ich ein Modul mit Ruby on Rails 3?

Ich verwende Ruby on Rails 3 und möchte benutzerdefinierten und gemeinsam genutzten Code in ein Modul verschieben.

1. Welche Syntax soll ich zum Schreiben des Modulcodes verwenden?
2. In welchem ​​Ordner meiner Anwendung muss ich die Moduldatei ablegen?
3. Wie muss ich dieses Modul in eine oder mehrere Controller-Klassen aufnehmen?
4. Welche andere Aktion muss ich, falls vorhanden, an einer beliebigen Stelle in meiner Anwendung verwenden?
5. Wie kann ich Methoden im Modul aus meiner Anwendung aufrufen?

Danke im Voraus.

Zu 1. Ein Modul wird erstellt / geöffnet, indem einfach gesagt wird:

module MyModule
  def first_module_method
  end
end

Zu 2. Der libOrdner. Wenn Sie Ihre Module im libOrdner organisieren möchten , können Sie sie selbst in Module einfügen. Wenn Sie beispielsweise einen Unterordner super_modulesmöchten, werden Ihre Module wie folgt definiert:

module SuperModules
  module MyModule
    def first_module_method
    end
  end
end

Bis 3./5. Wenn Sie das Modul in eine Klasse aufnehmen, können Sie die Modulmethoden einfach so aufrufen, als wären sie in der Klasse definiert:

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

Stellen Sie zunächst sicher, dass Ihr Modul in jeder Klasse Ihrer Anwendung wirklich benötigt wird. Wenn dies nicht der Fall ist, ist es sinnvoll, es nur dort einzuschließen, wo es benötigt wird, um die Klassen, die es sowieso nicht benötigen, nicht aufzublähen. Wenn Sie das Modul wirklich überall haben möchten, sehen Sie sich die Klassenhierarchie Ihrer Klassen in der App an. Möchten Sie das Modul in allen Modellen? Sie können ActiveRecord :: Base öffnen und dort Ihr Modul hinzufügen.

A> 1. Sie können dieselbe Syntax wie jede andere Ruby-Klasse verwenden. Zum Beispiel definiere ich ein VehicleClassifer-Modul, das die classify_vehicle-Methode verwendet, um ein Fahrzeug basierend auf der Anzahl der Räder zu klassifizieren, die es als Eingabe empfängt.

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

A> 2. Module werden normalerweise im Ordner / lib gespeichert.

Fragen 3,4,5 haben mehr oder weniger die gleiche Antwort. Sie können verwenden

class SomeController < ApplicationController
  include VehicleClassfier

  def index 
    classify_vehicle(4)  
  end
end

In der Klasse verwenden Sie das Modul und haben Zugriff auf alle Methoden des Moduls.

Falls Sie ein Modul in Ihrer gesamten App verwenden müssen, können Sie es in Ihren Anwendungscontroller aufnehmen.