active_model_serializers 0.6.0 → 0.7.0

data/lib/active_model/serializer/associations.rb

@@ -0,0 +1,226 @@
+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
+          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?
+          option(:embed, source_serializer._embed) == :ids
+        end
+
+        def embed_objects?
+          option(:embed, source_serializer._embed) == :objects
+        end
+
+        def embed_in_root?
+          option(:include, source_serializer._root_embed)
+        end
+
+        def embeddable?
+          !associated_object.nil?
+        end
+
+      protected
+
+        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
+      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 embed_key
+          if key = option(:embed_key)
+            key
+          else
+            :id
+          end
+        end
+
+        def serialize
+          associated_object.map do |item|
+            find_serializable(item).serializable_hash
+          end
+        end
+
+        def serializables
+          associated_object.map do |item|
+            find_serializable(item)
+          end
+        end
+
+        def serialize_ids
+          # Use pluck or select_columns if available
+          # return collection.ids if collection.respond_to?(:ids)
+          ids_key = "#{key.to_s.singularize}_ids"
+
+          if !option(:include) && !option(:embed_key) && source_serializer.object.respond_to?(ids_key)
+            source_serializer.object.send(ids_key)
+          else
+            associated_object.map do |item|
+              item.read_attribute_for_serialization(embed_key)
+            end
+          end
+        end
+      end
+
+      class HasOne < Config #:nodoc:
+        def embeddable?
+          if polymorphic? && associated_object.nil?
+            false
+          else
+            true
+          end
+        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
+          else
+            @name.to_s.pluralize.to_sym
+          end
+        end
+
+        def key
+          if key = option(:key)
+            key
+          elsif embed_ids? && !polymorphic?
+            "#{@name}_id".to_sym
+          else
+            @name
+          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
+
+        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
+          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.object.respond_to?("#{name}_id")
+            source_serializer.object.send("#{name}_id")
+          elsif associated_object
+            associated_object.read_attribute_for_serialization(embed_key)
+          else
+            nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_model/serializers/version.rb

@@ -1,5 +1,5 @@
 module ActiveModel
   class Serializer
-    VERSION = "0.6.0"
+    VERSION = "0.7.0"
   end
 end

data/lib/active_model_serializers.rb

@@ -2,9 +2,9 @@ require "active_support"
 require "active_support/core_ext/string/inflections"
 require "active_support/notifications"
 require "active_model"
-require "active_model/ordered_set"
 require "active_model/array_serializer"
 require "active_model/serializer"
+require "active_model/serializer/associations"
 require "set"
 
 if defined?(Rails)
@@ -33,14 +33,12 @@ module ActiveModel::SerializerSupport
   module ClassMethods #:nodoc:
     if "".respond_to?(:safe_constantize)
       def active_model_serializer
-        @active_model_serializer ||= "#{self.name}Serializer".safe_constantize
+        "#{self.name}Serializer".safe_constantize
       end
     else
       def active_model_serializer
-        return @active_model_serializer if defined?(@active_model_serializer)
-
         begin
-          @active_model_serializer = "#{self.name}Serializer".constantize
+          "#{self.name}Serializer".constantize
         rescue NameError => e
           raise unless e.message =~ /uninitialized constant/
         end

data/test/array_serializer_test.rb

@@ -0,0 +1,55 @@
+require "test_helper"
+require "test_fakes"
+
+class ArraySerializerTest < ActiveModel::TestCase
+  # serialize different typed objects
+  def test_array_serializer
+    model    = Model.new
+    user     = User.new
+    comments = Comment.new(:title => "Comment1", :id => 1)
+
+    array = [model, user, comments]
+    serializer = array.active_model_serializer.new(array, :scope => {:scope => true})
+    assert_equal([
+      { :model => "Model" },
+      { :last_name => "Valim", :ok => true, :first_name => "Jose", :scope => true },
+      { :title => "Comment1" }
+    ], serializer.as_json)
+  end
+
+  def test_array_serializer_with_root
+    comment1 = Comment.new(:title => "Comment1", :id => 1)
+    comment2 = Comment.new(:title => "Comment2", :id => 2)
+
+    array = [ comment1, comment2 ]
+
+    serializer = array.active_model_serializer.new(array, :root => :comments)
+
+    assert_equal({ :comments => [
+      { :title => "Comment1" },
+      { :title => "Comment2" }
+    ]}, serializer.as_json)
+  end
+
+  def test_array_serializer_with_hash
+    hash = {:value => "something"}
+    array = [hash]
+    serializer = array.active_model_serializer.new(array, :root => :items)
+    assert_equal({ :items => [ hash.as_json ]}, serializer.as_json)
+  end
+
+  def test_array_serializer_with_specified_seriailizer
+    post1 = Post.new(:title => "Post1", :author => "Author1", :id => 1)
+    post2 = Post.new(:title => "Post2", :author => "Author2", :id => 2)
+
+    array = [ post1, post2 ]
+
+    serializer = array.active_model_serializer.new array, :each_serializer => CustomPostSerializer
+
+    assert_equal([
+      { :title => "Post1" },
+      { :title => "Post2" }
+    ], serializer.as_json)
+  end
+
+end

data/test/association_test.rb

@@ -30,30 +30,29 @@ class AssociationTest < ActiveModel::TestCase
   end
 
   def setup
+    @hash = {}
+    @root_hash = {}
+
     @post = Model.new(:title => "New Post", :body => "Body")
-    @comment = Model.new(:id => 1, :body => "ZOMG A COMMENT")
+    @comment = Model.new(:id => 1, :external_id => "COMM001", :body => "ZOMG A COMMENT")
     @post.comments = [ @comment ]
     @post.comment = @comment
 
     @comment_serializer_class = def_serializer do
-      attributes :id, :body
+      attributes :id, :external_id, :body
     end
 
     @post_serializer_class = def_serializer do
       attributes :title, :body
     end
 
-    @post_serializer = @post_serializer_class.new(@post)
-
-    @hash = {}
-    @root_hash = {}
+    @post_serializer = @post_serializer_class.new(@post, :hash => @root_hash)
   end
 
   def include!(key, options={})
     @post_serializer.include! key, {
       :embed => :ids,
       :include => true,
-      :hash => @root_hash,
       :node => @hash,
       :serializer => @comment_serializer_class
     }.merge(options)
@@ -61,7 +60,6 @@ class AssociationTest < ActiveModel::TestCase
 
   def include_bare!(key, options={})
     @post_serializer.include! key, {
-      :hash => @root_hash,
       :node => @hash,
       :serializer => @comment_serializer_class
     }.merge(options)
@@ -72,12 +70,12 @@ class AssociationTest < ActiveModel::TestCase
       include! :comments, :value => @post.comments
 
       assert_equal({
-        :comments => [ 1 ]
+        :comment_ids => [ 1 ]
       }, @hash)
 
       assert_equal({
         :comments => [
-          { :id => 1, :body => "ZOMG A COMMENT" }
+          { :id => 1, :external_id => "COMM001", :body => "ZOMG A COMMENT" }
         ]
       }, @root_hash)
     end
@@ -93,7 +91,7 @@ class AssociationTest < ActiveModel::TestCase
       include! :comments, :value => @post.comments, :embed => :ids, :include => false
 
       assert_equal({
-        :comments => [ 1 ]
+        :comment_ids => [ 1 ]
       }, @hash)
 
       assert_equal({}, @root_hash)
@@ -103,11 +101,11 @@ class AssociationTest < ActiveModel::TestCase
       include! :comment, :value => @post.comment
 
       assert_equal({
-        :comment => 1
+        :comment_id => 1
       }, @hash)
 
       assert_equal({
-        :comments => [{ :id => 1, :body => "ZOMG A COMMENT" }]
+        :comments => [{ :id => 1, :external_id => "COMM001", :body => "ZOMG A COMMENT" }]
       }, @root_hash)
     end
   end
@@ -121,12 +119,12 @@ class AssociationTest < ActiveModel::TestCase
       include! :comments
 
       assert_equal({
-        :comments => [ 1 ]
+        :comment_ids => [ 1 ]
       }, @hash)
 
       assert_equal({
         :comments => [
-          { :id => 1, :body => "ZOMG A COMMENT" }
+          { :id => 1, :external_id => "COMM001", :body => "ZOMG A COMMENT" }
         ]
       }, @root_hash)
     end
@@ -139,12 +137,12 @@ class AssociationTest < ActiveModel::TestCase
       include! :comment
 
       assert_equal({
-        :comment => 1
+        :comment_id => 1
       }, @hash)
 
       assert_equal({
         :comments => [
-          { :id => 1, :body => "ZOMG A COMMENT" }
+          { :id => 1, :external_id => "COMM001", :body => "ZOMG A COMMENT" }
         ]
       }, @root_hash)
     end
@@ -161,26 +159,98 @@ class AssociationTest < ActiveModel::TestCase
       }, @hash)
 
       assert_equal({
-        :custom_comments => [
-          { :id => 1, :body => "ZOMG A COMMENT" }
+        :comments => [
+          { :id => 1, :external_id => "COMM001", :body => "ZOMG A COMMENT" }
         ]
       }, @root_hash)
     end
 
     def test_with_default_has_one_with_custom_key
       @post_serializer_class.class_eval do
-        has_one :comment, :key => :custom_comment
+        has_one :comment, :key => :custom_comment_id
       end
 
       include! :comment
 
       assert_equal({
-        :custom_comment => 1
+        :custom_comment_id => 1
       }, @hash)
 
       assert_equal({
-        :custom_comments => [
-          { :id => 1, :body => "ZOMG A COMMENT" }
+        :comments => [
+          { :id => 1, :external_id => "COMM001", :body => "ZOMG A COMMENT" }
+        ]
+      }, @root_hash)
+    end
+
+    def test_with_default_has_many_with_custom_embed_key
+      @post_serializer_class.class_eval do
+        has_many :comments, :embed_key => :external_id
+      end
+
+      include! :comments
+
+      assert_equal({
+        :comment_ids => [ "COMM001" ]
+      }, @hash)
+
+      assert_equal({
+        :comments => [
+          { :id => 1, :external_id => "COMM001", :body => "ZOMG A COMMENT" }
+        ]
+      }, @root_hash)
+    end
+
+    def test_with_default_has_one_with_custom_embed_key
+      @post_serializer_class.class_eval do
+        has_one :comment, :embed_key => :external_id
+      end
+
+      include! :comment
+
+      assert_equal({
+        :comment_id => "COMM001"
+      }, @hash)
+
+      assert_equal({
+        :comments => [
+          { :id => 1, :external_id => "COMM001", :body => "ZOMG A COMMENT" }
+        ]
+      }, @root_hash)
+    end
+
+    def test_with_default_has_many_with_custom_key_and_custom_embed_key
+      @post_serializer_class.class_eval do
+        has_many :comments, :key => :custom_comments, :embed_key => :external_id
+      end
+
+      include! :comments
+
+      assert_equal({
+        :custom_comments => [ "COMM001" ]
+      }, @hash)
+
+      assert_equal({
+        :comments => [
+          { :id => 1, :external_id => "COMM001", :body => "ZOMG A COMMENT" }
+        ]
+      }, @root_hash)
+    end
+
+    def test_with_default_has_one_with_custom_key_and_custom_embed_key
+      @post_serializer_class.class_eval do
+        has_one :comment, :key => :custom_comment, :embed_key => :external_id
+      end
+
+      include! :comment
+
+      assert_equal({
+        :custom_comment => "COMM001"
+      }, @hash)
+
+      assert_equal({
+        :comments => [
+          { :id => 1, :external_id => "COMM001", :body => "ZOMG A COMMENT" }
         ]
       }, @root_hash)
     end
@@ -194,7 +264,7 @@ class AssociationTest < ActiveModel::TestCase
 
       assert_equal({
         :comments => [
-          { :id => 1, :body => "ZOMG A COMMENT" }
+          { :id => 1, :external_id => "COMM001", :body => "ZOMG A COMMENT" }
         ]
       }, @hash)
 
@@ -209,7 +279,7 @@ class AssociationTest < ActiveModel::TestCase
       include_bare! :comments
 
       assert_equal({
-        :comments => [ 1 ]
+        :comment_ids => [ 1 ]
       }, @hash)
 
       assert_equal({}, @root_hash)
@@ -234,12 +304,12 @@ class AssociationTest < ActiveModel::TestCase
       include_bare! :comments
 
       assert_equal({
-        :comments => [ 1 ]
+        :comment_ids => [ 1 ]
       }, @hash)
 
       assert_equal({
         :comments => [
-          { :id => 1, :body => "ZOMG A COMMENT" }
+          { :id => 1, :external_id => "COMM001", :body => "ZOMG A COMMENT" }
         ]
       }, @root_hash)
     end
@@ -252,7 +322,7 @@ class AssociationTest < ActiveModel::TestCase
       include_bare! :comment
 
       assert_equal({
-        :comment => 1
+        :comment_id => 1
       }, @hash)
 
       assert_equal({}, @root_hash)
@@ -277,15 +347,38 @@ class AssociationTest < ActiveModel::TestCase
       include_bare! :comment
 
       assert_equal({
-        :comment => 1
+        :comment_id => 1
       }, @hash)
 
       assert_equal({
         :comments => [
-          { :id => 1, :body => "ZOMG A COMMENT" }
+          { :id => 1, :external_id => "COMM001", :body => "ZOMG A COMMENT" }
         ]
       }, @root_hash)
     end
+
+    def test_embed_ids_include_true_does_not_serialize_multiple_times
+      @post.recent_comment = @comment
+
+      @post_serializer_class.class_eval do
+        has_one :comment, :embed => :ids, :include => true
+        has_one :recent_comment, :embed => :ids, :include => true, :root => :comments
+      end
+
+      # Count how often the @comment record is serialized.
+      serialized_times = 0
+      @comment.class_eval do
+        define_method :read_attribute_for_serialization, lambda { |name|
+          serialized_times += 1 if name == :body
+          super(name)
+        }
+      end
+
+      include_bare! :comment
+      include_bare! :recent_comment
+
+      assert_equal 1, serialized_times
+    end
   end
 
   class InclusionTest < AssociationTest
@@ -312,10 +405,10 @@ class AssociationTest < ActiveModel::TestCase
         :post => {
           :title => "New Post",
           :body => "Body",
-          :comments => [ 1 ]
+          :comment_ids => [ 1 ]
         },
         :comments => [
-          { :id => 1, :body => "ZOMG A COMMENT" }
+          { :id => 1, :external_id => "COMM001", :body => "ZOMG A COMMENT" }
         ]
       }, json)
     end
@@ -331,7 +424,7 @@ class AssociationTest < ActiveModel::TestCase
         :post => {
           :title => "New Post",
           :body => "Body",
-          :comments => [ 1 ]
+          :comment_ids => [ 1 ]
         }
       }, json)
     end
@@ -347,7 +440,7 @@ class AssociationTest < ActiveModel::TestCase
         :post => {
           :title => "New Post",
           :body => "Body",
-          :comments => [ 1 ]
+          :comment_ids => [ 1 ]
         }
       }, json)
     end
@@ -363,12 +456,34 @@ class AssociationTest < ActiveModel::TestCase
         :post => {
           :title => "New Post",
           :body => "Body",
-          :comments => [ 1 ]
+          :comment_ids => [ 1 ]
         },
         :comments => [
-          { :id => 1, :body => "ZOMG A COMMENT" }
+          { :id => 1, :external_id => "COMM001", :body => "ZOMG A COMMENT" }
         ]
       }, json)
     end
   end
+
+  class StringSerializerOption < AssociationTest
+    class StringSerializer < ActiveModel::Serializer
+      attributes :id, :body
+    end
+
+    def test_specifying_serializer_class_as_string
+      @post_serializer_class.class_eval do
+        has_many :comments, :embed => :objects
+      end
+
+      include_bare! :comments, :serializer => "AssociationTest::StringSerializerOption::StringSerializer"
+
+      assert_equal({
+        :comments => [
+          { :id => 1, :body => "ZOMG A COMMENT" }
+        ]
+      }, @hash)
+
+      assert_equal({}, @root_hash)
+    end
+  end
 end