active_model_serializers 0.9.0 → 0.9.8

data/lib/active_model/array_serializer.rb

@@ -15,15 +15,18 @@ module ActiveModel
       @object          = object
       @scope           = options[:scope]
       @root            = options.fetch(:root, self.class._root)
+      @polymorphic     = options.fetch(:polymorphic, false)
       @meta_key        = options[:meta_key] || :meta
       @meta            = options[@meta_key]
       @each_serializer = options[:each_serializer]
       @resource_name   = options[:resource_name]
       @only            = options[:only] ? Array(options[:only]) : nil
       @except          = options[:except] ? Array(options[:except]) : nil
+      @context         = options[:context]
+      @namespace       = options[:namespace]
       @key_format      = options[:key_format] || options[:each_serializer].try(:key_format)
     end
-    attr_accessor :object, :scope, :root, :meta_key, :meta, :key_format
+    attr_accessor :object, :scope, :root, :meta_key, :meta, :key_format, :context
 
     def json_key
       key = root.nil? ? @resource_name : root
@@ -32,13 +35,13 @@ module ActiveModel
     end
 
     def serializer_for(item)
-      serializer_class = @each_serializer || Serializer.serializer_for(item) || DefaultSerializer
-      serializer_class.new(item, scope: scope, key_format: key_format, only: @only, except: @except)
+      serializer_class = @each_serializer || Serializer.serializer_for(item, namespace: @namespace) || DefaultSerializer
+      serializer_class.new(item, scope: scope, key_format: key_format, context: @context, only: @only, except: @except, polymorphic: @polymorphic, namespace: @namespace)
     end
 
-    def serializable_object
+    def serializable_object(options={})
       @object.map do |item|
-        serializer_for(item).serializable_object
+        serializer_for(item).serializable_object_with_notification(options)
       end
     end
     alias_method :serializable_array, :serializable_object
@@ -49,7 +52,11 @@ module ActiveModel
           next if !objects || objects.flatten.empty?
 
           if hash.has_key?(type)
-            hash[type].concat(objects).uniq!
+            case hash[type] when Hash
+              hash[type].deep_merge!(objects){ |key, old, new| (Array(old) + Array(new)).uniq }
+            else
+              hash[type].concat(objects).uniq!
+            end
           else
             hash[type] = objects
           end
@@ -57,9 +64,5 @@ module ActiveModel
       end
     end
 
-    private
-    def instrumentation_keys
-      [:object, :scope, :root, :meta_key, :meta, :each_serializer, :resource_name, :key_format]
-    end
   end
 end

data/lib/active_model/default_serializer.rb

@@ -15,18 +15,14 @@ module ActiveModel
     end
 
     def as_json(options={})
-      instrument('!serialize') do
+      instrument do
         return [] if @object.nil? && @wrap_in_array
         hash = @object.as_json
         @wrap_in_array ? [hash] : hash
       end
     end
+
     alias serializable_hash as_json
     alias serializable_object as_json
-
-    private
-    def instrumentation_keys
-      [:object, :wrap_in_array]
-    end
   end
 end

data/lib/active_model/serializable.rb

@@ -1,17 +1,29 @@
+require 'active_model/serializable/utils'
+
 module ActiveModel
   module Serializable
+    INSTRUMENTATION_KEY = '!serialize.active_model_serializers'.freeze
+
+    def self.included(base)
+      base.extend Utils
+    end
+
     def as_json(options={})
-      instrument('!serialize') do
+      instrument do
         if root = options.fetch(:root, json_key)
-          hash = { root => serializable_object }
+          hash = { root => serializable_object(options) }
           hash.merge!(serializable_data)
           hash
         else
-          serializable_object
+          serializable_object(options)
         end
       end
     end
 
+    def serializable_object_with_notification(options={})
+      instrument { serializable_object(options) }
+    end
+
     def serializable_data
       embedded_in_root_associations.tap do |hash|
         if respond_to?(:meta) && meta
@@ -20,21 +32,28 @@ module ActiveModel
       end
     end
 
+    def namespace
+      if module_name = get_namespace
+        Serializer.serializers_cache.fetch_or_store(module_name) do
+          Utils._const_get(module_name)
+        end
+      end
+    end
+
     def embedded_in_root_associations
       {}
     end
 
     private
-    def instrument(action, &block)
-      payload = instrumentation_keys.inject({ serializer: self.class.name }) do |payload, key|
-        payload[:payload] = self.instance_variable_get(:"@#{key}")
-        payload
-      end
-      ActiveSupport::Notifications.instrument("#{action}.active_model_serializers", payload, &block)
+
+    def get_namespace
+      modules = self.class.name.split('::')
+      modules[0..-2].join('::') if modules.size > 1
     end
 
-    def instrumentation_keys
-      [:object, :scope, :root, :meta_key, :meta, :wrap_in_array, :only, :except, :key_format]
+    def instrument(&block)
+      payload = { serializer: self.class.name }
+      ActiveSupport::Notifications.instrument(INSTRUMENTATION_KEY, payload, &block)
     end
   end
 end

data/lib/active_model/serializable/utils.rb

@@ -0,0 +1,16 @@
+module ActiveModel
+  module Serializable
+    module Utils
+      extend self
+
+      def _const_get(const)
+        begin
+          method = RUBY_VERSION >= '2.0' ? :const_get : :qualified_const_get
+          Object.send method, const
+        rescue NameError
+          const.safe_constantize
+        end
+      end
+    end
+  end
+end

data/lib/active_model/serializer.rb

@@ -1,9 +1,10 @@
 require 'active_model/array_serializer'
 require 'active_model/serializable'
-require 'active_model/serializer/associations'
+require 'active_model/serializer/association'
 require 'active_model/serializer/config'
 
 require 'thread'
+require 'concurrent/map'
 
 module ActiveModel
   class Serializer
@@ -55,32 +56,19 @@ end
       end
       attr_reader :key_format
 
-      if RUBY_VERSION >= '2.0'
-        def serializer_for(resource)
-          if resource.respond_to?(:to_ary)
-            if Object.constants.include?(:ArraySerializer)
-              ::ArraySerializer
-            else
-              ArraySerializer
-            end
+      def serializer_for(resource, options = {})
+        if resource.respond_to?(:serializer_class)
+          resource.serializer_class
+        elsif resource.respond_to?(:to_ary)
+          if Object.constants.include?(:ArraySerializer)
+            ::ArraySerializer
           else
-            begin
-              Object.const_get "#{resource.class.name}Serializer"
-            rescue NameError
-              nil
-            end
+            ArraySerializer
           end
-        end
-      else
-        def serializer_for(resource)
-          if resource.respond_to?(:to_ary)
-            if Object.constants.include?(:ArraySerializer)
-              ::ArraySerializer
-            else
-              ArraySerializer
-            end
-          else
-            "#{resource.class.name}Serializer".safe_constantize
+        else
+          klass_name = build_serializer_class(resource, options)
+          Serializer.serializers_cache.fetch_or_store(klass_name) do
+            _const_get(klass_name)
           end
         end
       end
@@ -90,14 +78,19 @@ end
       alias root= _root=
 
       def root_name
-        name.demodulize.underscore.sub(/_serializer$/, '') if name
+        if name
+          root_name = name.demodulize.underscore.sub(/_serializer$/, '')
+          CONFIG.plural_default_root ? root_name.pluralize : root_name
+        end
       end
 
       def attributes(*attrs)
-        @_attributes.concat attrs
-
         attrs.each do |attr|
-          define_method attr do
+          striped_attr = strip_attribute attr
+
+          @_attributes << striped_attr
+
+          define_method striped_attr do
             object.read_attribute_for_serialization attr
           end unless method_defined?(attr)
         end
@@ -111,8 +104,28 @@ end
         associate(Association::HasMany, *attrs)
       end
 
+      def serializers_cache
+        @serializers_cache ||= Concurrent::Map.new
+      end
+
       private
 
+      def strip_attribute(attr)
+        symbolized = attr.is_a?(Symbol)
+
+        attr = attr.to_s.gsub(/\?\Z/, '')
+        attr = attr.to_sym if symbolized
+        attr
+      end
+
+      def build_serializer_class(resource, options)
+        "".tap do |klass_name|
+          klass_name << "#{options[:namespace]}::" if options[:namespace]
+          klass_name << options[:prefix].to_s.classify if options[:prefix]
+          klass_name << "#{resource.class.name}Serializer"
+        end
+      end
+
       def associate(klass, *attrs)
         options = attrs.extract_options!
 
@@ -130,6 +143,7 @@ end
       @object        = object
       @scope         = options[:scope]
       @root          = options.fetch(:root, self.class._root)
+      @polymorphic   = options.fetch(:polymorphic, false)
       @meta_key      = options[:meta_key] || :meta
       @meta          = options[@meta_key]
       @wrap_in_array = options[:_wrap_in_array]
@@ -137,8 +151,9 @@ end
       @except        = options[:except] ? Array(options[:except]) : nil
       @key_format    = options[:key_format]
       @context       = options[:context]
+      @namespace     = options[:namespace]
     end
-    attr_accessor :object, :scope, :root, :meta_key, :meta, :key_format, :context
+    attr_accessor :object, :scope, :root, :meta_key, :meta, :key_format, :context, :polymorphic
 
     def json_key
       key = if root == true || root.nil?
@@ -156,7 +171,7 @@ end
       end
     end
 
-    def associations
+    def associations(options={})
       associations = self.class._associations
       included_associations = filter(associations.keys)
       associations.each_with_object({}) do |(name, association), hash|
@@ -173,7 +188,7 @@ end
             if association.embed_namespace?
               hash = hash[association.embed_namespace] ||= {}
             end
-            hash[association.embedded_key] = serialize association
+            hash[association.embedded_key] = serialize association, options
           end
         end
       end
@@ -194,12 +209,21 @@ end
       included_associations = filter(associations.keys)
       associations.each_with_object({}) do |(name, association), hash|
         if included_associations.include? name
+          association_serializer = build_serializer(association)
+          # we must do this always because even if the current association is not
+          # embedded in root, it might have its own associations that are embedded in root
+          hash.merge!(association_serializer.embedded_in_root_associations) do |key, oldval, newval|
+            if oldval.respond_to?(:to_ary)
+              [oldval, newval].flatten.uniq
+            else
+              oldval.merge(newval) { |_, oldval, newval| [oldval, newval].flatten.uniq }
+            end
+          end
+
           if association.embed_in_root?
             if association.embed_in_root_key?
               hash = hash[association.embed_in_root_key] ||= {}
             end
-            association_serializer = build_serializer(association)
-            hash.merge!(association_serializer.embedded_in_root_associations) {|key, oldval, newval| [newval, oldval].flatten }
 
             serialized_data = association_serializer.serializable_object
             key = association.root_key
@@ -215,19 +239,29 @@ end
 
     def build_serializer(association)
       object = send(association.name)
-      association.build_serializer(object, scope: scope)
+      association.build_serializer(object, association_options_for_serializer(association))
+    end
+
+    def association_options_for_serializer(association)
+      prefix    = association.options[:prefix]
+      namespace = association.options[:namespace] || @namespace || self.namespace
+
+      { scope: scope }.tap do |opts|
+        opts[:namespace] = namespace if namespace
+        opts[:prefix]    = prefix    if prefix
+      end
     end
 
-    def serialize(association)
-      build_serializer(association).serializable_object
+    def serialize(association,options={})
+      build_serializer(association).serializable_object(options)
     end
 
     def serialize_ids(association)
       associated_data = send(association.name)
       if associated_data.respond_to?(:to_ary)
-        associated_data.map { |elem| elem.read_attribute_for_serialization(association.embed_key) }
+        associated_data.map { |elem| serialize_id(elem, association) }
       else
-        associated_data.read_attribute_for_serialization(association.embed_key) if associated_data
+        serialize_id(associated_data, association) if associated_data
       end
     end
 
@@ -255,14 +289,30 @@ end
       end]
     end
 
+    attr_writer :serialization_options
+    def serialization_options
+      @serialization_options || {}
+    end
+
     def serializable_object(options={})
+      self.serialization_options = options
       return @wrap_in_array ? [] : nil if @object.nil?
       hash = attributes
-      hash.merge! associations
+      hash.merge! associations(options)
       hash = convert_keys(hash) if key_format.present?
+      hash = { :type => type_name(@object), type_name(@object) => hash } if @polymorphic
       @wrap_in_array ? [hash] : hash
     end
     alias_method :serializable_hash, :serializable_object
+
+    def serialize_id(elem, association)
+      id = elem.read_attribute_for_serialization(association.embed_key)
+      association.polymorphic? ? { id: id, type: type_name(elem) } : id
+    end
+
+    def type_name(elem)
+      elem.class.to_s.demodulize.underscore.to_sym
+    end
   end
 
 end

data/lib/active_model/serializer/{associations.rb → association.rb}

@@ -1,4 +1,6 @@
 require 'active_model/default_serializer'
+require 'active_model/serializer/association/has_one'
+require 'active_model/serializer/association/has_many'
 
 module ActiveModel
   class Serializer
@@ -13,6 +15,7 @@ module ActiveModel
         @name          = name.to_s
         @options       = options
         self.embed     = options.fetch(:embed) { CONFIG.embed }
+        @polymorphic   = options.fetch(:polymorphic, false)
         @embed_in_root = options.fetch(:embed_in_root) { options.fetch(:include) { CONFIG.embed_in_root } }
         @key_format    = options.fetch(:key_format) { CONFIG.key_format }
         @embed_key     = options[:embed_key] || :id
@@ -25,21 +28,22 @@ module ActiveModel
         @serializer_from_options = serializer.is_a?(String) ? serializer.constantize : serializer
       end
 
-      attr_reader :name, :embed_ids, :embed_objects
+      attr_reader :name, :embed_ids, :embed_objects, :polymorphic
       attr_accessor :embed_in_root, :embed_key, :key, :embedded_key, :root_key, :serializer_from_options, :options, :key_format, :embed_in_root_key, :embed_namespace
       alias embed_ids? embed_ids
       alias embed_objects? embed_objects
       alias embed_in_root? embed_in_root
       alias embed_in_root_key? embed_in_root_key
       alias embed_namespace? embed_namespace
+      alias polymorphic? polymorphic
 
       def embed=(embed)
         @embed_ids     = embed == :id || embed == :ids
         @embed_objects = embed == :object || embed == :objects
       end
 
-      def serializer_from_object(object)
-        Serializer.serializer_for(object)
+      def serializer_from_object(object, options = {})
+        Serializer.serializer_for(object, options)
       end
 
       def default_serializer
@@ -47,55 +51,7 @@ module ActiveModel
       end
 
       def build_serializer(object, options = {})
-        serializer_class(object).new(object, options.merge(self.options))
-      end
-
-      class HasOne < Association
-        def initialize(name, *args)
-          super
-          @root_key = @embedded_key.to_s.pluralize
-          @key ||= "#{name}_id"
-        end
-
-        def serializer_class(object)
-          serializer_from_options || serializer_from_object(object) || default_serializer
-        end
-
-        def build_serializer(object, options = {})
-          options[:_wrap_in_array] = embed_in_root?
-          super
-        end
-      end
-
-      class HasMany < Association
-        def initialize(name, *args)
-          super
-          @root_key = @embedded_key
-          @key ||= "#{name.to_s.singularize}_ids"
-        end
-
-        def serializer_class(object)
-          if use_array_serializer?
-            ArraySerializer
-          else
-            serializer_from_options
-          end
-        end
-
-        def options
-          if use_array_serializer?
-            { each_serializer: serializer_from_options }.merge! super
-          else
-            super
-          end
-        end
-
-        private
-
-        def use_array_serializer?
-          !serializer_from_options ||
-            serializer_from_options && !(serializer_from_options <= ArraySerializer)
-        end
+        serializer_class(object, options).new(object, options.merge(self.options))
       end
     end
   end