safe_object_as_json 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c5cfc9f52cea679fdbd39e375fd930f28c9f87f09a636fab4765053c0a5bec84
+  data.tar.gz: 02fd5931b21822ea69643ef8ed47069d055b38a3d15a39b41b70b81829c046bf
+SHA512:
+  metadata.gz: 63e3e7ec587ac6fa99438bd7419b886ea4d0bb2eb8d74763d3de8c60200f8a6c701bb3e9e4e0b2074aee8c36cb8717346602f792adc0d616b26808eaffa8a4de
+  data.tar.gz: e856a2199351f45be79f0abab0a0eac31af2424b9e6fe9370e215617ba358ce3199558c5e35ffa0813d45a345ed9a24081e91829e5ba67062914db088d226357

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# 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
+- Re-implement Object#as_json to omit circular dependencies in internal object references.
+- Omit Proc and IO objects from being included in Object#as_json result.

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,44 @@
+[![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)
+
+# 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.
+
+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.
+
+## 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.
+
+The `Object#as_json` method is really just a fallback method that exists so that all objects can be sent to a JSON serializer. If you do have classes that rely on this method, you should really just implement the `as_json` method yourself. The main reason this gem exists is to handle cases where you don't control the class definition in your application code.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'safe_object_as_json'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install safe_object_as_json
+```
+
+## 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/safe_object_as_json.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "active_support/all"
+
+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
+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.
+  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
+          end
+        end
+
+        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))
+          end
+        end
+        hash
+      ensure
+        references.delete(object_id)
+        Thread.current[:object_as_json_references] = nil if references.empty?
+      end
+    end
+  end
+end

data/safe_object_as_json.gemspec

@@ -0,0 +1,35 @@
+Gem::Specification.new do |spec|
+  spec.name = "safe_object_as_json"
+  spec.version = File.read(File.expand_path("../VERSION", __FILE__)).strip
+  spec.authors = ["Brian Durand"]
+  spec.email = ["bbdurand@gmail.com"]
+
+  spec.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."
+  spec.homepage = "https://github.com/bdurand/safe_object_as_json"
+  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/
+    web_ui.png
+  ]
+  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_dependency "activesupport"
+
+  spec.add_development_dependency "bundler"
+
+  spec.required_ruby_version = ">= 2.5"
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: safe_object_as_json
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brian Durand
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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
+    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/safe_object_as_json.rb
+- safe_object_as_json.gemspec
+homepage: https://github.com/bdurand/safe_object_as_json
+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.0.3
+signing_key: 
+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.
+test_files: []