safe_object_as_json 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5cfc9f52cea679fdbd39e375fd930f28c9f87f09a636fab4765053c0a5bec84
-  data.tar.gz: 02fd5931b21822ea69643ef8ed47069d055b38a3d15a39b41b70b81829c046bf
+  metadata.gz: 48f61927e96d8c9e566b3563b4691589f99bab2c18a4ebe0ce4cd0377f123bac
+  data.tar.gz: bed00faa7540d1d80ca66c1cb9a742199c91f81cbeeb461826021195295bf11a
 SHA512:
-  metadata.gz: 63e3e7ec587ac6fa99438bd7419b886ea4d0bb2eb8d74763d3de8c60200f8a6c701bb3e9e4e0b2074aee8c36cb8717346602f792adc0d616b26808eaffa8a4de
-  data.tar.gz: e856a2199351f45be79f0abab0a0eac31af2424b9e6fe9370e215617ba358ce3199558c5e35ffa0813d45a345ed9a24081e91829e5ba67062914db088d226357
+  metadata.gz: ca75249f62a5c2a817efd9abeee452b404d47e66e8a14ea59ad5118743b4506a9c8482007f2d1f6a2cf9e789893de9202e272cd50a7d1caea800609e4e6c6715
+  data.tar.gz: 629028c82c38d5de8d248dd3bda12f5a808dbb4eed33e915c4b6fbda391890fe84fc0cf205017a98cd4607c92e8e148c2ade89743a47a5898bf5addc3180aefc

data/CHANGELOG.md

@@ -4,6 +4,15 @@ 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
+- Fixed reference tracking so that the internal thread local state is always cleaned up after the outermost call to `Object#as_json`. Previously serialized values were retained in a thread local variable forever, leaking memory and potentially omitting values from unrelated `as_json` calls on the same thread.
+- Circular references through objects that implement `to_hash` no longer raise `SystemStackError`; the circular reference is now serialized as `nil`.
+
+### Changed
+- Only require the parts of ActiveSupport that are actually used instead of `active_support/all`.
+
 ## 1.0.0
 
 ### Added

data/README.md

@@ -1,14 +1,17 @@
+# Safe Object As JSON
+
 [![Continuous Integration](https://github.com/bdurand/safe_object_as_json/actions/workflows/continuous_integration.yml/badge.svg)](https://github.com/bdurand/safe_object_as_json/actions/workflows/continuous_integration.yml)
 [![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
+[![Gem Version](https://badge.fury.io/rb/safe_object_as_json.svg)](https://badge.fury.io/rb/safe_object_as_json)
 
-# Safe Object As JSON
-
-This gem provides an enhancement to the implementation for `as_json` on the core `Object` class in the ActiveSiupport library. The implementation provided by ActiveSupport dumps the instance variables as name value pairs in a Hash. However, this is susceptible to infinite recursion when dumping an object that maintains references to other objects that then maintain back references to the original object.
+This gem provides an enhancement to the implementation for `as_json` on the core `Object` class in the ActiveSupport library. The implementation provided by ActiveSupport dumps the instance variables as name value pairs in a Hash. However, this is susceptible to infinite recursion when dumping an object that maintains references to other objects that then maintain back references to the original object.
 
 The fix provided by this gem maintains a state of the current stack of objects being used to construct the `as_json` hash. If an object has already been referenced in the current call to `Object#as_json`, it is left out of the hash in lieu of having it raise a stack level too deep error.
 
 It also omits any `Proc` or `IO` references since these are inherently not serializable.
 
+Objects that implement `to_hash` are serialized from that hash just like in ActiveSupport. If such an object is circularly referenced from within its own hash representation, the circular reference is serialized as `null`.
+
 ## Usage
 
 No changes are needed to use this gem. It will just replace the method definition of `Object#as_json`. It will not impact any class that defines its own `as_json` or `to_hash` method which includes all the core Ruby classes (String, Numeric, Array, Hash) as well as ActiveModel classes.

data/VERSION

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

data/lib/safe_object_as_json.rb

@@ -1,55 +1,95 @@
 # frozen_string_literal: true
 
-require "active_support/all"
+require "set"
+require "active_support"
+require "active_support/core_ext/object/json"
+require "active_support/core_ext/object/instance_variables"
+require "active_support/core_ext/hash/except"
 
 module SafeObjectAsJson
   # ActiveSupport 7 is adding support for filtering hash values with :only and :except options.
   SUPPORT_FILTERING = (ActiveSupport.version.canonical_segments.first > 6)
 
   VERSION = File.read(File.expand_path("../VERSION", __dir__)).chomp
+
+  class << self
+    # Yield the set of object ids currently being serialized on this thread. The set is
+    # created on the outermost call and always removed when that call finishes so that
+    # no state leaks between top level calls to Object#as_json.
+    def track_references
+      references = Thread.current[:object_as_json_references]
+      if references
+        yield references
+      else
+        references = Set.new
+        Thread.current[:object_as_json_references] = references
+        begin
+          yield references
+        ensure
+          Thread.current[:object_as_json_references] = nil
+        end
+      end
+    end
+  end
 end
 
 class Object
-  # Converts any object to JSON by creating a hash out of it's instance variables.
-  # If there is a circular reference within an object hierarchy, then duplicate
-  # objects will be omitted in order to avoid infinite recursion.
+  # Converts any object to JSON by creating a hash out of its instance variables.
+  # If there is a circular reference within an object hierarchy, then the duplicate
+  # reference will be omitted in order to avoid infinite recursion.
+  #
+  # @param [Hash] options
+  # @return [Object]
   def as_json(options = nil)
-    if respond_to?(:to_hash)
-      to_hash.as_json(options)
-    else
-      # The default as_json serializer serializes the instance variables as name value pairs.
-      # In order to prevent infinite recursion, we keep track of the object already used
-      # in the serialization and omit them if they are included recursively.
-      references = (Thread.current[:object_as_json_references] || Set.new)
-      begin
-        Thread.current[:object_as_json_references] = references if references.empty?
-        references << object_id
-        hash = {}
-
-        # Apply :only and :except filter from the options to the hash of instance variables.
-        values = instance_values
-        if options && SafeObjectAsJson::SUPPORT_FILTERING
-          only_attr = options[:only]
-          if only_attr
-            values = values.slice(*Array(only_attr).map(&:to_s))
-          else
-            except_attr = options[:except]
-            if except_attr
-              values = values.except(*Array(except_attr).map(&:to_s))
-            end
+    SafeObjectAsJson.track_references do |references|
+      if respond_to?(:to_hash)
+        # Register this object while its hash representation is being serialized so a
+        # circular reference back to it serializes as nil instead of recursing forever.
+        # A distinct key is used so that the registration of this object's id by a
+        # caller serializing it as a value is not mistaken for a circular reference.
+        if references.add?([:to_hash, object_id])
+          begin
+            to_hash.as_json(options)
+          ensure
+            references.delete([:to_hash, object_id])
           end
         end
+      else
+        # The default as_json serializer serializes the instance variables as name value
+        # pairs. In order to prevent infinite recursion, we keep track of the objects
+        # already being serialized and omit them if they are referenced recursively.
+        added = references.add?(object_id)
+        begin
+          hash = {}
 
-        values.each do |name, value|
-          unless references.include?(value.object_id) || value.is_a?(Proc) || value.is_a?(IO)
-            references << value
-            hash[name] = (options.nil? ? value.as_json : value.as_json(options.dup))
+          # Apply :only and :except filter from the options to the hash of instance variables.
+          values = instance_values
+          if options && SafeObjectAsJson::SUPPORT_FILTERING
+            only_attr = options[:only]
+            if only_attr
+              values = values.slice(*Array(only_attr).map(&:to_s))
+            else
+              except_attr = options[:except]
+              if except_attr
+                values = values.except(*Array(except_attr).map(&:to_s))
+              end
+            end
+          end
+
+          values.each do |name, value|
+            next if references.include?(value.object_id) || value.is_a?(Proc) || value.is_a?(IO)
+
+            references << value.object_id
+            begin
+              hash[name] = (options.nil? ? value.as_json : value.as_json(options.dup))
+            ensure
+              references.delete(value.object_id)
+            end
           end
+          hash
+        ensure
+          references.delete(object_id) if added
         end
-        hash
-      ensure
-        references.delete(object_id)
-        Thread.current[:object_as_json_references] = nil if references.empty?
       end
     end
   end

data/safe_object_as_json.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name = "safe_object_as_json"
-  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/safe_object_as_json"
   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[
@@ -19,9 +25,8 @@ Gem::Specification.new do |spec|
     bin/
     gemfiles/
     spec/
-    web_ui.png
   ]
-  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
 
@@ -29,7 +34,5 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "activesupport"
 
-  spec.add_development_dependency "bundler"
-
-  spec.required_ruby_version = ">= 2.5"
+  spec.required_ruby_version = ">= 2.6"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: safe_object_as_json
 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-07-29 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,21 +23,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !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: []
@@ -46,7 +30,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
-- MIT-LICENSE
+- MIT-LICENSE.txt
 - README.md
 - VERSION
 - lib/safe_object_as_json.rb
@@ -54,8 +38,10 @@ files:
 homepage: https://github.com/bdurand/safe_object_as_json
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/bdurand/safe_object_as_json
+  source_code_uri: https://github.com/bdurand/safe_object_as_json
+  changelog_uri: https://github.com/bdurand/safe_object_as_json/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -63,15 +49,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.0.3
-signing_key: 
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Drop in replacement for the Object#as_json implementation in ActiveSupport,
   but with logic to handle circular references between objects to avoid infinite recursion.