Merge branch 'master' into nested-serializers

Author: beauby

.rubocop.yml

@@ -8,39 +8,6 @@ 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:

CHANGELOG.md

@@ -1,5 +1,15 @@
 ### 0.10.0
 
+Breaking changes:
+  * Adapters now inherit Adapter::Base. 'Adapter' is now a module, no longer a class. [@bf4], #1138
+    * using a class as a namespace that you also inherit from is complicated and circular at time i.e.
+      buggy (see https://github.com/rails-api/active_model_serializers/pull/1177)
+    * The class methods on Adapter aren't necessarily related to the instance methods, they're more
+        Adapter functions
+    * named `Base` because it's a Rails-ism
+    * It helps to isolate and highlight what the Adapter interface actually is
+
+Features:
   * adds adapters pattern
   * adds support for `meta` and `meta_key` [@kurko]
   * adds method to override association [@kurko]
@@ -11,4 +21,9 @@
   * 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]
+  * adds extended format for `include` option to JsonApi adapter [@beauby]
+  * adds support for wildcards in `include` option [@beauby]
+
+Fixes:
+
+Misc:

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?branch=master)](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>
 
@@ -12,7 +12,7 @@ AMS does this through two components: **serializers** and **adapters**.
 Serializers describe _which_ attributes and relationships should be serialized.
 Adapters describe _how_ attributes and relationships should be serialized.
 
-By default AMS will use the **Flatten Json Adapter**. But we strongly advise you to use **JsonApi Adapter** that follows 1.0 of the format specified in [jsonapi.org/format](http://jsonapi.org/format).
+By default AMS will use the **Attributes Adapter**. But we strongly advise you to use **JsonApi Adapter** that follows 1.0 of the format specified in [jsonapi.org/format](http://jsonapi.org/format).
 Check how to change the adapter in the sections bellow.
 
 # RELEASE CANDIDATE, PLEASE READ
@@ -66,7 +66,7 @@ ActiveModel::Serializer.config.adapter = :json_api
 You won't need to implement an adapter unless you wish to use a new format or
 media type with AMS.
 
-If you want to have a root key on your responses you should use the Json adapter, instead of the default FlattenJson:
+If you want to have a root key on your responses you should use the Json adapter, instead of the default Attributes:
 
 ```ruby
 ActiveModel::Serializer.config.adapter = :json
@@ -136,7 +136,8 @@ The key can be customized using `meta_key` option.
 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`.
+`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 (Attributes) doesn't have `root`.
 
 ### Using a serializer without `render`
 
@@ -189,7 +190,7 @@ end
 
 ### Built in Adapters
 
-#### FlattenJSON
+#### Attributes
 
 It's the default adapter, it generates a json response without a root key.
 Doesn't follow any specifc convention.
@@ -199,7 +200,7 @@ Doesn't follow any specifc convention.
 It also generates a json response but always with a root key. The root key **can't be overridden**, and will be automatically defined accordingly with the objects being serialized.
 Doesn't follow any specifc convention.
 
-#### JSONAPI
+#### JSON API
 
 This adapter follows 1.0 of the format specified in
 [jsonapi.org/format](http://jsonapi.org/format). It will include the associated
@@ -285,9 +286,15 @@ And you can change the JSON key that the serializer should use for a particular
 
 ## Pagination
 
-Pagination links will be included in your response automatically as long as the resource is paginated using [Kaminari](https://github.com/amatsuda/kaminari) or [WillPaginate](https://github.com/mislav/will_paginate) and if you are using a ```JSON-API``` adapter.
+Pagination links will be included in your response automatically as long
+as the resource is paginated using [Kaminari](https://github.com/amatsuda/kaminari) or
+[WillPaginate](https://github.com/mislav/will_paginate) and
+if you are using the ```JsonApi``` adapter.
 
-Although the others adapters does not have this feature, it is possible to implement pagination links to `JSON` adapter. For more information about it, please see in our docs [How to add pagination links](https://github.com/rails-api/active_model_serializers/blob/master/docs/howto/add_pagination_links.md)
+Although the others adapters does not have this feature, it is possible to
+implement pagination links to `JSON` adapter. For more information about it,
+please see in our docs [How to add pagination
+links](https://github.com/rails-api/active_model_serializers/blob/master/docs/howto/add_pagination_links.md).
 
 ## Caching
 

active_model_serializers.gemspec

@@ -42,9 +42,9 @@ Gem::Specification.new do |spec|
     # 'thread_safe'
 
   # Soft dependency for pagination
-  spec.add_development_dependency 'kaminari'
-  spec.add_development_dependency 'will_paginate'
+  spec.add_development_dependency 'kaminari', ' ~> 0.16.3'
+  spec.add_development_dependency 'will_paginate', '~> 3.0', '>= 3.0.7'
 
   spec.add_development_dependency 'bundler', '~> 1.6'
-  spec.add_development_dependency 'timecop', '>= 0.7'
+  spec.add_development_dependency 'timecop', '~> 0.7'
 end

docs/general/adapters.md

@@ -3,11 +3,11 @@
 AMS does this through two components: **serializers** and **adapters**.
 Serializers describe _which_ attributes and relationships should be serialized.
 Adapters describe _how_ attributes and relationships should be serialized.
-You can use one of the built-in adapters (```FlattenJSON``` is the default one) or create one by yourself, but you won't need to implement an adapter unless you wish to use a new format or media type with AMS.
+You can use one of the built-in adapters (```Attributes``` is the default one) or create one by yourself, but you won't need to implement an adapter unless you wish to use a new format or media type with AMS.
 
 ## Built in Adapters
 
-### FlattenJSON - Default
+### Attributes - Default
 
 It's the default adapter, it generates a json response without a root key.
 Doesn't follow any specifc convention.
@@ -17,7 +17,7 @@ Doesn't follow any specifc convention.
 It also generates a json response but always with a root key. The root key **can't be overridden**, and will be automatically defined accordingly to the objects being serialized.
 Doesn't follow any specifc convention.
 
-### JSONAPI
+### JSON API
 
 This adapter follows **version 1.0** of the format specified in
 [jsonapi.org/format](http://jsonapi.org/format). It will include the associated
@@ -51,7 +51,7 @@ ActiveModel::Serializer.config.adapter = :json_api
 ```
 
 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:
+JsonApi adapters instead of the default Attributes:
 
 ```ruby
 ActiveModel::Serializer.config.adapter = :json

docs/general/configuration_options.md

@@ -4,7 +4,7 @@ The following configuration options can be set on `ActiveModel::Serializer.confi
 
 ## General
 
-- `adapter`: The [adapter](adapters.md) to use. Possible values: `:flatten_json, :json, :json_api`. Default: `:flatten_json`.
+- `adapter`: The [adapter](adapters.md) to use. Possible values: `:attributes, :json, :json_api`. Default: `:attributes`.
 
 ## JSON API
 

docs/howto/add_pagination_links.md

@@ -1,12 +1,15 @@
 # How to add pagination links
 
-### JSON-API adapter
+### JSON API adapter
 
-Pagination links will be included in your response automatically as long as the resource is paginated and if you are using a ```JSON-API``` adapter.
+Pagination links will be included in your response automatically as long as
+the resource is paginated and if you are using the ```JsonApi``` adapter.
 
-If you want pagination links in your response, use [Kaminari](https://github.com/amatsuda/kaminari) or [WillPaginate](https://github.com/mislav/will_paginate).
+If you want pagination links in your response, use [Kaminari](https://github.com/amatsuda/kaminari)
+or [WillPaginate](https://github.com/mislav/will_paginate).
 
 ###### Kaminari examples
+
 ```ruby
 #array
 @posts = Kaminari.paginate_array([1, 2, 3]).page(3).per(1)
@@ -107,6 +110,6 @@ ex.
 }
 ```
 
-### FlattenJSON adapter
+### Attributes adapter
 
 This adapter does not allow us to use `meta` key, due to that it is not possible to add pagination links.

docs/howto/add_root_key.md

@@ -1,6 +1,6 @@
 # How to add root key
 
-Add the root key to your API is quite simple with AMS. The **Adapter** is what determines the format of your JSON response. The default adapter is the ```FlattenJSON``` which doesn't have the root key, so your response is something similar to:
+Add the root key to your API is quite simple with AMS. The **Adapter** is what determines the format of your JSON response. The default adapter is the ```Attributes``` which doesn't have the root key, so your response is something similar to:
 
 ```json
 {