Module: Hashie::Extensions::Dash::PropertyTranslation::ClassMethods

Defined in:
lib/hashie/extensions/dash/property_translation.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#transforms ⇒ Object (readonly)

Returns the value of attribute transforms.



49
50
51
 
# File 'lib/hashie/extensions/dash/property_translation.rb', line 49

def transforms
  @transforms
end

#translations_hash ⇒ Object (readonly)

Returns the value of attribute translations_hash.



49
50
51
 
# File 'lib/hashie/extensions/dash/property_translation.rb', line 49

def translations_hash
  @translations_hash
end

Instance Method Details

#inherited(klass) ⇒ Object

Ensures that any inheriting classes maintain their translations.

  • :default - The class inheriting the translations.


54
55
56
57
58
 
# File 'lib/hashie/extensions/dash/property_translation.rb', line 54

def inherited(klass)
  super
  klass.instance_variable_set(:@transforms, transforms.dup)
  klass.instance_variable_set(:@translations_hash, translations_hash.dup)
end

#inverse_translations ⇒ Object 



115
116
117
118
119
120
121
122
123
 
# File 'lib/hashie/extensions/dash/property_translation.rb', line 115

def inverse_translations
  @inverse_translations ||= {}.tap do |translations|
    translations_hash.each do |(property_name, property_translations)|
      property_translations.each_key do |key|
        translations[key] = property_name
      end
    end
  end
end

#permitted_input_keys ⇒ Object 



60
61
62
63
64
 
# File 'lib/hashie/extensions/dash/property_translation.rb', line 60

def permitted_input_keys
  @permitted_input_keys ||=
    properties
    .map { |property| inverse_translations.fetch property, property }
end

#property(property_name, options = {}) ⇒ Object

Defines a property on the Trash. Options are as follows:

  • :default - Specify a default value for this property, to be returned before a value is set on the property in a new Dash.
  • :from - Specify the original key name that will be write only.
  • :with - Specify a lambda to be used to convert value.
  • :transform_with - Specify a lambda to be used to convert value without using the :from option. It transform the property itself.


74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/hashie/extensions/dash/property_translation.rb', line 74

def property(property_name, options = {})
  super

  from = options[:from]
  converter = options[:with]
  transformer = options[:transform_with]

  if from
    fail_self_transformation_error!(property_name) if property_name == from
    define_translation(from, property_name, converter || transformer)
    define_writer_for_source_property(from)
  elsif valid_transformer?(transformer)
    transforms[property_name] = transformer
  end
end

#transformation_exists?(name) ⇒ Boolean

Returns:

  • (Boolean) 


94
95
96
 
# File 'lib/hashie/extensions/dash/property_translation.rb', line 94

def transformation_exists?(name)
  transforms.key? name
end

#transformed_property(property_name, value) ⇒ Object 



90
91
92
 
# File 'lib/hashie/extensions/dash/property_translation.rb', line 90

def transformed_property(property_name, value)
  transforms[property_name].call(value)
end

#translation_exists?(name) ⇒ Boolean

Returns:

  • (Boolean) 


98
99
100
 
# File 'lib/hashie/extensions/dash/property_translation.rb', line 98

def translation_exists?(name)
  translations_hash.key? name
end

#translations ⇒ Object 



102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/hashie/extensions/dash/property_translation.rb', line 102

def translations
  @translations ||= {}.tap do |translations|
    translations_hash.each do |(property_name, property_translations)|
      translations[property_name] =
        if property_translations.size > 1
          property_translations.keys
        else
          property_translations.keys.first
        end
    end
  end
end