active_model_serializers 0.5.1 → 0.5.2

data/README.markdown

@@ -126,12 +126,12 @@ class PostSerializer < ActiveModel::Serializer
 
   # only let the user see comments he created.
   def comments
-    post.comments.where(:created_by => @scope)
+    post.comments.where(:created_by => options[:scope])
   end
 end
 ```
 
-In a serializer, `@scope` is the current authorization scope (usually
+In a serializer, `options[:scope]` is the current authorization scope (usually
 `current_user`), which the controller gives to the serializer when you call
 `render :json`
 
@@ -219,11 +219,11 @@ this:
     "id": 1,
     "title": "New post",
     "body": "A body!",
-    "comments": [ 1 ]
+    "comments": [ 1, 2 ]
   },
   "comments": [
     { "id": 1, "body": "what a dumb post", "tags": [ 1, 2 ] },
-    { "id": 1, "body": "i liked it", "tags": [ 1, 3 ] },
+    { "id": 2, "body": "i liked it", "tags": [ 1, 3 ] },
   ],
   "tags": [
     { "id": 1, "name": "short" },

data/lib/action_controller/serialization.rb

@@ -41,7 +41,7 @@ module ActionController
 
     def _render_option_json(json, options)
       if json.respond_to?(:to_ary)
-        options[:root] ||= controller_name
+        options[:root] ||= controller_name unless options[:root] == false
       end
 
       serializer = options.delete(:serializer) ||

data/lib/active_model/serializer.rb

@@ -52,7 +52,15 @@ module ActiveModel
       @options[:hash] = hash = {}
       @options[:unique_values] = {}
 
-      array = serializable_array.map(&:serializable_hash)
+      array = serializable_array.map do |item|
+        if item.is_a?(Hash)
+          item
+        elsif item.respond_to?(:serializable_hash)
+          item.serializable_hash
+        else
+          item.as_json
+        end
+      end
 
       if root = @options[:root]
         hash.merge!(root => array)
@@ -91,7 +99,7 @@ module ActiveModel
   #       end
   #
   #       def author?
-  #         post.author == scope
+  #         post.author == options[:scope]
   #       end
   #     end
   #
@@ -402,9 +410,13 @@ module ActiveModel
     # Returns a hash representation of the serializable
     # object without the root.
     def serializable_hash
-      node = attributes
-      include_associations!(node) if _embed
-      node
+      instrument(:serialize, :serializer => self.class.name) do
+        node = attributes
+        instrument :associations do
+          include_associations!(node) if _embed
+        end
+        node
+      end
     end
 
     def include_associations!(node)
@@ -505,6 +517,12 @@ module ActiveModel
     end
 
     alias :read_attribute_for_serialization :send
+
+    # Use ActiveSupport::Notifications to send events to external systems.
+    # The event name is: name.class_name.serializer
+    def instrument(name, payload = {}, &block)
+      ActiveSupport::Notifications.instrument("#{name}.serializer", payload, &block)
+    end
   end
 end
 

data/lib/active_model/serializers/version.rb

@@ -1,5 +1,5 @@
 module ActiveModel
   class Serializer
-    VERSION = "0.5.1"
+    VERSION = "0.5.2"
   end
 end

data/lib/active_model_serializers.rb

@@ -1,5 +1,6 @@
 require "active_support"
 require "active_support/core_ext/string/inflections"
+require "active_support/notifications"
 require "active_model"
 require "active_model/serializer"
 
@@ -7,6 +8,8 @@ if defined?(Rails)
   module ActiveModel
     class Railtie < Rails::Railtie
       generators do |app|
+        app ||= Rails.application # Rails 3.0.x does not yield `app`
+
         Rails::Generators.configure!(app.config.generators)
         require "generators/resource_override"
       end

data/lib/generators/serializer/serializer_generator.rb

@@ -17,7 +17,7 @@ module Rails
       private
 
       def attributes_names
-        attributes.select { |attr| !attr.reference? }.map { |a| a.name.to_sym }
+        [:id] + attributes.select { |attr| !attr.reference? }.map { |a| a.name.to_sym }
       end
 
       def association_names

data/lib/generators/serializer/templates/serializer.rb

@@ -1,9 +1,8 @@
 <% module_namespacing do -%>
 class <%= class_name %>Serializer < <%= parent_class_name %>
-<% if attributes.any? -%>  attributes <%= attributes_names.map(&:inspect).join(", ") %>
-<% end -%>
+  attributes <%= attributes_names.map(&:inspect).join(", ") %>
 <% association_names.each do |attribute| -%>
   has_one :<%= attribute %>
 <% end -%>
 end
-<% end -%>
+<% end -%>

data/test/association_test.rb

@@ -185,24 +185,6 @@ class AssociationTest < ActiveModel::TestCase
       }, @root_hash)
     end
 
-    def test_with_default_has_one_with_custom_key
-      @post_serializer_class.class_eval do
-        has_one :comment, :key => :custom_comment
-      end
-
-      include! :comment
-
-      assert_equal({
-        :custom_comment => 1
-      }, @hash)
-
-      assert_equal({
-        :custom_comments => [
-          { :id => 1, :body => "ZOMG A COMMENT" }
-        ]
-      }, @root_hash)
-    end
-
     def test_embed_objects_for_has_many_associations
       @post_serializer_class.class_eval do
         has_many :comments, :embed => :objects

data/test/generators_test.rb

@@ -55,13 +55,13 @@ class SerializerGeneratorTest < Rails::Generators::TestCase
   def test_generates_attributes_and_associations
     run_generator
     assert_file "app/serializers/account_serializer.rb" do |serializer|
-      assert_match(/^  attributes :name, :description$/, serializer)
+      assert_match(/^  attributes :id, :name, :description$/, serializer)
       assert_match(/^  has_one :business$/, serializer)
     end
   end
 
   def test_with_no_attributes_does_not_add_extra_space
     run_generator ["account"]
-    assert_file "app/serializers/account_serializer.rb", /class AccountSerializer < ActiveModel::Serializer\nend/
+    assert_file "app/serializers/account_serializer.rb", /class AccountSerializer < ActiveModel::Serializer\n  attributes :id\nend/
   end
 end

data/test/serialization_test.rb

@@ -140,6 +140,11 @@ class RenderJsonTest < ActionController::TestCase
       render :json => HypermediaSerializable.new
     end
 
+    def render_json_array_with_no_root
+      render :json => [], :root => false
+    end
+
+
   private
     def default_serializer_options
       if params[:check_defaults]
@@ -217,7 +222,7 @@ class RenderJsonTest < ActionController::TestCase
     assert_match '"object":{"serializable_object":true}', @response.body
   end
 
-  def test_render_json_with_serializer
+  def test_render_json_with_serializer_checking_defaults
     get :render_json_with_serializer, :check_defaults => true
     assert_match '"scope":{"current_user":true}', @response.body
     assert_match '"object":{"serializable_object":true}', @response.body
@@ -250,4 +255,9 @@ class RenderJsonTest < ActionController::TestCase
     get :render_json_with_links
     assert_match '{"link":"http://www.nextangle.com/hypermedia"}', @response.body
   end
+
+  def test_render_json_array_with_no_root
+    get :render_json_array_with_no_root
+    assert_equal '[]', @response.body
+  end
 end

data/test/serializer_test.rb

@@ -71,8 +71,8 @@ class SerializerTest < ActiveModel::TestCase
   end
 
   class CommentSerializer
-    def initialize(comment, scope, options={})
-      @comment, @scope = comment, scope
+    def initialize(comment, options={})
+      @comment = comment
     end
 
     def serializable_hash
@@ -375,21 +375,22 @@ class SerializerTest < ActiveModel::TestCase
     }, serializer.as_json)
   end
 
+  # serialize different typed objects
   def test_array_serializer
     model    = Model.new
     user     = User.new
     comments = Comment.new(:title => "Comment1", :id => 1)
 
     array = [model, user, comments]
-    serializer = array.active_model_serializer.new(array, {:scope => true})
+    serializer = array.active_model_serializer.new(array, :scope => {:scope => true})
     assert_equal([
       { :model => "Model" },
-      { :user => { :last_name=>"Valim", :ok=>true, :first_name=>"Jose", :scope => true } },
-      { :comment => { :title => "Comment1" } }
+      { :last_name => "Valim", :ok => true, :first_name => "Jose", :scope => true },
+      { :title => "Comment1" }
     ], serializer.as_json)
   end
 
-  def test_array_serializer
+  def test_array_serializer_with_root
     comment1 = Comment.new(:title => "Comment1", :id => 1)
     comment2 = Comment.new(:title => "Comment2", :id => 2)
 
@@ -403,6 +404,13 @@ class SerializerTest < ActiveModel::TestCase
     ]}, serializer.as_json)
   end
 
+  def test_array_serializer_with_hash
+    hash = {:value => "something"}
+    array = [hash]
+    serializer = array.active_model_serializer.new(array, :root => :items)
+    assert_equal({ :items => [ hash ]}, serializer.as_json)
+  end
+
   class CustomBlog < Blog
     attr_accessor :public_posts, :public_user
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_model_serializers
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-23 00:00:00.000000000 Z
+date: 2012-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &2153228860 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,15 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153228860
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2153227780 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,7 +38,12 @@ dependencies:
         version: '3.0'
   type: :development
   prerelease: false
-  version_requirements: *2153227780
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: Making it easy to serialize models for client-side use
 email:
 - jose.valim@gmail.com
@@ -85,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Bringing consistency and object orientation to model serialization. Works
@@ -97,4 +107,3 @@ test_files:
 - test/serializer_support_test.rb
 - test/serializer_test.rb
 - test/test_helper.rb
-has_rdoc: