active_model_serializers 0.1.0 → 0.5.0

data/lib/active_model/serializers/version.rb

@@ -0,0 +1,5 @@
+module ActiveModel
+  class Serializer
+    VERSION = "0.5.0"
+  end
+end

data/lib/active_model_serializers.rb

@@ -3,6 +3,17 @@ require "active_support/core_ext/string/inflections"
 require "active_model"
 require "active_model/serializer"
 
+if defined?(Rails)
+  module ActiveModel
+    class Railtie < Rails::Railtie
+      generators do |app|
+        Rails::Generators.configure!(app.config.generators)
+        require "generators/resource_override"
+      end
+    end
+  end
+end
+
 module ActiveModel::SerializerSupport
   extend ActiveSupport::Concern
 

data/lib/generators/resource_override.rb

@@ -0,0 +1,13 @@
+require "rails/generators"
+require "rails/generators/rails/resource/resource_generator"
+
+module Rails
+  module Generators
+    ResourceGenerator.class_eval do
+      def add_serializer
+        invoke "serializer"
+      end
+    end
+  end
+end
+

data/lib/generators/serializer/serializer_generator.rb

@@ -30,7 +30,7 @@ module Rails
         # Only works on 3.2
         # elsif (n = Rails::Generators.namespace) && n.const_defined?(:ApplicationSerializer)
         #   "ApplicationSerializer"
-        elsif Object.const_defined?(:ApplicationSerializer)
+        elsif defined?(:ApplicationSerializer)
           "ApplicationSerializer"
         else
           "ActiveModel::Serializer"

data/test/association_test.rb

@@ -0,0 +1,392 @@
+require "test_helper"
+
+class AssociationTest < ActiveModel::TestCase
+  def def_serializer(&block)
+    Class.new(ActiveModel::Serializer, &block)
+  end
+
+  class Model
+    def initialize(hash={})
+      @attributes = hash
+    end
+
+    def read_attribute_for_serialization(name)
+      @attributes[name]
+    end
+
+    def as_json(*)
+      { :model => "Model" }
+    end
+
+    def method_missing(meth, *args)
+      if meth.to_s =~ /^(.*)=$/
+        @attributes[$1.to_sym] = args[0]
+      elsif @attributes.key?(meth)
+        @attributes[meth]
+      else
+        super
+      end
+    end
+  end
+
+  def setup
+    @post = Model.new(:title => "New Post", :body => "Body")
+    @comment = Model.new(:id => 1, :body => "ZOMG A COMMENT")
+    @post.comments = [ @comment ]
+    @post.comment = @comment
+
+    @comment_serializer_class = def_serializer do
+      attributes :id, :body
+    end
+
+    @post_serializer_class = def_serializer do
+      attributes :title, :body
+    end
+
+    @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)
+  end
+
+  def include_bare!(key, options={})
+    @post_serializer.include! key, {
+      :hash => @root_hash,
+      :node => @hash,
+      :serializer => @comment_serializer_class
+    }.merge(options)
+  end
+
+  class NoDefaults < AssociationTest
+    def test_include_bang_has_many_associations
+      include! :comments, :value => @post.comments
+
+      assert_equal({
+        :comments => [ 1 ]
+      }, @hash)
+
+      assert_equal({
+        :comments => [
+          { :id => 1, :body => "ZOMG A COMMENT" }
+        ]
+      }, @root_hash)
+    end
+
+    def test_include_bang_with_embed_false
+      include! :comments, :value => @post.comments, :embed => false
+
+      assert_equal({}, @hash)
+      assert_equal({}, @root_hash)
+    end
+
+    def test_include_bang_with_embed_ids_include_false
+      include! :comments, :value => @post.comments, :embed => :ids, :include => false
+
+      assert_equal({
+        :comments => [ 1 ]
+      }, @hash)
+
+      assert_equal({}, @root_hash)
+    end
+
+    def test_include_bang_has_one_associations
+      include! :comment, :value => @post.comment
+
+      assert_equal({
+        :comment => 1
+      }, @hash)
+
+      assert_equal({
+        :comments => [{ :id => 1, :body => "ZOMG A COMMENT" }]
+      }, @root_hash)
+    end
+  end
+
+  class DefaultsTest < AssociationTest
+    def test_with_default_has_many
+      @post_serializer_class.class_eval do
+        has_many :comments
+      end
+
+      include! :comments
+
+      assert_equal({
+        :comments => [ 1 ]
+      }, @hash)
+
+      assert_equal({
+        :comments => [
+          { :id => 1, :body => "ZOMG A COMMENT" }
+        ]
+      }, @root_hash)
+    end
+
+    def test_with_default_has_one
+      @post_serializer_class.class_eval do
+        has_one :comment
+      end
+
+      include! :comment
+
+      assert_equal({
+        :comment => 1
+      }, @hash)
+
+      assert_equal({
+        :comments => [
+          { :id => 1, :body => "ZOMG A COMMENT" }
+        ]
+      }, @root_hash)
+    end
+
+    def test_with_default_has_many_with_custom_key
+      @post_serializer_class.class_eval do
+        has_many :comments, :key => :custom_comments
+      end
+
+      include! :comments
+
+      assert_equal({
+        :custom_comments => [ 1 ]
+      }, @hash)
+
+      assert_equal({
+        :custom_comments => [
+          { :id => 1, :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
+      end
+
+      include! :comment
+
+      assert_equal({
+        :custom_comment => 1
+      }, @hash)
+
+      assert_equal({
+        :custom_comments => [
+          { :id => 1, :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
+      end
+
+      include! :comment
+
+      assert_equal({
+        :custom_comment => 1
+      }, @hash)
+
+      assert_equal({
+        :custom_comments => [
+          { :id => 1, :body => "ZOMG A COMMENT" }
+        ]
+      }, @root_hash)
+    end
+
+    def test_embed_objects_for_has_many_associations
+      @post_serializer_class.class_eval do
+        has_many :comments, :embed => :objects
+      end
+
+      include_bare! :comments
+
+      assert_equal({
+        :comments => [
+          { :id => 1, :body => "ZOMG A COMMENT" }
+        ]
+      }, @hash)
+
+      assert_equal({}, @root_hash)
+    end
+
+    def test_embed_ids_for_has_many_associations
+      @post_serializer_class.class_eval do
+        has_many :comments, :embed => :ids
+      end
+
+      include_bare! :comments
+
+      assert_equal({
+        :comments => [ 1 ]
+      }, @hash)
+
+      assert_equal({}, @root_hash)
+    end
+
+    def test_embed_false_for_has_many_associations
+      @post_serializer_class.class_eval do
+        has_many :comments, :embed => false
+      end
+
+      include_bare! :comments
+
+      assert_equal({}, @hash)
+      assert_equal({}, @root_hash)
+    end
+
+    def test_embed_ids_include_true_for_has_many_associations
+      @post_serializer_class.class_eval do
+        has_many :comments, :embed => :ids, :include => true
+      end
+
+      include_bare! :comments
+
+      assert_equal({
+        :comments => [ 1 ]
+      }, @hash)
+
+      assert_equal({
+        :comments => [
+          { :id => 1, :body => "ZOMG A COMMENT" }
+        ]
+      }, @root_hash)
+    end
+
+    def test_embed_ids_for_has_one_associations
+      @post_serializer_class.class_eval do
+        has_one :comment, :embed => :ids
+      end
+
+      include_bare! :comment
+
+      assert_equal({
+        :comment => 1
+      }, @hash)
+
+      assert_equal({}, @root_hash)
+    end
+
+    def test_embed_false_for_has_one_associations
+      @post_serializer_class.class_eval do
+        has_one :comment, :embed => false
+      end
+
+      include_bare! :comment
+
+      assert_equal({}, @hash)
+      assert_equal({}, @root_hash)
+    end
+
+    def test_embed_ids_include_true_for_has_one_associations
+      @post_serializer_class.class_eval do
+        has_one :comment, :embed => :ids, :include => true
+      end
+
+      include_bare! :comment
+
+      assert_equal({
+        :comment => 1
+      }, @hash)
+
+      assert_equal({
+        :comments => [
+          { :id => 1, :body => "ZOMG A COMMENT" }
+        ]
+      }, @root_hash)
+    end
+  end
+
+  class InclusionTest < AssociationTest
+    def setup
+      super
+
+      comment_serializer_class = @comment_serializer_class
+
+      @post_serializer_class.class_eval do
+        root :post
+        embed :ids, :include => true
+        has_many :comments, :serializer => comment_serializer_class
+      end
+    end
+
+    def test_when_it_is_included
+      post_serializer = @post_serializer_class.new(
+        @post, :include => [:comments]
+      )
+
+      json = post_serializer.as_json
+
+      assert_equal({
+        :post => {
+          :title => "New Post",
+          :body => "Body",
+          :comments => [ 1 ]
+        },
+        :comments => [
+          { :id => 1, :body => "ZOMG A COMMENT" }
+        ]
+      }, json)
+    end
+
+    def test_when_it_is_not_included
+      post_serializer = @post_serializer_class.new(
+        @post, :include => []
+      )
+
+      json = post_serializer.as_json
+
+      assert_equal({
+        :post => {
+          :title => "New Post",
+          :body => "Body",
+          :comments => [ 1 ]
+        }
+      }, json)
+    end
+
+    def test_when_it_is_excluded
+      post_serializer = @post_serializer_class.new(
+        @post, :exclude => [:comments]
+      )
+
+      json = post_serializer.as_json
+
+      assert_equal({
+        :post => {
+          :title => "New Post",
+          :body => "Body",
+          :comments => [ 1 ]
+        }
+      }, json)
+    end
+
+    def test_when_it_is_not_excluded
+      post_serializer = @post_serializer_class.new(
+        @post, :exclude => []
+      )
+
+      json = post_serializer.as_json
+
+      assert_equal({
+        :post => {
+          :title => "New Post",
+          :body => "Body",
+          :comments => [ 1 ]
+        },
+        :comments => [
+          { :id => 1, :body => "ZOMG A COMMENT" }
+        ]
+      }, json)
+    end
+  end
+end

data/test/generators_test.rb

@@ -16,12 +16,12 @@ class SerializerGeneratorTest < Rails::Generators::TestCase
 
   def test_generates_a_serializer
     run_generator
-    assert_file "app/serializers/account_serializer.rb", /class AccountSerializer < ActiveModel::Serializer/
+    assert_file "app/serializers/account_serializer.rb", /class AccountSerializer < ApplicationSerializer/
   end
 
   def test_generates_a_namespaced_serializer
     run_generator ["admin/account"]
-    assert_file "app/serializers/admin/account_serializer.rb", /class Admin::AccountSerializer < ActiveModel::Serializer/
+    assert_file "app/serializers/admin/account_serializer.rb", /class Admin::AccountSerializer < ApplicationSerializer/
   end
 
   def test_uses_application_serializer_if_one_exists
@@ -62,6 +62,6 @@ class SerializerGeneratorTest < Rails::Generators::TestCase
 
   def test_with_no_attributes_does_not_add_extra_space
     run_generator ["account"]
-    assert_file "app/serializers/account_serializer.rb", /class AccountSerializer < ActiveModel::Serializer\nend/
+    assert_file "app/serializers/account_serializer.rb", /class AccountSerializer < ApplicationSerializer\nend/
   end
 end