class Hashie::Trash
A Trash is a 'translated' Dash where the keys can be remapped from a source hash.
Trashes are useful when you need to read data from another application, such as a Java api, where the keys are named differently from how we would in Ruby.
Public Class Methods
# File lib/hashie/trash.rb, line 55 def self.permitted_input_keys @permitted_input_keys ||= properties.map { |property| inverse_translations.fetch property, property } end
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.
# File lib/hashie/trash.rb, line 19 def self.property(property_name, options = {}) super options[:from] = options[:from].to_sym if options[:from] property_name = property_name.to_sym if options[:from] if property_name == options[:from] fail ArgumentError, "Property name (#{property_name}) and :from option must not be the same" end translations[options[:from].to_sym] = property_name.to_sym define_method "#{options[:from]}=" do |val| with = options[:with] || options[:transform_with] self[property_name.to_sym] = with.respond_to?(:call) ? with.call(val) : val end else if options[:transform_with].respond_to? :call transforms[property_name.to_sym] = options[:transform_with] end end end
Private Class Methods
# File lib/hashie/trash.rb, line 69 def self.inverse_translations @inverse_translations ||= Hash[translations.map(&:reverse)] end
# File lib/hashie/trash.rb, line 61 def self.properties @properties ||= [] end
# File lib/hashie/trash.rb, line 73 def self.transforms @transforms ||= {} end
# File lib/hashie/trash.rb, line 65 def self.translations @translations ||= {} end
Public Instance Methods
Set a value on the Dash in a Hash-like way. Only works on pre-existing properties.
# File lib/hashie/trash.rb, line 45 def []=(property, value) if self.class.translations.key? property.to_sym send("#{property}=", value) elsif self.class.transforms.key? property.to_sym super property, self.class.transforms[property.to_sym].call(value) elsif property_exists? property super end end
Private Instance Methods
Deletes any keys that have a translation
# File lib/hashie/trash.rb, line 89 def initialize_attributes(attributes) return unless attributes attributes_copy = attributes.dup.delete_if do |k, v| if self.class.translations.include?(k.to_sym) self[k] = v true end end super attributes_copy end
Raises an NoMethodError if the property doesn't exist
# File lib/hashie/trash.rb, line 79 def property_exists?(property) unless self.class.property?(property.to_sym) fail NoMethodError, "The property '#{property}' is not defined for this Trash." end true end