module Hashie::Extensions::Dash::PropertyTranslation::ClassMethods

Attributes

transforms[R]
translations_hash[R]

Public Instance Methods

inherited(klass) click to toggle source

Ensures that any inheriting classes maintain their translations.

  • :default - The class inheriting the translations.

Calls superclass method
# 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() click to toggle source
# 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() click to toggle source
# 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 = {}) click to toggle source

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.

Calls superclass method
# 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) click to toggle source
# File lib/hashie/extensions/dash/property_translation.rb, line 94
def transformation_exists?(name)
  transforms.key? name
end
transformed_property(property_name, value) click to toggle source
# 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) click to toggle source
# File lib/hashie/extensions/dash/property_translation.rb, line 98
def translation_exists?(name)
  translations_hash.key? name
end
translations() click to toggle source
# 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

Private Instance Methods

define_translation(from, property_name, translator) click to toggle source
# File lib/hashie/extensions/dash/property_translation.rb, line 127
def define_translation(from, property_name, translator)
  translations_hash[from][property_name] = translator
end
define_writer_for_source_property(property) click to toggle source
# File lib/hashie/extensions/dash/property_translation.rb, line 131
def define_writer_for_source_property(property)
  define_method "#{property}=" do |val|
    __translations[property].each do |name, with|
      self[name] = with.respond_to?(:call) ? with.call(val) : val
    end
  end
end
fail_self_transformation_error!(property_name) click to toggle source
# File lib/hashie/extensions/dash/property_translation.rb, line 139
def fail_self_transformation_error!(property_name)
  raise ArgumentError,
        "Property name (#{property_name}) and :from option must not be the same"
end
valid_transformer?(transformer) click to toggle source
# File lib/hashie/extensions/dash/property_translation.rb, line 144
def valid_transformer?(transformer)
  transformer.respond_to? :call
end