require "cases/helper" require 'models/contact' require 'models/post' require 'models/author' require 'models/comment' require 'models/company_in_module' require 'models/toy' require 'models/topic' require 'models/reply' require 'models/company' class XmlSerializationTest < ActiveRecord::TestCase def test_should_serialize_default_root @xml = Contact.new.to_xml assert_match %r{^<contact>}, @xml assert_match %r{</contact>$}, @xml end def test_should_serialize_default_root_with_namespace @xml = Contact.new.to_xml :namespace=>"http://xml.rubyonrails.org/contact" assert_match %r{^<contact xmlns="http://xml.rubyonrails.org/contact">}, @xml assert_match %r{</contact>$}, @xml end def test_should_serialize_custom_root @xml = Contact.new.to_xml :root => 'xml_contact' assert_match %r{^<xml-contact>}, @xml assert_match %r{</xml-contact>$}, @xml end def test_should_allow_undasherized_tags @xml = Contact.new.to_xml :root => 'xml_contact', :dasherize => false assert_match %r{^<xml_contact>}, @xml assert_match %r{</xml_contact>$}, @xml assert_match %r{<created_at}, @xml end def test_should_allow_camelized_tags @xml = Contact.new.to_xml :root => 'xml_contact', :camelize => true assert_match %r{^<XmlContact>}, @xml assert_match %r{</XmlContact>$}, @xml assert_match %r{<CreatedAt}, @xml end def test_should_allow_skipped_types @xml = Contact.new(:age => 25).to_xml :skip_types => true assert %r{<age>25</age>}.match(@xml) end def test_should_include_yielded_additions @xml = Contact.new.to_xml do |xml| xml.creator "David" end assert_match %r{<creator>David</creator>}, @xml end def test_to_xml_with_block value = "Rockin' the block" xml = Contact.new.to_xml(:skip_instruct => true) do |_xml| _xml.tag! "arbitrary-element", value end assert_equal "<contact>", xml.first(9) assert xml.include?(%(<arbitrary-element>#{value}</arbitrary-element>)) end def test_should_skip_instruct_for_included_records @contact = Contact.new @contact.alternative = Contact.new(:name => 'Copa Cabana') @xml = @contact.to_xml(:include => [ :alternative ]) assert_equal @xml.index('<?xml '), 0 assert_nil @xml.index('<?xml ', 1) end end class DefaultXmlSerializationTest < ActiveRecord::TestCase def setup @xml = Contact.new(:name => 'aaron stack', :age => 25, :avatar => 'binarydata', :created_at => Time.utc(2006, 8, 1), :awesome => false, :preferences => { :gem => 'ruby' }).to_xml end def test_should_serialize_string assert_match %r{<name>aaron stack</name>}, @xml end def test_should_serialize_integer assert_match %r{<age type="integer">25</age>}, @xml end def test_should_serialize_binary assert_match %r{YmluYXJ5ZGF0YQ==\n</avatar>}, @xml assert_match %r{<avatar(.*)(type="binary")}, @xml assert_match %r{<avatar(.*)(encoding="base64")}, @xml end def test_should_serialize_datetime assert_match %r{<created-at type=\"datetime\">2006-08-01T00:00:00Z</created-at>}, @xml end def test_should_serialize_boolean assert_match %r{<awesome type=\"boolean\">false</awesome>}, @xml end def test_should_serialize_hash assert_match %r{<preferences>\s*<gem>ruby</gem>\s*</preferences>}m, @xml end end class DefaultXmlSerializationTimezoneTest < ActiveRecord::TestCase def test_should_serialize_datetime_with_timezone timezone, Time.zone = Time.zone, "Pacific Time (US & Canada)" toy = Toy.create(:name => 'Mickey', :updated_at => Time.utc(2006, 8, 1)) assert_match %r{<updated-at type=\"datetime\">2006-07-31T17:00:00-07:00</updated-at>}, toy.to_xml ensure Time.zone = timezone end def test_should_serialize_datetime_with_timezone_reloaded timezone, Time.zone = Time.zone, "Pacific Time (US & Canada)" toy = Toy.create(:name => 'Minnie', :updated_at => Time.utc(2006, 8, 1)).reload assert_match %r{<updated-at type=\"datetime\">2006-07-31T17:00:00-07:00</updated-at>}, toy.to_xml ensure Time.zone = timezone end end class NilXmlSerializationTest < ActiveRecord::TestCase def setup @xml = Contact.new.to_xml(:root => 'xml_contact') end def test_should_serialize_string assert_match %r{<name nil="true"></name>}, @xml end def test_should_serialize_integer assert %r{<age (.*)></age>}.match(@xml) attributes = $1 assert_match %r{nil="true"}, attributes assert_match %r{type="integer"}, attributes end def test_should_serialize_binary assert %r{<avatar (.*)></avatar>}.match(@xml) attributes = $1 assert_match %r{type="binary"}, attributes assert_match %r{encoding="base64"}, attributes assert_match %r{nil="true"}, attributes end def test_should_serialize_datetime assert %r{<created-at (.*)></created-at>}.match(@xml) attributes = $1 assert_match %r{nil="true"}, attributes assert_match %r{type="datetime"}, attributes end def test_should_serialize_boolean assert %r{<awesome (.*)></awesome>}.match(@xml) attributes = $1 assert_match %r{type="boolean"}, attributes assert_match %r{nil="true"}, attributes end def test_should_serialize_yaml assert_match %r{<preferences nil=\"true\"></preferences>}, @xml end end class DatabaseConnectedXmlSerializationTest < ActiveRecord::TestCase fixtures :topics, :companies, :accounts, :authors, :posts, :projects def test_to_xml xml = REXML::Document.new(topics(:first).to_xml(:indent => 0)) bonus_time_in_current_timezone = topics(:first).bonus_time.xmlschema written_on_in_current_timezone = topics(:first).written_on.xmlschema last_read_in_current_timezone = topics(:first).last_read.xmlschema assert_equal "topic", xml.root.name assert_equal "The First Topic" , xml.elements["//title"].text assert_equal "David" , xml.elements["//author-name"].text assert_match "Have a nice day", xml.elements["//content"].text assert_equal "1", xml.elements["//id"].text assert_equal "integer" , xml.elements["//id"].attributes['type'] assert_equal "1", xml.elements["//replies-count"].text assert_equal "integer" , xml.elements["//replies-count"].attributes['type'] assert_equal written_on_in_current_timezone, xml.elements["//written-on"].text assert_equal "datetime" , xml.elements["//written-on"].attributes['type'] assert_equal "david@loudthinking.com", xml.elements["//author-email-address"].text assert_equal nil, xml.elements["//parent-id"].text assert_equal "integer", xml.elements["//parent-id"].attributes['type'] assert_equal "true", xml.elements["//parent-id"].attributes['nil'] if current_adapter?(:SybaseAdapter) assert_equal last_read_in_current_timezone, xml.elements["//last-read"].text assert_equal "datetime" , xml.elements["//last-read"].attributes['type'] else # Oracle enhanced adapter allows to define Date attributes in model class (see topic.rb) assert_equal "2004-04-15", xml.elements["//last-read"].text assert_equal "date" , xml.elements["//last-read"].attributes['type'] end # Oracle and DB2 don't have true boolean or time-only fields unless current_adapter?(:OracleAdapter, :DB2Adapter) assert_equal "false", xml.elements["//approved"].text assert_equal "boolean" , xml.elements["//approved"].attributes['type'] assert_equal bonus_time_in_current_timezone, xml.elements["//bonus-time"].text assert_equal "datetime" , xml.elements["//bonus-time"].attributes['type'] end end def test_except_option xml = topics(:first).to_xml(:indent => 0, :skip_instruct => true, :except => [:title, :replies_count]) assert_equal "<topic>", xml.first(7) assert !xml.include?(%(<title>The First Topic</title>)) assert xml.include?(%(<author-name>David</author-name>)) xml = topics(:first).to_xml(:indent => 0, :skip_instruct => true, :except => [:title, :author_name, :replies_count]) assert !xml.include?(%(<title>The First Topic</title>)) assert !xml.include?(%(<author-name>David</author-name>)) end # to_xml used to mess with the hash the user provided which # caused the builder to be reused. This meant the document kept # getting appended to. def test_modules projects = MyApplication::Business::Project.all xml = projects.to_xml root = projects.first.class.to_s.underscore.pluralize.tr('/','_').dasherize assert_match "<#{root} type=\"array\">", xml assert_match "</#{root}>", xml end def test_passing_hash_shouldnt_reuse_builder options = {:include=>:posts} david = authors(:david) first_xml_size = david.to_xml(options).size second_xml_size = david.to_xml(options).size assert_equal first_xml_size, second_xml_size end def test_include_uses_association_name xml = authors(:david).to_xml :include=>:hello_posts, :indent => 0 assert_match %r{<hello-posts type="array">}, xml assert_match %r{<hello-post type="Post">}, xml assert_match %r{<hello-post type="StiPost">}, xml end def test_included_associations_should_skip_types xml = authors(:david).to_xml :include=>:hello_posts, :indent => 0, :skip_types => true assert_match %r{<hello-posts>}, xml assert_match %r{<hello-post>}, xml assert_match %r{<hello-post>}, xml end def test_including_has_many_association xml = topics(:first).to_xml(:indent => 0, :skip_instruct => true, :include => :replies, :except => :replies_count) assert_equal "<topic>", xml.first(7) assert xml.include?(%(<replies type="array"><reply>)) assert xml.include?(%(<title>The Second Topic of the day</title>)) end def test_including_belongs_to_association xml = companies(:first_client).to_xml(:indent => 0, :skip_instruct => true, :include => :firm) assert !xml.include?("<firm>") xml = companies(:second_client).to_xml(:indent => 0, :skip_instruct => true, :include => :firm) assert xml.include?("<firm>") end def test_including_multiple_associations xml = companies(:first_firm).to_xml(:indent => 0, :skip_instruct => true, :include => [ :clients, :account ]) assert_equal "<firm>", xml.first(6) assert xml.include?(%(<account>)) assert xml.include?(%(<clients type="array"><client>)) end def test_including_association_with_options xml = companies(:first_firm).to_xml( :indent => 0, :skip_instruct => true, :include => { :clients => { :only => :name } } ) assert_equal "<firm>", xml.first(6) assert xml.include?(%(<client><name>Summit</name></client>)) assert xml.include?(%(<clients type="array"><client>)) end def test_methods_are_called_on_object xml = authors(:david).to_xml :methods => :label, :indent => 0 assert_match %r{<label>.*</label>}, xml end def test_should_not_call_methods_on_associations_that_dont_respond xml = authors(:david).to_xml :include=>:hello_posts, :methods => :label, :indent => 2 assert !authors(:david).hello_posts.first.respond_to?(:label) assert_match %r{^ <label>.*</label>}, xml assert_no_match %r{^ <label>}, xml end def test_procs_are_called_on_object proc = Proc.new { |options| options[:builder].tag!('nationality', 'Danish') } xml = authors(:david).to_xml(:procs => [ proc ]) assert_match %r{<nationality>Danish</nationality>}, xml end def test_dual_arity_procs_are_called_on_object proc = Proc.new { |options, record| options[:builder].tag!('name-reverse', record.name.reverse) } xml = authors(:david).to_xml(:procs => [ proc ]) assert_match %r{<name-reverse>divaD</name-reverse>}, xml end def test_top_level_procs_arent_applied_to_associations author_proc = Proc.new { |options| options[:builder].tag!('nationality', 'Danish') } xml = authors(:david).to_xml(:procs => [ author_proc ], :include => :posts, :indent => 2) assert_match %r{^ <nationality>Danish</nationality>}, xml assert_no_match %r{^ {6}<nationality>Danish</nationality>}, xml end def test_procs_on_included_associations_are_called posts_proc = Proc.new { |options| options[:builder].tag!('copyright', 'DHH') } xml = authors(:david).to_xml( :indent => 2, :include => { :posts => { :procs => [ posts_proc ] } } ) assert_no_match %r{^ <copyright>DHH</copyright>}, xml assert_match %r{^ {6}<copyright>DHH</copyright>}, xml end def test_should_include_empty_has_many_as_empty_array authors(:david).posts.delete_all xml = authors(:david).to_xml :include=>:posts, :indent => 2 assert_equal [], Hash.from_xml(xml)['author']['posts'] assert_match %r{^ <posts type="array"/>}, xml end def test_should_has_many_array_elements_should_include_type_when_different_from_guessed_value xml = authors(:david).to_xml :include=>:posts_with_comments, :indent => 2 assert Hash.from_xml(xml) assert_match %r{^ <posts-with-comments type="array">}, xml assert_match %r{^ <posts-with-comment type="Post">}, xml assert_match %r{^ <posts-with-comment type="StiPost">}, xml types = Hash.from_xml(xml)['author']['posts_with_comments'].collect {|t| t['type'] } assert types.include?('SpecialPost') assert types.include?('Post') assert types.include?('StiPost') end def test_should_produce_xml_for_methods_returning_array xml = authors(:david).to_xml(:methods => :social) array = Hash.from_xml(xml)['author']['social'] assert_equal 2, array.size assert array.include? 'twitter' assert array.include? 'github' end def test_should_support_aliased_attributes xml = Author.select("name as firstname").to_xml array = Hash.from_xml(xml)['authors'] assert_equal array.size, array.select { |author| author.has_key? 'firstname' }.size end def test_array_to_xml_including_has_many_association xml = [ topics(:first), topics(:second) ].to_xml(:indent => 0, :skip_instruct => true, :include => :replies) assert xml.include?(%(<replies type="array"><reply>)) end def test_array_to_xml_including_methods xml = [ topics(:first), topics(:second) ].to_xml(:indent => 0, :skip_instruct => true, :methods => [ :topic_id ]) assert xml.include?(%(<topic-id type="integer">#{topics(:first).topic_id}</topic-id>)), xml assert xml.include?(%(<topic-id type="integer">#{topics(:second).topic_id}</topic-id>)), xml end def test_array_to_xml_including_has_one_association xml = [ companies(:first_firm), companies(:rails_core) ].to_xml(:indent => 0, :skip_instruct => true, :include => :account) assert xml.include?(companies(:first_firm).account.to_xml(:indent => 0, :skip_instruct => true)) assert xml.include?(companies(:rails_core).account.to_xml(:indent => 0, :skip_instruct => true)) end def test_array_to_xml_including_belongs_to_association xml = [ companies(:first_client), companies(:second_client), companies(:another_client) ].to_xml(:indent => 0, :skip_instruct => true, :include => :firm) assert xml.include?(companies(:first_client).to_xml(:indent => 0, :skip_instruct => true)) assert xml.include?(companies(:second_client).firm.to_xml(:indent => 0, :skip_instruct => true)) assert xml.include?(companies(:another_client).firm.to_xml(:indent => 0, :skip_instruct => true)) end end