cheap_ams 0.10.8 → 0.10.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c11a7633ccf053404efecf2697bfd9752aae2c9f
-  data.tar.gz: bd233c341599ef68b1675006e377f2c42c324d59
+  metadata.gz: 95422216cd4811b37e7e9943fc97c1f8e1984e08
+  data.tar.gz: 18bb09e6ba28642242e1e75092ed5250ed9456f3
 SHA512:
-  metadata.gz: d0490358ba5efc8a4b511ed881e2a4e1b7eec74fe9718fdeaec1439715a934ed60e4131725a05fc5ce2b8486ebb0a4fad7899ea8c544cc32933d6f7f8eb09a16
-  data.tar.gz: 4ea5b8af5728285995945cdd8095f25ecadb444cd6919c0ad846865e1e44e849fa4216cd704b2880a404155839efbfdd185b8b901616a2c41f86b2363334a854
+  metadata.gz: c05c8d9b94ae34f70e5e4e3a017a1871da8497b9ecf281e967d73f0fc8033b39fc486e726c059b870935c52de544cc633d87979423f1241b9df9d4c2c0df4bf4
+  data.tar.gz: 9514e1203f2ccefe5b917538c47238d4e19687dd89ce4f6ebb6a9e03c4a83bb0c9f0c6c141f6a26086f2853d2445bb15912b308892a52bba6d1ff030de2d2aae

data/.gitignore

@@ -4,6 +4,7 @@
 .config
 .yardoc
 Gemfile.lock
+Gemfile.local
 InstalledFiles
 _yardoc
 coverage

data/.rubocop.yml

@@ -8,6 +8,39 @@ AllCops:
   DisplayCopNames: true
   DisplayStyleGuide: true
 
+Style/IndentationConsistency:
+  Exclude:
+    - lib/active_model/serializer/adapter/flatten_json.rb
+    - lib/active_model/serializer/adapter/fragment_cache.rb
+    - lib/active_model/serializer/adapter/json.rb
+    - lib/active_model/serializer/adapter/json/fragment_cache.rb
+    - lib/active_model/serializer/adapter/json_api.rb
+    - lib/active_model/serializer/adapter/json_api/fragment_cache.rb
+    - lib/active_model/serializer/adapter/json_api/pagination_links.rb
+    - lib/active_model/serializer/adapter/null.rb
+
+Style/IndentationWidth:
+  Exclude:
+    - lib/active_model/serializer/adapter/flatten_json.rb
+    - lib/active_model/serializer/adapter/fragment_cache.rb
+    - lib/active_model/serializer/adapter/json.rb
+    - lib/active_model/serializer/adapter/json/fragment_cache.rb
+    - lib/active_model/serializer/adapter/json_api.rb
+    - lib/active_model/serializer/adapter/json_api/fragment_cache.rb
+    - lib/active_model/serializer/adapter/json_api/pagination_links.rb
+    - lib/active_model/serializer/adapter/null.rb
+
+Style/AccessModifierIndentation:
+  Exclude:
+    - lib/active_model/serializer/adapter/flatten_json.rb
+    - lib/active_model/serializer/adapter/fragment_cache.rb
+    - lib/active_model/serializer/adapter/json.rb
+    - lib/active_model/serializer/adapter/json/fragment_cache.rb
+    - lib/active_model/serializer/adapter/json_api.rb
+    - lib/active_model/serializer/adapter/json_api/fragment_cache.rb
+    - lib/active_model/serializer/adapter/json_api/pagination_links.rb
+    - lib/active_model/serializer/adapter/null.rb
+
 Lint/NestedMethodDefinition:
   Enabled: false
   Exclude:

data/.simplecov

@@ -8,7 +8,7 @@
   when 'jruby', 'rbx'
     96.0
   else
-    98.3
+    98.1
   end
 }.to_f.round(2)
 # rubocop:disable Style/DoubleNegation

data/CHANGELOG.md

@@ -11,3 +11,4 @@
   * remove root key option and split JSON adapter [@joaomdmoura]
   * adds FlattenJSON as default adapter [@joaomdmoura]
   * adds support for `pagination links` at top level of JsonApi adapter [@bacarini]
+  * adds extended format for `include` option to JSONAPI adapter [@beauby]

data/Gemfile

@@ -1,4 +1,8 @@
 source 'https://rubygems.org'
+#
+# Add a Gemfile.local to locally bundle gems outside of version control
+local_gemfile = File.join(File.expand_path('..', __FILE__), 'Gemfile.local')
+eval_gemfile local_gemfile if File.readable?(local_gemfile)
 
 # Specify your gem's dependencies in active_model_serializers.gemspec
 gemspec

data/README.md

@@ -1,6 +1,6 @@
 # ActiveModel::Serializer
 
-[![Build Status](https://travis-ci.org/rails-api/active_model_serializers.svg)](https://travis-ci.org/rails-api/active_model_serializers) 
+[![Build Status](https://travis-ci.org/rails-api/active_model_serializers.svg)](https://travis-ci.org/rails-api/active_model_serializers)
 <a href="https://codeclimate.com/github/rails-api/active_model_serializers"><img src="https://codeclimate.com/github/rails-api/active_model_serializers/badges/gpa.svg" /></a>
 <a href="https://codeclimate.com/github/rails-api/active_model_serializers/coverage"><img src="https://codeclimate.com/github/rails-api/active_model_serializers/badges/coverage.svg" /></a>
 
@@ -138,6 +138,23 @@ render json: @post, meta: { total: 10 }, meta_key: "custom_meta"
 
 `meta` will only be included in your response if you are using an Adapter that supports `root`, as JsonAPI and Json adapters, the default adapter (FlattenJson) doesn't have `root`.
 
+### Using a serializer without `render`
+
+At times, you might want to use a serializer without rendering it to the view. For those cases, you can create an instance of `ActiveModel::SerializableResource` with
+the resource you want to be serialized and call `.serializable_hash`.
+
+```ruby
+def create
+  @message = current_user.messages.create!(message_params)
+  MessageCreationWorker.perform(serialized_message)
+  head 204
+end
+
+def serialized_message
+  ActiveModel::SerializableResource.new(@message).serializable_hash
+end
+```
+
 ### Overriding association methods
 
 If you want to override any association, you can use:
@@ -187,12 +204,12 @@ Doesn't follow any specifc convention.
 This adapter follows 1.0 of the format specified in
 [jsonapi.org/format](http://jsonapi.org/format). It will include the associated
 resources in the `"included"` member when the resource names are included in the
-`include` option.
+`include` option. Including nested associated resources is also supported.
 
 ```ruby
-  render @posts, include: ['authors', 'comments']
+  render @posts, include: ['author', 'comments', 'comments.author']
   # or
-  render @posts, include: 'authors,comments'
+  render @posts, include: 'author,comments,comments.author'
 ```
 
 ## Installation
@@ -283,7 +300,7 @@ The cache support is optimized to use the cached object in multiple request. An
 
 **[NOTE] Every object is individually cached.**
 
-**[NOTE] The cache is automatically expired after update an object but it's not deleted.**
+**[NOTE] The cache is automatically expired after an object is updated, but it's not deleted.**
 
 ```ruby
 cache(options = nil) # options: ```{key, expires_in, compress, force, race_condition_ttl}```

data/docs/general/adapters.md

@@ -30,9 +30,11 @@ resources in the `"included"` member when the resource names are included in the
   render @posts, include: 'authors,comments'
 ```
 
+The format of the `include` option can be either a String composed of a comma-separated list of [relationship paths](http://jsonapi.org/format/#fetching-includes), an Array of Symbols and Hashes, or a mix of both.
+
 ## Choosing an adapter
 
-If you want to use a different adapter, such as JsonApi, you can change this in an initializer:
+If you want to use a specify a default adapter, such as JsonApi, you can change this in an initializer:
 
 ```ruby
 ActiveModel::Serializer.config.adapter = ActiveModel::Serializer::Adapter::JsonApi
@@ -44,8 +46,59 @@ or
 ActiveModel::Serializer.config.adapter = :json_api
 ```
 
-If you want to have a root key in your responses you should use the Json adapter, instead of the default FlattenJson:
+If you want to have a root key for each resource in your responses, you should use the Json or
+JsonApi adapters instead of the default FlattenJson:
 
 ```ruby
 ActiveModel::Serializer.config.adapter = :json
 ```
+
+## Advanced adapter configuration
+
+### Registering an adapter
+
+The default adapter can be configured, as above, to use any class given to it.
+
+An adapter may also be specified, e.g. when rendering, as a class or as a symbol.
+If a symbol, then the adapter must be, e.g. `:great_example`,
+`ActiveModel::Serializer::Adapter::GreatExample`, or registered.
+
+There are two ways to register an adapter:
+
+1) The simplest, is to subclass `ActiveModel::Serializer::Adapter`, e.g. the below will
+register the `Example::UsefulAdapter` as `:useful_adapter`.
+
+```ruby
+module Example
+  class UsefulAdapter < ActiveModel::Serializer::Adapter
+  end
+end
+```
+
+You'll notice that the name it registers is the class name underscored, not the full namespace.
+
+Under the covers, when the `ActiveModel::Serializer::Adapter` is subclassed, it registers
+the subclass as `register(:useful_adapter, Example::UsefulAdapter)`
+
+2) Any class can be registered as an adapter by calling `register` directly on the
+`ActiveModel::Serializer::Adapter` class. e.g., the below registers `MyAdapter` as
+`:special_adapter`.
+
+```ruby
+class MyAdapter; end
+ActiveModel::Serializer::Adapter.register(:special_adapter, MyAdapter)
+```
+
+### Looking up an adapter
+
+| `ActiveModel::Serializer::Adapter.adapter_map` | A Hash of all known adapters { adapter_name => adapter_class } |
+| `ActiveModel::Serializer::Adapter.adapters`    | A (sorted) Array of all known adapter_names |
+| `ActiveModel::Serializer::Adapter.lookup(name_or_klass)` |  The adapter_class, else raises an `ActiveModel::Serializer::Adapter::UnknownAdapter` error |
+| `ActiveModel::Serializer::Adapter.adapter_class(adapter)` | delegates to `ActiveModel::Serializer::Adapter.lookup(adapter)` |
+| `ActiveModel::Serializer.adapter` | a convenience method for `ActiveModel::Serializer::Adapter.lookup(config.adapter)` |
+
+The registered adapter name is always a String, but may be looked up as a Symbol or String.
+Helpfully, the Symbol or String is underscored, so that `get(:my_adapter)` and `get("MyAdapter")`
+may both be used.
+
+For more information, see [the Adapter class on GitHub](https://github.com/rails-api/active_model_serializers/blob/master/lib/active_model/serializer/adapter.rb)

data/lib/action_controller/serialization.rb

@@ -6,6 +6,9 @@ module ActionController
 
     include ActionController::Renderers
 
+    # Deprecated
+    ADAPTER_OPTION_KEYS = ActiveModel::SerializableResource::ADAPTER_OPTION_KEYS
+
     included do
       class_attribute :_serialization_scope
       self._serialization_scope = :current_user

data/lib/active_model/serializable_resource.rb

@@ -76,7 +76,7 @@ module ActiveModel
     private
 
     ActiveModelSerializers.silence_warnings do
-    attr_reader :resource, :adapter_opts, :serializer_opts
+      attr_reader :resource, :adapter_opts, :serializer_opts
     end
   end
 end

data/lib/active_model/serializer.rb

@@ -10,6 +10,7 @@ module ActiveModel
     autoload :Lint
     autoload :Associations
     autoload :Fieldset
+    autoload :Utils
     include Configuration
     include Associations
 
@@ -94,19 +95,9 @@ module ActiveModel
       end
     end
 
+    # @see ActiveModel::Serializer::Adapter.lookup
     def self.adapter
-      adapter_class = case config.adapter
-                      when Symbol
-                        ActiveModel::Serializer::Adapter.adapter_class(config.adapter)
-                      when Class
-                        config.adapter
-                      end
-      unless adapter_class
-        valid_adapters = Adapter.constants.map { |klass| ":#{klass.to_s.downcase}" }
-        raise ArgumentError, "Unknown adapter: #{config.adapter}. Valid adapters are: #{valid_adapters}"
-      end
-
-      adapter_class
+      ActiveModel::Serializer::Adapter.lookup(config.adapter)
     end
 
     def self.root_name

data/lib/active_model/serializer/adapter.rb

@@ -1,12 +1,15 @@
 module ActiveModel
   class Serializer
     class Adapter
+      UnknownAdapterError = Class.new(ArgumentError)
+      ADAPTER_MAP = {}
+      private_constant :ADAPTER_MAP if defined?(private_constant)
       extend ActiveSupport::Autoload
-      require 'active_model/serializer/adapter/json'
-      require 'active_model/serializer/adapter/json_api'
-      autoload :FlattenJson
-      autoload :Null
       autoload :FragmentCache
+      autoload :Json
+      autoload :JsonApi
+      autoload :Null
+      autoload :FlattenJson
 
       def self.create(resource, options = {})
         override = options.delete(:adapter)
@@ -14,9 +17,67 @@ module ActiveModel
         klass.new(resource, options)
       end
 
+      # @see ActiveModel::Serializer::Adapter.lookup
       def self.adapter_class(adapter)
-        adapter_name = adapter.to_s.classify.sub('API', 'Api')
-        "ActiveModel::Serializer::Adapter::#{adapter_name}".safe_constantize
+        ActiveModel::Serializer::Adapter.lookup(adapter)
+      end
+
+      # Only the Adapter class has these methods.
+      # None of the sublasses have them.
+      class << ActiveModel::Serializer::Adapter
+        # @return Hash<adapter_name, adapter_class>
+        def adapter_map
+          ADAPTER_MAP
+        end
+
+        # @return [Array<Symbol>] list of adapter names
+        def adapters
+          adapter_map.keys.sort
+        end
+
+        # Adds an adapter 'klass' with 'name' to the 'adapter_map'
+        # Names are stringified and underscored
+        # @param [Symbol, String] name of the registered adapter
+        # @param [Class] klass - adapter class itself
+        # @example
+        #     AMS::Adapter.register(:my_adapter, MyAdapter)
+        def register(name, klass)
+          adapter_map.update(name.to_s.underscore => klass)
+          self
+        end
+
+        # @param  adapter [String, Symbol, Class] name to fetch adapter by
+        # @return [ActiveModel::Serializer::Adapter] subclass of Adapter
+        # @raise  [UnknownAdapterError]
+        def lookup(adapter)
+          # 1. return if is a class
+          return adapter if adapter.is_a?(Class)
+          adapter_name = adapter.to_s.underscore
+          # 2. return if registered
+          adapter_map.fetch(adapter_name) {
+            # 3. try to find adapter class from environment
+            adapter_class = find_by_name(adapter_name)
+            register(adapter_name, adapter_class)
+            adapter_class
+          }
+        rescue NameError, ArgumentError => e
+          failure_message =
+            "NameError: #{e.message}. Unknown adapter: #{adapter.inspect}. Valid adapters are: #{adapters}"
+          raise UnknownAdapterError, failure_message, e.backtrace
+        end
+
+        # @api private
+        def find_by_name(adapter_name)
+          adapter_name = adapter_name.to_s.classify.tr('API', 'Api')
+          ActiveModel::Serializer::Adapter.const_get(adapter_name.to_sym) or # rubocop:disable Style/AndOr
+            fail UnknownAdapterError
+        end
+        private :find_by_name
+      end
+
+      # Automatically register adapters when subclassing
+      def self.inherited(subclass)
+        ActiveModel::Serializer::Adapter.register(subclass.to_s.demodulize, subclass)
       end
 
       attr_reader :serializer

data/lib/active_model/serializer/adapter/flatten_json.rb

@@ -1,10 +1,6 @@
-module ActiveModel
-  class Serializer
-    class Adapter
-      class FlattenJson < Json
+class ActiveModel::Serializer::Adapter::FlattenJson < ActiveModel::Serializer::Adapter::Json
         def serializable_hash(options = {})
-          super
-          @result
+          super.each_value.first
         end
 
         private
@@ -13,7 +9,4 @@ module ActiveModel
         def include_meta(json)
           json
         end
-      end
-    end
-  end
 end

data/lib/active_model/serializer/adapter/fragment_cache.rb

@@ -1,7 +1,4 @@
-module ActiveModel
-  class Serializer
-    class Adapter
-      class FragmentCache
+class ActiveModel::Serializer::Adapter::FragmentCache
         attr_reader :serializer
 
         def initialize(adapter, serializer, options)
@@ -75,7 +72,4 @@ module ActiveModel
         def to_valid_const_name(name)
           name.gsub('::', '_')
         end
-      end
-    end
-  end
 end

data/lib/active_model/serializer/adapter/json.rb

@@ -1,17 +1,15 @@
-require 'active_model/serializer/adapter/json/fragment_cache'
+class ActiveModel::Serializer::Adapter::Json < ActiveModel::Serializer::Adapter
+        extend ActiveSupport::Autoload
+        autoload :FragmentCache
 
-module ActiveModel
-  class Serializer
-    class Adapter
-      class Json < Adapter
         def serializable_hash(options = nil)
           options ||= {}
           if serializer.respond_to?(:each)
-            @result = serializer.map { |s| FlattenJson.new(s).serializable_hash(options) }
+            result = serializer.map { |s| FlattenJson.new(s).serializable_hash(options) }
           else
-            @hash = {}
+            hash = {}
 
-            @core = cache_check(serializer) do
+            core = cache_check(serializer) do
               serializer.attributes(options)
             end
 
@@ -21,13 +19,13 @@ module ActiveModel
 
               if serializer.respond_to?(:each)
                 array_serializer = serializer
-                @hash[association.key] = array_serializer.map do |item|
+                hash[association.key] = array_serializer.map do |item|
                   cache_check(item) do
                     item.attributes(opts)
                   end
                 end
               else
-                @hash[association.key] =
+                hash[association.key] =
                   if serializer && serializer.object
                     cache_check(serializer) do
                       serializer.attributes(options)
@@ -37,16 +35,13 @@ module ActiveModel
                   end
               end
             end
-            @result = @core.merge @hash
+            result = core.merge hash
           end
 
-          { root => @result }
+          { root => result }
         end
 
         def fragment_cache(cached_hash, non_cached_hash)
-          Json::FragmentCache.new().fragment_cache(cached_hash, non_cached_hash)
+          ActiveModel::Serializer::Adapter::Json::FragmentCache.new().fragment_cache(cached_hash, non_cached_hash)
         end
-      end
-    end
-  end
 end

data/lib/active_model/serializer/adapter/json/fragment_cache.rb

@@ -1,14 +1,5 @@
-require 'active_model/serializer/adapter/fragment_cache'
-module ActiveModel
-  class Serializer
-    class Adapter
-      class Json < Adapter
-        class FragmentCache
+class ActiveModel::Serializer::Adapter::Json::FragmentCache
           def fragment_cache(cached_hash, non_cached_hash)
             non_cached_hash.merge cached_hash
           end
-        end
-      end
-    end
-  end
 end

data/lib/active_model/serializer/adapter/json_api.rb

@@ -1,19 +1,13 @@
-require 'active_model/serializer/adapter/json_api/fragment_cache'
-require 'active_model/serializer/adapter/json_api/pagination_links'
+class ActiveModel::Serializer::Adapter::JsonApi < ActiveModel::Serializer::Adapter
+        extend ActiveSupport::Autoload
+        autoload :PaginationLinks
+        autoload :FragmentCache
 
-module ActiveModel
-  class Serializer
-    class Adapter
-      class JsonApi < Adapter
         def initialize(serializer, options = {})
           super
           @hash = { data: [] }
 
-          @options[:include] ||= []
-          if @options[:include].is_a?(String)
-            @options[:include] = @options[:include].split(',')
-          end
-
+          @included = ActiveModel::Serializer::Utils.include_args_to_hash(@options[:include])
           fields = options.delete(:fields)
           if fields
             @fieldset = ActiveModel::Serializer::Fieldset.new(fields, serializer.json_key)
@@ -49,7 +43,7 @@ module ActiveModel
 
         def fragment_cache(cached_hash, non_cached_hash)
           root = false if @options.include?(:include)
-          JsonApi::FragmentCache.new.fragment_cache(root, cached_hash, non_cached_hash)
+          ActiveModel::Serializer::Adapter::JsonApi::FragmentCache.new().fragment_cache(root, cached_hash, non_cached_hash)
         end
 
         private
@@ -62,6 +56,12 @@ module ActiveModel
           end
         end
 
+        def add_relationships(resource, name, serializers)
+          resource[:relationships] ||= {}
+          resource[:relationships][name] ||= { data: [] }
+          resource[:relationships][name][:data] += serializers.map { |serializer| { type: serializer.json_api_type, id: serializer.id.to_s } }
+        end
+
         def resource_identifier_id_for(serializer)
           if serializer.respond_to?(:id)
             serializer.id
@@ -113,56 +113,46 @@ module ActiveModel
         end
 
         def included_for(serializer)
-          serializer.associations.flat_map { |assoc| _included_for(assoc.key, assoc.serializer) }.uniq
+          included = @included.flat_map do |inc|
+            association = serializer.associations.find { |assoc| assoc.key == inc.first }
+            _included_for(association.serializer, inc.second) if association
+          end
+
+          included.uniq
         end
 
-        def _included_for(resource_name, serializer, parent = nil)
+        def _included_for(serializer, includes)
           if serializer.respond_to?(:each)
-            serializer.flat_map { |s| _included_for(resource_name, s, parent) }.uniq
+            serializer.flat_map { |s| _included_for(s, includes) }.uniq
           else
             return [] unless serializer && serializer.object
-            result = []
-            resource_path = [parent, resource_name].compact.join('.')
-
-            if include_assoc?(resource_path)
-              primary_data = primary_data_for(serializer, @options)
-              relationships = relationships_for(serializer)
-              primary_data[:relationships] = relationships if relationships.any?
-              result.push(primary_data)
-            end
 
-            if include_nested_assoc?(resource_path)
-              non_empty_associations = serializer.associations.select(&:serializer)
+            primary_data = primary_data_for(serializer, @options)
+            relationships = relationships_for(serializer)
+            primary_data[:relationships] = relationships if relationships.any?
+
+            included = [primary_data]
 
-              non_empty_associations.each do |association|
-                result.concat(_included_for(association.key, association.serializer, resource_path))
-                result.uniq!
+            includes.each do |inc|
+              association = serializer.associations.find { |assoc| assoc.key == inc.first }
+              if association
+                included.concat(_included_for(association.serializer, inc.second))
+                included.uniq!
               end
             end
-            result
-          end
-        end
-
-        def include_assoc?(assoc)
-          check_assoc("#{assoc}$")
-        end
-
-        def include_nested_assoc?(assoc)
-          check_assoc("#{assoc}.")
-        end
 
-        def check_assoc(assoc)
-          @options[:include].any? { |s| s.match(/^#{assoc.gsub('.', '\.')}/) }
+            included
+          end
         end
 
         def add_links(options)
-          links = @hash.fetch(:meta) { {} }
+          links = @hash.fetch(:links) { {} }
           collection = serializer.object
-          @hash[:meta] = add_pagination_links(links, collection, options) if paginated?(collection)
+          @hash[:links] = add_pagination_links(links, collection, options) if paginated?(collection)
         end
 
-        def add_pagination_links(links, collection, options)
-          pagination_links = JsonApi::PaginationLinks.new(collection, options[:context]).serializable_hash(options)
+        def add_pagination_links(links, resources, options)
+          pagination_links = ActiveModel::Serializer::Adapter::JsonApi::PaginationLinks.new(resources, options[:context]).serializable_hash(options)
           links.update(pagination_links)
         end
 
@@ -171,7 +161,4 @@ module ActiveModel
             collection.respond_to?(:total_pages) &&
             collection.respond_to?(:size)
         end
-      end
-    end
-  end
 end

data/lib/active_model/serializer/adapter/json_api/fragment_cache.rb

@@ -1,9 +1,4 @@
-require 'active_model/serializer/adapter/fragment_cache'
-module ActiveModel
-  class Serializer
-    class Adapter
-      class JsonApi < Adapter
-        class FragmentCache
+class ActiveModel::Serializer::Adapter::JsonApi::FragmentCache
           def fragment_cache(root, cached_hash, non_cached_hash)
             hash              = {}
             core_cached       = cached_hash.first
@@ -15,8 +10,4 @@ module ActiveModel
 
             hash.deep_merge no_root_non_cache.deep_merge no_root_cache
           end
-        end
-      end
-    end
-  end
 end

data/lib/active_model/serializer/adapter/json_api/pagination_links.rb

@@ -1,8 +1,4 @@
-module ActiveModel
-  class Serializer
-    class Adapter
-      class JsonApi < Adapter
-        class PaginationLinks
+class ActiveModel::Serializer::Adapter::JsonApi::PaginationLinks
           FIRST_PAGE = 1
 
           attr_reader :collection, :context
@@ -51,8 +47,4 @@ module ActiveModel
           def query_parameters
             @query_parameters ||= context.query_parameters
           end
-        end
-      end
-    end
-  end
 end

data/lib/active_model/serializer/adapter/null.rb

@@ -1,11 +1,5 @@
-module ActiveModel
-  class Serializer
-    class Adapter
-      class Null < Adapter
+class ActiveModel::Serializer::Adapter::Null < ActiveModel::Serializer::Adapter
         def serializable_hash(options = nil)
           {}
         end
-      end
-    end
-  end
 end

data/lib/active_model/serializer/fieldset.rb

@@ -18,7 +18,7 @@ module ActiveModel
       private
 
       ActiveModelSerializers.silence_warnings do
-      attr_reader :raw_fields, :root
+        attr_reader :raw_fields, :root
       end
 
       def parsed_fields
@@ -26,7 +26,7 @@ module ActiveModel
           raw_fields.inject({}) { |h, (k, v)| h[k.to_sym] = v.map(&:to_sym); h }
         elsif raw_fields.is_a?(Array)
           if root.nil?
-            raise ArgumentError, 'The root argument must be specified if the fileds argument is an array.'
+            raise ArgumentError, 'The root argument must be specified if the fields argument is an array.'
           end
           hash = {}
           hash[root.to_sym] = raw_fields.map(&:to_sym)

data/lib/active_model/serializer/utils.rb

@@ -0,0 +1,35 @@
+module ActiveModel::Serializer::Utils
+  module_function
+
+  # Translates a comma separated list of dot separated paths (JSONAPI format) into a Hash.
+  # Example: `'posts.author, posts.comments.upvotes, posts.comments.author'` would become `{ posts: { author: {}, comments: { author: {}, upvotes: {} } } }`.
+  #
+  # @param [String] included
+  # @return [Hash] a Hash representing the same tree structure
+  def include_string_to_hash(included)
+    included.delete(' ').split(',').inject({}) do |hash, path|
+      hash.deep_merge!(path.split('.').reverse_each.inject({}) { |a, e| { e.to_sym => a } })
+    end
+  end
+
+  # Translates the arguments passed to the include option into a Hash. The format can be either
+  # a String (see #include_string_to_hash), an Array of Symbols and Hashes, or a mix of both.
+  # Example: `posts: [:author, comments: [:author, :upvotes]]` would become `{ posts: { author: {}, comments: { author: {}, upvotes: {} } } }`.
+  #
+  # @param [Symbol, Hash, Array, String] included
+  # @return [Hash] a Hash representing the same tree structure
+  def include_args_to_hash(included)
+    case included
+    when Symbol
+      { included => {} }
+    when Hash
+      included.each_with_object({}) { |(key, value), hash| hash[key] = include_args_to_hash(value) }
+    when Array
+      included.inject({}) { |a, e| a.merge!(include_args_to_hash(e)) }
+    when String
+      include_string_to_hash(included)
+    else
+      {}
+    end
+  end
+end

data/lib/active_model/serializer/version.rb

@@ -1,5 +1,5 @@
 module ActiveModel
   class Serializer
-    VERSION = "0.10.8"
+    VERSION = "0.10.10"
   end
 end

data/test/action_controller/json_api/linked_test.rb

@@ -43,29 +43,29 @@ module ActionController
 
           def render_resource_with_include
             setup_post
-            render json: @post, include: 'author', adapter: :json_api
+            render json: @post, include: [:author], adapter: :json_api
           end
 
           def render_resource_with_nested_include
             setup_post
-            render json: @post, include: 'comments.author', adapter: :json_api
+            render json: @post, include: [comments: [:author]], adapter: :json_api
           end
 
           def render_resource_with_nested_has_many_include
             setup_post
-            render json: @post, include: ['author', 'author.roles'], adapter: :json_api
+            render json: @post, include: 'author.roles', adapter: :json_api
           end
 
           def render_resource_with_missing_nested_has_many_include
             setup_post
             @post.author = @author2 # author2 has no roles.
-            render json: @post, include: 'author,author.roles', adapter: :json_api
+            render json: @post, include: [author: [:roles]], adapter: :json_api
           end
 
           def render_collection_with_missing_nested_has_many_include
             setup_post
             @post.author = @author2
-            render json: [@post, @post2], include: 'author,author.roles', adapter: :json_api
+            render json: [@post, @post2], include: [author: [:roles]], adapter: :json_api
           end
 
           def render_collection_without_include
@@ -75,7 +75,7 @@ module ActionController
 
           def render_collection_with_include
             setup_post
-            render json: [@post], include: %w(author comments), adapter: :json_api
+            render json: [@post], include: 'author, comments', adapter: :json_api
           end
         end
 
@@ -141,8 +141,7 @@ module ActionController
           get :render_resource_with_nested_include
           response = JSON.parse(@response.body)
           assert response.key? 'included'
-          assert_equal 1, response['included'].size
-          assert_equal 'Anonymous', response['included'].first['attributes']['name']
+          assert_equal 3, response['included'].size
         end
 
         def test_render_collection_without_include

data/test/action_controller/serialization_scope_name_test.rb

@@ -25,7 +25,7 @@ class DefaultScopeNameTest < ActionController::TestCase
     end
   end
 
- tests UserTestController
+  tests UserTestController
 
   def test_default_scope_name
     get :render_new_user

data/test/active_record_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+class ActiveRecordTest < Minitest::Test
+  include ActiveModel::Serializer::Lint::Tests
+
+  def setup
+    @resource = ARModels::Post.new
+  end
+end

data/test/adapter/json_api/belongs_to_test.rb

@@ -38,7 +38,7 @@ module ActiveModel
           end
 
           def test_includes_linked_post
-            @adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer, include: 'post')
+            @adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer, include: [:post])
             expected = [{
               id: '42',
               type: 'posts',
@@ -56,7 +56,7 @@ module ActiveModel
           end
 
           def test_limiting_linked_post_fields
-            @adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer, include: 'post', fields: { post: [:title] })
+            @adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer, include: [:post], fields: { post: [:title] })
             expected = [{
               id: '42',
               type: 'posts',
@@ -108,7 +108,7 @@ module ActiveModel
 
           def test_include_linked_resources_with_type_name
             serializer = BlogSerializer.new(@blog)
-            adapter = ActiveModel::Serializer::Adapter::JsonApi.new(serializer, include: %w(writer articles))
+            adapter = ActiveModel::Serializer::Adapter::JsonApi.new(serializer, include: [:writer, :articles])
             linked = adapter.serializable_hash[:included]
             expected = [
               {

data/test/adapter/json_api/has_many_explicit_serializer_test.rb

@@ -24,7 +24,7 @@ module ActiveModel
             @serializer = PostPreviewSerializer.new(@post)
             @adapter = ActiveModel::Serializer::Adapter::JsonApi.new(
               @serializer,
-              include: %w(comments author)
+              include: [:comments, :author]
             )
           end
 

data/test/adapter/json_api/has_many_test.rb

@@ -42,7 +42,7 @@ module ActiveModel
           end
 
           def test_includes_linked_comments
-            @adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer, include: 'comments')
+            @adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer, include: [:comments])
             expected = [{
               id: '1',
               type: 'comments',
@@ -68,7 +68,7 @@ module ActiveModel
           end
 
           def test_limit_fields_of_linked_comments
-            @adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer, include: 'comments', fields: { comment: [:id] })
+            @adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer, include: [:comments], fields: { comment: [:id] })
             expected = [{
               id: '1',
               type: 'comments',

data/test/adapter/json_api/has_one_test.rb

@@ -28,7 +28,7 @@ module ActiveModel
             @virtual_value = VirtualValue.new(id: 1)
 
             @serializer = AuthorSerializer.new(@author)
-            @adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer, include: 'bio,posts')
+            @adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer, include: [:bio, :posts])
           end
 
           def test_includes_bio_id
@@ -38,7 +38,7 @@ module ActiveModel
           end
 
           def test_includes_linked_bio
-            @adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer, include: 'bio')
+            @adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer, include: [:bio])
 
             expected = [
               {

data/test/adapter/json_api/linked_test.rb

@@ -43,11 +43,11 @@ module ActiveModel
             serializer = ArraySerializer.new([@first_post, @second_post])
             adapter = ActiveModel::Serializer::Adapter::JsonApi.new(
               serializer,
-              include: ['author', 'author.bio', 'comments']
+              include: [:comments, author: [:bio]]
             )
             alt_adapter = ActiveModel::Serializer::Adapter::JsonApi.new(
               serializer,
-              include: 'author,author.bio,comments'
+              include: [:comments, author: [:bio]]
             )
 
             expected = {
@@ -153,11 +153,11 @@ module ActiveModel
             serializer = BioSerializer.new @bio1
             adapter = ActiveModel::Serializer::Adapter::JsonApi.new(
               serializer,
-              include: ['author', 'author.posts']
+              include: [author: [:posts]]
             )
             alt_adapter = ActiveModel::Serializer::Adapter::JsonApi.new(
               serializer,
-              include: 'author,author.posts'
+              include: [author: [:posts]]
             )
 
             expected = [
@@ -224,7 +224,7 @@ module ActiveModel
             serializer = ArraySerializer.new([@first_comment, @second_comment])
             adapter = ActiveModel::Serializer::Adapter::JsonApi.new(
               serializer,
-              include: ['post']
+              include: [:post]
             )
 
             expected = [
@@ -257,7 +257,7 @@ module ActiveModel
             serializer = PostPreviewSerializer.new(@first_post)
             adapter = ActiveModel::Serializer::Adapter::JsonApi.new(
               serializer,
-              include: ['author']
+              include: [:author]
             )
 
             expected = {

data/test/adapter_test.rb

@@ -19,16 +19,6 @@ module ActiveModel
         assert_equal @serializer, @adapter.serializer
       end
 
-      def test_adapter_class_for_known_adapter
-        klass = ActiveModel::Serializer::Adapter.adapter_class(:json_api)
-        assert_equal ActiveModel::Serializer::Adapter::JsonApi, klass
-      end
-
-      def test_adapter_class_for_unknown_adapter
-        klass = ActiveModel::Serializer::Adapter.adapter_class(:json_simple)
-        assert_nil klass
-      end
-
       def test_create_adapter
         adapter = ActiveModel::Serializer::Adapter.create(@serializer)
         assert_equal ActiveModel::Serializer::Adapter::FlattenJson, adapter.class

data/test/serializers/adapter_for_test.rb

@@ -1,8 +1,15 @@
 module ActiveModel
   class Serializer
     class AdapterForTest < Minitest::Test
+      UnknownAdapterError = ::ActiveModel::Serializer::Adapter::UnknownAdapterError
+
       def setup
         @previous_adapter = ActiveModel::Serializer.config.adapter
+        # Eager load adapters
+        ActiveModel::Serializer::Adapter.eager_load!
+        [:json_api, :flatten_json, :null, :json].each do |adapter_name|
+          ActiveModel::Serializer::Adapter.lookup(adapter_name)
+        end
       end
 
       def teardown
@@ -20,6 +27,7 @@ module ActiveModel
         adapter = ActiveModel::Serializer.adapter
         assert_equal ActiveModel::Serializer::Adapter::Null, adapter
       ensure
+        ActiveModel::Serializer.config.adapter = @previous_adapter
       end
 
       def test_overwrite_adapter_with_class
@@ -32,7 +40,7 @@ module ActiveModel
       def test_raises_exception_if_invalid_symbol_given
         ActiveModel::Serializer.config.adapter = :unknown
 
-        assert_raises ArgumentError do
+        assert_raises UnknownAdapterError do
           ActiveModel::Serializer.adapter
         end
       end
@@ -40,10 +48,123 @@ module ActiveModel
       def test_raises_exception_if_it_does_not_know_hot_to_infer_adapter
         ActiveModel::Serializer.config.adapter = 42
 
-        assert_raises ArgumentError do
+        assert_raises UnknownAdapterError do
           ActiveModel::Serializer.adapter
         end
       end
+
+      def test_adapter_class_for_known_adapter
+        klass = ActiveModel::Serializer::Adapter.adapter_class(:json_api)
+        assert_equal ActiveModel::Serializer::Adapter::JsonApi, klass
+      end
+
+      def test_adapter_class_for_unknown_adapter
+        assert_raises UnknownAdapterError do
+          ActiveModel::Serializer::Adapter.adapter_class(:json_simple)
+        end
+      end
+
+      def test_adapter_map
+        expected_adapter_map = {
+          'json'.freeze              => ActiveModel::Serializer::Adapter::Json,
+          'json_api'.freeze          => ActiveModel::Serializer::Adapter::JsonApi,
+          'flatten_json'.freeze      => ActiveModel::Serializer::Adapter::FlattenJson,
+          'null'.freeze              => ActiveModel::Serializer::Adapter::Null
+        }
+        assert_equal ActiveModel::Serializer::Adapter.adapter_map, expected_adapter_map
+      end
+
+      def test_adapters
+        assert_equal ActiveModel::Serializer::Adapter.adapters.sort, [
+          'flatten_json'.freeze,
+          'json'.freeze,
+          'json_api'.freeze,
+          'null'.freeze
+        ]
+      end
+
+      def test_lookup_adapter_by_string_name
+        assert_equal ActiveModel::Serializer::Adapter.lookup('json'.freeze), ActiveModel::Serializer::Adapter::Json
+      end
+
+      def test_lookup_adapter_by_symbol_name
+        assert_equal ActiveModel::Serializer::Adapter.lookup(:json), ActiveModel::Serializer::Adapter::Json
+      end
+
+      def test_lookup_adapter_by_class
+        klass = ActiveModel::Serializer::Adapter::Json
+        assert_equal ActiveModel::Serializer::Adapter.lookup(klass), klass
+      end
+
+      def test_lookup_adapter_from_environment_registers_adapter
+        ActiveModel::Serializer::Adapter.const_set(:AdapterFromEnvironment, Class.new)
+        klass = ::ActiveModel::Serializer::Adapter::AdapterFromEnvironment
+        name = 'adapter_from_environment'.freeze
+        assert_equal ActiveModel::Serializer::Adapter.lookup(name), klass
+        assert ActiveModel::Serializer::Adapter.adapters.include?(name)
+      ensure
+        ActiveModel::Serializer::Adapter.adapter_map.delete(name)
+        ActiveModel::Serializer::Adapter.send(:remove_const, :AdapterFromEnvironment)
+      end
+
+      def test_lookup_adapter_for_unknown_name
+        assert_raises UnknownAdapterError do
+          ActiveModel::Serializer::Adapter.lookup(:json_simple)
+        end
+      end
+
+      def test_adapter
+        assert_equal ActiveModel::Serializer.config.adapter, :flatten_json
+        assert_equal ActiveModel::Serializer.adapter, ActiveModel::Serializer::Adapter::FlattenJson
+      end
+
+      def test_register_adapter
+        new_adapter_name  = :foo
+        new_adapter_klass = Class.new
+        ActiveModel::Serializer::Adapter.register(new_adapter_name, new_adapter_klass)
+        assert ActiveModel::Serializer::Adapter.adapters.include?('foo'.freeze)
+        assert ActiveModel::Serializer::Adapter.lookup(:foo), new_adapter_klass
+      ensure
+        ActiveModel::Serializer::Adapter.adapter_map.delete(new_adapter_name.to_s)
+      end
+
+      def test_inherited_adapter_hooks_register_adapter
+        Object.const_set(:MyAdapter, Class.new)
+        my_adapter = MyAdapter
+        ActiveModel::Serializer::Adapter.inherited(my_adapter)
+        assert_equal ActiveModel::Serializer::Adapter.lookup(:my_adapter), my_adapter
+      ensure
+        ActiveModel::Serializer::Adapter.adapter_map.delete('my_adapter'.freeze)
+        Object.send(:remove_const, :MyAdapter)
+      end
+
+      def test_inherited_adapter_hooks_register_demodulized_adapter
+        Object.const_set(:MyNamespace, Module.new)
+        MyNamespace.const_set(:MyAdapter, Class.new)
+        my_adapter = MyNamespace::MyAdapter
+        ActiveModel::Serializer::Adapter.inherited(my_adapter)
+        assert_equal ActiveModel::Serializer::Adapter.lookup(:my_adapter), my_adapter
+      ensure
+        ActiveModel::Serializer::Adapter.adapter_map.delete('my_adapter'.freeze)
+        MyNamespace.send(:remove_const, :MyAdapter)
+        Object.send(:remove_const, :MyNamespace)
+      end
+
+      def test_inherited_adapter_hooks_register_subclass_of_registered_adapter
+        Object.const_set(:MyAdapter, Class.new)
+        my_adapter = MyAdapter
+        Object.const_set(:MySubclassedAdapter, Class.new(MyAdapter))
+        my_subclassed_adapter = MySubclassedAdapter
+        ActiveModel::Serializer::Adapter.inherited(my_adapter)
+        ActiveModel::Serializer::Adapter.inherited(my_subclassed_adapter)
+        assert_equal ActiveModel::Serializer::Adapter.lookup(:my_adapter), my_adapter
+        assert_equal ActiveModel::Serializer::Adapter.lookup(:my_subclassed_adapter), my_subclassed_adapter
+      ensure
+        ActiveModel::Serializer::Adapter.adapter_map.delete('my_adapter'.freeze)
+        ActiveModel::Serializer::Adapter.adapter_map.delete('my_subclassed_adapter'.freeze)
+        Object.send(:remove_const, :MyAdapter)
+        Object.send(:remove_const, :MySubclassedAdapter)
+      end
     end
   end
 end

data/test/utils/include_args_to_hash_test.rb

@@ -0,0 +1,79 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    module Utils
+      class IncludeArgsToHashTest < Minitest::Test
+        def test_nil
+          input = nil
+          expected = {}
+          actual = ActiveModel::Serializer::Utils.include_args_to_hash(input)
+          assert_equal(expected, actual)
+        end
+
+        def test_empty_string
+          input = ''
+          expected = {}
+          actual = ActiveModel::Serializer::Utils.include_args_to_hash(input)
+          assert_equal(expected, actual)
+        end
+
+        def test_single_string
+          input = 'author'
+          expected = { author: {} }
+          actual = ActiveModel::Serializer::Utils.include_args_to_hash(input)
+          assert_equal(expected, actual)
+        end
+
+        def test_multiple_strings
+          input = 'author,comments'
+          expected = { author: {}, comments: {} }
+          actual = ActiveModel::Serializer::Utils.include_args_to_hash(input)
+          assert_equal(expected, actual)
+        end
+
+        def test_multiple_strings_with_space
+          input = 'author, comments'
+          expected = { author: {}, comments: {} }
+          actual = ActiveModel::Serializer::Utils.include_args_to_hash(input)
+          assert_equal(expected, actual)
+        end
+
+        def test_nested_string
+          input = 'posts.author'
+          expected = { posts: { author: {} } }
+          actual = ActiveModel::Serializer::Utils.include_args_to_hash(input)
+          assert_equal(expected, actual)
+        end
+
+        def test_multiple_nested_string
+          input = 'posts.author,posts.comments.author,comments'
+          expected = { posts: { author: {}, comments: { author: {} } }, comments: {} }
+          actual = ActiveModel::Serializer::Utils.include_args_to_hash(input)
+          assert_equal(expected, actual)
+        end
+
+        def test_empty_array
+          input = []
+          expected = {}
+          actual = ActiveModel::Serializer::Utils.include_args_to_hash(input)
+          assert_equal(expected, actual)
+        end
+
+        def test_simple_array
+          input = [:comments, :author]
+          expected = { author: {}, comments: {} }
+          actual = ActiveModel::Serializer::Utils.include_args_to_hash(input)
+          assert_equal(expected, actual)
+        end
+
+        def test_nested_array
+          input = [:comments, posts: [:author, comments: [:author]]]
+          expected = { posts: { author: {}, comments: { author: {} } }, comments: {} }
+          actual = ActiveModel::Serializer::Utils.include_args_to_hash(input)
+          assert_equal(expected, actual)
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cheap_ams
 version: !ruby/object:Gem::Version
-  version: 0.10.8
+  version: 0.10.10
 platform: ruby
 authors:
 - Steve Klabnik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-10 00:00:00.000000000 Z
+date: 2015-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -160,6 +160,7 @@ files:
 - lib/active_model/serializer/railtie.rb
 - lib/active_model/serializer/reflection.rb
 - lib/active_model/serializer/singular_reflection.rb
+- lib/active_model/serializer/utils.rb
 - lib/active_model/serializer/version.rb
 - lib/active_model_serializers.rb
 - lib/generators/serializer/USAGE
@@ -173,6 +174,7 @@ files:
 - test/action_controller/json_api/pagination_test.rb
 - test/action_controller/serialization_scope_name_test.rb
 - test/action_controller/serialization_test.rb
+- test/active_record_test.rb
 - test/adapter/fragment_cache_test.rb
 - test/adapter/json/belongs_to_test.rb
 - test/adapter/json/collection_test.rb
@@ -217,6 +219,7 @@ files:
 - test/support/stream_capture.rb
 - test/support/test_case.rb
 - test/test_helper.rb
+- test/utils/include_args_to_hash_test.rb
 homepage: https://github.com/rails-api/active_model_serializers
 licenses:
 - MIT
@@ -248,6 +251,7 @@ test_files:
 - test/action_controller/json_api/pagination_test.rb
 - test/action_controller/serialization_scope_name_test.rb
 - test/action_controller/serialization_test.rb
+- test/active_record_test.rb
 - test/adapter/fragment_cache_test.rb
 - test/adapter/json/belongs_to_test.rb
 - test/adapter/json/collection_test.rb
@@ -292,3 +296,4 @@ test_files:
 - test/support/stream_capture.rb
 - test/support/test_case.rb
 - test/test_helper.rb
+- test/utils/include_args_to_hash_test.rb