active_model_serializers 0.10.0.rc5 → 0.10.0

data/lib/active_model_serializers/adapter/json_api/pagination_links.rb

@@ -6,24 +6,29 @@ module ActiveModelSerializers
 
         attr_reader :collection, :context
 
-        def initialize(collection, context)
+        def initialize(collection, adapter_options)
           @collection = collection
-          @context = context
+          @adapter_options = adapter_options
+          @context = adapter_options.fetch(:serialization_context)
         end
 
-        def serializable_hash(options = {})
+        def as_json
           per_page = collection.try(:per_page) || collection.try(:limit_value) || collection.size
           pages_from.each_with_object({}) do |(key, value), hash|
             params = query_parameters.merge(page: { number: value, size: per_page }).to_query
 
-            hash[key] = "#{url(options)}?#{params}"
+            hash[key] = "#{url(adapter_options)}?#{params}"
           end
         end
 
+        protected
+
+        attr_reader :adapter_options
+
         private
 
         def pages_from
-          return {} if collection.total_pages == FIRST_PAGE
+          return {} if collection.total_pages <= FIRST_PAGE
 
           {}.tap do |pages|
             pages[:self] = collection.current_page

data/lib/active_model_serializers/adapter/null.rb

@@ -1,8 +1,7 @@
 module ActiveModelSerializers
   module Adapter
     class Null < Base
-      # Since options param is not being used, underscored naming of the param
-      def serializable_hash(_options = nil)
+      def serializable_hash(*)
         {}
       end
     end

data/lib/active_model_serializers/register_jsonapi_renderer.rb

@@ -57,8 +57,9 @@ end
 ActionController::Renderers.add :jsonapi do |json, options|
   json = serialize_jsonapi(json, options).to_json(options) unless json.is_a?(String)
   self.content_type ||= media_type
-  headers.merge! ActiveModelSerializers::Jsonapi::HEADERS[:response]
   self.response_body = json
 end
 
-ActionController::Base.send :include, ActiveModelSerializers::Jsonapi::ControllerSupport
+ActiveSupport.on_load(:action_controller) do
+  include ActiveModelSerializers::Jsonapi::ControllerSupport
+end

data/lib/active_model_serializers/serializable_resource.rb

@@ -2,7 +2,7 @@ require 'set'
 
 module ActiveModelSerializers
   class SerializableResource
-    ADAPTER_OPTION_KEYS = Set.new([:include, :fields, :adapter, :meta, :meta_key, :links])
+    ADAPTER_OPTION_KEYS = Set.new([:include, :fields, :adapter, :meta, :meta_key, :links, :serialization_context, :key_transform])
     include ActiveModelSerializers::Logging
 
     delegate :serializable_hash, :as_json, :to_json, to: :adapter

data/lib/active_model_serializers/test/schema.rb

@@ -10,19 +10,38 @@ module ActiveModelSerializers
       #   get :index
       #   assert_response_schema
       def assert_response_schema(schema_path = nil, message = nil)
-        matcher = AssertResponseSchema.new(schema_path, response, message)
+        matcher = AssertResponseSchema.new(schema_path, request, response, message)
         assert(matcher.call, matcher.message)
       end
 
-      MissingSchema = Class.new(Errno::ENOENT)
-      InvalidSchemaError = Class.new(StandardError)
+      def assert_request_schema(schema_path = nil, message = nil)
+        matcher = AssertRequestSchema.new(schema_path, request, response, message)
+        assert(matcher.call, matcher.message)
+      end
+
+      # May be renamed
+      def assert_request_response_schema(schema_path = nil, message = nil)
+        assert_request_schema(schema_path, message)
+        assert_response_schema(schema_path, message)
+      end
+
+      def assert_schema(payload, schema_path = nil, message = nil)
+        matcher = AssertSchema.new(schema_path, request, response, message, payload)
+        assert(matcher.call, matcher.message)
+      end
 
-      class AssertResponseSchema
-        attr_reader :schema_path, :response, :message
+      MissingSchema = Class.new(Minitest::Assertion)
+      InvalidSchemaError = Class.new(Minitest::Assertion)
 
-        def initialize(schema_path, response, message)
+      class AssertSchema
+        attr_reader :schema_path, :request, :response, :message, :payload
+
+        # Interface may change.
+        def initialize(schema_path, request, response, message, payload = nil)
           require_json_schema!
+          @request = request
           @response = response
+          @payload = payload
           @schema_path = schema_path || schema_path_default
           @message = message
           @document_store = JsonSchema::DocumentStore.new
@@ -32,7 +51,7 @@ module ActiveModelSerializers
         def call
           json_schema.expand_references!(store: document_store)
           status, errors = json_schema.validate(response_body)
-          @message ||= errors.map(&:to_s).to_sentence
+          @message = [message, errors.map(&:to_s).to_sentence].compact.join(': ')
           status
         end
 
@@ -41,11 +60,11 @@ module ActiveModelSerializers
         attr_reader :document_store
 
         def controller_path
-          response.request.filtered_parameters[:controller]
+          request.filtered_parameters[:controller]
         end
 
         def action
-          response.request.filtered_parameters[:action]
+          request.filtered_parameters[:action]
         end
 
         def schema_directory
@@ -68,6 +87,10 @@ module ActiveModelSerializers
           load_json(response.body)
         end
 
+        def request_params
+          request.env['action_dispatch.request.request_parameters']
+        end
+
         def json_schema
           @json_schema ||= JsonSchema.parse!(schema_data)
         end
@@ -98,6 +121,18 @@ module ActiveModelSerializers
           raise LoadError, "You don't have json_schema installed in your application. Please add it to your Gemfile and run bundle install"
         end
       end
+      class AssertResponseSchema < AssertSchema
+        def initialize(*)
+          super
+          @payload = response_body
+        end
+      end
+      class AssertRequestSchema < AssertSchema
+        def initialize(*)
+          super
+          @payload = request_params
+        end
+      end
     end
   end
 end

data/test/action_controller/json_api/transform_test.rb

@@ -60,10 +60,11 @@ module ActionController
           end
 
           def render_resource_with_transform_with_global_config
-            setup_post
             old_transform = ActiveModelSerializers.config.key_transform
+            setup_post
             ActiveModelSerializers.config.key_transform = :camel_lower
             render json: @post, serializer: PostSerializer, adapter: :json_api
+          ensure
             ActiveModelSerializers.config.key_transform = old_transform
           end
         end

data/test/action_controller/serialization_test.rb

@@ -454,13 +454,15 @@ module ActionController
       end
 
       def test_render_event_is_emmited
-        ::ActiveSupport::Notifications.subscribe('render.active_model_serializers') do |name|
+        subscriber = ::ActiveSupport::Notifications.subscribe('render.active_model_serializers') do |name|
           @name = name
         end
 
         get :render_using_implicit_serializer
 
         assert_equal 'render.active_model_serializers', @name
+      ensure
+        ActiveSupport::Notifications.unsubscribe(subscriber) if subscriber
       end
     end
   end

data/test/active_model_serializers/test/schema_test.rb

@@ -54,13 +54,15 @@ module ActiveModelSerializers
 
       def test_that_raises_error_with_a_custom_message_with_a_invalid_schema
         message = 'oh boy the show is broken'
+        exception_message = "#/name: failed schema #/properties/name: For 'properties/name', \"Name 1\" is not an integer. and #/description: failed schema #/properties/description: For 'properties/description', \"Description 1\" is not a boolean."
+        expected_message = "#{message}: #{exception_message}"
 
         get :show
 
         error = assert_raises Minitest::Assertion do
           assert_response_schema(nil, message)
         end
-        assert_equal(message, error.message)
+        assert_equal(expected_message, error.message)
       end
 
       def test_that_assert_with_a_custom_schema
@@ -102,14 +104,14 @@ module ActiveModelSerializers
       end
 
       def test_with_a_non_existent_file
-        message = %r{.* - No Schema file at test/support/schemas/non-existent.json}
+        message = 'No Schema file at test/support/schemas/non-existent.json'
 
         get :show
 
         error = assert_raises ActiveModelSerializers::Test::Schema::MissingSchema do
           assert_response_schema('non-existent.json')
         end
-        assert_match(message, error.message)
+        assert_equal(message, error.message)
       end
 
       def test_that_raises_with_a_invalid_json_body

data/test/active_model_serializers/test/serializer_test.rb

@@ -10,9 +10,8 @@ module ActiveModelSerializers
           render json: Profile.new(name: 'Name 1', description: 'Description 1', comments: 'Comments 1')
         end
 
-        # For Rails4.0
         def render_some_text
-          Rails.version > '4.1' ? render(plain: 'ok') : render(text: 'ok')
+          render(plain: 'ok')
         end
       end
 

data/test/adapter/json/transform_test.rb

@@ -8,9 +8,11 @@ module ActiveModelSerializers
           context = Minitest::Mock.new
           context.expect(:request_url, URI)
           context.expect(:query_parameters, {})
-          @options = {}
-          @options[:key_transform] = key_transform if key_transform
-          @options[:serialization_context] = context
+          options = {}
+          options[:key_transform] = key_transform if key_transform
+          options[:serialization_context] = context
+          serializer = CustomBlogSerializer.new(@blog)
+          @adapter = ActiveModelSerializers::Adapter::Json.new(serializer, options)
         end
 
         Post = Class.new(::Model)
@@ -18,24 +20,22 @@ module ActiveModelSerializers
           attributes :id, :title, :body, :publish_at
         end
 
-        def setup
+        setup do
           ActionController::Base.cache_store.clear
           @blog = Blog.new(id: 1, name: 'My Blog!!', special_attribute: 'neat')
-          serializer = CustomBlogSerializer.new(@blog)
-          @adapter = ActiveModelSerializers::Adapter::Json.new(serializer)
         end
 
         def test_transform_default
           mock_request
           assert_equal({
             blog: { id: 1, special_attribute: 'neat', articles: nil }
-          }, @adapter.serializable_hash(@options))
+          }, @adapter.serializable_hash)
         end
 
         def test_transform_global_config
           mock_request
           result = with_config(key_transform: :camel_lower) do
-            @adapter.serializable_hash(@options)
+            @adapter.serializable_hash
           end
           assert_equal({
             blog: { id: 1, specialAttribute: 'neat', articles: nil }
@@ -45,7 +45,7 @@ module ActiveModelSerializers
         def test_transform_serialization_ctx_overrides_global_config
           mock_request(:camel)
           result = with_config(key_transform: :camel_lower) do
-            @adapter.serializable_hash(@options)
+            @adapter.serializable_hash
           end
           assert_equal({
             Blog: { Id: 1, SpecialAttribute: 'neat', Articles: nil }
@@ -56,7 +56,7 @@ module ActiveModelSerializers
           mock_request(:blam)
           result = nil
           assert_raises NoMethodError do
-            result = @adapter.serializable_hash(@options)
+            result = @adapter.serializable_hash
           end
         end
 
@@ -64,28 +64,28 @@ module ActiveModelSerializers
           mock_request(:dash)
           assert_equal({
             blog: { id: 1, :"special-attribute" => 'neat', articles: nil }
-          }, @adapter.serializable_hash(@options))
+          }, @adapter.serializable_hash)
         end
 
         def test_transform_unaltered
           mock_request(:unaltered)
           assert_equal({
             blog: { id: 1, special_attribute: 'neat', articles: nil }
-          }, @adapter.serializable_hash(@options))
+          }, @adapter.serializable_hash)
         end
 
         def test_transform_camel
           mock_request(:camel)
           assert_equal({
             Blog: { Id: 1, SpecialAttribute: 'neat', Articles: nil }
-          }, @adapter.serializable_hash(@options))
+          }, @adapter.serializable_hash)
         end
 
         def test_transform_camel_lower
           mock_request(:camel_lower)
           assert_equal({
             blog: { id: 1, specialAttribute: 'neat', articles: nil }
-          }, @adapter.serializable_hash(@options))
+          }, @adapter.serializable_hash)
         end
       end
     end

data/test/adapter/json_api/has_many_test.rb

@@ -131,8 +131,9 @@ module ActiveModelSerializers
               id: '1',
               type: 'virtual-values',
               relationships: {
-                maker: { data: { id: 1 } },
-                reviews: { data: [{ id: 1 }, { id: 2 }] }
+                maker: { data: { type: 'makers', id: '1' } },
+                reviews: { data: [{ type: 'reviews', id: '1' },
+                                  { type: 'reviews', id: '2' }] }
               }
             }
           }, adapter.serializable_hash)

data/test/adapter/json_api/has_one_test.rb

@@ -65,8 +65,9 @@ module ActiveModelSerializers
               id: '1',
               type: 'virtual-values',
               relationships: {
-                maker: { data: { id: 1 } },
-                reviews: { data: [{ id: 1 }, { id: 2 }] }
+                maker: { data: { type: 'makers', id: '1' } },
+                reviews: { data: [{ type: 'reviews', id: '1' },
+                                  { type: 'reviews', id: '2' }] }
               }
             }
           }

data/test/adapter/json_api/pagination_links_test.rb

@@ -25,13 +25,13 @@ module ActiveModelSerializers
           context = Minitest::Mock.new
           context.expect(:request_url, original_url)
           context.expect(:query_parameters, query_parameters)
-          @options = {}
-          @options[:serialization_context] = context
+          context.expect(:key_transform, nil)
         end
 
-        def load_adapter(paginated_collection, options = {})
-          options = options.merge(adapter: :json_api)
-          ActiveModelSerializers::SerializableResource.new(paginated_collection, options)
+        def load_adapter(paginated_collection, mock_request = nil)
+          render_options = { adapter: :json_api }
+          render_options[:serialization_context] = mock_request if mock_request
+          serializable(paginated_collection, render_options)
         end
 
         def using_kaminari(page = 2)
@@ -101,44 +101,62 @@ module ActiveModelSerializers
           end
         end
 
+        def expected_response_with_no_data_pagination_links
+          {}.tap do |hash|
+            hash[:data] = []
+            hash[:links] = {}
+          end
+        end
+
         def test_pagination_links_using_kaminari
-          adapter = load_adapter(using_kaminari)
+          adapter = load_adapter(using_kaminari, mock_request)
 
-          mock_request
-          assert_equal expected_response_with_pagination_links, adapter.serializable_hash(@options)
+          assert_equal expected_response_with_pagination_links, adapter.serializable_hash
         end
 
         def test_pagination_links_using_will_paginate
-          adapter = load_adapter(using_will_paginate)
+          adapter = load_adapter(using_will_paginate, mock_request)
 
-          mock_request
-          assert_equal expected_response_with_pagination_links, adapter.serializable_hash(@options)
+          assert_equal expected_response_with_pagination_links, adapter.serializable_hash
         end
 
         def test_pagination_links_with_additional_params
-          adapter = load_adapter(using_will_paginate)
+          adapter = load_adapter(using_will_paginate, mock_request({ test: 'test' }))
 
-          mock_request({ test: 'test' })
           assert_equal expected_response_with_pagination_links_and_additional_params,
-            adapter.serializable_hash(@options)
+            adapter.serializable_hash
+        end
+
+        def test_pagination_links_when_zero_results_kaminari
+          @array = []
+
+          adapter = load_adapter(using_kaminari(1), mock_request)
+
+          assert_equal expected_response_with_no_data_pagination_links, adapter.serializable_hash
+        end
+
+        def test_pagination_links_when_zero_results_will_paginate
+          @array = []
+
+          adapter = load_adapter(using_will_paginate(1), mock_request)
+
+          assert_equal expected_response_with_no_data_pagination_links, adapter.serializable_hash
         end
 
         def test_last_page_pagination_links_using_kaminari
-          adapter = load_adapter(using_kaminari(3))
+          adapter = load_adapter(using_kaminari(3), mock_request)
 
-          mock_request
-          assert_equal expected_response_with_last_page_pagination_links, adapter.serializable_hash(@options)
+          assert_equal expected_response_with_last_page_pagination_links, adapter.serializable_hash
         end
 
         def test_last_page_pagination_links_using_will_paginate
-          adapter = load_adapter(using_will_paginate(3))
+          adapter = load_adapter(using_will_paginate(3), mock_request)
 
-          mock_request
-          assert_equal expected_response_with_last_page_pagination_links, adapter.serializable_hash(@options)
+          assert_equal expected_response_with_last_page_pagination_links, adapter.serializable_hash
         end
 
         def test_not_showing_pagination_links
-          adapter = load_adapter(@array)
+          adapter = load_adapter(@array, mock_request)
 
           assert_equal expected_response_without_pagination_links, adapter.serializable_hash
         end