active_model_serializers 0.9.5 → 0.9.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 824c53b8e015242b747a646eb8d39e6f5bfb6828
-  data.tar.gz: c57b340d57742eda89976c6eff76f79c630615ce
+  metadata.gz: 1191ac4c27b87b68e877584e0739eeb45d98652b
+  data.tar.gz: e22fcf90100f324db9ff4617015e787ddb1186bb
 SHA512:
-  metadata.gz: 1d102aafb1713dd3010bde0cfc29e84626f9dd56d02a0d63807fed04a05d519a4d11ee35ee19e6c0a1e15714a460bdc8280e0d491421bc9fc8dc49fe84dce3fc
-  data.tar.gz: 3135135c42d6533232266a5d7f8b7efba43c83b2fc9017a2867172afeb2c459fc9b335d1322dd625eb916729891902357898785f51b981590ff5cc20671c1d34
+  metadata.gz: 00d60b3ac320a5f50fc2b460ce114a7723f8ed85b5ac94513cd159d50aa86f7587a523c00297048a5bf7938dd78be7eb8ac0c6b78b2104009abc473498b6187a
+  data.tar.gz: f00ab07a45f77ab3650e26f083d90f38ccf46ee53b55bc4f526f0f74628d4f06abd3df83133388c11bfa2889470e03ecd07b8413a7bc1db10403ea74f15ccde2

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 ## 0.09.x
 
-### [0-9-stable](https://github.com/rails-api/active_model_serializers/compare/v0.9.4...0-9-stable)
+### [0-9-stable](https://github.com/rails-api/active_model_serializers/compare/v0.9.5...0-9-stable)
+
+### [v0.9.6 (2017-01-10)](https://github.com/rails-api/active_model_serializers/compare/v0.9.5...v0.9.6)
+
+- [#2008](https://github.com/rails-api/active_model_serializers/pull/2008) Fix warning on Thor. (@kirs)
 
 ### [v0.9.5 (2016-03-30)](https://github.com/rails-api/active_model_serializers/compare/v0.9.4...v0.9.5)
 

data/README.md

@@ -378,7 +378,7 @@ The above usage of `:meta` will produce the following:
 If you would like to change the meta key name you can use the `:meta_key` option:
 
 ```ruby
-render json: @posts, serializer: CustomArraySerializer, meta_object: {total: 10}, meta_key: 'meta_object'
+render json: @posts, serializer: CustomArraySerializer, meta_object: { total: 10 }, meta_key: :meta_object
 ```
 
 The above usage of `:meta_key` will produce the following:

data/lib/active_model/serializer/generators/serializer/scaffold_controller_generator.rb

@@ -7,7 +7,7 @@ module Rails
       if Rails::VERSION::MAJOR >= 4
         source_root File.expand_path('../templates', __FILE__)
 
-        hook_for :serializer, default: true
+        hook_for :serializer, default: true, type: :boolean
       end
     end
   end

data/lib/active_model/serializer/version.rb

@@ -1,5 +1,5 @@
 module ActiveModel
   class Serializer
-    VERSION = '0.9.5'
+    VERSION = '0.9.6'
   end
 end

data/lib/bulk_cache_fetcher.rb

@@ -0,0 +1,104 @@
+# https://github.com/justinweiss/bulk_cache_fetcher/blob/df1c83e06b9641b7ec3408ec577b37528021190f/lib/bulk_cache_fetcher.rb
+# Fetches many objects from a cache in order. In the event that some
+# objects can't be served from the cache, you will have the
+# opportunity to fetch them in bulk. This allows you to preload and
+# cache entire object hierarchies, which works particularly well with
+# Rails' nested caching while avoiding the n+1 queries problem in the
+# uncached case.
+class BulkCacheFetcher
+  VERSION = '1.0.0'.freeze
+
+  # Creates a new bulk cache fetcher, backed by +cache+. Cache must
+  # respond to the standard Rails cache API, described on
+  # http://guides.rubyonrails.org/caching_with_rails.html
+  def initialize(cache)
+    @cache = cache
+  end
+
+  # Returns a list of objects identified by
+  # <tt>object_identifiers</tt>. +fetch+ will try to find the objects
+  # from the cache first. Identifiers for objects that aren't in the
+  # cache will be passed as an ordered list to <tt>finder_block</tt>,
+  # where you can find the objects as you see fit. These objects
+  # should be returned in the same order as the identifiers that were
+  # passed into the block, because they'll be cached under their
+  # respective keys. The objects returned by +fetch+ will be returned
+  # in the same order as the <tt>object_identifiers</tt> passed in.
+  #
+  # +options+ will be passed along unmodified when caching newly found
+  # objects, so you can use it for things like setting cache
+  # expiration.
+  def fetch(object_identifiers, options = {}, &finder_block)
+    object_identifiers = normalize(object_identifiers)
+    cached_keys_with_objects, uncached_identifiers = partition(object_identifiers)
+    found_objects = find(uncached_identifiers, options, &finder_block)
+    coalesce(cache_keys(object_identifiers), cached_keys_with_objects, found_objects)
+  end
+
+  private
+
+  # Splits a list of identifiers into two objects. The first is a hash
+  # of <tt>{cache_key: object}</tt> for all the objects we were able to serve
+  # from the cache. The second is a list of all of the identifiers for
+  # objects that weren't cached.
+  def partition(object_identifiers)
+    uncached_identifiers = object_identifiers.dup
+
+    cache_keys = cache_keys(object_identifiers)
+    cached_keys_with_objects = @cache.read_multi(*cache_keys)
+
+    cache_keys.each do |cache_key|
+      uncached_identifiers.delete(cache_key) if cached_keys_with_objects.key?(cache_key)
+    end
+
+    [cached_keys_with_objects, uncached_identifiers]
+  end
+
+  # Finds all of the objects identified by +identifiers+, using the
+  # +finder_block+. Will pass +options+ on to the cache.
+  def find(identifiers, options = {})
+    return [] if identifiers.empty?
+    Array(yield(identifiers)).tap do |objects|
+      verify_equal_key_and_value_counts!(identifiers, objects)
+      cache_all(identifiers, objects, options)
+    end
+  end
+
+  # Makes sure we have enough +identifiers+ to cache all of our
+  # +objects+, and vice-versa.
+  def verify_equal_key_and_value_counts!(identifiers, objects)
+    fail ArgumentError, 'You are returning too many objects from your cache block!' if objects.length > identifiers.length
+    fail ArgumentError, 'You are returning too few objects from your cache block!' if objects.length < identifiers.length
+  end
+
+  # Caches all +values+ under their respective +keys+.
+  def cache_all(keys, values, options = {})
+    keys.zip(values) { |k, v| @cache.write(cache_key(k), v, options) }
+  end
+
+  # Given a list of +cache_keys+, either find associated objects from
+  # +cached_keys_with_objects, or grab them from +found_objects+, in
+  # order.
+  def coalesce(cache_keys, cached_keys_with_objects, found_objects)
+    found_objects = Array(found_objects)
+    cache_keys.map { |key| cached_keys_with_objects.fetch(key) { found_objects.shift } }
+  end
+
+  # Returns the part of the identifier that we can use as the cache
+  # key. For simple identifiers, it's just the identifier, for
+  # identifiers with extra information attached, it's the first part
+  # of the identifier.
+  def cache_key(identifier)
+    Array(identifier).first
+  end
+
+  # Returns the cache keys for all of the +identifiers+.
+  def cache_keys(identifiers)
+    identifiers.map { |identifier| cache_key(identifier) }
+  end
+
+  # Makes sure we can iterate over identifiers.
+  def normalize(identifiers)
+    identifiers.respond_to?(:each) ? identifiers : Array(identifiers)
+  end
+end

data/test/action_controller/http_cache_test.rb

@@ -0,0 +1,56 @@
+require 'test_helper'
+
+# https://github.com/rails/rails/blob/4-2-stable/actionpack/lib/action_dispatch/testing/integration.rb
+# rubocop:disable Style/ClassAndModuleChildren:
+class ActionController::Serialization::HttpCacheTest < ActionController::TestCase
+  # class ActionController::Serialization::HttpCacheTest < ActionDispatch::IntegrationTest
+  class HttpCacheTestController < ActionController::Base
+    class Model < ActiveModelSerializers::Model
+      attr_accessor :name, :description, :comments
+    end
+    class ModelSerializer < ActiveModel::Serializer
+      attributes :name, :description, :comments
+    end
+
+    def render_as_serializable_object
+      render serialization_options.merge!(json: model)
+    end
+
+    def render_as_json_string
+      json = ActiveModelSerializers::SerializableResource.new(model, serialization_options).to_json
+      render json: json
+    end
+
+    private
+
+    def model
+      Model.new(name: 'Name 1', description: 'Description 1', comments: 'Comments 1')
+    end
+
+    def serialization_options
+      { serializer: ModelSerializer, adapter: :json }
+    end
+  end
+
+  tests HttpCacheTestController
+
+  DATE          = 'Date'.freeze
+  LAST_MODIFIED = 'Last-Modified'.freeze
+  ETAG          = 'ETag'.freeze
+  CACHE_CONTROL = 'Cache-Control'.freeze
+  SPECIAL_KEYS  = Set.new(%w(extras no-cache max-age public must-revalidate))
+  def test_render_as_serializable_object
+    10.times do
+      get :render_as_serializable_object
+    end
+    p [@response.etag?, @response.last_modified, @response.date, @response.headers[CACHE_CONTROL], @response.headers[ETAG], @response.headers[LAST_MODIFIED], @response.headers[DATE]]
+  end
+
+  def test_render_as_json_string
+    10.times do
+      get :render_as_json_string
+    end
+    p [@response.etag?, @response.last_modified, @response.date, @response.headers[CACHE_CONTROL], @response.headers[ETAG], @response.headers[LAST_MODIFIED], @response.headers[DATE]]
+  end
+end
+# rubocop:enable Style/ClassAndModuleChildren:

data/test/benchmark/bm_rails_cache.rb

@@ -0,0 +1,141 @@
+require 'bundler/setup'
+require_relative './benchmarking_support'
+require_relative './app'
+
+time = 10
+cache_store = ActiveSupport::Cache.lookup_store(:memory_store)
+comments = (0..50).map do |i|
+  Comment.new(id: i, body: 'ZOMG A COMMENT')
+end
+author = Author.new(id: 42, first_name: 'Joao', last_name: 'Moura')
+model = Post.new(id: 1337, title: 'New Post', blog: nil, body: 'Body', comments: comments, author: author)
+
+define_method :json do
+  model.to_json
+end
+define_method :cached_json do
+  parts = []
+  parts << 'key_name'
+  parts << 'adapter_name'
+  cache_key = parts.join('/')
+  cache_store.fetch(cache_key) { model.to_json }
+end
+define_method :ams do
+  ActiveModelSerializers::SerializableResource.new(model, adapter: :json, serializer: PostSerializer).as_json
+end
+define_method :cached_ams do
+  ActiveModelSerializers::SerializableResource.new(model, adapter: :json, serializer: CachingPostSerializer).as_json
+end
+def as_json(serializer_instance, adapter_instance, fields, includes = '*')
+  if serializer_instance.respond_to?(:each)
+    return serializer_instance.map do |each_serializer|
+      as_json(each_serializer, adapter_instance, fields, includes)
+    end
+  end
+  cache_key = serializer_instance.cache_key(adapter_instance)
+  include_tree = includes || ActiveModel::Serializer::IncludeTree.from_include_args(includes)
+  cache_store = ActiveModelSerializers.config.cache_store
+  json = cache_store.fetch(cache_key) do
+    serializer_instance.attributes(fields)
+  end
+  serializer_instance.associations(include_tree).each do |association|
+    # FIXME: yields each association twice
+    json[association.key] ||= as_json(association.serializer, adapter_instance, [], includes[association.key])
+  end
+  json
+end
+
+define_method :cached_virtual_ams do
+  ### OMG
+  post_serializer = CachingPostSerializer.new(model)
+  adapter_instance = ActiveModelSerializers::Adapter::Attributes.new(post_serializer)
+  fields = nil
+  includes = ActiveModel::Serializer::IncludeTree.from_include_args('*')
+  { post: as_json(post_serializer, adapter_instance, fields, includes) }
+  # parts = []
+  # parts << 'ams_blog'
+  # parts << 'attributes'
+  # cache_key = parts.join('/')
+  # cache_store.fetch(cache_key) do
+  #   include_tree = ActiveModel::Serializer::IncludeTree.from_include_args('*')
+  #   post_serializer = CachingPostSerializer.new(model)
+  #   json = { post: post_serializer.attributes }
+  #   post_serializer.associations(include_tree).each do |association|
+  #     # FIXME: yields each association twice
+  #     json[:post][association.key] ||=
+  #       case association.key
+  #       when :comments
+  #         cache_store.fetch(%w(ams_comments attributes).join('/')) do
+  #           association.serializer.map(&:attributes)
+  #         end
+  #       when :blog
+  #         association.serializer.attributes
+  #       when :author
+  #         cache_store.fetch(%w(ams_author attributes).join('/')) do
+  #           association.serializer.attributes
+  #         end
+  #       else
+  #         fail ArgumentError, "unexpected association #{association}"
+  #       end
+  #   end
+  #   json
+  # end
+end
+puts JSON.pretty_generate(
+  equality: { cached_ams: ams == cached_ams, cached_virtual_ams: ams == cached_virtual_ams },
+  ams: ams,
+  cached_ams: cached_ams,
+  cached_virtual_ams: cached_virtual_ams
+)
+
+{
+  # 'cached json' => { disable_gc: true, send: :cached_json },
+  # 'json'        => { disable_gc: true, send: :json },
+  # 'cached ams' => { disable_gc: true, send: :cached_ams },
+  'cached virtual ams' => { disable_gc: true, send: :cached_virtual_ams },
+  'ams' => { disable_gc: true, send: :ams }
+}.each do |label, options|
+  Benchmark.ams(label, time: time, disable_gc: options[:disable_gc]) do
+    send(options[:send])
+  end
+end
+__END__
+cached json 121321.3745504354/ips; 16 objects
+json 1177.243210850789/ips; 1984 objects
+cached ams 251.90341731442047/ips; 5879 objects
+cached virtual ams 89169.87612473704/ips; 16 objects
+ams 598.9890084759535/ips; 2348 objects
+Benchmark results:
+{
+  "commit_hash": "aa0be94",
+  "version": "0.10.0.rc5",
+  "rails_version": "4.2.5.1",
+  "benchmark_run[environment]": "2.2.3p173",
+  "runs": [
+    {
+      "benchmark_type[category]": "cached json",
+      "benchmark_run[result][iterations_per_second]": 121321.375,
+      "benchmark_run[result][total_allocated_objects_per_iteration]": 16
+    },
+    {
+      "benchmark_type[category]": "json",
+      "benchmark_run[result][iterations_per_second]": 1177.243,
+      "benchmark_run[result][total_allocated_objects_per_iteration]": 1984
+    },
+    {
+      "benchmark_type[category]": "cached ams",
+      "benchmark_run[result][iterations_per_second]": 251.903,
+      "benchmark_run[result][total_allocated_objects_per_iteration]": 5879
+    },
+    {
+      "benchmark_type[category]": "cached virtual ams",
+      "benchmark_run[result][iterations_per_second]": 89169.876,
+      "benchmark_run[result][total_allocated_objects_per_iteration]": 16
+    },
+    {
+      "benchmark_type[category]": "ams",
+      "benchmark_run[result][iterations_per_second]": 598.989,
+      "benchmark_run[result][total_allocated_objects_per_iteration]": 2348
+    }
+  ]
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_model_serializers
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 0.9.6
 platform: ruby
 authors:
 - José Valim
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-30 00:00:00.000000000 Z
+date: 2017-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -75,6 +75,38 @@ files:
 - lib/active_model/serializer/version.rb
 - lib/active_model/serializer_support.rb
 - lib/active_model_serializers.rb
+- lib/bulk_cache_fetcher.rb
+- test/action_controller/http_cache_test.rb
+- test/benchmark/bm_rails_cache.rb
+- test/benchmark/tmp/miniprofiler/mp_timers_16x1i2wkkt8b8zybbfbx
+- test/benchmark/tmp/miniprofiler/mp_timers_3aa299ezxdqvog6sfjzr
+- test/benchmark/tmp/miniprofiler/mp_timers_3f0bdfx4nib4hxfb5lmq
+- test/benchmark/tmp/miniprofiler/mp_timers_54wkvaidi0avdc8yawyt
+- test/benchmark/tmp/miniprofiler/mp_timers_6b9d32ftlk8v5xy2op05
+- test/benchmark/tmp/miniprofiler/mp_timers_7nlok5ykeley83h8bine
+- test/benchmark/tmp/miniprofiler/mp_timers_b36ymkc1vgu5fy9fvm9k
+- test/benchmark/tmp/miniprofiler/mp_timers_c3a27vo6uvfijeh105nt
+- test/benchmark/tmp/miniprofiler/mp_timers_eqcbrj14r4c341abi3h6
+- test/benchmark/tmp/miniprofiler/mp_timers_hqodkd691tbr7sbfdiez
+- test/benchmark/tmp/miniprofiler/mp_timers_j7y5frtod7cw4qc4cear
+- test/benchmark/tmp/miniprofiler/mp_timers_jpxzfgo92l24t7wzt8g1
+- test/benchmark/tmp/miniprofiler/mp_timers_m78k2w11sd7ba5oh40rw
+- test/benchmark/tmp/miniprofiler/mp_timers_mkvat4ehphrje9n2hu3t
+- test/benchmark/tmp/miniprofiler/mp_timers_nd3ymt54l1ga22i2brn8
+- test/benchmark/tmp/miniprofiler/mp_timers_o2dk1yhw6ez9jzxf6p0a
+- test/benchmark/tmp/miniprofiler/mp_timers_p76i310zb4y12iqm5o0n
+- test/benchmark/tmp/miniprofiler/mp_timers_pi3hvrrkfxnxl300wvah
+- test/benchmark/tmp/miniprofiler/mp_timers_q4w5d86flb4u9tsadqvw
+- test/benchmark/tmp/miniprofiler/mp_timers_sfa5nundogo63o056n5y
+- test/benchmark/tmp/miniprofiler/mp_timers_tkjlmqeauf5gur2u5nob
+- test/benchmark/tmp/miniprofiler/mp_timers_tngbj11ilv2i75rqn2d2
+- test/benchmark/tmp/miniprofiler/mp_timers_u4haqgvgybvc1sb5nihw
+- test/benchmark/tmp/miniprofiler/mp_timers_uc1b3hwqrd4q512gy6c9
+- test/benchmark/tmp/miniprofiler/mp_timers_uwholuf0iix2vvbo2l3c
+- test/benchmark/tmp/miniprofiler/mp_timers_waye238ygft3p4xvppc4
+- test/benchmark/tmp/miniprofiler/mp_timers_ydwo7p117loo2ky40lk3
+- test/benchmark/tmp/miniprofiler/mp_timers_zhgmyfizfa8slppitgua
+- test/benchmark/tmp/miniprofiler/mp_views_127.0.0.1
 - test/fixtures/active_record.rb
 - test/fixtures/poro.rb
 - test/fixtures/template.html.erb
@@ -139,6 +171,37 @@ specification_version: 4
 summary: Bringing consistency and object orientation to model serialization. Works
   great for client-side MVC frameworks!
 test_files:
+- test/action_controller/http_cache_test.rb
+- test/benchmark/bm_rails_cache.rb
+- test/benchmark/tmp/miniprofiler/mp_timers_16x1i2wkkt8b8zybbfbx
+- test/benchmark/tmp/miniprofiler/mp_timers_3aa299ezxdqvog6sfjzr
+- test/benchmark/tmp/miniprofiler/mp_timers_3f0bdfx4nib4hxfb5lmq
+- test/benchmark/tmp/miniprofiler/mp_timers_54wkvaidi0avdc8yawyt
+- test/benchmark/tmp/miniprofiler/mp_timers_6b9d32ftlk8v5xy2op05
+- test/benchmark/tmp/miniprofiler/mp_timers_7nlok5ykeley83h8bine
+- test/benchmark/tmp/miniprofiler/mp_timers_b36ymkc1vgu5fy9fvm9k
+- test/benchmark/tmp/miniprofiler/mp_timers_c3a27vo6uvfijeh105nt
+- test/benchmark/tmp/miniprofiler/mp_timers_eqcbrj14r4c341abi3h6
+- test/benchmark/tmp/miniprofiler/mp_timers_hqodkd691tbr7sbfdiez
+- test/benchmark/tmp/miniprofiler/mp_timers_j7y5frtod7cw4qc4cear
+- test/benchmark/tmp/miniprofiler/mp_timers_jpxzfgo92l24t7wzt8g1
+- test/benchmark/tmp/miniprofiler/mp_timers_m78k2w11sd7ba5oh40rw
+- test/benchmark/tmp/miniprofiler/mp_timers_mkvat4ehphrje9n2hu3t
+- test/benchmark/tmp/miniprofiler/mp_timers_nd3ymt54l1ga22i2brn8
+- test/benchmark/tmp/miniprofiler/mp_timers_o2dk1yhw6ez9jzxf6p0a
+- test/benchmark/tmp/miniprofiler/mp_timers_p76i310zb4y12iqm5o0n
+- test/benchmark/tmp/miniprofiler/mp_timers_pi3hvrrkfxnxl300wvah
+- test/benchmark/tmp/miniprofiler/mp_timers_q4w5d86flb4u9tsadqvw
+- test/benchmark/tmp/miniprofiler/mp_timers_sfa5nundogo63o056n5y
+- test/benchmark/tmp/miniprofiler/mp_timers_tkjlmqeauf5gur2u5nob
+- test/benchmark/tmp/miniprofiler/mp_timers_tngbj11ilv2i75rqn2d2
+- test/benchmark/tmp/miniprofiler/mp_timers_u4haqgvgybvc1sb5nihw
+- test/benchmark/tmp/miniprofiler/mp_timers_uc1b3hwqrd4q512gy6c9
+- test/benchmark/tmp/miniprofiler/mp_timers_uwholuf0iix2vvbo2l3c
+- test/benchmark/tmp/miniprofiler/mp_timers_waye238ygft3p4xvppc4
+- test/benchmark/tmp/miniprofiler/mp_timers_ydwo7p117loo2ky40lk3
+- test/benchmark/tmp/miniprofiler/mp_timers_zhgmyfizfa8slppitgua
+- test/benchmark/tmp/miniprofiler/mp_views_127.0.0.1
 - test/fixtures/active_record.rb
 - test/fixtures/poro.rb
 - test/fixtures/template.html.erb