summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHiroshi SHIBATA <[email protected]>2025-01-08 09:58:48 +0900
committerHiroshi SHIBATA <[email protected]>2025-01-08 17:12:19 +0900
commit5f4be3ad7ea6d914f9d50d1da74eb801a02873a8 (patch)
tree6e2769a3e8f9f154cdc343db6fba82e91cf80d91
parentd722bdcf6e6d195faf4ed03bbd8b2c07686a925b (diff)
Make ostruct as bundled gems
Notes
Notes: Merged: https://github.com/ruby/ruby/pull/12531
-rw-r--r--gems/bundled_gems1
-rw-r--r--lib/ostruct.gemspec26
-rw-r--r--lib/ostruct.rb489
-rw-r--r--test/ostruct/test_ostruct.rb434
4 files changed, 1 insertions, 949 deletions
diff --git a/gems/bundled_gems b/gems/bundled_gems
index 4dd4160221..87421277f6 100644
--- a/gems/bundled_gems
+++ b/gems/bundled_gems
@@ -35,3 +35,4 @@ nkf 0.2.0 https://github.com/ruby/nkf
syslog 0.2.0 https://github.com/ruby/syslog
csv 3.3.2 https://github.com/ruby/csv
repl_type_completor 0.1.9 https://github.com/ruby/repl_type_completor
+ostruct 0.6.1 https://github.com/ruby/ostruct
diff --git a/lib/ostruct.gemspec b/lib/ostruct.gemspec
deleted file mode 100644
index 28b5f1f2c0..0000000000
--- a/lib/ostruct.gemspec
+++ /dev/null
@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-name = File.basename(__FILE__, ".gemspec")
-version = ["lib", Array.new(name.count("-")+1, ".").join("/")].find do |dir|
- break File.foreach(File.join(__dir__, dir, "#{name.tr('-', '/')}.rb")) do |line|
- /^\s*VERSION\s*=\s*"(.*)"/ =~ line and break $1
- end rescue nil
-end
-
-Gem::Specification.new do |spec|
- spec.name = name
- spec.version = version
- spec.authors = ["Marc-Andre Lafortune"]
- spec.email = ["[email protected]"]
-
- spec.summary = %q{Class to build custom data structures, similar to a Hash.}
- spec.description = %q{Class to build custom data structures, similar to a Hash.}
- spec.homepage = "https://github.com/ruby/ostruct"
- spec.licenses = ["Ruby", "BSD-2-Clause"]
- spec.required_ruby_version = ">= 2.5.0"
-
- spec.files = [".gitignore", "Gemfile", "COPYING", "BSDL", "README.md", "Rakefile", "bin/console", "bin/setup", "lib/ostruct.rb", "ostruct.gemspec"]
- spec.require_paths = ["lib"]
-
- spec.metadata["changelog_uri"] = spec.homepage + "/releases"
-end
diff --git a/lib/ostruct.rb b/lib/ostruct.rb
deleted file mode 100644
index 3793e5db01..0000000000
--- a/lib/ostruct.rb
+++ /dev/null
@@ -1,489 +0,0 @@
-# frozen_string_literal: true
-#
-# = ostruct.rb: OpenStruct implementation
-#
-# Author:: Yukihiro Matsumoto
-# Documentation:: Gavin Sinclair
-#
-# OpenStruct allows the creation of data objects with arbitrary attributes.
-# See OpenStruct for an example.
-#
-
-#
-# An OpenStruct is a data structure, similar to a Hash, that allows the
-# definition of arbitrary attributes with their accompanying values. This is
-# accomplished by using Ruby's metaprogramming to define methods on the class
-# itself.
-#
-# == Examples
-#
-# require "ostruct"
-#
-# person = OpenStruct.new
-# person.name = "John Smith"
-# person.age = 70
-#
-# person.name # => "John Smith"
-# person.age # => 70
-# person.address # => nil
-#
-# An OpenStruct employs a Hash internally to store the attributes and values
-# and can even be initialized with one:
-#
-# australia = OpenStruct.new(:country => "Australia", :capital => "Canberra")
-# # => #<OpenStruct country="Australia", capital="Canberra">
-#
-# Hash keys with spaces or characters that could normally not be used for
-# method calls (e.g. <code>()[]*</code>) will not be immediately available
-# on the OpenStruct object as a method for retrieval or assignment, but can
-# still be reached through the Object#send method or using [].
-#
-# 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
-#
-# Removing the presence of an attribute requires the execution of the
-# delete_field method as setting the property value to +nil+ will not
-# remove the attribute.
-#
-# 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 compatibility: A frozen OpenStruct with shareable values is itself shareable.
-#
-# == Caveats
-#
-# An OpenStruct utilizes Ruby's method lookup structure to find and define the
-# necessary methods for properties. This is accomplished through the methods
-# method_missing and define_singleton_method.
-#
-# This should be a consideration if there is a concern about the performance of
-# the objects that are created, as there is much more overhead in the setting
-# of these properties compared to using a Hash or a Struct.
-# Creating an open struct from a small Hash and accessing a few of the
-# entries can be 200 times slower than accessing the hash directly.
-#
-# This is a potential security issue; building OpenStruct from untrusted user data
-# (e.g. JSON web request) may be susceptible to a "symbol denial of service" attack
-# since the keys create methods and names of methods are never garbage collected.
-#
-# This may also be the source of incompatibilities between Ruby versions:
-#
-# o = OpenStruct.new
-# o.then # => nil in Ruby < 2.6, enumerator for Ruby >= 2.6
-#
-# Builtin methods may be overwritten this way, which may be a source of bugs
-# or security issues:
-#
-# o = OpenStruct.new
-# o.methods # => [:to_h, :marshal_load, :marshal_dump, :each_pair, ...
-# o.methods = [:foo, :bar]
-# o.methods # => [:foo, :bar]
-#
-# To help remedy clashes, OpenStruct uses only protected/private methods ending with <code>!</code>
-# and defines aliases for builtin public methods by adding a <code>!</code>:
-#
-# o = OpenStruct.new(make: 'Bentley', class: :luxury)
-# o.class # => :luxury
-# o.class! # => OpenStruct
-#
-# It is recommended (but not enforced) to not use fields ending in <code>!</code>;
-# Note that a subclass' methods may not be overwritten, nor can OpenStruct's own methods
-# ending with <code>!</code>.
-#
-# For all these reasons, consider not using OpenStruct at all.
-#
-class OpenStruct
- VERSION = "0.6.1"
-
- HAS_PERFORMANCE_WARNINGS = begin
- Warning[:performance]
- true
- rescue NoMethodError, ArgumentError
- false
- end
- private_constant :HAS_PERFORMANCE_WARNINGS
-
- #
- # Creates a new OpenStruct object. By default, the resulting OpenStruct
- # object will have no attributes.
- #
- # The optional +hash+, if given, will generate attributes and values
- # (can be a Hash, an OpenStruct or a Struct).
- # For example:
- #
- # require "ostruct"
- # hash = { "country" => "Australia", :capital => "Canberra" }
- # data = OpenStruct.new(hash)
- #
- # data # => #<OpenStruct country="Australia", capital="Canberra">
- #
- def initialize(hash=nil)
- if HAS_PERFORMANCE_WARNINGS && Warning[:performance]
- warn "OpenStruct use is discouraged for performance reasons", uplevel: 1, category: :performance
- end
-
- if hash
- update_to_values!(hash)
- else
- @table = {}
- end
- end
-
- # Duplicates an OpenStruct object's Hash table.
- private def initialize_clone(orig) # :nodoc:
- super # clones the singleton class for us
- @table = @table.dup unless @table.frozen?
- end
-
- private def initialize_dup(orig) # :nodoc:
- super
- update_to_values!(@table)
- end
-
- private def update_to_values!(hash) # :nodoc:
- @table = {}
- hash.each_pair do |k, v|
- set_ostruct_member_value!(k, v)
- end
- end
-
- #
- # call-seq:
- # ostruct.to_h -> hash
- # ostruct.to_h {|name, value| block } -> hash
- #
- # Converts the OpenStruct to a hash with keys representing
- # each attribute (as symbols) and their corresponding values.
- #
- # If a block is given, the results of the block on each pair of
- # the receiver will be used as pairs.
- #
- # 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" }
- #
- if {test: :to_h}.to_h{ [:works, true] }[:works] # RUBY_VERSION < 2.6 compatibility
- def to_h(&block)
- if block
- @table.to_h(&block)
- else
- @table.dup
- end
- end
- else
- def to_h(&block)
- if block
- @table.map(&block).to_h
- else
- @table.dup
- end
- end
- end
-
- #
- # :call-seq:
- # ostruct.each_pair {|name, value| block } -> ostruct
- # ostruct.each_pair -> Enumerator
- #
- # Yields all attributes (as symbols) along with the corresponding values
- # or returns an enumerator if no block is given.
- #
- # require "ostruct"
- # data = OpenStruct.new("country" => "Australia", :capital => "Canberra")
- # data.each_pair.to_a # => [[:country, "Australia"], [:capital, "Canberra"]]
- #
- def each_pair
- return to_enum(__method__) { @table.size } unless defined?(yield)
- @table.each_pair{|p| yield p}
- self
- end
-
- #
- # Provides marshalling support for use by the Marshal library.
- #
- def marshal_dump # :nodoc:
- @table
- end
-
- #
- # Provides marshalling support for use by the Marshal library.
- #
- alias_method :marshal_load, :update_to_values! # :nodoc:
-
- #
- # Used internally to defined properties on the
- # OpenStruct. It does this by using the metaprogramming function
- # define_singleton_method for both the getter method and the setter method.
- #
- def new_ostruct_member!(name) # :nodoc:
- unless @table.key?(name) || is_method_protected!(name)
- if defined?(::Ractor)
- getter_proc = nil.instance_eval{ Proc.new { @table[name] } }
- setter_proc = nil.instance_eval{ Proc.new {|x| @table[name] = x} }
- ::Ractor.make_shareable(getter_proc)
- ::Ractor.make_shareable(setter_proc)
- else
- getter_proc = Proc.new { @table[name] }
- setter_proc = Proc.new {|x| @table[name] = x}
- end
- define_singleton_method!(name, &getter_proc)
- define_singleton_method!("#{name}=", &setter_proc)
- end
- end
- private :new_ostruct_member!
-
- private def is_method_protected!(name) # :nodoc:
- if !respond_to?(name, true)
- false
- elsif name.match?(/!$/)
- true
- else
- owner = method!(name).owner
- if owner.class == ::Class
- owner < ::OpenStruct
- else
- self.class!.ancestors.any? do |mod|
- return false if mod == ::OpenStruct
- mod == owner
- end
- end
- end
- end
-
- def freeze
- @table.freeze
- super
- end
-
- private def method_missing(mid, *args) # :nodoc:
- len = args.length
- if mname = mid[/.*(?==\z)/m]
- if len != 1
- raise! ArgumentError, "wrong number of arguments (given #{len}, expected 1)", caller(1)
- end
- set_ostruct_member_value!(mname, args[0])
- elsif len == 0
- @table[mid]
- else
- begin
- super
- rescue NoMethodError => err
- err.backtrace.shift
- raise!
- end
- end
- end
-
- #
- # :call-seq:
- # ostruct[name] -> object
- #
- # Returns the value of an attribute, or +nil+ if there is no such attribute.
- #
- # require "ostruct"
- # person = OpenStruct.new("name" => "John Smith", "age" => 70)
- # person[:age] # => 70, same as person.age
- #
- def [](name)
- @table[name.to_sym]
- end
-
- #
- # :call-seq:
- # ostruct[name] = obj -> obj
- #
- # Sets the value of an attribute.
- #
- # require "ostruct"
- # person = OpenStruct.new("name" => "John Smith", "age" => 70)
- # person[:age] = 42 # equivalent to person.age = 42
- # person.age # => 42
- #
- def []=(name, value)
- name = name.to_sym
- new_ostruct_member!(name)
- @table[name] = value
- end
- alias_method :set_ostruct_member_value!, :[]=
- private :set_ostruct_member_value!
-
- # :call-seq:
- # ostruct.dig(name, *identifiers) -> object
- #
- # Finds and returns the object in nested objects
- # that is specified by +name+ and +identifiers+.
- # The nested objects may be instances of various classes.
- # See {Dig Methods}[rdoc-ref:dig_methods.rdoc].
- #
- # Examples:
- # 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
- 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
-
- #
- # Removes the named field from the object and returns the value the field
- # contained if it was defined. You may optionally provide a block.
- # If the field is not defined, the result of the block is returned,
- # or a NameError is raised if no block was given.
- #
- # require "ostruct"
- #
- # person = OpenStruct.new(name: "John", age: 70, pension: 300)
- #
- # person.delete_field!("age") # => 70
- # person # => #<OpenStruct name="John", pension=300>
- #
- # Setting the value to +nil+ will not remove the attribute:
- #
- # person.pension = nil
- # person # => #<OpenStruct name="John", pension=nil>
- #
- # person.delete_field('number') # => NameError
- #
- # person.delete_field('number') { 8675_309 } # => 8675309
- #
- def delete_field(name, &block)
- sym = name.to_sym
- begin
- singleton_class.remove_method(sym, "#{sym}=")
- rescue NameError
- end
- @table.delete(sym) do
- return yield if block
- raise! NameError.new("no field '#{sym}' in #{self}", sym)
- end
- end
-
- InspectKey = :__inspect_key__ # :nodoc:
-
- #
- # Returns a string containing a detailed summary of the keys and values.
- #
- 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
- alias :to_s :inspect
-
- attr_reader :table # :nodoc:
- alias table! table
- protected :table!
-
- #
- # Compares this object and +other+ for equality. An OpenStruct is equal to
- # +other+ when +other+ is an OpenStruct and the two objects' Hash tables are
- # equal.
- #
- # 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
- #
- def ==(other)
- return false unless other.kind_of?(OpenStruct)
- @table == other.table!
- end
-
- #
- # Compares this object and +other+ for equality. An OpenStruct is eql? to
- # +other+ when +other+ is an OpenStruct and the two objects' Hash tables are
- # eql?.
- #
- def eql?(other)
- return false unless other.kind_of?(OpenStruct)
- @table.eql?(other.table!)
- end
-
- # Computes a hash code for this OpenStruct.
- def hash # :nodoc:
- @table.hash
- end
-
- #
- # Provides marshalling support for use by the YAML library.
- #
- def encode_with(coder) # :nodoc:
- @table.each_pair do |key, value|
- coder[key.to_s] = value
- end
- if @table.size == 1 && @table.key?(:table) # support for legacy format
- # in the very unlikely case of a single entry called 'table'
- coder['legacy_support!'] = true # add a bogus second entry
- end
- end
-
- #
- # Provides marshalling support for use by the YAML library.
- #
- def init_with(coder) # :nodoc:
- h = coder.map
- if h.size == 1 # support for legacy format
- key, val = h.first
- if key == 'table'
- h = val
- end
- end
- update_to_values!(h)
- end
-
- # Make all public methods (builtin or our own) accessible with <code>!</code>:
- give_access = instance_methods
- # See https://github.com/ruby/ostruct/issues/30
- give_access -= %i[instance_exec instance_eval eval] if RUBY_ENGINE == 'jruby'
- give_access.each do |method|
- next if method.match(/\W$/)
-
- new_name = "#{method}!"
- alias_method new_name, method
- end
- # Other builtin private methods we use:
- alias_method :raise!, :raise
- private :raise!
-
- # See https://github.com/ruby/ostruct/issues/40
- if RUBY_ENGINE != 'jruby'
- alias_method :block_given!, :block_given?
- private :block_given!
- end
-end
diff --git a/test/ostruct/test_ostruct.rb b/test/ostruct/test_ostruct.rb
deleted file mode 100644
index 19bb606145..0000000000
--- a/test/ostruct/test_ostruct.rb
+++ /dev/null
@@ -1,434 +0,0 @@
-# frozen_string_literal: true
-require 'test/unit'
-require 'ostruct'
-require 'yaml'
-
-class TC_OpenStruct < Test::Unit::TestCase
- def test_initialize
- h = {name: "John Smith", age: 70, pension: 300}
- assert_equal h, OpenStruct.new(h).to_h
- assert_equal h, OpenStruct.new(OpenStruct.new(h)).to_h
- assert_equal h, OpenStruct.new(Struct.new(*h.keys).new(*h.values)).to_h
- end
-
- def test_respond_to
- o = OpenStruct.new
- o.a = 1
- assert_respond_to(o, :a)
- assert_respond_to(o, :a=)
- end
-
- def test_respond_to_with_lazy_getter
- o = OpenStruct.new a: 1
- assert_respond_to(o, :a)
- assert_respond_to(o, :a=)
- end
-
- def test_respond_to_allocated
- assert_not_respond_to(OpenStruct.allocate, :a)
- end
-
- def test_equality
- o1 = OpenStruct.new
- o2 = OpenStruct.new
- assert_equal(o1, o2)
-
- o1.a = 'a'
- assert_not_equal(o1, o2)
-
- o2.a = 'a'
- assert_equal(o1, o2)
-
- o1.a = 'b'
- assert_not_equal(o1, o2)
-
- o2 = Object.new
- o2.instance_eval{@table = {:a => 'b'}}
- assert_not_equal(o1, o2)
- end
-
- def test_inspect
- foo = OpenStruct.new
- assert_equal("#<OpenStruct>", foo.inspect)
- foo.bar = 1
- foo.baz = 2
- assert_equal("#<OpenStruct bar=1, baz=2>", foo.inspect)
- assert_equal(false, foo.inspect.frozen?)
-
- foo = OpenStruct.new
- foo.bar = OpenStruct.new
- assert_equal('#<OpenStruct bar=#<OpenStruct>>', foo.inspect)
- foo.bar.foo = foo
- assert_equal('#<OpenStruct bar=#<OpenStruct foo=#<OpenStruct ...>>>', foo.inspect)
- assert_equal(false, foo.inspect.frozen?)
- end
-
- def test_frozen
- o = OpenStruct.new(foo: 42)
- o.a = 'a'
- o.freeze
- assert_raise(FrozenError) {o.b = 'b'}
- assert_not_respond_to(o, :b)
- assert_raise(FrozenError) {o.a = 'z'}
- assert_equal('a', o.a)
- assert_equal(42, o.foo)
- o = OpenStruct.new :a => 42
- def o.frozen?; nil end
- o.freeze
- assert_raise(FrozenError, '[ruby-core:22559]') {o.a = 1764}
- end
-
- def test_delete_field
- bug = '[ruby-core:33010]'
- o = OpenStruct.new
- assert_not_respond_to(o, :a)
- assert_not_respond_to(o, :a=)
- o.a = 'a'
- assert_respond_to(o, :a)
- assert_respond_to(o, :a=)
- a = o.delete_field :a
- assert_not_respond_to(o, :a, bug)
- assert_not_respond_to(o, :a=, bug)
- assert_equal('a', a)
- s = Object.new
- def s.to_sym
- :foo
- end
- o[s] = true
- assert_respond_to(o, :foo)
- assert_respond_to(o, :foo=)
- o.delete_field s
- assert_not_respond_to(o, :foo)
- assert_not_respond_to(o, :foo=)
-
- assert_raise(NameError) { o.delete_field(s) }
- assert_equal(:bar, o.delete_field(s) { :bar })
-
- o[s] = :foobar
- assert_respond_to(o, :foo)
- assert_respond_to(o, :foo=)
- assert_equal(:foobar, o.delete_field(s) { :baz })
-
- assert_equal(42, OpenStruct.new(foo: 42).delete_field(:foo) { :bug })
-
- o = OpenStruct.new(block_given?: 42)
- assert_raise(NameError) { o.delete_field(:foo) }
- end
-
- def test_setter
- os = OpenStruct.new
- os[:foo] = :bar
- assert_equal :bar, os.foo
- os['foo'] = :baz
- assert_equal :baz, os.foo
- end
-
- def test_getter
- os = OpenStruct.new
- os.foo = :bar
- assert_equal :bar, os[:foo]
- assert_equal :bar, os['foo']
- end
-
- def test_dig
- os1 = OpenStruct.new
- os2 = OpenStruct.new
- os1.child = os2
- os2.foo = :bar
- os2.child = [42]
- assert_equal :bar, os1.dig("child", :foo)
- assert_nil os1.dig("parent", :foo)
- assert_raise(TypeError) { os1.dig("child", 0) }
- end
-
- def test_to_h
- h = {name: "John Smith", age: 70, pension: 300}
- os = OpenStruct.new(h)
- to_h = os.to_h
- assert_equal(h, to_h)
-
- to_h[:age] = 71
- assert_equal(70, os.age)
- assert_equal(70, h[:age])
-
- assert_equal(h, OpenStruct.new("name" => "John Smith", "age" => 70, pension: 300).to_h)
- end
-
- def test_to_h_with_block
- os = OpenStruct.new("country" => "Australia", :capital => "Canberra")
- assert_equal({"country" => "AUSTRALIA", "capital" => "CANBERRA" },
- os.to_h {|name, value| [name.to_s, value.upcase]})
- assert_equal("Australia", os.country)
- end
-
- def test_each_pair
- h = {name: "John Smith", age: 70, pension: 300}
- os = OpenStruct.new(h)
- assert_same os, os.each_pair{ }
- assert_equal '#<Enumerator: #<OpenStruct name="John Smith", age=70, pension=300>:each_pair>', os.each_pair.inspect
- assert_equal [[:name, "John Smith"], [:age, 70], [:pension, 300]], os.each_pair.to_a
- assert_equal 3, os.each_pair.size
- end
-
- def test_eql_and_hash
- os1 = OpenStruct.new age: 70
- os2 = OpenStruct.new age: 70.0
- assert_equal os1, os2
- assert_equal false, os1.eql?(os2)
- assert_not_equal os1.hash, os2.hash
- assert_equal true, os1.eql?(os1.dup)
- assert_equal os1.hash, os1.dup.hash
- end
-
- def test_method_missing
- os = OpenStruct.new
- e = assert_raise(NoMethodError) { os.foo true }
- assert_equal :foo, e.name
- assert_equal [true], e.args
- assert_match(/#{__callee__}/, e.backtrace[0])
- e = assert_raise(ArgumentError) { os.send :foo=, true, true }
- assert_match(/#{__callee__}/, e.backtrace[0])
- end
-
- def test_accessor_defines_method
- os = OpenStruct.new(foo: 42)
- assert_respond_to(os, :foo)
- assert_equal(42, os.foo)
- assert_equal([:foo, :foo=], os.singleton_methods.sort)
- end
-
- def test_does_not_redefine
- $VERBOSE, verbose_bak = nil, $VERBOSE
- os = OpenStruct.new(foo: 42)
- def os.foo
- 43
- end
- os.foo = 44
- assert_equal(43, os.foo)
- ensure
- $VERBOSE = verbose_bak
- end
-
- def test_allocate_subclass
- bug = '[ruby-core:80292] [Bug #13358] allocate should not call initialize'
- c = Class.new(OpenStruct) {
- def initialize(x,y={})super(y);end
- }
- os = assert_nothing_raised(ArgumentError, bug) {c.allocate}
- assert_instance_of(c, os)
- end
-
- def test_initialize_subclass
- c = Class.new(OpenStruct) {
- def initialize(x,y={})super(y);end
- }
- o = c.new(1, {a: 42})
- assert_equal(42, o.dup.a)
- assert_equal(42, o.clone.a)
- end
-
- def test_private_method
- os = OpenStruct.new
- class << os
- private
- def foo
- end
- end
- assert_raise_with_message(NoMethodError, /private method/) do
- os.foo true, true
- end
- end
-
- def test_protected_method
- os = OpenStruct.new
- class << os
- protected
- def foo
- end
- end
- assert_raise_with_message(NoMethodError, /protected method/) do
- os.foo true, true
- end
- end
-
- def test_access_undefined
- os = OpenStruct.new
- assert_nil os.foo
- end
-
- def test_overridden_private_methods
- os = OpenStruct.new(puts: :foo, format: :bar)
- assert_equal(:foo, os.puts)
- assert_equal(:bar, os.format)
- end
-
- def test_super
- c = Class.new(OpenStruct) {
- def foo; super; end
- }
- os = c.new(foo: :bar)
- assert_equal(:bar, os.foo)
- end
-
- def test_overridden_public_methods
- os = OpenStruct.new(method: :foo, class: :bar)
- assert_equal(:foo, os.method)
- assert_equal(:bar, os.class)
- end
-
- def test_access_original_methods
- os = OpenStruct.new(method: :foo, hash: 42)
- assert_equal(os.object_id, os.method!(:object_id).call)
- assert_not_equal(42, os.hash!)
- refute os.methods.include?(:"!~!")
- end
-
- def test_override_subclass
- c = Class.new(OpenStruct) {
- def foo; :protect_me; end
- private def bar; :protect_me; end
- def inspect; 'protect me'; end
- }
- o = c.new(
- foo: 1, bar: 2, inspect: '3', # in subclass: protected
- table!: 4, # bang method: protected
- each_pair: 5, to_s: 'hello', # others: not protected
- )
- # protected:
- assert_equal(:protect_me, o.foo)
- assert_equal(:protect_me, o.send(:bar))
- assert_equal('protect me', o.inspect)
- assert_not_equal(4, o.send(:table!))
- # not protected:
- assert_equal(5, o.each_pair)
- assert_equal('hello', o.to_s)
- end
-
- def test_override_submodule
- m = Module.new {
- def foo; :protect_me; end
- private def bar; :protect_me; end
- def inspect; 'protect me'; end
- }
- m2 = Module.new {
- def added_to_all_open_struct; :override_me; end
- }
- OpenStruct.class_eval do
- include m2
- # prepend case tbd
- def added_to_all_open_struct_2; :override_me; end
- end
- c = Class.new(OpenStruct) { include m }
- o = c.new(
- foo: 1, bar: 2, inspect: '3', # in subclass: protected
- table!: 4, # bang method: protected
- each_pair: 5, to_s: 'hello', # others: not protected
- # including those added by the user:
- added_to_all_open_struct: 6, added_to_all_open_struct_2: 7,
- )
- # protected:
- assert_equal(:protect_me, o.foo)
- assert_equal(:protect_me, o.send(:bar))
- assert_equal('protect me', o.inspect)
- assert_not_equal(4, o.send(:table!))
- # not protected:
- assert_equal(5, o.each_pair)
- assert_equal('hello', o.to_s)
- assert_equal(6, o.added_to_all_open_struct)
- assert_equal(7, o.added_to_all_open_struct_2)
- end
-
- def test_mistaken_subclass
- sub = Class.new(OpenStruct) do
- def [](k)
- __send__(k)
- super
- end
-
- def []=(k, v)
- @item_set = true
- __send__("#{k}=", v)
- super
- end
- end
- o = sub.new
- o.foo = 42
- assert_equal 42, o.foo
- end
-
- def test_ractor
- assert_ractor(<<~RUBY, require: 'ostruct')
- obj1 = OpenStruct.new(a: 42, b: 42)
- obj1.c = 42
- obj1.freeze
-
- obj2 = Ractor.new obj1 do |obj|
- obj
- end.take
- assert obj1.object_id == obj2.object_id
- RUBY
- end if defined?(Ractor)
-
- def test_access_methods_from_different_ractor
- assert_ractor(<<~RUBY, require: 'ostruct')
- os = OpenStruct.new
- os.value = 100
- r = Ractor.new(os) do |x|
- v = x.value
- Ractor.yield v
- end
- assert 100 == r.take
- RUBY
- end if defined?(Ractor)
-
- def test_legacy_yaml
- s = "--- !ruby/object:OpenStruct\ntable:\n :foo: 42\n"
- o = YAML.safe_load(s, permitted_classes: [Symbol, OpenStruct])
- assert_equal(42, o.foo)
-
- o = OpenStruct.new(table: {foo: 42})
- assert_equal({foo: 42}, YAML.safe_load(YAML.dump(o), permitted_classes: [Symbol, OpenStruct]).table)
- end if RUBY_VERSION >= '2.6'
-
- def test_yaml
- h = {name: "John Smith", age: 70, pension: 300.42}
- yaml = "--- !ruby/object:OpenStruct\nname: John Smith\nage: 70\npension: 300.42\n"
- os1 = OpenStruct.new(h)
- os2 = YAML.safe_load(os1.to_yaml, permitted_classes: [Symbol, OpenStruct])
- assert_equal yaml, os1.to_yaml
- assert_equal os1, os2
- assert_equal true, os1.eql?(os2)
- assert_equal 300.42, os2.pension
- end if RUBY_VERSION >= '2.6'
-
- def test_marshal
- o = OpenStruct.new(name: "John Smith", age: 70, pension: 300.42)
- o2 = Marshal.load(Marshal.dump(o))
- assert_equal o, o2
- end
-
- def test_class
- os = OpenStruct.new(class: 'my-class', method: 'post')
- assert_equal('my-class', os.class)
- assert_equal(OpenStruct, os.class!)
- end
-
- has_performance_warnings = begin
- Warning[:performance]
- true
- rescue NoMethodError, ArgumentError
- false
- end
-
- if has_performance_warnings
- def test_performance_warning
- assert_in_out_err(
- %w(-Ilib -rostruct -w -W:performance -e) + ['OpenStruct.new(a: 1)'],
- "",
- [],
- ["-e:1: warning: OpenStruct use is discouraged for performance reasons"],
- success: true,
- )
- end
- end
-end