production_open_struct 1.0.0

checksums.yaml

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

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+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.0
+
+### Added
+- Override OpenStuct to not define singleton methods which clear the Ruby method cache.

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Brian Durand
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,56 @@
+[![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
+
+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.
+
+OpenStruct defines singleton methods on every object created for each key in the hash. Defining these methods is slow and it busts the global method cache used by the Ruby VM requiring it to be rebuilt after every OpenStruct object is created.
+
+```ruby
+# This defines methods "foo" and "foo=" on object and busts the method cache
+object = OpenStruct.new(foo: "bar")
+object.foo # => "bar"
+object.foo = "biz"
+object.foo # => "bix"
+```
+
+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.
+
+## Usage
+
+Nothing is needed to use this gem other than requiring it.
+
+```ruby
+require "production_open_struct"
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'production_open_struct'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install production_open_struct
+```
+
+## Contributing
+
+Open a pull request on GitHub.
+
+Please use the [standardrb](https://github.com/testdouble/standard) syntax and lint your code with `standardrb --fix` before submitting.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/production_open_struct.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "ostruct"
+
+# Overrides OpenStruct behavior to no longer define singleton methods on each object.
+module ProductionOpenStruct
+  def delete_field(name)
+    sym = name.to_sym
+    @table.delete(sym) do
+      return yield if block_given!
+      raise! NameError.new("no field `#{sym}' in #{self}", sym)
+    end
+  end
+
+  private
+
+  def new_ostruct_member!(name)
+    # no-op to avoid defining singleton methods that will bust the method cache.
+    name.to_sym
+  end
+
+  def method_missing(method_name, *args) # :nodoc:
+    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)
+      end
+      self[method_name.to_s.chomp("=")] = args[0]
+    elsif len == 0
+      @table[method_name]
+    else
+      begin
+        super
+      rescue NoMethodError => err
+        err.backtrace.shift
+        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
+  end
+end
+
+OpenStruct.prepend(ProductionOpenStruct) unless ENV["PRODUCTION_OPEN_STRUCT_AUTO_INCLUDE"] == "false"

data/production_open_struct.gemspec

@@ -0,0 +1,32 @@
+Gem::Specification.new do |spec|
+  spec.name = "production_open_struct"
+  spec.version = File.read(File.expand_path("../VERSION", __FILE__)).strip
+  spec.authors = ["Brian Durand"]
+  spec.email = ["bbdurand@gmail.com"]
+
+  spec.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 applications."
+  spec.homepage = "https://github.com/bdurand/production_open_struct"
+  spec.license = "MIT"
+
+  # 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[
+    .
+    Appraisals
+    Gemfile
+    Gemfile.lock
+    Rakefile
+    bin/
+    gemfiles/
+    spec/
+  ]
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| ignore_files.any? { |path| f.start_with?(path) } }
+  end
+
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+
+  spec.required_ruby_version = ">= 2.5"
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: production_open_struct
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brian Durand
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-08-26 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'
+description: 
+email:
+- bbdurand@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
+- VERSION
+- lib/production_open_struct.rb
+- production_open_struct.gemspec
+homepage: https://github.com/bdurand/production_open_struct
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+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
+  applications.
+test_files: []