Ticket #9677: add_includes_to_to_json.2.diff

activerecord/test/json_serialization_test.rb

@@ +1 @@
+require 'abstract_unit'
+require 'fixtures/contact'
+require 'fixtures/post'
+require 'fixtures/author'
+require 'fixtures/tagging'
+require 'fixtures/tag'
+require 'fixtures/comment'
+
+class JsonSerializationTest < Test::Unit::TestCase
+  def setup
+    # Quote all keys (so that we can test against strictly valid JSON).
+    ActiveSupport::JSON.unquote_hash_key_identifiers = false
+
+    @contact = Contact.new(
+      :name        => 'Konata Izumi',
+      :age         => 16,
+      :avatar      => 'binarydata',
+      :created_at  => Time.utc(2006, 8, 1),
+      :awesome     => true,
+      :preferences => { :shows => 'anime' }
+    )
+  end
+
+  def test_should_encode_all_encodable_attributes
+    json = @contact.to_json
+
+    assert_match %r{"name": "Konata Izumi"}, json
+    assert_match %r{"age": 16}, json
+    assert_match %r{"created_at": #{ActiveSupport::JSON.encode(Time.utc(2006, 8, 1))}}, json
+    assert_match %r{"awesome": true}, json
+    assert_match %r{"preferences": \{"shows": "anime"\}}, json
+  end
+
+  def test_should_allow_attribute_filtering_with_only
+    json = @contact.to_json(:only => [:name, :age])
+
+    assert_match %r{"name": "Konata Izumi"}, json
+    assert_match %r{"age": 16}, json
+    assert_no_match %r{"awesome": true}, json
+    assert_no_match %r{"created_at": #{ActiveSupport::JSON.encode(Time.utc(2006, 8, 1))}}, json
+    assert_no_match %r{"preferences": \{"shows": "anime"\}}, json
+  end
+
+  def test_should_allow_attribute_filtering_with_except
+    json = @contact.to_json(:except => [:name, :age])
+
+    assert_no_match %r{"name": "Konata Izumi"}, json
+    assert_no_match %r{"age": 16}, json
+    assert_match %r{"awesome": true}, json
+    assert_match %r{"created_at": #{ActiveSupport::JSON.encode(Time.utc(2006, 8, 1))}}, json
+    assert_match %r{"preferences": \{"shows": "anime"\}}, json
+  end
+
+  def test_methods_are_called_on_object
+    # Define methods on fixture.
+    def @contact.label; "Has cheezburger"; end
+    def @contact.favorite_quote; "Constraints are liberating"; end
+
+    # Single method.
+    assert_match %r{"label": "Has cheezburger"}, @contact.to_json(:only => :name, :methods => :label)
+
+    # Both methods.
+    methods_json = @contact.to_json(:only => :name, :methods => [:label, :favorite_quote])
+    assert_match %r{"label": "Has cheezburger"}, methods_json
+    assert_match %r{"favorite_quote": "Constraints are liberating"}, methods_json
+  end
+end
+
+class DatabaseConnectedJsonEncodingTest < Test::Unit::TestCase
+  fixtures :authors, :posts, :comments, :tags, :taggings
+
+  def setup
+    ActiveSupport::JSON.unquote_hash_key_identifiers = false
+
+    @david = authors(:david)
+  end
+
+  def test_includes_uses_association_name
+    json = @david.to_json(:include => :posts)
+    
+    assert_match %r{"posts": \[}, json
+
+    assert_match %r{"id": 1}, json
+    assert_match %r{"name": "David"}, json
+
+    assert_match %r{"author_id": 1}, json
+    assert_match %r{"title": "Welcome to the weblog"}, json
+    assert_match %r{"body": "Such a lovely day"}, json
+
+    assert_match %r{"title": "So I was thinking"}, json
+    assert_match %r{"body": "Like I hopefully always am"}, json
+  end
+
+  def test_includes_uses_association_name_and_applies_attribute_filters
+    json = @david.to_json(:include => { :posts => { :only => :title } })
+
+    assert_match %r{"name": "David"}, json
+    assert_match %r{"posts": \[}, json
+
+    assert_match %r{"title": "Welcome to the weblog"}, json
+    assert_no_match %r{"body": "Such a lovely day"}, json
+
+    assert_match %r{"title": "So I was thinking"}, json
+    assert_no_match %r{"body": "Like I hopefully always am"}, json
+  end
+
+  def test_includes_fetches_second_level_associations
+    json = @david.to_json(:include => { :posts => { :include => { :comments => { :only => :body } } } })
+
+    assert_match %r{"name": "David"}, json
+    assert_match %r{"posts": \[}, json
+
+    assert_match %r{"comments": \[}, json
+    assert_match %r{\{"body": "Thank you again for the welcome"\}}, json
+    assert_match %r{\{"body": "Don't think too hard"\}}, json
+    assert_no_match %r{"post_id": }, json
+  end
+
+  def test_includes_fetches_nth_level_associations
+    json = @david.to_json(
+      :include => {
+        :posts => {
+          :include => {
+            :taggings => {
+              :include => {
+                :tag => { :only => :name }
+              }
+            }
+          }
+        }
+    })
+
+    assert_match %r{"name": "David"}, json
+    assert_match %r{"posts": \[}, json
+
+    assert_match %r{"taggings": \[}, json
+    assert_match %r{"tag": \{"name": "General"\}}, json
+  end
+
+  def test_should_not_call_methods_on_associations_that_dont_respond
+    def @david.favorite_quote; "Constraints are liberating"; end
+    json = @david.to_json(:include => :posts, :methods => :favorite_quote)
+
+    assert !@david.posts.first.respond_to?(:favorite_quote)
+    assert_match %r{"favorite_quote": "Constraints are liberating"}, json
+    assert_equal %r{"favorite_quote": }.match(json).size, 1
+  end
+end

activerecord/lib/active_record/serialization.rb

@@ -2 +2 @@
-  module Serialization
-    class Serializer #:nodoc:
-      attr_reader :options
-
+
-      def initialize(record, options = {})
-        @record, @options = record, options.dup
-      end
@@ -23 +23 @@
-          options[:except] = Array(options[:except]) | Array(@record.class.inheritance_column)
-          attribute_names = attribute_names - options[:except].collect { |n| n.to_s }
-        end
-
+
-        attribute_names
-      end
-
-      def serializable_method_names
-        Array(options[:methods]).inject([]) do |method_attributes, name|
-:
+
-          method_attributes
-        end
-      end
-
+
-      def serializable_names
-        serializable_attribute_names + serializable_method_names
-      end
-
+      def serializable_associations
+
+      end
+
-      def serializable_record
-        returning(serializable_record = {}) do
-          serializable_names.each { |name| serializable_record[name] = @record.send(name) }
@@ -46 +50 @@
-
-      def serialize
-        # overwrite to implement
-        
-
+
+
-      def to_s(&block)
-        serialize(&block)
-      end

activerecord/lib/active_record/serializers/json_serializer.rb

@@ -13 +13 @@
-      def serialize
-        serializable_record.to_json
-      end
+
+      def serializable_record
+        returning(serializable_record = {}) do
+          serializable_names.each { |name| serializable_record[name] = @record.send(name) }
+          add_includes(serializable_record)
+        end
+      end
+
+      protected
+        # Add associations specified via the :includes option.
+        def add_includes(serializable_record)
+          if include_associations = options.delete(:include)
+            base_only_or_except = { :except => options[:except],
+                                    :only => options[:only] }
+
+            include_has_options = include_associations.is_a?(Hash)
+            associations = include_has_options ? include_associations.keys : Array(include_associations)
+
+            for association in associations
+              association_options = include_has_options ? include_associations[association] : base_only_or_except
+
+              opts = options.merge(association_options)
+
+              case @record.class.reflect_on_association(association).macro
+              when :has_many, :has_and_belongs_to_many
+                records = @record.send(association).to_a
+                unless records.empty?
+                  serializable_record[association] = records.collect { |r| self.class.new(r, opts).serializable_record }
+                end
+              when :has_one, :belongs_to
+                if record = @record.send(association)
+                  serializable_record[association] = self.class.new(record, opts).serializable_record
+                end
+              end
+            end
+
+            options[:include] = include_associations
+          end
+        end
-    end
-  end
-end