класс 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[:"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

Совместимость с Ractor: замороженный объект OpenStruct с совместно используемыми значениями сам является совместно используемым.

Предостережения

OpenStruct использует механизм поиска методов Ruby для поиска и определения необходимых методов свойств. Это достигается с помощью методов method_missing и define_singleton_method.

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

Это может представлять угрозу безопасности: создание OpenStruct из недоверенных пользовательских данных (например, веб-запроса JSON) может сделать приложение уязвимым для атаки типа «отказ в обслуживании символами», поскольку ключи создают методы, а имена методов никогда не удаляются сборщиком мусора.

Это также может стать причиной несовместимости между версиями Ruby:

o = OpenStruct.new
o.then # => nil in Ruby < 2.6, enumerator for Ruby >= 2.6

Таким образом могут быть переопределены встроенные методы, что может привести к ошибкам или проблемам с безопасностью:

o = OpenStruct.new
o.methods # => [:to_h, :marshal_load, :marshal_dump, :each_pair, ...
o.methods = [:foo, :bar]
o.methods # => [:foo, :bar]

Чтобы уменьшить вероятность конфликтов, OpenStruct использует только защищённые/приватные методы, заканчивающиеся на !, и определяет псевдонимы для встроенных публичных методов, добавляя !:

o = OpenStruct.new(make: 'Bentley', class: :luxury)
o.class # => :luxury
o.class! # => OpenStruct

Рекомендуется (но это не запрещено) не использовать поля, заканчивающиеся на !. Обратите внимание, что методы подкласса не могут быть переопределены, как и собственные методы OpenStruct, заканчивающиеся на !.

По всем этим причинам рекомендуется вообще не использовать OpenStruct.