active_model_serializers 0.10.6 → 0.10.13

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
@@ -142,7 +144,10 @@ module ActiveModel
     # Make JSON API top-level jsonapi member opt-in
     # ref: http://jsonapi.org/format/#document-top-level
     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.
@@ -274,9 +279,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.
@@ -337,10 +347,10 @@ module ActiveModel
     # @return [Enumerator<Association>]
     def associations(include_directive = ActiveModelSerializers.default_include_directive, include_slice = nil)
       include_slice ||= include_directive
-      return Enumerator.new unless object
+      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)
 
@@ -356,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)
@@ -370,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)
@@ -404,6 +422,6 @@ module ActiveModel
 
     protected
 
-    attr_accessor :instance_options
+    attr_accessor :instance_options, :instance_reflections
   end
 end

data/lib/active_model_serializers/adapter/attributes.rb

@@ -1,6 +1,13 @@
+# frozen_string_literal: true
+
 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]
@@ -8,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/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'case_transform'
 
 module ActiveModelSerializers

data/lib/active_model_serializers/adapter/json.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveModelSerializers
   module Adapter
     class Json < Base

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveModelSerializers
   module Adapter
     class JsonApi
@@ -189,7 +191,7 @@ module ActiveModelSerializers
 
           polymorphic = (options[:polymorphic] || []).include?(assoc_name.to_sym)
           if polymorphic
-            hash["#{prefix_key}_type".to_sym] = assoc_data.present? ? assoc_data['type'] : nil
+            hash["#{prefix_key}_type".to_sym] = assoc_data.present? ? assoc_data['type'].classify : nil
           end
 
           hash

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveModelSerializers
   module Adapter
     class JsonApi < Base

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveModelSerializers
   module Adapter
     class JsonApi < Base

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveModelSerializers
   module Adapter
     class JsonApi

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveModelSerializers
   module Adapter
     class JsonApi

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveModelSerializers
   module Adapter
     class JsonApi < Base
@@ -15,17 +17,18 @@ module ActiveModelSerializers
  JsonApi::PaginationLinks requires a ActiveModelSerializers::SerializationContext.
  Please pass a ':serialization_context' option or
  override CollectionSerializer#paginated? to return 'false'.
-             EOF
+            EOF
           end
         end
 
         def as_json
-          per_page = collection.try(:per_page) || collection.try(:limit_value) || collection.size
-          pages_from.each_with_object({}) do |(key, value), hash|
-            params = query_parameters.merge(page: { number: value, size: per_page }).to_query
-
-            hash[key] = "#{url(adapter_options)}?#{params}"
-          end
+          {
+            self:  location_url,
+            first: first_page_url,
+            prev:  prev_page_url,
+            next:  next_page_url,
+            last:  last_page_url
+          }
         end
 
         protected
@@ -34,25 +37,43 @@ module ActiveModelSerializers
 
         private
 
-        def pages_from
-          return {} if collection.total_pages <= FIRST_PAGE
+        def location_url
+          url_for_page(collection.current_page)
+        end
 
-          {}.tap do |pages|
-            pages[:self] = collection.current_page
+        def first_page_url
+          url_for_page(1)
+        end
 
-            unless collection.current_page == FIRST_PAGE
-              pages[:first] = FIRST_PAGE
-              pages[:prev]  = collection.current_page - FIRST_PAGE
-            end
+        def last_page_url
+          if collection.total_pages == 0
+            url_for_page(FIRST_PAGE)
+          else
+            url_for_page(collection.total_pages)
+          end
+        end
 
-            unless collection.current_page == collection.total_pages
-              pages[:next] = collection.current_page + FIRST_PAGE
-              pages[:last] = collection.total_pages
-            end
+        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 url(options)
+        def next_page_url
+          return nil if collection.total_pages == 0 ||
+              collection.current_page >= collection.total_pages
+          url_for_page(collection.next_page)
+        end
+
+        def url_for_page(number)
+          params = query_parameters.dup
+          params[:page] = { size: per_page, number: number }
+          "#{url(adapter_options)}?#{params.to_query}"
+        end
+
+        def url(options = {})
           @url ||= options.fetch(:links, {}).fetch(:self, nil) || request_url
         end
 
@@ -63,6 +84,10 @@ module ActiveModelSerializers
         def query_parameters
           @query_parameters ||= context.query_parameters
         end
+
+        def per_page
+          @per_page ||= collection.try(:per_page) || collection.try(:limit_value) || collection.size
+        end
       end
     end
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveModelSerializers
   module Adapter
     class JsonApi
@@ -43,10 +45,16 @@ module ActiveModelSerializers
         end
 
         def data_for_one(association)
-          if association.belongs_to? &&
-              parent_serializer.object.respond_to?(association.reflection.foreign_key)
-            id = parent_serializer.object.send(association.reflection.foreign_key)
-            type = association.reflection.type.to_s
+          if belongs_to_id_on_self?(association)
+            id = parent_serializer.read_attribute_for_serialization(association.reflection.foreign_key)
+            type =
+              if association.polymorphic?
+                # We can't infer resource type for polymorphic relationships from the serializer.
+                # We can ONLY know a polymorphic resource type by inspecting each resource.
+                association.lazy_association.serializer.json_key
+              else
+                association.reflection.type.to_s
+              end
             ResourceIdentifier.for_type_with_id(type, id, serializable_resource_options)
           else
             # TODO(BF): Process relationship without evaluating lazy_association
@@ -86,6 +94,12 @@ module ActiveModelSerializers
           meta = association.meta
           meta.respond_to?(:call) ? parent_serializer.instance_eval(&meta) : meta
         end
+
+        def belongs_to_id_on_self?(association)
+          parent_serializer.config.jsonapi_use_foreign_key_on_belongs_to_relationship &&
+            association.belongs_to? &&
+            parent_serializer.object.respond_to?(association.reflection.foreign_key)
+        end
       end
     end
   end

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

@@ -1,33 +1,37 @@
+# frozen_string_literal: true
+
 module ActiveModelSerializers
   module Adapter
     class JsonApi
       class ResourceIdentifier
-        def self.type_for(class_name, serializer_type = nil, transform_options = {})
-          if serializer_type
-            raw_type = serializer_type
-          else
-            inflection =
-              if ActiveModelSerializers.config.jsonapi_resource_type == :singular
-                :singularize
-              else
-                :pluralize
-              end
-
-            raw_type = class_name.underscore
-            raw_type = ActiveSupport::Inflector.public_send(inflection, raw_type)
-            raw_type
-              .gsub!('/'.freeze, ActiveModelSerializers.config.jsonapi_namespace_separator)
-            raw_type
-          end
+        def self.type_for(serializer, serializer_type = nil, transform_options = {})
+          raw_type = serializer_type ? serializer_type : raw_type_from_serializer_object(serializer.object)
           JsonApi.send(:transform_key_casing!, raw_type, transform_options)
         end
 
         def self.for_type_with_id(type, id, options)
-          return nil if id.blank?
-          {
-            id: id.to_s,
-            type: type_for(:no_class_needed, type, options)
-          }
+          type = inflect_type(type)
+          type = type_for(:no_class_needed, type, options)
+          if id.blank?
+            nil
+          else
+            { id: id.to_s, type: type }
+          end
+        end
+
+        def self.raw_type_from_serializer_object(object)
+          class_name = object.class.name # should use model_name
+          raw_type = class_name.underscore
+          raw_type = inflect_type(raw_type)
+          raw_type
+            .gsub!('/'.freeze, ActiveModelSerializers.config.jsonapi_namespace_separator)
+          raw_type
+        end
+
+        def self.inflect_type(type)
+          singularize = ActiveModelSerializers.config.jsonapi_resource_type == :singular
+          inflection = singularize ? :singularize : :pluralize
+          ActiveSupport::Inflector.public_send(inflection, type)
         end
 
         # {http://jsonapi.org/format/#document-resource-identifier-objects Resource Identifier Objects}
@@ -37,8 +41,11 @@ module ActiveModelSerializers
         end
 
         def as_json
-          return nil if id.blank?
-          { id: id, type: type }
+          if id.blank?
+            { type: type }
+          else
+            { id: id.to_s, type: type }
+          end
         end
 
         protected
@@ -48,7 +55,8 @@ module ActiveModelSerializers
         private
 
         def type_for(serializer, transform_options)
-          self.class.type_for(serializer.object.class.name, serializer._type, transform_options)
+          serializer_type = serializer._type
+          self.class.type_for(serializer, serializer_type, transform_options)
         end
 
         def id_for(serializer)

data/lib/active_model_serializers/adapter/json_api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # {http://jsonapi.org/format/ JSON API specification}
 # rubocop:disable Style/AsciiComments
 # TODO: implement!
@@ -22,14 +24,16 @@ module ActiveModelSerializers
   module Adapter
     class JsonApi < Base
       extend ActiveSupport::Autoload
-      autoload :Jsonapi
-      autoload :ResourceIdentifier
-      autoload :Relationship
-      autoload :Link
-      autoload :PaginationLinks
-      autoload :Meta
-      autoload :Error
-      autoload :Deserialization
+      eager_autoload do
+        autoload :Jsonapi
+        autoload :ResourceIdentifier
+        autoload :Link
+        autoload :PaginationLinks
+        autoload :Meta
+        autoload :Error
+        autoload :Deserialization
+        autoload :Relationship
+      end
 
       def self.default_key_transform
         :dash
@@ -480,7 +484,8 @@ module ActiveModelSerializers
       #   }.reject! {|_,v| v.nil? }
       def links_for(serializer)
         serializer._links.each_with_object({}) do |(name, value), hash|
-          result = Link.new(serializer, value).as_json
+          next if value.excluded?(serializer)
+          result = Link.new(serializer, value.block).as_json
           hash[name] = result if result
         end
       end

data/lib/active_model_serializers/adapter/null.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveModelSerializers
   module Adapter
     class Null < Base

data/lib/active_model_serializers/adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveModelSerializers
   module Adapter
     UnknownAdapterError = Class.new(ArgumentError)
@@ -35,7 +37,7 @@ module ActiveModelSerializers
 
       # @return [Array<Symbol>] list of adapter names
       def adapters
-        adapter_map.keys.sort
+        adapter_map.keys.sort!
       end
 
       # Adds an adapter 'klass' with 'name' to the 'adapter_map'

data/lib/active_model_serializers/callbacks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Adapted from
 # https://github.com/rails/rails/blob/7f18ea14c8/activejob/lib/active_job/callbacks.rb
 require 'active_support/callbacks'

data/lib/active_model_serializers/deprecate.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ##
 # Provides a single method +deprecate+ to be used to declare when
 # something is going away.

data/lib/active_model_serializers/deserialization.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveModelSerializers
   module Deserialization
     module_function

data/lib/active_model_serializers/json_pointer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveModelSerializers
   module JsonPointer
     module_function

data/lib/active_model_serializers/logging.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ##
 # ActiveModelSerializers::Logging
 #

data/lib/active_model_serializers/lookup_chain.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveModelSerializers
   module LookupChain
     # Standard appending of Serializer to the resource name.

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

data/lib/active_model_serializers/model.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # ActiveModelSerializers::Model is a convenient superclass for making your models
 # from Plain-Old Ruby Objects (PORO). It also serves as a reference implementation
 # that satisfies ActiveModel::Serializer::Lint::Tests.

data/lib/active_model_serializers/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails/railtie'
 require 'action_controller'
 require 'action_controller/railtie'
@@ -5,6 +7,8 @@ require 'action_controller/serialization'
 
 module ActiveModelSerializers
   class Railtie < Rails::Railtie
+    config.eager_load_namespaces << ActiveModelSerializers
+
     config.to_prepare do
       ActiveModel::Serializer.serializers_cache.clear
     end

data/lib/active_model_serializers/register_jsonapi_renderer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Based on discussion in https://github.com/rails/rails/pull/23712#issuecomment-184977238,
 # the JSON API media type will have its own format/renderer.
 #

data/lib/active_model_serializers/serializable_resource.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'set'
 
 module ActiveModelSerializers
@@ -14,8 +16,8 @@ module ActiveModelSerializers
     # @return the serializable_resource, ready for #as_json/#to_json/#serializable_hash.
     def initialize(resource, options = {})
       @resource = resource
-      @adapter_opts, @serializer_opts =
-        options.partition { |k, _| ADAPTER_OPTION_KEYS.include? k }.map { |h| Hash[h] }
+      @adapter_opts = options.select { |k, _| ADAPTER_OPTION_KEYS.include? k }
+      @serializer_opts = options.reject { |k, _| ADAPTER_OPTION_KEYS.include? k }
     end
 
     def serialization_scope=(scope)

data/lib/active_model_serializers/serialization_context.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/core_ext/array/extract_options'
 module ActiveModelSerializers
   class SerializationContext

data/lib/active_model_serializers/test/schema.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveModelSerializers
   module Test
     module Schema

data/lib/active_model_serializers/test/serializer.rb

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

data/lib/active_model_serializers/test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveModelSerializers
   module Test
     extend ActiveSupport::Autoload