fast_serializer 1.1.4 → 1.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a466a168d1e4a3e346fca8549c08eef80b4f524d5db975197129f23ce8614b16
-  data.tar.gz: 07113eca188e090a2ab948fc9740ac71de8af3d74e76748a368a4e3acc9d3da1
+  metadata.gz: 43835187de2f5c9d212b524e690bff5b7c9200017db003cd86c7626d7614bbfd
+  data.tar.gz: 5b8fbbde43174cce1fedf517c260ce50dbf8a9543132cb04139247ac360db31e
 SHA512:
-  metadata.gz: dce0f676f3cb5dc3591b9f28ef09ad662b8203839b96a27f30043fd000399fff0c03799ee642a085afecaba60d7221bc97ae5bc3dc044bdcca21d95bba3cbc97
-  data.tar.gz: c4486052e66f392022e8524cb3fa201087248c82ed6444b9b08ff4ee3d1292795a9f6657324213e32791f572751745a05f58b7c896aba8550f0212a1589debd4
+  metadata.gz: aeb09ec697703487469d5cfeee8fb102aec96747cc391146fe602fb1f75169418353df1eea2b92fb841cb58df2937813193014d917d2fa40b73aaef9e86f93af
+  data.tar.gz: e002e4633acaacc799d77718b4ba66dcb1795f372d8e24cd6cce164c7a49b331729a7955018a7ddc4c4a04d79ff8fadf831558bf8e3afe8a484a7c79293316e7

data/CHANGELOG.md

@@ -4,6 +4,22 @@ 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.1.5
+
+### Fixed
+
+- The `delegate: false` option on `serialize` is now honored; previously a delegate method was always defined.
+- Redefining a serialized field (including in a subclass) now replaces the existing field instead of also appending a duplicate that was serialized twice.
+- `SerializationContext` no longer clears its cache on every miss, so duplicate serializers within a context are properly reused.
+- `ArraySerializer#cache` and `#cache_ttl` now return the configured cache and TTL instead of `true`, fixing a crash when passing the `:cache` option to an array serializer.
+- `Cache::ActiveSupportCache#fetch_all` now passes the TTL to `fetch_multi`, so batch-cached entries expire as configured.
+- Serializing non-Array enumerables (such as `Set`) containing values that need conversion no longer raises `NoMethodError`.
+
+### Changed
+
+- Serialization no longer duplicates the options hash for fields without an associated serializer when `:include` or `:exclude` options are present.
+- Minimum required Ruby version is now 2.6.
+
 ## 1.1.4
 
 ### Fixed

data/VERSION

@@ -1 +1 @@
-1.1.4
+1.1.5

data/fast_serializer.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.5"
+  spec.required_ruby_version = ">= 2.6"
 
   spec.add_development_dependency "bundler"
 end

data/lib/fast_serializer/array_serializer.rb

@@ -34,10 +34,10 @@ module FastSerializer
       end
     end
 
-    # @return [Numeric, Boolean]
+    # @return [Numeric, nil]
     def cache_ttl
       if option(:cache_ttl)
-        true
+        option(:cache_ttl)
       elsif option(:serializer)
         option(:serializer).cache_ttl
       else
@@ -45,10 +45,10 @@ module FastSerializer
       end
     end
 
-    # @return [FastSerializer::Cache, Boolean]
+    # @return [FastSerializer::Cache, nil]
     def cache
-      if option(:cache)
-        true
+      if @cache
+        @cache
       elsif option(:serializer)
         option(:serializer).cache
       else
@@ -56,11 +56,9 @@ module FastSerializer
       end
     end
 
-    # @return [Hash]
+    # @return [Array, nil]
     def as_json(*args)
-      if array.nil?
-        nil
-      elsif array.empty?
+      if array.empty?
         []
       else
         super[:array]

data/lib/fast_serializer/cache/active_support_cache.rb

@@ -16,7 +16,7 @@ module FastSerializer
     end
 
     def fetch_all(serializers, ttl)
-      results = @cache.fetch_multi(*serializers) { |serializer| yield(serializer) }
+      results = @cache.fetch_multi(*serializers, expires_in: ttl) { |serializer| yield(serializer) }
       if results.is_a?(Hash)
         serializers.collect { |serializer| results[serializer] }
       else

data/lib/fast_serializer/serialization_context.rb

@@ -55,7 +55,7 @@ module FastSerializer
       unless serializer
         serializer = serializer_class.allocate
         serializer.send(:initialize, object, options)
-        @cache = {}
+        @cache ||= {}
         @cache[key] = serializer
       end
 

data/lib/fast_serializer/serialized_field.rb

@@ -3,7 +3,7 @@
 module FastSerializer
   # Data structure used internally for maintaining a field to be serialized.
   class SerializedField
-    attr_reader :name, :condition
+    attr_reader :name, :condition, :serializer
 
     # Create a new serialized field.
     #
@@ -36,7 +36,6 @@ module FastSerializer
     # @return [Object] the serialized value
     def serialize(value, options = nil)
       if value && @serializer
-        serializer = nil
         serializer = if @enumerable
           ArraySerializer.new(value, serializer: @serializer, serializer_options: serializer_options(options))
         else
@@ -109,7 +108,7 @@ module FastSerializer
       hash = nil
       value.each do |k, v|
         val = serialize_value(v)
-        if val.object_id != v.object_id
+        unless val.equal?(v)
           hash ||= value.dup
           hash[k] = val
         end
@@ -121,9 +120,11 @@ module FastSerializer
       array = nil
       value.each_with_index do |v, i|
         val = serialize_value(v)
-        if val.object_id != v.object_id
-          array ||= value.dup
-          array[i] = val
+        if array
+          array << val
+        elsif !val.equal?(v)
+          array = value.first(i)
+          array << val
         end
       end
       array || value

data/lib/fast_serializer/serializer.rb

@@ -7,17 +7,19 @@ module FastSerializer
   # To define what fields to serialize on the wrapped object, the serializer class must call the +serialize+
   # class method:
   #
+  # @example Defining a basic serializer
   #   class PersonSerializer
   #     include FastSerializer::Serializer
   #     serialize :id, :name
   #   end
   #
-  # This sample serializer will output an object as a hash with keys {:id, :name}. The values for each field
+  # This sample serializer will output an object as a hash with the keys +:id+ and +:name+. The values for each field
   # is gotten by calling the corresponding method on the serializer object. By default, each serialized field
   # will automatically define a method that simply delegates to the wrapped object. So if you need provide special
   # handling for a field or serialize a virtual field that doesn't exist on the parent object, you just need to
   # implement the method on the serializer.
   #
+  # @example Defining a virtual field
   #   class PersonSerializer
   #     include FastSerializer::Serializer
   #     serialize :id, :name
@@ -29,6 +31,7 @@ module FastSerializer
   #
   # Serializers can implement their own options for controlling details about how to serialize the object.
   #
+  # @example Defining a serializer with custom options
   #   class PersonSerializer
   #     include FastSerializer::Serializer
   #     serialize :id, :name
@@ -75,7 +78,7 @@ module FastSerializer
       # Several options can be specified to control how the field is serialized.
       #
       # * as: Name to call the field in the serialized hash. Defaults to the same as the field name
-      #   (withany ? stripped off the end for boolean fields). This option can only be specified
+      #   (with any ? stripped off the end for boolean fields). This option can only be specified
       #   for a single field.
       #
       # * optional: Boolean flag indicating if the field is optional in the serialized value (defaults to false).
@@ -115,7 +118,7 @@ module FastSerializer
         end
         as = options.delete(:as)
         optional = options.delete(:optional) || false
-        delegate = options.delete(:delegate) || true
+        delegate = options.include?(:delegate) ? options.delete(:delegate) : true
         enumerable = options.delete(:enumerable) || false
         serializer = options.delete(:serializer)
         serializer_options = options.delete(:serializer_options)
@@ -205,7 +208,7 @@ module FastSerializer
         @cache_ttl = value
       end
 
-      # Get the cache implemtation used to store cacheable serializers.
+      # Get the cache implementation used to store cacheable serializers.
       #
       # @return [FastSerializer::Cache]
       def cache
@@ -258,7 +261,7 @@ module FastSerializer
       def add_field(name, optional:, serializer:, serializer_options:, enumerable:, condition:)
         name = name.to_sym
         if condition.is_a?(Proc)
-          include_method_name = "__include_#{name}?".to_sym
+          include_method_name = :"__include_#{name}?"
           define_method(include_method_name, condition)
           private include_method_name
           condition = include_method_name
@@ -271,6 +274,7 @@ module FastSerializer
         added = false
         serializable_fields.each do |existing_field|
           field_list << if existing_field.name == name
+            added = true
             field
           else
             existing_field
@@ -307,7 +311,7 @@ module FastSerializer
       @object = object
       @options = options
       @cache = options[:cache] if options
-      if @cache && defined?(ActiveSupport::Cache::Store) && cache.is_a?(ActiveSupport::Cache::Store)
+      if @cache && defined?(ActiveSupport::Cache::Store) && @cache.is_a?(ActiveSupport::Cache::Store)
         @cache = Cache::ActiveSupportCache.new(@cache)
       end
       @_serialized = nil
@@ -388,7 +392,7 @@ module FastSerializer
           condition = field.condition
           next if condition && !send(condition)
 
-          value = field.serialize(send(name), serializer_options(name))
+          value = field.serialize(send(name), field.serializer ? serializer_options(name) : nil)
           hash[name] = value
         end
       end
@@ -405,7 +409,7 @@ module FastSerializer
           include_options = include_options[name.to_sym]
           opts[:include] = include_options if include_options
         end
-        exclude_options = options[:exclude]
+        exclude_options = opts[:exclude]
         if exclude_options.is_a?(Hash)
           exclude_options = exclude_options[name.to_sym]
           opts[:exclude] = exclude_options if exclude_options

data/lib/fast_serializer.rb

@@ -42,7 +42,7 @@ module FastSerializer
   # Exception raised when there is a circular reference serializing a model dependent on itself.
   class CircularReferenceError < StandardError
     def initialize(model)
-      super("Circular refernce on #{model.inspect}")
+      super("Circular reference on #{model.inspect}")
     end
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: fast_serializer
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.1.5
 platform: ruby
 authors:
 - Brian Durand
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-12 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,7 +23,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email:
 - bbdurand@gmail.com
 executables: []
@@ -47,7 +45,6 @@ homepage: https://github.com/bdurand/fast_serializer
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -55,15 +52,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.4.12
-signing_key:
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Super fast object serialization for API's combining a simple DSL with many
   optimizations under the hood.