Class: RecursiveOpenStruct

Inherits:
OpenStruct
  • Object
show all
Includes:
DebugInspect, Dig
Defined in:
lib/recursive_open_struct.rb,
lib/recursive_open_struct/dig.rb,
lib/recursive_open_struct/version.rb

Overview

TODO: When we care less about Rubies before 2.4.0, match OpenStruct’s method names instead of doing things like aliasing ‘new_ostruct_member` to `new_ostruct_member!`

TODO: ‘#*_as_a_hash` deprecated. Nested hashes can be referenced using `#to_h`.

Defined Under Namespace

Modules: DebugInspect, Dig Classes: DeepDup

Constant Summary collapse

VERSION = 
"1.1.2"

Class Method Summary collapse

Instance Method Summary collapse

Methods included from DebugInspect

#debug_inspect, #display_recursive_open_struct

Methods included from Dig

#dig

Constructor Details

#initialize(hash = nil, passed_options = {}) ⇒ RecursiveOpenStruct

Returns a new instance of RecursiveOpenStruct.



30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/recursive_open_struct.rb', line 30

def initialize(hash=nil, passed_options={})
  hash ||= {}

  @options = self.class.default_options.merge!(passed_options).freeze

  @deep_dup = DeepDup.new(@options)

  @table = @options[:mutate_input_hash] ? hash : @deep_dup.call(hash)

  @sub_elements = {}
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(mid, *args) ⇒ Object

Adapted implementation of method_missing to accommodate the differences between ROS and OS.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/recursive_open_struct.rb', line 98

def method_missing(mid, *args)
  len = args.length
  if mid =~ /^(.*)=$/
    if len != 1
      raise ArgumentError, "wrong number of arguments (#{len} for 1)", caller(1)
    end
    # self[$1.to_sym] = args[0]
    # modifiable?[new_ostruct_member!($1.to_sym)] = args[0]
    new_ostruct_member!($1.to_sym)
    public_send(mid, args[0])
  elsif len == 0
    key = mid
    key = $1 if key =~ /^(.*)_as_a_hash$/
    if @table.key?(_get_key_from_table_(key))
      new_ostruct_member!(key)
      public_send(mid)
    end
  else
    err = NoMethodError.new "undefined method `#{mid}' for #{self}", mid, args
    err.set_backtrace caller(1)
    raise err
  end
end

Class Method Details

.default_options ⇒ Object 



22
23
24
25
26
27
28
 
# File 'lib/recursive_open_struct.rb', line 22

def self.default_options
  {
    mutate_input_hash: false,
    recurse_over_arrays: false,
    preserve_original_keys: false
  }
end

Instance Method Details

#[](name) ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/recursive_open_struct.rb', line 59

def [](name)
  key_name = _get_key_from_table_(name)
  v = @table[key_name]
  if v.is_a?(Hash)
    @sub_elements[key_name] ||= _create_sub_element_(v, mutate_input_hash: true)
  elsif v.is_a?(Array) and @options[:recurse_over_arrays]
    @sub_elements[key_name] ||= recurse_over_array(v)
    @sub_elements[key_name] = recurse_over_array(@sub_elements[key_name])
  else
    v
  end
end

#[]=(name, value) ⇒ Object 



72
73
74
75
76
77
 
# File 'lib/recursive_open_struct.rb', line 72

def []=(name, value)
  key_name = _get_key_from_table_(name)
  tbl = modifiable?  # Ensure we are modifiable
  @sub_elements.delete(key_name)
  tbl[key_name] = value
end

#delete_field(name) ⇒ Object 



149
150
151
152
153
154
 
# File 'lib/recursive_open_struct.rb', line 149

def delete_field(name)
  sym = _get_key_from_table_(name)
  singleton_class.__send__(:remove_method, sym, "#{sym}=") rescue NoMethodError # ignore if methods not yet generated.
  @sub_elements.delete(sym)
  @table.delete(sym)
end

#initialize_copy(orig) ⇒ Object 



42
43
44
45
46
47
48
49
 
# File 'lib/recursive_open_struct.rb', line 42

def initialize_copy(orig)
  super

  # deep copy the table to separate the two objects
  @table = @deep_dup.call(orig.instance_variable_get(:@table))
  # Forget any memoized sub-elements
  @sub_elements = {}
end

#new_ostruct_member(name) ⇒ Object Also known as: new_ostruct_member!

TODO: Rename to new_ostruct_member! once we care less about Rubies before 2.4.0.



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/recursive_open_struct.rb', line 124

def new_ostruct_member(name)
  key_name = _get_key_from_table_(name)
  unless self.singleton_class.method_defined?(name.to_sym)
    class << self; self; end.class_eval do
      define_method(name) do
        self[key_name]
      end
      define_method("#{name}=") do |x|
        self[key_name] = x
      end
      define_method("#{name}_as_a_hash") { @table[key_name] }
    end
  end
  key_name
end

#respond_to_missing?(mid, include_private = false) ⇒ Boolean

Makes sure ROS responds as expected on #respond_to? and #method requests

Returns:

  • (Boolean) 


80
81
82
83
 
# File 'lib/recursive_open_struct.rb', line 80

def respond_to_missing?(mid, include_private = false)
  mname = _get_key_from_table_(mid.to_s.chomp('=').chomp('_as_a_hash'))
  @table.key?(mname) || super
end

#to_h ⇒ Object Also known as: to_hash 



51
52
53
 
# File 'lib/recursive_open_struct.rb', line 51

def to_h
  @deep_dup.call(@table)
end