grape-active_model_serializers 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c7f60aa1ac797001ff0756f457621d9ff5e99792
-  data.tar.gz: 5ba457a7a9b482bae17e354bef91425659c0821c
+  metadata.gz: e8ff356c3449ed21a7317fa1aba4f2166bd37f08
+  data.tar.gz: d5d8c18b882b728fa2dc80ef8fc117f50514cfcf
 SHA512:
-  metadata.gz: f3207365ca7d238a108f87045f21aa493155b836c00c54fbe141f7519feb851828ca7c94dced658404a01db3ae9053b579f2521c7a300b4d8e06f1ecef34b66c
-  data.tar.gz: 6c9646fc114bb51c3f8acf6d30c890283b5a9d95a8c7f8328fcf6010e21970109aba81c9019ea2b5bbf6250d328d5f29ba8cb12e538a7a39f85f1677d64eb4de
+  metadata.gz: 1d759b25c58f6f4f822268643888949e4a499361c987ff2900b535ec59af5ca9926701cf87ade34f7346dca4a664c97836d08aabb6e704d022bb72dfb81bdca2
+  data.tar.gz: bcf1bebecde31d684cc11d7ae200caf6b9ff1ec254f328292f882162ac3c909efc03caace67a20925174fdd2d9aa1b6f89657bb76fd6e5a24d6f4164b98841b6

data/.rubocop.yml

@@ -1,2 +1,9 @@
 inherit_from: .rubocop_todo.yml
 
+AllCops:
+  Exclude:
+    - Guardfile
+    - grape-active_model_serializers.gemspec
+
+Style/BlockDelimiters:
+  Enabled: false

data/.rubocop_todo.yml

@@ -10,9 +10,6 @@
 Metrics/AbcSize:
   Max: 20
 
-Metrics/LineLength:
-  Max: 179
-
 # Offense count: 7
 Style/Documentation:
   Enabled: false
@@ -21,7 +18,3 @@ Style/Documentation:
 # Configuration parameters: Exclude.
 Style/FileName:
   Enabled: false
-
-# Offense count: 4
-Style/RegexpLiteral:
-  MaxSlashes: 0

data/.travis.yml

@@ -24,7 +24,6 @@ matrix:
       env: GRAPE_VERSION=HEAD
     - rvm: 2.3.0
     - rvm: 2.2.5
-    - rvm: 2.1
     - rvm: rbx-2
     - rvm: jruby-19mode
     - rvm: ruby-head

data/CHANGELOG.md

@@ -1,39 +1,47 @@
 ## Changelog
 
-### 1.5.0 (Next)
+### 1.5.1 (Next)
 
-* Your contribution here.
+* ...
+
+### 1.5.0 (August 24, 2016)
+
+* [#61](https://github.com/ruby-grape/grape-active_model_serializers/pull/61): Adds support for collection serializers - [@drn](https://github.com/drn).
+* [#60](https://github.com/ruby-grape/grape-active_model_serializers/pull/60): Namespace serializer inference - [@drn](https://github.com/drn).
+* [#59](https://github.com/ruby-grape/grape-active_model_serializers/pull/59): Refactor option and serializer resolution - [@drn](https://github.com/drn).
+* [#57](https://github.com/ruby-grape/grape-active_model_serializers/pull/57): Solve line length linter issues - [@drn](https://github.com/drn).
+* [#54](https://github.com/ruby-grape/grape-active_model_serializers/pull/54): Adding support for ASM v0.10. Drops support for ASM v0.9 - [@drn](https://github.com/drn).
 
 ### 1.4.0 (July 14, 2016)
 
-* [#49](https://github.com/jrhe/grape-active_model_serializers/pull/49): Adds support for active model serializer namespace - [@syntaxTerr0r](https://github.com/syntaxTerr0r).
-* [#36](https://github.com/jrhe/grape-active_model_serializers/pull/36), [#50](https://github.com/jrhe/grape-active_model_serializers/pull/50): Added support through Grape 0.16.x - [@dblock](https://github.com/dblock).
+* [#49](https://github.com/ruby-grape/grape-active_model_serializers/pull/49): Adds support for active model serializer namespace - [@syntaxTerr0r](https://github.com/syntaxTerr0r).
+* [#36](https://github.com/ruby-grape/grape-active_model_serializers/pull/36), [#50](https://github.com/jrhe/grape-active_model_serializers/pull/50): Added support through Grape 0.16.x - [@dblock](https://github.com/dblock).
 
 ### v1.3.2 (February 27, 2015)
 
-* [#39](https://github.com/jrhe/grape-active_model_serializers/pull/39): Look for namespace and other options to configure serializers - [@jwkoelewijn](https://github.com/jwkoelewijn).
-* [#40](https://github.com/jrhe/grape-active_model_serializers/pull/40): Use env to pass AMS meta around - [@dblock](https://github.com/dblock).
+* [#40](https://github.com/ruby-grape/grape-active_model_serializers/pull/40): Use env to pass AMS meta around - [@dblock](https://github.com/dblock).
+* [#39](https://github.com/ruby-grape/grape-active_model_serializers/pull/39): Look for namespace and other options to configure serializers - [@jwkoelewijn](https://github.com/jwkoelewijn).
 
 ### v1.3.1 (November 20, 2014)
 
-* [#30](https://github.com/jrhe/grape-active_model_serializers/pull/30): Read options from default_serializer_options - [@siong1987](https://github.com/siong1987).
-* [#24](https://github.com/jrhe/grape-active_model_serializers/pull/24): Makes it possible to use `current_user` within serializers - [@sonxurxo](https://github.com/sonxurxo).
+* [#30](https://github.com/ruby-grape/grape-active_model_serializers/pull/30): Read options from default_serializer_options - [@siong1987](https://github.com/siong1987).
+* [#24](https://github.com/ruby-grape/grape-active_model_serializers/pull/24): Makes it possible to use `current_user` within serializers - [@sonxurxo](https://github.com/sonxurxo).
 
 ### v1.2.1 (July 23, 2014)
 
-* [#21](https://github.com/jrhe/grape-active_model_serializers/pull/21): Correctly fetch serialization scope - [@radanskoric](https://github.com/radanskoric).
-* [#18](https://github.com/jrhe/grape-active_model_serializers/pull/18): Added support for active model serializer 0.9.x - [@sbounmy](https://github.com/sbounmy).
+* [#21](https://github.com/ruby-grape/grape-active_model_serializers/pull/21): Correctly fetch serialization scope - [@radanskoric](https://github.com/radanskoric).
+* [#18](https://github.com/ruby-grape/grape-active_model_serializers/pull/18): Added support for active model serializer 0.9.x - [@sbounmy](https://github.com/sbounmy).
 
-* [#15](https://github.com/jrhe/grape-active_model_serializers/pull/15): Added `render` syntactic sugar - [@zph](https://github.com/zph).
-* [#14](https://github.com/jrhe/grape-active_model_serializers/pull/14): Fix: `default_root` method to support symbol route in Grape - [@wjp2013](https://github.com/wjp2013).
-* [#12](https://github.com/jrhe/grape-active_model_serializers/pull/12): Added support for `current_user` - [@kpassapk](https://github.com/kpassapk).
-* [#11](https://github.com/jrhe/grape-active_model_serializers/pull/11): Fixed require path - [@schickling](https://github.com/schickling).
+* [#15](https://github.com/ruby-grape/grape-active_model_serializers/pull/15): Added `render` syntactic sugar - [@zph](https://github.com/zph).
+* [#14](https://github.com/ruby-grape/grape-active_model_serializers/pull/14): Fix: `default_root` method to support symbol route in Grape - [@wjp2013](https://github.com/wjp2013).
+* [#12](https://github.com/ruby-grape/grape-active_model_serializers/pull/12): Added support for `current_user` - [@kpassapk](https://github.com/kpassapk).
+* [#11](https://github.com/ruby-grape/grape-active_model_serializers/pull/11): Fixed require path - [@schickling](https://github.com/schickling).
 
 ### v1.0.1 (September 9, 2013)
 
-* [#6](https://github.com/jrhe/grape-active_model_serializers/pull/6): Conform to ActiveModel::Serializers way of determining array-ness - [@tfe](https://github.com/tfe).
-* [#4](https://github.com/jrhe/grape-active_model_serializers/pull/4): Support for namespace options and rely more on active_model_serializers - [@johnallen3d](https://github.com/johnallen3d).
-* [#1](https://github.com/jrhe/grape-active_model_serializers/pull/1): Fix: Grape::ActiveModelSerializers for models with compound names - [@george](https://github.com/george).
+* [#6](https://github.com/ruby-grape/grape-active_model_serializers/pull/6): Conform to ActiveModel::Serializers way of determining array-ness - [@tfe](https://github.com/tfe).
+* [#4](https://github.com/ruby-grape/grape-active_model_serializers/pull/4): Support for namespace options and rely more on active_model_serializers - [@johnallen3d](https://github.com/johnallen3d).
+* [#1](https://github.com/ruby-grape/grape-active_model_serializers/pull/1): Fix: Grape::ActiveModelSerializers for models with compound names - [@george](https://github.com/george).
 
 ### v1.0.0
 

data/README.md

@@ -2,7 +2,8 @@
 
 Use [active_model_serializers](https://github.com/rails-api/active_model_serializers) with [Grape](https://github.com/intridea/grape)!
 
-[![Build Status](https://api.travis-ci.org/ruby-grape/grape-active_model_serializers.svg)](http://travis-ci.org/ruby-grape/grape-active_model_serializers) [![Dependency Status](https://gemnasium.com/ruby-grape/grape-active_model_serializers.svg)](https://gemnasium.com/ruby-grape/grape-active_model_serializers) [![Code Climate](https://codeclimate.com/github/jrhe/grape-active_model_serializers.svg)](https://codeclimate.com/github/jrhe/grape-active_model_serializers)
+[![Gem Version](https://badge.fury.io/rb/grape-active_model_serializers.svg)](https://badge.fury.io/rb/grape-active_model_serializers)
+[![Build Status](https://api.travis-ci.org/ruby-grape/grape-active_model_serializers.svg)](http://travis-ci.org/ruby-grape/grape-active_model_serializers) [![Dependency Status](https://gemnasium.com/ruby-grape/grape-active_model_serializers.svg)](https://gemnasium.com/ruby-grape/grape-active_model_serializers) [![Code Climate](https://codeclimate.com/github/ruby-grape/grape-active_model_serializers.svg)](https://codeclimate.com/github/ruby-grape/grape-active_model_serializers)
 
 ## Installation
 
@@ -14,6 +15,12 @@ gem 'grape-active_model_serializers'
 
 See [UPGRADING](UPGRADING.md) if you're upgrading from a previous version.
 
+## Dependencies
+
+* >= Ruby v2.2
+* >= [grape](https://github.com/intridea/grape) v0.8.0
+* >= [active_model_serializers](https://github.com/rails-api/active_model_serializers) v0.10.0
+
 ## Usage
 
 ### Require grape-active_model_serializers

data/UPGRADING.md

@@ -1,12 +1,145 @@
-### Upgrading to v.1.4.0
+### Upgrading to v1.5.0
+
+#### ASM v0.10.x support added, v0.9.x support dropped
+
+[ASM](https://github.com/rails-api/active_model_serializers) introduced
+breaking changes with ASM v0.10.x. Support has been introduced in v1.5.0.
+If you require support for older version of ASM, please lock your Gemfile
+to the relevant version.
+
+#### Non-collection Serializer Resolution
+
+Serializer resolution now uses the following strategy:
+
+1. Defined by the resource
+
+```
+class UsersApi < Grape::Api
+  resource :users do
+    get '/:id', serializer: SpecifiedUserSerializer do
+      current_user
+    end
+  end
+end
+
+class User
+  def serializer_class
+    SpecifiedUserSerializer
+  end
+end
+```
+
+2. Specified by options
+
+```
+class UsersApi < Grape::Api
+  resource :users do
+    get '/:id', serializer: SpecifiedUserSerializer do
+      current_user
+    end
+  end
+end
+```
+
+2. Namespace inferred
+
+```
+class V1::UsersApi < Grape::Api
+  resource :users do
+    get '/:id' do
+      current_user
+    end
+  end
+end
+# 'V1::UsersApi'.deconstantize => 'V1'
+# searches for serializers in the V1:: namespace with the name UserSerializer
+
+# used
+class V1::UserSerializer
+  ...
+end
+
+# not used since V1::UserSerializer resolved first
+class UserSerializer
+  ...
+end
+```
+
+3. Version inferred
+
+```
+class UsersApi < Grape::Api
+  version 'v2'
+
+  resource :users do
+    get '/:id' do
+      current_user
+    end
+  end
+end
+# 'v2'.classify => V2
+# searches for serializers in the V2:: namespace with the name UserSerializer
+
+# used
+class V2::UserSerializer
+  ...
+end
+
+# not used since V2::UserSerializer resolved first
+class UserSerializer
+  ...
+end
+```
+
+4. Default ASM lookup
+
+```
+class V1::UsersApi < Grape::Api
+  version 'v2'
+
+  resource :users do
+    get '/:id' do
+      current_user
+    end
+  end
+end
+# searches for serializers in the V1:: namespace, none found
+# searches for serializers in the V2:: namespace, none found
+
+# used as no other serializers were found
+class UserSerializer
+  ...
+end
+```
+
+#### Collection Serializer Resolution
+
+Serializer resolution for collections also uses the above strategy, but has
+the added option of overriding the member serializer if the `each_serializer`
+options is specified.
+
+```
+class UsersApi < Grape::Api
+  resource :users do
+    get each_serializer: SpecifiedUserSerializer do
+      User.all
+    end
+  end
+end
+```
+
+
+### Upgrading to v1.4.0
 
 #### Changes in Serializer Namespacing
 
-Version 1.4.0 introduced changes in serializer namespacing when using Grape API versioning.
+Version 1.4.0 introduced changes in serializer namespacing when using Grape
+API versioning.
 
 If you haven't declared an API version in Grape, nothing changed.
 
-If your Grape API is versioned, which means you have declared at least one version in Grape, you must namespace your serializers accordingly.
+If your Grape API is versioned, which means you have declared at least one
+version in Grape, you must namespace your serializers accordingly.
 
 For example, given the following API.
 
@@ -48,7 +181,8 @@ module Chocolate
 end
 ```
 
-This will allow you to keep your serializers easier to maintain and more organized.
+This will allow you to keep your serializers easier to maintain and more
+organized.
 
 ```
 app
@@ -73,13 +207,15 @@ or alternatively:
     └── candy_bar_user_serializer.rb
 ```
 
-Thus, ActiveModelSerializer will fetch automatically the right serializer to render.
+Thus, ActiveModelSerializer will fetch automatically the right serializer to
+render.
 
 ### Upgrading to v1.0.0
 
 #### Changes to Array Roots
 
-When serializing an array, the array root is set to the innermost namespace name if there is one, otherwise it is set to the route name.
+When serializing an array, the array root is set to the innermost namespace
+name if there is one, otherwise it is set to the route name.
 
 In the following example the array root is `users`.
 

data/grape-active_model_serializers.gemspec

@@ -16,13 +16,13 @@ Gem::Specification.new do |gem|
   gem.version       = Grape::ActiveModelSerializers::VERSION
   gem.licenses      = ['MIT']
 
-  gem.add_dependency 'grape'
-  gem.add_dependency 'active_model_serializers', '>= 0.9.0'
+  gem.add_dependency 'grape', '>= 0.8.0'
+  gem.add_dependency 'active_model_serializers', '>= 0.10.0'
 
   gem.add_development_dependency 'listen', '~> 3.0.7'
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'rack-test'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'guard-rspec'
-  gem.add_development_dependency 'rubocop', '0.28.0'
+  gem.add_development_dependency 'rubocop', '0.41.2'
 end

data/lib/grape-active_model_serializers.rb

@@ -2,4 +2,6 @@ require 'active_model_serializers'
 require 'grape'
 require 'grape-active_model_serializers/endpoint_extension'
 require 'grape-active_model_serializers/formatter'
+require 'grape-active_model_serializers/serializer_resolver'
+require 'grape-active_model_serializers/options_builder'
 require 'grape-active_model_serializers/version'

data/lib/grape-active_model_serializers/endpoint_extension.rb

@@ -9,7 +9,7 @@ module Grape
     attr_accessor :controller_name
 
     def namespace_options
-      if self.respond_to?(:inheritable_setting)
+      if respond_to?(:inheritable_setting)
         inheritable_setting.namespace
       else
         settings[:namespace] ? settings[:namespace].options : {}
@@ -17,7 +17,7 @@ module Grape
     end
 
     def route_options
-      if self.respond_to?(:inheritable_setting)
+      if respond_to?(:inheritable_setting)
         inheritable_setting.route
       else
         options[:route_options]
@@ -30,7 +30,9 @@ module Grape
 
       base.class_eval do
         def serialization_scope
-          send(_serialization_scope) if _serialization_scope && respond_to?(_serialization_scope, true)
+          return unless _serialization_scope
+          return unless respond_to?(_serialization_scope, true)
+          send(_serialization_scope)
         end
       end
     end

data/lib/grape-active_model_serializers/formatter.rb

@@ -3,60 +3,28 @@ module Grape
     module ActiveModelSerializers
       class << self
         def call(resource, env)
-          serializer = fetch_serializer(resource, env)
+          options = build_options(resource, env)
+          serializer = fetch_serializer(resource, options)
 
           if serializer
-            serializer.to_json
+            ::ActiveModelSerializers::Adapter.create(
+              serializer, options
+            ).to_json
           else
-            Grape::Formatter::Json.call resource, env
+            Grape::Formatter::Json.call(resource, env)
           end
         end
 
-        def fetch_serializer(resource, env)
-          endpoint = env['api.endpoint']
-          options = build_options_from_endpoint(endpoint)
-          ams_options = {}.tap do |ns|
-            # Extracting declared version from Grape
-            ns[:namespace] = options[:version].try(:classify) if options.try(:[], :version)
-          end
-
-          serializer = options.fetch(:serializer, ActiveModel::Serializer.serializer_for(resource, ams_options))
-          return nil unless serializer
-
-          options[:scope] = endpoint unless options.key?(:scope)
-          # ensure we have an root to fallback on
-          options[:resource_name] = default_root(endpoint) if resource.respond_to?(:to_ary)
-          serializer.new(resource, options.merge(other_options(env)))
-        end
-
-        def other_options(env)
-          options = {}
-          ams_meta = env['ams_meta'] || {}
-          meta = ams_meta.delete(:meta)
-          meta_key = ams_meta.delete(:meta_key)
-          options[:meta_key] = meta_key if meta && meta_key
-          options[meta_key || :meta] = meta if meta
-          options
+        def build_options(resource, env)
+          Grape::ActiveModelSerializers::OptionsBuilder.new(
+            resource, env
+          ).options
         end
 
-        def build_options_from_endpoint(endpoint)
-          [endpoint.default_serializer_options || {}, endpoint.namespace_options, endpoint.route_options, endpoint.options, endpoint.options.fetch(:route_options)].reduce(:merge)
-        end
-
-        # array root is the innermost namespace name ('space') if there is one,
-        # otherwise the route name (e.g. get 'name')
-        def default_root(endpoint)
-          innermost_scope = if endpoint.respond_to?(:namespace_stackable)
-                              endpoint.namespace_stackable(:namespace).last
-                            else
-                              endpoint.settings.peek[:namespace]
-                            end
-
-          if innermost_scope
-            innermost_scope.space
-          else
-            endpoint.options[:path][0].to_s.split('/')[-1]
-          end
+        def fetch_serializer(resource, options)
+          Grape::ActiveModelSerializers::SerializerResolver.new(
+            resource, options
+          ).serializer
         end
       end
     end

data/lib/grape-active_model_serializers/options_builder.rb

@@ -0,0 +1,68 @@
+module Grape
+  module ActiveModelSerializers
+    class OptionsBuilder
+      def initialize(resource, env)
+        self.resource = resource
+        self.env = env
+      end
+
+      def options
+        @options ||= (
+          options = endpoint_options
+          options[:scope] = endpoint unless options.key?(:scope)
+          options.merge!(default_root_options) unless options.key?(:root)
+          options.merge!(meta_options)
+          options
+        )
+      end
+
+      private
+
+      attr_accessor :resource, :env
+
+      def endpoint_options
+        [
+          endpoint.default_serializer_options || {},
+          endpoint.namespace_options,
+          endpoint.route_options,
+          endpoint.options,
+          endpoint.options.fetch(:route_options)
+        ].reduce(:merge)
+      end
+
+      def endpoint
+        @endpoint ||= env['api.endpoint']
+      end
+
+      # array root is the innermost namespace name ('space') if there is one,
+      # otherwise the route name (e.g. get 'name')
+      def default_root_options
+        return {} unless resource.respond_to?(:to_ary)
+
+        if innermost_scope
+          { root: innermost_scope.space }
+        else
+          { root: endpoint.options[:path].first.to_s.split('/').last }
+        end
+      end
+
+      def innermost_scope
+        if endpoint.respond_to?(:namespace_stackable)
+          endpoint.namespace_stackable(:namespace).last
+        else
+          endpoint.settings.peek[:namespace]
+        end
+      end
+
+      def meta_options
+        options = {}
+        ams_meta = env['ams_meta'] || {}
+        meta = ams_meta[:meta]
+        meta_key = ams_meta[:meta_key]
+        options[:meta] = meta if meta
+        options[:meta_key] = meta_key if meta && meta_key
+        options
+      end
+    end
+  end
+end