active_model_serializers 0.10.0.rc2 → 0.10.0.rc3

data/test/serializers/fieldset_test.rb

@@ -3,12 +3,11 @@ require 'test_helper'
 module ActiveModel
   class Serializer
     class FieldsetTest < Minitest::Test
-
       def test_fieldset_with_hash
-        fieldset = ActiveModel::Serializer::Fieldset.new({'post' => ['id', 'title'], 'coment' => ['body']})
+        fieldset = ActiveModel::Serializer::Fieldset.new({ 'post' => %w(id title), 'coment' => ['body'] })
 
         assert_equal(
-          {:post=>[:id, :title], :coment=>[:body]}, 
+          { :post => [:id, :title], :coment => [:body] },
           fieldset.fields
         )
       end
@@ -17,7 +16,7 @@ module ActiveModel
         fieldset = ActiveModel::Serializer::Fieldset.new(['title'], 'post')
 
         assert_equal(
-          {:post => [:title]}, 
+          { :post => [:title] },
           fieldset.fields
         )
       end

data/test/serializers/meta_test.rb

@@ -7,19 +7,19 @@ module ActiveModel
         ActionController::Base.cache_store.clear
         @blog = Blog.new(id: 1,
                          name: 'AMS Hints',
-                         writer: Author.new(id: 2, name: "Steve"),
-                         articles: [Post.new(id: 3, title: "AMS")])
+                         writer: Author.new(id: 2, name: 'Steve'),
+                         articles: [Post.new(id: 3, title: 'AMS')])
       end
 
       def test_meta_is_present_with_root
-        serializer = AlternateBlogSerializer.new(@blog, meta: {total: 10})
-        adapter = ActiveModel::Serializer::Adapter::Json.new(serializer, root: 'blog')
+        serializer = AlternateBlogSerializer.new(@blog, meta: { total: 10 })
+        adapter = ActiveModel::Serializer::Adapter::Json.new(serializer)
         expected = {
-          alternate_blog: {
+          blog: {
             id: 1,
-            title: "AMS Hints"
+            title: 'AMS Hints'
           },
-          "meta" => {
+          'meta' => {
             total: 10
           }
         }
@@ -27,42 +27,58 @@ module ActiveModel
       end
 
       def test_meta_is_not_included_when_root_is_missing
-        adapter = load_adapter(meta: {total: 10})
+        # load_adapter uses FlattenJson Adapter
+        adapter = load_adapter(meta: { total: 10 })
         expected = {
           id: 1,
-          title: "AMS Hints"
+          title: 'AMS Hints'
         }
         assert_equal expected, adapter.as_json
       end
 
       def test_meta_key_is_used
-        serializer = AlternateBlogSerializer.new(@blog, root: 'blog', meta: {total: 10}, meta_key: "haha_meta")
-        adapter = ActiveModel::Serializer::Adapter::Json.new(serializer, root: 'blog')
+        serializer = AlternateBlogSerializer.new(@blog, meta: { total: 10 }, meta_key: 'haha_meta')
+        adapter = ActiveModel::Serializer::Adapter::Json.new(serializer)
         expected = {
-          alternate_blog: {
+          blog: {
             id: 1,
-            title: "AMS Hints"
+            title: 'AMS Hints'
           },
-          "haha_meta" => {
+          'haha_meta' => {
             total: 10
           }
         }
         assert_equal expected, adapter.as_json
       end
 
+      def test_meta_key_is_used_with_json_api
+        serializer = AlternateBlogSerializer.new(@blog, meta: { total: 10 }, meta_key: 'haha_meta')
+        adapter = ActiveModel::Serializer::Adapter::JsonApi.new(serializer)
+        expected = {
+          data: {
+            id: '1',
+            type: 'blogs',
+            attributes: { title: 'AMS Hints' }
+          },
+          'haha_meta' => { total: 10 }
+        }
+        assert_equal expected, adapter.as_json
+      end
+
       def test_meta_is_not_present_on_arrays_without_root
-        serializer = ArraySerializer.new([@blog], meta: {total: 10})
+        serializer = ArraySerializer.new([@blog], meta: { total: 10 })
+        # FlattenJSON doesn't have support to root
         adapter = ActiveModel::Serializer::Adapter::FlattenJson.new(serializer)
         expected = [{
           id: 1,
-          name: "AMS Hints",
+          name: 'AMS Hints',
           writer: {
             id: 2,
-            name: "Steve"
+            name: 'Steve'
           },
           articles: [{
             id: 3,
-            title: "AMS",
+            title: 'AMS',
             body: nil
           }]
         }]
@@ -70,19 +86,20 @@ module ActiveModel
       end
 
       def test_meta_is_present_on_arrays_with_root
-        serializer = ArraySerializer.new([@blog], meta: {total: 10}, meta_key: "haha_meta")
-        adapter = ActiveModel::Serializer::Adapter::Json.new(serializer, root: 'blog')
+        serializer = ArraySerializer.new([@blog], meta: { total: 10 }, meta_key: 'haha_meta')
+        # JSON adapter adds root by default
+        adapter = ActiveModel::Serializer::Adapter::Json.new(serializer)
         expected = {
           blogs: [{
             id: 1,
-            name: "AMS Hints",
+            name: 'AMS Hints',
             writer: {
               id: 2,
-              name: "Steve"
+              name: 'Steve'
             },
             articles: [{
               id: 3,
-              title: "AMS",
+              title: 'AMS',
               body: nil
             }]
           }],
@@ -96,11 +113,8 @@ module ActiveModel
       private
 
       def load_adapter(options)
-        adapter_opts, serializer_opts =
-          options.partition { |k, _| ActionController::Serialization::ADAPTER_OPTION_KEYS.include? k }.map { |h| Hash[h] }
-
-        serializer = AlternateBlogSerializer.new(@blog, serializer_opts)
-        ActiveModel::Serializer::Adapter::FlattenJson.new(serializer, adapter_opts)
+        options = options.merge(adapter: :flatten_json, serializer: AlternateBlogSerializer)
+        ActiveModel::SerializableResource.new(@blog, options)
       end
     end
   end

data/test/serializers/root_test.rb

@@ -0,0 +1,21 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class RootTest < Minitest::Test
+      def setup
+        @virtual_value = VirtualValue.new(id: 1)
+      end
+
+      def test_overwrite_root
+        serializer = VirtualValueSerializer.new(@virtual_value, { root: 'smth' })
+        assert_equal('smth', serializer.json_key)
+      end
+
+      def test_underscore_in_root
+        serializer = VirtualValueSerializer.new(@virtual_value)
+        assert_equal('virtual_value', serializer.json_key)
+      end
+    end
+  end
+end

data/test/serializers/serializer_for_test.rb

@@ -26,7 +26,7 @@ module ActiveModel
         end
       end
 
-      class SerializerTest <  Minitest::Test
+      class SerializerTest < Minitest::Test
         class MyProfile < Profile
         end
         class CustomProfile

data/test/support/rails_app.rb

@@ -0,0 +1,21 @@
+class Foo < Rails::Application
+  if Rails::VERSION::MAJOR >= 4
+    config.eager_load = false
+    config.secret_key_base = 'abc123'
+    config.action_controller.perform_caching = true
+    config.active_support.test_order = :random
+    config.logger = Logger.new(nil)
+    ActionController::Base.cache_store = :memory_store
+  end
+end
+Foo.initialize!
+
+module TestHelper
+  Routes = ActionDispatch::Routing::RouteSet.new
+  Routes.draw do
+    get ':controller(/:action(/:id))'
+    get ':controller(/:action)'
+  end
+
+  ActionController::Base.send :include, Routes.url_helpers
+end

data/test/support/serialization_testing.rb

@@ -0,0 +1,13 @@
+class Minitest::Test
+  def before_setup
+    ActionController::Base.cache_store.clear
+  end
+
+  def with_adapter(adapter)
+    old_adapter = ActiveModel::Serializer.config.adapter
+    ActiveModel::Serializer.config.adapter = adapter
+    yield
+  ensure
+    ActiveModel::Serializer.config.adapter = old_adapter
+  end
+end

data/test/support/simplecov.rb

@@ -0,0 +1,6 @@
+# https://github.com/colszowka/simplecov/pull/400
+# https://github.com/ruby/ruby/blob/trunk/lib/English.rb
+unless defined?(English)
+  # The exception object passed to +raise+.
+  alias $ERROR_INFO $! # rubocop:disable Style/SpecialGlobalVars
+end

data/test/support/stream_capture.rb

@@ -0,0 +1,50 @@
+# Use cleaner stream testing interface from Rails 5 if available
+# see https://github.com/rails/rails/blob/29959eb59d/activesupport/lib/active_support/testing/stream.rb
+begin
+  require 'active_support/testing/stream'
+rescue LoadError
+  require 'tempfile'
+  module ActiveSupport
+    module Testing
+      module Stream #:nodoc:
+        private
+
+        def silence_stream(stream)
+          old_stream = stream.dup
+          stream.reopen(IO::NULL)
+          stream.sync = true
+          yield
+        ensure
+          stream.reopen(old_stream)
+          old_stream.close
+        end
+
+        def quietly
+          silence_stream(STDOUT) do
+            silence_stream(STDERR) do
+              yield
+            end
+          end
+        end
+
+        def capture(stream)
+          stream = stream.to_s
+          captured_stream = Tempfile.new(stream)
+          stream_io = eval("$#{stream}") # rubocop:disable Lint/Eval
+          origin_stream = stream_io.dup
+          stream_io.reopen(captured_stream)
+
+          yield
+
+          stream_io.rewind
+          return captured_stream.read
+        ensure
+          captured_stream.close
+          captured_stream.unlink
+          stream_io.reopen(origin_stream)
+        end
+      end
+    end
+  end
+end
+

data/test/support/test_case.rb

@@ -0,0 +1,5 @@
+ActionController::TestCase.class_eval do
+  def setup
+    @routes = TestHelper::Routes
+  end
+end

data/test/test_helper.rb

@@ -1,44 +1,56 @@
 require 'bundler/setup'
 
+begin
+  require 'simplecov'
+  # HACK: till https://github.com/colszowka/simplecov/pull/400 is merged and released.
+  # Otherwise you may get:
+  # simplecov-0.10.0/lib/simplecov/defaults.rb:50: warning: global variable `$ERROR_INFO' not initialized
+  require 'support/simplecov'
+  AppCoverage.start
+rescue LoadError
+  STDERR.puts 'Running without SimpleCov'
+end
+
+require 'timecop'
 require 'rails'
 require 'action_controller'
 require 'action_controller/test_case'
 require 'action_controller/railtie'
 require 'active_support/json'
-require 'minitest/autorun'
 require 'fileutils'
-# Ensure backward compatibility with Minitest 4
-Minitest::Test = MiniTest::Unit::TestCase unless defined?(Minitest::Test)
-
-require 'active_model_serializers'
+FileUtils.mkdir_p(File.expand_path('../../tmp/cache', __FILE__))
 
-class Foo < Rails::Application
-  if Rails::VERSION::MAJOR >= 4
-    config.eager_load = false
-    config.secret_key_base = 'abc123'
-    config.action_controller.perform_caching = true
-    config.active_support.test_order = :random
-    config.logger = Logger.new(nil)
-    ActionController::Base.cache_store = :memory_store
+gem 'minitest'
+require 'minitest/autorun'
+if defined?(Minitest::Test)
+  # Minitest 5
+  # https://github.com/seattlerb/minitest/blob/e21fdda9d/lib/minitest/autorun.rb
+  # https://github.com/seattlerb/minitest/blob/e21fdda9d/lib/minitest.rb#L45-L59
+else
+  # Minitest 4
+  # https://github.com/seattlerb/minitest/blob/644a52fd0/lib/minitest/autorun.rb
+  # https://github.com/seattlerb/minitest/blob/644a52fd0/lib/minitest/unit.rb#L768-L787
+  # Ensure backward compatibility with Minitest 4
+  Minitest = MiniTest unless defined?(Minitest)
+  Minitest::Test = MiniTest::Unit::TestCase
+  def Minitest.after_run(&block)
+    MiniTest::Unit.after_tests(&block)
   end
 end
-FileUtils.mkdir_p(File.expand_path('../../tmp/cache', __FILE__))
-Foo.initialize!
 
-require 'fixtures/poro'
+require 'capture_warnings'
+CaptureWarnings.new(_fail_build = true).execute!
 
-module TestHelper
-  Routes = ActionDispatch::Routing::RouteSet.new
-  Routes.draw do
-    get ':controller(/:action(/:id))'
-    get ':controller(/:action)'
-  end
+require 'active_model_serializers'
 
-  ActionController::Base.send :include, Routes.url_helpers
-end
+require 'support/stream_capture'
 
-ActionController::TestCase.class_eval do
-  def setup
-    @routes = TestHelper::Routes
-  end
-end
+require 'support/rails_app'
+
+require 'support/test_case'
+
+require 'support/serialization_testing'
+
+require 'fixtures/active_record'
+
+require 'fixtures/poro'

data/test/utils/include_args_to_hash_test.rb

@@ -0,0 +1,79 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    module Utils
+      class IncludeArgsToHashTest < Minitest::Test
+        def test_nil
+          input = nil
+          expected = {}
+          actual = ActiveModel::Serializer::Utils.include_args_to_hash(input)
+          assert_equal(expected, actual)
+        end
+
+        def test_empty_string
+          input = ''
+          expected = {}
+          actual = ActiveModel::Serializer::Utils.include_args_to_hash(input)
+          assert_equal(expected, actual)
+        end
+
+        def test_single_string
+          input = 'author'
+          expected = { author: {} }
+          actual = ActiveModel::Serializer::Utils.include_args_to_hash(input)
+          assert_equal(expected, actual)
+        end
+
+        def test_multiple_strings
+          input = 'author,comments'
+          expected = { author: {}, comments: {} }
+          actual = ActiveModel::Serializer::Utils.include_args_to_hash(input)
+          assert_equal(expected, actual)
+        end
+
+        def test_multiple_strings_with_space
+          input = 'author, comments'
+          expected = { author: {}, comments: {} }
+          actual = ActiveModel::Serializer::Utils.include_args_to_hash(input)
+          assert_equal(expected, actual)
+        end
+
+        def test_nested_string
+          input = 'posts.author'
+          expected = { posts: { author: {} } }
+          actual = ActiveModel::Serializer::Utils.include_args_to_hash(input)
+          assert_equal(expected, actual)
+        end
+
+        def test_multiple_nested_string
+          input = 'posts.author,posts.comments.author,comments'
+          expected = { posts: { author: {}, comments: { author: {} } }, comments: {} }
+          actual = ActiveModel::Serializer::Utils.include_args_to_hash(input)
+          assert_equal(expected, actual)
+        end
+
+        def test_empty_array
+          input = []
+          expected = {}
+          actual = ActiveModel::Serializer::Utils.include_args_to_hash(input)
+          assert_equal(expected, actual)
+        end
+
+        def test_simple_array
+          input = [:comments, :author]
+          expected = { author: {}, comments: {} }
+          actual = ActiveModel::Serializer::Utils.include_args_to_hash(input)
+          assert_equal(expected, actual)
+        end
+
+        def test_nested_array
+          input = [:comments, posts: [:author, comments: [:author]]]
+          expected = { posts: { author: {}, comments: { author: {} } }, comments: {} }
+          actual = ActiveModel::Serializer::Utils.include_args_to_hash(input)
+          assert_equal(expected, actual)
+        end
+      end
+    end
+  end
+end