Class: RecursiveOpenStruct
- Inherits:
-
OpenStruct
- Object
- OpenStruct
- RecursiveOpenStruct
- 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.3"
Class Method Summary collapse
Instance Method Summary collapse
- #[](name) ⇒ Object
- #[]=(name, value) ⇒ Object
- #delete_field(name) ⇒ Object
-
#initialize(hash = nil, passed_options = {}) ⇒ RecursiveOpenStruct
constructor
A new instance of RecursiveOpenStruct.
- #initialize_copy(orig) ⇒ Object
-
#method_missing(mid, *args) ⇒ Object
Adapted implementation of method_missing to accommodate the differences between ROS and OS.
-
#new_ostruct_member(name) ⇒ Object
(also: #new_ostruct_member!)
TODO: Rename to new_ostruct_member! once we care less about Rubies before 2.4.0.
-
#respond_to_missing?(mid, include_private = false) ⇒ Boolean
Makes sure ROS responds as expected on #respond_to? and #method requests.
- #to_h ⇒ Object (also: #to_hash)
Methods included from DebugInspect
#debug_inspect, #display_recursive_open_struct
Methods included from 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, ={}) hash ||= {} @options = self.class..merge!().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.
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 |
# File 'lib/recursive_open_struct.rb', line 111 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. { mutate_input_hash: false, recurse_over_arrays: false, preserve_original_keys: false } end |
Instance Method Details
#[](name) ⇒ Object
75 76 77 78 79 80 81 82 83 84 85 86 |
# File 'lib/recursive_open_struct.rb', line 75 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
89 90 91 92 93 94 |
# File 'lib/recursive_open_struct.rb', line 89 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
162 163 164 165 166 167 |
# File 'lib/recursive_open_struct.rb', line 162 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
44 45 46 47 48 49 50 51 |
# File 'lib/recursive_open_struct.rb', line 44 def initialize_copy(orig) super # deep copy the table to separate the two objects @table = @deep_dup.call(@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.
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 |
# File 'lib/recursive_open_struct.rb', line 137 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
104 105 106 107 |
# File 'lib/recursive_open_struct.rb', line 104 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
54 55 56 |
# File 'lib/recursive_open_struct.rb', line 54 def to_h @deep_dup.call(@table) end |