active_model_serializers 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe4ac40d39a738a9f0761ddaf33f1a13c5ef5565
-  data.tar.gz: a3db3953c4a189e3eb2c7b9b45fec250572013bf
+  metadata.gz: ee11c77cee4b5f85a7a31b2ae7fded2ae12dcab1
+  data.tar.gz: a8a8c430d80820d373fa123dc22199418e7150ee
 SHA512:
-  metadata.gz: 2d410fea01930d45f6b263c4cc347b3f4be9aae2d92465ca83bc6e56f7c5059bde90fcf2207fabfca2ae048eb136c6d81fea15b186c4b8a0a2b54dfd2177a3af
-  data.tar.gz: 4f87769234bdaa917b36387b124da7667bac3acb13745694b8013a0cdbdcb366f6519641fddacb0c2db26e5ea2bc2654234db3ec5d82e1f0d0b6fc46ed20d68f
+  metadata.gz: 3b468f9db91455e90e6f61f12c6168224f59c151e58f51ac54a2a09791daa0160119470154325b0983b7c73f2a4e614c6ac5d29a40e9914ddbdbabba35bd3574
+  data.tar.gz: 74dff8c032533a17b4e917ff8eaa57a35e19a789f0081294918b6f87619eab7abdc043ff1be9aec2bdaac8ebd38c92d7dfcef7adbc81da8a5e1518ce8b168c3c

data/.travis.yml

@@ -7,8 +7,7 @@ rvm:
   - ree
   - jruby-18mode
   - jruby-19mode
-  - rbx-18mode
-  - rbx-19mode
+  - rbx-2
 gemfile:
   - Gemfile
   - Gemfile.edge

data/CHANGELOG.md

@@ -22,9 +22,11 @@
 * URL helpers used inside of Engines now work properly.
 
 * Serializers now can filter attributes with `only` and `except`:
-  
+
+  ```
   UserSerializer.new(user, only: [:first_name, :last_name])
   UserSerializer.new(user, except: :first_name)
+  ```
 
 * Basic Mongoid support. We now include our mixins in the right place.
 

data/Gemfile

@@ -2,5 +2,3 @@ source 'https://rubygems.org'
 
 # Specify gem dependencies in active_model_serializers.gemspec
 gemspec
-
-gem "coveralls", :require => false

data/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://api.travis-ci.org/rails-api/active_model_serializers.png)](https://travis-ci.org/rails-api/active_model_serializers) [![Code Climate](https://codeclimate.com/github/rails-api/active_model_serializers.png)](https://codeclimate.com/github/rails-api/active_model_serializers) [![Coverage Status](https://coveralls.io/repos/rails-api/active_model_serializers/badge.png?branch=master)](https://coveralls.io/r/rails-api/active_model_serializers) 
+[![Build Status](https://api.travis-ci.org/rails-api/active_model_serializers.png)](https://travis-ci.org/rails-api/active_model_serializers) [![Code Climate](https://codeclimate.com/github/rails-api/active_model_serializers.png)](https://codeclimate.com/github/rails-api/active_model_serializers)
 
 # Purpose
 
@@ -19,7 +19,7 @@ The easiest way to install `ActiveModel::Serializers` is to add it to your
 `Gemfile`:
 
 ```ruby
-gem "active_model_serializers", "~> 0.7.0"
+gem "active_model_serializers", "~> 0.8.0"
 ```
 
 Then, install it on the command line:
@@ -54,7 +54,7 @@ compliant but do not descend from `ActiveRecord` or include
 `Mongoid::Document`, you must add an include statement for
 `ActiveModel::SerializerSupport` to make models serializable. If you
 also want to make collections serializable, you should include
-`ActiveModel::ArraySerializationSupport` into your ORM's
+`ActiveModel::ArraySerializerSupport` into your ORM's
 relation/criteria class.
 
 # ActiveModel::Serializer
@@ -139,23 +139,47 @@ render :json => @posts, :root => "some_posts"
 ```
 
 You may disable the root element for arrays at the top level, which will result in
-more concise json. To disable the root element for arrays, you have 4 options:
+more concise json. See the next section for ways on how to do this. Disabling the
+root element of the array with any of those methods will produce
 
-#### 1. Disable root globally for in `ArraySerializer`. In an initializer:
+```json
+[
+  { "title": "Post 1", "body": "Hello!" },
+  { "title": "Post 2", "body": "Goodbye!" }
+]
+```
+
+To specify a custom serializer for the items within an array:
+
+```ruby
+render :json => @posts, :each_serializer => FancyPostSerializer
+```
+
+## Disabling the root element
+
+You have 4 options to disable the root element, each with a slightly different scope:
+
+#### 1. Disable root globally for all, or per class
+
+In an initializer:
 
 ```ruby
 ActiveSupport.on_load(:active_model_serializers) do
+  # Disable for all serializers (except ArraySerializer)
+  ActiveModel::Serializer.root = false
+  
+  # Disable for ArraySerializer
   ActiveModel::ArraySerializer.root = false
 end
 ```
 
-#### 2. Disable root per render call in your controller:
+#### 2. Disable root per render call in your controller
 
 ```ruby
 render :json => @posts, :root => false
 ```
 
-#### 3. Create a custom `ArraySerializer` and render arrays with it:
+#### 3. Subclass the serializer, and specify using it
 
 ```ruby
 class CustomArraySerializer < ActiveModel::ArraySerializer
@@ -166,21 +190,6 @@ end
 render :json => @posts, :serializer => CustomArraySerializer
 ```
 
-Disabling the root element of the array with any of the above 3 methods
-will produce
-
-```json
-[
-  { "title": "Post 1", "body": "Hello!" },
-  { "title": "Post 2", "body": "Goodbye!" }
-]
-```
-
-To specify a custom serializer for the items within an array:
-
-```ruby
-render :json => @posts, :each_serializer => FancyPostSerializer
-```
 #### 4. Define default_serializer_options in your controller
 
 If you define `default_serializer_options` method in your controller,

data/active_model_serializers.gemspec

@@ -20,6 +20,4 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'activemodel', '>= 3.0'
   gem.add_development_dependency "rails", ">= 3.0"
   gem.add_development_dependency "pry"
-  gem.add_development_dependency "simplecov"
-  gem.add_development_dependency "coveralls"
 end

data/lib/active_model/array_serializer.rb

@@ -83,7 +83,7 @@ module ActiveModel
           serializer = item.active_model_serializer
         end
 
-        serializable = serializer ? serializer.new(item, @options) : DefaultSerializer.new(item, @options)
+        serializable = serializer ? serializer.new(item, @options) : DefaultSerializer.new(item, @options.merge(:root => false))
 
         if serializable.respond_to?(:serializable_hash)
           serializable.serializable_hash

data/lib/active_model/serializer.rb

@@ -337,6 +337,7 @@ module ActiveModel
     # Returns a json representation of the serializable
     # object including the root.
     def as_json(options={})
+      options ||= {}
       if root = options.fetch(:root, @options.fetch(:root, root_name))
         @options[:hash] = hash = {}
         @options[:unique_values] = {}

data/lib/active_model/serializers/version.rb

@@ -1,5 +1,5 @@
 module ActiveModel
   class Serializer
-    VERSION = "0.8.1"
+    VERSION = "0.8.2"
   end
 end

data/lib/active_model_serializers.rb

@@ -20,9 +20,7 @@ if defined?(Rails)
 
       initializer "include_routes.active_model_serializer" do |app|
         ActiveSupport.on_load(:active_model_serializers) do
-          include AbstractController::UrlFor
-          extend ::AbstractController::Railties::RoutesHelpers.with(app.routes)
-          include app.routes.mounted_helpers
+          include app.routes.url_helpers
         end
       end
 

data/test/array_serializer_test.rb

@@ -2,6 +2,27 @@ require "test_helper"
 require "test_fakes"
 
 class ArraySerializerTest < ActiveModel::TestCase
+
+  def test_array_items_do_not_have_root
+    array = [
+        BasicActiveModel.new(:name => "First model"),
+        BasicActiveModel.new(:name => "Second model")
+    ]
+    expected = { "root" => [
+        { :name => "First model" },
+        { :name => "Second model" }
+    ] }
+
+    default_serializer = array.active_model_serializer.new(array, :root => "root")
+    each_serializer = array.active_model_serializer.new(array, :root => "root", :each_serializer => BasicSerializer)
+
+    default_json = default_serializer.as_json
+    each_json = each_serializer.as_json
+
+    assert_equal(expected, default_json)
+    assert_equal(expected, each_json)
+  end
+
   # serialize different typed objects
   def test_array_serializer
     model    = Model.new

data/test/serializer_test.rb

@@ -1449,4 +1449,17 @@ class SerializerTest < ActiveModel::TestCase
       }
     }, post_serializer.as_json)
   end
+
+  def test_as_json_with_nil_options
+    user = User.new
+    user_serializer = DefaultUserSerializer.new(user, {})
+
+    # ActiveSupport 3.1 Object#to_json generates this downstream call
+    assert_equal({
+      :default_user => {
+        :first_name => "Jose",
+        :last_name => "Valim"
+      }
+    }, user_serializer.as_json(nil))
+  end
 end

data/test/test_fakes.rb

@@ -1,3 +1,26 @@
+class BasicActiveModel
+  include ActiveModel::Serializers::JSON
+  def initialize(hash = {})
+    @attributes = hash
+  end
+
+  def serializable_hash(*)
+    @attributes
+  end
+
+  def method_missing(method)
+    if @attributes.key? method
+      @attributes[method]
+    else
+      raise NoMethodError
+    end
+  end
+end
+
+class BasicSerializer < ActiveModel::Serializer
+  attributes :name
+end
+
 class Model
   def initialize(hash={})
     @attributes = hash

data/test/test_helper.rb

@@ -1,15 +1,6 @@
 require "rubygems"
 require "bundler/setup"
 
-require 'simplecov'
-SimpleCov.start do
-  add_group "lib", "lib"
-  add_group "spec", "spec"
-end
-
-require 'coveralls'
-Coveralls.wear!
-
 require "pry"
 
 require "active_model_serializers"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_model_serializers
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
 platform: ruby
 authors:
 - José Valim
@@ -9,76 +9,48 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-06 00:00:00.000000000 Z
+date: 2014-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Making it easy to serialize models for client-side use
@@ -89,8 +61,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - DESIGN.textile
 - Gemfile
@@ -132,31 +104,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Bringing consistency and object orientation to model serialization. Works
   great for client-side MVC frameworks!
-test_files:
-- test/array_serializer_test.rb
-- test/association_test.rb
-- test/caching_test.rb
-- test/generators_test.rb
-- test/no_serialization_scope_test.rb
-- test/serialization_scope_name_test.rb
-- test/serialization_test.rb
-- test/serializer_support_test.rb
-- test/serializer_test.rb
-- test/test_fakes.rb
-- test/test_helper.rb
-has_rdoc: 
+test_files: []