production_open_struct 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d66f2bc476482745d878fdd7ddcbeca5eb7ee08f3f6f455449913fee661f848b
-  data.tar.gz: 52799916fea68a7a9c0fc57cdabfdc9a62aff4f16c0014cb1291bf50e07725a4
+  metadata.gz: 8c050b2ea17cf5ea57c4a707234b2a1e2f6aa8f3db1955a81375392f3c9e75a0
+  data.tar.gz: 0f8225d7a222ff8dcccd1ceb8fb349e2bc70f3977143e0b8585321c38cd31285
 SHA512:
-  metadata.gz: d074f8eea4c9a220c41394b91a69123a43e04f9018293af6c87f2d798806628ace0a9ebdb05855da01c8c13d75bd4ea280321d7f5540e520e1847eb7d3501484
-  data.tar.gz: 3c6ed9917bebdbb928ec8dff696eac4ea9e626c60ea552b0841e9ec8ae6100eb6df9a05dcb9cddf4a5bb8c58a02d76e9d8a9ede92b33fcf1427267a0605d1794
+  metadata.gz: e938bb6035f79a5bbafefa6a620f2624fe14d6585d02a4c30c63f76d954a3691c859e183f5ee33facfcda1b83ad93a6b588b78517c66753a8f1a1ebe5c9ab477
+  data.tar.gz: bcc856b4c14684b64cea93323fce0e04ccc0ab35eb41e921c2a35286d5d014e7f421e01f51d371f98b1457024d6ba0e511b0e4bc06861bcf1a3e1b37afdf4fcd

data/CHANGELOG.md

@@ -4,7 +4,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 1.0.1
+
+### Fixed
+
+- Use `raise` and an explicit block argument instead of the `raise!` and `block_given!` aliases which do not exist in the ostruct versions bundled with Ruby <= 3.0 or on JRuby. Previously on those versions, errors from `delete_field` on a missing field, setter calls with the wrong number of arguments, and undefined method calls with arguments could be silently swallowed instead of raised.
+- `respond_to?` no longer raises an error on an allocated but uninitialized OpenStruct.
+- `delete_field` now raises a `FrozenError` on frozen objects on ostruct versions that do not freeze the internal table.
+- `delete_field` removes stale singleton method accessors from objects created before the gem was loaded.
+
 ## 1.0.0
 
 ### Added
+
 - Override OpenStuct to not define singleton methods which clear the Ruby method cache.

data/README.md

@@ -1,7 +1,8 @@
+# Production OpenStruct
+
 [![Continuous Integration](https://github.com/bdurand/production_open_struct/actions/workflows/continuous_integration.yml/badge.svg)](https://github.com/bdurand/production_open_struct/actions/workflows/continuous_integration.yml)
 [![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
-
-# Production OpenStuct
+[![Gem Version](https://badge.fury.io/rb/production_open_struct.svg)](https://badge.fury.io/rb/production_open_struct)
 
 This gem overrides behavior in the [OpenStruct](https://github.com/ruby/ostruct) implementation defined in the Ruby standard library. While OpenStruct can be useful for one off scripts or as testing mocks, it can cause performance issues in production environments.
 
@@ -12,12 +13,12 @@ OpenStruct defines singleton methods on every object created for each key in the
 object = OpenStruct.new(foo: "bar")
 object.foo # => "bar"
 object.foo = "biz"
-object.foo # => "bix"
+object.foo # => "biz"
 ```
 
 It is not a good idea to use OpenStruct in your production code. It is much more efficient and safer to just define some simple classes or use `Struct` rather than using OpenStruct. However, not everyone sticks to this and you can end up with external libraries in your application that do use OpenStruct.
 
-This gem solves the OpenStruct performance issues by simply overriding the code in OpenStruct that defines singleton methods. This doesn't have any functional affect on OpenStruct objects; you can still use the attribute reader and writer methods. However, these will now go through `method_missing` every time you call them. This does add its own overhead but it is far more performant in most cases than defining dynamic methods. Furthermore, the global method cache is no longer impacted by creating OpenStruct objects.
+This gem solves the OpenStruct performance issues by simply overriding the code in OpenStruct that defines singleton methods. This doesn't have any functional effect on OpenStruct objects; you can still use the attribute reader and writer methods. However, these will now go through `method_missing` every time you call them. This does add its own overhead but it is far more performant in most cases than defining dynamic methods. Furthermore, the global method cache is no longer impacted by creating OpenStruct objects.
 
 ## Usage
 
@@ -27,6 +28,12 @@ Nothing is needed to use this gem other than requiring it.
 require "production_open_struct"
 ```
 
+If you need to disable the OpenStruct patch (for instance, to compare behavior in a test suite), you can set the `PRODUCTION_OPEN_STRUCT_AUTO_INCLUDE` environment variable to `false` before the gem is required. You can then opt in manually with:
+
+```ruby
+OpenStruct.prepend(ProductionOpenStruct)
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/lib/production_open_struct.rb

@@ -3,12 +3,28 @@
 require "ostruct"
 
 # Overrides OpenStruct behavior to no longer define singleton methods on each object.
+#
+# Note: unlike the standard library implementation, this code does not need to use
+# the `raise!` and `block_given!` aliases. Those aliases exist to protect OpenStruct
+# internals from fields that shadow built in methods via singleton methods. Since this
+# module prevents singleton methods from ever being defined, built in methods can no
+# longer be shadowed. The aliases also don't exist in the ostruct versions bundled
+# with Ruby <= 3.0 or on JRuby, so using them would break on those platforms.
 module ProductionOpenStruct
-  def delete_field(name)
+  # @param name [Symbol, String] the name of the field to delete
+  # @return [void]
+  def delete_field(name, &block)
+    raise FrozenError, "can't modify frozen #{self.class}: #{inspect}" if frozen?
+
     sym = name.to_sym
+    begin
+      # Clean up stale accessors on objects created before this module was prepended.
+      singleton_class.remove_method(sym, "#{sym}=")
+    rescue NameError
+    end
     @table.delete(sym) do
-      return yield if block_given!
-      raise! NameError.new("no field `#{sym}' in #{self}", sym)
+      return yield if block
+      raise NameError.new("no field `#{sym}' in #{self}", sym)
     end
   end
 
@@ -23,7 +39,7 @@ module ProductionOpenStruct
     len = args.length
     if method_name.to_s.end_with?("=")
       if len != 1
-        raise! ArgumentError, "wrong number of arguments (given #{len}, expected 1)", caller(1)
+        raise ArgumentError, "wrong number of arguments (given #{len}, expected 1)", caller(1)
       end
       self[method_name.to_s.chomp("=")] = args[0]
     elsif len == 0
@@ -33,15 +49,15 @@ module ProductionOpenStruct
         super
       rescue NoMethodError => err
         err.backtrace.shift
-        raise!
+        raise
       end
     end
   end
 
   def respond_to_missing?(method_name, include_private = false)
     key = method_name.to_s.chomp("=").to_sym
-    @table.include?(key) || super
+    (defined?(@table) && @table.include?(key)) || super
   end
 end
 
-OpenStruct.prepend(ProductionOpenStruct) unless ENV["PRODUCTION_OPEN_STRUCT_AUTO_INCLUDE"] == "false"
+OpenStruct.send(:prepend, ProductionOpenStruct) unless ENV["PRODUCTION_OPEN_STRUCT_AUTO_INCLUDE"] == "false"

data/production_open_struct.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name = "production_open_struct"
-  spec.version = File.read(File.expand_path("../VERSION", __FILE__)).strip
+  spec.version = File.read(File.expand_path("VERSION", __dir__)).strip
   spec.authors = ["Brian Durand"]
   spec.email = ["bbdurand@gmail.com"]
 
@@ -8,6 +8,12 @@ Gem::Specification.new do |spec|
   spec.homepage = "https://github.com/bdurand/production_open_struct"
   spec.license = "MIT"
 
+  spec.metadata = {
+    "homepage_uri" => spec.homepage,
+    "source_code_uri" => spec.homepage,
+    "changelog_uri" => "#{spec.homepage}/blob/main/CHANGELOG.md"
+  }
+
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   ignore_files = %w[
@@ -20,13 +26,15 @@ Gem::Specification.new do |spec|
     gemfiles/
     spec/
   ]
-  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+  spec.files = Dir.chdir(__dir__) do
     `git ls-files -z`.split("\x0").reject { |f| ignore_files.any? { |path| f.start_with?(path) } }
   end
 
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "ostruct"
+
   spec.add_development_dependency "bundler"
 
-  spec.required_ruby_version = ">= 2.5"
+  spec.required_ruby_version = ">= 2.6"
 end

metadata

@@ -1,15 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: production_open_struct
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Brian Durand
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-26 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -24,7 +37,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
 email:
 - bbdurand@gmail.com
 executables: []
@@ -32,7 +44,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
-- MIT-LICENSE
+- MIT-LICENSE.txt
 - README.md
 - VERSION
 - lib/production_open_struct.rb
@@ -40,8 +52,10 @@ files:
 homepage: https://github.com/bdurand/production_open_struct
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/bdurand/production_open_struct
+  source_code_uri: https://github.com/bdurand/production_open_struct
+  changelog_uri: https://github.com/bdurand/production_open_struct/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -49,15 +63,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Modifies OpenStruct so that it doesn't define singleton methods on each object
   which busts the Ruby method cache which can cause performance issues in production