Module: EmbeddedLocalization::ActiveRecord::ActMacro

Defined in:
lib/embedded_localization/active_record/act_macro.rb

Instance Method Summary collapse

Instance Method Details

#translates(*attr_names) ⇒ Object 



4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/embedded_localization/active_record/act_macro.rb', line 4

def translates(*attr_names)
  return if translates?  # cludge to make sure we don't set this up twice..

  # for details about I18n fallbacks, check the source:
  # i18n-0.9.0/lib/i18n/backend/fallbacks.rb
  # i18n-0.9.0/lib/i18n/locale/fallbacks.rb

  # options[:fallbacks] => true or false # not used at this time
  options = attr_names.extract_options!

  class_attribute :translated_attribute_names, :translation_options
  self.translated_attribute_names = attr_names.map(&:to_sym).sort.uniq
  self.translation_options        = options

  include InstanceMethods
  extend  ClassMethods

  #-
  # if ActiveRecord::Base is in the parent-chain of the class where we are included into:
  # ::Rails::Railtie.subclasses.map(&:to_s).include?("ActiveRecord::Railtie")
  #+

  serialize :i18n, coder: YAML, type: Hash   # we should also protect it from direct assignment by the user

  #-
  # if Mongoid::Document is in the list of classes which extends the class we are included into:
  # ::Rails::Railtie.subclasses.map(&:to_s).include?("Rails::Mongoid::Railtie")

  #    field :i18n, type: Hash
  # but on the other hand, Mongoid now supports "localized fields" -- so we don't need to re-implement this.
  # Yay! Durran Jordan is awesome! :-) See: http://mongoid.org/docs/documents/localized.html
  #
  # NOTE: I like how Durran implemented the localization in Mongoid.. too bad I didn't see that before.
  # I'm thinking of re-writing this gem to store the localization hash per attribute... hmm... hmm... thinking...
  # there would be a couple of advantages to store the I18n-hash per attribute:
  #   - drop-in internationalization for existing String type attributes
  #   - works well with rails scaffolding and with protection of attributes (attr_protected / attr_accessible)
  #   - we can easily hide the internal hash by re-defining the attr-accessors for doing the I18n
  #   - we can better add the per-attribute versioning, which is planned
  #   -
  #+

  after_initialize :initialize_i18n_hashes

  # dynamically define the accessors for the translated attributes:

  translated_attribute_names.each do |attr_name|
    class_eval do
      # define the getter method
      #
      define_method(attr_name) do |locale = I18n.locale|
        if self.i18n.has_key?(locale)
          if self.i18n[locale].keys.include?(attr_name)
            self.i18n[ locale ][attr_name]
          else
            nil
          end
        else
          # fallback to the I18n.default_locale if we do fallbacks:
          if self.class.fallbacks? && self.i18n[ I18n.default_locale ]
            return self.i18n[ I18n.default_locale ][attr_name]
          else
            return nil
          end
        end
      end

      # define the setter method
      #
      define_method(attr_name.to_s+ '=') do |new_translation|
        # first check if nothing changed - then we can just return, so that timestamps and other records don't get touched
        if self.i18n.class == Hash && (self.i18n[I18n.locale]) && (self.i18n[I18n.locale][attr_name.to_sym] == new_translation)
          return if (I18n.locale != I18n.default_locale)
          return if (I18n.locale == I18n.default_locale) && (read_attribute(attr_name) == new_translation) # both i18n and attr_name need to be equal to new_translation
        end

        self.i18n_will_change!     # for ActiveModel Dirty tracking
        if self.attributes.has_key?(attr_name.to_s)  # if user has defined DB field with that name
          write_attribute(attr_name , new_translation) if I18n.locale == I18n.default_locale
        end
        self.i18n ||= Hash.new
        self.i18n[I18n.locale] ||= Hash.new
        self.i18n[I18n.locale][attr_name.to_sym] = new_translation
      end
    end
  end
end

#translates? ⇒ Boolean

Returns:

  • (Boolean) 


92
93
94
 
# File 'lib/embedded_localization/active_record/act_macro.rb', line 92

def translates?
  included_modules.include?(InstanceMethods)
end