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.
# File lib/hashie/trash.rb, line 66 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] if options[:from] 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]] = property_name define_method "#{options[:from]}=" do |val| with = options[:with] || options[:transform_with] self[property_name] = with.respond_to?(:call) ? with.call(val) : val end else if options[:transform_with].respond_to? :call transforms[property_name] = options[:transform_with] end end end
# File lib/hashie/trash.rb, line 62 def self.transformation_exists?(name) transforms.key? name end
Set a value on the Dash in a Hash-like way. Only works on pre-existing properties.
# File lib/hashie/trash.rb, line 44 def []=(property, value) if self.class.translation_exists? property send("#{property}=", value) elsif self.class.transformation_exists? property super property, self.class.transformed_property(property, value) elsif property_exists? property super end end
Generated with the Darkfish Rdoc Generator 2.