active_model_serializers 0.10.1 → 0.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01b7ca6e2acce14a076a2a63c87dc6d4677989dc
-  data.tar.gz: e04babe194acff0c4a0fd2b1daec6ee5128d8b8d
+  metadata.gz: d9ab72fd33fbf20e8630b9109d18edda9272658e
+  data.tar.gz: 8654e40594d8bf26038b329a8044dc9197bc5733
 SHA512:
-  metadata.gz: 5b4a986b9ab49ec7962be0ff855c9c3d2504e55743b8ba5cbbb22fdb936704456d5033160ab52d5efc2537a248f18de636aaafc7d5ec9c8a29a5e027f1c39063
-  data.tar.gz: d824f39238f997d1fd763f8cb8d6ce158209a7d4c3ab5de3ea5294d991e5f2a6a1dca6a2be090bc69195ed58506ae54e5934f61440095ab2a749a948397a6937
+  metadata.gz: 454504b650ab8302e6e1f87b15f952ff3068033bcaaac136764211fbcb724759b354d66b7e0b662e1e10a1b57734173b4843f96eb2344c164d568fae824da8b3
+  data.tar.gz: 56355761907c1ea7882d7b04dc8adcff8538f188bd418946c2493a267188cedfef4247e410206b4c479575ba926efa1259c5966e166b901eaea26c45b7d4aae8

data/.rubocop.yml

@@ -1,7 +1,5 @@
-inherit_from: .rubocop_todo.yml
-
 AllCops:
-  TargetRubyVersion: 2.2
+  TargetRubyVersion: 2.1
   Exclude:
     - config/initializers/forbidden_yaml.rb
     - !ruby/regexp /(vendor|bundle|bin|db|tmp)\/.*/
@@ -46,7 +44,7 @@ Style/AlignParameters:
   EnforcedStyle: with_fixed_indentation
 
 Style/ClassAndModuleChildren:
-  EnforcedStyle: compact
+  EnforcedStyle: nested
 
 Style/Documentation:
   Enabled: false

data/.travis.yml

@@ -27,6 +27,7 @@ env:
   matrix:
     - "RAILS_VERSION=4.1"
     - "RAILS_VERSION=4.2"
+    - "RAILS_VERSION=5.0"
     - "RAILS_VERSION=master"
 
 matrix:

data/CHANGELOG.md

@@ -1,6 +1,6 @@
 ## 0.10.x
 
-### [master (unreleased)](https://github.com/rails-api/active_model_serializers/compare/v0.10.1...master)
+### [master (unreleased)](https://github.com/rails-api/active_model_serializers/compare/v0.10.2...master)
 
 Breaking changes:
 
@@ -10,6 +10,14 @@ Fixes:
 
 Misc:
 
+### [v0.10.2 (2016-07-05)(unreleased)](https://github.com/rails-api/active_model_serializers/compare/v0.10.1...v0.10.2)
+
+Fixes:
+- [#1814] (https://github.com/rails-api/active_model_serializers/pull/1814) Ensuring read_multi works with fragment cache
+
+Misc:
+- [#1808](https://github.com/rails-api/active_model_serializers/pull/1808) Adds documentation for `fields` option. (@luizkowalski)
+
 ### [v0.10.1 (2016-06-16)](https://github.com/rails-api/active_model_serializers/compare/v0.10.0...v0.10.1)
 
 Features:

data/Rakefile

@@ -5,7 +5,7 @@ rescue LoadError
 end
 begin
   require 'simplecov'
-rescue LoadError
+rescue LoadError # rubocop:disable Lint/HandleExceptions
 end
 
 Bundler::GemHelper.install_tasks
@@ -33,7 +33,7 @@ end
 begin
   require 'rubocop'
   require 'rubocop/rake_task'
-rescue LoadError
+rescue LoadError # rubocop:disable Lint/HandleExceptions
 else
   Rake::Task[:rubocop].clear if Rake::Task.task_defined?(:rubocop)
   require 'rbconfig'
@@ -100,4 +100,4 @@ else
 end
 
 desc 'CI test task'
-task :ci => [:default]
+task ci: [:default]

data/active_model_serializers.gemspec

@@ -23,31 +23,31 @@ Gem::Specification.new do |spec|
 
   rails_versions = ['>= 4.1', '< 6']
   spec.add_runtime_dependency 'activemodel', rails_versions
-    # 'activesupport', rails_versions
-    # 'builder'
+  # 'activesupport', rails_versions
+  # 'builder'
 
   spec.add_runtime_dependency 'actionpack', rails_versions
-    # 'activesupport', rails_versions
-    # 'rack'
-    # 'rack-test', '~> 0.6.2'
+  # 'activesupport', rails_versions
+  # 'rack'
+  # 'rack-test', '~> 0.6.2'
 
   spec.add_runtime_dependency 'railties', rails_versions
-    # 'activesupport', rails_versions
-    # 'actionpack', rails_versions
-    # 'rake', '>= 0.8.7'
+  # 'activesupport', rails_versions
+  # 'actionpack', rails_versions
+  # 'rake', '>= 0.8.7'
 
   # 'activesupport', rails_versions
-    # 'i18n,
-    # 'tzinfo'
-    # 'minitest'
-    # 'thread_safe'
+  # 'i18n,
+  # 'tzinfo'
+  # 'minitest'
+  # 'thread_safe'
 
   spec.add_runtime_dependency 'jsonapi', '~> 0.1.1.beta2'
 
   spec.add_development_dependency 'activerecord', rails_versions
-    # arel
-    # activesupport
-    # activemodel
+  # arel
+  # activesupport
+  # activemodel
 
   # Soft dependency for pagination
   spec.add_development_dependency 'kaminari', ' ~> 0.16.3'

data/docs/general/fields.md

@@ -0,0 +1,31 @@
+[Back to Guides](../README.md)
+
+# Fields
+
+If for any reason, you need to restrict the fields returned, you should use `fields` option.
+
+For example, if you have a serializer like this
+
+```ruby
+class UserSerializer < ActiveModel::Serializer
+  attributes :access_token, :first_name, :last_name
+end
+```
+
+and in a specific controller, you want to return `access_token` only, `fields` will help you:
+
+```ruby
+class AnonymousController < ApplicationController
+  def create
+    render json: User.create(activation_state: 'anonymous'), fields: [:access_token], status: 201
+  end
+end
+```
+
+Note that this is only valid for the `json` and `attributes` adapter. For the `json_api` adapter, you would use
+
+```ruby
+render json: @user, fields: { users: [:access_token] }
+```
+
+Where `users` is the JSONAPI type.

data/docs/general/rendering.md

@@ -73,7 +73,12 @@ See [ARCHITECTURE](../ARCHITECTURE.md) for more information.
 
 #### fields
 
-PR please :)
+If you are using `json` or `attributes` adapter
+```ruby
+render json: @user, fields: [:access_token]
+```
+
+See [Fields](fields.md) for more information.
 
 #### adapter
 
@@ -83,7 +88,7 @@ PR please :)
 
 ```render json: posts, each_serializer: PostSerializer, key_transform: :camel_lower```
 
-See [Key Transforms](key_transforms.md) for more informaiton.
+See [Key Transforms](key_transforms.md) for more information.
 
 #### meta
 

data/docs/general/serializers.md

@@ -314,6 +314,38 @@ So that when we render the `#edit` action, we'll get
 
 Where `can_edit` is `view_context.current_user.admin?` (true).
 
+You can also tell what to set as `serialization_scope` for specific actions.
+
+For example, use `admin_user` only for `Admin::PostSerializer` and `current_user` for rest.
+
+```ruby
+class PostsController < ActionController::Base
+
+  before_action only: :edit do
+    self.class.serialization_scope :admin_user
+  end
+
+  def show
+    render json: @post, serializer: PostSerializer
+  end
+
+  def edit
+    @post.save
+    render json: @post, serializer: Admin::PostSerializer
+  end
+
+  private
+
+  def admin_user
+    User.new(id: 2, name: 'Bob', admin: true)
+  end
+
+  def current_user
+    User.new(id: 2, name: 'Bob', admin: false)
+  end
+end
+```
+
 #### #read_attribute_for_serialization(key)
 
 The serialized value for a given key. e.g. `read_attribute_for_serialization(:title) #=> 'Hello World'`

data/docs/howto/add_pagination_links.md

@@ -81,7 +81,7 @@ def pagination_dict(object)
   {
     current_page: object.current_page,
     next_page: object.next_page,
-    prev_page: object.prev_page,
+    prev_page: object.prev_page, # use object.previous_page when using will_paginate
     total_pages: object.total_pages,
     total_count: object.total_count
   }
@@ -126,14 +126,13 @@ def meta_attributes(resource, extra_meta = {})
   {
     current_page: resource.current_page,
     next_page: resource.next_page,
-    prev_page: resource.prev_page,
+    prev_page: resource.prev_page, # use resource.previous_page when using will_paginate
     total_pages: resource.total_pages,
     total_count: resource.total_count
   }.merge(extra_meta)
 end
 ```
 
-
 ### Attributes adapter
 
 This adapter does not allow us to use `meta` key, due to that it is not possible to add pagination links.

data/docs/integrations/ember-and-json-api.md

@@ -17,17 +17,32 @@ To solve this, in Ember, both the adapter and the serializer will need some modi
 
 ### Server-Side Changes
 
-there are multiple mimetypes for json that should all be parsed similarly, so
-in `config/initializers/mime_types.rb`:
+First, set the adapter type in an initializer file:
+
+```ruby
+# config/initializers/active_model_serializers.rb
+ActiveModelSerializers.config.adapter = :json_api
+```
+
+or:
+
+```ruby
+# config/initializers/active_model_serializers.rb
+ActiveModelSerializers.config.adapter = ActiveModelSerializers::Adapter::JsonApi
+```
+
+You will also want to set the `key_transform` to `:unaltered` since you will adjust the attributes in your Ember serializer to use underscores instead of dashes later. You could also use `:underscore`, but `:unaltered` is better for performance.
+
+```ruby
+# config/initializers/active_model_serializers.rb
+ActiveModelSerializers.config.key_transform = :unaltered
+```
+
+Lastly, in order to properly handle JSON API responses, we need to register a JSON API renderer, like so:
+
 ```ruby
-api_mime_types = %W(
-  application/vnd.api+json
-  text/x-json
-  application/json
-)
-
-Mime::Type.unregister :json
-Mime::Type.register 'application/json', :json, api_mime_types
+# config/initializers/active_model_serializers.rb
+require 'active_model_serializers/register_jsonapi_renderer'
 ```
 
 ### Adapter Changes

data/lib/action_controller/serialization.rb

@@ -19,12 +19,13 @@ module ActionController
     end
 
     def serialization_scope
-      send(_serialization_scope) if _serialization_scope &&
-        respond_to?(_serialization_scope, true)
+      return unless _serialization_scope && respond_to?(_serialization_scope, true)
+
+      send(_serialization_scope)
     end
 
     def get_serializer(resource, options = {})
-      if !use_adapter?
+      unless use_adapter?
         warn 'ActionController::Serialization#use_adapter? has been removed. '\
           "Please pass 'adapter: false' or see ActiveSupport::SerializableResource.new"
         options[:adapter] = false

data/lib/active_model/serializer.rb

@@ -125,10 +125,9 @@ module ActiveModel
       self.root = instance_options[:root]
       self.scope = instance_options[:scope]
 
-      scope_name = instance_options[:scope_name]
-      if scope_name && !respond_to?(scope_name)
-        define_singleton_method scope_name, lambda { scope }
-      end
+      return if !(scope_name = instance_options[:scope_name]) || respond_to?(scope_name)
+
+      define_singleton_method scope_name, -> { scope }
     end
 
     def success?

data/lib/active_model/serializer/array_serializer.rb

@@ -1,9 +1,12 @@
 require 'active_model/serializer/collection_serializer'
-class ActiveModel::Serializer
-  class ArraySerializer < CollectionSerializer
-    class << self
-      extend ActiveModelSerializers::Deprecate
-      deprecate :new, 'ActiveModel::Serializer::CollectionSerializer.'
+
+module ActiveModel
+  class Serializer
+    class ArraySerializer < CollectionSerializer
+      class << self
+        extend ActiveModelSerializers::Deprecate
+        deprecate :new, 'ActiveModel::Serializer::CollectionSerializer.'
+      end
     end
   end
 end

data/lib/active_model/serializer/associations.rb

@@ -39,7 +39,7 @@ module ActiveModel
         # @example
         #  has_many :comments, serializer: CommentSummarySerializer
         #
-        def has_many(name, options = {}, &block)
+        def has_many(name, options = {}, &block) # rubocop:disable Style/PredicateName
           associate(HasManyReflection.new(name, options, block))
         end
 
@@ -61,7 +61,7 @@ module ActiveModel
         # @example
         #  has_one :author, serializer: AuthorSerializer
         #
-        def has_one(name, options = {}, &block)
+        def has_one(name, options = {}, &block) # rubocop:disable Style/PredicateName
           associate(HasOneReflection.new(name, options, block))
         end
 

data/lib/active_model/serializer/caching.rb

@@ -197,7 +197,7 @@ module ActiveModel
         def object_cache_key(serializer, adapter_instance)
           return unless serializer.present? && serializer.object.present?
 
-          serializer.class.cache_enabled? ? serializer.cache_key(adapter_instance) : nil
+          (serializer.class.cache_enabled? || serializer.class.fragment_cache_enabled?) ? serializer.cache_key(adapter_instance) : nil
         end
       end
 
@@ -211,7 +211,7 @@ module ActiveModel
             end
           end
         elsif serializer_class.fragment_cache_enabled?
-          fetch_attributes_fragment(adapter_instance)
+          fetch_attributes_fragment(adapter_instance, cached_attributes)
         else
           attributes(fields, true)
         end
@@ -230,7 +230,8 @@ module ActiveModel
       # 1. Determine cached fields from serializer class options
       # 2. Get non_cached_fields and fetch cache_fields
       # 3. Merge the two hashes using adapter_instance#fragment_cache
-      def fetch_attributes_fragment(adapter_instance)
+      # rubocop:disable Metrics/AbcSize
+      def fetch_attributes_fragment(adapter_instance, cached_attributes = {})
         serializer_class._cache_options ||= {}
         serializer_class._cache_options[:key] = serializer_class._cache_key if serializer_class._cache_key
         fields = serializer_class.fragmented_attributes
@@ -243,15 +244,17 @@ module ActiveModel
         cached_fields = fields[:cached].dup
         key = cache_key(adapter_instance)
         cached_hash =
-          serializer_class.cache_store.fetch(key, serializer_class._cache_options) do
-            hash = attributes(cached_fields, true)
-            include_directive = JSONAPI::IncludeDirective.new(cached_fields - hash.keys)
-            hash.merge! resource_relationships({}, { include_directive: include_directive }, adapter_instance)
+          cached_attributes.fetch(key) do
+            serializer_class.cache_store.fetch(key, serializer_class._cache_options) do
+              hash = attributes(cached_fields, true)
+              include_directive = JSONAPI::IncludeDirective.new(cached_fields - hash.keys)
+              hash.merge! resource_relationships({}, { include_directive: include_directive }, adapter_instance)
+            end
           end
-
         # Merge both results
         adapter_instance.fragment_cache(cached_hash, non_cached_hash)
       end
+      # rubocop:enable Metrics/AbcSize
 
       def cache_key(adapter_instance)
         return @cache_key if defined?(@cache_key)

data/lib/active_model/serializer/error_serializer.rb

@@ -1,10 +1,14 @@
-class ActiveModel::Serializer::ErrorSerializer < ActiveModel::Serializer
-  # @return [Hash<field_name,Array<error_message>>]
-  def as_json
-    object.errors.messages
-  end
+module ActiveModel
+  class Serializer
+    class ErrorSerializer < ActiveModel::Serializer
+      # @return [Hash<field_name,Array<error_message>>]
+      def as_json
+        object.errors.messages
+      end
 
-  def success?
-    false
+      def success?
+        false
+      end
+    end
   end
 end

data/lib/active_model/serializer/errors_serializer.rb

@@ -1,27 +1,32 @@
 require 'active_model/serializer/error_serializer'
-class ActiveModel::Serializer::ErrorsSerializer
-  include Enumerable
-  delegate :each, to: :@serializers
-  attr_reader :object, :root
 
-  def initialize(resources, options = {})
-    @root = options[:root]
-    @object = resources
-    @serializers = resources.map do |resource|
-      serializer_class = options.fetch(:serializer) { ActiveModel::Serializer::ErrorSerializer }
-      serializer_class.new(resource, options.except(:serializer))
-    end
-  end
+module ActiveModel
+  class Serializer
+    class ErrorsSerializer
+      include Enumerable
+      delegate :each, to: :@serializers
+      attr_reader :object, :root
 
-  def success?
-    false
-  end
+      def initialize(resources, options = {})
+        @root = options[:root]
+        @object = resources
+        @serializers = resources.map do |resource|
+          serializer_class = options.fetch(:serializer) { ActiveModel::Serializer::ErrorSerializer }
+          serializer_class.new(resource, options.except(:serializer))
+        end
+      end
 
-  def json_key
-    nil
-  end
+      def success?
+        false
+      end
 
-  protected
+      def json_key
+        nil
+      end
 
-  attr_reader :serializers
+      protected
+
+      attr_reader :serializers
+    end
+  end
 end