active_model_serializers 0.10.7 → 0.10.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c3a5900ed1c671e57b90ea00e3130ad3a5fe4939a6a1c36e1481dbdeeef3199
-  data.tar.gz: 59ed63aa89861c650f87ba5bfeb5dfc90c997cd8fe4542129f28d1194d3c24ff
+  metadata.gz: 20ead782c7fc4fcfbfd9739a0fcb1957f65284c65c53b619b3b2ac5ed7339bc3
+  data.tar.gz: d65bf0ce1f442f19679c36f624fde661f6ce4d97db1f849ac948d104ac3d88d2
 SHA512:
-  metadata.gz: 0ee2569a69953e286d63861bb01a37836ee9b25463980da1dc561815e0d7e7902aa1b1d344b265bb50f3c41b1e93ea6cfec2ba241c5314511d4a55a5082f5ce0
-  data.tar.gz: d011e2d950d8b7869d4f49139d23cf994f2b1f6e8319aa2a3ff018d4f1c578d24bb64cfe632c912e91edd92e0f5945fa58a1a7742b611ef33c5a4d0a14dfbc70
+  metadata.gz: ff70ab49d8bc826f3247ffefe845a169411a2a0767a92fa5de560894f70914c99bdad75d17cf2403c7a1eeff68a1611dcfa35da175d2f2cc711c5f7961ac522f
+  data.tar.gz: d85f6549fb002b01220c0710f3928489d747792b4cd9bf65fef2b712dd3c70a6e628a6e33f306927886e85a0f50d32d195c988c8cb7d6045c30f235d5410f6c6

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.10...0-10-stable)
 
 Breaking changes:
 
@@ -10,6 +10,50 @@ Fixes:
 
 Misc:
 
+### [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

@@ -266,8 +266,8 @@ 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),

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/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/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/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)
@@ -281,7 +283,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

data/lib/active_model/serializer/error_serializer.rb

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

data/lib/active_model/serializer/errors_serializer.rb

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

data/lib/active_model/serializer/field.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveModel
   class Serializer
     # Holds all the meta-data about a field (i.e. attribute or association) as it was

data/lib/active_model/serializer/fieldset.rb

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

data/lib/active_model/serializer/has_many_reflection.rb

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

data/lib/active_model/serializer/has_one_reflection.rb

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

data/lib/active_model/serializer/lazy_association.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveModel
   class Serializer
     # @api private
@@ -7,11 +9,12 @@ module ActiveModel
       delegate :collection?, to: :reflection
 
       def reflection_options
-        @reflection_options ||= reflection.options.dup.reject { |k, _| !REFLECTION_OPTIONS.include?(k) }
+        @reflection_options ||= reflection.options.select { |k, _| REFLECTION_OPTIONS.include?(k) }
       end
 
       def object
-        @object ||= reflection.value(
+        return @object if defined?(@object)
+        @object = reflection.value(
           association_options.fetch(:parent_serializer),
           association_options.fetch(:include_slice)
         )
@@ -76,6 +79,7 @@ module ActiveModel
         serializer_options[:serializer_context_class] = association_options.fetch(:parent_serializer).class
         serializer = reflection_options.fetch(:serializer, nil)
         serializer_options[:serializer] = serializer if serializer
+        serializer_options[:namespace]  = reflection_options[:namespace] if reflection_options[:namespace]
         serializer_class.new(object, serializer_options)
       end
 

data/lib/active_model/serializer/link.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'active_model/serializer/field'
+
+module ActiveModel
+  class Serializer
+    # Holds all the data about a serializer link
+    #
+    # @example
+    #   class PostSerializer < ActiveModel::Serializer
+    #     link :callback, if: :internal? do
+    #       object.callback_link
+    #     end
+    #
+    #     def internal?
+    #       instance_options[:internal] == true
+    #     end
+    #   end
+    #
+    class Link < Field
+    end
+  end
+end

data/lib/active_model/serializer/lint.rb

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

data/lib/active_model/serializer/null.rb

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

data/lib/active_model/serializer/reflection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_model/serializer/field'
 require 'active_model/serializer/association'
 
@@ -151,6 +153,9 @@ module ActiveModel
       # @yield [ActiveModel::Serializer]
       # @return [:nil, associated resource or resource collection]
       def value(serializer, include_slice)
+        # NOTE(BF): This method isn't thread-safe because the _reflections class attribute is not thread-safe
+        # Therefore, when we build associations from reflections, we dup the entire reflection instance.
+        # Better solutions much appreciated!
         @object = serializer.object
         @scope = serializer.scope
 

data/lib/active_model/serializer/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module ActiveModel
   class Serializer
-    VERSION = '0.10.7'.freeze
+    VERSION = '0.10.10'.freeze
   end
 end

data/lib/active_model/serializer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'thread_safe'
 require 'jsonapi/include_directive'
 require 'active_model/serializer/collection_serializer'
@@ -18,16 +20,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
 
@@ -91,7 +94,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 +278,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 +349,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 +365,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 +382,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 +421,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

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

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

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

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveModelSerializers
   module Adapter
     class JsonApi
@@ -11,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/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'