class Globalize::ActiveRecord::Migration::Migrator

Attributes

model[R]

Public Class Methods

new(model) click to toggle source
# File lib/globalize/active_record/migration.rb, line 21
def initialize(model)
  @model = model
end

Public Instance Methods

add_translation_fields() click to toggle source
# File lib/globalize/active_record/migration.rb, line 87
def add_translation_fields
  connection.change_table(translations_table_name) do |t|
    fields.each do |name, options|
      if options.is_a? Hash
        t.column name, options.delete(:type), options
      else
        t.column name, options
      end
    end
  end
end
add_translation_fields!(fields, options = {}) click to toggle source
# File lib/globalize/active_record/migration.rb, line 45
def add_translation_fields!(fields, options = {})
  @fields = fields
  validate_translated_fields
  add_translation_fields
  clear_schema_cache!
  move_data_to_translation_table if options[:migrate_data]
  remove_source_columns if options[:remove_source_columns]
  clear_schema_cache!
end
clear_schema_cache!() click to toggle source
# File lib/globalize/active_record/migration.rb, line 188
def clear_schema_cache!
  connection.schema_cache.clear! if connection.respond_to? :schema_cache
  model::Translation.reset_column_information
  model.reset_column_information
end
column_type(name) click to toggle source
# File lib/globalize/active_record/migration.rb, line 168
def column_type(name)
  columns.detect { |c| c.name == name.to_s }.try(:type) || :string
end
complete_translated_fields() click to toggle source

This adds all the current translated attributes of the model It's a problem because in early migrations would add all the translated attributes

# File lib/globalize/active_record/migration.rb, line 73
def complete_translated_fields
  translated_attribute_names.each do |name|
    @fields[name] ||= column_type(name)
  end
end
create_translation_table() click to toggle source
# File lib/globalize/active_record/migration.rb, line 79
def create_translation_table
  connection.create_table(translations_table_name) do |t|
    t.references table_name.sub(/^#{table_name_prefix}/, '').singularize, :null => false, :index => false, :type => column_type(model.primary_key).to_sym
    t.string :locale, :null => false
    t.timestamps :null => false
  end
end
create_translation_table!(fields = {}, options = {}) click to toggle source
# File lib/globalize/active_record/migration.rb, line 29
def create_translation_table!(fields = {}, options = {})
  extra = options.keys - [:migrate_data, :remove_source_columns, :unique_index]
  if extra.any?
    raise ArgumentError, "Unknown migration #{'option'.pluralize(extra.size)}: #{extra}"
  end
  @fields = fields
  # If we have fields we only want to create the translation table with those fields
  complete_translated_fields if fields.blank?
  validate_translated_fields

  create_translation_table
  add_translation_fields!(fields, options)
  create_translations_index(options)
  clear_schema_cache!
end
create_translations_index(options) click to toggle source
# File lib/globalize/active_record/migration.rb, line 99
def create_translations_index(options)
  foreign_key = "#{table_name.sub(/^#{table_name_prefix}/, "").singularize}_id".to_sym
  connection.add_index(
    translations_table_name,
    foreign_key,
    :name => translation_index_name
  )
  # index for select('DISTINCT locale') call in translation.rb
  connection.add_index(
    translations_table_name,
    :locale,
    :name => translation_locale_index_name
  )

  if options[:unique_index]
    connection.add_index(
      translations_table_name,
      [foreign_key, :locale],
      :name => translation_unique_index_name,
      unique: true
    )
  end
end
drop_translation_table() click to toggle source
# File lib/globalize/active_record/migration.rb, line 123
def drop_translation_table
  connection.drop_table(translations_table_name)
end
drop_translation_table!(options = {}) click to toggle source
# File lib/globalize/active_record/migration.rb, line 64
def drop_translation_table!(options = {})
  move_data_to_model_table if options[:migrate_data]
  drop_translations_index
  drop_translation_table
  clear_schema_cache!
end
drop_translations_index() click to toggle source
# File lib/globalize/active_record/migration.rb, line 127
def drop_translations_index
  if connection.indexes(translations_table_name).map(&:name).include?(translation_index_name)
    connection.remove_index(translations_table_name, :name => translation_index_name)
  end
  if connection.indexes(translations_table_name).map(&:name).include?(translation_locale_index_name)
    connection.remove_index(translations_table_name, :name => translation_locale_index_name)
  end
end
fields() click to toggle source
# File lib/globalize/active_record/migration.rb, line 25
def fields
  @fields ||= complete_translated_fields
end
move_data_to_model_table() click to toggle source
# File lib/globalize/active_record/migration.rb, line 146
def move_data_to_model_table
  add_missing_columns

  # Find all of the translated attributes for all records in the model.
  all_translated_attributes = model.all.collect{|m| m.attributes}
  all_translated_attributes.each do |translated_record|
    # Create a hash containing the translated column names and their values.
    translated_attribute_names.inject(fields_to_update={}) do |f, name|
      f.update({name.to_sym => translated_record[name.to_s]})
    end

    # Now, update the actual model's record with the hash.
    model.where(model.primary_key.to_sym => translated_record[model.primary_key]).update_all(fields_to_update)
  end
end
move_data_to_translation_table() click to toggle source
# File lib/globalize/active_record/migration.rb, line 136
def move_data_to_translation_table
  model.find_each do |record|
    translation = record.translation_for(I18n.locale) || record.translations.build(:locale => I18n.locale)
    fields.each do |attribute_name, attribute_type|
      translation[attribute_name] = record.read_attribute(attribute_name, {:translated => false})
    end
    translation.save!
  end
end
remove_source_columns() click to toggle source
# File lib/globalize/active_record/migration.rb, line 55
def remove_source_columns
  column_names = *fields.keys
  column_names.each do |column|
    if connection.column_exists?(table_name, column)
      connection.remove_column(table_name, column)
    end
  end
end
translation_index_name() click to toggle source
# File lib/globalize/active_record/migration.rb, line 176
def translation_index_name
  truncate_index_name "index_#{translations_table_name}_on_#{table_name.singularize}_id"
end
translation_locale_index_name() click to toggle source
# File lib/globalize/active_record/migration.rb, line 180
def translation_locale_index_name
  truncate_index_name "index_#{translations_table_name}_on_locale"
end
translation_unique_index_name() click to toggle source
# File lib/globalize/active_record/migration.rb, line 184
def translation_unique_index_name
  truncate_index_name "index_#{translations_table_name}_on_#{table_name.singularize}_id_and_locale"
end
valid_field_name?(name) click to toggle source
# File lib/globalize/active_record/migration.rb, line 172
def valid_field_name?(name)
  translated_attribute_names.include?(name)
end
validate_translated_fields() click to toggle source
# File lib/globalize/active_record/migration.rb, line 162
def validate_translated_fields
  fields.each do |name, options|
    raise BadFieldName.new(name) unless valid_field_name?(name)
  end
end

Private Instance Methods

add_missing_columns() click to toggle source
# File lib/globalize/active_record/migration.rb, line 204
def add_missing_columns
  clear_schema_cache!
  translated_attribute_names.map(&:to_s).each do |attribute|
    unless model.column_names.include?(attribute)
      connection.add_column(table_name, attribute, model::Translation.columns_hash[attribute].type)
    end
  end
end
truncate_index_name(index_name) click to toggle source
# File lib/globalize/active_record/migration.rb, line 196
def truncate_index_name(index_name)
  if index_name.size < connection.index_name_length
    index_name
  else
    "index_#{Digest::SHA1.hexdigest(index_name)}"[0, connection.index_name_length]
  end
end