active_model_serializers 0.10.0 → 0.10.9

data/lib/grape/formatters/active_model_serializers.rb

@@ -1,15 +1,34 @@
+# frozen_string_literal: true
+
 # A Grape response formatter that can be used as 'formatter :json, Grape::Formatters::ActiveModelSerializers'
 #
 # Serializer options can be passed as a hash from your Grape endpoint using env[:active_model_serializer_options],
 # or better yet user the render helper in Grape::Helpers::ActiveModelSerializers
+
+require 'active_model_serializers/serialization_context'
+
 module Grape
   module Formatters
     module ActiveModelSerializers
       def self.call(resource, env)
-        serializer_options = {}
-        serializer_options.merge!(env[:active_model_serializer_options]) if env[:active_model_serializer_options]
+        serializer_options = build_serializer_options(env)
         ::ActiveModelSerializers::SerializableResource.new(resource, serializer_options).to_json
       end
+
+      def self.build_serializer_options(env)
+        ams_options = env[:active_model_serializer_options] || {}
+
+        # Add serialization context
+        ams_options.fetch(:serialization_context) do
+          request = env['grape.request']
+          ams_options[:serialization_context] = ::ActiveModelSerializers::SerializationContext.new(
+            request_url: request.url[/\A[^?]+/],
+            query_parameters: request.params
+          )
+        end
+
+        ams_options
+      end
     end
   end
 end

data/lib/grape/helpers/active_model_serializers.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 # Helpers can be included in your Grape endpoint as: helpers Grape::Helpers::ActiveModelSerializers
+
 module Grape
   module Helpers
     module ActiveModelSerializers

data/lib/tasks/rubocop.rake

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+begin
+  require 'rubocop'
+  require 'rubocop/rake_task'
+rescue LoadError # rubocop:disable Lint/HandleExceptions
+else
+  require 'rbconfig'
+  # https://github.com/bundler/bundler/blob/1b3eb2465a/lib/bundler/constants.rb#L2
+  windows_platforms = /(msdos|mswin|djgpp|mingw)/
+  if RbConfig::CONFIG['host_os'] =~ windows_platforms
+    desc 'No-op rubocop on Windows-- unsupported platform'
+    task :rubocop do
+      puts 'Skipping rubocop on Windows'
+    end
+  elsif defined?(::Rubinius)
+    desc 'No-op rubocop to avoid rbx segfault'
+    task :rubocop do
+      puts 'Skipping rubocop on rbx due to segfault'
+      puts 'https://github.com/rubinius/rubinius/issues/3499'
+    end
+  else
+    Rake::Task[:rubocop].clear if Rake::Task.task_defined?(:rubocop)
+    patterns = [
+      'Gemfile',
+      'Rakefile',
+      'lib/**/*.{rb,rake}',
+      'config/**/*.rb',
+      'app/**/*.rb',
+      'test/**/*.rb'
+    ]
+    desc 'Execute rubocop'
+    RuboCop::RakeTask.new(:rubocop) do |task|
+      task.options = ['--rails', '--display-cop-names', '--display-style-guide']
+      task.formatters = ['progress']
+      task.patterns = patterns
+      task.fail_on_error = true
+    end
+
+    namespace :rubocop do
+      desc 'Auto-gen rubocop config'
+      task :auto_gen_config do
+        options = ['--auto-gen-config'].concat patterns
+        require 'benchmark'
+        result = 0
+        cli = RuboCop::CLI.new
+        time = Benchmark.realtime do
+          result = cli.run(options)
+        end
+        puts "Finished in #{time} seconds" if cli.options[:debug]
+        abort('RuboCop failed!') if result.nonzero?
+      end
+    end
+  end
+end

data/test/action_controller/adapter_selector_test.rb

@@ -1,21 +1,32 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 module ActionController
   module Serialization
     class AdapterSelectorTest < ActionController::TestCase
+      class Profile < Model
+        attributes :id, :name, :description
+        associations :comments
+      end
+      class ProfileSerializer < ActiveModel::Serializer
+        type 'profiles'
+        attributes :name, :description
+      end
+
       class AdapterSelectorTestController < ActionController::Base
         def render_using_default_adapter
-          @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+          @profile = Profile.new(name: 'Name 1', description: 'Description 1', comments: 'Comments 1')
           render json: @profile
         end
 
         def render_using_adapter_override
-          @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+          @profile = Profile.new(id: 'render_using_adapter_override', name: 'Name 1', description: 'Description 1', comments: 'Comments 1')
           render json: @profile, adapter: :json_api
         end
 
         def render_skipping_adapter
-          @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+          @profile = Profile.new(id: 'render_skipping_adapter_id', name: 'Name 1', description: 'Description 1', comments: 'Comments 1')
           render json: @profile, adapter: false
         end
       end
@@ -32,7 +43,7 @@ module ActionController
 
         expected = {
           data: {
-            id: assigns(:profile).id.to_s,
+            id: 'render_using_adapter_override',
             type: 'profiles',
             attributes: {
               name: 'Name 1',
@@ -46,7 +57,7 @@ module ActionController
 
       def test_render_skipping_adapter
         get :render_skipping_adapter
-        assert_equal '{"name":"Name 1","description":"Description 1","comments":"Comments 1"}', response.body
+        assert_equal '{"id":"render_skipping_adapter_id","name":"Name 1","description":"Description 1"}', response.body
       end
     end
   end

data/test/action_controller/explicit_serializer_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 module ActionController
@@ -100,11 +102,12 @@ module ActionController
         get :render_array_using_explicit_serializer_and_custom_serializers
 
         expected = [
-          { 'title' => 'New Post',
+          {
+            'title' => 'New Post',
             'body' => 'Body',
-            'id' => assigns(:post).id,
+            'id' => @controller.instance_variable_get(:@post).id,
             'comments' => [{ 'id' => 1 }, { 'id' => 2 }],
-            'author' => { 'id' => assigns(:author).id }
+            'author' => { 'id' => @controller.instance_variable_get(:@author).id }
           }
         ]
 
@@ -122,7 +125,7 @@ module ActionController
               id: 42,
               lat: '-23.550520',
               lng: '-46.633309',
-              place: 'Nowhere' # is a virtual attribute on LocationSerializer
+              address: 'Nowhere' # is a virtual attribute on LocationSerializer
             }
           ]
         }

data/test/action_controller/json/include_test.rb

@@ -1,9 +1,15 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 module ActionController
   module Serialization
     class Json
       class IncludeTest < ActionController::TestCase
+        INCLUDE_STRING = 'posts.comments'.freeze
+        INCLUDE_HASH = { posts: :comments }.freeze
+        DEEP_INCLUDE = 'posts.comments.author'.freeze
+
         class IncludeTestController < ActionController::Base
           def setup_data
             ActionController::Base.cache_store.clear
@@ -38,17 +44,28 @@ module ActionController
 
           def render_resource_with_include_hash
             setup_data
-            render json: @author, include: { posts: :comments }, adapter: :json
+            render json: @author, include: INCLUDE_HASH, adapter: :json
           end
 
           def render_resource_with_include_string
             setup_data
-            render json: @author, include: 'posts.comments', adapter: :json
+            render json: @author, include: INCLUDE_STRING, adapter: :json
           end
 
           def render_resource_with_deep_include
             setup_data
-            render json: @author, include: 'posts.comments.author', adapter: :json
+            render json: @author, include: DEEP_INCLUDE, adapter: :json
+          end
+
+          def render_without_recursive_relationships
+            # testing recursive includes ('**') can't have any cycles in the
+            # relationships, or we enter an infinite loop.
+            author = Author.new(id: 11, name: 'Jane Doe')
+            post = Post.new(id: 12, title: 'Hello World', body: 'My first post')
+            comment = Comment.new(id: 13, body: 'Commentary')
+            author.posts = [post]
+            post.comments = [comment]
+            render json: author
           end
         end
 
@@ -77,34 +94,90 @@ module ActionController
         def test_render_resource_with_include_hash
           get :render_resource_with_include_hash
           response = JSON.parse(@response.body)
-          expected = {
-            'author' => {
-              'id' => 1,
-              'name' => 'Steve K.',
+
+          assert_equal(expected_include_response, response)
+        end
+
+        def test_render_resource_with_include_string
+          get :render_resource_with_include_string
+
+          response = JSON.parse(@response.body)
+
+          assert_equal(expected_include_response, response)
+        end
+
+        def test_render_resource_with_deep_include
+          get :render_resource_with_deep_include
+
+          response = JSON.parse(@response.body)
+
+          assert_equal(expected_deep_include_response, response)
+        end
+
+        def test_render_with_empty_default_includes
+          with_default_includes '' do
+            get :render_without_include
+            response = JSON.parse(@response.body)
+            expected = {
+              'author' => {
+                'id' => 1,
+                'name' => 'Steve K.'
+              }
+            }
+            assert_equal(expected, response)
+          end
+        end
+
+        def test_render_with_recursive_default_includes
+          with_default_includes '**' do
+            get :render_without_recursive_relationships
+            response = JSON.parse(@response.body)
+
+            expected = {
+              'id' => 11,
+              'name' => 'Jane Doe',
+              'roles' => nil,
+              'bio' => nil,
               'posts' => [
                 {
-                  'id' => 42, 'title' => 'New Post', 'body' => 'Body',
+                  'id' => 12,
+                  'title' => 'Hello World',
+                  'body' => 'My first post',
                   'comments' => [
                     {
-                      'id' => 1, 'body' => 'ZOMG A COMMENT'
-                    },
-                    {
-                      'id' => 2, 'body' => 'ZOMG ANOTHER COMMENT'
+                      'id' => 13,
+                      'body' => 'Commentary',
+                      'post' => nil, # not set to avoid infinite recursion
+                      'author' => nil, # not set to avoid infinite recursion
                     }
-                  ]
+                  ],
+                  'blog' => {
+                    'id' => 999,
+                    'name' => 'Custom blog',
+                    'writer' => nil,
+                    'articles' => nil
+                  },
+                  'author' => nil # not set to avoid infinite recursion
                 }
               ]
             }
-          }
+            assert_equal(expected, response)
+          end
+        end
 
-          assert_equal(expected, response)
+        def test_render_with_includes_overrides_default_includes
+          with_default_includes '' do
+            get :render_resource_with_include_hash
+            response = JSON.parse(@response.body)
+
+            assert_equal(expected_include_response, response)
+          end
         end
 
-        def test_render_resource_with_include_string
-          get :render_resource_with_include_string
+        private
 
-          response = JSON.parse(@response.body)
-          expected = {
+        def expected_include_response
+          {
             'author' => {
               'id' => 1,
               'name' => 'Steve K.',
@@ -123,15 +196,10 @@ module ActionController
               ]
             }
           }
-
-          assert_equal(expected, response)
         end
 
-        def test_render_resource_with_deep_include
-          get :render_resource_with_deep_include
-
-          response = JSON.parse(@response.body)
-          expected = {
+        def expected_deep_include_response
+          {
             'author' => {
               'id' => 1,
               'name' => 'Steve K.',
@@ -158,8 +226,21 @@ module ActionController
               ]
             }
           }
+        end
 
-          assert_equal(expected, response)
+        def with_default_includes(include_directive)
+          original = ActiveModelSerializers.config.default_includes
+          ActiveModelSerializers.config.default_includes = include_directive
+          clear_include_directive_cache
+          yield
+        ensure
+          ActiveModelSerializers.config.default_includes = original
+          clear_include_directive_cache
+        end
+
+        def clear_include_directive_cache
+          ActiveModelSerializers
+            .instance_variable_set(:@default_include_directive, nil)
         end
       end
     end

data/test/action_controller/json_api/deserialization_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 module ActionController
@@ -45,7 +47,7 @@ module ActionController
           response = JSON.parse(@response.body)
           expected = {
             'restriction_for_id' => '67',
-            'restriction_for_type' => 'discounts',
+            'restriction_for_type' => 'Discount',
             'restricted_to_id' => nil,
             'restricted_to_type' => nil
           }

data/test/action_controller/json_api/errors_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 module ActionController
@@ -7,18 +9,17 @@ module ActionController
         def test_active_model_with_multiple_errors
           get :render_resource_with_errors
 
-          expected_errors_object =
-            { :errors =>
-              [
-                { :source => { :pointer => '/data/attributes/name' }, :detail => 'cannot be nil' },
-                { :source => { :pointer => '/data/attributes/name' }, :detail => 'must be longer' },
-                { :source => { :pointer => '/data/attributes/id' }, :detail => 'must be a uuid' }
-              ]
+          expected_errors_object = {
+            errors:               [
+              { source: { pointer: '/data/attributes/name' }, detail: 'cannot be nil' },
+              { source: { pointer: '/data/attributes/name' }, detail: 'must be longer' },
+              { source: { pointer: '/data/attributes/id' }, detail: 'must be a uuid' }
+            ]
           }.to_json
-          assert_equal json_reponse_body.to_json, expected_errors_object
+          assert_equal json_response_body.to_json, expected_errors_object
         end
 
-        def json_reponse_body
+        def json_response_body
           JSON.load(@response.body)
         end
 

data/test/action_controller/json_api/fields_test.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+module ActionController
+  module Serialization
+    class JsonApi
+      class FieldsTest < ActionController::TestCase
+        class FieldsTestController < ActionController::Base
+          class AuthorWithName < Author
+            attributes :first_name, :last_name
+          end
+          class AuthorWithNameSerializer < AuthorSerializer
+            type 'authors'
+          end
+          class PostWithPublishAt < Post
+            attributes :publish_at
+          end
+          class PostWithPublishAtSerializer < ActiveModel::Serializer
+            type 'posts'
+            attributes :title, :body, :publish_at
+            belongs_to :author
+            has_many :comments
+          end
+
+          def setup_post
+            ActionController::Base.cache_store.clear
+            @author = AuthorWithName.new(id: 1, first_name: 'Bob', last_name: 'Jones')
+            @comment1 = Comment.new(id: 7, body: 'cool', author: @author)
+            @comment2 = Comment.new(id: 12, body: 'awesome', author: @author)
+            @post = PostWithPublishAt.new(id: 1337, title: 'Title 1', body: 'Body 1',
+                                          author: @author, comments: [@comment1, @comment2],
+                                          publish_at: '2020-03-16T03:55:25.291Z')
+            @comment1.post = @post
+            @comment2.post = @post
+          end
+
+          def render_fields_works_on_relationships
+            setup_post
+            render json: @post, serializer: PostWithPublishAtSerializer, adapter: :json_api, fields: { posts: [:author] }
+          end
+        end
+
+        tests FieldsTestController
+
+        test 'fields works on relationships' do
+          get :render_fields_works_on_relationships
+          response = JSON.parse(@response.body)
+          expected = {
+            'data' => {
+              'id' => '1337',
+              'type' => 'posts',
+              'relationships' => {
+                'author' => {
+                  'data' => {
+                    'id' => '1',
+                    'type' => 'authors'
+                  }
+                }
+              }
+            }
+          }
+          assert_equal expected, response
+        end
+      end
+    end
+  end
+end

data/test/action_controller/json_api/linked_test.rb

@@ -1,11 +1,12 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 module ActionController
   module Serialization
     class JsonApi
-      class LinkedTest < ActionController::TestCase
+      class LinkedTest < ActionDispatch::IntegrationTest
         class LinkedTestController < ActionController::Base
-          require 'active_model_serializers/register_jsonapi_renderer'
           def setup_post
             ActionController::Base.cache_store.clear
             @role1 = Role.new(id: 1, name: 'admin')
@@ -39,62 +40,68 @@ module ActionController
 
           def render_resource_without_include
             setup_post
-            render jsonapi: @post
+            render json: @post
           end
 
           def render_resource_with_include
             setup_post
-            render jsonapi: @post, include: [:author]
+            render json: @post, adapter: :json_api, include: [:author]
           end
 
           def render_resource_with_include_of_custom_key_by_original
             setup_post
-            render jsonapi: @post, include: [:reviews], serializer: PostWithCustomKeysSerializer
+            render json: @post, adapter: :json_api, include: [:reviews], serializer: PostWithCustomKeysSerializer
           end
 
           def render_resource_with_nested_include
             setup_post
-            render jsonapi: @post, include: [comments: [:author]]
+            render json: @post, adapter: :json_api, include: [comments: [:author]]
           end
 
           def render_resource_with_nested_has_many_include_wildcard
             setup_post
-            render jsonapi: @post, include: 'author.*'
+            render json: @post, adapter: :json_api, include: 'author.*'
           end
 
           def render_resource_with_missing_nested_has_many_include
             setup_post
             @post.author = @author2 # author2 has no roles.
-            render jsonapi: @post, include: [author: [:roles]]
+            render json: @post, adapter: :json_api, include: [author: [:roles]]
           end
 
           def render_collection_with_missing_nested_has_many_include
             setup_post
             @post.author = @author2
-            render jsonapi: [@post, @post2], include: [author: [:roles]]
+            render json: [@post, @post2], adapter: :json_api, include: [author: [:roles]]
           end
 
           def render_collection_without_include
             setup_post
-            render jsonapi: [@post]
+            render json: [@post], adapter: :json_api
           end
 
           def render_collection_with_include
             setup_post
-            render jsonapi: [@post], include: 'author, comments'
+            render json: [@post], adapter: :json_api, include: 'author, comments'
           end
         end
 
-        tests LinkedTestController
+        setup do
+          @routes = Rails.application.routes.draw do
+            ActiveSupport::Deprecation.silence do
+              match ':action', to: LinkedTestController, via: [:get, :post]
+            end
+          end
+        end
 
         def test_render_resource_without_include
-          get :render_resource_without_include
+          get '/render_resource_without_include'
           response = JSON.parse(@response.body)
           refute response.key? 'included'
         end
 
         def test_render_resource_with_include
-          get :render_resource_with_include
+          get '/render_resource_with_include'
           response = JSON.parse(@response.body)
           assert response.key? 'included'
           assert_equal 1, response['included'].size
@@ -102,7 +109,7 @@ module ActionController
         end
 
         def test_render_resource_with_nested_has_many_include
-          get :render_resource_with_nested_has_many_include_wildcard
+          get '/render_resource_with_nested_has_many_include_wildcard'
           response = JSON.parse(@response.body)
           expected_linked = [
             {
@@ -144,7 +151,7 @@ module ActionController
         end
 
         def test_render_resource_with_include_of_custom_key_by_original
-          get :render_resource_with_include_of_custom_key_by_original
+          get '/render_resource_with_include_of_custom_key_by_original'
           response = JSON.parse(@response.body)
           assert response.key? 'included'
 
@@ -156,39 +163,39 @@ module ActionController
         end
 
         def test_render_resource_with_nested_include
-          get :render_resource_with_nested_include
+          get '/render_resource_with_nested_include'
           response = JSON.parse(@response.body)
           assert response.key? 'included'
           assert_equal 3, response['included'].size
         end
 
         def test_render_collection_without_include
-          get :render_collection_without_include
+          get '/render_collection_without_include'
           response = JSON.parse(@response.body)
           refute response.key? 'included'
         end
 
         def test_render_collection_with_include
-          get :render_collection_with_include
+          get '/render_collection_with_include'
           response = JSON.parse(@response.body)
           assert response.key? 'included'
         end
 
         def test_render_resource_with_nested_attributes_even_when_missing_associations
-          get :render_resource_with_missing_nested_has_many_include
+          get '/render_resource_with_missing_nested_has_many_include'
           response = JSON.parse(@response.body)
           assert response.key? 'included'
-          refute has_type?(response['included'], 'roles')
+          refute include_type?(response['included'], 'roles')
         end
 
         def test_render_collection_with_missing_nested_has_many_include
-          get :render_collection_with_missing_nested_has_many_include
+          get '/render_collection_with_missing_nested_has_many_include'
           response = JSON.parse(@response.body)
           assert response.key? 'included'
-          assert has_type?(response['included'], 'roles')
+          assert include_type?(response['included'], 'roles')
         end
 
-        def has_type?(collection, value)
+        def include_type?(collection, value)
           collection.detect { |i| i['type'] == value }
         end
       end