active_model_serializers 0.9.13 → 0.10.0.rc1

data/test/serializers/cache_test.rb

@@ -0,0 +1,128 @@
+require 'test_helper'
+module ActiveModel
+  class Serializer
+    class CacheTest < Minitest::Test
+      def setup
+        ActionController::Base.cache_store.clear
+        @comment        = Comment.new(id: 1, body: 'ZOMG A COMMENT')
+        @blog           = Blog.new(id: 999, name: "Custom blog")
+        @post           = Post.new(title: 'New Post', body: 'Body')
+        @bio            = Bio.new(id: 1, content: 'AMS Contributor')
+        @author         = Author.new(name: 'Joao M. D. Moura')
+        @role           = Role.new(name: 'Great Author')
+        @location       = Location.new(lat: '-23.550520', lng: '-46.633309')
+        @place          = Place.new(name: 'Amazing Place')
+        @author.posts   = [@post]
+        @author.roles   = [@role]
+        @role.author    = @author
+        @author.bio     = @bio
+        @bio.author     = @author
+        @post.comments  = [@comment]
+        @post.author    = @author
+        @comment.post   = @post
+        @comment.author = @author
+        @post.blog      = @blog
+        @location.place = @place
+
+        @location_serializer = LocationSerializer.new(@location)
+        @bio_serializer      = BioSerializer.new(@bio)
+        @role_serializer     = RoleSerializer.new(@role)
+        @post_serializer     = PostSerializer.new(@post)
+        @author_serializer   = AuthorSerializer.new(@author)
+        @comment_serializer  = CommentSerializer.new(@comment)
+      end
+
+      def test_cache_definition
+        assert_equal(ActionController::Base.cache_store, @post_serializer.class._cache)
+        assert_equal(ActionController::Base.cache_store, @author_serializer.class._cache)
+        assert_equal(ActionController::Base.cache_store, @comment_serializer.class._cache)
+      end
+
+      def test_cache_key_definition
+        assert_equal('post', @post_serializer.class._cache_key)
+        assert_equal('writer', @author_serializer.class._cache_key)
+        assert_equal(nil, @comment_serializer.class._cache_key)
+      end
+
+      def test_cache_key_interpolation_with_updated_at
+        author = render_object_with_cache(@author)
+        assert_equal(nil, ActionController::Base.cache_store.fetch(@author.cache_key))
+        assert_equal(@author_serializer.attributes.to_json, ActionController::Base.cache_store.fetch("#{@author_serializer.class._cache_key}/#{@author_serializer.object.id}-#{@author_serializer.object.updated_at}").to_json)
+      end
+
+      def test_default_cache_key_fallback
+        comment = render_object_with_cache(@comment)
+        assert_equal(@comment_serializer.attributes.to_json, ActionController::Base.cache_store.fetch(@comment.cache_key).to_json)
+      end
+
+      def test_cache_options_definition
+        assert_equal({expires_in: 0.1}, @post_serializer.class._cache_options)
+        assert_equal(nil, @author_serializer.class._cache_options)
+        assert_equal({expires_in: 1.day}, @comment_serializer.class._cache_options)
+      end
+
+      def test_fragment_cache_definition
+        assert_equal([:name], @role_serializer.class._cache_only)
+        assert_equal([:content], @bio_serializer.class._cache_except)
+      end
+
+      def test_associations_separately_cache
+        ActionController::Base.cache_store.clear
+        assert_equal(nil, ActionController::Base.cache_store.fetch(@post.cache_key))
+        assert_equal(nil, ActionController::Base.cache_store.fetch(@comment.cache_key))
+
+        post = render_object_with_cache(@post)
+
+        assert_equal(@post_serializer.attributes, ActionController::Base.cache_store.fetch(@post.cache_key))
+        assert_equal(@comment_serializer.attributes, ActionController::Base.cache_store.fetch(@comment.cache_key))
+      end
+
+      def test_associations_cache_when_updated
+        # Clean the Cache
+        ActionController::Base.cache_store.clear
+
+        # Generate a new Cache of Post object and each objects related to it.
+        render_object_with_cache(@post)
+
+        # Check if if cache the objects separately
+        assert_equal(@post_serializer.attributes, ActionController::Base.cache_store.fetch(@post.cache_key))
+        assert_equal(@comment_serializer.attributes, ActionController::Base.cache_store.fetch(@comment.cache_key))
+
+        # Simulating update on comments relationship with Post
+        new_comment            = Comment.new(id: 2, body: 'ZOMG A NEW COMMENT')
+        new_comment_serializer = CommentSerializer.new(new_comment)
+        @post.comments         = [new_comment]
+
+        # Ask for the serialized object
+        render_object_with_cache(@post)
+
+        # Check if the the new comment was cached
+        assert_equal(new_comment_serializer.attributes, ActionController::Base.cache_store.fetch(new_comment.cache_key))
+        assert_equal(@post_serializer.attributes, ActionController::Base.cache_store.fetch(@post.cache_key))
+      end
+
+      def test_fragment_fetch_with_virtual_associations
+        expected_result = {
+          id: @location.id,
+          lat: @location.lat,
+          lng: @location.lng,
+          place: 'Nowhere'
+        }
+
+        hash = render_object_with_cache(@location)
+
+        assert_equal(hash, expected_result)
+        assert_equal({place: 'Nowhere'}, ActionController::Base.cache_store.fetch(@location.cache_key))
+      end
+
+      private
+      def render_object_with_cache(obj)
+        serializer_class = ActiveModel::Serializer.serializer_for(obj)
+        serializer = serializer_class.new(obj)
+        adapter = ActiveModel::Serializer.adapter.new(serializer)
+        adapter.serializable_hash
+      end
+    end
+  end
+end
+

data/test/serializers/configuration_test.rb

@@ -0,0 +1,15 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class ConfigurationTest < Minitest::Test
+      def test_array_serializer
+        assert_equal ActiveModel::Serializer::ArraySerializer, ActiveModel::Serializer.config.array_serializer
+      end
+
+      def test_default_adapter
+        assert_equal :json, ActiveModel::Serializer.config.adapter
+      end
+    end
+  end
+end

data/test/serializers/fieldset_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class FieldsetTest < Minitest::Test
+
+      def test_fieldset_with_hash
+        fieldset = ActiveModel::Serializer::Fieldset.new({'post' => ['id', 'title'], 'coment' => ['body']})
+
+        assert_equal(
+          {:post=>[:id, :title], :coment=>[:body]}, 
+          fieldset.fields
+        )
+      end
+
+      def test_fieldset_with_array_of_fields_and_root_name
+        fieldset = ActiveModel::Serializer::Fieldset.new(['title'], 'post')
+
+        assert_equal(
+          {:post => [:title]}, 
+          fieldset.fields
+        )
+      end
+    end
+  end
+end

data/test/serializers/generators_test.rb

@@ -0,0 +1,59 @@
+class Foo < Rails::Application
+  if Rails.version.to_s.start_with? '4'
+    config.eager_load = false
+    config.secret_key_base = 'abc123'
+  end
+end
+
+Rails.application.load_generators
+
+require 'generators/serializer/serializer_generator'
+
+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
+    run_generator
+    assert_file "app/serializers/account_serializer.rb", /class AccountSerializer < ActiveModel::Serializer/
+  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
+
+  def test_generates_attributes_and_associations
+    run_generator
+    assert_file "app/serializers/account_serializer.rb" do |serializer|
+      assert_match(/^  attributes :id, :name, :description$/, serializer)
+      assert_match(/^  attribute :business$/, serializer)
+    end
+  end
+
+  def test_with_no_attributes_does_not_add_extra_space
+    run_generator ["account"]
+    assert_file "app/serializers/account_serializer.rb" do |content|
+      assert_no_match /\n\nend/, content
+    end
+  end
+end

data/test/serializers/meta_test.rb

@@ -0,0 +1,78 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class MetaTest < Minitest::Test
+      def setup
+        ActionController::Base.cache_store.clear
+        @blog = Blog.new(id: 1,
+                         name: 'AMS Hints',
+                         writer: Author.new(id: 2, name: "Steve"),
+                         articles: [Post.new(id: 3, title: "AMS")])
+      end
+
+      def test_meta_is_present_with_root
+        adapter = load_adapter(root: "blog", meta: {total: 10})
+        expected = {
+          "blog" => {
+            id: 1,
+            title: "AMS Hints"
+          },
+          "meta" => {
+            total: 10
+          }
+        }
+        assert_equal expected, adapter.as_json
+      end
+
+      def test_meta_is_not_included_when_root_is_missing
+        adapter = load_adapter(meta: {total: 10})
+        expected = {
+          id: 1,
+          title: "AMS Hints"
+        }
+        assert_equal expected, adapter.as_json
+      end
+
+      def test_meta_key_is_used
+        adapter = load_adapter(root: "blog", meta: {total: 10}, meta_key: "haha_meta")
+        expected = {
+          "blog" => {
+            id: 1,
+            title: "AMS Hints"
+          },
+          "haha_meta" => {
+            total: 10
+          }
+        }
+        assert_equal expected, adapter.as_json
+      end
+
+      def test_meta_is_not_used_on_arrays
+        serializer = ArraySerializer.new([@blog], root: "blog", meta: {total: 10}, meta_key: "haha_meta")
+        adapter = ActiveModel::Serializer::Adapter::Json.new(serializer)
+        expected = [{
+          id: 1,
+          name: "AMS Hints",
+          writer: {
+            id: 2,
+            name: "Steve"
+          },
+          articles: [{
+            id: 3,
+            title: "AMS",
+            body: nil
+          }]
+        }]
+        assert_equal expected, adapter.as_json
+      end
+
+      private
+
+      def load_adapter(options)
+        serializer = AlternateBlogSerializer.new(@blog, options)
+        ActiveModel::Serializer::Adapter::Json.new(serializer)
+      end
+    end
+  end
+end

data/test/serializers/options_test.rb

@@ -0,0 +1,21 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class OptionsTest < Minitest::Test
+      def setup
+        @profile = Profile.new(name: 'Name 1', description: 'Description 1')
+      end
+
+      def test_options_are_accessible
+        @profile_serializer = ProfileSerializer.new(@profile, my_options: :accessible)
+        assert @profile_serializer.arguments_passed_in?
+      end
+
+      def test_no_option_is_passed_in
+        @profile_serializer = ProfileSerializer.new(@profile)
+        refute @profile_serializer.arguments_passed_in?
+      end
+    end
+  end
+end

data/test/serializers/serializer_for_test.rb

@@ -0,0 +1,56 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class SerializerForTest < Minitest::Test
+      class ArraySerializerTest < Minitest::Test
+        def setup
+          @array = [1, 2, 3]
+          @previous_array_serializer = ActiveModel::Serializer.config.array_serializer
+        end
+
+        def teardown
+          ActiveModel::Serializer.config.array_serializer = @previous_array_serializer
+        end
+
+        def test_serializer_for_array
+          serializer = ActiveModel::Serializer.serializer_for(@array)
+          assert_equal ActiveModel::Serializer.config.array_serializer, serializer
+        end
+
+        def test_overwritten_serializer_for_array
+          new_array_serializer = Class.new
+          ActiveModel::Serializer.config.array_serializer = new_array_serializer
+          serializer = ActiveModel::Serializer.serializer_for(@array)
+          assert_equal new_array_serializer, serializer
+        end
+      end
+
+      class SerializerTest <  Minitest::Test
+        class MyProfile < Profile
+        end
+
+        def setup
+          @profile = Profile.new
+          @my_profile = MyProfile.new
+          @model = ::Model.new
+        end
+
+        def test_serializer_for_existing_serializer
+          serializer = ActiveModel::Serializer.serializer_for(@profile)
+          assert_equal ProfileSerializer, serializer
+        end
+
+        def test_serializer_for_not_existing_serializer
+          serializer = ActiveModel::Serializer.serializer_for(@model)
+          assert_equal nil, serializer
+        end
+
+        def test_serializer_inherited_serializer
+          serializer = ActiveModel::Serializer.serializer_for(@my_profile)
+          assert_equal ProfileSerializer, serializer
+        end
+      end
+    end
+  end
+end

data/test/serializers/urls_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class UrlsTest < Minitest::Test
+
+      def setup
+        @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+        @post = Post.new({ title: 'New Post', body: 'Body' })
+        @comment = Comment.new({ id: 1, body: 'ZOMG A COMMENT' })
+        @post.comments = [@comment]
+
+        @profile_serializer = ProfileSerializer.new(@profile)
+        @post_serializer = PostSerializer.new(@post)
+      end
+
+      def test_urls_definition
+        assert_equal([:posts, :comments], @profile_serializer.class._urls)
+      end
+
+      def test_url_definition
+        assert_equal([:comments], @post_serializer.class._urls)
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -1,17 +1,24 @@
 require 'bundler/setup'
+
+require 'rails'
+require 'action_controller'
+require 'action_controller/test_case'
+require 'action_controller/railtie'
+require 'active_support/json'
 require 'minitest/autorun'
-require 'active_model_serializers'
-require 'fixtures/poro'
-begin
-  require 'rails-controller-testing'
-  Rails::Controller::Testing.install
-rescue LoadError
-  false # Rails 5 < backward compatibility
+# Ensure backward compatibility with Minitest 4
+Minitest::Test = MiniTest::Unit::TestCase unless defined?(Minitest::Test)
+
+class Foo < Rails::Application
+  if Rails.version.to_s.start_with? '4'
+    config.action_controller.perform_caching = true
+    ActionController::Base.cache_store = :memory_store
+  end
 end
 
+require "active_model_serializers"
 
-# Ensure backward compatibility with Minitest 4
-Minitest::Test = MiniTest::Unit::TestCase unless defined?(Minitest::Test)
+require 'fixtures/poro'
 
 module TestHelper
   Routes = ActionDispatch::Routing::RouteSet.new
@@ -21,7 +28,6 @@ module TestHelper
   end
 
   ActionController::Base.send :include, Routes.url_helpers
-  ActionController::Base.send :include, ActionController::Serialization
 end
 
 ActionController::TestCase.class_eval do
@@ -29,3 +35,7 @@ ActionController::TestCase.class_eval do
     @routes = TestHelper::Routes
   end
 end
+
+def def_serializer(&block)
+  Class.new(ActiveModel::Serializer, &block)
+end