active_model_serializers_custom 0.10.90

data/lib/generators/rails/templates/serializer.rb.erb

@@ -0,0 +1,8 @@
+<% module_namespacing do -%>
+class <%= class_name %>Serializer < <%= parent_class_name %>
+  attributes <%= attributes_names.map(&:inspect).join(", ") %>
+<% association_names.each do |attribute| -%>
+  has_one :<%= attribute %>
+<% end -%>
+end
+<% end -%>

data/lib/grape/active_model_serializers.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# To add Grape support, require 'grape/active_model_serializers' in the base of your Grape endpoints
+# Then add 'include Grape::ActiveModelSerializers' to enable the formatter and helpers
+require 'active_model_serializers'
+require 'grape/formatters/active_model_serializers'
+require 'grape/helpers/active_model_serializers'
+
+module Grape
+  module ActiveModelSerializers
+    extend ActiveSupport::Concern
+
+    included do
+      formatter :json, Grape::Formatters::ActiveModelSerializers
+      helpers Grape::Helpers::ActiveModelSerializers
+    end
+  end
+end

data/lib/grape/formatters/active_model_serializers.rb

@@ -0,0 +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 = 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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Helpers can be included in your Grape endpoint as: helpers Grape::Helpers::ActiveModelSerializers
+
+module Grape
+  module Helpers
+    module ActiveModelSerializers
+      # A convenience method for passing ActiveModelSerializers serializer options
+      #
+      # Example: To include relationships in the response: render(post, include: ['comments'])
+      #
+      # Example: To include pagination meta data: render(posts, meta: { page: posts.page, total_pages: posts.total_pages })
+      def render(resource, active_model_serializer_options = {})
+        env[:active_model_serializer_options] = active_model_serializer_options
+        resource
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# 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')
+          render json: @profile
+        end
+
+        def render_using_adapter_override
+          @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(id: 'render_skipping_adapter_id', name: 'Name 1', description: 'Description 1', comments: 'Comments 1')
+          render json: @profile, adapter: false
+        end
+      end
+
+      tests AdapterSelectorTestController
+
+      def test_render_using_default_adapter
+        get :render_using_default_adapter
+        assert_equal '{"name":"Name 1","description":"Description 1"}', response.body
+      end
+
+      def test_render_using_adapter_override
+        get :render_using_adapter_override
+
+        expected = {
+          data: {
+            id: 'render_using_adapter_override',
+            type: 'profiles',
+            attributes: {
+              name: 'Name 1',
+              description: 'Description 1'
+            }
+          }
+        }
+
+        assert_equal expected.to_json, response.body
+      end
+
+      def test_render_skipping_adapter
+        get :render_skipping_adapter
+        assert_equal '{"id":"render_skipping_adapter_id","name":"Name 1","description":"Description 1"}', response.body
+      end
+    end
+  end
+end

data/test/action_controller/explicit_serializer_test.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+module ActionController
+  module Serialization
+    class ExplicitSerializerTest < ActionController::TestCase
+      class ExplicitSerializerTestController < ActionController::Base
+        def render_using_explicit_serializer
+          @profile = Profile.new(name: 'Name 1',
+                                 description: 'Description 1',
+                                 comments: 'Comments 1')
+          render json: @profile, serializer: ProfilePreviewSerializer
+        end
+
+        def render_array_using_explicit_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,
+                 serializer: PaginatedSerializer,
+                 each_serializer: ProfilePreviewSerializer
+        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,
+                 each_serializer: ProfilePreviewSerializer
+        end
+
+        def render_array_using_explicit_serializer_and_custom_serializers
+          @post = Post.new(title: 'New Post', body: 'Body')
+          @author = Author.new(name: 'Jane Blogger')
+          @author.posts = [@post]
+          @post.author = @author
+          @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]
+          @first_comment.post = @post
+          @first_comment.author = nil
+          @second_comment.post = @post
+          @second_comment.author = nil
+          @blog = Blog.new(id: 23, name: 'AMS Blog')
+          @post.blog = @blog
+
+          render json: [@post], each_serializer: PostPreviewSerializer
+        end
+
+        def render_using_explicit_each_serializer
+          location       = Location.new(id: 42, lat: '-23.550520', lng: '-46.633309')
+          place          = Place.new(id: 1337, name: 'Amazing Place', locations: [location])
+
+          render json: place, each_serializer: PlaceSerializer
+        end
+      end
+
+      tests ExplicitSerializerTestController
+
+      def test_render_using_explicit_serializer
+        get :render_using_explicit_serializer
+
+        assert_equal 'application/json', @response.content_type
+        assert_equal '{"name":"Name 1"}', @response.body
+      end
+
+      def test_render_array_using_explicit_serializer
+        get :render_array_using_explicit_serializer
+        assert_equal 'application/json', @response.content_type
+
+        expected = [
+          { 'name' => 'Name 1' },
+          { 'name' => 'Name 2' }
+        ]
+
+        assert_equal expected.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' },
+          { 'name' => 'Name 2' }
+        ]
+        assert_equal expected.to_json, @response.body
+      end
+
+      def test_render_array_using_explicit_serializer_and_custom_serializers
+        get :render_array_using_explicit_serializer_and_custom_serializers
+
+        expected = [
+          {
+            'title' => 'New Post',
+            'body' => 'Body',
+            'id' => @controller.instance_variable_get(:@post).id,
+            'comments' => [{ 'id' => 1 }, { 'id' => 2 }],
+            'author' => { 'id' => @controller.instance_variable_get(:@author).id }
+          }
+        ]
+
+        assert_equal expected.to_json, @response.body
+      end
+
+      def test_render_using_explicit_each_serializer
+        get :render_using_explicit_each_serializer
+
+        expected = {
+          id: 1337,
+          name: 'Amazing Place',
+          locations: [
+            {
+              id: 42,
+              lat: '-23.550520',
+              lng: '-46.633309',
+              address: 'Nowhere' # is a virtual attribute on LocationSerializer
+            }
+          ]
+        }
+
+        assert_equal expected.to_json, response.body
+      end
+    end
+  end
+end

data/test/action_controller/json/include_test.rb

@@ -0,0 +1,248 @@
+# 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
+
+            @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
+            @author.posts = [@post]
+
+            @first_comment.author = @author
+            @second_comment.author = @author
+            @author.comments = [@first_comment, @second_comment]
+            @author.roles = []
+            @author.bio = {}
+          end
+
+          def render_without_include
+            setup_data
+            render json: @author, adapter: :json
+          end
+
+          def render_resource_with_include_hash
+            setup_data
+            render json: @author, include: INCLUDE_HASH, adapter: :json
+          end
+
+          def render_resource_with_include_string
+            setup_data
+            render json: @author, include: INCLUDE_STRING, adapter: :json
+          end
+
+          def render_resource_with_deep_include
+            setup_data
+            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
+
+        tests IncludeTestController
+
+        def test_render_without_include
+          get :render_without_include
+          response = JSON.parse(@response.body)
+          expected = {
+            'author' => {
+              'id' => 1,
+              'name' => 'Steve K.',
+              'posts' => [
+                {
+                  'id' => 42, 'title' => 'New Post', 'body' => 'Body'
+                }
+              ],
+              'roles' => [],
+              'bio' => {}
+            }
+          }
+
+          assert_equal(expected, response)
+        end
+
+        def test_render_resource_with_include_hash
+          get :render_resource_with_include_hash
+          response = JSON.parse(@response.body)
+
+          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' => 12,
+                  'title' => 'Hello World',
+                  'body' => 'My first post',
+                  'comments' => [
+                    {
+                      '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
+
+        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
+
+        private
+
+        def expected_include_response
+          {
+            'author' => {
+              'id' => 1,
+              'name' => 'Steve K.',
+              'posts' => [
+                {
+                  'id' => 42, 'title' => 'New Post', 'body' => 'Body',
+                  'comments' => [
+                    {
+                      'id' => 1, 'body' => 'ZOMG A COMMENT'
+                    },
+                    {
+                      'id' => 2, 'body' => 'ZOMG ANOTHER COMMENT'
+                    }
+                  ]
+                }
+              ]
+            }
+          }
+        end
+
+        def expected_deep_include_response
+          {
+            'author' => {
+              'id' => 1,
+              'name' => 'Steve K.',
+              'posts' => [
+                {
+                  'id' => 42, 'title' => 'New Post', 'body' => 'Body',
+                  'comments' => [
+                    {
+                      'id' => 1, 'body' => 'ZOMG A COMMENT',
+                      'author' => {
+                        'id' => 1,
+                        'name' => 'Steve K.'
+                      }
+                    },
+                    {
+                      'id' => 2, 'body' => 'ZOMG ANOTHER COMMENT',
+                      'author' => {
+                        'id' => 1,
+                        'name' => 'Steve K.'
+                      }
+                    }
+                  ]
+                }
+              ]
+            }
+          }
+        end
+
+        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
+  end
+end