active_model_serializers 0.8.3 → 0.10.0.rc4

data/test/serializers/cache_test.rb

@@ -0,0 +1,209 @@
+require 'test_helper'
+require 'tmpdir'
+require 'tempfile'
+module ActiveModel
+  class Serializer
+    class CacheTest < ActiveSupport::TestCase
+      include ActiveSupport::Testing::Stream
+
+      def setup
+        ActionController::Base.cache_store.clear
+        @comment        = Comment.new(id: 1, body: 'ZOMG A COMMENT')
+        @post           = Post.new(title: 'New Post', body: 'Body')
+        @bio            = Bio.new(id: 1, content: 'AMS Contributor')
+        @author         = Author.new(name: 'Joao M. D. Moura')
+        @blog           = Blog.new(id: 999, name: 'Custom blog', writer: @author, articles: [])
+        @role           = Role.new(name: 'Great Author')
+        @location       = Location.new(lat: '-23.550520', lng: '-46.633309')
+        @place          = Place.new(name: 'Amazing Place')
+        @author.posts   = [@post]
+        @author.roles   = [@role]
+        @role.author    = @author
+        @author.bio     = @bio
+        @bio.author     = @author
+        @post.comments  = [@comment]
+        @post.author    = @author
+        @comment.post   = @post
+        @comment.author = @author
+        @post.blog      = @blog
+        @location.place = @place
+
+        @location_serializer = LocationSerializer.new(@location)
+        @bio_serializer      = BioSerializer.new(@bio)
+        @role_serializer     = RoleSerializer.new(@role)
+        @post_serializer     = PostSerializer.new(@post)
+        @author_serializer   = AuthorSerializer.new(@author)
+        @comment_serializer  = CommentSerializer.new(@comment)
+        @blog_serializer     = BlogSerializer.new(@blog)
+      end
+
+      def test_inherited_cache_configuration
+        inherited_serializer = Class.new(PostSerializer)
+
+        assert_equal PostSerializer._cache_key, inherited_serializer._cache_key
+        assert_equal PostSerializer._cache_options, inherited_serializer._cache_options
+      end
+
+      def test_override_cache_configuration
+        inherited_serializer = Class.new(PostSerializer) do
+          cache key: 'new-key'
+        end
+
+        assert_equal PostSerializer._cache_key, 'post'
+        assert_equal inherited_serializer._cache_key, 'new-key'
+      end
+
+      def test_cache_definition
+        assert_equal(ActionController::Base.cache_store, @post_serializer.class._cache)
+        assert_equal(ActionController::Base.cache_store, @author_serializer.class._cache)
+        assert_equal(ActionController::Base.cache_store, @comment_serializer.class._cache)
+      end
+
+      def test_cache_key_definition
+        assert_equal('post', @post_serializer.class._cache_key)
+        assert_equal('writer', @author_serializer.class._cache_key)
+        assert_equal(nil, @comment_serializer.class._cache_key)
+      end
+
+      def test_cache_key_interpolation_with_updated_at
+        render_object_with_cache(@author)
+        assert_equal(nil, ActionController::Base.cache_store.fetch(@author.cache_key))
+        assert_equal(@author_serializer.attributes.to_json, ActionController::Base.cache_store.fetch("#{@author_serializer.class._cache_key}/#{@author_serializer.object.id}-#{@author_serializer.object.updated_at.strftime("%Y%m%d%H%M%S%9N")}").to_json)
+      end
+
+      def test_default_cache_key_fallback
+        render_object_with_cache(@comment)
+        assert_equal(@comment_serializer.attributes.to_json, ActionController::Base.cache_store.fetch(@comment.cache_key).to_json)
+      end
+
+      def test_cache_options_definition
+        assert_equal({ expires_in: 0.1, skip_digest: true }, @post_serializer.class._cache_options)
+        assert_equal(nil, @blog_serializer.class._cache_options)
+        assert_equal({ expires_in: 1.day, skip_digest: true }, @comment_serializer.class._cache_options)
+      end
+
+      def test_fragment_cache_definition
+        assert_equal([:name], @role_serializer.class._cache_only)
+        assert_equal([:content], @bio_serializer.class._cache_except)
+      end
+
+      def test_associations_separately_cache
+        ActionController::Base.cache_store.clear
+        assert_equal(nil, ActionController::Base.cache_store.fetch(@post.cache_key))
+        assert_equal(nil, ActionController::Base.cache_store.fetch(@comment.cache_key))
+
+        Timecop.freeze(Time.now) do
+          render_object_with_cache(@post)
+
+          assert_equal(@post_serializer.attributes, ActionController::Base.cache_store.fetch(@post.cache_key))
+          assert_equal(@comment_serializer.attributes, ActionController::Base.cache_store.fetch(@comment.cache_key))
+        end
+      end
+
+      def test_associations_cache_when_updated
+        # Clean the Cache
+        ActionController::Base.cache_store.clear
+
+        Timecop.freeze(Time.now) do
+          # Generate a new Cache of Post object and each objects related to it.
+          render_object_with_cache(@post)
+
+          # Check if it cached the objects separately
+          assert_equal(@post_serializer.attributes, ActionController::Base.cache_store.fetch(@post.cache_key))
+          assert_equal(@comment_serializer.attributes, ActionController::Base.cache_store.fetch(@comment.cache_key))
+
+          # Simulating update on comments relationship with Post
+          new_comment            = Comment.new(id: 2, body: 'ZOMG A NEW COMMENT')
+          new_comment_serializer = CommentSerializer.new(new_comment)
+          @post.comments         = [new_comment]
+
+          # Ask for the serialized object
+          render_object_with_cache(@post)
+
+          # Check if the the new comment was cached
+          assert_equal(new_comment_serializer.attributes, ActionController::Base.cache_store.fetch(new_comment.cache_key))
+          assert_equal(@post_serializer.attributes, ActionController::Base.cache_store.fetch(@post.cache_key))
+        end
+      end
+
+      def test_fragment_fetch_with_virtual_associations
+        expected_result = {
+          id: @location.id,
+          lat: @location.lat,
+          lng: @location.lng,
+          place: 'Nowhere'
+        }
+
+        hash = render_object_with_cache(@location)
+
+        assert_equal(hash, expected_result)
+        assert_equal({ place: 'Nowhere' }, ActionController::Base.cache_store.fetch(@location.cache_key))
+      end
+
+      def test_uses_file_digest_in_cache_key
+        render_object_with_cache(@blog)
+        assert_equal(@blog_serializer.attributes, ActionController::Base.cache_store.fetch(@blog.cache_key_with_digest))
+      end
+
+      def test_cache_digest_definition
+        assert_equal(::Model::FILE_DIGEST, @post_serializer.class._cache_digest)
+      end
+
+      def test_serializer_file_path_on_nix
+        path = '/Users/git/emberjs/ember-crm-backend/app/serializers/lead_serializer.rb'
+        caller_line = "#{path}:1:in `<top (required)>'"
+        assert_equal caller_line[ActiveModel::Serializer::CALLER_FILE], path
+      end
+
+      def test_serializer_file_path_on_windows
+        path = 'c:/git/emberjs/ember-crm-backend/app/serializers/lead_serializer.rb'
+        caller_line = "#{path}:1:in `<top (required)>'"
+        assert_equal caller_line[ActiveModel::Serializer::CALLER_FILE], path
+      end
+
+      def test_serializer_file_path_with_space
+        path = '/Users/git/ember js/ember-crm-backend/app/serializers/lead_serializer.rb'
+        caller_line = "#{path}:1:in `<top (required)>'"
+        assert_equal caller_line[ActiveModel::Serializer::CALLER_FILE], path
+      end
+
+      def test_serializer_file_path_with_submatch
+        # The submatch in the path ensures we're using a correctly greedy regexp.
+        path = '/Users/git/ember js/ember:123:in x/app/serializers/lead_serializer.rb'
+        caller_line = "#{path}:1:in `<top (required)>'"
+        assert_equal caller_line[ActiveModel::Serializer::CALLER_FILE], path
+      end
+
+      def test_digest_caller_file
+        contents = "puts 'AMS rocks'!"
+        dir = Dir.mktmpdir('space char')
+        file = Tempfile.new('some_ruby.rb', dir)
+        file.write(contents)
+        path = file.path
+        caller_line = "#{path}:1:in `<top (required)>'"
+        file.close
+        assert_equal ActiveModel::Serializer.digest_caller_file(caller_line), Digest::MD5.hexdigest(contents)
+      ensure
+        file.unlink
+        FileUtils.remove_entry dir
+      end
+
+      def test_warn_on_serializer_not_defined_in_file
+        called = false
+        serializer = Class.new(ActiveModel::Serializer)
+        assert_match(/_cache_digest/, (capture(:stderr) do
+          serializer.digest_caller_file('')
+          called = true
+        end))
+        assert called
+      end
+
+      private
+
+      def render_object_with_cache(obj)
+        ActiveModel::SerializableResource.new(obj).serializable_hash
+      end
+    end
+  end
+end
+

data/test/serializers/configuration_test.rb

@@ -0,0 +1,32 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class ConfigurationTest < ActiveSupport::TestCase
+      def test_collection_serializer
+        assert_equal ActiveModel::Serializer::CollectionSerializer, ActiveModelSerializers.config.collection_serializer
+      end
+
+      def test_array_serializer
+        assert_equal ActiveModel::Serializer::CollectionSerializer, ActiveModelSerializers.config.array_serializer
+      end
+
+      def test_setting_array_serializer_sets_collection_serializer
+        config = ActiveModelSerializers.config
+        old_config = config.dup
+        begin
+          assert_equal ActiveModel::Serializer::CollectionSerializer, config.collection_serializer
+          config.array_serializer = :foo
+          assert_equal config.array_serializer, :foo
+          assert_equal config.collection_serializer, :foo
+        ensure
+          ActiveModelSerializers.config.replace(old_config)
+        end
+      end
+
+      def test_default_adapter
+        assert_equal :attributes, ActiveModelSerializers.config.adapter
+      end
+    end
+  end
+end

data/test/serializers/fieldset_test.rb

@@ -0,0 +1,14 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class FieldsetTest < ActiveSupport::TestCase
+      def test_fieldset_with_hash
+        fieldset = ActiveModel::Serializer::Fieldset.new('post' => %w(id title), 'comment' => ['body'])
+        expected = { :post => [:id, :title], :comment => [:body] }
+
+        assert_equal(expected, fieldset.fields)
+      end
+    end
+  end
+end

data/test/serializers/meta_test.rb

@@ -0,0 +1,130 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class MetaTest < ActiveSupport::TestCase
+      def setup
+        @blog = Blog.new(id: 1,
+                         name: 'AMS Hints',
+                         writer: Author.new(id: 2, name: 'Steve'),
+                         articles: [Post.new(id: 3, title: 'AMS')])
+      end
+
+      def test_meta_is_present_with_root
+        actual = ActiveModel::SerializableResource.new(
+          @blog,
+          adapter: :json,
+          serializer: AlternateBlogSerializer,
+          meta: { total: 10 }).as_json
+        expected = {
+          blog: {
+            id: 1,
+            title: 'AMS Hints'
+          },
+          'meta' => {
+            total: 10
+          }
+        }
+        assert_equal(expected, actual)
+      end
+
+      def test_meta_is_not_included_when_root_is_missing
+        actual = ActiveModel::SerializableResource.new(
+          @blog,
+          adapter: :attributes,
+          serializer: AlternateBlogSerializer,
+          meta: { total: 10 }).as_json
+        expected = {
+          id: 1,
+          title: 'AMS Hints'
+        }
+        assert_equal(expected, actual)
+      end
+
+      def test_meta_key_is_used
+        actual = ActiveModel::SerializableResource.new(
+          @blog,
+          adapter: :json,
+          serializer: AlternateBlogSerializer,
+          meta: { total: 10 },
+          meta_key: 'haha_meta').as_json
+        expected = {
+          blog: {
+            id: 1,
+            title: 'AMS Hints'
+          },
+          'haha_meta' => {
+            total: 10
+          }
+        }
+        assert_equal(expected, actual)
+      end
+
+      def test_meta_key_is_used_with_json_api
+        actual = ActiveModel::SerializableResource.new(
+          @blog,
+          adapter: :json_api,
+          serializer: AlternateBlogSerializer,
+          meta: { total: 10 },
+          meta_key: 'haha_meta').as_json
+        expected = {
+          data: {
+            id: '1',
+            type: 'blogs',
+            attributes: { title: 'AMS Hints' }
+          },
+          'haha_meta' => { total: 10 }
+        }
+        assert_equal(expected, actual)
+      end
+
+      def test_meta_is_not_present_on_arrays_without_root
+        actual = ActiveModel::SerializableResource.new(
+          [@blog],
+          adapter: :attributes,
+          meta: { total: 10 }).as_json
+        expected = [{
+          id: 1,
+          name: 'AMS Hints',
+          writer: {
+            id: 2,
+            name: 'Steve'
+          },
+          articles: [{
+            id: 3,
+            title: 'AMS',
+            body: nil
+          }]
+        }]
+        assert_equal(expected, actual)
+      end
+
+      def test_meta_is_present_on_arrays_with_root
+        actual = ActiveModel::SerializableResource.new(
+          [@blog],
+          adapter: :json,
+          meta: { total: 10 },
+          meta_key: 'haha_meta').as_json
+        expected = {
+          blogs: [{
+            id: 1,
+            name: 'AMS Hints',
+            writer: {
+              id: 2,
+              name: 'Steve'
+            },
+            articles: [{
+              id: 3,
+              title: 'AMS',
+              body: nil
+            }]
+          }],
+          'haha_meta' => {
+            total: 10
+          }
+        }
+        assert_equal(expected, actual)
+      end
+    end
+  end
+end

data/test/serializers/options_test.rb

@@ -0,0 +1,21 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class OptionsTest < ActiveSupport::TestCase
+      def setup
+        @profile = Profile.new(name: 'Name 1', description: 'Description 1')
+      end
+
+      def test_options_are_accessible
+        @profile_serializer = ProfileSerializer.new(@profile, my_options: :accessible)
+        assert @profile_serializer.arguments_passed_in?
+      end
+
+      def test_no_option_is_passed_in
+        @profile_serializer = ProfileSerializer.new(@profile)
+        refute @profile_serializer.arguments_passed_in?
+      end
+    end
+  end
+end

data/test/serializers/root_test.rb

@@ -0,0 +1,21 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class RootTest < ActiveSupport::TestCase
+      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

@@ -0,0 +1,134 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class SerializerForTest < ActiveSupport::TestCase
+      class CollectionSerializerTest < ActiveSupport::TestCase
+        def setup
+          @array = [1, 2, 3]
+          @previous_collection_serializer = ActiveModelSerializers.config.collection_serializer
+        end
+
+        def teardown
+          ActiveModelSerializers.config.collection_serializer = @previous_collection_serializer
+        end
+
+        def test_serializer_for_array
+          serializer = ActiveModel::Serializer.serializer_for(@array)
+          assert_equal ActiveModelSerializers.config.collection_serializer, serializer
+        end
+
+        def test_overwritten_serializer_for_array
+          new_collection_serializer = Class.new
+          ActiveModelSerializers.config.collection_serializer = new_collection_serializer
+          serializer = ActiveModel::Serializer.serializer_for(@array)
+          assert_equal new_collection_serializer, serializer
+        end
+      end
+
+      class SerializerTest < ActiveSupport::TestCase
+        module ResourceNamespace
+          Post    = Class.new(::Model)
+          Comment = Class.new(::Model)
+
+          class PostSerializer < ActiveModel::Serializer
+            class CommentSerializer < ActiveModel::Serializer
+            end
+          end
+        end
+
+        class MyProfile < Profile
+        end
+
+        class CustomProfile
+          def serializer_class; ProfileSerializer; end
+        end
+
+        Tweet = Class.new(::Model)
+        TweetSerializer = Class.new
+
+        def setup
+          @profile = Profile.new
+          @my_profile = MyProfile.new
+          @custom_profile = CustomProfile.new
+          @model = ::Model.new
+          @tweet = Tweet.new
+        end
+
+        def test_serializer_for_non_ams_serializer
+          serializer = ActiveModel::Serializer.serializer_for(@tweet)
+          assert_equal nil, serializer
+        end
+
+        def test_serializer_for_existing_serializer
+          serializer = ActiveModel::Serializer.serializer_for(@profile)
+          assert_equal ProfileSerializer, serializer
+        end
+
+        def test_serializer_for_existing_serializer_with_lookup_disabled
+          serializer = with_serializer_lookup_disabled do
+            ActiveModel::Serializer.serializer_for(@profile)
+          end
+          assert_equal nil, serializer
+        end
+
+        def test_serializer_for_not_existing_serializer
+          serializer = ActiveModel::Serializer.serializer_for(@model)
+          assert_equal nil, serializer
+        end
+
+        def test_serializer_inherited_serializer
+          serializer = ActiveModel::Serializer.serializer_for(@my_profile)
+          assert_equal ProfileSerializer, serializer
+        end
+
+        def test_serializer_inherited_serializer_with_lookup_disabled
+          serializer = with_serializer_lookup_disabled do
+            ActiveModel::Serializer.serializer_for(@my_profile)
+          end
+          assert_equal nil, serializer
+        end
+
+        def test_serializer_custom_serializer
+          serializer = ActiveModel::Serializer.serializer_for(@custom_profile)
+          assert_equal ProfileSerializer, serializer
+        end
+
+        def test_serializer_custom_serializer_with_lookup_disabled
+          serializer = with_serializer_lookup_disabled do
+            ActiveModel::Serializer.serializer_for(@custom_profile)
+          end
+          assert_equal ProfileSerializer, serializer
+        end
+
+        def test_serializer_for_namespaced_resource
+          post = ResourceNamespace::Post.new
+          serializer = ActiveModel::Serializer.serializer_for(post)
+          assert_equal ResourceNamespace::PostSerializer, serializer
+        end
+
+        def test_serializer_for_namespaced_resource_with_lookup_disabled
+          post = ResourceNamespace::Post.new
+          serializer = with_serializer_lookup_disabled do
+            ActiveModel::Serializer.serializer_for(post)
+          end
+          assert_equal nil, serializer
+        end
+
+        def test_serializer_for_nested_resource
+          comment = ResourceNamespace::Comment.new
+          serializer = ResourceNamespace::PostSerializer.serializer_for(comment)
+          assert_equal ResourceNamespace::PostSerializer::CommentSerializer, serializer
+        end
+
+        def test_serializer_for_nested_resource_with_lookup_disabled
+          comment = ResourceNamespace::Comment.new
+          serializer = with_serializer_lookup_disabled do
+            ResourceNamespace::PostSerializer.serializer_for(comment)
+          end
+          assert_equal nil, serializer
+        end
+      end
+    end
+  end
+end

data/test/support/custom_schemas/active_model_serializers/test/schema_test/my/index.json

@@ -0,0 +1,6 @@
+{
+  "properties": {
+    "name" : { "type" : "string" },
+    "description" : { "type" : "string" }
+  }
+}

data/test/support/isolated_unit.rb

@@ -0,0 +1,77 @@
+# https://github.com/rails/rails/blob/v5.0.0.beta1/railties/test/isolation/abstract_unit.rb
+
+# Usage Example:
+#
+# require 'support/isolated_unit'
+#
+# class RailtieTest < ActiveSupport::TestCase
+#   include ActiveSupport::Testing::Isolation
+#
+#   class WithRailsDefinedOnLoad < RailtieTest
+#     setup do
+#       require 'rails'
+#       require 'active_model_serializers'
+#       make_basic_app
+#     end
+#
+#     # some tests
+#   end
+#
+#   class WithoutRailsDefinedOnLoad < RailtieTest
+#     setup do
+#       require 'active_model_serializers'
+#       make_basic_app
+#     end
+#
+#     # some tests
+#   end
+# end
+#
+# Note:
+# It is important to keep this file as light as possible
+# the goal for tests that require this is to test booting up
+# rails from an empty state, so anything added here could
+# hide potential failures
+#
+# It is also good to know what is the bare minimum to get
+# Rails booted up.
+require 'bundler/setup' unless defined?(Bundler)
+require 'active_support'
+require 'active_support/core_ext/string/access'
+
+# These files do not require any others and are needed
+# to run the tests
+require 'active_support/testing/autorun'
+require 'active_support/testing/isolation'
+
+module TestHelpers
+  module Generation
+    # Make a very basic app, without creating the whole directory structure.
+    # Is faster and simpler than generating a Rails app in a temp directory
+    def make_basic_app
+      require 'rails'
+      require 'action_controller/railtie'
+
+      @app = Class.new(Rails::Application) do
+        config.eager_load = false
+        config.session_store :cookie_store, key: '_myapp_session'
+        config.active_support.deprecation = :log
+        config.active_support.test_order = :parallel
+        ActiveSupport::TestCase.respond_to?(:test_order=) && ActiveSupport::TestCase.test_order = :parallel
+        config.root = File.dirname(__FILE__)
+        config.log_level = :info
+        # Set a fake logger to avoid creating the log directory automatically
+        fake_logger = Logger.new(nil)
+        config.logger = fake_logger
+      end
+      @app.respond_to?(:secrets) && @app.secrets.secret_key_base = '3b7cd727ee24e8444053437c36cc66c4'
+
+      yield @app if block_given?
+      @app.initialize!
+    end
+  end
+end
+
+class ActiveSupport::TestCase
+  include TestHelpers::Generation
+end

data/test/support/rails5_shims.rb

@@ -0,0 +1,29 @@
+module Rails5Shims
+  module ControllerTests
+    # https://github.com/rails/rails/blob/b217354/actionpack/lib/action_controller/test_case.rb
+    REQUEST_KWARGS = [:params, :session, :flash, :method, :body, :xhr]
+
+    # Fold kwargs from test request into args
+    # Band-aid for DEPRECATION WARNING
+    def get(path, *args)
+      hash = args && args[0]
+      if hash.respond_to?(:key)
+        Rails5Shims::ControllerTests::REQUEST_KWARGS.each do |kwarg|
+          next unless hash.key?(kwarg)
+          hash.merge! hash.delete(kwarg)
+        end
+      end
+      super
+    end
+
+    # Uncomment for debugging where the kwargs warnings come from
+    # def non_kwarg_request_warning
+    #   super.tap do
+    #     STDOUT.puts caller[2..3]
+    #   end
+    # end
+  end
+end
+if Rails::VERSION::MAJOR < 5
+  ActionController::TestCase.send :include, Rails5Shims::ControllerTests
+end