From e3d6d10e1ff669430c3d8678c196c52397c850ea Mon Sep 17 00:00:00 2001 From: Joshua Peek Date: Sun, 28 Jun 2009 20:16:06 -0500 Subject: Ensure JSON serializer includes model naming --- activemodel/lib/active_model/serializers/json.rb | 2 ++ activemodel/test/cases/json_serialization_test.rb | 1 - 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/activemodel/lib/active_model/serializers/json.rb b/activemodel/lib/active_model/serializers/json.rb index 60b5cbe948..440fe47e34 100644 --- a/activemodel/lib/active_model/serializers/json.rb +++ b/activemodel/lib/active_model/serializers/json.rb @@ -10,6 +10,8 @@ module ActiveModel include ActiveModel::Attributes included do + extend ActiveModel::Naming + cattr_accessor :include_root_in_json, :instance_writer => false end diff --git a/activemodel/test/cases/json_serialization_test.rb b/activemodel/test/cases/json_serialization_test.rb index abcec67a85..e50922493d 100644 --- a/activemodel/test/cases/json_serialization_test.rb +++ b/activemodel/test/cases/json_serialization_test.rb @@ -2,7 +2,6 @@ require 'cases/helper' class JsonSerializationTest < ActiveModel::TestCase class Contact - extend ActiveModel::Naming include ActiveModel::Serializers::JSON attr_accessor :name, :age, :created_at, :awesome, :preferences end -- cgit v1.2.3 From d2b78b3594b9cc9870e6a6ebfeb2e56d00e6ddb8 Mon Sep 17 00:00:00 2001 From: Joshua Peek Date: Sun, 28 Jun 2009 22:12:10 -0500 Subject: Initial extraction of AMo xml serializer --- activemodel/lib/active_model.rb | 2 + activemodel/lib/active_model/serializer.rb | 54 +++++++ activemodel/lib/active_model/serializers/json.rb | 34 +++-- activemodel/lib/active_model/serializers/xml.rb | 168 +++++++++++++++++++++ activemodel/test/cases/json_serialization_test.rb | 63 -------- .../serializeration/json_serialization_test.rb | 77 ++++++++++ .../serializeration/xml_serialization_test.rb | 81 ++++++++++ activemodel/test/models/contact.rb | 3 + 8 files changed, 404 insertions(+), 78 deletions(-) create mode 100644 activemodel/lib/active_model/serializer.rb create mode 100644 activemodel/lib/active_model/serializers/xml.rb delete mode 100644 activemodel/test/cases/json_serialization_test.rb create mode 100644 activemodel/test/cases/serializeration/json_serialization_test.rb create mode 100644 activemodel/test/cases/serializeration/xml_serialization_test.rb create mode 100644 activemodel/test/models/contact.rb diff --git a/activemodel/lib/active_model.rb b/activemodel/lib/active_model.rb index 544121c593..f988cd71b8 100644 --- a/activemodel/lib/active_model.rb +++ b/activemodel/lib/active_model.rb @@ -34,6 +34,7 @@ module ActiveModel autoload :Naming, 'active_model/naming' autoload :Observer, 'active_model/observing' autoload :Observing, 'active_model/observing' + autoload :Serializer, 'active_model/serializer' autoload :StateMachine, 'active_model/state_machine' autoload :TestCase, 'active_model/test_case' autoload :Validations, 'active_model/validations' @@ -41,6 +42,7 @@ module ActiveModel module Serializers autoload :JSON, 'active_model/serializers/json' + autoload :Xml, 'active_model/serializers/xml' end end diff --git a/activemodel/lib/active_model/serializer.rb b/activemodel/lib/active_model/serializer.rb new file mode 100644 index 0000000000..7a55921e85 --- /dev/null +++ b/activemodel/lib/active_model/serializer.rb @@ -0,0 +1,54 @@ +require 'active_support/core_ext/hash/except' +require 'active_support/core_ext/hash/slice' + +module ActiveModel + class Serializer + attr_reader :options + + def initialize(serializable, options = nil) + @serializable = serializable + @options = options ? options.dup : {} + end + + def serialize + raise NotImplemented + end + + def to_s(&block) + serialize(&block) + end + + protected + def serializable_attribute_names + attribute_names = @serializable.attributes.keys + + if options[:only] + only = Array.wrap(options[:only]).map { |n| n.to_s } + attribute_names &= only + elsif options[:except] + except = Array.wrap(options[:except]).map { |n| n.to_s } + attribute_names -= except + end + + attribute_names + end + + def serializable_method_names + Array.wrap(options[:methods]).inject([]) do |methods, name| + methods << name if @serializable.respond_to?(name.to_s) + methods + end + end + + def serializable_names + serializable_attribute_names + serializable_method_names + end + + def serializable_hash + serializable_names.inject({}) { |hash, name| + hash[name] = @serializable.send(name) + hash + } + end + end +end diff --git a/activemodel/lib/active_model/serializers/json.rb b/activemodel/lib/active_model/serializers/json.rb index 440fe47e34..0636e8c330 100644 --- a/activemodel/lib/active_model/serializers/json.rb +++ b/activemodel/lib/active_model/serializers/json.rb @@ -1,7 +1,5 @@ require 'active_support/json' require 'active_support/core_ext/class/attribute_accessors' -require 'active_support/core_ext/hash/except' -require 'active_support/core_ext/hash/slice' module ActiveModel module Serializers @@ -15,26 +13,32 @@ module ActiveModel cattr_accessor :include_root_in_json, :instance_writer => false end - def encode_json(encoder) - options = encoder.options || {} - - hash = if options[:only] - only = Array.wrap(options[:only]).map { |attr| attr.to_s } - attributes.slice(*only) - elsif options[:except] - except = Array.wrap(options[:except]).map { |attr| attr.to_s } - attributes.except(*except) - else - attributes + class Serializer < ActiveModel::Serializer + def serializable_hash + model = super + if @serializable.include_root_in_json + model = { @serializable.class.model_name.element => model } + end + model + end + + def serialize + ActiveSupport::JSON.encode(serializable_hash) end + end - hash = { self.class.model_name.element => hash } if include_root_in_json - ActiveSupport::JSON.encode(hash) + def encode_json(encoder) + Serializer.new(self, encoder.options).to_s end def as_json(options = nil) self end + + def from_json(json) + self.attributes = ActiveSupport::JSON.decode(json) + self + end end end end diff --git a/activemodel/lib/active_model/serializers/xml.rb b/activemodel/lib/active_model/serializers/xml.rb new file mode 100644 index 0000000000..d187859b44 --- /dev/null +++ b/activemodel/lib/active_model/serializers/xml.rb @@ -0,0 +1,168 @@ +require 'active_support/core_ext/class/attribute_accessors' +require 'active_support/core_ext/hash/conversions' + +module ActiveModel + module Serializers + module Xml + extend ActiveSupport::Concern + include ActiveModel::Attributes + + class Serializer < ActiveModel::Serializer #:nodoc: + class Attribute #:nodoc: + attr_reader :name, :value, :type + + def initialize(name, serializable) + @name, @serializable = name, serializable + @type = compute_type + @value = compute_value + end + + def needs_encoding? + ![ :binary, :date, :datetime, :boolean, :float, :integer ].include?(type) + end + + def decorations(include_types = true) + decorations = {} + + if type == :binary + decorations[:encoding] = 'base64' + end + + if include_types && type != :string + decorations[:type] = type + end + + if value.nil? + decorations[:nil] = true + end + + decorations + end + + protected + def compute_type + value = @serializable.send(name) + type = Hash::XML_TYPE_NAMES[value.class.name] + type ||= :string if value.respond_to?(:to_str) + type ||= :yaml + type + end + + def compute_value + value = @serializable.send(name) + + if formatter = Hash::XML_FORMATTING[type.to_s] + value ? formatter.call(value) : nil + else + value + end + end + end + + class MethodAttribute < Attribute #:nodoc: + protected + def compute_type + Hash::XML_TYPE_NAMES[@serializable.send(name).class.name] || :string + end + end + + def builder + @builder ||= begin + require 'builder' unless defined? ::Builder + options[:indent] ||= 2 + builder = options[:builder] ||= ::Builder::XmlMarkup.new(:indent => options[:indent]) + + unless options[:skip_instruct] + builder.instruct! + options[:skip_instruct] = true + end + + builder + end + end + + def root + root = (options[:root] || @serializable.class.to_s.underscore).to_s + reformat_name(root) + end + + def dasherize? + !options.has_key?(:dasherize) || options[:dasherize] + end + + def camelize? + options.has_key?(:camelize) && options[:camelize] + end + + def serializable_attributes + serializable_attribute_names.collect { |name| Attribute.new(name, @serializable) } + end + + def serializable_method_attributes + Array(options[:methods]).inject([]) do |methods, name| + methods << MethodAttribute.new(name.to_s, @serializable) if @serializable.respond_to?(name.to_s) + methods + end + end + + def add_attributes + (serializable_attributes + serializable_method_attributes).each do |attribute| + add_tag(attribute) + end + end + + def add_procs + if procs = options.delete(:procs) + [ *procs ].each do |proc| + proc.call(options) + end + end + end + + def add_tag(attribute) + builder.tag!( + reformat_name(attribute.name), + attribute.value.to_s, + attribute.decorations(!options[:skip_types]) + ) + end + + def serialize + args = [root] + + if options[:namespace] + args << {:xmlns => options[:namespace]} + end + + if options[:type] + args << {:type => options[:type]} + end + + builder.tag!(*args) do + add_attributes + procs = options.delete(:procs) + options[:procs] = procs + add_procs + yield builder if block_given? + end + end + + private + def reformat_name(name) + name = name.camelize if camelize? + dasherize? ? name.dasherize : name + end + end + + def to_xml(options = {}, &block) + serializer = Serializer.new(self, options) + block_given? ? serializer.to_s(&block) : serializer.to_s + end + + def from_xml(xml) + self.attributes = Hash.from_xml(xml).values.first + self + end + end + end +end diff --git a/activemodel/test/cases/json_serialization_test.rb b/activemodel/test/cases/json_serialization_test.rb deleted file mode 100644 index e50922493d..0000000000 --- a/activemodel/test/cases/json_serialization_test.rb +++ /dev/null @@ -1,63 +0,0 @@ -require 'cases/helper' - -class JsonSerializationTest < ActiveModel::TestCase - class Contact - include ActiveModel::Serializers::JSON - attr_accessor :name, :age, :created_at, :awesome, :preferences - end - - def setup - @contact = Contact.new - @contact.name = 'Konata Izumi' - @contact.age = 16 - @contact.created_at = Time.utc(2006, 8, 1) - @contact.awesome = true - @contact.preferences = { 'shows' => 'anime' } - end - - test "should include root in json" do - begin - Contact.include_root_in_json = true - json = @contact.to_json - - assert_match %r{^\{"contact":\{}, json - assert_match %r{"name":"Konata Izumi"}, json - assert_match %r{"age":16}, json - assert json.include?(%("created_at":#{ActiveSupport::JSON.encode(Time.utc(2006, 8, 1))})) - assert_match %r{"awesome":true}, json - assert_match %r{"preferences":\{"shows":"anime"\}}, json - ensure - Contact.include_root_in_json = false - end - end - - test "should encode all encodable attributes" do - json = @contact.to_json - - assert_match %r{"name":"Konata Izumi"}, json - assert_match %r{"age":16}, json - assert json.include?(%("created_at":#{ActiveSupport::JSON.encode(Time.utc(2006, 8, 1))})) - assert_match %r{"awesome":true}, json - assert_match %r{"preferences":\{"shows":"anime"\}}, json - end - - test "should allow attribute filtering with only" do - 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 !json.include?(%("created_at":#{ActiveSupport::JSON.encode(Time.utc(2006, 8, 1))})) - assert_no_match %r{"preferences":\{"shows":"anime"\}}, json - end - - test "should allow attribute filtering with except" do - 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 json.include?(%("created_at":#{ActiveSupport::JSON.encode(Time.utc(2006, 8, 1))})) - assert_match %r{"preferences":\{"shows":"anime"\}}, json - end -end diff --git a/activemodel/test/cases/serializeration/json_serialization_test.rb b/activemodel/test/cases/serializeration/json_serialization_test.rb new file mode 100644 index 0000000000..3e69db110e --- /dev/null +++ b/activemodel/test/cases/serializeration/json_serialization_test.rb @@ -0,0 +1,77 @@ +require 'cases/helper' +require 'models/contact' + +class Contact + include ActiveModel::Serializers::JSON +end + +class JsonSerializationTest < ActiveModel::TestCase + def setup + @contact = Contact.new + @contact.name = 'Konata Izumi' + @contact.age = 16 + @contact.created_at = Time.utc(2006, 8, 1) + @contact.awesome = true + @contact.preferences = { 'shows' => 'anime' } + end + + test "should include root in json" do + begin + Contact.include_root_in_json = true + json = @contact.to_json + + assert_match %r{^\{"contact":\{}, json + assert_match %r{"name":"Konata Izumi"}, json + assert_match %r{"age":16}, json + assert json.include?(%("created_at":#{ActiveSupport::JSON.encode(Time.utc(2006, 8, 1))})) + assert_match %r{"awesome":true}, json + assert_match %r{"preferences":\{"shows":"anime"\}}, json + ensure + Contact.include_root_in_json = false + end + end + + test "should encode all encodable attributes" do + json = @contact.to_json + + assert_match %r{"name":"Konata Izumi"}, json + assert_match %r{"age":16}, json + assert json.include?(%("created_at":#{ActiveSupport::JSON.encode(Time.utc(2006, 8, 1))})) + assert_match %r{"awesome":true}, json + assert_match %r{"preferences":\{"shows":"anime"\}}, json + end + + test "should allow attribute filtering with only" do + 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 !json.include?(%("created_at":#{ActiveSupport::JSON.encode(Time.utc(2006, 8, 1))})) + assert_no_match %r{"preferences":\{"shows":"anime"\}}, json + end + + test "should allow attribute filtering with except" do + 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 json.include?(%("created_at":#{ActiveSupport::JSON.encode(Time.utc(2006, 8, 1))})) + assert_match %r{"preferences":\{"shows":"anime"\}}, json + end + + test "methds are called on object" do + # 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 diff --git a/activemodel/test/cases/serializeration/xml_serialization_test.rb b/activemodel/test/cases/serializeration/xml_serialization_test.rb new file mode 100644 index 0000000000..57792e900e --- /dev/null +++ b/activemodel/test/cases/serializeration/xml_serialization_test.rb @@ -0,0 +1,81 @@ +require 'cases/helper' +require 'models/contact' + +class Contact + include ActiveModel::Serializers::Xml +end + +class XmlSerializationTest < ActiveModel::TestCase + def setup + @contact = Contact.new + @contact.name = 'aaron stack' + @contact.age = 25 + @contact.created_at = Time.utc(2006, 8, 1) + @contact.awesome = false + @contact.preferences = { :gem => 'ruby' } + end + + test "should serialize default root" do + @xml = @contact.to_xml + assert_match %r{^}, @xml + assert_match %r{$}, @xml + end + + test "should serialize default root with namespace" do + @xml = @contact.to_xml :namespace => "http://xml.rubyonrails.org/contact" + assert_match %r{^}, @xml + assert_match %r{$}, @xml + end + + test "should serialize custom root" do + @xml = @contact.to_xml :root => 'xml_contact' + assert_match %r{^}, @xml + assert_match %r{$}, @xml + end + + test "should allow undasherized tags" do + @xml = @contact.to_xml :root => 'xml_contact', :dasherize => false + assert_match %r{^}, @xml + assert_match %r{$}, @xml + assert_match %r{ 'xml_contact', :camelize => true + assert_match %r{^}, @xml + assert_match %r{$}, @xml + assert_match %r{ true + assert %r{25}.match(@xml) + end + + test "should include yielded additions" do + @xml = @contact.to_xml do |xml| + xml.creator "David" + end + assert_match %r{David}, @xml + end + + test "should serialize string" do + assert_match %r{aaron stack}, @contact.to_xml + end + + test "should serialize integer" do + assert_match %r{25}, @contact.to_xml + end + + test "should serialize datetime" do + assert_match %r{2006-08-01T00:00:00Z}, @contact.to_xml + end + + test "should serialize boolean" do + assert_match %r{false}, @contact.to_xml + end + + test "should serialize yaml" do + assert_match %r{--- \n:gem: ruby\n}, @contact.to_xml + end +end diff --git a/activemodel/test/models/contact.rb b/activemodel/test/models/contact.rb new file mode 100644 index 0000000000..7d69c91996 --- /dev/null +++ b/activemodel/test/models/contact.rb @@ -0,0 +1,3 @@ +class Contact + attr_accessor :name, :age, :created_at, :awesome, :preferences +end -- cgit v1.2.3 From 783db25e0c640c1588732967a87d65c10fddc08e Mon Sep 17 00:00:00 2001 From: Joshua Peek Date: Fri, 3 Jul 2009 23:12:42 -0500 Subject: Integrate AMo JSON serializer into AR --- activemodel/lib/active_model/attributes.rb | 8 ++ activemodel/lib/active_model/serializer.rb | 60 ++++++++------- activemodel/lib/active_model/serializers/json.rb | 73 ++++++++++++++++++- activerecord/lib/active_record/serialization.rb | 68 ++++------------- .../active_record/serializers/json_serializer.rb | 85 +--------------------- .../active_record/serializers/xml_serializer.rb | 12 +-- 6 files changed, 134 insertions(+), 172 deletions(-) diff --git a/activemodel/lib/active_model/attributes.rb b/activemodel/lib/active_model/attributes.rb index 4665525281..ea8c8d5f72 100644 --- a/activemodel/lib/active_model/attributes.rb +++ b/activemodel/lib/active_model/attributes.rb @@ -2,6 +2,14 @@ require 'active_support/core_ext/object/instance_variables' module ActiveModel module Attributes + def self.append_features(base) + unless base.instance_methods.include?('attributes') + super + else + false + end + end + def attributes instance_values end diff --git a/activemodel/lib/active_model/serializer.rb b/activemodel/lib/active_model/serializer.rb index 7a55921e85..5b603bdbd7 100644 --- a/activemodel/lib/active_model/serializer.rb +++ b/activemodel/lib/active_model/serializer.rb @@ -8,6 +8,9 @@ module ActiveModel def initialize(serializable, options = nil) @serializable = serializable @options = options ? options.dup : {} + + @options[:only] = Array.wrap(@options[:only]).map { |n| n.to_s } + @options[:except] = Array.wrap(@options[:except]).map { |n| n.to_s } end def serialize @@ -18,37 +21,40 @@ module ActiveModel serialize(&block) end - protected - def serializable_attribute_names - attribute_names = @serializable.attributes.keys - - if options[:only] - only = Array.wrap(options[:only]).map { |n| n.to_s } - attribute_names &= only - elsif options[:except] - except = Array.wrap(options[:except]).map { |n| n.to_s } - attribute_names -= except - end - - attribute_names + # To replicate the behavior in ActiveRecord#attributes, + # :except takes precedence over :only. If :only is not set + # for a N level model but is set for the N+1 level models, + # then because :except is set to a default value, the second + # level model can have both :except and :only set. So if + # :only is set, always delete :except. + def serializable_attribute_names + attribute_names = @serializable.attributes.keys.sort + + if options[:only].any? + attribute_names &= options[:only] + elsif options[:except].any? + attribute_names -= options[:except] end - def serializable_method_names - Array.wrap(options[:methods]).inject([]) do |methods, name| - methods << name if @serializable.respond_to?(name.to_s) - methods - end - end + attribute_names + end - def serializable_names - serializable_attribute_names + serializable_method_names + def serializable_method_names + Array.wrap(options[:methods]).inject([]) do |methods, name| + methods << name if @serializable.respond_to?(name.to_s) + methods end + end - def serializable_hash - serializable_names.inject({}) { |hash, name| - hash[name] = @serializable.send(name) - hash - } - end + def serializable_names + serializable_attribute_names + serializable_method_names + end + + def serializable_hash + serializable_names.inject({}) { |hash, name| + hash[name] = @serializable.send(name) + hash + } + end end end diff --git a/activemodel/lib/active_model/serializers/json.rb b/activemodel/lib/active_model/serializers/json.rb index 0636e8c330..adf200597d 100644 --- a/activemodel/lib/active_model/serializers/json.rb +++ b/activemodel/lib/active_model/serializers/json.rb @@ -16,10 +16,9 @@ module ActiveModel class Serializer < ActiveModel::Serializer def serializable_hash model = super - if @serializable.include_root_in_json - model = { @serializable.class.model_name.element => model } - end - model + @serializable.include_root_in_json ? + { @serializable.class.model_name.element => model } : + model end def serialize @@ -27,6 +26,72 @@ module ActiveModel end end + # Returns a JSON string representing the model. Some configuration is + # available through +options+. + # + # The option ActiveRecord::Base.include_root_in_json controls the + # top-level behavior of to_json. In a new Rails application, it is set to + # true in initializers/new_rails_defaults.rb. When it is true, + # to_json will emit a single root node named after the object's type. For example: + # + # konata = User.find(1) + # ActiveRecord::Base.include_root_in_json = true + # konata.to_json + # # => { "user": {"id": 1, "name": "Konata Izumi", "age": 16, + # "created_at": "2006/08/01", "awesome": true} } + # + # ActiveRecord::Base.include_root_in_json = false + # konata.to_json + # # => {"id": 1, "name": "Konata Izumi", "age": 16, + # "created_at": "2006/08/01", "awesome": true} + # + # The remainder of the examples in this section assume include_root_in_json is set to + # false. + # + # Without any +options+, the returned JSON string will include all + # the model's attributes. For example: + # + # konata = User.find(1) + # konata.to_json + # # => {"id": 1, "name": "Konata Izumi", "age": 16, + # "created_at": "2006/08/01", "awesome": true} + # + # The :only and :except options can be used to limit the attributes + # included, and work similar to the +attributes+ method. For example: + # + # konata.to_json(:only => [ :id, :name ]) + # # => {"id": 1, "name": "Konata Izumi"} + # + # konata.to_json(:except => [ :id, :created_at, :age ]) + # # => {"name": "Konata Izumi", "awesome": true} + # + # To include any methods on the model, use :methods. + # + # konata.to_json(:methods => :permalink) + # # => {"id": 1, "name": "Konata Izumi", "age": 16, + # "created_at": "2006/08/01", "awesome": true, + # "permalink": "1-konata-izumi"} + # + # To include associations, use :include. + # + # konata.to_json(:include => :posts) + # # => {"id": 1, "name": "Konata Izumi", "age": 16, + # "created_at": "2006/08/01", "awesome": true, + # "posts": [{"id": 1, "author_id": 1, "title": "Welcome to the weblog"}, + # {"id": 2, author_id: 1, "title": "So I was thinking"}]} + # + # 2nd level and higher order associations work as well: + # + # konata.to_json(:include => { :posts => { + # :include => { :comments => { + # :only => :body } }, + # :only => :title } }) + # # => {"id": 1, "name": "Konata Izumi", "age": 16, + # "created_at": "2006/08/01", "awesome": true, + # "posts": [{"comments": [{"body": "1st post!"}, {"body": "Second!"}], + # "title": "Welcome to the weblog"}, + # {"comments": [{"body": "Don't think too hard"}], + # "title": "So I was thinking"}]} def encode_json(encoder) Serializer.new(self, encoder.options).to_s end diff --git a/activerecord/lib/active_record/serialization.rb b/activerecord/lib/active_record/serialization.rb index 23d085bea9..94f1e8f1fd 100644 --- a/activerecord/lib/active_record/serialization.rb +++ b/activerecord/lib/active_record/serialization.rb @@ -1,42 +1,9 @@ module ActiveRecord #:nodoc: module Serialization - class Serializer #:nodoc: - attr_reader :options - - def initialize(record, options = nil) - @record = record - @options = options ? options.dup : {} - end - - # To replicate the behavior in ActiveRecord#attributes, - # :except takes precedence over :only. If :only is not set - # for a N level model but is set for the N+1 level models, - # then because :except is set to a default value, the second - # level model can have both :except and :only set. So if - # :only is set, always delete :except. - def serializable_attribute_names - attribute_names = @record.attribute_names - - if options[:only] - options.delete(:except) - attribute_names = attribute_names & Array.wrap(options[:only]).collect { |n| n.to_s } - else - options[:except] = Array.wrap(options[:except]) | Array.wrap(@record.class.inheritance_column) - attribute_names = attribute_names - options[:except].collect { |n| n.to_s } - end - - attribute_names - end - - def serializable_method_names - Array.wrap(options[:methods]).inject([]) do |method_attributes, name| - method_attributes << name if @record.respond_to?(name.to_s) - method_attributes - end - end - - def serializable_names - serializable_attribute_names + serializable_method_names + module RecordSerializer #:nodoc: + def initialize(*args) + super + options[:except] |= Array.wrap(@serializable.class.inheritance_column) end # Add associations specified via the :includes option. @@ -53,11 +20,11 @@ module ActiveRecord #:nodoc: associations = include_has_options ? include_associations.keys : Array.wrap(include_associations) for association in associations - records = case @record.class.reflect_on_association(association).macro + records = case @serializable.class.reflect_on_association(association).macro when :has_many, :has_and_belongs_to_many - @record.send(association).to_a + @serializable.send(association).to_a when :has_one, :belongs_to - @record.send(association) + @serializable.send(association) end unless records.nil? @@ -71,28 +38,19 @@ module ActiveRecord #:nodoc: end end - def serializable_record - record = {} - serializable_names.each { |name| record[name] = @record.send(name) } + def serializable_hash + hash = super add_includes do |association, records, opts| - record[association] = + hash[association] = if records.is_a?(Enumerable) - records.collect { |r| self.class.new(r, opts).serializable_record } + records.collect { |r| self.class.new(r, opts).serializable_hash } else - self.class.new(records, opts).serializable_record + self.class.new(records, opts).serializable_hash end end - record - end - - def serialize - # overwrite to implement - end - - def to_s(&block) - serialize(&block) + hash end end end diff --git a/activerecord/lib/active_record/serializers/json_serializer.rb b/activerecord/lib/active_record/serializers/json_serializer.rb index 21afcd6e5c..63bf42c09d 100644 --- a/activerecord/lib/active_record/serializers/json_serializer.rb +++ b/activerecord/lib/active_record/serializers/json_serializer.rb @@ -1,91 +1,14 @@ -require 'active_support/json' -require 'active_model/naming' - module ActiveRecord #:nodoc: module Serialization extend ActiveSupport::Concern + include ActiveModel::Serializers::JSON - included do - cattr_accessor :include_root_in_json, :instance_writer => false + class JSONSerializer < ActiveModel::Serializers::JSON::Serializer + include Serialization::RecordSerializer end - # Returns a JSON string representing the model. Some configuration is - # available through +options+. - # - # The option ActiveRecord::Base.include_root_in_json controls the - # top-level behavior of to_json. In a new Rails application, it is set to - # true in initializers/new_rails_defaults.rb. When it is true, - # to_json will emit a single root node named after the object's type. For example: - # - # konata = User.find(1) - # ActiveRecord::Base.include_root_in_json = true - # konata.to_json - # # => { "user": {"id": 1, "name": "Konata Izumi", "age": 16, - # "created_at": "2006/08/01", "awesome": true} } - # - # ActiveRecord::Base.include_root_in_json = false - # konata.to_json - # # => {"id": 1, "name": "Konata Izumi", "age": 16, - # "created_at": "2006/08/01", "awesome": true} - # - # The remainder of the examples in this section assume include_root_in_json is set to - # false. - # - # Without any +options+, the returned JSON string will include all - # the model's attributes. For example: - # - # konata = User.find(1) - # konata.to_json - # # => {"id": 1, "name": "Konata Izumi", "age": 16, - # "created_at": "2006/08/01", "awesome": true} - # - # The :only and :except options can be used to limit the attributes - # included, and work similar to the +attributes+ method. For example: - # - # konata.to_json(:only => [ :id, :name ]) - # # => {"id": 1, "name": "Konata Izumi"} - # - # konata.to_json(:except => [ :id, :created_at, :age ]) - # # => {"name": "Konata Izumi", "awesome": true} - # - # To include any methods on the model, use :methods. - # - # konata.to_json(:methods => :permalink) - # # => {"id": 1, "name": "Konata Izumi", "age": 16, - # "created_at": "2006/08/01", "awesome": true, - # "permalink": "1-konata-izumi"} - # - # To include associations, use :include. - # - # konata.to_json(:include => :posts) - # # => {"id": 1, "name": "Konata Izumi", "age": 16, - # "created_at": "2006/08/01", "awesome": true, - # "posts": [{"id": 1, "author_id": 1, "title": "Welcome to the weblog"}, - # {"id": 2, author_id: 1, "title": "So I was thinking"}]} - # - # 2nd level and higher order associations work as well: - # - # konata.to_json(:include => { :posts => { - # :include => { :comments => { - # :only => :body } }, - # :only => :title } }) - # # => {"id": 1, "name": "Konata Izumi", "age": 16, - # "created_at": "2006/08/01", "awesome": true, - # "posts": [{"comments": [{"body": "1st post!"}, {"body": "Second!"}], - # "title": "Welcome to the weblog"}, - # {"comments": [{"body": "Don't think too hard"}], - # "title": "So I was thinking"}]} def encode_json(encoder) - hash = Serializer.new(self, encoder.options).serializable_record - hash = { self.class.model_name.element => hash } if include_root_in_json - ActiveSupport::JSON.encode(hash) - end - - def as_json(options = nil) self end #:nodoc: - - def from_json(json) - self.attributes = ActiveSupport::JSON.decode(json) - self + JSONSerializer.new(self, encoder.options).to_s end end end diff --git a/activerecord/lib/active_record/serializers/xml_serializer.rb b/activerecord/lib/active_record/serializers/xml_serializer.rb index 4eaf9531e2..c3811caa53 100644 --- a/activerecord/lib/active_record/serializers/xml_serializer.rb +++ b/activerecord/lib/active_record/serializers/xml_serializer.rb @@ -164,7 +164,9 @@ module ActiveRecord #:nodoc: end end - class XmlSerializer < ActiveRecord::Serialization::Serializer #:nodoc: + class XmlSerializer < ActiveModel::Serializer #:nodoc: + include Serialization::RecordSerializer + def builder @builder ||= begin require 'builder' unless defined? ::Builder @@ -181,7 +183,7 @@ module ActiveRecord #:nodoc: end def root - root = (options[:root] || @record.class.to_s.underscore).to_s + root = (options[:root] || @serializable.class.to_s.underscore).to_s reformat_name(root) end @@ -199,12 +201,12 @@ module ActiveRecord #:nodoc: end def serializable_attributes - serializable_attribute_names.collect { |name| Attribute.new(name, @record) } + serializable_attribute_names.collect { |name| Attribute.new(name, @serializable) } end def serializable_method_attributes Array(options[:methods]).inject([]) do |method_attributes, name| - method_attributes << MethodAttribute.new(name.to_s, @record) if @record.respond_to?(name.to_s) + method_attributes << MethodAttribute.new(name.to_s, @serializable) if @serializable.respond_to?(name.to_s) method_attributes end end @@ -254,7 +256,7 @@ module ActiveRecord #:nodoc: end end else - if record = @record.send(association) + if record = @serializable.send(association) record.to_xml(opts.merge(:root => association)) end end -- cgit v1.2.3