active_model_serializers 0.10.0 → 0.10.2

data/test/cache_test.rb

@@ -101,14 +101,14 @@ module ActiveModelSerializers
       uncached_author_serializer = AuthorSerializer.new(uncached_author)
 
       render_object_with_cache(uncached_author)
-      key = "#{uncached_author_serializer.class._cache_key}/#{uncached_author_serializer.object.id}-#{uncached_author_serializer.object.updated_at.strftime("%Y%m%d%H%M%S%9N")}"
-      key = "#{key}/#{adapter.cached_name}"
+      key = "#{uncached_author_serializer.class._cache_key}/#{uncached_author_serializer.object.id}-#{uncached_author_serializer.object.updated_at.strftime('%Y%m%d%H%M%S%9N')}"
+      key = "#{key}/#{adapter.cache_key}"
       assert_equal(uncached_author_serializer.attributes.to_json, cache_store.fetch(key).to_json)
     end
 
     def test_default_cache_key_fallback
       render_object_with_cache(@comment)
-      key = "#{@comment.cache_key}/#{adapter.cached_name}"
+      key = "#{@comment.cache_key}/#{adapter.cache_key}"
       assert_equal(@comment_serializer.attributes.to_json, cache_store.fetch(key).to_json)
     end
 
@@ -117,7 +117,7 @@ module ActiveModelSerializers
       e = assert_raises ActiveModel::Serializer::UndefinedCacheKey do
         render_object_with_cache(article)
       end
-      assert_match(/ActiveModelSerializers::CacheTest::Article must define #cache_key, or the 'key:' option must be passed into 'CachedActiveModelSerializers_CacheTest_ArticleSerializer.cache'/, e.message)
+      assert_match(/ActiveModelSerializers::CacheTest::Article must define #cache_key, or the 'key:' option must be passed into 'ActiveModelSerializers::CacheTest::ArticleSerializer.cache'/, e.message)
     end
 
     def test_cache_options_definition
@@ -127,7 +127,7 @@ module ActiveModelSerializers
     end
 
     def test_fragment_cache_definition
-      assert_equal([:name], @role_serializer.class._cache_only)
+      assert_equal([:name, :slug], @role_serializer.class._cache_only)
       assert_equal([:content], @bio_serializer.class._cache_except)
     end
 
@@ -139,9 +139,9 @@ module ActiveModelSerializers
       Timecop.freeze(Time.current) do
         render_object_with_cache(@post)
 
-        key = "#{@post.cache_key}/#{adapter.cached_name}"
+        key = "#{@post.cache_key}/#{adapter.cache_key}"
         assert_equal(@post_serializer.attributes, cache_store.fetch(key))
-        key = "#{@comment.cache_key}/#{adapter.cached_name}"
+        key = "#{@comment.cache_key}/#{adapter.cache_key}"
         assert_equal(@comment_serializer.attributes, cache_store.fetch(key))
       end
     end
@@ -152,9 +152,9 @@ module ActiveModelSerializers
         render_object_with_cache(@post)
 
         # Check if it cached the objects separately
-        key = "#{@post.cache_key}/#{adapter.cached_name}"
+        key = "#{@post.cache_key}/#{adapter.cache_key}"
         assert_equal(@post_serializer.attributes, cache_store.fetch(key))
-        key = "#{@comment.cache_key}/#{adapter.cached_name}"
+        key = "#{@comment.cache_key}/#{adapter.cache_key}"
         assert_equal(@comment_serializer.attributes, cache_store.fetch(key))
 
         # Simulating update on comments relationship with Post
@@ -166,9 +166,9 @@ module ActiveModelSerializers
         render_object_with_cache(@post)
 
         # Check if the the new comment was cached
-        key = "#{new_comment.cache_key}/#{adapter.cached_name}"
+        key = "#{new_comment.cache_key}/#{adapter.cache_key}"
         assert_equal(new_comment_serializer.attributes, cache_store.fetch(key))
-        key = "#{@post.cache_key}/#{adapter.cached_name}"
+        key = "#{@post.cache_key}/#{adapter.cache_key}"
         assert_equal(@post_serializer.attributes, cache_store.fetch(key))
       end
     end
@@ -178,14 +178,14 @@ module ActiveModelSerializers
         id: @location.id,
         lat: @location.lat,
         lng: @location.lng,
-        place: 'Nowhere'
+        address: 'Nowhere'
       }
 
       hash = render_object_with_cache(@location)
 
       assert_equal(hash, expected_result)
-      key = "#{@location.cache_key}/#{adapter.cached_name}"
-      assert_equal({ place: 'Nowhere' }, cache_store.fetch(key))
+      key = "#{@location.cache_key}/#{adapter.cache_key}"
+      assert_equal({ address: 'Nowhere' }, cache_store.fetch(key))
     end
 
     def test_fragment_cache_with_inheritance
@@ -204,7 +204,7 @@ module ActiveModelSerializers
 
     # Based on original failing test by @kevintyll
     # rubocop:disable Metrics/AbcSize
-    def test_a_serializer_rendered_by_two_adapter_returns_differently_cached_attributes
+    def test_a_serializer_rendered_by_two_adapter_returns_differently_fetch_attributes
       Object.const_set(:Alert, Class.new(ActiveModelSerializers::Model) do
         attr_accessor :id, :status, :resource, :started_at, :ended_at, :updated_at, :created_at
       end)
@@ -225,7 +225,7 @@ module ActiveModelSerializers
         created_at: Time.new(2016, 3, 31, 21, 37, 35, 0)
       )
 
-      expected_cached_attributes = {
+      expected_fetch_attributes = {
         id: 1,
         status: 'fail',
         resource: 'resource-1',
@@ -250,7 +250,7 @@ module ActiveModelSerializers
       # Assert attributes are serialized correctly
       serializable_alert = serializable(alert, serializer: AlertSerializer, adapter: :attributes)
       attributes_serialization = serializable_alert.as_json
-      assert_equal expected_cached_attributes, alert.attributes
+      assert_equal expected_fetch_attributes, alert.attributes
       assert_equal alert.attributes, attributes_serialization
       attributes_cache_key = serializable_alert.adapter.serializer.cache_key(serializable_alert.adapter)
       assert_equal attributes_serialization, cache_store.fetch(attributes_cache_key)
@@ -276,7 +276,7 @@ module ActiveModelSerializers
 
     def test_uses_file_digest_in_cache_key
       render_object_with_cache(@blog)
-      key = "#{@blog.cache_key}/#{adapter.cached_name}/#{::Model::FILE_DIGEST}"
+      key = "#{@blog.cache_key}/#{adapter.cache_key}/#{::Model::FILE_DIGEST}"
       assert_equal(@blog_serializer.attributes, cache_store.fetch(key))
     end
 
@@ -286,33 +286,66 @@ module ActiveModelSerializers
 
     def test_object_cache_keys
       serializable = ActiveModelSerializers::SerializableResource.new([@comment, @comment])
-      include_tree = ActiveModel::Serializer::IncludeTree.from_include_args('*')
+      include_directive = JSONAPI::IncludeDirective.new('*', allow_wildcard: true)
 
-      actual = ActiveModel::Serializer.object_cache_keys(serializable.adapter.serializer, serializable.adapter, include_tree)
+      actual = ActiveModel::Serializer.object_cache_keys(serializable.adapter.serializer, serializable.adapter, include_directive)
 
       assert_equal 3, actual.size
-      assert actual.any? { |key| key == "comment/1/#{serializable.adapter.cached_name}" }
+      assert actual.any? { |key| key == "comment/1/#{serializable.adapter.cache_key}" }
       assert actual.any? { |key| key =~ %r{post/post-\d+} }
       assert actual.any? { |key| key =~ %r{author/author-\d+} }
     end
 
-    def test_cached_attributes
-      serializer = ActiveModel::Serializer::CollectionSerializer.new([@comment, @comment])
+    def test_fetch_attributes_from_cache
+      serializers = ActiveModel::Serializer::CollectionSerializer.new([@comment, @comment])
 
       Timecop.freeze(Time.current) do
         render_object_with_cache(@comment)
 
-        attributes = Adapter::Attributes.new(serializer)
-        attributes.send(:cache_attributes)
-        cached_attributes = attributes.instance_variable_get(:@cached_attributes)
+        options = {}
+        adapter_options = {}
+        adapter_instance = ActiveModelSerializers::Adapter::Attributes.new(serializers, adapter_options)
+        serializers.serializable_hash(adapter_options, options, adapter_instance)
+        cached_attributes = adapter_options.fetch(:cached_attributes)
 
-        assert_equal cached_attributes["#{@comment.cache_key}/#{attributes.cached_name}"], Comment.new(id: 1, body: 'ZOMG A COMMENT').attributes
-        assert_equal cached_attributes["#{@comment.post.cache_key}/#{attributes.cached_name}"], Post.new(id: 'post', title: 'New Post', body: 'Body').attributes
+        include_directive = ActiveModelSerializers.default_include_directive
+        manual_cached_attributes = ActiveModel::Serializer.cache_read_multi(serializers, adapter_instance, include_directive)
+        assert_equal manual_cached_attributes, cached_attributes
+
+        assert_equal cached_attributes["#{@comment.cache_key}/#{adapter_instance.cache_key}"], Comment.new(id: 1, body: 'ZOMG A COMMENT').attributes
+        assert_equal cached_attributes["#{@comment.post.cache_key}/#{adapter_instance.cache_key}"], Post.new(id: 'post', title: 'New Post', body: 'Body').attributes
 
         writer = @comment.post.blog.writer
         writer_cache_key = writer.cache_key
+        assert_equal cached_attributes["#{writer_cache_key}/#{adapter_instance.cache_key}"], Author.new(id: 'author', name: 'Joao M. D. Moura').attributes
+      end
+    end
+
+    def test_cache_read_multi_with_fragment_cache_enabled
+      post_serializer = Class.new(ActiveModel::Serializer) do
+        cache except: [:body]
+      end
 
-        assert_equal cached_attributes["#{writer_cache_key}/#{attributes.cached_name}"], Author.new(id: 'author', name: 'Joao M. D. Moura').attributes
+      serializers = ActiveModel::Serializer::CollectionSerializer.new([@post, @post], serializer: post_serializer)
+
+      Timecop.freeze(Time.current) do
+        # Warming up.
+        options = {}
+        adapter_options = {}
+        adapter_instance = ActiveModelSerializers::Adapter::Attributes.new(serializers, adapter_options)
+        serializers.serializable_hash(adapter_options, options, adapter_instance)
+
+        # Should find something with read_multi now
+        adapter_options = {}
+        serializers.serializable_hash(adapter_options, options, adapter_instance)
+        cached_attributes = adapter_options.fetch(:cached_attributes)
+
+        include_directive = ActiveModelSerializers.default_include_directive
+        manual_cached_attributes = ActiveModel::Serializer.cache_read_multi(serializers, adapter_instance, include_directive)
+
+        refute_equal 0, cached_attributes.size
+        refute_equal 0, manual_cached_attributes.size
+        assert_equal manual_cached_attributes, cached_attributes
       end
     end
 
@@ -429,25 +462,53 @@ module ActiveModelSerializers
     end
 
     def test_fragment_fetch_with_virtual_attributes
-      @author          = Author.new(name: 'Joao M. D. Moura')
-      @role            = Role.new(name: 'Great Author', description: nil)
-      @role.author     = [@author]
-      @role_serializer = RoleSerializer.new(@role)
-      @role_hash       = @role_serializer.fetch_fragment_cache(ActiveModelSerializers::Adapter.configured_adapter.new(@role_serializer))
+      author          = Author.new(name: 'Joao M. D. Moura')
+      role            = Role.new(name: 'Great Author', description: nil)
+      role.author     = [author]
+      role_serializer = RoleSerializer.new(role)
+      adapter_instance = ActiveModelSerializers::Adapter.configured_adapter.new(role_serializer)
+      expected_result = {
+        id: role.id,
+        description: role.description,
+        slug: "#{role.name}-#{role.id}",
+        name: role.name
+      }
+      cache_store.clear
 
+      role_hash = role_serializer.fetch_attributes_fragment(adapter_instance)
+      assert_equal(role_hash, expected_result)
+
+      role.attributes[:id] = 'this has been updated'
+      role.name = 'this was cached'
+
+      role_hash = role_serializer.fetch_attributes_fragment(adapter_instance)
+      assert_equal(expected_result.merge(id: role.id), role_hash)
+    end
+
+    def test_fragment_fetch_with_except
+      adapter_instance = ActiveModelSerializers::Adapter.configured_adapter.new(@bio_serializer)
       expected_result = {
-        id: @role.id,
-        description: @role.description,
-        slug: "#{@role.name}-#{@role.id}",
-        name: @role.name
+        id: @bio.id,
+        rating: nil,
+        content: @bio.content
       }
-      assert_equal(@role_hash, expected_result)
+      cache_store.clear
+
+      bio_hash = @bio_serializer.fetch_attributes_fragment(adapter_instance)
+      assert_equal(expected_result, bio_hash)
+
+      @bio.content = 'this has been updated'
+      @bio.rating = 'this was cached'
+
+      bio_hash = @bio_serializer.fetch_attributes_fragment(adapter_instance)
+      assert_equal(expected_result.merge(content: @bio.content), bio_hash)
     end
 
     def test_fragment_fetch_with_namespaced_object
       @spam            = Spam::UnrelatedLink.new(id: 'spam-id-1')
       @spam_serializer = Spam::UnrelatedLinkSerializer.new(@spam)
-      @spam_hash       = @spam_serializer.fetch_fragment_cache(ActiveModelSerializers::Adapter.configured_adapter.new(@spam_serializer))
+      adapter_instance = ActiveModelSerializers::Adapter.configured_adapter.new(@spam_serializer)
+      @spam_hash       = @spam_serializer.fetch_attributes_fragment(adapter_instance)
       expected_result = {
         id: @spam.id
       }
@@ -476,10 +537,5 @@ module ActiveModelSerializers
     def adapter
       @serializable_resource.adapter
     end
-
-    def cached_serialization(serializer)
-      cache_key = serializer.cache_key(adapter)
-      cache_store.fetch(cache_key)
-    end
   end
 end

data/test/collection_serializer_test.rb

@@ -11,7 +11,7 @@ module ActiveModel
         @comment = Comment.new
         @post = Post.new
         @resource = build_named_collection @comment, @post
-        @serializer = collection_serializer.new(@resource, { some: :options })
+        @serializer = collection_serializer.new(@resource, some: :options)
       end
 
       def collection_serializer
@@ -44,7 +44,7 @@ module ActiveModel
       end
 
       def test_serializer_option_not_passed_to_each_serializer
-        serializers = collection_serializer.new([@post], { serializer: PostSerializer }).to_a
+        serializers = collection_serializer.new([@post], serializer: PostSerializer).to_a
 
         refute serializers.first.custom_options.key?(:serializer)
       end

data/test/fixtures/poro.rb

@@ -8,7 +8,7 @@ class Model < ActiveModelSerializers::Model
   # Convenience when not adding @attributes readers and writers
   def method_missing(meth, *args)
     if meth.to_s =~ /^(.*)=$/
-      attributes[$1.to_sym] = args[0]
+      attributes[Regexp.last_match(1).to_sym] = args[0]
     elsif attributes.key?(meth)
       attributes[meth]
     else
@@ -64,7 +64,7 @@ VirtualValue = Class.new(Model)
 Comment = Class.new(Model) do
   # Uses a custom non-time-based cache key
   def cache_key
-    "#{self.class.name.downcase}/#{self.id}"
+    "#{self.class.name.downcase}/#{id}"
   end
 end
 
@@ -136,10 +136,11 @@ AuthorSerializer = Class.new(ActiveModel::Serializer) do
 end
 
 RoleSerializer = Class.new(ActiveModel::Serializer) do
-  cache only: [:name], skip_digest: true
-  attributes :id, :name, :description, :slug
+  cache only: [:name, :slug], skip_digest: true
+  attributes :id, :name, :description
+  attribute :friendly_id, key: :slug
 
-  def slug
+  def friendly_id
     "#{object.name}-#{object.id}"
   end
 
@@ -153,10 +154,10 @@ LikeSerializer = Class.new(ActiveModel::Serializer) do
 end
 
 LocationSerializer = Class.new(ActiveModel::Serializer) do
-  cache only: [:place], skip_digest: true
+  cache only: [:address], skip_digest: true
   attributes :id, :lat, :lng
 
-  belongs_to :place
+  belongs_to :place, key: :address
 
   def place
     'Nowhere'

data/test/grape_test.rb

@@ -1,82 +1,178 @@
 require 'test_helper'
 require 'grape'
 require 'grape/active_model_serializers'
+require 'kaminari'
+require 'kaminari/hooks'
+::Kaminari::Hooks.init
+
+module ActiveModelSerializers
+  class GrapeTest < ActiveSupport::TestCase
+    include Rack::Test::Methods
+    module Models
+      def self.model1
+        ARModels::Post.new(id: 1, title: 'Dummy Title', body: 'Lorem Ipsum')
+      end
 
-class ActiveModelSerializers::GrapeTest < ActiveSupport::TestCase
-  include Rack::Test::Methods
-  module Models
-    def self.model1
-      ARModels::Post.new(id: 1, title: 'Dummy Title', body: 'Lorem Ipsum')
-    end
+      def self.model2
+        ARModels::Post.new(id: 2, title: 'Second Dummy Title', body: 'Second Lorem Ipsum')
+      end
+
+      def self.all
+        @all ||=
+          begin
+            model1.save!
+            model2.save!
+            ARModels::Post.all
+          end
+      end
+
+      def self.reset_all
+        ARModels::Post.delete_all
+        @all = nil
+      end
+
+      def self.collection_per
+        2
+      end
 
-    def self.model2
-      ARModels::Post.new(id: 2, title: 'Second Dummy Title', body: 'Second Lorem Ipsum')
+      def self.collection
+        @collection ||=
+          begin
+            Kaminari.paginate_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'),
+                Profile.new(id: 4, name: 'Name 4', description: 'Description 4', comments: 'Comments 4'),
+                Profile.new(id: 5, name: 'Name 5', description: 'Description 5', comments: 'Comments 5')
+              ]
+            ).page(1).per(collection_per)
+          end
+      end
     end
 
-    def self.all
-      @all ||=
-        begin
-          model1.save!
-          model2.save!
-          ARModels::Post.all
+    class GrapeTest < Grape::API
+      format :json
+      include Grape::ActiveModelSerializers
+
+      resources :grape do
+        get '/render' do
+          render Models.model1
         end
-    end
-  end
 
-  class GrapeTest < Grape::API
-    format :json
-    include Grape::ActiveModelSerializers
+        get '/render_with_json_api' do
+          post = Models.model1
+          render post, meta: { page: 1, total_pages: 2 }, adapter: :json_api
+        end
 
-    resources :grape do
-      get '/render' do
-        render Models.model1
-      end
+        get '/render_array_with_json_api' do
+          posts = Models.all
+          render posts, adapter: :json_api
+        end
 
-      get '/render_with_json_api' do
-        post = Models.model1
-        render post, meta: { page: 1, total_pages: 2 }, adapter: :json_api
-      end
+        get '/render_collection_with_json_api' do
+          posts = Models.collection
+          render posts, adapter: :json_api
+        end
 
-      get '/render_array_with_json_api' do
-        posts = Models.all
-        render posts, adapter: :json_api
+        get '/render_with_implicit_formatter' do
+          Models.model1
+        end
+
+        get '/render_array_with_implicit_formatter' do
+          Models.all
+        end
+
+        get '/render_collection_with_implicit_formatter' do
+          Models.collection
+        end
       end
     end
-  end
 
-  def app
-    GrapeTest.new
-  end
+    def app
+      Grape::Middleware::Globals.new(GrapeTest.new)
+    end
 
-  def test_formatter_returns_json
-    get '/grape/render'
+    def test_formatter_returns_json
+      get '/grape/render'
 
-    post = Models.model1
-    serializable_resource = serializable(post)
+      post = Models.model1
+      serializable_resource = serializable(post)
 
-    assert last_response.ok?
-    assert_equal serializable_resource.to_json, last_response.body
-  end
+      assert last_response.ok?
+      assert_equal serializable_resource.to_json, last_response.body
+    end
 
-  def test_render_helper_passes_through_options_correctly
-    get '/grape/render_with_json_api'
+    def test_render_helper_passes_through_options_correctly
+      get '/grape/render_with_json_api'
 
-    post = Models.model1
-    serializable_resource = serializable(post, serializer: ARModels::PostSerializer, adapter: :json_api, meta: { page: 1, total_pages: 2 })
+      post = Models.model1
+      serializable_resource = serializable(post, serializer: ARModels::PostSerializer, adapter: :json_api, meta: { page: 1, total_pages: 2 })
 
-    assert last_response.ok?
-    assert_equal serializable_resource.to_json, last_response.body
-  end
+      assert last_response.ok?
+      assert_equal serializable_resource.to_json, last_response.body
+    end
+
+    def test_formatter_handles_arrays
+      get '/grape/render_array_with_json_api'
+
+      posts = Models.all
+      serializable_resource = serializable(posts, adapter: :json_api)
+
+      assert last_response.ok?
+      assert_equal serializable_resource.to_json, last_response.body
+    ensure
+      Models.reset_all
+    end
+
+    def test_formatter_handles_collections
+      get '/grape/render_collection_with_json_api'
+      assert last_response.ok?
+
+      representation = JSON.parse(last_response.body)
+      assert representation.include?('data')
+      assert representation['data'].count == Models.collection_per
+      assert representation.include?('links')
+      assert representation['links'].count > 0
+    end
+
+    def test_implicit_formatter
+      post = Models.model1
+      serializable_resource = serializable(post, adapter: :json_api)
+
+      with_adapter :json_api do
+        get '/grape/render_with_implicit_formatter'
+      end
+
+      assert last_response.ok?
+      assert_equal serializable_resource.to_json, last_response.body
+    end
 
-  def test_formatter_handles_arrays
-    get '/grape/render_array_with_json_api'
+    def test_implicit_formatter_handles_arrays
+      posts = Models.all
+      serializable_resource = serializable(posts, adapter: :json_api)
 
-    posts = Models.all
-    serializable_resource = serializable(posts, adapter: :json_api)
+      with_adapter :json_api do
+        get '/grape/render_array_with_implicit_formatter'
+      end
+
+      assert last_response.ok?
+      assert_equal serializable_resource.to_json, last_response.body
+    ensure
+      Models.reset_all
+    end
 
-    assert last_response.ok?
-    assert_equal serializable_resource.to_json, last_response.body
-  ensure
-    ARModels::Post.delete_all
+    def test_implicit_formatter_handles_collections
+      with_adapter :json_api do
+        get '/grape/render_collection_with_implicit_formatter'
+      end
+
+      representation = JSON.parse(last_response.body)
+      assert last_response.ok?
+      assert representation.include?('data')
+      assert representation['data'].count == Models.collection_per
+      assert representation.include?('links')
+      assert representation['links'].count > 0
+    end
   end
 end

data/test/lint_test.rb

@@ -30,7 +30,7 @@ module ActiveModel
         def errors
         end
 
-        def self.human_attribute_name(attr, options = {})
+        def self.human_attribute_name(_, _ = {})
         end
 
         def self.lookup_ancestors

data/test/logger_test.rb

@@ -1,18 +1,20 @@
 require 'test_helper'
 
-class ActiveModelSerializers::LoggerTest < ActiveSupport::TestCase
-  def test_logger_is_set_to_action_controller_logger_when_initializer_runs
-    assert_equal $action_controller_logger, ActionController::Base.logger # rubocop:disable Style/GlobalVars
-  end
+module ActiveModelSerializers
+  class LoggerTest < ActiveSupport::TestCase
+    def test_logger_is_set_to_action_controller_logger_when_initializer_runs
+      assert_equal $action_controller_logger, ActionController::Base.logger # rubocop:disable Style/GlobalVars
+    end
 
-  def test_logger_can_be_set
-    original_logger = ActiveModelSerializers.logger
-    logger = Logger.new(STDOUT)
+    def test_logger_can_be_set
+      original_logger = ActiveModelSerializers.logger
+      logger = Logger.new(STDOUT)
 
-    ActiveModelSerializers.logger = logger
+      ActiveModelSerializers.logger = logger
 
-    assert_equal ActiveModelSerializers.logger, logger
-  ensure
-    ActiveModelSerializers.logger = original_logger
+      assert_equal ActiveModelSerializers.logger, logger
+    ensure
+      ActiveModelSerializers.logger = original_logger
+    end
   end
 end