ostruct 0.3.1 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2b9fc88b5467418401b1e0a44f555fd467cf3b90dbcd36db7329830afee1b83
-  data.tar.gz: decc3b34075bc2746bd61fe0498c666dab2154401515fe69a4c1baa0ab2da2a1
+  metadata.gz: e36ab53d76adf09c53509a2ac80afb2e8fb7a76fdc18273be6080a32ebf95070
+  data.tar.gz: f837cb94bbf9fab791e752e0eacfbbe6f721052a4673441b4f84794c71eae69b
 SHA512:
-  metadata.gz: c8166a4d8ec376ec8b8a8fbd7f85e6cc83cb142c06ea9cbb6728011221b2beaa598152f9e9f724d3bf24fb37b89a8261f6728dbeb093b84c8e68887e860824f2
-  data.tar.gz: 49275721136d6546dba4290e3d14df92b82a84de1e2386d13551d481232da7c82987ddde25ea9baa33761689634d18951a15edce19fb57bb2a9c32ddb1cfbd09
+  metadata.gz: 254e895a7bfde536dc044638746d605ff0ac435963a98887015f5ef12ff7b1e5c4cdf1a89d18a956d766dc5ea58fcbfab22f737686c97624cb8de7be0d157166
+  data.tar.gz: 0cc6bcb1268e37a81efd0e1fceb08c352e4693d2d799f4dace50bc09b244b2589d3a0bde1e14af04f0183b27b8f9576e2bf479cd258bdb27c8049d359c32b33f

data/{LICENSE.txt → BSDL}

@@ -4,10 +4,10 @@ Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:
 1. Redistributions of source code must retain the above copyright
-notice, this list of conditions and the following disclaimer.
+   notice, this list of conditions and the following disclaimer.
 2. Redistributions in binary form must reproduce the above copyright
-notice, this list of conditions and the following disclaimer in the
-documentation and/or other materials provided with the distribution.
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
 
 THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

data/COPYING

@@ -0,0 +1,56 @@
+Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.jp>.
+You can redistribute it and/or modify it under either the terms of the
+2-clause BSDL (see the file BSDL), or the conditions below:
+
+1. You may make and give away verbatim copies of the source form of the
+   software without restriction, provided that you duplicate all of the
+   original copyright notices and associated disclaimers.
+
+2. You may modify your copy of the software in any way, provided that
+   you do at least ONE of the following:
+
+   a. place your modifications in the Public Domain or otherwise
+      make them Freely Available, such as by posting said
+      modifications to Usenet or an equivalent medium, or by allowing
+      the author to include your modifications in the software.
+
+   b. use the modified software only within your corporation or
+      organization.
+
+   c. give non-standard binaries non-standard names, with
+      instructions on where to get the original software distribution.
+
+   d. make other distribution arrangements with the author.
+
+3. You may distribute the software in object code or binary form,
+   provided that you do at least ONE of the following:
+
+   a. distribute the binaries and library files of the software,
+      together with instructions (in the manual page or equivalent)
+      on where to get the original distribution.
+
+   b. accompany the distribution with the machine-readable source of
+      the software.
+
+   c. give non-standard binaries non-standard names, with
+      instructions on where to get the original software distribution.
+
+   d. make other distribution arrangements with the author.
+
+4. You may modify and include the part of the software into any other
+   software (possibly commercial).  But some files in the distribution
+   are not written by the author, so that they are not under these terms.
+
+   For the list of those files and their copying conditions, see the
+   file LEGAL.
+
+5. The scripts and library files supplied as input to or produced as
+   output from the software do not automatically fall under the
+   copyright of the software, but belong to whomever generated them,
+   and may be sold commercially, and may be aggregated with this
+   software.
+
+6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+   IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+   WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+   PURPOSE.

data/Gemfile

@@ -1,6 +1,10 @@
 source "https://rubygems.org"
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in ostruct.gemspec
 gemspec
+
+group :development do
+  gem "bundler"
+  gem "rake"
+  gem "test-unit"
+  gem "test-unit-ruby-core"
+end

data/README.md

@@ -8,7 +8,7 @@ The `ostruct` library comes pre-packaged with Ruby. No installation is necessary
 
 ## Usage
 
-```
+```ruby
   require "ostruct"
 
   person = OpenStruct.new
@@ -22,14 +22,14 @@ The `ostruct` library comes pre-packaged with Ruby. No installation is necessary
 
 An OpenStruct employs a Hash internally to store the attributes and values and can even be initialized with one:
 
-```
+```ruby
   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.
 
-```
+```ruby
   measurements = OpenStruct.new("length (in inches)" => 24)
   measurements.send("length (in inches)")   # => 24
 
@@ -41,7 +41,7 @@ Hash keys with spaces or characters that could normally not be used for method c
 
 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.
 
-```
+```ruby
   first_pet  = OpenStruct.new(:name => "Rowdy", :owner => "John Smith")
   second_pet = OpenStruct.new(:name => "Rowdy")
 

data/Rakefile

@@ -1,8 +1,8 @@
 task :release do
-  cur = `git branch --show-current`
+  cur = `git branch --show-current`.chomp
   if cur != 'master'
     puts 'Release only from master branch'
-    exit(1)
+    exit(-1)
   end
 end
 
@@ -10,9 +10,9 @@ require "bundler/gem_tasks"
 require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test" << "test/lib"
-  t.libs << "lib"
-  t.test_files = FileList['test/**/test_*.rb']
+  t.libs << "test/lib"
+  t.ruby_opts << "-rhelper"
+  t.test_files = FileList["test/**/test_*.rb"]
 end
 
 task :default => [:test]

data/lib/ostruct.rb

@@ -93,21 +93,29 @@
 #   o.methods = [:foo, :bar]
 #   o.methods # => [:foo, :bar]
 #
-# To help remedy clashes, OpenStruct uses only protected/private methods ending with `!`
-# and defines aliases for builtin public methods by adding a `!`:
+# 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 `!`;
+# 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 `!`.
+# ending with <code>!</code>.
 #
 # For all these reasons, consider not using OpenStruct at all.
 #
 class OpenStruct
-  VERSION = "0.3.1"
+  VERSION = "0.6.3"
+
+  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
@@ -124,6 +132,10 @@ class OpenStruct
   #   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
@@ -197,7 +209,7 @@ class OpenStruct
   #   data.each_pair.to_a   # => [[:country, "Australia"], [:capital, "Canberra"]]
   #
   def each_pair
-    return to_enum(__method__) { @table.size } unless block_given?
+    return to_enum(__method__) { @table.size } unless defined?(yield)
     @table.each_pair{|p| yield p}
     self
   end
@@ -221,8 +233,20 @@ class OpenStruct
   #
   def new_ostruct_member!(name) # :nodoc:
     unless @table.key?(name) || is_method_protected!(name)
-      define_singleton_method!(name) { @table[name] }
-      define_singleton_method!("#{name}=") {|x| @table[name] = x}
+      if defined?(::Ractor.shareable_proc)
+        getter_proc = Ractor.shareable_proc { @table[name] }
+        setter_proc = Ractor.shareable_proc {|x| @table[name] = x}
+      elsif 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!
@@ -233,7 +257,15 @@ class OpenStruct
     elsif name.match?(/!$/)
       true
     else
-      method!(name).owner < OpenStruct
+      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
 
@@ -250,6 +282,7 @@ class OpenStruct
       end
       set_ostruct_member_value!(mname, args[0])
     elsif len == 0
+      @table[mid]
     else
       begin
         super
@@ -264,7 +297,7 @@ class OpenStruct
   # :call-seq:
   #   ostruct[name]  -> object
   #
-  # Returns the value of an attribute, or `nil` if there is no such attribute.
+  # Returns the value of an attribute, or +nil+ if there is no such attribute.
   #
   #   require "ostruct"
   #   person = OpenStruct.new("name" => "John Smith", "age" => 70)
@@ -299,7 +332,7 @@ class OpenStruct
   # 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:doc/dig_methods.rdoc].
+  # See {Dig Methods}[rdoc-ref:dig_methods.rdoc].
   #
   # Examples:
   #   require "ostruct"
@@ -317,8 +350,10 @@ class OpenStruct
   end
 
   #
-  # Removes the named field from the object. Returns the value that the field
-  # contained if it was defined.
+  # 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"
   #
@@ -332,14 +367,19 @@ class OpenStruct
   #   person.pension = nil
   #   person                 # => #<OpenStruct name="John", pension=nil>
   #
-  def delete_field(name)
+  #   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
-      raise! NameError.new("no field `#{sym}' in #{self}", sym)
+      return yield if block
+      raise! NameError.new("no field '#{sym}' in #{self}", sym)
     end
   end
 
@@ -430,12 +470,23 @@ class OpenStruct
     update_to_values!(h)
   end
 
-  # Make all public methods (builtin or our own) accessible with `!`:
-  instance_methods.each do |method|
+  # 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

data/ostruct.gemspec

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 name = File.basename(__FILE__, ".gemspec")
-version = ["lib", Array.new(name.count("-")+1, "..").join("/")].find do |dir|
+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
@@ -16,14 +16,11 @@ Gem::Specification.new do |spec|
   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.license       = "BSD-2-Clause"
+  spec.licenses      = ["Ruby", "BSD-2-Clause"]
   spec.required_ruby_version = ">= 2.5.0"
 
-  spec.files         = [".gitignore", "Gemfile", "LICENSE.txt", "README.md", "Rakefile", "bin/console", "bin/setup", "lib/ostruct.rb", "ostruct.gemspec"]
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.files         = [".gitignore", "Gemfile", "COPYING", "BSDL", "README.md", "Rakefile", "bin/console", "bin/setup", "lib/ostruct.rb", "ostruct.gemspec"]
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
+  spec.metadata["changelog_uri"] = spec.homepage + "/releases"
 end

metadata

@@ -1,43 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: ostruct
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.6.3
 platform: ruby
 authors:
 - Marc-Andre Lafortune
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2020-10-06 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+date: 2025-07-17 00:00:00.000000000 Z
+dependencies: []
 description: Class to build custom data structures, similar to a Hash.
 email:
 - ruby-core@marc-andre.ca
@@ -46,8 +18,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- BSDL
+- COPYING
 - Gemfile
-- LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
@@ -56,8 +29,10 @@ files:
 - ostruct.gemspec
 homepage: https://github.com/ruby/ostruct
 licenses:
+- Ruby
 - BSD-2-Clause
-metadata: {}
+metadata:
+  changelog_uri: https://github.com/ruby/ostruct/releases
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -73,7 +48,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Class to build custom data structures, similar to a Hash.