active_model_serializers 0.10.0.rc2 → 0.10.0.rc3

data/test/adapter/json_api/pagination_links_test.rb

@@ -0,0 +1,115 @@
+require 'test_helper'
+require 'will_paginate/array'
+require 'kaminari'
+require 'kaminari/hooks'
+::Kaminari::Hooks.init
+
+module ActiveModel
+  class Serializer
+    class Adapter
+      class JsonApi
+        class PaginationLinksTest < Minitest::Test
+          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
+
+          def mock_request(query_parameters = {}, original_url = URI)
+            context = Minitest::Mock.new
+            context.expect(:original_url, original_url)
+            context.expect(:query_parameters, query_parameters)
+            @options = {}
+            @options[:context] = context
+          end
+
+          def load_adapter(paginated_collection, options = {})
+            options = options.merge(adapter: :json_api)
+            ActiveModel::SerializableResource.new(paginated_collection, options)
+          end
+
+          def using_kaminari
+            Kaminari.paginate_array(@array).page(2).per(1)
+          end
+
+          def using_will_paginate
+            @array.paginate(page: 2, per_page: 1)
+          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' } }
+              ]
+            }
+          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"
+              }
+            }
+          end
+
+          def expected_response_without_pagination_links
+            data
+          end
+
+          def expected_response_with_pagination_links
+            {}.tap do |hash|
+              hash[:data] = [data.values.flatten.second]
+              hash.merge! 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
+          end
+
+          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
+
+          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
+
+          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
+
+          def test_not_showing_pagination_links
+            adapter = load_adapter(@array)
+
+            assert_equal expected_response_without_pagination_links, adapter.serializable_hash
+          end
+        end
+      end
+    end
+  end
+end

data/test/adapter/json_api/resource_type_config_test.rb

@@ -0,0 +1,59 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class Adapter
+      class JsonApi
+        class ResourceTypeConfigTest < Minitest::Test
+          def setup
+            @author = Author.new(id: 1, name: 'Steve K.')
+            @author.bio = nil
+            @author.roles = []
+            @blog = Blog.new(id: 23, name: 'AMS Blog')
+            @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]
+            @post.blog = @blog
+            @anonymous_post.comments = []
+            @anonymous_post.blog = nil
+            @comment.post = @post
+            @comment.author = nil
+            @post.author = @author
+            @anonymous_post.author = nil
+            @blog = Blog.new(id: 1, name: 'My Blog!!')
+            @blog.writer = @author
+            @blog.articles = [@post, @anonymous_post]
+            @author.posts = []
+          end
+
+          def with_jsonapi_resource_type type
+            old_type = ActiveModel::Serializer.config.jsonapi_resource_type
+            ActiveModel::Serializer.config.jsonapi_resource_type = type
+            yield
+          ensure
+            ActiveModel::Serializer.config.jsonapi_resource_type = old_type
+          end
+
+          def test_config_plural
+            with_adapter :json_api do
+              with_jsonapi_resource_type :plural do
+                hash = ActiveModel::SerializableResource.new(@comment).serializable_hash
+                assert_equal('comments', hash[:data][:type])
+              end
+            end
+          end
+
+          def test_config_singular
+            with_adapter :json_api do
+              with_jsonapi_resource_type :singular do
+                hash = ActiveModel::SerializableResource.new(@comment).serializable_hash
+                assert_equal('comment', hash[:data][:type])
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/test/adapter/json_test.rb

@@ -7,14 +7,14 @@ module ActiveModel
         def setup
           ActionController::Base.cache_store.clear
           @author = Author.new(id: 1, name: 'Steve K.')
-          @post = Post.new(title: 'New Post', body: 'Body')
+          @post = Post.new(id: 1, 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]
           @first_comment.post = @post
           @second_comment.post = @post
           @post.author = @author
-          @blog = Blog.new(id: 1, name: "My Blog!!")
+          @blog = Blog.new(id: 1, name: 'My Blog!!')
           @post.blog = @blog
 
           @serializer = PostSerializer.new(@post)
@@ -23,12 +23,25 @@ module ActiveModel
 
         def test_has_many
           assert_equal([
-                         {id: 1, body: 'ZOMG A COMMENT'},
-                         {id: 2, body: 'ZOMG ANOTHER COMMENT'}
+                         { id: 1, body: 'ZOMG A COMMENT' },
+                         { id: 2, body: 'ZOMG ANOTHER COMMENT' }
                        ], @adapter.serializable_hash[:post][:comments])
         end
+
+        def test_custom_keys
+          serializer = PostWithCustomKeysSerializer.new(@post)
+          adapter = ActiveModel::Serializer::Adapter::Json.new(serializer)
+
+          assert_equal({
+            id: 1,
+            reviews: [{ id: 1, body: 'ZOMG A COMMENT' },
+                      { id: 2, body: 'ZOMG ANOTHER COMMENT' }
+                    ],
+            writer: { id: 1, name: 'Steve K.' },
+            site: { id: 1, name: 'My Blog!!' }
+            }, adapter.serializable_hash[:post])
+        end
       end
     end
   end
 end
-

data/test/adapter_test.rb

@@ -19,25 +19,24 @@ module ActiveModel
         assert_equal @serializer, @adapter.serializer
       end
 
-      def test_adapter_class_for_known_adapter
-        klass = ActiveModel::Serializer::Adapter.adapter_class(:json_api)
-        assert_equal ActiveModel::Serializer::Adapter::JsonApi, klass
-      end
-
-      def test_adapter_class_for_unknown_adapter
-        klass = ActiveModel::Serializer::Adapter.adapter_class(:json_simple)
-        assert_nil klass
-      end
-
       def test_create_adapter
         adapter = ActiveModel::Serializer::Adapter.create(@serializer)
         assert_equal ActiveModel::Serializer::Adapter::FlattenJson, adapter.class
       end
 
       def test_create_adapter_with_override
-        adapter = ActiveModel::Serializer::Adapter.create(@serializer, { adapter: :json_api})
+        adapter = ActiveModel::Serializer::Adapter.create(@serializer, { adapter: :json_api })
         assert_equal ActiveModel::Serializer::Adapter::JsonApi, adapter.class
       end
+
+      def test_inflected_adapter_class_for_known_adapter
+        ActiveSupport::Inflector.inflections(:en) { |inflect| inflect.acronym 'API' }
+        klass = ActiveModel::Serializer::Adapter.adapter_class(:json_api)
+
+        ActiveSupport::Inflector.inflections.acronyms.clear
+
+        assert_equal ActiveModel::Serializer::Adapter::JsonApi, klass
+      end
     end
   end
 end

data/test/array_serializer_test.rb

@@ -6,7 +6,17 @@ module ActiveModel
       def setup
         @comment = Comment.new
         @post = Post.new
-        @serializer = ArraySerializer.new([@comment, @post], {some: :options})
+        @resource = build_named_collection @comment, @post
+        @serializer = ArraySerializer.new(@resource, { some: :options })
+      end
+
+      def build_named_collection(*resource)
+        resource.define_singleton_method(:name) { 'MeResource' }
+        resource
+      end
+
+      def test_has_object_reader_serializer_interface
+        assert_equal @serializer.object, @resource
       end
 
       def test_respond_to_each
@@ -26,17 +36,65 @@ module ActiveModel
       end
 
       def test_serializer_option_not_passed_to_each_serializer
-        serializers = ArraySerializer.new([@post], {serializer: PostSerializer}).to_a
+        serializers = ArraySerializer.new([@post], { serializer: PostSerializer }).to_a
 
         refute serializers.first.custom_options.key?(:serializer)
       end
 
       def test_meta_and_meta_key_attr_readers
-        meta_content = {meta: "the meta", meta_key: "the meta key"}
+        meta_content = { meta: 'the meta', meta_key: 'the meta key' }
         @serializer = ArraySerializer.new([@comment, @post], meta_content)
 
-        assert_equal @serializer.meta, "the meta"
-        assert_equal @serializer.meta_key, "the meta key"
+        assert_equal @serializer.meta, 'the meta'
+        assert_equal @serializer.meta_key, 'the meta key'
+      end
+
+      def test_root_default
+        @serializer = ArraySerializer.new([@comment, @post])
+        assert_equal @serializer.root, nil
+      end
+
+      def test_root
+        expected =  'custom_root'
+        @serializer = ArraySerializer.new([@comment, @post], root: expected)
+        assert_equal @serializer.root, expected
+      end
+
+      def test_root_with_no_serializers
+        expected =  'custom_root'
+        @serializer = ArraySerializer.new([], root: expected)
+        assert_equal @serializer.root, expected
+      end
+
+      def test_json_key
+        assert_equal @serializer.json_key, 'comments'
+      end
+
+      def test_json_key_with_resource_with_name_and_no_serializers
+        serializer = ArraySerializer.new(build_named_collection)
+        assert_equal serializer.json_key, 'me_resources'
+      end
+
+      def test_json_key_with_resource_with_nil_name_and_no_serializers
+        resource = []
+        resource.define_singleton_method(:name) { nil }
+        serializer = ArraySerializer.new(resource)
+        assert_equal serializer.json_key, nil
+      end
+
+      def test_json_key_with_resource_without_name_and_no_serializers
+        serializer = ArraySerializer.new([])
+        assert_equal serializer.json_key, nil
+      end
+
+      def test_json_key_with_root
+        serializer = ArraySerializer.new(@resource, root: 'custom_root')
+        assert_equal serializer.json_key, 'custom_roots'
+      end
+
+      def test_json_key_with_root_and_no_serializers
+        serializer = ArraySerializer.new(build_named_collection, root: 'custom_root')
+        assert_equal serializer.json_key, 'custom_roots'
       end
     end
   end

data/test/capture_warnings.rb

@@ -0,0 +1,65 @@
+# https://raw.githubusercontent.com/metric_fu/metric_fu/master/spec/capture_warnings.rb
+require 'tempfile'
+require 'fileutils'
+
+class CaptureWarnings
+  def initialize(fail_on_warnings = true)
+    @fail_on_warnings = fail_on_warnings
+    @stderr_file = Tempfile.new('app.stderr')
+    @app_root ||= Dir.pwd
+    @output_dir = File.join(app_root, 'tmp')
+    FileUtils.mkdir_p(output_dir)
+    @bundle_dir = File.join(app_root, 'bundle')
+    @output = STDOUT
+  end
+
+  def execute!
+    $VERBOSE = true
+    $stderr.reopen(stderr_file.path)
+
+    Minitest.after_run do
+      stderr_file.rewind
+      lines = stderr_file.read.split("\n")
+      stderr_file.close!
+      $stderr.reopen(STDERR)
+      after_tests(lines)
+    end
+  end
+
+  # rubocop:disable Metrics/AbcSize
+  def after_tests(lines)
+    app_warnings, other_warnings = lines.partition { |line|
+      line.include?(app_root) && !line.include?(bundle_dir)
+    }
+
+    header = "#{'-' * 22} app warnings: #{'-' * 22}"
+    output.puts
+    output.puts header
+
+    if app_warnings.any?
+      output.puts app_warnings.join("\n")
+    else
+      output.puts 'None. Yay!'
+    end
+
+    if other_warnings.any?
+      File.write(File.join(output_dir, 'warnings.txt'), other_warnings.join("\n") << "\n")
+      output.puts
+      output.puts 'Non-app warnings written to tmp/warnings.txt'
+      output.puts
+    end
+
+    output.puts
+    output.puts '-' * header.size
+
+    # fail the build...
+    if fail_on_warnings && app_warnings.any?
+      abort "Failing build due to app warnings: #{app_warnings.inspect}"
+    end
+  end
+  # rubocop:enable Metrics/AbcSize
+
+  private
+
+  attr_reader :stderr_file, :app_root, :output_dir, :bundle_dir, :fail_on_warnings, :output
+end

data/test/fixtures/active_record.rb

@@ -0,0 +1,56 @@
+require 'active_record'
+
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+ActiveRecord::Schema.define do
+  create_table :posts, force: true do |t|
+    t.string :title
+    t.text :body
+    t.references :author
+    t.timestamps null: false
+  end
+  create_table :authors, force: true do |t|
+    t.string :name
+    t.timestamps null: false
+  end
+  create_table :comments, force: true do |t|
+    t.text :contents
+    t.references :author
+    t.references :post
+    t.timestamp null: false
+  end
+end
+
+module ARModels
+  class Post < ActiveRecord::Base
+    has_many :comments
+    belongs_to :author
+  end
+
+  class Comment < ActiveRecord::Base
+    belongs_to :post
+    belongs_to :author
+  end
+
+  class Author < ActiveRecord::Base
+    has_many :posts
+  end
+
+  class PostSerializer < ActiveModel::Serializer
+    attributes :id, :title, :body
+
+    has_many :comments
+    belongs_to :author
+  end
+
+  class CommentSerializer < ActiveModel::Serializer
+    attributes :id, :contents
+
+    belongs_to :author
+  end
+
+  class AuthorSerializer < ActiveModel::Serializer
+    attributes :id, :name
+
+    has_many :posts
+  end
+end