active_model_serializers 0.10.9 → 0.10.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e365d9b8e66fd40b66555a2e57faad48fee5bfd82b988ab42aacda73930bb53c
-  data.tar.gz: bbad118b340ea31c7a09f1f0661d0e53866135a99923276182dc159d4eeb2f9c
+  metadata.gz: 94ecdeeabcad7f33e6b2891f2354edeb1fdabf444d9938014d839b554f0a5ab7
+  data.tar.gz: cd43b9ceddf4920feb4efae6c5d0748bbb6e37111328c015cdcca06ba8f9d86d
 SHA512:
-  metadata.gz: 011fcf63a00a7cfc27a54679551cf6c03b3dd4ff177192fca7d2be34bfbb2c3b6c6ba40bc92395997a392ed9bf1d91823da15afa7bde374d08f5e9d69982d054
-  data.tar.gz: 8311b1ed270c60ae5d00beaa2e421a350201bec131a44096190f40dfb61a84f11d50ace18c357cc77e364863bef94eebaad717dc78a156c923049679c5295d1d
+  metadata.gz: 93b28755ff8f015277534dfc971cab0ef5bf30745bebb34c90e2f6e17c1cb611ef1100ba9e484ebdd1dc415d2c9d1c7e715984a1052e75daada8f712b1126850
+  data.tar.gz: 86d257304d0e58b87e82a8c32f55a7722ffdc568dd394ac93214dfe382bf8ff27c8bed24c11f6a948184a16a67ad5fa7bbaf98f2443b2d11c017ce5463c58947

data/CHANGELOG.md

@@ -1,6 +1,6 @@
 ## 0.10.x
 
-### [master (unreleased)](https://github.com/rails-api/active_model_serializers/compare/v0.10.9...0-10-stable)
+### [master (unreleased)](https://github.com/rails-api/active_model_serializers/compare/v0.10.13...0-10-stable)
 
 Breaking changes:
 
@@ -10,8 +10,47 @@ Fixes:
 
 Misc:
 
-### [v0.10.9 (2019-02-08)](https://github.com/rails-api/active_model_serializers/compare/v0.10.8...v0.10.9)
+### [v0.10.13 (2022-01013)](https://github.com/rails-api/active_model_serializers/compare/v0.10.12...v0.10.13)
+
+Fixes:
+
+- [#2399](https://github.com/rails-api/active_model_serializers/pull/2399) Handles edge case where requested current_page > total_pages (@f3z0)
+
+### [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:
 

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>
@@ -13,7 +13,6 @@
     <td>
       <a href="https://codeclimate.com/github/rails-api/active_model_serializers"><img src="https://codeclimate.com/github/rails-api/active_model_serializers/badges/gpa.svg" alt="Code Quality"></a>
       <a href="https://codebeat.co/projects/github-com-rails-api-active_model_serializers"><img src="https://codebeat.co/badges/a9ab35fa-8b5a-4680-9d4e-a81f9a55ebcd" alt="codebeat" ></a>
-      <a href="https://codeclimate.com/github/rails-api/active_model_serializers/coverage"><img src="https://codeclimate.com/github/rails-api/active_model_serializers/badges/coverage.svg" alt="Test Coverage"></a>
     </td>
   </tr>
   <tr>
@@ -41,7 +40,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 +74,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 +86,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 +170,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 +187,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 +228,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 +253,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.
 
@@ -270,7 +269,7 @@ to know about, but not part of ActiveModelSerializers.)
   [(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 +297,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

@@ -23,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/serializer/collection_serializer.rb

@@ -48,8 +48,11 @@ module ActiveModel
         key ||= object.respond_to?(:name) ? object.name && object.name.underscore : nil
         # 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')
+        if raise_cannot_infer_root_key_error?
+          # 5. fail if the key cannot be determined
+          key || fail(CannotInferRootKeyError, 'Cannot infer root key from collection type. Please specify the root or each_serializer option, or render a JSON String')
+        end
+        key
       end
       # rubocop:enable Metrics/CyclomaticComplexity
 
@@ -60,12 +63,18 @@ module ActiveModel
           object.respond_to?(:size)
       end
 
+      class CannotInferRootKeyError < StandardError; end
+
       protected
 
       attr_reader :serializers, :options
 
       private
 
+      def raise_cannot_infer_root_key_error?
+        ActiveModelSerializers.config.raise_cannot_infer_root_key_error
+      end
+
       def serializers_from_resources
         serializer_context_class = options.fetch(:serializer_context_class, ActiveModel::Serializer)
         object.map do |resource|

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

@@ -56,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}'.

data/lib/active_model/serializer/fieldset.rb

@@ -12,7 +12,7 @@ module ActiveModel
       end
 
       def fields_for(type)
-        fields[type.singularize.to_sym] || fields[type.pluralize.to_sym]
+        fields[type.to_s.singularize.to_sym] || fields[type.to_s.pluralize.to_sym]
       end
 
       protected

data/lib/active_model/serializer/reflection.rb

@@ -87,8 +87,8 @@ module ActiveModel
       #       meta ids: ids
       #     end
       #   end
-      def link(name, value = nil)
-        options[:links][name] = block_given? ? Proc.new : value
+      def link(name, value = nil, &block)
+        options[:links][name] = block_given? ? block : value
         :nil
       end
 
@@ -102,8 +102,8 @@ module ActiveModel
       #       href object.blog.id.to_s
       #       meta(id: object.blog.id)
       #     end
-      def meta(value = nil)
-        options[:meta] = block_given? ? Proc.new : value
+      def meta(value = nil, &block)
+        options[:meta] = block_given? ? block : value
         :nil
       end
 

data/lib/active_model/serializer/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveModel
   class Serializer
-    VERSION = '0.10.9'.freeze
+    VERSION = '0.10.13'.freeze
   end
 end

data/lib/active_model/serializer.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'thread_safe'
 require 'jsonapi/include_directive'
 require 'active_model/serializer/collection_serializer'
 require 'active_model/serializer/array_serializer'
@@ -73,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
@@ -94,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
@@ -147,6 +146,8 @@ module ActiveModel
     config.jsonapi_include_toplevel_object = false
     config.jsonapi_use_foreign_key_on_belongs_to_relationship = false
     config.include_data_default = true
+    # Raise ActiveModel::Serializer::CollectionSerializer::CannotInferRootKeyError when cannot infer root key from collection type
+    config.raise_cannot_infer_root_key_error = true
 
     # For configuring how serializers are found.
     # This should be an array of procs.
@@ -365,6 +366,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)
@@ -379,7 +383,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)

data/lib/active_model_serializers/adapter/attributes.rb

@@ -3,6 +3,11 @@
 module ActiveModelSerializers
   module Adapter
     class Attributes < Base
+      def initialize(*)
+        super
+        instance_options[:fieldset] ||= ActiveModel::Serializer::Fieldset.new(fields_to_fieldset(instance_options.delete(:fields)))
+      end
+
       def serializable_hash(options = nil)
         options = serialization_options(options)
         options[:fields] ||= instance_options[:fields]
@@ -10,6 +15,22 @@ module ActiveModelSerializers
 
         self.class.transform_key_casing!(serialized_hash, instance_options)
       end
+
+      private
+
+      def fields_to_fieldset(fields)
+        return fields if fields.nil?
+        resource_fields = []
+        relationship_fields = {}
+        fields.each do |field|
+          case field
+          when Symbol, String then resource_fields << field
+          when Hash then relationship_fields.merge!(field)
+          else fail ArgumentError, "Unknown conversion of fields to fieldset: '#{field.inspect}' in '#{fields.inspect}'"
+          end
+        end
+        relationship_fields.merge!(serializer.json_key.to_sym => resource_fields)
+      end
     end
   end
 end

data/lib/active_model_serializers/adapter/json_api/pagination_links.rb

@@ -55,11 +55,15 @@ module ActiveModelSerializers
 
         def prev_page_url
           return nil if collection.current_page == FIRST_PAGE
+          if collection.current_page > collection.total_pages
+            return url_for_page(collection.total_pages)
+          end
           url_for_page(collection.current_page - FIRST_PAGE)
         end
 
         def next_page_url
-          return nil if collection.total_pages == 0 || collection.current_page == collection.total_pages
+          return nil if collection.total_pages == 0 ||
+              collection.current_page >= collection.total_pages
           url_for_page(collection.next_page)
         end
 

data/lib/active_model_serializers/adapter/json_api/resource_identifier.rb

@@ -13,7 +13,7 @@ module ActiveModelSerializers
           type = inflect_type(type)
           type = type_for(:no_class_needed, type, options)
           if id.blank?
-            { type: type }
+            nil
           else
             { id: id.to_s, type: type }
           end

data/lib/active_model_serializers/model/caching.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+module ActiveModelSerializers
+  class Model
+    module Caching
+      extend ActiveSupport::Concern
+
+      included do
+        attr_writer :updated_at
+        attributes :id
+      end
+
+      # Defaults to the downcased model name and updated_at
+      def cache_key
+        ActiveSupport::Cache.expand_cache_key([
+          self.class.model_name.name.downcase,
+          "#{id}-#{updated_at.strftime('%Y%m%d%H%M%S%9N')}"
+        ].compact)
+      end
+
+      # Defaults to the time the serializer file was modified.
+      def updated_at
+        defined?(@updated_at) ? @updated_at : File.mtime(__FILE__)
+      end
+    end
+  end
+end