active_model_serializers 0.8.3 → 0.9.1

data/test/integration/action_controller/serialization_test.rb

@@ -0,0 +1,303 @@
+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
+  
+    class ExplicitEachSerializerWithEnumarableObjectTest < ActionController::TestCase
+      class MyController < ActionController::Base
+        def render_array
+          render json: [Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })].to_enum, each_serializer: DifferentProfileSerializer
+        end
+      end
+
+      tests MyController
+
+      def test_render_array
+        get :render_array
+        assert_equal 'application/json', @response.content_type
+        assert_equal '{"my":[{"name":"Name 1"}]}', @response.body
+      end
+    end
+  end
+end

data/test/integration/action_controller/serialization_test_case_test.rb

@@ -0,0 +1,71 @@
+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
+
+        def render_template
+          prepend_view_path "./test/fixtures"
+          render template: "template"
+        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
+
+      def test_does_not_overwrite_notification_subscriptions
+        get :render_template
+        assert_template "template"
+      end
+    end
+  end
+end

data/test/integration/active_record/active_record_test.rb

@@ -0,0 +1,77 @@
+require 'test_helper'
+require 'fixtures/active_record'
+
+module ActiveModel
+  class Serializer
+    class ActiveRecordTest < Minitest::Test
+      def setup
+        @post = ARPost.first
+      end
+
+      def test_serialization_embedding_objects
+        post_serializer = ARPostSerializer.new(@post)
+
+        assert_equal({
+          'ar_post' => {
+            title: 'New post', body: 'A body!!!',
+            ar_comments: [{ body: 'what a dumb post', ar_tags: [{ name: 'happy' }, { name: 'whiny' }] },
+                          { body: 'i liked it', ar_tags: [{:name=>"happy"}, {:name=>"short"}] }],
+            ar_tags: [{ name: 'short' }, { name: 'whiny' }],
+            ar_section: { 'name' => 'ruby' }
+          }
+        }, post_serializer.as_json)
+      end
+
+      def test_serialization_embedding_ids
+        post_serializer = ARPostSerializer.new(@post)
+
+        embed(ARPostSerializer, embed: :ids) do
+          assert_equal({
+            'ar_post' => {
+              title: 'New post', body: 'A body!!!',
+              'ar_comment_ids' => [1, 2],
+              'ar_tag_ids' => [1, 2],
+              'ar_section_id' => 1
+            }
+          }, post_serializer.as_json)
+        end
+      end
+
+      def test_serialization_embedding_ids_including_in_root
+        post_serializer = ARPostSerializer.new(@post)
+
+        embed(ARPostSerializer, embed: :ids, embed_in_root: true) do
+          embed(ARCommentSerializer, embed: :ids, embed_in_root: true) do
+            assert_equal({
+              'ar_post' => {
+                title: 'New post', body: 'A body!!!',
+                'ar_comment_ids' => [1, 2],
+                'ar_tag_ids' => [1, 2],
+                'ar_section_id' => 1
+              },
+              'ar_comments' => [{ body: 'what a dumb post', 'ar_tag_ids' => [3, 2] },
+                            { body: 'i liked it', 'ar_tag_ids' => [3, 1] }],
+              'ar_tags' => [{ name: 'happy' }, { name: 'whiny' }, { name: 'short' }],
+              'ar_sections' => [{ 'name' => 'ruby' }]
+            }, post_serializer.as_json)
+          end
+        end
+      end
+
+      private
+
+      def embed(serializer_class, options = {})
+        old_assocs = Hash[serializer_class._associations.to_a.map { |(name, association)| [name, association.dup] }]
+
+        serializer_class._associations.each_value do |association|
+          association.embed = options[:embed]
+          association.embed_in_root = options[:embed_in_root]
+        end
+
+        yield
+      ensure
+        serializer_class._associations = old_assocs
+      end
+    end
+  end
+end

data/test/integration/generators/resource_generator_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+require 'rails'
+require 'active_model/serializer/railtie'
+require 'test_app'
+
+class ResourceGeneratorTest < Rails::Generators::TestCase
+  destination File.expand_path('../../../tmp', __FILE__)
+  setup :prepare_destination, :copy_routes
+
+  tests Rails::Generators::ResourceGenerator
+  arguments %w(account)
+
+  def test_serializer_file_is_generated
+    run_generator
+
+    assert_file 'app/serializers/account_serializer.rb', /class AccountSerializer < ActiveModel::Serializer/
+  end
+
+  private
+
+  def copy_routes
+    config_dir = File.join(destination_root, 'config')
+    FileUtils.mkdir_p(config_dir)
+    File.write(File.join(config_dir, 'routes.rb'), 'Rails.application.routes.draw { }')
+  end
+end

data/test/integration/generators/scaffold_controller_generator_test.rb

@@ -0,0 +1,64 @@
+require 'test_helper'
+require 'rails'
+require 'active_model/serializer/railtie'
+require 'test_app'
+
+class ScaffoldControllerGeneratorTest < Rails::Generators::TestCase
+  destination File.expand_path('../../../tmp', __FILE__)
+  setup :prepare_destination
+
+  tests Rails::Generators::ScaffoldControllerGenerator
+  arguments %w(account name:string description:text business:references)
+
+  def test_generated_controller
+    return true if Rails::VERSION::MAJOR < 4
+
+    run_generator
+
+    assert_file 'app/controllers/accounts_controller.rb' do |content|
+      assert_instance_method :index, content do |m|
+        assert_match /@accounts = Account\.all/, m
+        assert_match /format.html/, m
+        assert_match /format.json \{ render json: @accounts \}/, m
+      end
+
+      assert_instance_method :show, content do |m|
+        assert_match /format.html/, m
+        assert_match /format.json \{ render json: @account \}/, m
+      end
+
+      assert_instance_method :new, content do |m|
+        assert_match /@account = Account\.new/, m
+      end
+
+      assert_instance_method :edit, content do |m|
+        assert m.blank?
+      end
+
+      assert_instance_method :create, content do |m|
+        assert_match /@account = Account\.new\(account_params\)/, m
+        assert_match /@account\.save/, m
+        assert_match /format\.html \{ redirect_to @account, notice: 'Account was successfully created\.' \}/, m
+        assert_match /format\.json \{ render json: @account, status: :created \}/, m
+        assert_match /format\.html \{ render action: 'new' \}/, m
+        assert_match /format\.json \{ render json: @account\.errors, status: :unprocessable_entity \}/, m
+      end
+
+      assert_instance_method :update, content do |m|
+        assert_match /format\.html \{ redirect_to @account, notice: 'Account was successfully updated\.' \}/, m
+        assert_match /format\.json \{ head :no_content \}/, m
+        assert_match /format\.html \{ render action: 'edit' \}/, m
+        assert_match /format\.json \{ render json: @account.errors, status: :unprocessable_entity \}/, m
+      end
+
+      assert_instance_method :destroy, content do |m|
+        assert_match /@account\.destroy/, m
+        assert_match /format\.html { redirect_to accounts_url \}/, m
+        assert_match /format\.json \{ head :no_content \}/, m
+      end
+
+      assert_match(/def account_params/, content)
+      assert_match(/params\.require\(:account\)\.permit\(:name, :description, :business_id\)/, content)
+    end
+  end
+end

data/test/integration/generators/serializer_generator_test.rb

@@ -0,0 +1,41 @@
+require 'test_helper'
+require 'rails'
+require 'active_model/serializer/railtie'
+require 'test_app'
+
+class SerializerGeneratorTest < Rails::Generators::TestCase
+  destination File.expand_path('../../../tmp', __FILE__)
+  setup :prepare_destination
+
+  tests Rails::Generators::SerializerGenerator
+  arguments %w(account name:string description:text business:references)
+
+  def test_generates_a_serializer_with_attributes_and_associations
+    run_generator
+    assert_file 'app/serializers/account_serializer.rb', /class AccountSerializer < ActiveModel::Serializer/ do |serializer|
+      assert_match(/attributes :id, :name, :description/, serializer)
+      assert_match(/has_one :business/, serializer)
+    end
+  end
+
+  def test_generates_a_namespaced_serializer
+    run_generator ['admin/account']
+    assert_file 'app/serializers/admin/account_serializer.rb', /class Admin::AccountSerializer < ActiveModel::Serializer/
+  end
+
+  def test_uses_application_serializer_if_one_exists
+    Object.const_set(:ApplicationSerializer, Class.new)
+    run_generator
+    assert_file 'app/serializers/account_serializer.rb', /class AccountSerializer < ApplicationSerializer/
+  ensure
+    Object.send :remove_const, :ApplicationSerializer
+  end
+
+  def test_uses_given_parent
+    Object.const_set(:ApplicationSerializer, Class.new)
+    run_generator ['Account', '--parent=MySerializer']
+    assert_file 'app/serializers/account_serializer.rb', /class AccountSerializer < MySerializer/
+  ensure
+    Object.send :remove_const, :ApplicationSerializer
+  end
+end

data/test/test_app.rb

@@ -0,0 +1,14 @@
+class TestApp < Rails::Application
+  if Rails.version.to_s.first >= '4'
+    config.eager_load = false
+    config.secret_key_base = 'abc123'
+  end
+  config.after_initialize do
+    Rails.application.routes.default_url_options = { host: 'http://example.com' }
+  end
+
+  # Set up a logger to avoid creating a log directory on every run.
+  config.logger = Logger.new(nil)
+end
+
+TestApp.initialize!

data/test/test_helper.rb

@@ -1,32 +1,24 @@
-require "rubygems"
-require "bundler/setup"
+require 'bundler/setup'
+require 'minitest/autorun'
+require 'active_model_serializers'
+require 'fixtures/poro'
 
-require "pry"
-
-require "active_model_serializers"
-require "active_support/json"
-require "minitest/autorun"
-
-require 'rails'
+# Ensure backward compatibility with Minitest 4
+Minitest::Test = MiniTest::Unit::TestCase unless defined?(Minitest::Test)
 
 module TestHelper
   Routes = ActionDispatch::Routing::RouteSet.new
   Routes.draw do
-    resource :hypermedia
     get ':controller(/:action(/:id))'
     get ':controller(/:action)'
   end
 
   ActionController::Base.send :include, Routes.url_helpers
-  ActiveModel::Serializer.send :include, Routes.url_helpers
+  ActionController::Base.send :include, ActionController::Serialization
 end
 
-ActiveSupport::TestCase.class_eval do
-  setup do
-    @routes = ::TestHelper::Routes
+ActionController::TestCase.class_eval do
+  def setup
+    @routes = TestHelper::Routes
   end
 end
-
-class Object
-  undef_method :id if respond_to?(:id)
-end

data/test/tmp/app/serializers/account_serializer.rb

@@ -0,0 +1,3 @@
+class AccountSerializer < MySerializer
+  attributes :id
+end

data/test/unit/active_model/array_serializer/except_test.rb

@@ -0,0 +1,18 @@
+require 'test_helper'
+
+module ActiveModel
+  class ArraySerializer
+    class ExceptTest < Minitest::Test
+      def test_array_serializer_pass_except_to_items_serializers
+        array = [Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' }),
+                 Profile.new({ name: 'Name 2', description: 'Description 2', comments: 'Comments 2' })]
+        serializer = ArraySerializer.new(array, except: [:description])
+
+        expected = [{ name: 'Name 1' },
+                    { name: 'Name 2' }]
+
+        assert_equal expected, serializer.serializable_array
+      end
+    end
+  end
+end

data/test/unit/active_model/array_serializer/key_format_test.rb

@@ -0,0 +1,18 @@
+require 'test_helper'
+
+module ActiveModel
+  class ArraySerializer
+    class KeyFormatTest < Minitest::Test
+      def test_array_serializer_pass_options_to_items_serializers
+        array = [WebLog.new({ name: 'Name 1', display_name: 'Display Name 1'}),
+                 WebLog.new({ name: 'Name 2', display_name: 'Display Name 2'})]
+        serializer = ArraySerializer.new(array, key_format: :lower_camel)
+
+        expected = [{ name: 'Name 1', displayName: 'Display Name 1' },
+                    { name: 'Name 2', displayName: 'Display Name 2' }]
+
+        assert_equal expected, serializer.serializable_array
+      end
+    end
+  end
+end