Module: Globalize::ActiveRecord::InstanceMethods

Defined in:
lib/globalize/active_record/instance_methods.rb

Instance Method Summary collapse

Instance Method Details

#[](attr_name) ⇒ Object


34
35
36
37
38
39
40
# File 'lib/globalize/active_record/instance_methods.rb', line 34

def [](attr_name)
  if translated?(attr_name)
    read_attribute(attr_name)
  else
    read_attribute(attr_name) { |n| missing_attribute(n, caller) }
  end
end

#assign_attributes(new_attributes, *options) ⇒ Object


20
21
22
23
24
# File 'lib/globalize/active_record/instance_methods.rb', line 20

def assign_attributes(new_attributes, *options)
  super unless new_attributes.respond_to?(:stringify_keys) && new_attributes.present?
  attributes = new_attributes.stringify_keys
  with_given_locale(attributes) { super(attributes.except("locale"), *options) }
end

#attribute_namesObject


57
58
59
# File 'lib/globalize/active_record/instance_methods.rb', line 57

def attribute_names
  translated_attribute_names.map(&:to_s) + super
end

#attributesObject


10
11
12
# File 'lib/globalize/active_record/instance_methods.rb', line 10

def attributes
  super.merge(translated_attributes)
end

#attributes=(new_attributes, *options) ⇒ Object


14
15
16
17
18
# File 'lib/globalize/active_record/instance_methods.rb', line 14

def attributes=(new_attributes, *options)
  super unless new_attributes.respond_to?(:stringify_keys) && new_attributes.present?
  attributes = new_attributes.stringify_keys
  with_given_locale(attributes) { super(attributes.except("locale"), *options) }
end

#available_localesObject

Get available locales from translations association, without a separate distinct query


137
138
139
# File 'lib/globalize/active_record/instance_methods.rb', line 137

def available_locales
  translations.map(&:locale).uniq
end

#cache_keyObject


164
165
166
# File 'lib/globalize/active_record/instance_methods.rb', line 164

def cache_key
  [super, translation.cache_key].join("/")
end

#changed?Boolean


168
169
170
# File 'lib/globalize/active_record/instance_methods.rb', line 168

def changed?
  changed_attributes.present? || translations.any?(&:changed?)
end

#column_for_attribute(name) ⇒ Object


158
159
160
161
162
# File 'lib/globalize/active_record/instance_methods.rb', line 158

def column_for_attribute name
  return super if translated_attribute_names.exclude?(name)

  globalize.send(:column_for_attribute, name)
end

#globalizeObject


6
7
8
# File 'lib/globalize/active_record/instance_methods.rb', line 6

def globalize
  @globalize ||= Adapter.new(self)
end

#globalize_fallbacks(locale) ⇒ Object


141
142
143
# File 'lib/globalize/active_record/instance_methods.rb', line 141

def globalize_fallbacks(locale)
  Globalize.fallbacks(locale)
end

#initialize_dup(other) ⇒ Object


98
99
100
101
102
103
104
105
# File 'lib/globalize/active_record/instance_methods.rb', line 98

def initialize_dup(other)
  @globalize = nil
  @translation_caches = nil
  super
  other.each_locale_and_translated_attribute do |locale, name|
    globalize.write(locale, name, other.globalize.fetch(locale, name) )
  end
end

#original_changed_attributesObject

need to access instance variable directly since changed_attributes is frozen as of Rails 4.2


174
175
176
# File 'lib/globalize/active_record/instance_methods.rb', line 174

def original_changed_attributes
  @changed_attributes
end

#read_attribute(name, options = {}, &block) ⇒ Object


42
43
44
45
46
47
48
49
50
51
52
53
54
55
# File 'lib/globalize/active_record/instance_methods.rb', line 42

def read_attribute(name, options = {}, &block)
  options = {:translated => true, :locale => nil}.merge(options)
  return super(name, &block) unless options[:translated]

  if translated?(name)
    if !(value = globalize.fetch(options[:locale] || Globalize.locale, name)).nil?
      value
    else
      super(name, &block)
    end
  else
    super(name, &block)
  end
end

#reload(options = nil) ⇒ Object


91
92
93
94
95
96
# File 'lib/globalize/active_record/instance_methods.rb', line 91

def reload(options = nil)
  translation_caches.clear
  translated_attribute_names.each { |name| @attributes.reset(name.to_s) }
  globalize.reset
  super(options)
end

#saveObject


145
146
147
148
149
150
151
152
153
154
155
156
# File 'lib/globalize/active_record/instance_methods.rb', line 145

def save(*)
  result = Globalize.with_locale(translation.locale || I18n.default_locale) do
    without_fallbacks do
      super
    end
  end
  if result
    globalize.clear_dirty
  end

  result
end

#set_translations(options) ⇒ Object


77
78
79
80
81
82
83
84
85
86
87
88
89
# File 'lib/globalize/active_record/instance_methods.rb', line 77

def set_translations(options)
  options.keys.each do |locale|
    translation = translation_for(locale) ||
                  translations.build(:locale => locale.to_s)

    options[locale].each do |key, value|
      translation.send :"#{key}=", value
      translation.globalized_model.send :"#{key}=", value
    end
    translation.save if persisted?
  end
  globalize.reset
end

#translated_attribute_by_locale(name) ⇒ Object


132
133
134
# File 'lib/globalize/active_record/instance_methods.rb', line 132

def translated_attribute_by_locale(name)
  translations_by_locale(&:"#{name}")
end

#translated_attributesObject


63
64
65
66
67
# File 'lib/globalize/active_record/instance_methods.rb', line 63

def translated_attributes
  translated_attribute_names.inject({}) do |attributes, name|
    attributes.merge(name.to_s => send(name))
  end
end

#translationObject


107
108
109
# File 'lib/globalize/active_record/instance_methods.rb', line 107

def translation
  translation_for(::Globalize.locale)
end

#translation_cachesObject


122
123
124
# File 'lib/globalize/active_record/instance_methods.rb', line 122

def translation_caches
  @translation_caches ||= {}
end

#translation_for(locale, build_if_missing = true) ⇒ Object


111
112
113
114
115
116
117
118
119
120
# File 'lib/globalize/active_record/instance_methods.rb', line 111

def translation_for(locale, build_if_missing = true)
  unless translation_caches[locale]
    # Fetch translations from database as those in the translation collection may be incomplete
    _translation = translations.detect{|t| t.locale.to_s == locale.to_s}
    _translation ||= translations.with_locale(locale).first unless translations.loaded?
    _translation ||= translations.build(:locale => locale) if build_if_missing
    translation_caches[locale] = _translation if _translation
  end
  translation_caches[locale]
end

#translations_by_localeObject


126
127
128
129
130
# File 'lib/globalize/active_record/instance_methods.rb', line 126

def translations_by_locale
  translations.each_with_object(HashWithIndifferentAccess.new) do |t, hash|
    hash[t.locale] = block_given? ? yield(t) : t
  end
end

#untranslated_attributesObject

This method is basically the method built into Rails but we have to pass => false


71
72
73
74
75
# File 'lib/globalize/active_record/instance_methods.rb', line 71

def untranslated_attributes
  attribute_names.inject({}) do |attrs, name|
    attrs[name] = read_attribute(name, {:translated => false}); attrs
  end
end

#write_attribute(name, value, *args, &block) ⇒ Object


26
27
28
29
30
31
32
# File 'lib/globalize/active_record/instance_methods.rb', line 26

def write_attribute(name, value, *args, &block)
  return super(name, value, *args, &block) unless translated?(name)

  options = {:locale => Globalize.locale}.merge(args.first || {})

  globalize.write(options[:locale], name, value)
end