cheap_ams 0.10.0.rc2

data/test/action_controller/serialization_test.rb

@@ -0,0 +1,426 @@
+
+require 'test_helper'
+
+module ActionController
+  module Serialization
+    class ImplicitSerializerTest < ActionController::TestCase
+      include ActiveSupport::Testing::Stream
+      class ImplicitSerializationTestController < ActionController::Base
+        def render_using_implicit_serializer
+          @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+          render json: @profile
+        end
+
+        def render_using_default_adapter_root
+          with_adapter ActiveModel::Serializer::Adapter::JsonApi do
+            # JSON-API adapter sets root by default
+            @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+            render json: @profile
+          end
+        end
+
+        def render_array_using_custom_root
+          with_adapter ActiveModel::Serializer::Adapter::Json do
+            @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+            render json: [@profile], root: "custom_root"
+          end
+        end
+
+        def render_array_that_is_empty_using_custom_root
+          with_adapter ActiveModel::Serializer::Adapter::Json do
+            render json: [], root: "custom_root"
+          end
+        end
+
+        def render_object_using_custom_root
+          with_adapter ActiveModel::Serializer::Adapter::Json do
+            @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+            render json: @profile, root: "custom_root"
+          end
+        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
+        end
+
+        def render_array_using_implicit_serializer_and_meta
+          with_adapter ActiveModel::Serializer::Adapter::JsonApi do
+
+            @profiles = [
+              Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+            ]
+
+            render json: @profiles, meta: { total: 10 }
+          end
+        end
+
+        def render_object_with_cache_enabled
+          @comment = Comment.new({ id: 1, body: 'ZOMG A COMMENT' })
+          @author  = Author.new(id: 1, name: 'Joao Moura.')
+          @post    = Post.new({ id: 1, title: 'New Post', body: 'Body', comments: [@comment], author: @author })
+
+          generate_cached_serializer(@post)
+
+          @post.title = 'ZOMG a New Post'
+          render json: @post
+        end
+
+        def render_json_object_without_serializer
+          render json: {error: 'Result is Invalid'}
+        end
+
+        def render_json_array_object_without_serializer
+          render json: [{error: 'Result is Invalid'}]
+        end
+
+        def update_and_render_object_with_cache_enabled
+          @post.updated_at = Time.now
+
+          generate_cached_serializer(@post)
+          render json: @post
+        end
+
+        def render_object_expired_with_cache_enabled
+          comment = Comment.new({ id: 1, body: 'ZOMG A COMMENT' })
+          author = Author.new(id: 1, name: 'Joao Moura.')
+          post = Post.new({ id: 1, title: 'New Post', body: 'Body', comments: [comment], author: author })
+
+          generate_cached_serializer(post)
+
+          post.title = 'ZOMG a New Post'
+          sleep 0.1
+          render json: post
+        end
+
+        def render_changed_object_with_cache_enabled
+          comment = Comment.new({ id: 1, body: 'ZOMG A COMMENT' })
+          author = Author.new(id: 1, name: 'Joao Moura.')
+          post = Post.new({ id: 1, title: 'ZOMG a New Post', body: 'Body', comments: [comment], author: author })
+
+          render json: post
+        end
+
+        def render_fragment_changed_object_with_only_cache_enabled
+          author = Author.new(id: 1, name: 'Joao Moura.')
+          role = Role.new({ id: 42, name: 'ZOMG A ROLE', description: 'DESCRIPTION HERE', author: author })
+
+          generate_cached_serializer(role)
+          role.name = 'lol'
+          role.description = 'HUEHUEBRBR'
+
+          render json: role
+        end
+
+        def render_fragment_changed_object_with_except_cache_enabled
+          author = Author.new(id: 1, name: 'Joao Moura.')
+          bio = Bio.new({ id: 42, content: 'ZOMG A ROLE', rating: 5, author: author })
+
+          generate_cached_serializer(bio)
+          bio.content = 'lol'
+          bio.rating = 0
+
+          render json: bio
+        end
+
+        def render_fragment_changed_object_with_relationship
+          comment = Comment.new({ id: 1, body: 'ZOMG A COMMENT' })
+          comment2 = Comment.new({ id: 1, body: 'ZOMG AN UPDATED-BUT-NOT-CACHE-EXPIRED COMMENT' })
+          like = Like.new({ id: 1, likeable: comment, time: 3.days.ago })
+
+          generate_cached_serializer(like)
+          like.likable = comment2
+          like.time = Time.now.to_s
+
+          render json: like
+        end
+
+        private
+        def generate_cached_serializer(obj)
+          ActiveModel::SerializableResource.new(obj).to_json
+        end
+
+        def with_adapter(adapter)
+          old_adapter = ActiveModel::Serializer.config.adapter
+          # JSON-API adapter sets root by default
+          ActiveModel::Serializer.config.adapter = adapter
+          yield
+        ensure
+          ActiveModel::Serializer.config.adapter = old_adapter
+        end
+      end
+
+      tests ImplicitSerializationTestController
+
+      # We just have Null for now, this will change
+      def test_render_using_implicit_serializer
+        get :render_using_implicit_serializer
+
+        expected = {
+          name: "Name 1",
+          description: "Description 1"
+        }
+
+        assert_equal 'application/json', @response.content_type
+        assert_equal expected.to_json, @response.body
+      end
+
+      def test_render_using_default_root
+        get :render_using_default_adapter_root
+
+        expected = {
+          data: {
+            id: assigns(:profile).id.to_s,
+            type: "profiles",
+            attributes: {
+              name: "Name 1",
+              description: "Description 1"
+            }
+          }
+        }
+
+        assert_equal 'application/json', @response.content_type
+        assert_equal expected.to_json, @response.body
+      end
+
+      def test_render_array_using_custom_root
+        get :render_array_using_custom_root
+
+        expected =  {custom_roots: [{name: "Name 1", description: "Description 1"}]}
+        assert_equal 'application/json', @response.content_type
+        assert_equal expected.to_json, @response.body
+      end
+
+      def test_render_array_that_is_empty_using_custom_root
+        get :render_array_that_is_empty_using_custom_root
+
+        expected =  {custom_roots: []}
+        assert_equal 'application/json', @response.content_type
+        assert_equal expected.to_json, @response.body
+      end
+
+      def test_render_object_using_custom_root
+        get :render_object_using_custom_root
+
+        expected =  {custom_root: {name: "Name 1", description: "Description 1"}}
+        assert_equal 'application/json', @response.content_type
+        assert_equal expected.to_json, @response.body
+      end
+
+      def test_render_json_object_without_serializer
+        get :render_json_object_without_serializer
+
+        assert_equal 'application/json', @response.content_type
+        expected_body = {error: 'Result is Invalid'}
+        assert_equal expected_body.to_json, @response.body
+      end
+
+      def test_render_json_array_object_without_serializer
+        get :render_json_array_object_without_serializer
+
+        assert_equal 'application/json', @response.content_type
+        expected_body = [{error: 'Result is Invalid'}]
+        assert_equal expected_body.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',
+            description: 'Description 1',
+          },
+          {
+            name: 'Name 2',
+            description: 'Description 2',
+          }
+        ]
+
+        assert_equal expected.to_json, @response.body
+      end
+
+      def test_render_array_using_implicit_serializer_and_meta
+        get :render_array_using_implicit_serializer_and_meta
+
+        expected = {
+          data: [
+            {
+              id: assigns(:profiles).first.id.to_s,
+              type: "profiles",
+              attributes: {
+                name: "Name 1",
+                description: "Description 1"
+              }
+            }
+          ],
+          meta: {
+            total: 10
+          }
+        }
+
+        assert_equal 'application/json', @response.content_type
+        assert_equal expected.to_json, @response.body
+      end
+
+      def test_render_with_cache_enable
+        expected = {
+          id: 1,
+          title: 'New Post',
+          body: 'Body',
+          comments: [
+            {
+              id: 1,
+              body: 'ZOMG A COMMENT' }
+          ],
+          blog: {
+            id: 999,
+            name: 'Custom blog'
+          },
+          author: {
+            id: 1,
+            name: 'Joao Moura.'
+          }
+        }
+
+        ActionController::Base.cache_store.clear
+        Timecop.freeze(Time.now) do
+          get :render_object_with_cache_enabled
+
+          assert_equal 'application/json', @response.content_type
+          assert_equal expected.to_json, @response.body
+
+          get :render_changed_object_with_cache_enabled
+          assert_equal expected.to_json, @response.body
+        end
+
+        ActionController::Base.cache_store.clear
+        get :render_changed_object_with_cache_enabled
+        assert_not_equal expected.to_json, @response.body
+      end
+
+      def test_render_with_cache_enable_and_expired
+        ActionController::Base.cache_store.clear
+        get :render_object_expired_with_cache_enabled
+
+        expected = {
+          id: 1,
+          title: 'ZOMG a New Post',
+          body: 'Body',
+          comments: [
+            {
+              id: 1,
+              body: 'ZOMG A COMMENT' }
+          ],
+          blog: {
+            id: 999,
+            name: 'Custom blog'
+          },
+          author: {
+            id: 1,
+            name: 'Joao Moura.'
+          }
+        }
+
+        assert_equal 'application/json', @response.content_type
+        assert_equal expected.to_json, @response.body
+      end
+
+      def test_render_with_fragment_only_cache_enable
+        ActionController::Base.cache_store.clear
+        get :render_fragment_changed_object_with_only_cache_enabled
+        response = JSON.parse(@response.body)
+
+        assert_equal 'application/json', @response.content_type
+        assert_equal 'ZOMG A ROLE', response["name"]
+        assert_equal 'HUEHUEBRBR', response["description"]
+      end
+
+      def test_render_with_fragment_except_cache_enable
+        ActionController::Base.cache_store.clear
+        get :render_fragment_changed_object_with_except_cache_enabled
+        response = JSON.parse(@response.body)
+
+        assert_equal 'application/json', @response.content_type
+        assert_equal 5, response["rating"]
+        assert_equal 'lol', response["content"]
+      end
+
+      def test_render_fragment_changed_object_with_relationship
+        ActionController::Base.cache_store.clear
+
+        Timecop.freeze(Time.now) do
+          get :render_fragment_changed_object_with_relationship
+          response = JSON.parse(@response.body)
+
+          expected_return = {
+            "id"=>1,
+            "time"=>Time.now.to_s,
+            "likeable" => {
+              "id"=>1,
+              "body"=>"ZOMG A COMMENT"
+            }
+          }
+
+          assert_equal 'application/json', @response.content_type
+          assert_equal expected_return, response
+        end
+      end
+
+      def test_cache_expiration_on_update
+        ActionController::Base.cache_store.clear
+        get :render_object_with_cache_enabled
+
+        expected = {
+          id: 1,
+          title: 'ZOMG a New Post',
+          body: 'Body',
+          comments: [
+            {
+              id: 1,
+              body: 'ZOMG A COMMENT' }
+          ],
+          blog: {
+            id:999,
+            name: "Custom blog"
+          },
+          author: {
+            id: 1,
+            name: 'Joao Moura.'
+          }
+        }
+
+        get :update_and_render_object_with_cache_enabled
+
+        assert_equal 'application/json', @response.content_type
+        assert_equal expected.to_json, @response.body
+      end
+
+      def test_warn_overridding_use_adapter_as_falsy_on_controller_instance
+        controller = Class.new(ImplicitSerializationTestController) {
+          def use_adapter?
+            false
+          end
+        }.new
+        assert_match(/adapter: false/, (capture(:stderr) {
+          controller.get_serializer(Profile.new)
+        }))
+      end
+
+      def test_dont_warn_overridding_use_adapter_as_truthy_on_controller_instance
+        controller = Class.new(ImplicitSerializationTestController) {
+          def use_adapter?
+            true
+          end
+        }.new
+        assert_equal "", (capture(:stderr) {
+          controller.get_serializer(Profile.new)
+        })
+      end
+    end
+  end
+end

data/test/adapter/fragment_cache_test.rb

@@ -0,0 +1,37 @@
+require 'test_helper'
+module ActiveModel
+  class Serializer
+    class Adapter
+      class FragmentCacheTest < Minitest::Test
+        def setup
+          @spam            = Spam::UnrelatedLink.new(id: "spam-id-1")
+          @author          = Author.new(name: 'Joao M. D. Moura')
+          @role            = Role.new(name: 'Great Author', description:nil)
+          @role.author     = [@author]
+          @role_serializer = RoleSerializer.new(@role)
+          @spam_serializer = Spam::UnrelatedLinkSerializer.new(@spam)
+          @role_hash       = FragmentCache.new(RoleSerializer.adapter.new(@role_serializer), @role_serializer, {})
+          @spam_hash       = FragmentCache.new(Spam::UnrelatedLinkSerializer.adapter.new(@spam_serializer), @spam_serializer, {})
+        end
+
+        def test_fragment_fetch_with_virtual_attributes
+          expected_result = {
+            id: @role.id,
+            description: @role.description,
+            slug: "#{@role.name}-#{@role.id}",
+            name: @role.name
+          }
+          assert_equal(@role_hash.fetch, expected_result)
+        end
+
+        def test_fragment_fetch_with_namespaced_object
+          expected_result = {
+            id: @spam.id
+          }
+          assert_equal(@spam_hash.fetch, expected_result)
+        end
+      end
+    end
+  end
+end
+

data/test/adapter/json/belongs_to_test.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class Adapter
+      class Json
+        class BelongsToTest < Minitest::Test
+          def setup
+            @post = Post.new(id: 42, title: 'New Post', body: 'Body')
+            @anonymous_post = Post.new(id: 43, title: 'Hello!!', body: 'Hello, world!!')
+            @comment = Comment.new(id: 1, body: 'ZOMG A COMMENT')
+            @post.comments = [@comment]
+            @anonymous_post.comments = []
+            @comment.post = @post
+            @comment.author = nil
+            @anonymous_post.author = nil
+            @blog = Blog.new(id: 1, name: "My Blog!!")
+            @post.blog = @blog
+            @anonymous_post.blog = nil
+
+            @serializer = CommentSerializer.new(@comment)
+            @adapter = ActiveModel::Serializer::Adapter::Json.new(@serializer)
+            ActionController::Base.cache_store.clear
+          end
+
+          def test_includes_post
+            assert_equal({id: 42, title: 'New Post', body: 'Body'}, @adapter.serializable_hash[:comment][:post])
+          end
+
+          def test_include_nil_author
+            serializer = PostSerializer.new(@anonymous_post)
+            adapter = ActiveModel::Serializer::Adapter::Json.new(serializer)
+
+            assert_equal({post: {title: "Hello!!", body: "Hello, world!!", id: 43, comments: [], blog: {id: 999, name: "Custom blog"}, author: nil}}, adapter.serializable_hash)
+          end
+
+          def test_include_nil_author_with_specified_serializer
+            serializer = PostPreviewSerializer.new(@anonymous_post)
+            adapter = ActiveModel::Serializer::Adapter::Json.new(serializer)
+
+            assert_equal({post: {title: "Hello!!", body: "Hello, world!!", id: 43, comments: [], author: nil}}, adapter.serializable_hash)
+          end
+        end
+      end
+    end
+  end
+end

data/test/adapter/json/collection_test.rb

@@ -0,0 +1,82 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class Adapter
+      class Json
+        class Collection < Minitest::Test
+          def setup
+            @author = Author.new(id: 1, name: 'Steve K.')
+            @first_post = Post.new(id: 1, title: 'Hello!!', body: 'Hello, world!!')
+            @second_post = Post.new(id: 2, title: 'New Post', body: 'Body')
+            @first_post.comments = []
+            @second_post.comments = []
+            @first_post.author = @author
+            @second_post.author = @author
+            @blog = Blog.new(id: 1, name: "My Blog!!")
+            @first_post.blog = @blog
+            @second_post.blog = nil
+
+            ActionController::Base.cache_store.clear
+          end
+
+          def test_with_serializer_option
+            @blog.special_attribute = "Special"
+            @blog.articles = [@first_post, @second_post]
+            serializer = ArraySerializer.new([@blog], serializer: CustomBlogSerializer)
+            adapter = ActiveModel::Serializer::Adapter::Json.new(serializer)
+
+            expected = {blogs:[{
+              id: 1,
+              special_attribute: "Special",
+              articles: [{id: 1,title: "Hello!!", body: "Hello, world!!"}, {id: 2, title: "New Post", body: "Body"}]
+            }]}
+            assert_equal expected, adapter.serializable_hash
+          end
+
+          def test_include_multiple_posts
+            serializer = ArraySerializer.new([@first_post, @second_post])
+            adapter = ActiveModel::Serializer::Adapter::Json.new(serializer)
+
+            expected = { posts: [{
+              title: "Hello!!",
+              body: "Hello, world!!",
+              id: 1,
+              comments: [],
+              author: {
+                id: 1,
+                name: "Steve K."
+              },
+              blog: {
+                id: 999,
+                name: "Custom blog"
+              }
+            }, {
+              title: "New Post",
+              body: "Body",
+              id: 2,
+              comments: [],
+              author: {
+                id: 1,
+                name: "Steve K."
+              },
+              blog: {
+                id: 999,
+                name: "Custom blog"
+              }
+            }]}
+            assert_equal expected, adapter.serializable_hash
+          end
+
+          def test_root_is_underscored
+            virtual_value = VirtualValue.new(id: 1)
+            serializer = ArraySerializer.new([virtual_value])
+            adapter = ActiveModel::Serializer::Adapter::Json.new(serializer)
+
+            assert_equal 1, adapter.serializable_hash[:virtual_values].length
+          end
+        end
+      end
+    end
+  end
+end

data/test/adapter/json/has_many_test.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class Adapter
+      class Json
+        class HasManyTestTest < Minitest::Test
+          def setup
+            ActionController::Base.cache_store.clear
+            @author = Author.new(id: 1, name: 'Steve K.')
+            @post = Post.new(id: 42, 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
+            @second_comment.post = @post
+            @blog = Blog.new(id: 1, name: "My Blog!!")
+            @post.blog = @blog
+            @tag = Tag.new(id: 1, name: "#hash_tag")
+            @post.tags = [@tag]
+          end
+
+          def test_has_many
+            serializer = PostSerializer.new(@post)
+            adapter = ActiveModel::Serializer::Adapter::Json.new(serializer)
+            assert_equal([
+                           {id: 1, body: 'ZOMG A COMMENT'},
+                           {id: 2, body: 'ZOMG ANOTHER COMMENT'}
+                         ], adapter.serializable_hash[:post][:comments])
+          end
+
+          def test_has_many_with_no_serializer
+            serializer = PostWithTagsSerializer.new(@post)
+            adapter = ActiveModel::Serializer::Adapter::Json.new(serializer)
+            assert_equal({
+              id: 42,
+              tags: [
+                {"attributes"=>{"id"=>1, "name"=>"#hash_tag"}}
+              ]
+            }.to_json, adapter.serializable_hash[:post].to_json)
+          end
+        end
+      end
+    end
+  end
+end