Class: FancyOpenStruct

Inherits:
OpenStruct
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/fancy-open-struct.rb,
lib/fancy-open-struct/version.rb

Constant Summary collapse

VERSION = 
"0.4.0"

Instance Method Summary collapse

Constructor Details

#initialize(hash = nil, args = {}) ⇒ FancyOpenStruct 



13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/fancy-open-struct.rb', line 13

def initialize(hash=nil, args={})
  @recurse_over_arrays = args.fetch(:recurse_over_arrays, false)
  @table = {}
  if hash
    for k, v in hash
      @table[k.to_sym] = v
      new_ostruct_member(k)
    end
  end
  @sub_elements = {}
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(mid, *args) ⇒ Object (private)

Dynamically handle any attempts to get or set values via dot syntax if the OpenStruct member methods haven’t already been created



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/fancy-open-struct.rb', line 109

def method_missing(mid, *args) # :nodoc:
  mname = mid.id2name
  len = args.length
  if mname.chomp!('=')
    raise ArgumentError, "wrong number of arguments (#{len} for 1)", caller(1) if len != 1
    # Set up an instance method to point to the key/value in the table and set the value
    modifiable[new_ostruct_member(mname.to_sym)] = args[0]
    build_sub_elements_key_cache(mname.to_sym)
    @table[mname.to_sym]
  elsif @table.has_key?(mid)
    # The table has apparently been modified externally, so we need to set up
    # an instance method to point to the key/value in the table.
    new_ostruct_member(mname.to_sym)
    build_sub_elements_key_cache(mname.to_sym)
    self.send(mid)
  else
    nil
  end
end

Instance Method Details

#[](key) ⇒ Object

Hash getter method which translates the key to a Symbol



46
47
48
49
 
# File 'lib/fancy-open-struct.rb', line 46

def [](key)
  key = key.to_sym unless key.kind_of? Symbol
  @table[key]
end

#[]=(key, value) ⇒ Object

Hash setter method which translates the key to a Symbol and also creates a getter method (OpenStruct member) for accessing the key/value later via dot syntax



53
54
55
56
57
 
# File 'lib/fancy-open-struct.rb', line 53

def []=(key, value)
  key = key.to_sym unless key.kind_of? Symbol
  modifiable[new_ostruct_member(key)] = value
  build_sub_elements_key_cache(key)
end

#debug_inspect(options = {}) ⇒ Object 



39
40
41
42
43
 
# File 'lib/fancy-open-struct.rb', line 39

def debug_inspect(options = {})
  # Refer to the "Awesome Print" gem documentation for information about which options are available
  # The awesome_print gem can be found at https://rubygems.org/gems/awesome_print
  ap(@table, options)
end

#to_h ⇒ Object Also known as: to_hash 



25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/fancy-open-struct.rb', line 25

def to_h
  @table.dup.update(@sub_elements) do |k, oldval, newval|
    if newval.kind_of?(self.class)
      newval.to_h
    elsif newval.kind_of?(Array)
      newval.map { |a| a.kind_of?(self.class) ? a.to_h : a }
    else
      newval
    end
  end
end