active_model_serializers 0.8.3 → 0.10.0.rc2

data/lib/active_model_serializers.rb

@@ -1,85 +1,8 @@
-require "active_support"
-require "active_support/core_ext/string/inflections"
-require "active_support/notifications"
-require "active_model"
-require "active_model/array_serializer"
-require "active_model/serializer"
-require "active_model/serializer/associations"
-require "set"
-
-if defined?(Rails)
-  module ActiveModel
-    class Railtie < Rails::Railtie
-      generators do |app|
-        app ||= Rails.application # Rails 3.0.x does not yield `app`
-
-        Rails::Generators.configure!(app.config.generators)
-        Rails::Generators.hidden_namespaces.uniq!
-        require_relative "generators/resource_override"
-      end
-
-      initializer "include_routes.active_model_serializer" do |app|
-        ActiveSupport.on_load(:active_model_serializers) do
-          include app.routes.url_helpers
-        end
-      end
-
-      initializer "caching.active_model_serializer" do |app|
-        ActiveModel::Serializer.perform_caching = app.config.action_controller.perform_caching
-        ActiveModel::ArraySerializer.perform_caching = app.config.action_controller.perform_caching
-
-        ActiveModel::Serializer.cache = Rails.cache
-        ActiveModel::ArraySerializer.cache = Rails.cache
-      end
-    end
-  end
-end
-
-module ActiveModel::SerializerSupport
-  extend ActiveSupport::Concern
-
-  module ClassMethods #:nodoc:
-    if "".respond_to?(:safe_constantize)
-      def active_model_serializer
-        "#{self.name}Serializer".safe_constantize
-      end
-    else
-      def active_model_serializer
-        begin
-          "#{self.name}Serializer".constantize
-        rescue NameError => e
-          raise unless e.message =~ /uninitialized constant/
-        end
-      end
-    end
-  end
-
-  # Returns a model serializer for this object considering its namespace.
-  def active_model_serializer
-    self.class.active_model_serializer
-  end
-
-  alias :read_attribute_for_serialization :send
-end
-
-module ActiveModel::ArraySerializerSupport
-  def active_model_serializer
-    ActiveModel::ArraySerializer
-  end
-end
-
-Array.send(:include, ActiveModel::ArraySerializerSupport)
-Set.send(:include, ActiveModel::ArraySerializerSupport)
-
-{
-  :active_record => 'ActiveRecord::Relation',
-  :mongoid => 'Mongoid::Criteria'
-}.each do |orm, rel_class|
-  ActiveSupport.on_load(orm) do
-    include ActiveModel::SerializerSupport
-    rel_class.constantize.send(:include, ActiveModel::ArraySerializerSupport)
-  end
-end
+require 'active_model'
+require 'active_model/serializer/version'
+require 'active_model/serializer'
+require 'active_model/serializer/fieldset'
+require 'active_model/serializer/railtie'
 
 begin
   require 'action_controller'
@@ -87,9 +10,10 @@ begin
 
   ActiveSupport.on_load(:action_controller) do
     include ::ActionController::Serialization
+    ActionDispatch::Reloader.to_prepare do
+      ActiveModel::Serializer.serializers_cache.clear
+    end
   end
-rescue LoadError => ex
-  # rails on installed, continuing
+rescue LoadError
+  # rails not installed, continuing
 end
-
-ActiveSupport.run_load_hooks(:active_model_serializers, ActiveModel::Serializer)

data/lib/generators/serializer/USAGE

@@ -4,6 +4,3 @@ Description:
 Example:
     `rails generate serializer Account name created_at`
 
-    For TestUnit it creates:
-        Serializer:  app/serializers/account_serializer.rb
-        TestUnit:    test/unit/account_serializer_test.rb

data/lib/generators/serializer/resource_override.rb

@@ -0,0 +1,12 @@
+require 'rails/generators'
+require 'rails/generators/rails/resource/resource_generator'
+
+module Rails
+  module Generators
+    class ResourceGenerator
+      def add_serializer
+        invoke 'serializer'
+      end
+    end
+  end
+end

data/lib/generators/serializer/serializer_generator.rb

@@ -13,9 +13,6 @@ module Rails
       end
 
       private
-      def generate_id_method
-        RUBY_VERSION =~ /1\.8/
-      end
 
       def attributes_names
         [:id] + attributes.select { |attr| !attr.reference? }.map { |a| a.name.to_sym }
@@ -28,9 +25,6 @@ module Rails
       def parent_class_name
         if options[:parent]
           options[:parent]
-        # Only works on 3.2
-        # elsif (n = Rails::Generators.namespace) && n.const_defined?(:ApplicationSerializer)
-        #   "ApplicationSerializer"
         elsif defined?(::ApplicationSerializer)
           "ApplicationSerializer"
         else
@@ -40,3 +34,4 @@ module Rails
     end
   end
 end
+

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

@@ -1,19 +1,8 @@
 <% module_namespacing do -%>
 class <%= class_name %>Serializer < <%= parent_class_name %>
   attributes <%= attributes_names.map(&:inspect).join(", ") %>
+end
 <% association_names.each do |attribute| -%>
-  has_one :<%= attribute %>
-<% end -%>
-<% if generate_id_method %>
-
-  # due to the difference between 1.8 and 1.9 with respect to #id and
-  # #object_id, we recommend that if you wish to serialize id columns, you
-  # do this. Feel free to remove this if you don't feel that it's appropriate.
-  #
-  # For more: https://github.com/rails-api/active_model_serializers/issues/127
-  def id
-    object.read_attribute_for_serialization(:id)
-  end
+  attribute :<%= attribute %>
 <% end -%>
-end
 <% end -%>

data/test/action_controller/adapter_selector_test.rb

@@ -0,0 +1,53 @@
+require 'test_helper'
+
+module ActionController
+  module Serialization
+    class AdapterSelectorTest < ActionController::TestCase
+      class AdapterSelectorTestController < 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 AdapterSelectorTestController
+
+      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: {
+            id: assigns(:profile).id.to_s,
+            type: "profiles",
+            attributes: {
+              name: "Name 1",
+              description: "Description 1",
+            }
+          }
+        }
+
+        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,134 @@
+require 'test_helper'
+
+module ActionController
+  module Serialization
+    class ExplicitSerializerTest < ActionController::TestCase
+      class ExplicitSerializerTestController < 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
+
+        def render_using_explicit_each_serializer
+          location       = Location.new(id: 42, lat: '-23.550520', lng: '-46.633309')
+          place          = Place.new(id: 1337, name: 'Amazing Place', locations: [location])
+
+          render json: place, each_serializer: PlaceSerializer
+        end
+      end
+
+      tests ExplicitSerializerTestController
+
+      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 = [
+          { '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
+
+      def test_render_using_explicit_each_serializer
+        get :render_using_explicit_each_serializer
+
+        expected = {
+          id: 1337,
+          name: "Amazing Place",
+          locations: [
+            {
+              id: 42,
+              lat: "-23.550520",
+              lng: "-46.633309",
+              place: "Nowhere" # is a virtual attribute on LocationSerializer
+            }
+          ]
+        }
+
+        assert_equal expected.to_json, response.body
+      end
+    end
+  end
+end

data/test/action_controller/json_api_linked_test.rb

@@ -0,0 +1,179 @@
+require 'test_helper'
+
+module ActionController
+  module Serialization
+    class JsonApiLinkedTest < ActionController::TestCase
+      class JsonApiLinkedTestController < 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 JsonApiLinkedTestController
+
+      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['attributes']['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",
+            "attributes" => {
+              "name" => "Steve K."
+            },
+            "relationships" => {
+              "posts" => { "data" => [] },
+              "roles" => { "data" => [{ "type" =>"roles", "id" => "1" }, { "type" =>"roles", "id" => "2" }] },
+              "bio" => { "data" => nil }
+            }
+          }, {
+            "id" => "1",
+            "type" => "roles",
+            "attributes" => {
+              "name" => "admin",
+              "description" => nil,
+              "slug" => "admin-1"
+            },
+            "relationships" => {
+              "author" => { "data" => { "type" =>"authors", "id" => "1" } }
+            }
+          }, {
+            "id" => "2",
+            "type" => "roles",
+            "attributes" => {
+              "name" => "colab",
+              "description" => nil,
+              "slug" => "colab-2"
+            },
+            "relationships" => {
+              "author" => { "data" => { "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['attributes']['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/rescue_from_test.rb

@@ -0,0 +1,32 @@
+require 'test_helper'
+
+module ActionController
+  module Serialization
+    class RescueFromTest < ActionController::TestCase
+      class RescueFromTestController < ActionController::Base
+        rescue_from Exception, with: :handle_error
+
+        def render_using_raise_error_serializer
+          @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+          render json: [@profile], serializer: RaiseErrorSerializer
+        end
+
+        def handle_error(exception)
+          render json: { errors: ['Internal Server Error'] }, status: :internal_server_error
+        end
+      end
+
+      tests RescueFromTestController
+
+      def test_rescue_from
+        get :render_using_raise_error_serializer
+
+        expected = {
+          errors: ['Internal Server Error']
+        }.to_json
+
+        assert_equal expected, @response.body
+      end
+    end
+  end
+end

data/test/{serialization_scope_name_test.rb → action_controller/serialization_scope_name_test.rb}

@@ -2,8 +2,6 @@ require 'test_helper'
 require 'pathname'
 
 class DefaultScopeNameTest < ActionController::TestCase
-  TestUser = Struct.new(:name, :admin)
-
   class UserSerializer < ActiveModel::Serializer
     attributes :admin?
     def admin?
@@ -17,11 +15,11 @@ class DefaultScopeNameTest < ActionController::TestCase
     before_filter { request.format = :json }
 
     def current_user
-      TestUser.new('Pete', false)
+      User.new(id: 1, name: 'Pete', admin: false)
     end
 
     def render_new_user
-      render :json => TestUser.new('pete', false), :serializer => UserSerializer
+      render json: User.new(id: 1, name: 'Pete', admin: false), serializer: UserSerializer, adapter: :json_api
     end
   end
 
@@ -29,13 +27,11 @@ class DefaultScopeNameTest < ActionController::TestCase
 
   def test_default_scope_name
     get :render_new_user
-    assert_equal '{"user":{"admin":false}}', @response.body
+    assert_equal '{"data":{"id":"1","type":"users","attributes":{"admin?":false}}}', @response.body
   end
 end
 
 class SerializationScopeNameTest < ActionController::TestCase
-  TestUser = Struct.new(:name, :admin)
-
   class AdminUserSerializer < ActiveModel::Serializer
     attributes :admin?
     def admin?
@@ -50,11 +46,11 @@ class SerializationScopeNameTest < ActionController::TestCase
     before_filter { request.format = :json }
 
     def current_admin
-      TestUser.new('Bob', true)
+      User.new(id: 2, name: 'Bob', admin: true)
     end
 
     def render_new_user
-      render :json => TestUser.new('pete', false), :serializer => AdminUserSerializer
+      render json: User.new(id: 1, name: 'Pete', admin: false), serializer: AdminUserSerializer, adapter: :json_api
     end
   end
 
@@ -62,6 +58,6 @@ class SerializationScopeNameTest < ActionController::TestCase
 
   def test_override_scope_name_with_controller
     get :render_new_user
-    assert_equal '{"admin_user":{"admin":true}}', @response.body
+    assert_equal '{"data":{"id":"1","type":"users","attributes":{"admin?":true}}}', @response.body
   end
-end
+end