класс 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. Создание объекта OpenStruct из небольшого 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.