active_model_serializers 0.8.3 → 0.9.0

data/lib/action_controller/serialization.rb

@@ -1,3 +1,5 @@
+require 'active_support/core_ext/class/attribute'
+
 module ActionController
   # Action Controller Serialization
   #
@@ -27,34 +29,51 @@ module ActionController
 
     include ActionController::Renderers
 
+    class << self
+      attr_accessor :enabled
+    end
+    self.enabled = true
+
     included do
       class_attribute :_serialization_scope
       self._serialization_scope = :current_user
     end
 
-    def serialization_scope
-      send(_serialization_scope) if _serialization_scope &&
-        respond_to?(_serialization_scope, true)
+    module ClassMethods
+      def serialization_scope(scope)
+        self._serialization_scope = scope
+      end
     end
 
-    def default_serializer_options
+    def _render_option_json(resource, options)
+      serializer = build_json_serializer(resource, options)
+
+      if serializer
+        super(serializer, options)
+      else
+        super
+      end
     end
 
-    [:_render_option_json, :_render_with_renderer_json].each do |renderer_method|
-      define_method renderer_method do |resource, options|
-        json = ActiveModel::Serializer.build_json(self, resource, options)
+    private
 
-        if json
-          super(json, options)
-        else
-          super(resource, options)
-        end
-      end
+    def default_serializer_options
+      {}
     end
 
-    module ClassMethods
-      def serialization_scope(scope)
-        self._serialization_scope = scope
+    def serialization_scope
+      _serialization_scope = self.class._serialization_scope
+      send(_serialization_scope) if _serialization_scope && respond_to?(_serialization_scope, true)
+    end
+
+    def build_json_serializer(resource, options = {})
+      options = default_serializer_options.merge(options)
+
+      if serializer = options.fetch(:serializer, ActiveModel::Serializer.serializer_for(resource))
+        options[:scope] = serialization_scope unless options.has_key?(:scope)
+        options[:resource_name] = controller_name if resource.respond_to?(:to_ary)
+
+        serializer.new(resource, options)
       end
     end
   end

data/lib/action_controller/serialization_test_case.rb

@@ -0,0 +1,79 @@
+module ActionController
+  module SerializationAssertions
+    extend ActiveSupport::Concern
+
+    included do
+      setup :setup_subscriptions
+      teardown :teardown_subscriptions
+    end
+
+    def setup_subscriptions
+      @serializers = Hash.new(0)
+
+      ActiveSupport::Notifications.subscribe("!serialize.active_model_serializers") do |name, start, finish, id, payload|
+        serializer = payload[:serializer]
+        @serializers[serializer] += 1
+      end
+    end
+
+    def teardown_subscriptions
+      ActiveSupport::Notifications.unsubscribe("!serialize.active_model_serializers")
+    end
+
+    def process(*args)
+      @serializers = Hash.new(0)
+      super
+    end
+
+    # Asserts that the request was rendered with the appropriate serializers.
+    #
+    #  # assert that the "PostSerializer" serializer was rendered
+    #  assert_serializer "PostSerializer"
+    #
+    #  # assert that the instance of PostSerializer was rendered
+    #  assert_serializer PostSerializer
+    #
+    #  # assert that the "PostSerializer" serializer was rendered
+    #  assert_serializer :post_serializer
+    #
+    #  # assert that the rendered serializer starts with "Post"
+    #  assert_serializer %r{\APost.+\Z}
+    #
+    #  # assert that no serializer was rendered
+    #  assert_serializer nil
+    #
+    #
+    def assert_serializer(options = {}, message = nil)
+      # Force body to be read in case the template is being streamed.
+      response.body
+
+      rendered = @serializers
+      msg = message || "expecting <#{options.inspect}> but rendering with <#{rendered.keys}>"
+
+      matches_serializer = case options
+                           when lambda { |options| options.kind_of?(Class) && options < ActiveModel::Serializer }
+                             rendered.any? do |serializer, count|
+                               options.name == serializer
+                             end
+                           when Symbol
+                             options = options.to_s.camelize
+                             rendered.any? do |serializer, count|
+                               serializer == options
+                             end
+                           when String
+                             !options.empty? && rendered.any? do |serializer, count|
+                               serializer == options
+                             end
+                           when Regexp
+                             rendered.any? do |serializer, count|
+                               serializer.match(options)
+                             end
+                           when NilClass
+                             rendered.blank?
+                           else
+                             raise ArgumentError, "assert_serializer only accepts a String, Symbol, Regexp, ActiveModel::Serializer, or nil"
+                           end
+      assert matches_serializer, msg
+    end
+  end
+end

data/lib/active_model/array_serializer.rb

@@ -1,104 +1,65 @@
-require "active_support/core_ext/class/attribute"
-require 'active_support/dependencies'
-require 'active_support/descendants_tracker'
+require 'active_model/default_serializer'
+require 'active_model/serializable'
 
 module ActiveModel
-  # Active Model Array Serializer
-  #
-  # Serializes an Array, checking if each element implements
-  # the +active_model_serializer+ method.
-  #
-  # To disable serialization of root elements:
-  #
-  #     ActiveModel::ArraySerializer.root = false
-  #
   class ArraySerializer
-    extend ActiveSupport::DescendantsTracker
-
-    attr_reader :object, :options
-
-    class_attribute :root
-
-    class_attribute :cache
-    class_attribute :perform_caching
+    include Serializable
 
     class << self
-      # set perform caching like root
-      def cached(value = true)
-        self.perform_caching = value
-      end
+      attr_accessor :_root
+      alias root  _root=
+      alias root= _root=
     end
 
     def initialize(object, options={})
-      @object, @options = object, options
+      @object          = object
+      @scope           = options[:scope]
+      @root            = options.fetch(:root, self.class._root)
+      @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
+      @key_format      = options[:key_format] || options[:each_serializer].try(:key_format)
     end
+    attr_accessor :object, :scope, :root, :meta_key, :meta, :key_format
 
-    def meta_key
-      @options[:meta_key].try(:to_sym) || :meta
-    end
+    def json_key
+      key = root.nil? ? @resource_name : root
 
-    def include_meta(hash)
-      hash[meta_key] = @options[:meta] if @options.has_key?(:meta)
+      key_format == :lower_camel && key.present? ? key.camelize(:lower) : key
     end
 
-    def as_json(*args)
-      @options[:hash] = hash = {}
-      @options[:unique_values] = {}
-
-      if root = @options[:root]
-        hash.merge!(root => serializable_array)
-        include_meta hash
-        hash
-      else
-        serializable_array
-      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)
     end
 
-    def to_json(*args)
-      if perform_caching?
-        cache.fetch expand_cache_key([self.class.to_s.underscore, cache_key, 'to-json']) do
-          super
-        end
-      else
-        super
+    def serializable_object
+      @object.map do |item|
+        serializer_for(item).serializable_object
       end
     end
-
-    def serializable_array
-      if perform_caching?
-        cache.fetch expand_cache_key([self.class.to_s.underscore, cache_key, 'serializable-array']) do
-          _serializable_array
+    alias_method :serializable_array, :serializable_object
+
+    def embedded_in_root_associations
+      @object.each_with_object({}) do |item, hash|
+        serializer_for(item).embedded_in_root_associations.each_pair do |type, objects|
+          next if !objects || objects.flatten.empty?
+
+          if hash.has_key?(type)
+            hash[type].concat(objects).uniq!
+          else
+            hash[type] = objects
+          end
         end
-      else
-        _serializable_array
       end
     end
 
     private
-    def _serializable_array
-      @object.map do |item|
-        if @options.has_key? :each_serializer
-          serializer = @options[:each_serializer]
-        elsif item.respond_to?(:active_model_serializer)
-          serializer = item.active_model_serializer
-        end
-
-        serializable = serializer ? serializer.new(item, @options) : DefaultSerializer.new(item, @options.merge(:root => false))
-
-        if serializable.respond_to?(:serializable_hash)
-          serializable.serializable_hash
-        else
-          serializable.as_json
-        end
-      end
-    end
-
-    def expand_cache_key(*args)
-      ActiveSupport::Cache.expand_cache_key(args)
-    end
-
-    def perform_caching?
-      perform_caching && cache && respond_to?(:cache_key)
+    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

@@ -0,0 +1,32 @@
+require 'active_model/serializable'
+
+module ActiveModel
+  # DefaultSerializer
+  #
+  # Provides a constant interface for all items
+  class DefaultSerializer
+    include ActiveModel::Serializable
+
+    attr_reader :object
+
+    def initialize(object, options={})
+      @object = object
+      @wrap_in_array = options[:_wrap_in_array]
+    end
+
+    def as_json(options={})
+      instrument('!serialize') 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

@@ -0,0 +1,40 @@
+module ActiveModel
+  module Serializable
+    def as_json(options={})
+      instrument('!serialize') do
+        if root = options.fetch(:root, json_key)
+          hash = { root => serializable_object }
+          hash.merge!(serializable_data)
+          hash
+        else
+          serializable_object
+        end
+      end
+    end
+
+    def serializable_data
+      embedded_in_root_associations.tap do |hash|
+        if respond_to?(:meta) && meta
+          hash[meta_key] = meta
+        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)
+    end
+
+    def instrumentation_keys
+      [:object, :scope, :root, :meta_key, :meta, :wrap_in_array, :only, :except, :key_format]
+    end
+  end
+end

data/lib/active_model/serializer/associations.rb

@@ -1,231 +1,100 @@
+require 'active_model/default_serializer'
+
 module ActiveModel
   class Serializer
-    module Associations #:nodoc:
-      class Config #:nodoc:
-        class_attribute :options
-
-        def self.refine(name, class_options)
-          current_class = self
-
-          Class.new(self) do
-            singleton_class.class_eval do
-              define_method(:to_s) do
-                "(subclass of #{current_class.name})"
-              end
-
-              alias inspect to_s
-            end
-
-            self.options = class_options
-
-            # cache the root so we can reuse it without falling back on a per-instance basis
-            begin
-              self.options[:root] ||= self.new(name, nil).root
-            rescue
-              # this could fail if it needs a valid source, for example a polymorphic association
-            end
-
-          end
-        end
-
-        self.options = {}
-
-        def initialize(name, source, options={})
-          @name = name
-          @source = source
-          @options = options
-        end
-
-        def option(key, default=nil)
-          if @options.key?(key)
-            @options[key]
-          elsif self.class.options.key?(key)
-            self.class.options[key]
-          else
-            default
-          end
-        end
-
-        def target_serializer
-          serializer = option(:serializer)
-          serializer.is_a?(String) ? serializer.constantize : serializer
-        end
-
-        def source_serializer
-          @source
-        end
-
-        def key
-          option(:key) || @name
-        end
-
-        def root
-          option(:root) || @name
-        end
-
-        def name
-          option(:name) || @name
-        end
-
-        def associated_object
-          option(:value) || source_serializer.send(name)
-        end
-
-        def embed_ids?
-          [:id, :ids].include? option(:embed, source_serializer._embed)
-        end
-
-        def embed_objects?
-          [:object, :objects].include? option(:embed, source_serializer._embed)
-        end
-
-        def embed_in_root?
-          option(:include, source_serializer._root_embed)
-        end
-
-        def embeddable?
-          !associated_object.nil?
-        end
+    class Association
+      def initialize(name, options={})
+        if options.has_key?(:include)
+          ActiveSupport::Deprecation.warn <<-WARN
+** Notice: include was renamed to embed_in_root. **
+          WARN
+        end
+
+        @name          = name.to_s
+        @options       = options
+        self.embed     = options.fetch(:embed) { CONFIG.embed }
+        @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
+        @key           = options[:key]
+        @embedded_key  = options[:root] || name
+        @embed_in_root_key = options.fetch(:embed_in_root_key) { CONFIG.embed_in_root_key }
+        @embed_namespace = options.fetch(:embed_namespace) { CONFIG.embed_namespace }
+
+        serializer = @options[:serializer]
+        @serializer_from_options = serializer.is_a?(String) ? serializer.constantize : serializer
+      end
 
-      protected
+      attr_reader :name, :embed_ids, :embed_objects
+      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
+
+      def embed=(embed)
+        @embed_ids     = embed == :id || embed == :ids
+        @embed_objects = embed == :object || embed == :objects
+      end
 
-        def find_serializable(object)
-          if target_serializer
-            target_serializer.new(object, source_serializer.options)
-          elsif object.respond_to?(:active_model_serializer) && (ams = object.active_model_serializer)
-            ams.new(object, source_serializer.options)
-          else
-            object
-          end
-        end
+      def serializer_from_object(object)
+        Serializer.serializer_for(object)
       end
 
-      class HasMany < Config #:nodoc:
-        def key
-          if key = option(:key)
-            key
-          elsif embed_ids?
-            "#{@name.to_s.singularize}_ids".to_sym
-          else
-            @name
-          end
-        end
+      def default_serializer
+        DefaultSerializer
+      end
 
-        def embed_key
-          if key = option(:embed_key)
-            key
-          else
-            :id
-          end
-        end
+      def build_serializer(object, options = {})
+        serializer_class(object).new(object, options.merge(self.options))
+      end
 
-        def serialize
-          associated_object.map do |item|
-            find_serializable(item).serializable_hash
-          end
+      class HasOne < Association
+        def initialize(name, *args)
+          super
+          @root_key = @embedded_key.to_s.pluralize
+          @key ||= "#{name}_id"
         end
 
-        def serializables
-          associated_object.map do |item|
-            find_serializable(item)
-          end
+        def serializer_class(object)
+          serializer_from_options || serializer_from_object(object) || default_serializer
         end
 
-        def serialize_ids
-          ids_key = "#{@name.to_s.singularize}_ids".to_sym
-          if !option(:embed_key) && !source_serializer.respond_to?(@name.to_s) && source_serializer.object.respond_to?(ids_key)
-            source_serializer.object.read_attribute_for_serialization(ids_key)
-          else
-            associated_object.map do |item|
-              item.read_attribute_for_serialization(embed_key)
-            end
-          end
+        def build_serializer(object, options = {})
+          options[:_wrap_in_array] = embed_in_root?
+          super
         end
       end
 
-      class HasOne < Config #:nodoc:
-        def embeddable?
-          if polymorphic? && associated_object.nil?
-            false
-          else
-            true
-          end
+      class HasMany < Association
+        def initialize(name, *args)
+          super
+          @root_key = @embedded_key
+          @key ||= "#{name.to_s.singularize}_ids"
         end
 
-        def polymorphic?
-          option :polymorphic
-        end
-
-        def root
-          if root = option(:root)
-            root
-          elsif polymorphic?
-            associated_object.class.to_s.pluralize.demodulize.underscore.to_sym
+        def serializer_class(object)
+          if use_array_serializer?
+            ArraySerializer
           else
-            @name.to_s.pluralize.to_sym
+            serializer_from_options
           end
         end
 
-        def key
-          if key = option(:key)
-            key
-          elsif embed_ids? && !polymorphic?
-            "#{@name}_id".to_sym
+        def options
+          if use_array_serializer?
+            { each_serializer: serializer_from_options }.merge! super
           else
-            @name
+            super
           end
         end
 
-        def embed_key
-          if key = option(:embed_key)
-            key
-          else
-            :id
-          end
-        end
-
-        def polymorphic_key
-          associated_object.class.to_s.demodulize.underscore.to_sym
-        end
+        private
 
-        def serialize
-          object = associated_object
-
-          if object && polymorphic?
-            {
-              :type => polymorphic_key,
-              polymorphic_key => find_serializable(object).serializable_hash
-            }
-          elsif object
-            find_serializable(object).serializable_hash
-          end
-        end
-
-        def serializables
-          object = associated_object
-          value = object && find_serializable(object)
-          value ? [value] : []
-        end
-
-        def serialize_ids
-          id_key = "#{@name}_id".to_sym
-
-          if polymorphic?
-            if associated_object
-              {
-                :type => polymorphic_key,
-                :id => associated_object.read_attribute_for_serialization(embed_key)
-              }
-            else
-              nil
-            end
-          elsif !option(:embed_key) && !source_serializer.respond_to?(@name.to_s) && source_serializer.object.respond_to?(id_key)
-            source_serializer.object.read_attribute_for_serialization(id_key)
-          elsif associated_object
-            associated_object.read_attribute_for_serialization(embed_key)
-          else
-            nil
-          end
+        def use_array_serializer?
+          !serializer_from_options ||
+            serializer_from_options && !(serializer_from_options <= ArraySerializer)
         end
       end
     end