Rails 2.3.8 | Closer to Code

Wstęp

W pewnym projekcie nad którym ostatnio pracuję, postanowiłem skorzystać z UUIDów (co to są UUIDy dowiesz się tutaj) zamiast wykorzystywać domyślne ID'ki. Realizacja tego zadania w Railsach wymaga zastosowania pewnych niewielkich zabiegów, jednak całość jest całkiem prosta.

Generowanie UUIDów

Do generowania UUIDów wykorzystamy gem uuidtools:

gem 'uuidtools'

Generowanie odbywa się z pomocą poniższej metody:

UUIDTools::UUID.random_create.to_s

Migracje

Aby wykorzystać UUIDy, zamiast standardowego pola ID skorzystamy z pola (a jakże) UUID. Aby tego dokonac, wyłączymy całkowicie generowanie IDków dla migracji. Stworzymy w tym celu klasę bazową dla naszych migracji (można oczywiście deklarować to w każdej migracji z osobna ale komu się chce). Tworzymy w katalogu db/ plik uuid_migration.rb zawierający jedną metodę (migracja ta jest migracją bazową więc nie ma up, down czy też (w R3.1) change:

class UuidMigration < ActiveRecord::Migration
  def create_uuid_table(name, options = {})
    create_table name, options.merge(:id => false) do |t|
      t.string :uuid, :limit => 36, :primary => true
      yield t
      t.timestamps
    end

    add_index name, :uuid, 'UNIQUE'
  end
end

Od teraz możemy wykorzystać naszą migrację edytując migracje danych modeli, np:

require File.expand_path(File.dirname(__FILE__))+'/../uuid_migration.rb'

class CreateProducts < UuidMigration
  def change
    create_uuid_table :products do |t|
      t.string   :name,  :null => false
      t.float    :price, :null => false
      t.timestamps
    end
  end
end

Taka migracja spowoduje, że oprócz pól zadeklarowanych powyżej, powstanie także (automatycznie) pole uuid oraz timestampy. Tworząc dużo modeli opartych na UUIDach, taka metoda jest wygodniejsza (nie zapomnimy np. przez przypadek wyłączyć automatycznie tworzonego pola id).

Klasa bazowa dla naszych modeli

Zanim zaczniemy, chciałbym zaznaczyć, że wykorzystamy klasę bazową zamiast modułu tylko dlatego, że w systemie nad którym pracuję, występuje takie rozwiązanie (powody pozostawiam dla siebie ;) ). Niemniej jednak, nic nie stoi na przeszkodzie aby przerobić rozwiązanie zaprezentowane poniżej wersję modułową.

W gruncie rzeczy cały "myk" sprowadza się do informowania klas o tym że zamiast id używamy uuida oraz do jego inicjowania. Inicjować uuida będziemy zaraz przed zapisem obiektu do bazy (before_create):

require 'uuidtools'

class UuidRecord::Base < ActiveRecord::Base

  self.abstract_class = true
  self.primary_key = :uuid

  before_create :generate_uuid

  private

  def generate_uuid
    self.uuid = UUIDTools::UUID.random_create.to_s
  end

end

Tworzymy klasę

Po utworzeniu naszej migracji oraz innych potrzebnych fragmentów kodu, możemy przystąpić do utworzenia naszej pierwszej klasy:

class Product < UuidRecord::Base

  set_table_name  :products
  set_primary_key :uuid

end

Wadą "uuidowania" jest to, że musimy deklarować nazwę tabeli (jeśli dziedziczymy, jako moduł includowany już nie), oraz że w każdym modelu (mimo że ustawiliśmy w nadrzędnym), musimy deklarować, że uuid jest naszym kluczem głównym:

set_table_name  :products
set_primary_key :uuid

Relacje pomiędzy obiektami

Opisując wykorzystanie UUIDów, warto wspomnieć także o tym, jak przebiega stosowanie ich w relacjach has, belongs_to, itd. Ogólnie rzecz ujmując, to przebiega... tak samo. Ale... należy pamiętać o tym, że nie mamy pola ID! Dlatego deklarując relacje, musimy podawać klucz obcy oraz klucz główny:

  belongs_to :product,
    :primary_key => :uuid,
    :foreign_key => :product_uuid

  has_many :ordereds,
    :primary_key => :uuid,
    :foreign_key => :order_uuid

Tyle jeśli chodzi o UUIDy. Ich wykorzystanie nie jest trudne, pod warunkiem, że będziemy pamiętać o tym co napisałem powyżej.

Tworząc arkusze stylów dla projektów często zdarza się, że chcemy dodać styl specyficzny dla danego kontrolera. Przykładowo w kontrolerze wyświetlającym pewien specyficzny rodzaj danych, chcemy mieć inne formatowanie. W przypadku Railsów składać się to będzie na dwie części - najpierw w ApplicationControlerze dodamy sobie metodę która ustawiać nam będzie trzy zmienne dostępne zarówno w kontrolerach jak i widokach:

@action_name - nazwa akcji
@controller_name - nazwa kontrolera
@module_name - nazwa modułu

Przy tym ostatnim (@module_name) należy pamiętać, że możemy mieć kilka "poziomów", np: Admin::Core::Logs, tak więc będziemy to trzymać w tablicy ([Admin, Core, Logs]). Przyjmiemy też konwencję, że nazwy będą przechowywane z małej litery.

  def get_module_and_controller_name
    my_class_name = self.class.name
    @action_name = self.action_name
    if my_class_name.index("::").nil? then
      @module_name = nil
      @controller_name = self.class.to_s.split('Controller').first.underlinize
    else
      @controller_name = self.class.to_s.split("::").last.split('Controller').first.underlinize
      if (my_class_name.split("::").length > 2)
        @module_name = my_class_name.split("::")
        @module_name = @module_name[0, @module_name.length-1].collect{|m| m.underlinize}
      else
        @module_name = Array.new(1, my_class_name.split("::").first.underlinize)
      end
    end
  end

Taką metodę ustawiamy jako before_filter.

Teraz jeszcze tylko helper do widoków:

  def controller_stylesheet_link_tag(module_name, controller)

    if module_name.class.to_s.downcase == 'array'
      module_name = module_name.join('/')
    end
    ex = FileTest.exist?(File.join(Rails.root, 'public',
        'stylesheets', module_name, "#{controller}.css"))

    stylesheet_link_tag "#{module_name}/#{controller}" if ex
  end

oraz wywołanie:

controller_stylesheet_link_tag(@module_name, @controller_name)

Warto wspomnieć, że powyższe rozwiązanie działa na 3.0.7. Dla 3.1.0 będzie troszkę inaczej, ale to pozostawiam wam :)

Wersja dla Padrino jest troszkę mniej "fajna" (aczk. wymaga before_filtre'a):

  def controller_stylesheet_link_tag
    path = request.path.split('/')
    styles = ''
    while path.count > 0
      file = File.join(Padrino.root, 'app', 'stylesheets', 'controllers', path)+'.less'
      if File.exists?(file)
        styles += stylesheet_link_tag 'controllers'+path.join('/')
      end
      path.delete(path.last)
    end
    styles
  end

Tag: Rails 2.3.8

UUID-GUUID zamiast domyślnego ID w Ruby on Rails