Spec-Zone.ru › Ruby 2.6

класс OpenStruct

Родитель:
Объект

Структура данных OpenStruct, похожая на Hash, позволяет определять произвольные атрибуты со значениями. Это достигается с помощью метапрограммирования Ruby для определения методов в самом классе.

Примеры

require "ostruct"

person = OpenStruct.new
person.name = "John Smith"
person.age  = 70

person.name      # => "John Smith"
person.age       # => 70
person.address   # => nil

Объект OpenStruct использует Hash для хранения атрибутов и значений и может быть инициализирован им:

australia = OpenStruct.new(:country => "Australia", :capital => "Canberra")
  # => #<OpenStruct country="Australia", capital="Canberra">

Ключи Hash с пробелами или символами, которые обычно не могут использоваться для вызова методов (например, ()[]*), не будут сразу доступны в объекте 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.

Это следует учитывать, если есть опасения по поводу производительности созданных объектов, так как установка этих свойств требует больше накладных расходов по сравнению с использованием Hash или Struct.

Методы публичного класса

json_create(object) Показать исходный код
# File ext/json/lib/json/add/ostruct.rb, line 11
def self.json_create(object)
  new(object['t'] || object[:t])
end

Десериализует строку JSON, создавая новый объект Struct со значениями t , сериализованными с помощью to_json.

new(hash=nil) Показать исходный код
# File lib/ostruct.rb, line 91
def initialize(hash=nil)
  @table = {}
  if hash
    hash.each_pair do |k, v|
      k = k.to_sym
      @table[k] = v
    end
  end
end

Создаёт новый объект OpenStruct. По умолчанию, создаваемый объект OpenStruct не будет содержать атрибутов.

Необязательный hash, если задан, сгенерирует атрибуты и значения (может быть Hash, OpenStruct или Struct). Например:

require "ostruct"
hash = { "country" => "Australia", :capital => "Canberra" }
data = OpenStruct.new(hash)

data   # => #<OpenStruct country="Australia", capital="Canberra">

Методы публичного экземпляра

==(other) Показать исходный код
# File lib/ostruct.rb, line 359
def ==(other)
  return false unless other.kind_of?(OpenStruct)
  @table == other.table!
end

Сравнивает этот объект и other на равенство. Объект OpenStruct равен other, когда other является объектом OpenStruct, и таблицы Hash этих двух объектов равны.

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
ostruct[name] → object Показать исходный код
# File lib/ostruct.rb, line 244
def [](name)
  @table[name.to_sym]
end

Возвращает значение атрибута.

require "ostruct"
person = OpenStruct.new("name" => "John Smith", "age" => 70)
person[:age]   # => 70, same as person.age
ostruct[name] = obj → obj Показать исходный код
# File lib/ostruct.rb, line 259
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
as_json(*) Показать исходный код
# File ext/json/lib/json/add/ostruct.rb, line 17
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 и представлять этот объект.

delete_field(name) Показать исходный код
# File lib/ostruct.rb, line 308
def delete_field(name)
  sym = name.to_sym
  begin
    singleton_class.remove_method(sym, "#{sym}=")
  rescue NameError
  end
  @table.delete(sym) do
    raise NameError.new("no field `#{sym}' in #{self}", sym)
  end
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>
dig(name, ...) → object Показать исходный код
# File lib/ostruct.rb, line 283
def dig(name, *names)
  begin
    name = name.to_sym
  rescue NoMethodError
    raise TypeError, "#{name} is not a symbol nor a string"
  end
  @table.dig(name, *names)
end

Извлекает вложенное значение, указанное последовательностью объектов name, вызывая dig на каждом шаге, возвращая nil, если любой промежуточный шаг 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]])

data.dig(:array, 1, 0)   # => 2
data.dig(:array, 0, 0)   # TypeError: Integer does not have #dig method
each_pair {|name, value| block } → ostruct Показать исходный код
each_pair → Enumerator
# File lib/ostruct.rb, line 144
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"]]
eql?(other) Показать исходный код
# File lib/ostruct.rb, line 369
def eql?(other)
  return false unless other.kind_of?(OpenStruct)
  @table.eql?(other.table!)
end

Сравнивает этот объект и other на равенство. Объект OpenStruct eql? с other, когда other является объектом OpenStruct, и таблицы Hash этих двух объектов eql?.

freeze() Показать исходный код
# File lib/ostruct.rb, line 202
def freeze
  @table.each_key {|key| new_ostruct_member!(key)}
  super
end
Вызов метода суперкласса Object#freeze
hash() Показать исходный код
# File lib/ostruct.rb, line 379
def hash
  @table.hash
end

Вычисляет хэш-код для этого объекта OpenStruct. Два объекта OpenStruct с одинаковым содержимым будут иметь одинаковый хэш-код (и будут сравниваться с помощью eql?).

См. также Object#hash.

inspect() Показать исходный код
# File lib/ostruct.rb, line 324
def inspect
  ids = (Thread.current[InspectKey] ||= [])
  if ids.include?(object_id)
    detail = ' ...'
  else
    ids << object_id
    begin
      detail = @table.map do |key, value|
        " #{key}=#{value.inspect}"
      end.join(',')
    ensure
      ids.pop
    end
  end
  ['#<', self.class, detail, '>'].join
end

Возвращает строку, содержащую подробное описание ключей и значений.

Также алиас для: to_s
marshal_dump() Показать исходный код
# File lib/ostruct.rb, line 153
def marshal_dump
  @table
end

Обеспечивает поддержку маршалинга для использования библиотекой Marshal.

marshal_load(x) Показать исходный код
# File lib/ostruct.rb, line 160
def marshal_load(x)
  @table = x
end

Обеспечивает поддержку маршалинга для использования библиотекой Marshal.

to_h → hash Показать исходный код
to_h {|name, value| block } → hash
# File lib/ostruct.rb, line 124
def to_h(&block)
  if block_given?
    @table.to_h(&block)
  else
    @table.dup
  end
end

Преобразует OpenStruct в хеш, где ключи представляют каждый атрибут (как символы) и их соответствующие значения.

Если задан блок, результаты блока для каждой пары получателя будут использоваться в качестве пар.

require "ostruct"
data = OpenStruct.new("country" => "Australia", :capital => "Canberra")
data.to_h   # => {:country => "Australia", :capital => "Canberra" }
data.to_h {|name, value| [name.to_s, value.upcase] }
            # => {"country" => "AUSTRALIA", "capital" => "CANBERRA" }
to_json(*args) Показать исходный код
# File ext/json/lib/json/add/ostruct.rb, line 28
def to_json(*args)
  as_json.to_json(*args)
end

Сохраняет имя класса (OpenStruct) со значениями этой структуры v в виде строки JSON.

to_s()
Псевдоним для: inspect

Ruby Core © 1993–2017 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API