OpenStruct

Creates a new OpenStruct object. By default, the resulting OpenStruct object will have no attributes.

The optional hash, if given, will generate attributes and values (can be a Hash, an OpenStruct or a Struct). For example:

require 'ostruct'
hash = { "country" => "Australia", :population => 20_000_000 }
data = OpenStruct.new(hash)
p data # -> <OpenStruct country="Australia" population=20000000>

 
 # File ostruct.rb, line 87
def initialize(hash=nil)
 @table = {}
 if hash
 hash.each_pair do |k, v|
 k = k.to_sym
 @table[k] = v
 new_ostruct_member(k)
 end
 end
end
 

Compares this object and other for equality. An OpenStruct is equal to other when other is an OpenStruct and the two objects' Hash tables are equal.

 
 # File ostruct.rb, line 265
def ==(other)
 return false unless other.kind_of?(OpenStruct)
 @table == other.table
end
 

Returns the value of a member.

person = OpenStruct.new('name' => 'John Smith', 'age' => 70)
person[:age] # => 70, same as ostruct.age

 
 # File ostruct.rb, line 198
def [](name)
 @table[name.to_sym]
end
 

Sets the value of a member.

person = OpenStruct.new('name' => 'John Smith', 'age' => 70)
person[:age] = 42 # => equivalent to ostruct.age = 42
person.age # => 42

 
 # File ostruct.rb, line 209
def []=(name, value)
 modifiable[new_ostruct_member(name)] = value
end
 

Remove the named field from the object. Returns the value that the field contained if it was defined.

require 'ostruct'
person = OpenStruct.new('name' => 'John Smith', 'age' => 70)
person.delete_field('name') # => 'John Smith'

 
 # File ostruct.rb, line 223
def delete_field(name)
 sym = name.to_sym
 singleton_class.__send__(:remove_method, sym, "#{sym}=")
 @table.delete sym
end
 

Yields all attributes (as a symbol) along with the corresponding values or returns an enumerator if not block is given. Example:

require 'ostruct'
data = OpenStruct.new("country" => "Australia", :population => 20_000_000)
data.each_pair.to_a # => [[:country, "Australia"], [:population, 20000000]]

 
 # File ostruct.rb, line 127
def each_pair
 return to_enum(__method__) { @table.size } unless block_given?
 @table.each_pair{|p| yield p}
end
 

Compares this object and other for equality. An OpenStruct is eql? to other when other is an OpenStruct and the two objects' Hash tables are eql?.

 
 # File ostruct.rb, line 275
def eql?(other)
 return false unless other.kind_of?(OpenStruct)
 @table.eql?(other.table)
end
 

Compute a hash-code for this OpenStruct. Two hashes with the same content will have the same hash code (and will be eql?).

 
 # File ostruct.rb, line 283
def hash
 @table.hash
end
 

Duplicate an OpenStruct object members.

 
 # File ostruct.rb, line 99
def initialize_copy(orig)
 super
 @table = @table.dup
 @table.each_key{|key| new_ostruct_member(key)}
end
 

Returns a string containing a detailed summary of the keys and values.

 
 # File ostruct.rb, line 234
def inspect
 str = "#<#{self.class}"
 ids = (Thread.current[InspectKey] ||= [])
 if ids.include?(object_id)
 return str << ' ...>'
 end
 ids << object_id
 begin
 first = true
 for k,v in @table
 str << "," unless first
 first = false
 str << " #{k}=#{v.inspect}"
 end
 return str << '>'
 ensure
 ids.pop
 end
end
 

Provides marshalling support for use by the Marshal library.

 
 # File ostruct.rb, line 135
def marshal_dump
 @table
end
 

Provides marshalling support for use by the Marshal library.

 
 # File ostruct.rb, line 142
def marshal_load(x)
 @table = x
 @table.each_key{|key| new_ostruct_member(key)}
end
 

Converts the OpenStruct to a hash with keys representing each attribute (as symbols) and their corresponding values Example:

require 'ostruct'
data = OpenStruct.new("country" => "Australia", :population => 20_000_000)
data.to_h # => {:country => "Australia", :population => 20000000 }

 
 # File ostruct.rb, line 114
def to_h
 @table.dup
end
 

Used internally to check if the OpenStruct is able to be modified before granting access to the internal Hash table to be modified.

 
 # File ostruct.rb, line 151
def modifiable
 begin
 @modifiable = true
 rescue
 raise RuntimeError, "can't modify frozen #{self.class}", caller(3)
 end
 @table
end
 

Used internally to defined properties on the OpenStruct. It does this by using the metaprogramming function define_singleton_method for both the getter method and the setter method.

 
 # File ostruct.rb, line 166
def new_ostruct_member(name)
 name = name.to_sym
 unless respond_to?(name)
 define_singleton_method(name) { @table[name] }
 define_singleton_method("#{name}=") { |x| modifiable[name] = x }
 end
 name
end