active_model_serializers 0.10.7 → 0.10.12

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
@@ -10,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/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'
 
@@ -85,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
 
@@ -100,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
 
@@ -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.12'.freeze
   end
 end

data/lib/active_model_serializers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_model'
 require 'active_support'
 require 'active_support/core_ext/object/with_options'
@@ -5,16 +7,19 @@ require 'active_support/core_ext/string/inflections'
 require 'active_support/json'
 module ActiveModelSerializers
   extend ActiveSupport::Autoload
-  autoload :Model
-  autoload :Callbacks
-  autoload :Deserialization
-  autoload :SerializableResource
-  autoload :Logging
-  autoload :Test
-  autoload :Adapter
-  autoload :JsonPointer
-  autoload :Deprecate
-  autoload :LookupChain
+  eager_autoload do
+    autoload :Model
+    autoload :Callbacks
+    autoload :SerializableResource
+    autoload :SerializationContext
+    autoload :Logging
+    autoload :Test
+    autoload :Adapter
+    autoload :JsonPointer
+    autoload :Deprecate
+    autoload :LookupChain
+    autoload :Deserialization
+  end
 
   class << self; attr_accessor :logger; end
   self.logger = ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new(STDOUT))
@@ -46,6 +51,11 @@ module ActiveModelSerializers
     $VERBOSE = original_verbose
   end
 
+  def self.eager_load!
+    super
+    ActiveModel::Serializer.eager_load!
+  end
+
   require 'active_model/serializer/version'
   require 'active_model/serializer'
   require 'active_model/serializable_resource'

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/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.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/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/null.rb

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

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.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/model/caching.rb

@@ -0,0 +1,25 @@
+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