oj_serializers 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 807a53bcbe017c0279d9be8f654044a0c8834d289dd2e34646121833923ab4c1
-  data.tar.gz: b5f77a958e54273c9729e42a8d9270d4859f1c3aaa338efcbdff0357b3bdc8a5
+  metadata.gz: b12d0af1a11e10d1fd2276700de7e44e67532947ee8edfc56001e74b29ad55f0
+  data.tar.gz: d3e74a9a7e27943417680f469ed995312ec9439908a18652977152a0ba43abd2
 SHA512:
-  metadata.gz: 0753030fff469265ce72aecab4b8f7289d626bc15355f847dd0c57dccda3c3abbaa269e4154017bf12c9e1e3f0335df02bf62e31faf105f4cd2bd2a40c34b4ea
-  data.tar.gz: ad791006f8d82f9a1bba0ce8179d414372d2581fd2181920e9362fdad77b0e707f271a8c9a259e115deedcea9a576dca434b2332aef060502b8b530c69f25c3d
+  metadata.gz: 7ee8a29984fd104c0844c0c30228966effaf2f2244996c0ca874d228eff876d8d356890d24f166c73089be472511b882c1f692a627953a1705250476d2b4fae1
+  data.tar.gz: a5d34b5799786d9716d6c6b5939cf89e41ecdd6679fd72cd39ea0dba5b502beafb5f57975c01c364053cb98ee3787472d992ad3e9a7c2bbe7cf45f3c0c1d4c08

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## Oj Serializers 1.0.1 (2023-03-01) ##
+
+*   [Avoid caching instances of reloaded classes in development](https://github.com/ElMassimo/oj_serializers/commit/0bd928d64d159926acf6b4d57e3f08b12f6931ce)
+
+
 ## Oj Serializers 1.0.0 (2020-11-05) ##
 
 *   Initial Release.

data/README.md

@@ -1,10 +1,10 @@
 <h1 align="center">
 Oj Serializers
 <p align="center">
-<!-- <a href="https://travis-ci.org/ElMassimo/oj_serializers"><img alt="Build Status" src="https://travis-ci.org/ElMassimo/oj_serializers.svg"/></a>
-<a href="http://inch-ci.org/github/ElMassimo/oj_serializers"><img alt="Inline docs" src="http://inch-ci.org/github/ElMassimo/oj_serializers.svg"/></a>
+<a href="https://github.com/ElMassimo/oj_serializers/actions"><img alt="Build Status" src="https://github.com/ElMassimo/oj_serializers/workflows/build/badge.svg"/></a>
+<a href="https://inch-ci.org/github/ElMassimo/oj_serializers"><img alt="Inline docs" src="https://inch-ci.org/github/ElMassimo/oj_serializers.svg"/></a>
 <a href="https://codeclimate.com/github/ElMassimo/oj_serializers"><img alt="Maintainability" src="https://codeclimate.com/github/ElMassimo/oj_serializers/badges/gpa.svg"/></a>
-<a href="https://codeclimate.com/github/ElMassimo/oj_serializers"><img alt="Test Coverage" src="https://codeclimate.com/github/ElMassimo/oj_serializers/badges/coverage.svg"/></a> -->
+<a href="https://codeclimate.com/github/ElMassimo/oj_serializers"><img alt="Test Coverage" src="https://codeclimate.com/github/ElMassimo/oj_serializers/badges/coverage.svg"/></a>
 <a href="https://rubygems.org/gems/oj_serializers"><img alt="Gem Version" src="https://img.shields.io/gem/v/oj_serializers.svg?colorB=e9573f"/></a>
 <a href="https://github.com/ElMassimo/oj_serializers/blob/master/LICENSE.txt"><img alt="License" src="https://img.shields.io/badge/license-MIT-428F7E.svg"/></a>
 </p>
@@ -19,6 +19,7 @@ JSON serializers for Ruby, built on top of the powerful [`oj`][oj] library.
 [panko]: https://github.com/panko-serializer/panko_serializer
 [benchmarks]: https://github.com/ElMassimo/oj_serializers/tree/master/benchmarks
 [raw_benchmarks]: https://github.com/ElMassimo/oj_serializers/blob/master/benchmarks/document_benchmark.rb
+[sugar]: https://github.com/ElMassimo/oj_serializers/blob/master/lib/oj_serializers/sugar.rb#L14
 [migration guide]: https://github.com/ElMassimo/oj_serializers/blob/master/MIGRATION_GUIDE.md
 [design]: https://github.com/ElMassimo/oj_serializers#design-
 [raw_json]: https://github.com/ohler55/oj/issues/542
@@ -174,7 +175,7 @@ class AlbumsController < ApplicationController
 end
 ```
 
-If you are using Rails you can also use something closer to Active Model Serializers by adding `sugar`:
+If you are using Rails you can also use something closer to Active Model Serializers by adding [`sugar`][sugar]:
 
 ```ruby
 require 'oj_serializers/sugar'

data/lib/oj_serializers/compat.rb

@@ -6,11 +6,15 @@ require 'active_model_serializers'
 # as well.
 class ActiveModel::Serializer
   # JsonStringEncoder: Used internally to write a single object to JSON.
+  #
+  # Returns nothing.
   def self.write_one(writer, object, options)
     writer.push_value(new(object, options))
   end
 
   # JsonStringEncoder: Used internally to write an array of objects to JSON.
+  #
+  # Returns nothing.
   def self.write_many(writer, array, options)
     writer.push_array
     array.each do |object|
@@ -20,6 +24,8 @@ class ActiveModel::Serializer
   end
 
   # JsonStringEncoder: Used internally to instantiate an Oj::StringWriter.
+  #
+  # Returns an Oj::StringWriter.
   def self.new_json_writer
     OjSerializers::Serializer.send(:new_json_writer)
   end

data/lib/oj_serializers/json_string_encoder.rb

@@ -10,10 +10,10 @@ module OjSerializers::JsonStringEncoder
     #   render json: items, each_serializer: ItemSerializer
     #   render json: item, serializer: ItemSerializer
     #
-    # Returns a JSON string.
-    #
     # NOTE: Unlike the default encoder, this one will use the `root` option
     # regardless of whether a serializer is specified or not.
+    #
+    # Returns a JSON string.
     def encode_to_json(object, root: nil, serializer: nil, each_serializer: nil, **extras)
       # NOTE: Serializers may override `new_json_writer` to modify the behavior.
       writer = (serializer || each_serializer || OjSerializers::Serializer).send(:new_json_writer)
@@ -40,9 +40,9 @@ module OjSerializers::JsonStringEncoder
       writer.to_json
     end
 
-    # Allows to detect misusage of the options during development.
     if OjSerializers::Serializer::DEV_MODE
       alias actual_encode_to_json encode_to_json
+      # Internal: Allows to detect misusage of the options during development.
       def encode_to_json(object, root: nil, serializer: nil, each_serializer: nil, **extras)
         if serializer && serializer < OjSerializers::Serializer
           raise ArgumentError, 'You must use `each_serializer` when serializing collections' if object.respond_to?(:each)

data/lib/oj_serializers/json_value.rb

@@ -5,15 +5,18 @@
 # NOTE: Oj's raw_json option means there's no performance overhead, as it would
 # occur with the previous alternative of parsing the JSON string.
 class OjSerializers::JsonValue
-  # Helper: Expects an Array of JSON-encoded strings and wraps them in a JSON array.
-  def self.array(json_rows)
-    new("[#{json_rows.join(',')}]")
-  end
-
+  # Public: Expects json to be a JSON-encoded string.
   def initialize(json)
     @json = json
   end
 
+  # Public: Expects an Array of JSON-encoded strings and wraps them in a JSON array.
+  #
+  # Returns a JsonValue representing a JSON-encoded array.
+  def self.array(json_rows)
+    new("[#{json_rows.join(',')}]")
+  end
+
   # Public: Return the internal json when using string interpolation.
   def to_s
     @json

data/lib/oj_serializers/memo.rb

@@ -6,10 +6,14 @@ class OjSerializers::Memo
     @cache = {}
   end
 
+  # Internal: Allows to clear the cache when binding the serializer to a
+  # different object.
   def clear
     @cache.clear
   end
 
+  # Public: Allows to use a simple memoization pattern that also works for
+  # falsey values.
   def fetch(key)
     @cache.fetch(key) { @cache[key] = yield }
   end

data/lib/oj_serializers/serializer.rb

@@ -222,9 +222,6 @@ private
       @_associations
     end
 
-    # Internal: Iterating arrays is faster than iterating hashes.
-    attr_reader :_attributes_entries, :_associations_entries
-
   protected
 
     # Internal: Calculates the cache_key used to cache one serialized item.
@@ -451,7 +448,7 @@ private
     # Internal: Cache key to set a thread-local instance.
     def instance_key
       unless defined?(@instance_key)
-        @instance_key = "#{name.underscore}_instance".to_sym
+        @instance_key = "#{name.underscore}_instance_#{object_id}".to_sym
         # We take advantage of the fact that this method will always be called
         # before instantiating a serializer to define the write_to_json method.
         class_eval(write_to_json_body)

data/lib/oj_serializers/setup.rb

@@ -13,14 +13,15 @@ end
 # NOTE: Add an optimization to make it easier to work with a StringWriter
 # transparently in different scenarios.
 class Oj::StringWriter
-  # Patch: ActiveSupport can pass an options argument to `as_json` when
+  alias original_as_json as_json
+
+  # Internal: ActiveSupport can pass an options argument to `as_json` when
   # serializing a Hash or Array.
-  alias_method :original_as_json, :as_json
   def as_json(_options = nil)
     original_as_json
   end
 
-  # Optimization: We can use `to_s` directly, this is not important but gives a
+  # Internal: We can use `to_s` directly, this is not important but gives a
   # slight boost to a few use cases that use it for caching in Memcached.
   def to_json(_options = nil)
     to_s.delete_suffix("\n")

data/lib/oj_serializers/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OjSerializers
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oj_serializers
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Maximo Mussini
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-07 00:00:00.000000000 Z
+date: 2023-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -95,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: A lighter JSON serializer for Ruby Objects in Rails. Easily migrate away