Project

General

Profile

Download (10.1 KB)

Bug #13159 ยป doc_ostruct.patch

stomar (Marcus Stollsteimer), 02/03/2017 09:01 PM

View differences:

lib/ostruct.rb
# accomplished by using Ruby's metaprogramming to define methods on the class
# itself.
#
# == Examples:
# == Examples
#
# require 'ostruct'
# require "ostruct"
#
# person = OpenStruct.new
# person.name = "John Smith"
# person.age = 70
# person.pension = 300
# person.name = "John Smith"
# person.age = 70
#
# puts person.name # -> "John Smith"
# puts person.age # -> 70
# puts person.address # -> nil
# person.name # => "John Smith"
# person.age # => 70
# person.address # => nil
#
# An OpenStruct employs a Hash internally to store the methods and values and
# can even be initialized with one:
# An OpenStruct employs a Hash internally to store the attributes and values
# and can even be initialized with one:
#
# australia = OpenStruct.new(:country => "Australia", :population => 20_000_000)
# p australia # -> <OpenStruct country="Australia" population=20000000>
# australia = OpenStruct.new(:country => "Australia", :capital => "Canberra")
# # => #<OpenStruct country="Australia", capital="Canberra">
#
# Hash keys with spaces or characters that would normally not be able to use for
# method calls (e.g. ()[]*) will not be immediately available on the
# OpenStruct object as a method for retrieval or assignment, but can be still be
# reached through the Object#send method.
# Hash keys with spaces or characters that could normally not be used for
# method calls (e.g. <code>()[]*</code>) will not be immediately available
# on the OpenStruct object as a method for retrieval or assignment, but can
# still be reached through the Object#send method.
#
# measurements = OpenStruct.new("length (in inches)" => 24)
# measurements.send("length (in inches)") # -> 24
# measurements.send("length (in inches)") # => 24
#
# data_point = OpenStruct.new(:queued? => true)
# data_point.queued? # -> true
# data_point.send("queued?=",false)
# data_point.queued? # -> false
# message = OpenStruct.new(:queued? => true)
# message.queued? # => true
# message.send("queued?=", false)
# message.queued? # => false
#
# Removing the presence of a method requires the execution the delete_field
# method as setting the property value to +nil+ will not remove the method.
# Removing the presence of an attribute requires the execution of the
# delete_field method as setting the property value to +nil+ will not
# remove the attribute.
#
# first_pet = OpenStruct.new(:name => 'Rowdy', :owner => 'John Smith')
# first_pet.owner = nil
# second_pet = OpenStruct.new(:name => 'Rowdy')
# first_pet = OpenStruct.new(:name => "Rowdy", :owner => "John Smith")
# second_pet = OpenStruct.new(:name => "Rowdy")
#
# first_pet == second_pet # -> false
# first_pet.owner = nil
# first_pet # => #<OpenStruct name="Rowdy", owner=nil>
# first_pet == second_pet # => false
#
# first_pet.delete_field(:owner)
# first_pet == second_pet # -> true
# first_pet # => #<OpenStruct name="Rowdy">
# first_pet == second_pet # => true
#
#
# == Implementation:
# == Implementation
#
# An OpenStruct utilizes Ruby's method lookup structure to find and define the
# necessary methods for properties. This is accomplished through the method
# method_missing and define_method.
# necessary methods for properties. This is accomplished through the methods
# method_missing and define_singleton_method.
#
# This should be a consideration if there is a concern about the performance of
# the objects that are created, as there is much more overhead in the setting
......
# (can be a Hash, an OpenStruct or a Struct).
# For example:
#
# require 'ostruct'
# hash = { "country" => "Australia", :population => 20_000_000 }
# require "ostruct"
# hash = { "country" => "Australia", :capital => "Canberra" }
# data = OpenStruct.new(hash)
#
# p data # -> <OpenStruct country="Australia" population=20000000>
# data # => #<OpenStruct country="Australia", capital="Canberra">
#
def initialize(hash=nil)
@table = {}
......
end
end
# Duplicate an OpenStruct object members.
def initialize_copy(orig)
# Duplicates an OpenStruct object's Hash table.
def initialize_copy(orig) # :nodoc:
super
@table = @table.dup
end
#
# Converts the OpenStruct to a hash with keys representing
# each attribute (as symbols) and their corresponding values
# 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 }
# require "ostruct"
# data = OpenStruct.new("country" => "Australia", :capital => "Canberra")
# data.to_h # => {:country => "Australia", :capital => "Canberra" }
#
def to_h
@table.dup
end
#
# Yields all attributes (as a symbol) along with the corresponding values
# or returns an enumerator if not block is given.
# :call-seq:
# ostruct.each_pair {|name, value| block } -> ostruct
# ostruct.each_pair -> Enumerator
#
# Yields all attributes (as symbols) along with the corresponding values
# or returns an enumerator if no block is given.
# Example:
#
# require 'ostruct'
# data = OpenStruct.new("country" => "Australia", :population => 20_000_000)
# data.each_pair.to_a # => [[:country, "Australia"], [:population, 20000000]]
# require "ostruct"
# data = OpenStruct.new("country" => "Australia", :capital => "Canberra")
# data.each_pair.to_a # => [[:country, "Australia"], [:capital, "Canberra"]]
#
def each_pair
return to_enum(__method__) { @table.size } unless block_given?
......
super
end
def respond_to_missing?(mid, include_private = false)
def respond_to_missing?(mid, include_private = false) # :nodoc:
mname = mid.to_s.chomp("=").to_sym
@table.key?(mname) || super
end
......
end
end
# Returns the value of a member.
# Returns the value of an attribute.
#
# person = OpenStruct.new('name' => 'John Smith', 'age' => 70)
# person[:age] # => 70, same as ostruct.age
# require "ostruct"
# person = OpenStruct.new("name" => "John Smith", "age" => 70)
# person[:age] # => 70, same as person.age
#
def [](name)
@table[name.to_sym]
end
#
# Sets the value of a member.
# Sets the value of an attribute.
#
# person = OpenStruct.new('name' => 'John Smith', 'age' => 70)
# person[:age] = 42 # => equivalent to ostruct.age = 42
# person.age # => 42
# require "ostruct"
# person = OpenStruct.new("name" => "John Smith", "age" => 70)
# person[:age] = 42 # equivalent to person.age = 42
# person.age # => 42
#
def []=(name, value)
modifiable?[new_ostruct_member!(name)] = value
end
#
# Retrieves the value object corresponding to the each +name+
# objects repeatedly.
# Extracts the nested value specified by the sequence of +name+
# objects by calling +dig+ at each step, returning +nil+ if any
# intermediate step is +nil+.
#
# require "ostruct"
# address = OpenStruct.new("city" => "Anytown NC", "zip" => 12345)
# person = OpenStruct.new("name" => "John Smith", "address" => address)
#
# person.dig(:address, "zip") # => 12345
# person.dig(:business_address, "zip") # => nil
#
# data = OpenStruct.new(:array => [1, [2, 3]])
#
# address = OpenStruct.new('city' => "Anytown NC", 'zip' => 12345)
# person = OpenStruct.new('name' => 'John Smith', 'address' => address)
# person.dig(:address, 'zip') # => 12345
# person.dig(:business_address, 'zip') # => nil
# data.dig(:array, 1, 0) # => 2
# data.dig(:array, 0, 0) # TypeError: Integer does not have #dig method
#
def dig(name, *names)
begin
......
end
#
# Remove the named field from the object. Returns the value that the field
# Removes the named field from the object. Returns the value that the field
# contained if it was defined.
#
# require 'ostruct'
# require "ostruct"
#
# person = OpenStruct.new('name' => 'John Smith', 'age' => 70)
# person = OpenStruct.new(name: "John", age: 70, pension: 300)
#
# person.delete_field('name') # => 'John Smith'
# person.delete_field("age") # => 70
# person # => #<OpenStruct name="John", pension=300>
#
# Setting the value to +nil+ will not remove the attribute:
#
# person.pension = nil
# person # => #<OpenStruct name="John", pension=nil>
#
def delete_field(name)
sym = name.to_sym
......
# +other+ when +other+ is an OpenStruct and the two objects' Hash tables are
# equal.
#
# require "ostruct"
# first_pet = OpenStruct.new("name" => "Rowdy")
# second_pet = OpenStruct.new(:name => "Rowdy")
# third_pet = OpenStruct.new("name" => "Rowdy", :age => nil)
#
# first_pet == second_pet # => true
# first_pet == third_pet # => false
#
def ==(other)
return false unless other.kind_of?(OpenStruct)
@table == other.table!
......
@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?).
# Computes a hash code for this OpenStruct.
# Two OpenStruct objects with the same content will have the same hash code
# (and will compare using #eql?).
#
# See also Object#hash.
def hash
@table.hash
end
    (1-1/1)