active_model_serializers 0.10.0.rc4 → 0.10.0.rc5

data/test/adapter/json_api/links_test.rb

@@ -1,66 +1,91 @@
 require 'test_helper'
 
-module ActiveModel
-  class Serializer
-    module Adapter
-      class JsonApi
-        class LinksTest < ActiveSupport::TestCase
-          LinkAuthor = Class.new(::Model)
-          class LinkAuthorSerializer < ActiveModel::Serializer
-            link :self do
-              href "//example.com/link_author/#{object.id}"
-              meta stuff: 'value'
-            end
-
-            link :other, '//example.com/resource'
-
-            link :yet_another do
-              "//example.com/resource/#{object.id}"
-            end
+module ActiveModelSerializers
+  module Adapter
+    class JsonApi
+      class LinksTest < ActiveSupport::TestCase
+        LinkAuthor = Class.new(::Model)
+        class LinkAuthorSerializer < ActiveModel::Serializer
+          link :self do
+            href "http://example.com/link_author/#{object.id}"
+            meta stuff: 'value'
+          end
+          link(:author) { link_author_url(object.id) }
+          link(:link_authors) { url_for(controller: 'link_authors', action: 'index', only_path: false) }
+          link(:posts) { link_author_posts_url(object.id) }
+          link :resource, 'http://example.com/resource'
+          link :yet_another do
+            "http://example.com/resource/#{object.id}"
           end
+        end
 
-          def setup
-            @post = Post.new(id: 1337, comments: [], author: nil)
-            @author = LinkAuthor.new(id: 1337)
+        def setup
+          Rails.application.routes.draw do
+            resources :link_authors do
+              resources :posts
+            end
           end
+          @post = Post.new(id: 1337, comments: [], author: nil)
+          @author = LinkAuthor.new(id: 1337, posts: [@post])
+        end
 
-          def test_toplevel_links
-            hash = ActiveModel::SerializableResource.new(
-              @post,
-              adapter: :json_api,
-              links: {
-                self: {
-                  href: '//example.com/posts',
-                  meta: {
-                    stuff: 'value'
-                  }
-                }
-              }).serializable_hash
-            expected = {
+        def test_toplevel_links
+          hash = ActiveModelSerializers::SerializableResource.new(
+            @post,
+            adapter: :json_api,
+            links: {
               self: {
-                href: '//example.com/posts',
+                href: 'http://example.com/posts',
                 meta: {
                   stuff: 'value'
                 }
               }
+            }).serializable_hash
+          expected = {
+            self: {
+              href: 'http://example.com/posts',
+              meta: {
+                stuff: 'value'
+              }
             }
-            assert_equal(expected, hash[:links])
-          end
+          }
+          assert_equal(expected, hash[:links])
+        end
 
-          def test_resource_links
-            hash = serializable(@author, adapter: :json_api).serializable_hash
-            expected = {
-              self: {
-                href: '//example.com/link_author/1337',
-                meta: {
-                  stuff: 'value'
-                }
-              },
-              other: '//example.com/resource',
-              yet_another: '//example.com/resource/1337'
-            }
-            assert_equal(expected, hash[:data][:links])
-          end
+        def test_nil_toplevel_links
+          hash = ActiveModelSerializers::SerializableResource.new(
+            @post,
+            adapter: :json_api,
+            links: nil
+          ).serializable_hash
+          refute hash.key?(:links), 'No links key to be output'
+        end
+
+        def test_nil_toplevel_links_json_adapter
+          hash = ActiveModelSerializers::SerializableResource.new(
+            @post,
+            adapter: :json,
+            links: nil
+          ).serializable_hash
+          refute hash.key?(:links), 'No links key to be output'
+        end
+
+        def test_resource_links
+          hash = serializable(@author, adapter: :json_api).serializable_hash
+          expected = {
+            self: {
+              href: 'http://example.com/link_author/1337',
+              meta: {
+                stuff: 'value'
+              }
+            },
+            author: 'http://example.com/link_authors/1337',
+            :"link-authors" => 'http://example.com/link_authors',
+            resource: 'http://example.com/resource',
+            posts: 'http://example.com/link_authors/1337/posts',
+            :"yet-another" => 'http://example.com/resource/1337'
+          }
+          assert_equal(expected, hash[:data][:links])
         end
       end
     end

data/test/adapter/json_api/pagination_links_test.rb

@@ -4,110 +4,143 @@ require 'kaminari'
 require 'kaminari/hooks'
 ::Kaminari::Hooks.init
 
-module ActiveModel
-  class Serializer
-    module Adapter
-      class JsonApi
-        class PaginationLinksTest < ActiveSupport::TestCase
-          URI = 'http://example.com'
-
-          def setup
-            ActionController::Base.cache_store.clear
-            @array = [
-              Profile.new({ id: 1, name: 'Name 1', description: 'Description 1', comments: 'Comments 1' }),
-              Profile.new({ id: 2, name: 'Name 2', description: 'Description 2', comments: 'Comments 2' }),
-              Profile.new({ id: 3, name: 'Name 3', description: 'Description 3', comments: 'Comments 3' })
-            ]
-          end
+module ActiveModelSerializers
+  module Adapter
+    class JsonApi
+      class PaginationLinksTest < ActiveSupport::TestCase
+        URI = 'http://example.com'.freeze
+
+        def setup
+          ActionController::Base.cache_store.clear
+          @array = [
+            Profile.new({ id: 1, name: 'Name 1', description: 'Description 1', comments: 'Comments 1' }),
+            Profile.new({ id: 2, name: 'Name 2', description: 'Description 2', comments: 'Comments 2' }),
+            Profile.new({ id: 3, name: 'Name 3', description: 'Description 3', comments: 'Comments 3' }),
+            Profile.new({ id: 4, name: 'Name 4', description: 'Description 4', comments: 'Comments 4' }),
+            Profile.new({ id: 5, name: 'Name 5', description: 'Description 5', comments: 'Comments 5' })
+          ]
+        end
 
-          def mock_request(query_parameters = {}, original_url = URI)
-            context = Minitest::Mock.new
-            context.expect(:request_url, original_url)
-            context.expect(:query_parameters, query_parameters)
-            @options = {}
-            @options[:serialization_context] = context
-          end
+        def mock_request(query_parameters = {}, original_url = URI)
+          context = Minitest::Mock.new
+          context.expect(:request_url, original_url)
+          context.expect(:query_parameters, query_parameters)
+          @options = {}
+          @options[:serialization_context] = context
+        end
 
-          def load_adapter(paginated_collection, options = {})
-            options = options.merge(adapter: :json_api)
-            ActiveModel::SerializableResource.new(paginated_collection, options)
-          end
+        def load_adapter(paginated_collection, options = {})
+          options = options.merge(adapter: :json_api)
+          ActiveModelSerializers::SerializableResource.new(paginated_collection, options)
+        end
 
-          def using_kaminari
-            Kaminari.paginate_array(@array).page(2).per(1)
-          end
+        def using_kaminari(page = 2)
+          Kaminari.paginate_array(@array).page(page).per(2)
+        end
 
-          def using_will_paginate
-            @array.paginate(page: 2, per_page: 1)
-          end
+        def using_will_paginate(page = 2)
+          @array.paginate(page: page, per_page: 2)
+        end
+
+        def data
+          { data: [
+              { id: '1', type: 'profiles', attributes: { name: 'Name 1', description: 'Description 1' } },
+              { id: '2', type: 'profiles', attributes: { name: 'Name 2', description: 'Description 2' } },
+              { id: '3', type: 'profiles', attributes: { name: 'Name 3', description: 'Description 3' } },
+              { id: '4', type: 'profiles', attributes: { name: 'Name 4', description: 'Description 4' } },
+              { id: '5', type: 'profiles', attributes: { name: 'Name 5', description: 'Description 5' } }
+            ]
+          }
+        end
 
-          def data
-            { data: [
-                { id: '1', type: 'profiles', attributes: { name: 'Name 1', description: 'Description 1' } },
-                { id: '2', type: 'profiles', attributes: { name: 'Name 2', description: 'Description 2' } },
-                { id: '3', type: 'profiles', attributes: { name: 'Name 3', description: 'Description 3' } }
-              ]
+        def links
+          {
+            links: {
+              self: "#{URI}?page%5Bnumber%5D=2&page%5Bsize%5D=2",
+              first: "#{URI}?page%5Bnumber%5D=1&page%5Bsize%5D=2",
+              prev: "#{URI}?page%5Bnumber%5D=1&page%5Bsize%5D=2",
+              next: "#{URI}?page%5Bnumber%5D=3&page%5Bsize%5D=2",
+              last: "#{URI}?page%5Bnumber%5D=3&page%5Bsize%5D=2"
             }
-          end
+          }
+        end
 
-          def links
-            {
-              links: {
-                self: "#{URI}?page%5Bnumber%5D=2&page%5Bsize%5D=1",
-                first: "#{URI}?page%5Bnumber%5D=1&page%5Bsize%5D=1",
-                prev: "#{URI}?page%5Bnumber%5D=1&page%5Bsize%5D=1",
-                next: "#{URI}?page%5Bnumber%5D=3&page%5Bsize%5D=1",
-                last: "#{URI}?page%5Bnumber%5D=3&page%5Bsize%5D=1"
-              }
+        def last_page_links
+          {
+            links: {
+              self: "#{URI}?page%5Bnumber%5D=3&page%5Bsize%5D=2",
+              first: "#{URI}?page%5Bnumber%5D=1&page%5Bsize%5D=2",
+              prev: "#{URI}?page%5Bnumber%5D=2&page%5Bsize%5D=2"
             }
-          end
+          }
+        end
 
-          def expected_response_without_pagination_links
-            data
+        def expected_response_without_pagination_links
+          data
+        end
+
+        def expected_response_with_pagination_links
+          {}.tap do |hash|
+            hash[:data] = data.values.flatten[2..3]
+            hash.merge! links
           end
+        end
 
-          def expected_response_with_pagination_links
-            {}.tap do |hash|
-              hash[:data] = [data.values.flatten.second]
-              hash.merge! links
-            end
+        def expected_response_with_pagination_links_and_additional_params
+          new_links = links[:links].each_with_object({}) { |(key, value), hash| hash[key] = "#{value}&test=test" }
+          {}.tap do |hash|
+            hash[:data] = data.values.flatten[2..3]
+            hash.merge! links: new_links
           end
+        end
 
-          def expected_response_with_pagination_links_and_additional_params
-            new_links = links[:links].each_with_object({}) { |(key, value), hash| hash[key] = "#{value}&test=test" }
-            {}.tap do |hash|
-              hash[:data] = [data.values.flatten.second]
-              hash.merge! links: new_links
-            end
+        def expected_response_with_last_page_pagination_links
+          {}.tap do |hash|
+            hash[:data] = [data.values.flatten.last]
+            hash.merge! last_page_links
           end
+        end
 
-          def test_pagination_links_using_kaminari
-            adapter = load_adapter(using_kaminari)
+        def test_pagination_links_using_kaminari
+          adapter = load_adapter(using_kaminari)
 
-            mock_request
-            assert_equal expected_response_with_pagination_links, adapter.serializable_hash(@options)
-          end
+          mock_request
+          assert_equal expected_response_with_pagination_links, adapter.serializable_hash(@options)
+        end
 
-          def test_pagination_links_using_will_paginate
-            adapter = load_adapter(using_will_paginate)
+        def test_pagination_links_using_will_paginate
+          adapter = load_adapter(using_will_paginate)
 
-            mock_request
-            assert_equal expected_response_with_pagination_links, adapter.serializable_hash(@options)
-          end
+          mock_request
+          assert_equal expected_response_with_pagination_links, adapter.serializable_hash(@options)
+        end
 
-          def test_pagination_links_with_additional_params
-            adapter = load_adapter(using_will_paginate)
+        def test_pagination_links_with_additional_params
+          adapter = load_adapter(using_will_paginate)
 
-            mock_request({ test: 'test' })
-            assert_equal expected_response_with_pagination_links_and_additional_params,
-              adapter.serializable_hash(@options)
-          end
+          mock_request({ test: 'test' })
+          assert_equal expected_response_with_pagination_links_and_additional_params,
+            adapter.serializable_hash(@options)
+        end
 
-          def test_not_showing_pagination_links
-            adapter = load_adapter(@array)
+        def test_last_page_pagination_links_using_kaminari
+          adapter = load_adapter(using_kaminari(3))
 
-            assert_equal expected_response_without_pagination_links, adapter.serializable_hash
-          end
+          mock_request
+          assert_equal expected_response_with_last_page_pagination_links, adapter.serializable_hash(@options)
+        end
+
+        def test_last_page_pagination_links_using_will_paginate
+          adapter = load_adapter(using_will_paginate(3))
+
+          mock_request
+          assert_equal expected_response_with_last_page_pagination_links, adapter.serializable_hash(@options)
+        end
+
+        def test_not_showing_pagination_links
+          adapter = load_adapter(@array)
+
+          assert_equal expected_response_without_pagination_links, adapter.serializable_hash
         end
       end
     end

data/test/adapter/json_api/parse_test.rb

@@ -1,136 +1,134 @@
 require 'test_helper'
-module ActiveModel
-  class Serializer
-    module Adapter
-      class JsonApi
-        module Deserialization
-          class ParseTest < Minitest::Test
-            def setup
-              @hash = {
-                'data' => {
-                  'type' => 'photos',
-                  'id' => 'zorglub',
-                  'attributes' => {
-                    'title' => 'Ember Hamster',
-                    'src' => 'http://example.com/images/productivity.png'
+module ActiveModelSerializers
+  module Adapter
+    class JsonApi
+      module Deserialization
+        class ParseTest < Minitest::Test
+          def setup
+            @hash = {
+              'data' => {
+                'type' => 'photos',
+                'id' => 'zorglub',
+                'attributes' => {
+                  'title' => 'Ember Hamster',
+                  'src' => 'http://example.com/images/productivity.png'
+                },
+                'relationships' => {
+                  'author' => {
+                    'data' => nil
                   },
-                  'relationships' => {
-                    'author' => {
-                      'data' => nil
-                    },
-                    'photographer' => {
-                      'data' => { 'type' => 'people', 'id' => '9' }
-                    },
-                    'comments' => {
-                      'data' => [
-                        { 'type' => 'comments', 'id' => '1' },
-                        { 'type' => 'comments', 'id' => '2' }
-                      ]
-                    }
+                  'photographer' => {
+                    'data' => { 'type' => 'people', 'id' => '9' }
+                  },
+                  'comments' => {
+                    'data' => [
+                      { 'type' => 'comments', 'id' => '1' },
+                      { 'type' => 'comments', 'id' => '2' }
+                    ]
                   }
                 }
               }
-              @params = ActionController::Parameters.new(@hash)
-              @expected = {
-                id: 'zorglub',
-                title: 'Ember Hamster',
-                src: 'http://example.com/images/productivity.png',
-                author_id: nil,
-                photographer_id: '9',
-                comment_ids: %w(1 2)
-              }
+            }
+            @params = ActionController::Parameters.new(@hash)
+            @expected = {
+              id: 'zorglub',
+              title: 'Ember Hamster',
+              src: 'http://example.com/images/productivity.png',
+              author_id: nil,
+              photographer_id: '9',
+              comment_ids: %w(1 2)
+            }
 
-              @illformed_payloads = [nil,
-                                     {},
-                                     {
-                                       'data' => nil
-                                     }, {
-                                       'data' => { 'attributes' => [] }
-                                     }, {
-                                       'data' => { 'relationships' => [] }
-                                     }, {
-                                       'data' => {
-                                         'relationships' => { 'rel' => nil }
-                                       }
-                                     }, {
-                                       'data' => {
-                                         'relationships' => { 'rel' => {} }
-                                       }
-                                     }]
-            end
+            @illformed_payloads = [nil,
+                                   {},
+                                   {
+                                     'data' => nil
+                                   }, {
+                                     'data' => { 'attributes' => [] }
+                                   }, {
+                                     'data' => { 'relationships' => [] }
+                                   }, {
+                                     'data' => {
+                                       'relationships' => { 'rel' => nil }
+                                     }
+                                   }, {
+                                     'data' => {
+                                       'relationships' => { 'rel' => {} }
+                                     }
+                                   }]
+          end
 
-            def test_hash
-              parsed_hash = ActiveModel::Serializer::Adapter::JsonApi::Deserialization.parse!(@hash)
-              assert_equal(@expected, parsed_hash)
-            end
+          def test_hash
+            parsed_hash = ActiveModelSerializers::Adapter::JsonApi::Deserialization.parse!(@hash)
+            assert_equal(@expected, parsed_hash)
+          end
 
-            def test_actioncontroller_parameters
-              assert_equal(false, @params.permitted?)
-              parsed_hash = ActiveModel::Serializer::Adapter::JsonApi::Deserialization.parse!(@params)
-              assert_equal(@expected, parsed_hash)
-            end
+          def test_actioncontroller_parameters
+            assert_equal(false, @params.permitted?)
+            parsed_hash = ActiveModelSerializers::Adapter::JsonApi::Deserialization.parse!(@params)
+            assert_equal(@expected, parsed_hash)
+          end
 
-            def test_illformed_payloads_safe
-              @illformed_payloads.each do |p|
-                parsed_hash = ActiveModel::Serializer::Adapter::JsonApi::Deserialization.parse(p)
-                assert_equal({}, parsed_hash)
-              end
+          def test_illformed_payloads_safe
+            @illformed_payloads.each do |p|
+              parsed_hash = ActiveModelSerializers::Adapter::JsonApi::Deserialization.parse(p)
+              assert_equal({}, parsed_hash)
             end
+          end
 
-            def test_illformed_payloads_unsafe
-              @illformed_payloads.each do |p|
-                assert_raises(InvalidDocument) do
-                  ActiveModel::Serializer::Adapter::JsonApi::Deserialization.parse!(p)
-                end
+          def test_illformed_payloads_unsafe
+            @illformed_payloads.each do |p|
+              assert_raises(InvalidDocument) do
+                ActiveModelSerializers::Adapter::JsonApi::Deserialization.parse!(p)
               end
             end
+          end
 
-            def test_filter_fields_only
-              parsed_hash = ActiveModel::Serializer::Adapter::JsonApi::Deserialization.parse!(@hash, only: [:id, :title, :author])
-              expected = {
-                id: 'zorglub',
-                title: 'Ember Hamster',
-                author_id: nil
-              }
-              assert_equal(expected, parsed_hash)
-            end
+          def test_filter_fields_only
+            parsed_hash = ActiveModelSerializers::Adapter::JsonApi::Deserialization.parse!(@hash, only: [:id, :title, :author])
+            expected = {
+              id: 'zorglub',
+              title: 'Ember Hamster',
+              author_id: nil
+            }
+            assert_equal(expected, parsed_hash)
+          end
 
-            def test_filter_fields_except
-              parsed_hash = ActiveModel::Serializer::Adapter::JsonApi::Deserialization.parse!(@hash, except: [:id, :title, :author])
-              expected = {
-                src: 'http://example.com/images/productivity.png',
-                photographer_id: '9',
-                comment_ids: %w(1 2)
-              }
-              assert_equal(expected, parsed_hash)
-            end
+          def test_filter_fields_except
+            parsed_hash = ActiveModelSerializers::Adapter::JsonApi::Deserialization.parse!(@hash, except: [:id, :title, :author])
+            expected = {
+              src: 'http://example.com/images/productivity.png',
+              photographer_id: '9',
+              comment_ids: %w(1 2)
+            }
+            assert_equal(expected, parsed_hash)
+          end
 
-            def test_keys
-              parsed_hash = ActiveModel::Serializer::Adapter::JsonApi::Deserialization.parse!(@hash, keys: { author: :user, title: :post_title })
-              expected = {
-                id: 'zorglub',
-                post_title: 'Ember Hamster',
-                src: 'http://example.com/images/productivity.png',
-                user_id: nil,
-                photographer_id: '9',
-                comment_ids: %w(1 2)
-              }
-              assert_equal(expected, parsed_hash)
-            end
+          def test_keys
+            parsed_hash = ActiveModelSerializers::Adapter::JsonApi::Deserialization.parse!(@hash, keys: { author: :user, title: :post_title })
+            expected = {
+              id: 'zorglub',
+              post_title: 'Ember Hamster',
+              src: 'http://example.com/images/productivity.png',
+              user_id: nil,
+              photographer_id: '9',
+              comment_ids: %w(1 2)
+            }
+            assert_equal(expected, parsed_hash)
+          end
 
-            def test_polymorphic
-              parsed_hash = ActiveModel::Serializer::Adapter::JsonApi::Deserialization.parse!(@hash, polymorphic: [:photographer])
-              expected = {
-                id: 'zorglub',
-                title: 'Ember Hamster',
-                src: 'http://example.com/images/productivity.png',
-                author_id: nil,
-                photographer_id: '9',
-                photographer_type: 'people',
-                comment_ids: %w(1 2)
-              }
-              assert_equal(expected, parsed_hash)
-            end
+          def test_polymorphic
+            parsed_hash = ActiveModelSerializers::Adapter::JsonApi::Deserialization.parse!(@hash, polymorphic: [:photographer])
+            expected = {
+              id: 'zorglub',
+              title: 'Ember Hamster',
+              src: 'http://example.com/images/productivity.png',
+              author_id: nil,
+              photographer_id: '9',
+              photographer_type: 'people',
+              comment_ids: %w(1 2)
+            }
+            assert_equal(expected, parsed_hash)
           end
         end
       end