Class: Hashie::Dash

Inherits:
Hash
  • Object
show all
Includes:
PrettyInspect
Defined in:
lib/hashie/dash.rb

Overview

A Dash is a 'defined' or 'discrete' Hash, that is, a Hash that has a set of defined keys that are accessible (with optional defaults) and only those keys may be set or read.

Dashes are useful when you need to create a very simple lightweight data object that needs even fewer options and resources than something like a DataMapper resource.

It is preferrable to a Struct because of the in-class API for defining properties as well as per-property defaults.

Direct Known Subclasses

Trash

Class Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from PrettyInspect

#hashie_inspect, included

Methods inherited from Hash

#to_hash, #to_json

Methods included from HashExtensions

#hashie_stringify_keys, #hashie_stringify_keys!, included, #to_mash

Constructor Details

#initialize(attributes = {}, &block) ⇒ Dash

You may initialize a Dash with an attributes hash just like you would many other kinds of data objects.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/hashie/dash.rb', line 83

def initialize(attributes = {}, &block)
  super(&block)

  self.class.defaults.each_pair do |prop, value|
    self[prop] = begin
      value.dup
    rescue TypeError
      value
    end
  end

  initialize_attributes(attributes)
  assert_required_properties_set!
end

Class Attribute Details

.defaults ⇒ Object (readonly)

Returns the value of attribute defaults.



54
55
56
 
# File 'lib/hashie/dash.rb', line 54

def defaults
  @defaults
end

.properties ⇒ Object (readonly)

Returns the value of attribute properties.



54
55
56
 
# File 'lib/hashie/dash.rb', line 54

def properties
  @properties
end

.required_properties ⇒ Object (readonly)

Returns the value of attribute required_properties.



55
56
57
 
# File 'lib/hashie/dash.rb', line 55

def required_properties
  @required_properties
end

Class Method Details

.inherited(klass) ⇒ Object 



61
62
63
64
65
66
67
 
# File 'lib/hashie/dash.rb', line 61

def self.inherited(klass)
  super
  (@subclasses ||= Set.new) << klass
  klass.instance_variable_set('@properties', properties.dup)
  klass.instance_variable_set('@defaults', defaults.dup)
  klass.instance_variable_set('@required_properties', required_properties.dup)
end

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

Defines a property on the Dash. 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.

  • :required - Specify the value as required for this property, to raise an error if a value is unset in a new or existing Dash.



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/hashie/dash.rb', line 30

def self.property(property_name, options = {})
  property_name = property_name.to_sym

  properties << property_name

  if options.key?(:default)
    defaults[property_name] = options[:default]
  elsif defaults.key?(property_name)
    defaults.delete property_name
  end

  unless instance_methods.map { |m| m.to_s }.include?("#{property_name}=")
    define_method(property_name) { |&block| self.[](property_name.to_s, &block) }
    property_assignment = property_name.to_s.concat('=').to_sym
    define_method(property_assignment) { |value| self.[]=(property_name.to_s, value) }
  end

  if defined? @subclasses
    @subclasses.each { |klass| klass.property(property_name, options) }
  end
  required_properties << property_name if options.delete(:required)
end

.property?(name) ⇒ Boolean

Check to see if the specified property has already been defined.

Returns:

  • (Boolean) 


71
72
73
 
# File 'lib/hashie/dash.rb', line 71

def self.property?(name)
  properties.include? name.to_sym
end

.required?(name) ⇒ Boolean

Check to see if the specified property is required.

Returns:

  • (Boolean) 


77
78
79
 
# File 'lib/hashie/dash.rb', line 77

def self.required?(name)
  required_properties.include? name.to_sym
end

Instance Method Details

#[](property) ⇒ Object

Retrieve a value from the Dash (will return the property's default value if it hasn't been set).



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

def [](property)
  assert_property_exists! property
  value = super(property.to_s)
  # If the value is a lambda, proc, or whatever answers to call, eval the thing!
  if value.is_a? Proc
    self[property] = value.call # Set the result of the call as a value
  else
    yield value if block_given?
    value
  end
end

#[]=(property, value) ⇒ Object

Set a value on the Dash in a Hash-like way. Only works on pre-existing properties.



118
119
120
121
122
 
# File 'lib/hashie/dash.rb', line 118

def []=(property, value)
  assert_property_required! property, value
  assert_property_exists! property
  super(property.to_s, value)
end

#merge(other_hash) ⇒ Object 



124
125
126
127
128
129
130
 
# File 'lib/hashie/dash.rb', line 124

def merge(other_hash)
  new_dash = dup
  other_hash.each do |k, v|
    new_dash[k] = block_given? ? yield(k, self[k], v) : v
  end
  new_dash
end

#merge!(other_hash) ⇒ Object 



132
133
134
135
136
137
 
# File 'lib/hashie/dash.rb', line 132

def merge!(other_hash)
  other_hash.each do |k, v|
    self[k] = block_given? ? yield(k, self[k], v) : v
  end
  self
end

#replace(other_hash) ⇒ Object 



139
140
141
142
143
144
 
# File 'lib/hashie/dash.rb', line 139

def replace(other_hash)
  other_hash = self.class.defaults.merge(other_hash)
  (keys - other_hash.keys).each { |key| delete(key) }
  other_hash.each { |key, value| self[key] = value }
  self
end