active_model_serializers 0.8.3 → 0.9.0

data/lib/active_model/serializer_support.rb

@@ -0,0 +1,5 @@
+module ActiveModel
+  module SerializerSupport
+    alias read_attribute_for_serialization send
+  end
+end

data/lib/active_model_serializers.rb

@@ -1,95 +1,20 @@
-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'
+require 'active_model/serializer_support'
+require 'active_model/serializer/version'
+require 'active_model/serializer/railtie' if defined?(Rails)
 
 begin
   require 'action_controller'
   require 'action_controller/serialization'
+  require 'action_controller/serialization_test_case'
 
-  ActiveSupport.on_load(:action_controller) do
-    include ::ActionController::Serialization
+  ActiveSupport.on_load(:after_initialize) do
+    if ::ActionController::Serialization.enabled
+      ActionController::Base.send(:include, ::ActionController::Serialization)
+      ActionController::TestCase.send(:include, ::ActionController::SerializationAssertions)
+    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/test/fixtures/active_record.rb

@@ -0,0 +1,92 @@
+require 'active_record'
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => 'sqlite3',
+  :database => ':memory:'
+)
+
+ActiveRecord::Schema.define do
+  create_table :ar_posts, force: true do |t|
+    t.string     :title
+    t.text       :body
+    t.belongs_to :ar_section, index: true
+    t.timestamps
+  end
+
+  create_table :ar_comments, force: true do |t|
+    t.text       :body
+    t.belongs_to :ar_post, index: true
+    t.timestamps
+  end
+
+  create_table :ar_tags, force: true do |t|
+    t.string :name
+  end
+
+  create_table :ar_sections, force: true do |t|
+    t.string :name
+  end
+
+  create_table :ar_posts_tags, force: true do |t|
+    t.references :ar_post, :ar_tag, index: true
+  end
+
+  create_table :ar_comments_tags, force: true do |t|
+    t.references :ar_comment, :ar_tag, index: true
+  end
+end
+
+class ARPost < ActiveRecord::Base
+  has_many :ar_comments, class_name: 'ARComment'
+  has_and_belongs_to_many :ar_tags, class_name: 'ARTag', join_table: :ar_posts_tags
+  belongs_to :ar_section, class_name: 'ARSection'
+end
+
+class ARComment < ActiveRecord::Base
+  belongs_to :ar_post, class_name: 'ARPost'
+  has_and_belongs_to_many :ar_tags, class_name: 'ARTag', join_table: :ar_comments_tags
+end
+
+class ARTag < ActiveRecord::Base
+end
+
+class ARSection < ActiveRecord::Base
+end
+
+class ARPostSerializer < ActiveModel::Serializer
+  attributes :title, :body
+
+  has_many :ar_comments, :ar_tags
+  has_one  :ar_section
+end
+
+class ARCommentSerializer < ActiveModel::Serializer
+  attributes :body
+
+  has_many :ar_tags
+end
+
+class ARTagSerializer < ActiveModel::Serializer
+  attributes :name
+end
+
+class ARSectionSerializer < ActiveModel::Serializer
+  attributes 'name'
+end
+
+ARPost.create(title: 'New post',
+              body:  'A body!!!',
+              ar_section: ARSection.create(name: 'ruby')).tap do |post|
+
+  short_tag = post.ar_tags.create(name: 'short')
+  whiny_tag = post.ar_tags.create(name: 'whiny')
+  happy_tag = ARTag.create(name: 'happy')
+
+  post.ar_comments.create(body: 'what a dumb post').tap do |comment|
+    comment.ar_tags.concat happy_tag, whiny_tag
+  end
+
+  post.ar_comments.create(body: 'i liked it').tap do |comment|
+    comment.ar_tags.concat happy_tag, short_tag
+  end
+end

data/test/fixtures/poro.rb

@@ -0,0 +1,75 @@
+class Model
+  def initialize(hash={})
+    @attributes = hash
+  end
+
+  def read_attribute_for_serialization(name)
+    if name == :id || name == 'id'
+      object_id
+    else
+      @attributes[name]
+    end
+  end
+end
+
+
+###
+## Models
+###
+class User < Model
+  def profile
+    @profile ||= Profile.new(name: 'N1', description: 'D1')
+  end
+end
+
+class Profile < Model
+end
+
+class Post < Model
+  def comments
+    @comments ||= [Comment.new(content: 'C1'),
+                   Comment.new(content: 'C2')]
+  end
+end
+
+class Comment < Model
+end
+
+class WebLog < Model
+end
+
+###
+## Serializers
+###
+class UserSerializer < ActiveModel::Serializer
+  attributes :name, :email
+
+  has_one :profile
+end
+
+class ProfileSerializer < ActiveModel::Serializer
+  def description
+    description = object.read_attribute_for_serialization(:description)
+    scope ? "#{description} - #{scope}" : description
+  end
+
+  attributes :name, :description
+end
+
+class PostSerializer < ActiveModel::Serializer
+  attributes :title, :body
+
+  has_many :comments
+end
+
+class CommentSerializer < ActiveModel::Serializer
+  attributes :content
+end
+
+class WebLogSerializer < ActiveModel::Serializer
+  attributes :name, :display_name
+end
+
+class WebLogLowerCamelSerializer < WebLogSerializer
+  format_keys :lower_camel
+end

data/test/integration/action_controller/serialization_test.rb

@@ -0,0 +1,287 @@
+require 'test_helper'
+
+module ActionController
+  module Serialization
+    class ImplicitSerializerTest < ActionController::TestCase
+      class MyController < ActionController::Base
+        def render_using_implicit_serializer
+          render json: Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+        end
+      end
+
+      tests MyController
+
+      def test_render_using_implicit_serializer
+        get :render_using_implicit_serializer
+        assert_equal 'application/json', @response.content_type
+        assert_equal '{"profile":{"name":"Name 1","description":"Description 1"}}', @response.body
+      end
+    end
+
+    class ImplicitSerializerScopeTest < ActionController::TestCase
+      class MyController < ActionController::Base
+        def render_using_implicit_serializer_and_scope
+          render json: Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+        end
+
+        private
+
+        def current_user
+          'current_user'
+        end
+      end
+
+      tests MyController
+
+      def test_render_using_implicit_serializer_and_scope
+        get :render_using_implicit_serializer_and_scope
+        assert_equal 'application/json', @response.content_type
+        assert_equal '{"profile":{"name":"Name 1","description":"Description 1 - current_user"}}', @response.body
+      end
+    end
+
+    class DefaultOptionsForSerializerScopeTest < ActionController::TestCase
+      class MyController < ActionController::Base
+        def default_serializer_options
+          { scope: current_admin }
+        end
+
+        def render_using_scope_set_in_default_serializer_options
+          render json: Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+        end
+
+        private
+
+        def current_user
+          'current_user'
+        end
+
+        def current_admin
+          'current_admin'
+        end
+      end
+
+      tests MyController
+
+      def test_render_using_scope_set_in_default_serializer_options
+        get :render_using_scope_set_in_default_serializer_options
+        assert_equal 'application/json', @response.content_type
+        assert_equal '{"profile":{"name":"Name 1","description":"Description 1 - current_admin"}}', @response.body
+      end
+    end
+
+    class ExplicitSerializerScopeTest < ActionController::TestCase
+      class MyController < ActionController::Base
+        def render_using_implicit_serializer_and_explicit_scope
+          render json: Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' }), scope: current_admin
+        end
+
+        private
+
+        def current_user
+          'current_user'
+        end
+
+        def current_admin
+          'current_admin'
+        end
+      end
+
+      tests MyController
+
+      def test_render_using_implicit_serializer_and_explicit_scope
+        get :render_using_implicit_serializer_and_explicit_scope
+        assert_equal 'application/json', @response.content_type
+        assert_equal '{"profile":{"name":"Name 1","description":"Description 1 - current_admin"}}', @response.body
+      end
+    end
+
+    class OverridingSerializationScopeTest < ActionController::TestCase
+      class MyController < ActionController::Base
+        def render_overriding_serialization_scope
+          render json: Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+        end
+
+        private
+
+        def current_user
+          'current_user'
+        end
+
+        def serialization_scope
+          'current_admin'
+        end
+      end
+
+      tests MyController
+
+      def test_render_overriding_serialization_scope
+        get :render_overriding_serialization_scope
+        assert_equal 'application/json', @response.content_type
+        assert_equal '{"profile":{"name":"Name 1","description":"Description 1 - current_admin"}}', @response.body
+      end
+    end
+
+    class CallingSerializationScopeTest < ActionController::TestCase
+      class MyController < ActionController::Base
+        def render_calling_serialization_scope
+          render json: Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+        end
+
+        private
+
+        def current_user
+          'current_user'
+        end
+
+        serialization_scope :current_user
+      end
+
+      tests MyController
+
+      def test_render_calling_serialization_scope
+        get :render_calling_serialization_scope
+        assert_equal 'application/json', @response.content_type
+        assert_equal '{"profile":{"name":"Name 1","description":"Description 1 - current_user"}}', @response.body
+      end
+    end
+
+    class JSONDumpSerializerTest < ActionController::TestCase
+      class MyController < ActionController::Base
+        def render_using_json_dump
+          render json: JSON.dump(hello: 'world')
+        end
+      end
+
+      tests MyController
+
+      def test_render_using_json_dump
+        get :render_using_json_dump
+        assert_equal 'application/json', @response.content_type
+        assert_equal '{"hello":"world"}', @response.body
+      end
+    end
+
+    class RailsSerializerTest < ActionController::TestCase
+      class MyController < ActionController::Base
+        def render_using_rails_behavior
+          render json: [Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })], serializer: false
+        end
+      end
+
+      tests MyController
+
+      def test_render_using_rails_behavior
+        get :render_using_rails_behavior
+        assert_equal 'application/json', @response.content_type
+        assert_equal '[{"attributes":{"name":"Name 1","description":"Description 1","comments":"Comments 1"}}]', @response.body
+      end
+    end
+
+    class ArraySerializerTest < ActionController::TestCase
+      class MyController < ActionController::Base
+        def render_array
+          render json: [Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })]
+        end
+      end
+
+      tests MyController
+
+      def test_render_array
+        get :render_array
+        assert_equal 'application/json', @response.content_type
+        assert_equal '{"my":[{"name":"Name 1","description":"Description 1"}]}', @response.body
+      end
+    end
+
+    class LowerCamelArraySerializerTest < ActionController::TestCase
+      class WebLogController < ActionController::Base
+        def render_array
+          render json: [WebLog.new({name: 'Name 1', display_name: 'Display Name 1'}), WebLog.new({name: 'Name 2', display_name: 'Display Name 2'})], each_serializer: WebLogLowerCamelSerializer
+        end
+      end
+
+      tests WebLogController
+
+      def test_render_array
+        get :render_array
+        assert_equal 'application/json', @response.content_type
+        assert_equal '{"webLog":[{"name":"Name 1","displayName":"Display Name 1"},{"name":"Name 2","displayName":"Display Name 2"}]}', @response.body
+      end
+    end
+
+    class LowerCamelWoRootSerializerTest < ActionController::TestCase
+      class WebLogController < ActionController::Base
+        def render_without_root
+          render json: WebLog.new({name: 'Name 1', display_name: 'Display Name 1'}), 
+                 root: false, 
+                 serializer: WebLogLowerCamelSerializer
+        end
+      end
+
+      tests WebLogController
+
+      def test_render_without_root
+        get :render_without_root
+        assert_equal 'application/json', @response.content_type
+        assert_equal '{"name":"Name 1","displayName":"Display Name 1"}', @response.body
+      end
+    end
+
+    class LowerCamelArrayWoRootSerializerTest < ActionController::TestCase
+      class WebLogController < ActionController::Base
+        def render_array_without_root
+          render json: [WebLog.new({name: 'Name 1', display_name: 'Display Name 1'}), 
+                        WebLog.new({name: 'Name 2', display_name: 'Display Name 2'})], 
+                 root: false, 
+                 each_serializer: WebLogLowerCamelSerializer
+        end
+      end
+
+      tests WebLogController
+
+      def test_render_array_without_root
+        get :render_array_without_root
+        assert_equal 'application/json', @response.content_type
+        assert_equal '[{"name":"Name 1","displayName":"Display Name 1"},{"name":"Name 2","displayName":"Display Name 2"}]', @response.body
+      end
+    end
+
+    class ArrayEmbedingSerializerTest < ActionController::TestCase
+      def setup
+        super
+        @association = UserSerializer._associations[:profile]
+        @old_association = @association.dup
+      end
+
+      def teardown
+        super
+        UserSerializer._associations[:profile] = @old_association
+      end
+
+      class MyController < ActionController::Base
+        def initialize(*)
+          super
+          @user = User.new({ name: 'Name 1', email: 'mail@server.com', gender: 'M' })
+        end
+        attr_reader :user
+
+        def render_array_embeding_in_root
+          render json: [@user]
+        end
+      end
+
+      tests MyController
+
+      def test_render_array_embeding_in_root
+        @association.embed = :ids
+        @association.embed_in_root = true
+
+        get :render_array_embeding_in_root
+        assert_equal 'application/json', @response.content_type
+
+        assert_equal("{\"my\":[{\"name\":\"Name 1\",\"email\":\"mail@server.com\",\"profile_id\":#{@controller.user.profile.object_id}}],\"profiles\":[{\"name\":\"N1\",\"description\":\"D1\"}]}", @response.body)
+      end
+    end
+  end
+end

data/test/integration/action_controller/serialization_test_case_test.rb

@@ -0,0 +1,61 @@
+require 'test_helper'
+
+module ActionController
+  module SerializationsAssertions
+    class RenderSerializerTest < ActionController::TestCase
+      class MyController < ActionController::Base
+        def render_using_serializer
+          render json: Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+        end
+
+        def render_text
+          render text: 'ok'
+        end
+      end
+
+      tests MyController
+
+      def test_supports_specifying_serializers_with_a_serializer_class
+        get :render_using_serializer
+        assert_serializer ProfileSerializer
+      end
+
+      def test_supports_specifying_serializers_with_a_regexp
+        get :render_using_serializer
+        assert_serializer %r{\AProfile.+\Z}
+      end
+
+      def test_supports_specifying_serializers_with_a_string
+        get :render_using_serializer
+        assert_serializer 'ProfileSerializer'
+      end
+
+      def test_supports_specifying_serializers_with_a_symbol
+        get :render_using_serializer
+        assert_serializer :profile_serializer
+      end
+
+      def test_supports_specifying_serializers_with_a_nil
+        get :render_text
+        assert_serializer nil
+      end
+
+      def test_raises_descriptive_error_message_when_serializer_was_not_rendered
+        get :render_using_serializer
+        e = assert_raise ActiveSupport::TestCase::Assertion do
+          assert_serializer 'PostSerializer'
+        end
+        assert_match 'expecting <"PostSerializer"> but rendering with <["ProfileSerializer"]>', e.message
+      end
+
+
+      def test_raises_argument_error_when_asserting_with_invalid_object
+        get :render_using_serializer
+        e = assert_raise ArgumentError do
+          assert_serializer Hash
+        end
+        assert_match 'assert_serializer only accepts a String, Symbol, Regexp, ActiveModel::Serializer, or nil', e.message
+      end
+    end
+  end
+end