cm-active_model_serializers 0.10.0.rc1.1

data/lib/generators/serializer/USAGE

@@ -0,0 +1,6 @@
+Description:
+    Generates a serializer for the given resource with tests.
+
+Example:
+    `rails generate serializer Account name created_at`
+

data/lib/generators/serializer/serializer_generator.rb

@@ -0,0 +1,37 @@
+module Rails
+  module Generators
+    class SerializerGenerator < NamedBase
+      source_root File.expand_path("../templates", __FILE__)
+      check_class_collision :suffix => "Serializer"
+
+      argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
+
+      class_option :parent, :type => :string, :desc => "The parent class for the generated serializer"
+
+      def create_serializer_file
+        template 'serializer.rb', File.join('app/serializers', class_path, "#{file_name}_serializer.rb")
+      end
+
+      private
+
+      def attributes_names
+        [:id] + attributes.select { |attr| !attr.reference? }.map { |a| a.name.to_sym }
+      end
+
+      def association_names
+        attributes.select { |attr| attr.reference? }.map { |a| a.name.to_sym }
+      end
+
+      def parent_class_name
+        if options[:parent]
+          options[:parent]
+        elsif defined?(::ApplicationSerializer)
+          "ApplicationSerializer"
+        else
+          "ActiveModel::Serializer"
+        end
+      end
+    end
+  end
+end
+

data/lib/generators/serializer/templates/serializer.rb

@@ -0,0 +1,8 @@
+<% module_namespacing do -%>
+class <%= class_name %>Serializer < <%= parent_class_name %>
+  attributes <%= attributes_names.map(&:inspect).join(", ") %>
+end
+<% association_names.each do |attribute| -%>
+  attribute :<%= attribute %>
+<% end -%>
+<% end -%>

data/test/action_controller/adapter_selector_test.rb

@@ -0,0 +1,51 @@
+require 'test_helper'
+
+module ActionController
+  module Serialization
+    class AdapterSelectorTest < ActionController::TestCase
+      class MyController < ActionController::Base
+        def render_using_default_adapter
+          @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+          render json: @profile
+        end
+
+        def render_using_adapter_override
+          @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+          render json: @profile, adapter: :json_api
+        end
+
+        def render_skipping_adapter
+          @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+          render json: @profile, adapter: false
+        end
+      end
+
+      tests MyController
+
+      def test_render_using_default_adapter
+        get :render_using_default_adapter
+        assert_equal '{"name":"Name 1","description":"Description 1"}', response.body
+      end
+
+      def test_render_using_adapter_override
+        get :render_using_adapter_override
+
+        expected = {
+          data: {
+            name: "Name 1",
+            description: "Description 1",
+            id: assigns(:profile).id.to_s,
+            type: "profiles"
+          }
+        }
+
+        assert_equal expected.to_json, response.body
+      end
+
+      def test_render_skipping_adapter
+        get :render_skipping_adapter
+        assert_equal '{"attributes":{"name":"Name 1","description":"Description 1","comments":"Comments 1"}}', response.body
+      end
+    end
+  end
+end

data/test/action_controller/explicit_serializer_test.rb

@@ -0,0 +1,110 @@
+require 'test_helper'
+
+module ActionController
+  module Serialization
+    class ExplicitSerializerTest < ActionController::TestCase
+      class MyController < ActionController::Base
+        def render_using_explicit_serializer
+          @profile = Profile.new(name: 'Name 1',
+                                 description: 'Description 1',
+                                 comments: 'Comments 1')
+          render json: @profile, serializer: ProfilePreviewSerializer
+        end
+
+        def render_array_using_explicit_serializer
+          array = [
+            Profile.new(name: 'Name 1',
+                        description: 'Description 1',
+                        comments: 'Comments 1'),
+            Profile.new(name: 'Name 2',
+                        description: 'Description 2',
+                        comments: 'Comments 2')
+          ]
+          render json: array,
+                 serializer: PaginatedSerializer,
+                 each_serializer: ProfilePreviewSerializer
+        end
+
+        def render_array_using_implicit_serializer
+          array = [
+            Profile.new(name: 'Name 1',
+                        description: 'Description 1',
+                        comments: 'Comments 1'),
+            Profile.new(name: 'Name 2',
+                        description: 'Description 2',
+                        comments: 'Comments 2')
+          ]
+          render json: array,
+                 each_serializer: ProfilePreviewSerializer
+        end
+
+        def render_array_using_explicit_serializer_and_custom_serializers
+          @post = Post.new(title: 'New Post', body: 'Body')
+          @author = Author.new(name: 'Jane Blogger')
+          @author.posts = [@post]
+          @post.author = @author
+          @first_comment = Comment.new(id: 1, body: 'ZOMG A COMMENT')
+          @second_comment = Comment.new(id: 2, body: 'ZOMG ANOTHER COMMENT')
+          @post.comments = [@first_comment, @second_comment]
+          @first_comment.post = @post
+          @first_comment.author = nil
+          @second_comment.post = @post
+          @second_comment.author = nil
+          @blog = Blog.new(id: 23, name: 'AMS Blog')
+          @post.blog = @blog
+
+          render json: [@post], each_serializer: PostPreviewSerializer
+        end
+      end
+
+      tests MyController
+
+      def test_render_using_explicit_serializer
+        get :render_using_explicit_serializer
+
+        assert_equal 'application/json', @response.content_type
+        assert_equal '{"name":"Name 1"}', @response.body
+      end
+
+      def test_render_array_using_explicit_serializer
+        get :render_array_using_explicit_serializer
+        assert_equal 'application/json', @response.content_type
+
+        expected = {
+          'paginated' => [
+            { 'name' => 'Name 1' },
+            { 'name' => 'Name 2' }
+          ]
+        }
+
+        assert_equal expected.to_json, @response.body
+      end
+
+      def test_render_array_using_implicit_serializer
+        get :render_array_using_implicit_serializer
+        assert_equal 'application/json', @response.content_type
+
+        expected = [
+          { 'name' => 'Name 1' },
+          { 'name' => 'Name 2' }
+        ]
+        assert_equal expected.to_json, @response.body
+      end
+
+      def test_render_array_using_explicit_serializer_and_custom_serializers
+        get :render_array_using_explicit_serializer_and_custom_serializers
+
+        expected = [
+          { "title" => "New Post",
+            "body" => "Body",
+            "id" => assigns(:post).id,
+            "comments" => [{"id" => 1}, {"id" => 2}],
+            "author" => { "id" => assigns(:author).id }
+          }
+        ]
+
+        assert_equal expected.to_json, @response.body
+      end
+    end
+  end
+end

data/test/action_controller/json_api_linked_test.rb

@@ -0,0 +1,173 @@
+require 'test_helper'
+
+module ActionController
+  module Serialization
+    class JsonApiLinkedTest < ActionController::TestCase
+      class MyController < ActionController::Base
+        def setup_post
+          ActionController::Base.cache_store.clear
+          @role1 = Role.new(id: 1, name: 'admin')
+          @role2 = Role.new(id: 2, name: 'colab')
+          @author = Author.new(id: 1, name: 'Steve K.')
+          @author.posts = []
+          @author.bio = nil
+          @author.roles = [@role1, @role2]
+          @role1.author = @author
+          @role2.author = @author
+          @author2 = Author.new(id: 2, name: 'Anonymous')
+          @author2.posts = []
+          @author2.bio = nil
+          @author2.roles = []
+          @post = Post.new(id: 1, title: 'New Post', body: 'Body')
+          @first_comment = Comment.new(id: 1, body: 'ZOMG A COMMENT')
+          @second_comment = Comment.new(id: 2, body: 'ZOMG ANOTHER COMMENT')
+          @post.comments = [@first_comment, @second_comment]
+          @post.author = @author
+          @first_comment.post = @post
+          @first_comment.author = @author2
+          @second_comment.post = @post
+          @second_comment.author = nil
+          @post2 = Post.new(id: 2, title: "Another Post", body: "Body")
+          @post2.author = @author
+          @post2.comments = []
+          @blog = Blog.new(id: 1, name: "My Blog!!")
+          @post.blog = @blog
+          @post2.blog = @blog
+        end
+
+        def render_resource_without_include
+          setup_post
+          render json: @post, adapter: :json_api
+        end
+
+        def render_resource_with_include
+          setup_post
+          render json: @post, include: 'author', adapter: :json_api
+        end
+
+        def render_resource_with_nested_include
+          setup_post
+          render json: @post, include: 'comments.author', adapter: :json_api
+        end
+
+        def render_resource_with_nested_has_many_include
+          setup_post
+          render json: @post, include: ['author', 'author.roles'], adapter: :json_api
+        end
+
+        def render_resource_with_missing_nested_has_many_include
+          setup_post
+          @post.author = @author2 # author2 has no roles.
+          render json: @post, include: 'author,author.roles', adapter: :json_api
+        end
+
+        def render_collection_with_missing_nested_has_many_include
+          setup_post
+          @post.author = @author2
+          render json: [@post, @post2], include: 'author,author.roles', adapter: :json_api
+        end
+
+        def render_collection_without_include
+          setup_post
+          render json: [@post], adapter: :json_api
+        end
+
+        def render_collection_with_include
+          setup_post
+          render json: [@post], include: ['author', 'comments'], adapter: :json_api
+        end
+      end
+
+      tests MyController
+
+      def test_render_resource_without_include
+        get :render_resource_without_include
+        response = JSON.parse(@response.body)
+        refute response.key? 'included'
+      end
+
+      def test_render_resource_with_include
+        get :render_resource_with_include
+        response = JSON.parse(@response.body)
+        assert response.key? 'included'
+        assert_equal 1, response['included'].size
+        assert_equal 'Steve K.', response['included'].first['name']
+      end
+
+      def test_render_resource_with_nested_has_many_include
+        get :render_resource_with_nested_has_many_include
+        response = JSON.parse(@response.body)
+        expected_linked = [
+          {
+            "id" => "1",
+            "type" => "authors",
+            "name" => "Steve K.",
+            "links" => {
+              "posts" => { "linkage" => [] },
+              "roles" => { "linkage" => [{ "type" =>"roles", "id" => "1" }, { "type" =>"roles", "id" => "2" }] },
+              "bio" => { "linkage" => nil }
+            }
+          }, {
+            "id" => "1",
+            "type" => "roles",
+            "name" => "admin",
+            "description" => nil,
+            "slug" => "admin-1",
+            "links" => {
+              "author" => { "linkage" => { "type" =>"authors", "id" => "1" } }
+            }
+          }, {
+            "id" => "2",
+            "type" => "roles",
+            "name" => "colab",
+            "description" => nil,
+            "slug" => "colab-2",
+            "links" => {
+              "author" => { "linkage" => { "type" =>"authors", "id" => "1" } }
+            }
+          }
+        ]
+        assert_equal expected_linked, response['included']
+      end
+
+      def test_render_resource_with_nested_include
+        get :render_resource_with_nested_include
+        response = JSON.parse(@response.body)
+        assert response.key? 'included'
+        assert_equal 1, response['included'].size
+        assert_equal 'Anonymous', response['included'].first['name']
+      end
+
+      def test_render_collection_without_include
+        get :render_collection_without_include
+        response = JSON.parse(@response.body)
+        refute response.key? 'included'
+      end
+
+      def test_render_collection_with_include
+        get :render_collection_with_include
+        response = JSON.parse(@response.body)
+        assert response.key? 'included'
+      end
+
+      def test_render_resource_with_nested_attributes_even_when_missing_associations
+        get :render_resource_with_missing_nested_has_many_include
+        response = JSON.parse(@response.body)
+        assert response.key? 'included'
+        refute has_type?(response['included'], 'roles')
+      end
+
+      def test_render_collection_with_missing_nested_has_many_include
+        get :render_collection_with_missing_nested_has_many_include
+        response = JSON.parse(@response.body)
+        assert response.key? 'included'
+        assert has_type?(response['included'], 'roles')
+      end
+
+      def has_type?(collection, value)
+        collection.detect { |i| i['type'] == value}
+      end
+
+    end
+  end
+end

data/test/action_controller/serialization_scope_name_test.rb

@@ -0,0 +1,63 @@
+require 'test_helper'
+require 'pathname'
+
+class DefaultScopeNameTest < ActionController::TestCase
+  class UserSerializer < ActiveModel::Serializer
+    attributes :admin?
+    def admin?
+      current_user.admin
+    end
+  end
+
+  class UserTestController < ActionController::Base
+    protect_from_forgery
+
+    before_filter { request.format = :json }
+
+    def current_user
+      User.new(id: 1, name: 'Pete', admin: false)
+    end
+
+    def render_new_user
+      render json: User.new(id: 1, name: 'Pete', admin: false), serializer: UserSerializer, adapter: :json_api
+    end
+  end
+
+ tests UserTestController
+
+  def test_default_scope_name
+    get :render_new_user
+    assert_equal '{"data":{"admin?":false,"id":"1","type":"users"}}', @response.body
+  end
+end
+
+class SerializationScopeNameTest < ActionController::TestCase
+  class AdminUserSerializer < ActiveModel::Serializer
+    attributes :admin?
+    def admin?
+      current_admin.admin
+    end
+  end
+
+  class AdminUserTestController < ActionController::Base
+    protect_from_forgery
+
+    serialization_scope :current_admin
+    before_filter { request.format = :json }
+
+    def current_admin
+      User.new(id: 2, name: 'Bob', admin: true)
+    end
+
+    def render_new_user
+      render json: User.new(id: 1, name: 'Pete', admin: false), serializer: AdminUserSerializer, adapter: :json_api
+    end
+  end
+
+  tests AdminUserTestController
+
+  def test_override_scope_name_with_controller
+    get :render_new_user
+    assert_equal '{"data":{"admin?":true,"id":"1","type":"users"}}', @response.body
+  end
+end