dm-serializer 0.9.11 → 0.10.0

data/lib/dm-serializer/to_xml.rb

@@ -8,7 +8,8 @@ module DataMapper
     #
     # @return <REXML::Document> an XML representation of this Resource
     def to_xml(opts = {})
-      to_xml_document(opts).to_s
+      xml = XMLSerializers::SERIALIZER
+      xml.output(to_xml_document(opts)).to_s
     end
 
     protected
@@ -21,7 +22,7 @@ module DataMapper
     def to_xml_document(opts={}, doc = nil)
       xml = XMLSerializers::SERIALIZER
       doc ||= xml.new_document
-      default_xml_element_name = lambda { Extlib::Inflection.underscore(self.class.name).tr("/", "-") }
+      default_xml_element_name = lambda { Extlib::Inflection.underscore(model.name).tr("/", "-") }
       root = xml.root_node(doc, opts[:element_name] || default_xml_element_name[])
       properties_to_serialize(opts).each do |property|
         value = send(property.name)
@@ -33,10 +34,16 @@ module DataMapper
         if self.respond_to?(meth)
           xml_name = meth.to_s.gsub(/[^a-z0-9_]/, '')
           value = send(meth)
-          xml.add_node(root, xml_name, value.to_s) unless value.nil?
+          unless value.nil?
+            if value.respond_to?(:to_xml_document)
+              xml.add_xml(root, value.send(:to_xml_document))
+            else
+              xml.add_node(root, xml_name, value.to_s)
+            end
+          end
         end
       end
-      xml.output(doc)
+      doc
     end
   end
 
@@ -58,4 +65,34 @@ module DataMapper
       doc
     end
   end
+
+  if Serialize::Support.dm_validations_loaded?
+
+    module Validate
+      class ValidationErrors
+        def to_xml(opts = {})
+          to_xml_document(opts).to_s
+        end
+
+        protected
+
+        def to_xml_document(opts = {})
+          xml = DataMapper::Serialize::XMLSerializers::SERIALIZER
+          doc = xml.new_document
+          root = xml.root_node(doc, "errors", {'type' => 'hash'})
+
+          errors.each do |key, value|
+            property = xml.add_node(root, key.to_s, nil, {'type' => 'array'})
+            property.attributes["type"] = 'array'
+            value.each do |error|
+              xml.add_node(property, "error", error)
+            end
+          end
+
+          doc
+        end
+      end
+    end
+
+  end
 end

data/lib/dm-serializer/to_yaml.rb

@@ -6,7 +6,7 @@ module DataMapper
     #
     # @return <YAML> a YAML representation of this Resource
     def to_yaml(opts_or_emitter = {})
-      if opts_or_emitter.is_a?(YAML::Syck::Emitter)
+      if !opts_or_emitter.is_a?(Hash)
         emitter = opts_or_emitter
         opts = {}
       else
@@ -16,8 +16,7 @@ module DataMapper
 
       YAML::quick_emit(object_id,emitter) do |out|
         out.map(nil,to_yaml_style) do |map|
-          propset = properties_to_serialize(opts)
-          propset.each do |property|
+          properties_to_serialize(opts).each do |property|
             value = send(property.name.to_sym)
             map.add(property.name, value.is_a?(Class) ? value.to_s : value)
           end
@@ -37,7 +36,7 @@ module DataMapper
 
   class Collection
     def to_yaml(opts_or_emitter = {})
-      if opts_or_emitter.is_a?(YAML::Syck::Emitter)
+      if !opts_or_emitter.is_a?(Hash)
         to_a.to_yaml(opts_or_emitter)
       else
         # FIXME: Don't double handle the YAML (remove the YAML.load)
@@ -45,4 +44,16 @@ module DataMapper
       end
     end
   end
+
+  if Serialize::Support.dm_validations_loaded?
+
+    module Validate
+      class ValidationErrors
+        def to_yaml(*args)
+          errors.to_hash.to_yaml(*args)
+        end
+      end
+    end
+
+  end
 end

data/lib/dm-serializer/version.rb

@@ -1,5 +1,5 @@
 module DataMapper
   module Serializer
-    VERSION = '0.9.11'
+    VERSION = '0.10.0'.freeze
   end
 end

data/lib/dm-serializer/xml_serializers/libxml.rb

@@ -22,6 +22,11 @@ module DataMapper
             node[attr_name] = attr_val
           end
           parent << node
+          node
+        end
+
+        def self.add_xml(parent, xml)
+          parent << xml.root.copy(true)
         end
 
         def self.output(doc)

data/lib/dm-serializer/xml_serializers/nokogiri.rb

@@ -23,6 +23,10 @@ module DataMapper
           node
         end
 
+        def self.add_xml(parent, xml)
+          parent << xml.root
+        end
+
         def self.output(doc)
           doc.root.to_s
         end

data/lib/dm-serializer/xml_serializers/rexml.rb

@@ -17,6 +17,10 @@ module DataMapper
           node
         end
 
+        def self.add_xml(parent, xml)
+          parent.add(xml)
+        end
+
         def self.output(doc)
           doc.to_s
         end

data/spec/fixtures/cow.rb

@@ -6,6 +6,6 @@ class Cow
   property :name,      String
   property :breed,     String
 
-  has n, :baby_cows, :class_name => 'Cow'
-  belongs_to :mother_cow, :class_name => 'Cow'
+  belongs_to :mother_cow, :model => self, :nullable => true
+  has n, :baby_cows, :model => self, :child_key => [ :mother_cow_id, :mother_cow_composite ]
 end

data/spec/fixtures/planet.rb

@@ -1,13 +1,17 @@
 class Planet
   include DataMapper::Resource
 
-  property :name, String, :key => true
+  property :name,     String, :key => true
   property :aphelion, Float
 
+  validates_length :name, :min => 2
+
   # Sorry these associations don't make any sense
   # I just needed a many-to-many association to test against
   has n, :friended_planets
-  has n, :friend_planets, :through => :friended_planets, :class_name => 'Planet'
+  has n, :friend_planets, :through => :friended_planets, :model => 'Planet'
+
+  belongs_to :solar_system
 
   def category
     case self.name.downcase
@@ -28,6 +32,15 @@ class FriendedPlanet
   property :planet_name,        String, :key => true
   property :friend_planet_name, String, :key => true
 
-  belongs_to :planet, :child_key => [:planet_name]
-  belongs_to :friend_planet, :class_name => 'Planet', :child_key => [:friend_planet_name]
+  belongs_to :planet, :child_key => [ :planet_name ]
+  belongs_to :friend_planet, :model => 'Planet', :child_key => [ :friend_planet_name ]
+end
+
+class SolarSystem
+  include DataMapper::Resource
+
+  property :id, Serial
+
+  property :name, String
+
 end

data/spec/fixtures/quan_tum_cat.rb

@@ -4,8 +4,8 @@ module QuanTum
   class Cat
     include DataMapper::Resource
 
-    property :id, Serial
-    property :name, String
+    property :id,       Serial
+    property :name,     String
     property :location, String
 
     repository(:alternate) do

data/spec/lib/serialization_method_shared_spec.rb

@@ -1,5 +1,4 @@
-require 'pathname'
-require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+require 'spec_helper'
 
 share_examples_for 'A serialization method that also serializes core classes' do
   # This spec ensures that we don't break any serialization methods attached
@@ -32,13 +31,19 @@ share_examples_for 'A serialization method that also serializes core classes' do
 
   it 'serializes an array of collections' do
     query = DataMapper::Query.new(DataMapper::repository(:default), Cow)
-    collection = DataMapper::Collection.new(query) do |c|
-      c.load([1, 2, 'Betsy', 'Jersey'])
-      c.load([89, 34, 'Berta', 'Guernsey'])
-    end
-    result = @harness.test([collection])
-    result[0][1].values_at("id", "composite", "name", "breed").should ==
-      [89, 34, "Berta", "Guernsey"]
+
+    keys = %w[ id composite name breed ]
+
+    resources = [
+      keys.zip([  1,  2, 'Betsy', 'Jersey'   ]).to_hash,
+      keys.zip([ 89, 34, 'Berta', 'Guernsey' ]).to_hash,
+    ]
+
+    collection = DataMapper::Collection.new(query, query.model.load(resources, query))
+
+    result = @harness.test(collection)
+    result[0].values_at(*keys).should == resources[0].values_at(*keys)
+    result[1].values_at(*keys).should == resources[1].values_at(*keys)
   end
 end
 
@@ -144,6 +149,14 @@ share_examples_for 'A serialization method' do
       result = @harness.test(planet, :only => [:name], :exclude => [:name])
       result.values_at("name", "aphelion").should == ["Mars", nil]
     end
+
+    it 'should support child associations included via the :methods parameter' do
+      solar_system = SolarSystem.create(:name => "one")
+      planet = Planet.new(:name => "earth")
+      planet.solar_system = solar_system
+      result = @harness.test(planet, :methods => [:solar_system])
+      result['solar_system'].values_at('name', 'id').should == ['one', 1]
+    end
   end
 
   describe "(collections and proxies)" do
@@ -162,19 +175,24 @@ share_examples_for 'A serialization method' do
 
     it 'should serialize a collection' do
       query = DataMapper::Query.new(DataMapper::repository(:default), Cow)
-      collection = DataMapper::Collection.new(query) do |c|
-        c.load([1, 2, 'Betsy', 'Jersey'])
-        c.load([10, 20, 'Berta', 'Guernsey'])
-      end
+
+      keys = %w[ id composite name breed ]
+
+      resources = [
+        keys.zip([  1,  2, 'Betsy', 'Jersey'   ]).to_hash,
+        keys.zip([ 10, 20, 'Berta', 'Guernsey' ]).to_hash,
+      ]
+
+      collection = DataMapper::Collection.new(query, query.model.load(resources, query))
 
       result = @harness.test(collection)
-      result[0].values_at("id", "composite", "name", "breed").should == [1,  2, 'Betsy', 'Jersey']
-      result[1].values_at("id", "composite", "name", "breed").should == [10,  20, 'Berta', 'Guernsey']
+      result[0].values_at(*keys).should == resources[0].values_at(*keys)
+      result[1].values_at(*keys).should == resources[1].values_at(*keys)
     end
 
     it 'should serialize an empty collection' do
       query = DataMapper::Query.new(DataMapper::repository(:default), Cow)
-      collection = DataMapper::Collection.new(query) {}
+      collection = DataMapper::Collection.new(query)
 
       result = @harness.test(collection)
       result.should be_empty
@@ -206,29 +224,40 @@ share_examples_for 'A serialization method' do
     end
 
     it "serializes a many to many relationship" do
-      p1 = Planet.create(:name => 'earth')
-      p2 = Planet.create(:name => 'mars')
+      pending 'TODO: fix many to many in dm-core' do
+        p1 = Planet.create(:name => 'earth')
+        p2 = Planet.create(:name => 'mars')
 
-      FriendedPlanet.create(:planet => p1, :friend_planet => p2)
+        FriendedPlanet.create(:planet => p1, :friend_planet => p2)
 
-      result = @harness.test(p1.reload.friend_planets)
-      result.should be_kind_of(Array)
+        result = @harness.test(p1.reload.friend_planets)
+        result.should be_kind_of(Array)
 
-      result[0]["name"].should == "mars"
+        result[0]["name"].should == "mars"
+      end
     end
   end
 
   describe "(multiple repositories)" do
     before(:all) do
       QuanTum::Cat.auto_migrate!
-      repository(:alternate){QuanTum::Cat.auto_migrate!}
+      DataMapper.repository(:alternate) { QuanTum::Cat.auto_migrate! }
     end
 
     it "should use the repsoitory for the model" do
       gerry = QuanTum::Cat.create(:name => "gerry")
-      george = repository(:alternate){QuanTum::Cat.create(:name => "george", :is_dead => false)}
+      george = DataMapper.repository(:alternate){ QuanTum::Cat.create(:name => "george", :is_dead => false) }
       @harness.test(gerry )['is_dead'].should be(nil)
       @harness.test(george)['is_dead'].should be(false)
     end
   end
+
+  it 'should integrate with dm-validations' do
+    planet = Planet.create(:name => 'a')
+    results = @harness.test(planet.errors)
+    results.should == {
+      "name"            => planet.errors[:name],
+      "solar_system_id" => planet.errors[:solar_system_id]
+    }
+  end
 end

data/spec/public/serializer_spec.rb

@@ -1,5 +1,4 @@
-require 'pathname'
-require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+require 'spec_helper'
 
 describe DataMapper::Serialize do
   it "is included into DataMapper::Resource" do

data/spec/public/to_csv_spec.rb

@@ -1,48 +1,62 @@
-require 'pathname'
-require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+require 'spec_helper'
 
-describe DataMapper::Serialize, '#to_csv' do
-  #
-  # ==== blah, it's CSV
-  #
+if defined?(::CSV)
+  describe DataMapper::Serialize, '#to_csv' do
+    #
+    # ==== blah, it's CSV
+    #
 
-  before(:all) do
-    query = DataMapper::Query.new(DataMapper::repository(:default), Cow)
+    before(:all) do
+      query = DataMapper::Query.new(DataMapper::repository(:default), Cow)
+
+      resources = [
+        {:id => 1, :composite => 2, :name => 'Betsy', :breed => 'Jersey'},
+        {:id => 10, :composite => 20, :name => 'Berta', :breed => 'Guernsey'}
+      ]
+
+      @collection = DataMapper::Collection.new(query, resources)
 
-    @collection = DataMapper::Collection.new(query) do |c|
-      c.load([1, 2, 'Betsy', 'Jersey'])
-      c.load([10, 20, 'Berta', 'Guernsey'])
+      @empty_collection = DataMapper::Collection.new(query)
     end
 
-    @empty_collection = DataMapper::Collection.new(query) {}
-  end
+    it "should serialize a resource to CSV" do
+      peter = Cow.new
+      peter.id = 44
+      peter.composite = 344
+      peter.name = 'Peter'
+      peter.breed = 'Long Horn'
 
-  it "should serialize a resource to CSV" do
-    peter = Cow.new
-    peter.id = 44
-    peter.composite = 344
-    peter.name = 'Peter'
-    peter.breed = 'Long Horn'
-    peter.to_csv.chomp.split(',')[0..3].should == ['44','344','Peter','Long Horn']
-  end
+      peter.to_csv.chomp.split(',')[0..3].should == ['44','344','Peter','Long Horn']
+    end
 
-  it "should serialize a collection to CSV" do
-    result = @collection.to_csv.gsub(/[[:space:]]+\n/, "\n")
-    result.split("\n")[0].split(',')[0..3].should == ['1','2','Betsy','Jersey']
-    result.split("\n")[1].split(',')[0..3].should == ['10','20','Berta','Guernsey']
-  end
+    it "should serialize a collection to CSV" do
+      result = @collection.to_csv.gsub(/[[:space:]]+\n/, "\n")
+      result.split("\n")[0].split(',')[0..3].should == ['1','2','Betsy','Jersey']
+      result.split("\n")[1].split(',')[0..3].should == ['10','20','Berta','Guernsey']
+    end
 
-  describe "multiple repositories" do
-    before(:all) do
-      QuanTum::Cat.auto_migrate!
-      repository(:alternate){QuanTum::Cat.auto_migrate!}
+    it 'should integration with dm-validations by providing one line per error' do
+      planet = Planet.create(:name => 'a')
+      result = planet.errors.to_csv.gsub(/[[:space:]]+\n/, "\n").split("\n")
+      result.should include("name,#{planet.errors[:name][0]}")
+      result.should include("solar_system_id,#{planet.errors[:solar_system_id][0]}")
+      result.length.should == 2
     end
 
-    it "should use the repsoitory for the model" do
-      gerry = QuanTum::Cat.create(:name => "gerry")
-      george = repository(:alternate){QuanTum::Cat.create(:name => "george", :is_dead => false)}
-      gerry.to_csv.should_not match(/false/)
-      george.to_csv.should match(/false/)
+    describe "multiple repositories" do
+      before(:all) do
+        QuanTum::Cat.auto_migrate!
+        DataMapper.repository(:alternate){ QuanTum::Cat.auto_migrate! }
+      end
+
+      it "should use the repsoitory for the model" do
+        gerry = QuanTum::Cat.create(:name => "gerry")
+        george = DataMapper.repository(:alternate){ QuanTum::Cat.create(:name => "george", :is_dead => false) }
+        gerry.to_csv.should_not match(/false/)
+        george.to_csv.should match(/false/)
+      end
     end
   end
+else
+  warn "[WARNING] Cannot require 'faster_csv' or 'csv', not running #to_csv specs"
 end