class OpenStruct

要約

要素を動的に追加・削除できる手軽な構造体を提供するクラスです。

OpenStruct のインスタンスに対して未定義なメソッド x= を呼ぶと、 OpenStruct クラスの BasicObject#method_missing で捕捉され、そのインスタンスにインスタンスメソッド x, x= が定義されます。この挙動によって要素を動的に変更できる構造体として働きます。

require 'ostruct'
ab = OpenStruct.new
ab.foo = 25
p ab.foo          # => 25
ab.bar = 2
p ab.bar          # => 2
p ab              # => <OpenStruct foo=25, bar=2>
ab.delete_field("foo")
p ab.foo          # => nil
p ab              # => <OpenStruct bar=2>

初期化にハッシュを使用することもできます。

require 'ostruct'
son = OpenStruct.new({ :name => "Thomas", :age => 3 })
p son.name        # => "Thomas"
p son.age         # => 3
son.age += 1
p son.age         # => 4
son.items = ["candy","toy"]
p son.items       # => ["candy","toy"]
p son             # => #<OpenStruct name="Thomas", age=4, items=["candy", "toy"]>

注意事項

OpenStruct は Ruby のメソッド探索を利用して、プロパティに必要なメソッドを見つけて定義します。これは BasicObject#method_missing と BasicObject#define_singleton_method によって実現されます。

作成されるオブジェクトのパフォーマンスに懸念がある場合は、この点を考慮する必要があります。Hash や Struct を使用する場合と比較して、これらのプロパティの設定にははるかに多くのオーバーヘッドがあるためです。小規模な Hash から OpenStruct を作成し、いくつかの要素にアクセスした場合、直接ハッシュテーブルにアクセスするよりも 200 倍遅くなることがあります。

これは潜在的なセキュリティ問題です。信頼されていないユーザーデータ（例：JSON を用いたリクエスト）から OpenStruct を構築した場合、キーがメソッドを作成し、そのメソッド名が永久に GC されることがないため、DoS 攻撃を受ける可能性があります。

これは、Ruby バージョン間の非互換性の原因にもなります：

o = OpenStruct.new
p o.then          # => Ruby < 2.6 では nil、Ruby >= 2.6 では Enumerator

以下の方法では、組み込みライブラリのメソッドが上書きされる可能性があり、バグやセキュリティ上の問題が発生する可能性があります：

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

衝突を避けるために OpenStruct は ! で終わるメソッドは protected と private でのみ使用し、public な組み込みライブラリの ! で終わるメソッドはエイリアスを定義しています：

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

! で終わるフィールドは使用しないことが推奨されます（ただし、強制ではありません）。サブクラスのメソッドを上書きすることはできませんし、! で終わる OpenStruct 自身のメソッドを上書きすることもできません。

以上の理由から OpenStruct を一切使用しないことを検討してください。

目次

特異メソッド

• new

インスタンスメソッド

• ==
• []
• []=
• delete_field
• dig
• each_pair
• eql?
• hash
• inspect
• to_h
• to_s

protectedメソッド

• modifiable
• new_ostruct_member

追加されるメソッド

• json_create
• to_json

定数

• InspectKey

特異メソッド

new(hash = nil) -> OpenStruct[permalink][rdoc][edit]

OpenStruct オブジェクトを生成します。

ハッシュが与えられたとき、それぞれのキーを生成したオブジェクトの要素にし、値をセットします。

[PARAM] hash:

設定する要素とその値を指定します。 hash には Hash クラスのインスタンス、または each_pair メソッドを持つオブジェクトを用いる事ができます。

[EXCEPTION] NoMethodError:

hash のキーが to_sym メソッドを持たないときに発生します。

require 'ostruct'
some1 = OpenStruct.new({:a =>"a",:b =>"b"}) # => #<OpenStruct b="b", a="a">

インスタンスメソッド

self == other -> bool[permalink][rdoc][edit]

自身と比較対象のオブジェクトが等しい場合に真を返します。そうでない場合は、偽を返します。

[PARAM] other:

比較対象のオブジェクトを指定します。

self[name] -> objectRuby 2.0.0 から[permalink][rdoc][edit]

引数 name で指定した要素に対応する値を返します。

[PARAM] name:

要素の名前を文字列か Symbol オブジェクトで指定します。

例

require 'ostruct'
person = OpenStruct.new('name' => 'John Smith', 'age' => 70)
person[:age] # => 70, person.age と同じ

self[name] = valueRuby 2.0.0 から[permalink][rdoc][edit]

引数 name で指定した要素に対応する値に value をセットします。

[PARAM] name:

要素の名前を文字列か Symbol オブジェクトで指定します。

[PARAM] value:

セットする値を指定します。

例

require 'ostruct'
person = OpenStruct.new('name' => 'John Smith', 'age' => 70)
person[:age] = 42 # person.age = 42 と同じ
person.age # => 42

delete_field(name) -> object[permalink][rdoc][edit]

nameで指定された要素を削除します。

その後その要素を参照したら nil が返ります。

[PARAM] name:

削除する要素を文字列かシンボルで指定します。

[RETURN]

削除前の要素の値を返します。

dig(key, ...) -> object | nilRuby 2.3.0 から[permalink][rdoc][edit]

self 以下のネストしたオブジェクトを dig メソッドで再帰的に参照して返します。途中のオブジェクトが nil であった場合は nil を返します。

[PARAM] key:

キーを任意個指定します。

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

[SEE_ALSO] Array#dig, Hash#dig, Struct#dig

each_pair -> EnumeratorRuby 2.0.0 から[permalink][rdoc][edit]

each_pair { |key, value| } -> self

self の各要素の名前と要素を引数としてブロックを評価します。

ブロックを指定した場合は self を返します。そうでない場合は Enumerator を返します。

例

require 'ostruct'
data = OpenStruct.new("country" => "Australia", :population => 20_000_000)
p data.each_pair.to_a  # => [[:country, "Australia"], [:population, 20000000]]

eql?(other) -> boolRuby 2.0.0 から[permalink][rdoc][edit]

self と other が等しい場合に true を返します。そうでない場合は false を返します。

具体的には other が OpenStruct オブジェクトかそのサブクラスでかつ、 self の各要素を保持した内部の Hash が eql? で比較して等しい場合に true を返します。

[PARAM] other:

比較対象のオブジェクトを指定します。

hash -> IntegerRuby 2.0.0 から[permalink][rdoc][edit]

self のハッシュ値を返します。

inspect -> String[permalink][rdoc][edit]

to_s -> String

オブジェクトを人間が読める形式に変換した文字列を返します。

[SEE_ALSO] Object#inspect

to_h -> { Symbol => object }Ruby 2.0.0 から[permalink][rdoc][edit]

to_h {|name, value| block } -> Hash

self を各要素の名前をキー(Symbol)、要素が値のハッシュに変換して返します。

ブロックを指定すると各ペアでブロックを呼び出し、その結果をペアとして使います。

例

require 'ostruct'
data = OpenStruct.new("country" => "Australia", :capital => "Canberra")
p data.to_h # => {:country => "Australia", :capital => "Canberra" }
p data.to_h {|name, value| [name.to_s, value.upcase] }
            # => {"country" => "AUSTRALIA", "capital" => "CANBERRA" }

protectedメソッド

modifiable -> Hash[permalink][rdoc][edit]

このメソッドは内部的に使用されます。

自身が Object#freeze されている場合にこのメソッドを呼び出すと例外が発生します。

[EXCEPTION] TypeError:

自身が Object#freeze されている場合に発生します。

new_ostruct_member(name) -> Symbol[permalink][rdoc][edit]

与えられた名前のアクセサメソッドを自身に定義します。

[PARAM] name:

文字列かシンボルで定義するアクセサの名前を指定します。

追加されるメソッド

json_create(hash) -> OpenStructRuby 2.1.0 から[permalink][rdoc][edit] [added by json/add/ostruct]

JSON のオブジェクトから OpenStruct のオブジェクトを生成して返します。

[PARAM] hash:

OpenStruct.new に指定可能な値をキー 't' もしくは :t に持つハッシュを指定します。

to_json(*args) -> StringRuby 2.1.0 から[permalink][rdoc][edit] [added by json/add/ostruct]

自身を JSON 形式の文字列に変換して返します。

内部的にはハッシュにデータをセットしてから JSON::Generator::GeneratorMethods::Hash#to_json を呼び出しています。

[PARAM] args:

引数はそのまま JSON::Generator::GeneratorMethods::Hash#to_json に渡されます。

[SEE_ALSO] JSON::Generator::GeneratorMethods::Hash#to_json

定数

InspectKey -> :__inspect_key__[permalink][rdoc][edit]

内部的に使用する定数です。