класс OpenStruct
Структура данных OpenStruct, аналогичная хешу, позволяет определять произвольные атрибуты со значениями. Это достигается с помощью метапрограммирования Ruby для определения методов в самом классе.
Примеры
require "ostruct" person = OpenStruct.new person.name = "John Smith" person.age = 70 person.name # => "John Smith" person.age # => 70 person.address # => nil
OpenStruct использует хеш внутри для хранения атрибутов и значений и даже может быть инициализирован с помощью него:
australia = OpenStruct.new(:country => "Australia", :capital => "Canberra") # => #<OpenStruct country="Australia", capital="Canberra">
Ключи хеша с пробелами или символами, которые обычно не могут использоваться для вызовов методов (например, ()[]*) не будут сразу доступны в объекте OpenStruct как метод для извлечения или присвоения, но всё ещё могут быть достигнуты через метод Object#send.
measurements = OpenStruct.new("length (in inches)" => 24)
measurements.send("length (in inches)") # => 24
message = OpenStruct.new(:queued? => true)
message.queued? # => true
message.send("queued?=", false)
message.queued? # => false
Для удаления атрибута требуется выполнить метод #delete_field, так как установка значения свойства в nil не удалит атрибут.
first_pet = OpenStruct.new(:name => "Rowdy", :owner => "John Smith") second_pet = OpenStruct.new(:name => "Rowdy") first_pet.owner = nil first_pet # => #<OpenStruct name="Rowdy", owner=nil> first_pet == second_pet # => false first_pet.delete_field(:owner) first_pet # => #<OpenStruct name="Rowdy"> first_pet == second_pet # => true
Реализация
OpenStruct использует структуру поиска методов Ruby для поиска и определения необходимых методов для свойств. Это достигается с помощью методов method_missing и define_singleton_method.
Это следует учитывать, если есть опасения по поводу производительности создаваемых объектов, так как при настройке этих свойств гораздо больше накладных расходов по сравнению с использованием хеша или структуры.
Публичные методы класса
# File lib/ostruct.rb, line 89
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 Создаёт новый объект OpenStruct. По умолчанию, создаваемый объект OpenStruct не имеет атрибутов.
Необязательный hash, если задан, сгенерирует атрибуты и значения (может быть хешем, OpenStruct или структурой). Например:
require "ostruct"
hash = { "country" => "Australia", :capital => "Canberra" }
data = OpenStruct.new(hash)
data # => #<OpenStruct country="Australia", capital="Canberra">
Публичные методы экземпляра
# File lib/ostruct.rb, line 293 def ==(other) return false unless other.kind_of?(OpenStruct) @table == other.table end
Сравнивает этот объект и other на равенство. OpenStruct равен other, когда other является OpenStruct и таблицы хешей двух объектов равны.
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
# File lib/ostruct.rb, line 208 def [](name) @table[name.to_sym] end
Возвращает значение атрибута.
require "ostruct"
person = OpenStruct.new("name" => "John Smith", "age" => 70)
person[:age] # => 70, same as person.age
# File lib/ostruct.rb, line 223 def []=(name, value) modifiable[new_ostruct_member(name)] = value end
Устанавливает значение атрибута.
require "ostruct"
person = OpenStruct.new("name" => "John Smith", "age" => 70)
person[:age] = 42 # equivalent to person.age = 42
person.age # => 42
# File ext/json/lib/json/add/ostruct.rb, line 16
def as_json(*)
klass = self.class.name
klass.to_s.empty? and raise JSON::JSONError, "Only named structs are supported!"
{
JSON.create_id => klass,
't' => table,
}
end Возвращает хеш, который будет преобразован в объект JSON и представлять этот объект.
# File lib/ostruct.rb, line 243
def delete_field(name)
sym = name.to_sym
singleton_class.__send__(:remove_method, sym, "#{sym}=")
@table.delete sym
end Удаляет поле с указанным именем из объекта. Возвращает значение, содержащееся в поле, если оно было определено.
require "ostruct"
person = OpenStruct.new(name: "John", age: 70, pension: 300)
person.delete_field("age") # => 70
person # => #<OpenStruct name="John", pension=300>
Установка значения в nil не удалит атрибут:
person.pension = nil person # => #<OpenStruct name="John", pension=nil>
# File lib/ostruct.rb, line 131
def each_pair
return to_enum(__method__) { @table.size } unless block_given?
@table.each_pair{|p| yield p}
self
end Вызывает блок для всех атрибутов (как символы) вместе с соответствующими значениями или возвращает перечислитель, если блок не задан.
require "ostruct"
data = OpenStruct.new("country" => "Australia", :capital => "Canberra")
data.each_pair.to_a # => [[:country, "Australia"], [:capital, "Canberra"]]
# File lib/ostruct.rb, line 303 def eql?(other) return false unless other.kind_of?(OpenStruct) @table.eql?(other.table) end
Сравнивает этот объект и other на равенство. OpenStruct равен other, когда other является OpenStruct и таблицы хешей двух объектов равны.
# File lib/ostruct.rb, line 313 def hash @table.hash end
Вычисляет хэш-код для этого OpenStruct. Два объекта OpenStruct с одинаковым содержимым будут иметь одинаковый хэш-код (и сравнятся с помощью eql?).
См. также Object#hash.
# File lib/ostruct.rb, line 254
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 Возвращает строку, содержащую подробное описание ключей и значений.
# File lib/ostruct.rb, line 140 def marshal_dump @table end
Обеспечивает поддержку маршалинга для использования библиотекой Marshal.
# File lib/ostruct.rb, line 147
def marshal_load(x)
@table = x
@table.each_key{|key| new_ostruct_member(key)}
end Обеспечивает поддержку маршалинга для использования библиотекой Marshal.
# File lib/ostruct.rb, line 115 def to_h @table.dup end
Преобразует OpenStruct в хеш с ключами, представляющими каждый атрибут (как символы) и их соответствующими значениями.
require "ostruct"
data = OpenStruct.new("country" => "Australia", :capital => "Canberra")
data.to_h # => {:country => "Australia", :capital => "Canberra" }
# File ext/json/lib/json/add/ostruct.rb, line 27 def to_json(*args) as_json.to_json(*args) end
Сохраняет имя класса (OpenStruct) со значениями этой структуры v как строку JSON.
Защищённые методы экземпляра
# File lib/ostruct.rb, line 156
def modifiable
begin
@modifiable = true
rescue
raise RuntimeError, "can't modify frozen #{self.class}", caller(3)
end
@table
end Используется внутри для проверки, может ли OpenStruct быть изменён, прежде чем предоставить доступ к внутренней таблице хеша для изменения.
# File lib/ostruct.rb, line 171
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 Используется внутри для определения свойств в OpenStruct. Это делается путём использования метапрограммного метода define_singleton_method как для метода-получателя, так и для метода-установщика.
Ruby Core © 1993–2017 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.