active_model_serializers 0.10.7 → 0.10.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c3a5900ed1c671e57b90ea00e3130ad3a5fe4939a6a1c36e1481dbdeeef3199
-  data.tar.gz: 59ed63aa89861c650f87ba5bfeb5dfc90c997cd8fe4542129f28d1194d3c24ff
+  metadata.gz: 3c046246492aa51d55bec5b8ce5d2a97d9cd0ff8dba206cdde613f47aca0230e
+  data.tar.gz: 3621cbc3e965bc80389e08b40483b6de73e4a7c7ba7ac96315e1d6e5ee2995e9
 SHA512:
-  metadata.gz: 0ee2569a69953e286d63861bb01a37836ee9b25463980da1dc561815e0d7e7902aa1b1d344b265bb50f3c41b1e93ea6cfec2ba241c5314511d4a55a5082f5ce0
-  data.tar.gz: d011e2d950d8b7869d4f49139d23cf994f2b1f6e8319aa2a3ff018d4f1c578d24bb64cfe632c912e91edd92e0f5945fa58a1a7742b611ef33c5a4d0a14dfbc70
+  metadata.gz: 6fca5a15965145969a683b4f3466a067812ae6680a6a171e885854b6e8e1a684685cb0b37b6ffd52045c8404a95237ddfdd45628e39c0e33a779512ee5a56f5b
+  data.tar.gz: c32438302db80117e82bec0964c58177cca8579765e5169d127b423927430ab2cff2c51f8b6858e09ea53044b8cf6205524398d0a2e8560738499e9e80983dfa

data/CHANGELOG.md

@@ -1,6 +1,6 @@
 ## 0.10.x
 
-### [master (unreleased)](https://github.com/rails-api/active_model_serializers/compare/v0.10.7...0-10-stable)
+### [master (unreleased)](https://github.com/rails-api/active_model_serializers/compare/v0.10.12...0-10-stable)
 
 Breaking changes:
 
@@ -10,6 +10,67 @@ Fixes:
 
 Misc:
 
+### [v0.10.12 (2020-12-10)](https://github.com/rails-api/active_model_serializers/compare/v0.10.11...v0.10.12)
+
+Fixes:
+
+- [#2398](https://github.com/rails-api/active_model_serializers/pull/2398) Update rails dependency to < 6.2 (@ritikesh)
+
+### [v0.10.11 (2020-12-04)](https://github.com/rails-api/active_model_serializers/compare/v0.10.10...v0.10.11)
+
+Features:
+
+- [#2361](https://github.com/rails-api/active_model_serializers/pull/2361) Add `ActiveModelSerializers.config.use_sha1_digests` to allow customization of the hashing algorithm used for serializer caching (@alexzherdev)
+
+Fixes:
+
+- [#2344](https://github.com/rails-api/active_model_serializers/pull/2344) Fixes #2341 introduced since #2223 (@wasifhossain)
+- [#2395](https://github.com/rails-api/active_model_serializers/pull/2395) remove explicit require for thread_safe (@ritikesh)
+
+### [v0.10.10 (2019-07-13)](https://github.com/rails-api/active_model_serializers/compare/v0.10.9...v0.10.10)
+
+Fixes:
+
+- [#2319](https://github.com/rails-api/active_model_serializers/pull/2319) Fixes #2316. (@kylekeesling)
+    - Fix Rails 6.0 deprication warnings
+    - update test fixture schema to use `timestamps` instead of `timestamp`
+- [#2223](https://github.com/rails-api/active_model_serializers/pull/2223) Support Fieldset in Attributes/JSON adapters documented in [docs/general/fields.md](https://github.com/rails-api/active_model_serializers/blob/0-10-stable/docs/general/fields.md) that worked partially before (@bf4)
+- [#2337](https://github.com/rails-api/active_model_serializers/pull/2337) fix incorrect belongs_to serialization when foreign_key on object and belongs_to is blank (@InteNs)
+    - Fixes incorrect json-api generation when `jsonapi_use_foreign_key_on_belongs_to_relationship` is `true` and the relationship is blank
+- [#2172](https://github.com/rails-api/active_model_serializers/pull/2172) Preserve the namespace when falling back to a superclass serializer
+
+Misc:
+
+- [#2327](https://github.com/rails-api/active_model_serializers/pull/2327) Add support for Ruby 2.6 on Travis CI (@wasifhossain)
+- [#2304](https://github.com/rails-api/active_model_serializers/pull/2304) Slim down bundled gem by excluding test files and docs (@greysteil)
+
+### [v0.10.9 (2019-02-08)](https://github.com/rails-api/active_model_serializers/compare/v0.10.8...v0.10.9)
+
+Fixes:
+
+- [#2288](https://github.com/rails-api/active_model_serializers/pull/2288)
+  Change the fetch method to deal with recyclable key cache strategy.
+  Fixes #2287. (@cintamani, @wasifhossain)
+- [#2307](https://github.com/rails-api/active_model_serializers/pull/2307) Falsey attribute values should not be reevaluated.
+
+Misc:
+
+- [#2309](https://github.com/rails-api/active_model_serializers/pull/2309) Performance and memory usage fixes
+
+### [v0.10.8 (2018-11-01)](https://github.com/rails-api/active_model_serializers/compare/v0.10.7...v0.10.8)
+
+Features:
+- [#2279](https://github.com/rails-api/active_model_serializers/pull/2279) Support condition options in serializer link statements
+
+Fixes:
+
+- [#2296](https://github.com/rails-api/active_model_serializers/pull/2296) Fixes #2295 (@Hirurg103)
+  - Fix finding of namespaced serializer and non-namespaced model.
+- [#2289](https://github.com/rails-api/active_model_serializers/pull/2289) Fixes #2255 (@f-mer)
+  - Fix autoloading race condition, especially in Rails 5.
+- [#2299](https://github.com/rails-api/active_model_serializers/pull/2299) Fixes #2270 (@chau-bao-long via #2276)
+  - Fix reflection thread-safety bug
+
 ### [v0.10.7 (2017-11-14)](https://github.com/rails-api/active_model_serializers/compare/v0.10.6...v0.10.7)
 
 Regressions Fixed From v0.10.6:

data/README.md

@@ -4,8 +4,8 @@
   <tr>
     <td>Build Status</td>
     <td>
-      <a href="https://travis-ci.org/rails-api/active_model_serializers"><img src="https://travis-ci.org/rails-api/active_model_serializers.svg?branch=master" alt="Build Status" ></a>
-      <a href="https://ci.appveyor.com/project/joaomdmoura/active-model-serializers/branch/master"><img src="https://ci.appveyor.com/api/projects/status/x6xdjydutm54gvyt/branch/master?svg=true" alt="Build status"></a>
+      <a href="https://travis-ci.org/rails-api/active_model_serializers"><img src="https://api.travis-ci.org/rails-api/active_model_serializers.svg?branch=0-10-stable" alt="Build Status" ></a>
+      <a href="https://ci.appveyor.com/project/bf4/active-model-serializers/branch/0-10-stable"><img src="https://ci.appveyor.com/api/projects/status/x6xdjydutm54gvyt/branch/master?svg=true" alt="Build status"></a>
     </td>
   </tr>
   <tr>
@@ -41,7 +41,7 @@ these methods to the adapter.)
 
 By default ActiveModelSerializers will use the **Attributes Adapter** (no JSON root).
 But we strongly advise you to use **JsonApi Adapter**, which
-follows 1.0 of the format specified in [jsonapi.org/format](http://jsonapi.org/format).
+follows 1.0 of the format specified in [jsonapi.org/format](https://jsonapi.org/format).
 Check how to change the adapter in the sections below.
 
 `0.10.x` is **not** backward compatible with `0.9.x` nor `0.8.x`.
@@ -75,9 +75,9 @@ More information is available in the [Guides](docs) and
 If you find a bug, please report an [Issue](https://github.com/rails-api/active_model_serializers/issues/new)
 and see our [contributing guide](CONTRIBUTING.md).
 
-If you have a question, please [post to Stack Overflow](http://stackoverflow.com/questions/tagged/active-model-serializers).
+If you have a question, please [post to Stack Overflow](https://stackoverflow.com/questions/tagged/active-model-serializers).
 
-If you'd like to chat, we have a [community slack](http://amserializers.herokuapp.com).
+If you'd like to chat, we have a [community slack](https://amserializers.herokuapp.com).
 
 Thanks!
 
@@ -87,14 +87,14 @@ If you're reading this at https://github.com/rails-api/active_model_serializers
 reading documentation for our `master`, which may include features that have not
 been released yet. Please see below for the documentation relevant to you.
 
-- [0.10 (master) Documentation](https://github.com/rails-api/active_model_serializers/tree/master)
-- [0.10.6 (latest release) Documentation](https://github.com/rails-api/active_model_serializers/tree/v0.10.6)
-  - [![API Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/gems/active_model_serializers/0.10.6)
-  - [Guides](docs)
+- [0.10 (0-10-stable) Documentation](https://github.com/rails-api/active_model_serializers/tree/0-10-stable)
+- [0.10.10 (latest release) Documentation](https://github.com/rails-api/active_model_serializers/tree/v0.10.10)
+    - [![API Docs](https://img.shields.io/badge/yard-docs-blue.svg)](https://www.rubydoc.info/gems/active_model_serializers/0.10.10)
+    - [Guides](docs)
 - [0.9 (0-9-stable) Documentation](https://github.com/rails-api/active_model_serializers/tree/0-9-stable)
-  - [![API Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/github/rails-api/active_model_serializers/0-9-stable)
+    - [![API Docs](https://img.shields.io/badge/yard-docs-blue.svg)](https://www.rubydoc.info/gems/active_model_serializers/0.9.7)
 - [0.8 (0-8-stable) Documentation](https://github.com/rails-api/active_model_serializers/tree/0-8-stable)
-  - [![API Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/github/rails-api/active_model_serializers/0-8-stable)
+    - [![API Docs](https://img.shields.io/badge/yard-docs-blue.svg)](https://www.rubydoc.info/gems/active_model_serializers/0.8.4)
 
 
 ## High-level behavior
@@ -171,12 +171,12 @@ The original design is also available [here](https://github.com/rails-api/active
 
 ### ActiveModel::Serializer
 
-An **`ActiveModel::Serializer`** wraps a [serializable resource](https://github.com/rails/rails/blob/4-2-stable/activemodel/lib/active_model/serialization.rb)
+An **`ActiveModel::Serializer`** wraps a [serializable resource](https://github.com/rails/rails/blob/master/activemodel/lib/active_model/serialization.rb)
 and exposes an `attributes` method, among a few others.
 It allows you to specify which attributes and associations should be represented in the serializatation of the resource.
 It requires an adapter to transform its attributes into a JSON document; it cannot be serialized itself.
 It may be useful to think of it as a
-[presenter](http://blog.steveklabnik.com/posts/2011-09-09-better-ruby-presenters).
+[presenter](https://blog.steveklabnik.com/posts/2011-09-09-better-ruby-presenters).
 
 #### ActiveModel::CollectionSerializer
 
@@ -188,7 +188,7 @@ and, if there is no serializer, primitives.
 The **`ActiveModelSerializers::Adapter::Base`** describes the structure of the JSON document generated from a
 serializer. For example, the `Attributes` example represents each serializer as its
 unmodified attributes.  The `JsonApi` adapter represents the serializer as a [JSON
-API](http://jsonapi.org/) document.
+API](https://jsonapi.org/) document.
 
 ### ActiveModelSerializers::SerializableResource
 
@@ -229,7 +229,7 @@ High-level overview:
   - `:each_serializer` specifies the serializer for each resource in the collection.
 - For a **single resource**, the `:serializer` option is the resource serializer.
 - Options are partitioned in serializer options and adapter options.  Keys for adapter options are specified by
-    [`ADAPTER_OPTION_KEYS`](https://github.com/rails-api/active_model_serializers/blob/master/lib/active_model_serializers/serializable_resource.rb#L5).
+    [`ADAPTER_OPTION_KEYS`](lib/active_model_serializers/serializable_resource.rb#L5).
     The remaining options are serializer options.
 
 Details:
@@ -254,7 +254,7 @@ Details:
     2. `adapter_instance = ActiveModel::Serializer::Adapter.create(serializer_instance, adapter_opts)`
 1. **ActiveModel::Serializer::CollectionSerializer#new**
   1. If the `serializer_instance` was a `CollectionSerializer` and the `:serializer` serializer_opts
-    is present, then [that serializer is passed into each resource](https://github.com/rails-api/active_model_serializers/blob/a54d237e2828fe6bab1ea5dfe6360d4ecc8214cd/lib/active_model/serializer/array_serializer.rb#L14-L16).
+    is present, then [that serializer is passed into each resource](https://github.com/rails-api/active_model_serializers/blob/0-10-stable/lib/active_model/serializer/collection_serializer.rb#L77-L79).
 1. **ActiveModel::Serializer#attributes** is used by the adapter to get the attributes for
   resource as defined by the serializer.
 
@@ -266,11 +266,11 @@ to know about, but not part of ActiveModelSerializers.)
 
 - An `ActiveRecord::Base` object.
 - Any Ruby object that passes the
-  [Lint](http://www.rubydoc.info/github/rails-api/active_model_serializers/ActiveModel/Serializer/Lint/Tests)
-  [code](https://github.com/rails-api/active_model_serializers/blob/master/lib/active_model/serializer/lint.rb).
+  [Lint](https://www.rubydoc.info/gems/active_model_serializers/ActiveModel/Serializer/Lint/Tests)
+  [(code)](lib/active_model/serializer/lint.rb).
 
 ActiveModelSerializers provides a
-[`ActiveModelSerializers::Model`](https://github.com/rails-api/active_model_serializers/blob/master/lib/active_model_serializers/model.rb),
+[`ActiveModelSerializers::Model`](lib/active_model_serializers/model.rb),
 which is a simple serializable PORO (Plain-Old Ruby Object).
 
 `ActiveModelSerializers::Model` may be used either as a reference implementation, or in production code.
@@ -298,7 +298,7 @@ ActiveModelSerializers::SerializableResource.new(MyModel.new(level: 'awesome'),
 
 ## Semantic Versioning
 
-This project adheres to [semver](http://semver.org/)
+This project adheres to [semver](https://semver.org/)
 
 ## Contributing
 

data/lib/action_controller/serialization.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/core_ext/class/attribute'
 require 'active_model_serializers/serialization_context'
 
@@ -21,7 +23,15 @@ module ActionController
     end
 
     def namespace_for_serializer
-      @namespace_for_serializer ||= self.class.parent unless self.class.parent == Object
+      @namespace_for_serializer ||= namespace_for_class(self.class) unless namespace_for_class(self.class) == Object
+    end
+
+    def namespace_for_class(klass)
+      if Module.method_defined?(:module_parent)
+        klass.module_parent
+      else
+        klass.parent
+      end
     end
 
     def serialization_scope

data/lib/active_model/serializable_resource.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'set'
 
 module ActiveModel

data/lib/active_model/serializer.rb

@@ -1,4 +1,5 @@
-require 'thread_safe'
+# frozen_string_literal: true
+
 require 'jsonapi/include_directive'
 require 'active_model/serializer/collection_serializer'
 require 'active_model/serializer/array_serializer'
@@ -18,16 +19,17 @@ module ActiveModel
     # @see #serializable_hash for more details on these valid keys.
     SERIALIZABLE_HASH_VALID_KEYS = [:only, :except, :methods, :include, :root].freeze
     extend ActiveSupport::Autoload
-    autoload :Adapter
-    autoload :Null
-    autoload :Attribute
-    autoload :Association
-    autoload :Reflection
-    autoload :SingularReflection
-    autoload :CollectionReflection
-    autoload :BelongsToReflection
-    autoload :HasOneReflection
-    autoload :HasManyReflection
+    eager_autoload do
+      autoload :Adapter
+      autoload :Null
+      autoload :Attribute
+      autoload :Link
+      autoload :Association
+      autoload :Reflection
+      autoload :BelongsToReflection
+      autoload :HasOneReflection
+      autoload :HasManyReflection
+    end
     include ActiveSupport::Configurable
     include Caching
 
@@ -70,7 +72,7 @@ module ActiveModel
     # Used to cache serializer name => serializer class
     # when looked up by Serializer.get_serializer_for.
     def self.serializers_cache
-      @serializers_cache ||= ThreadSafe::Cache.new
+      @serializers_cache ||= Concurrent::Map.new
     end
 
     # @api private
@@ -91,7 +93,7 @@ module ActiveModel
         if serializer_class
           serializer_class
         elsif klass.superclass
-          get_serializer_for(klass.superclass)
+          get_serializer_for(klass.superclass, namespace)
         else
           nil # No serializer found
         end
@@ -275,9 +277,14 @@ module ActiveModel
     #   link(:self) { "http://example.com/resource/#{object.id}" }
     # @example
     #   link :resource, "http://example.com/resource"
+    # @example
+    #   link(:callback, if: :internal?), { "http://example.com/callback" }
     #
-    def self.link(name, value = nil, &block)
-      _links[name] = block || value
+    def self.link(name, *args, &block)
+      options = args.extract_options!
+      # For compatibility with the use case of passing link directly as string argument
+      # without block, we are creating a wrapping block
+      _links[name] = Link.new(name, options, block || ->(_serializer) { args.first })
     end
 
     # Set the JSON API meta attribute of a serializer.
@@ -341,7 +348,7 @@ module ActiveModel
       return Enumerator.new {} unless object
 
       Enumerator.new do |y|
-        self.class._reflections.each do |key, reflection|
+        (self.instance_reflections ||= self.class._reflections.deep_dup).each do |key, reflection|
           next if reflection.excluded?(self)
           next unless include_directive.key?(key)
 
@@ -357,6 +364,9 @@ module ActiveModel
     def serializable_hash(adapter_options = nil, options = {}, adapter_instance = self.class.serialization_adapter_instance)
       adapter_options ||= {}
       options[:include_directive] ||= ActiveModel::Serializer.include_directive_from_options(adapter_options)
+      if (fieldset = adapter_options[:fieldset])
+        options[:fields] = fieldset.fields_for(json_key)
+      end
       resource = attributes_hash(adapter_options, options, adapter_instance)
       relationships = associations_hash(adapter_options, options, adapter_instance)
       resource.merge(relationships)
@@ -371,7 +381,12 @@ module ActiveModel
 
     # Used by adapter as resource root.
     def json_key
-      root || _type || object.class.model_name.to_s.underscore
+      root || _type ||
+        begin
+          object.class.model_name.to_s.underscore
+        rescue ArgumentError
+          'anonymous_object'
+        end
     end
 
     def read_attribute_for_serialization(attr)
@@ -405,6 +420,6 @@ module ActiveModel
 
     protected
 
-    attr_accessor :instance_options
+    attr_accessor :instance_options, :instance_reflections
   end
 end

data/lib/active_model/serializer/adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_model_serializers/adapter'
 require 'active_model_serializers/deprecate'
 

data/lib/active_model/serializer/adapter/attributes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveModel
   class Serializer
     module Adapter

data/lib/active_model/serializer/adapter/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveModel
   class Serializer
     module Adapter

data/lib/active_model/serializer/adapter/json.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveModel
   class Serializer
     module Adapter

data/lib/active_model/serializer/adapter/json_api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveModel
   class Serializer
     module Adapter

data/lib/active_model/serializer/adapter/null.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveModel
   class Serializer
     module Adapter

data/lib/active_model/serializer/array_serializer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_model/serializer/collection_serializer'
 
 module ActiveModel

data/lib/active_model/serializer/association.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_model/serializer/lazy_association'
 
 module ActiveModel

data/lib/active_model/serializer/attribute.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_model/serializer/field'
 
 module ActiveModel

data/lib/active_model/serializer/belongs_to_reflection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveModel
   class Serializer
     # @api private

data/lib/active_model/serializer/collection_serializer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveModel
   class Serializer
     class CollectionSerializer
@@ -19,11 +21,10 @@ module ActiveModel
 
       # @api private
       def serializable_hash(adapter_options, options, adapter_instance)
-        include_directive = ActiveModel::Serializer.include_directive_from_options(adapter_options)
-        adapter_options[:cached_attributes] ||= ActiveModel::Serializer.cache_read_multi(self, adapter_instance, include_directive)
-        adapter_opts = adapter_options.merge(include_directive: include_directive)
+        options[:include_directive] ||= ActiveModel::Serializer.include_directive_from_options(adapter_options)
+        options[:cached_attributes] ||= ActiveModel::Serializer.cache_read_multi(self, adapter_instance, options[:include_directive])
         serializers.map do |serializer|
-          serializer.serializable_hash(adapter_opts, options, adapter_instance)
+          serializer.serializable_hash(adapter_options, options, adapter_instance)
         end
       end
 
@@ -48,8 +49,7 @@ module ActiveModel
         # 4. key may be nil for empty collection and no serializer option
         key &&= key.pluralize
         # 5. fail if the key cannot be determined
-        key || fail(ArgumentError, 'Cannot infer root key from collection type. Please
-                 specify the root or each_serializer option, or render a JSON String')
+        key || fail(ArgumentError, 'Cannot infer root key from collection type. Please specify the root or each_serializer option, or render a JSON String')
       end
       # rubocop:enable Metrics/CyclomaticComplexity
 

data/lib/active_model/serializer/concerns/caching.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveModel
   class Serializer
     UndefinedCacheKey = Class.new(StandardError)
@@ -54,7 +56,8 @@ module ActiveModel
         def digest_caller_file(caller_line)
           serializer_file_path = caller_line[CALLER_FILE]
           serializer_file_contents = IO.read(serializer_file_path)
-          Digest::MD5.hexdigest(serializer_file_contents)
+          algorithm = ActiveModelSerializers.config.use_sha1_digests ? Digest::SHA1 : Digest::MD5
+          algorithm.hexdigest(serializer_file_contents)
         rescue TypeError, Errno::ENOENT
           warn <<-EOF.strip_heredoc
             Cannot digest non-existent file: '#{caller_line}'.
@@ -281,7 +284,9 @@ module ActiveModel
       # Use object's cache_key if available, else derive a key from the object
       # Pass the `key` option to the `cache` declaration or override this method to customize the cache key
       def object_cache_key
-        if object.respond_to?(:cache_key)
+        if object.respond_to?(:cache_key_with_version)
+          object.cache_key_with_version
+        elsif object.respond_to?(:cache_key)
           object.cache_key
         elsif (serializer_cache_key = (serializer_class._cache_key || serializer_class._cache_options[:key]))
           object_time_safe = object.updated_at