Как расширить ActiveRecord :: Migration дополнительными методами? - PullRequest
17 голосов
/ 21 ноября 2010

Я создаю гем Ruby и хотел бы расширить ActiveRecord :: Migration своими помощниками для создания необходимых столбцов. (Это похоже на то, что делает Devise при создании миграций для их различных стратегий аутентификации.) Я понимаю, что добавляемая мной функциональность сама по себе довольно тривиальна, и, вероятно, есть более эффективные / более эффективные способы сделать это - я пытаюсь сделать это как опыт обучения, а не как что-то с практическим применением. Я просто хочу понять, как сделать что-то столь же инвазивное, как добавление новых возможностей миграции в Rails.

То, что у меня есть, успешно встраивается в гем и устанавливается, но когда я пытаюсь выполнить миграцию, например:

class CreatePosts < ActiveRecord::Migration
  def self.up
    create_table :posts do |t|
      t.string :name
      t.string :title
      t.text :content
      t.hideable
      t.tracks_hidden_at
      t.timestamps
    end
  end
end

... он не может сказать, что скрываемый не определен.

Я изучил способ, которым Devise сделал это, и я должен признать, что я немного растерян, но я пытался с этим справиться. Я сделал следующее:

Расширенный ActiveRecord с добавлением моих новых моделей и созданный метод для применения изменений схемы на основе моих новых методов миграции

require 'orm_adapter/adapters/active_record'

module HiddenRecord
  module Orm
    # This module contains some helpers and handle schema (migrations):
    #
    #   create_table :accounts do |t|
    #     t.hideable
    #     t.tracks_hidden_timestamp
    #   end
    #
    module ActiveRecord
      module Schema
        include HiddenRecord::Schema

        # Tell how to apply schema methods.
        def apply_hiddenrecord_schema(name, type, options={})
          column name, type.to_s.downcase.to_sym, options
        end
      end
    end
  end
end
ActiveRecord::Base.extend HiddenRecord::Models
ActiveRecord::ConnectionAdapters::Table.send :include, HiddenRecord::Orm::ActiveRecord::Schema
ActiveRecord::ConnectionAdapters::TableDefinition.send :include, HiddenRecord::Orm::ActiveRecord::Schema

Создан модуль Schema, похожий на schema.rb Devise, который определяет методы, которые я хочу использовать при миграции, и вызывает метод для применения схемы

module HiddenRecord
  # Holds schema definition for hiddenrecord model options.
  module Schema
    # Sets the model as having hidable rows
    #
    # == Options
    # * :null - When true, allows the hidden row flag to be null
    # * :default - Used to set default hidden status to true. If not set, default is false (rows are not hidden)
    def hideable(options={})
      null = options[:null] || false
      default = options[:default] || false

      apply_hiddenrecord_schema :hiddenrecord_is_row_hidden, Boolean, :null => null, :default => default
    end

    # Sets the model to record the timestamp when a row was hidden
    def tracks_hidden_timestamp()
      apply_hiddenrecord_schema :hiddenrecord_hidden_at, DateTime
    end
  end
end

Добавлены методы для моделей для поддержки новых полей

module HiddenRecord
  module Models
    # This module implements the hideable API
    module Hideable
      def self.included(base)
        base.class_eval do
          extend ClassMethods
        end
      end

      scope :visible, where(:hiddenrecord_is_row_hidden => true)

      def hidden?
        return hiddenrecord_is_row_hidden || false
      end

      def hide
        hiddenrecord_is_row_hidden = true
      end

      def hide!
        hiddenrecord_is_row_hidden = true
        save!
      end

      def unhide
        hiddenrecord_is_row_hidden = false
      end

      def unhide!
        hiddenrecord_is_row_hidden = false
        save!
      end

    end
  end
end

Загрузить файлы схемы и модели и в основной модуль гема

module HiddenRecord
  autoload :Schema, 'hiddenrecord/schema'
  autoload :Models, 'hiddenrecord/models'
  ...
end
require 'hiddenrecord/models/hideable'
require 'hiddenrecord/models/tracks_hidden_timestamp'

Опять же, признавая, что это в первую очередь учебный опыт, я надеюсь, что кто-то может указать мне правильное направление, как это сделать. Я пытаюсь это сделать на Rails 3.

Ответы [ 2 ]

7 голосов
/ 02 апреля 2012

Вот как я добавил пользовательские поля миграции с Rails 2 и MySQL для предыдущего проекта.Прекрасно работает.

Я не знаю, насколько это относится к вашим потребностям, поэтому не стесняйтесь задавать мне вопросы.

Я поместил этот код в Rails.root / lib / dbd_migration_helper.rb

module Ddb

  module MigrationHelper

    def self.included(base) # :nodoc:
      base.send(:include, InstanceMethods)
    end

    module InstanceMethods
      def active    (column_name=:active)     column(column_name, :boolean, :default=>true) end
      def email     (column_name=:email)      column(column_name, :string)     end
      def latitude  (column_name=:latitude)   column(column_name, :float)      end
      def longitude (column_name=:longitude)  column(column_name, :float)      end
      def position  (column_name=:position)   column(column_name, :integer)    end
    end
  end
end

require 'activerecord'
if defined?(ActiveRecord::ConnectionAdapters::TableDefinition)
   ActiveRecord::ConnectionAdapters::TableDefinition.send(:include, Ddb::MigrationHelper)
end
2 голосов
/ 07 апреля 2012

Быстрое примечание, эти строки:

ActiveRecord::ConnectionAdapters::Table.send :include, HiddenRecord::Orm::ActiveRecord::Schema
ActiveRecord::ConnectionAdapters::TableDefinition.send :include, HiddenRecord::Orm::ActiveRecord::Schema

не содержат правильного модуля.Я думаю, что они должны быть:

ActiveRecord::ConnectionAdapters::Table.send :include, HiddenRecord::Schema
ActiveRecord::ConnectionAdapters::TableDefinition.send :include, HiddenRecord::Schema

, но тогда вы, похоже, нигде не определили #tracks_hidden_at.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...