active_model_serializers 0.10.0.rc2 → 0.10.0.rc3

data/.travis.yml

@@ -2,6 +2,9 @@ language: ruby
 
 sudo: false
 
+cache:
+  bundler: true
+
 rvm:
   - 1.9.3
   - 2.0.0
@@ -14,6 +17,10 @@ rvm:
 install:
   - bundle install --retry=3
 
+script:
+  - bundle exec rake
+  - bundle exec rake rubocop
+
 env:
   - "RAILS_VERSION=4.0"
   - "RAILS_VERSION=4.1"
@@ -24,3 +31,4 @@ matrix:
   allow_failures:
     - rvm: ruby-head
     - env: "RAILS_VERSION=master"
+  fast_finish: true

data/CHANGELOG.md

@@ -1,8 +1,14 @@
 ### 0.10.0
 
+  * adds adapters pattern
   * adds support for `meta` and `meta_key` [@kurko]
-  * adds method to override association [adcb99e, @kurko]
+  * adds method to override association [@kurko]
   * adds `has_one` attribute for backwards compatibility [@ggordon]
-  * updates JSON API support to RC3 [@mateomurphy]
+  * adds JSON API support 1.0 [@benedikt]
   * adds fragment cache support [@joaomdmoura]
-  * adds cache support to attributes and associations [@joaomdmoura]
+  * adds cache support to attributes and associations [@joaomdmoura]
+  * uses model name to determine the type [@lsylvester]
+  * 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,17 +1,48 @@
 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
 
-gem "minitest"
+version = ENV['RAILS_VERSION'] || '4.2'
 
-version = ENV["RAILS_VERSION"] || "4.2"
+if version == 'master'
+  gem 'rack', github: 'rack/rack'
+  git 'https://github.com/rails/rails.git' do
+    gem 'railties'
+    gem 'activesupport'
+    gem 'activemodel'
+    gem 'actionpack'
+    # Rails 5
+    gem 'actionview'
+  end
+  # Rails 5
+  gem 'rails-controller-testing', github: 'rails/rails-controller-testing'
+else
+  gem_version = "~> #{version}.0"
+  gem 'railties', gem_version
+  gem 'activesupport', gem_version
+  gem 'activemodel', gem_version
+  gem 'actionpack', gem_version
+end
 
-if version == "master"
-  gem "rails", github: "rails/rails"
+group :test do
+  gem 'activerecord'
+  gem 'sqlite3', platform: [:ruby, :mingw, :x64_mingw, :mswin]
+  gem 'activerecord-jdbcsqlite3-adapter', platform: :jruby
+  gem 'codeclimate-test-reporter', require: false
+end
 
-  # ugh https://github.com/rails/rails/issues/16063#issuecomment-48090125
-  gem "arel", github: "rails/arel"
-else
-  gem "rails", "~> #{version}.0"
+group :test, :development do
+  gem 'simplecov', '~> 0.10', require: false
+end
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
+
+group :development, :test do
+  gem 'rubocop', '~> 0.34.0', require: false
 end

data/README.md

@@ -1,14 +1,18 @@
-# ActiveModel::Serializers
+# ActiveModel::Serializer
 
 [![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>
 
-ActiveModel::Serializers brings convention over configuration to your JSON generation.
+_Windows Build Status -_ [![Build status](https://ci.appveyor.com/api/projects/status/x6xdjydutm54gvyt/branch/master?svg=true)](https://ci.appveyor.com/project/joaomdmoura/active-model-serializers/branch/master)
+
+ActiveModel::Serializer brings convention over configuration to your JSON generation.
 
 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 **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 **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).
 Check how to change the adapter in the sections bellow.
 
 # RELEASE CANDIDATE, PLEASE READ
@@ -23,7 +27,7 @@ architecture. We'd love your help. [Learn how you can help here.](https://github
 ## Example
 
 Given two models, a `Post(title: string, body: text)` and a
-`Comment(name:string, body:text, post_id:integer)`, you will have two
+`Comment(name: string, body: text, post_id: integer)`, you will have two
 serializers:
 
 ```ruby
@@ -32,8 +36,6 @@ class PostSerializer < ActiveModel::Serializer
   attributes :title, :body
 
   has_many :comments
-
-  url :post
 end
 ```
 
@@ -44,8 +46,6 @@ class CommentSerializer < ActiveModel::Serializer
   attributes :name, :body
 
   belongs_to :post
-
-  url [:post, :comment]
 end
 ```
 
@@ -66,6 +66,12 @@ 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:
+
+```ruby
+ActiveModel::Serializer.config.adapter = :json
+```
+
 If you would like the key in the outputted JSON to be different from its name in ActiveRecord, you can use the :key option to customize it:
 
 ```ruby
@@ -112,7 +118,7 @@ If you wish to use a serializer other than the default, you can explicitly pass
 render json: @posts, each_serializer: PostPreviewSerializer
 
 # Or, you can explicitly provide the collection serializer as well
-render json: @posts, serializer: PaginatedSerializer, each_serializer: PostPreviewSerializer
+render json: @posts, serializer: CollectionSerializer, each_serializer: PostPreviewSerializer
 ```
 
 ### Meta
@@ -130,16 +136,23 @@ 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 there's a root. For instance,
-it won't be included in array responses.
+`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`.
 
-### Root key
+### Using a serializer without `render`
 
-If you want to define a custom root for your response, specify it in the `render`
-call:
+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
-render json: @post, root: "articles"
+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
@@ -176,17 +189,27 @@ end
 
 ### Built in Adapters
 
+#### FlattenJSON
+
+It's the default adapter, it generates a json response without a root key.
+Doesn't follow any specifc convention.
+
+#### JSON
+
+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
 
-This adapter follows RC4 of the format specified in
+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
@@ -229,8 +252,6 @@ class PostSerializer < ActiveModel::Serializer
 
   has_many :comments
   has_one :author
-
-  url :post
 end
 ```
 
@@ -241,15 +262,13 @@ class CommentSerializer < ActiveModel::Serializer
   attributes :name, :body
 
   belongs_to :post_id
-
-  url [:post, :comment]
 end
 ```
 
 The attribute names are a **whitelist** of attributes to be serialized.
 
 The `has_many`, `has_one`, and `belongs_to` declarations describe relationships between
-resources. By default, when you serialize a `Post`, you will get its `Comment`s
+resources. By default, when you serialize a `Post`, you will get its `Comments`
 as well.
 
 You may also use the `:serializer` option to specify a custom serializer class, for example:
@@ -258,8 +277,17 @@ You may also use the `:serializer` option to specify a custom serializer class,
   has_many :comments, serializer: CommentPreviewSerializer
 ```
 
-The `url` declaration describes which named routes to use while generating URLs
-for your JSON. Not every adapter will require URLs.
+And you can change the JSON key that the serializer should use for a particular association:
+
+```ruby
+  has_many :comments, key: :reviews
+```
+
+## 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.
+
+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
 
@@ -272,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}```
@@ -286,8 +314,6 @@ class PostSerializer < ActiveModel::Serializer
   attributes :title, :body
 
   has_many :comments
-
-  url :post
 end
 ```
 
@@ -311,8 +337,6 @@ class PostSerializer < ActiveModel::Serializer
   attributes :title, :body
 
   has_many :comments
-
-  url :post
 end
 ```
 

data/Rakefile

@@ -1,9 +1,36 @@
-require "bundler/gem_tasks"
+begin
+  require 'simplecov'
+rescue LoadError
+end
+
+require 'bundler/gem_tasks'
+
+begin
+  require 'rubocop'
+  require 'rubocop/rake_task'
+rescue LoadError
+else
+  Rake::Task[:rubocop].clear if Rake::Task.task_defined?(:rubocop)
+  if !defined?(::Rubinius)
+    Rake::Task[:rubocop].clear if Rake::Task.task_defined?(:rubocop)
+    desc 'Execute rubocop'
+    RuboCop::RakeTask.new(:rubocop) do |task|
+      task.options = ['--rails', '--display-cop-names', '--display-style-guide']
+      task.fail_on_error = true
+    end
+  else
+    desc 'No-op rubocop to avoid rbx segfault'
+    task :rubocop do
+      puts 'Skipping rubocop on rbx due to segfault'
+      puts 'https://github.com/rubinius/rubinius/issues/3499'
+    end
+  end
+end
 
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|
-  t.libs << "test"
+  t.libs << 'test'
   t.test_files = FileList['test/**/*_test.rb']
   t.ruby_opts = ['-r./test/test_helper.rb']
   t.verbose = true

data/active_model_serializers.gemspec

@@ -4,23 +4,47 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'active_model/serializer/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "active_model_serializers"
+  spec.name          = 'active_model_serializers'
   spec.version       = ActiveModel::Serializer::VERSION
-  spec.authors       = ["Steve Klabnik"]
-  spec.email         = ["steve@steveklabnik.com"]
-  spec.summary       = %q{Conventions-based JSON generation for Rails.}
-  spec.description   = %q{ActiveModel::Serializers allows you to generate your JSON in an object-oriented and convention-driven manner.}
-  spec.homepage      = "https://github.com/rails-api/active_model_serializers"
-  spec.license       = "MIT"
+  spec.platform      = Gem::Platform::RUBY
+  spec.authors       = ['Steve Klabnik']
+  spec.email         = ['steve@steveklabnik.com']
+  spec.summary       = 'Conventions-based JSON generation for Rails.'
+  spec.description   = 'ActiveModel::Serializers allows you to generate your JSON in an object-oriented and convention-driven manner.'
+  spec.homepage      = 'https://github.com/rails-api/active_model_serializers'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "activemodel", ">= 4.0"
+  spec.required_ruby_version = '>= 1.9.3'
 
-  spec.add_development_dependency "rails", ">= 4.0"
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"
+  rails_versions = '>= 4.0'
+  spec.add_runtime_dependency 'activemodel', rails_versions
+    # 'activesupport', rails_versions
+    # 'builder'
+
+  spec.add_runtime_dependency 'actionpack', rails_versions
+    # '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
+    # 'i18n,
+    # 'tzinfo'
+    # 'minitest'
+    # 'thread_safe'
+
+  # Soft dependency for pagination
+  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'
 end

data/appveyor.yml

@@ -0,0 +1,25 @@
+version: '{build}'
+
+skip_tags: true
+
+environment:
+  matrix:
+    - ruby_version: "193"
+    - ruby_version: "193-x64"
+    - ruby_version: "200"
+    - ruby_version: "200-x64"
+    - ruby_version: "21"
+    - ruby_version: "21-x64"
+
+install:
+  - SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
+  - ruby --version
+  - gem --version
+  - gem install bundler
+  - bundler --version
+  - bundle install --retry=3
+
+test_script:
+  - bundle exec rake
+
+build: off

data/docs/README.md

@@ -0,0 +1,29 @@
+# Docs - ActiveModel::Serializer 0.10.x
+
+This is the documentation of AMS, it's focused on the **0.10.x version.**
+
+-----
+
+## General
+
+- [Getting Started](general/getting_started.md)
+- [Adapters](general/adapters.md)
+- [Configuration Options](general/configuration_options.md)
+
+## How to
+
+- [How to add root key](howto/add_root_key.md)
+- [How to add pagination links](howto/add_pagination_links.md)
+- [Using AMS Outside Of Controllers](howto/outside_controller_use.md)
+
+## Getting Help
+
+If you find a bug, please report an [Issue](https://github.com/rails-api/active_model_serializers/issues/new).
+
+If you have a question, please [post to Stack Overflow](http://stackoverflow.com/questions/tagged/active-model-serializers).
+
+Thanks!
+
+## Contributing
+
+See [CONTRIBUTING.md](https://github.com/rails-api/active_model_serializers/blob/master/CONTRIBUTING.md)