dm-serializer 0.9.7 → 0.9.8

data/History.txt

@@ -1 +1,10 @@
+=== 0.9.8 / 2008-12-07
 
+* 2 minor enhancements:
+
+  * to_yaml and to_xml now support :only and :exclude options
+  * to_yaml and to_xml now support serializing methods
+
+* 1 bug fix:
+
+  * gem requires now preceded by gem() call

data/Manifest.txt

@@ -10,11 +10,14 @@ lib/dm-serializer.rb
 lib/dm-serializer/version.rb
 spec/fixtures/cow.rb
 spec/fixtures/planet.rb
-spec/fixtures/quatum_cat.rb
+spec/fixtures/quan_tum_cat.rb
+spec/lib/serialization_method_shared_spec.rb
+spec/public/serializer_spec.rb
+spec/public/to_csv_spec.rb
+spec/public/to_json_spec.rb
+spec/public/to_xml_spec.rb
+spec/public/to_yaml_spec.rb
 spec/spec.opts
 spec/spec_helper.rb
-spec/unit/serializer_spec.rb
-spec/unit/to_csv_spec.rb
-spec/unit/to_json_spec.rb
-spec/unit/to_xml_spec.rb
-spec/unit/to_yaml_spec.rb
+tasks/install.rb
+tasks/spec.rb

data/Rakefile

@@ -1,58 +1,25 @@
-require 'rubygems'
-require 'spec'
-require 'spec/rake/spectask'
 require 'pathname'
+require 'rubygems'
+
+ROOT    = Pathname(__FILE__).dirname.expand_path
+JRUBY   = RUBY_PLATFORM =~ /java/
+WINDOWS = Gem.win_platform?
+SUDO    = (WINDOWS || JRUBY) ? '' : ('sudo' unless ENV['SUDOLESS'])
 
-ROOT = Pathname(__FILE__).dirname.expand_path
 require ROOT + 'lib/dm-serializer/version'
 
-AUTHOR = "Guy van den Berg"
-EMAIL  = "vandenberg.guy@gmail.com"
-GEM_NAME = "dm-serializer"
+AUTHOR = 'Guy van den Berg'
+EMAIL  = 'vandenberg.guy [a] gmail [d] com'
+GEM_NAME = 'dm-serializer'
 GEM_VERSION = DataMapper::Serializer::VERSION
-GEM_DEPENDENCIES = [["dm-core", GEM_VERSION]]
-GEM_CLEAN = ["log", "pkg", "coverage"]
-GEM_EXTRAS = { :has_rdoc => true, :extra_rdoc_files => %w[ README.txt LICENSE TODO ] }
-
-PROJECT_NAME = "datamapper"
-PROJECT_URL  = "http://github.com/sam/dm-more/tree/master/dm-serializer"
-PROJECT_DESCRIPTION = PROJECT_SUMMARY = "DataMapper plugin for serializing DataMapper objects"
-
-require ROOT.parent + 'tasks/hoe'
-
-task :default => [ :spec ]
-
-WIN32 = (RUBY_PLATFORM =~ /win32|mingw|cygwin/) rescue nil
-SUDO  = WIN32 ? '' : ('sudo' unless ENV['SUDOLESS'])
-
-desc "Install #{GEM_NAME} #{GEM_VERSION} (default ruby)"
-task :install => [ :package ] do
-  sh "#{SUDO} gem install --local pkg/#{GEM_NAME}-#{GEM_VERSION} --no-update-sources", :verbose => false
-end
-
-desc "Uninstall #{GEM_NAME} #{GEM_VERSION} (default ruby)"
-task :uninstall => [ :clobber ] do
-  sh "#{SUDO} gem uninstall #{GEM_NAME} -v#{GEM_VERSION} -I -x", :verbose => false
-end
-
-namespace :jruby do
-  desc "Install #{GEM_NAME} #{GEM_VERSION} with JRuby"
-  task :install => [ :package ] do
-    sh %{#{SUDO} jruby -S gem install --local pkg/#{GEM_NAME}-#{GEM_VERSION} --no-update-sources}, :verbose => false
-  end
-end
+GEM_DEPENDENCIES = [['dm-core', "~>#{GEM_VERSION}"]]
+GEM_CLEAN = %w[ log pkg coverage ]
+GEM_EXTRAS = { :has_rdoc => true, :extra_rdoc_files => %w[ README.txt LICENSE TODO History.txt ] }
 
-desc 'Run specifications'
-Spec::Rake::SpecTask.new(:spec) do |t|
-  t.spec_opts << '--options' << 'spec/spec.opts' if File.exists?('spec/spec.opts')
-  t.spec_files = Pathname.glob((ROOT + 'spec/**/*_spec.rb').to_s)
+PROJECT_NAME = 'datamapper'
+PROJECT_URL  = "http://github.com/sam/dm-more/tree/master/#{GEM_NAME}"
+PROJECT_DESCRIPTION = PROJECT_SUMMARY = 'DataMapper plugin for serializing DataMapper objects'
 
-  begin
-    t.rcov = ENV.has_key?('NO_RCOV') ? ENV['NO_RCOV'] != 'true' : true
-    t.rcov_opts << '--exclude' << 'spec'
-    t.rcov_opts << '--text-summary'
-    t.rcov_opts << '--sort' << 'coverage' << '--sort-reverse'
-  rescue Exception
-    # rcov not installed
-  end
+[ ROOT, ROOT.parent ].each do |dir|
+  Pathname.glob(dir.join('tasks/**/*.rb').to_s).each { |f| require f }
 end

data/TODO

@@ -1,8 +0,0 @@
-TODO
-====
-
-
-
----
-TODO tickets may also be found in the DataMapper Issue Tracker:
-http://wm.lighthouseapp.com/projects/4819-datamapper/overview

data/lib/dm-serializer.rb

@@ -1,36 +1,31 @@
-require Pathname('rexml/document')
+require 'rexml/document'
 
 begin
+  gem('fastercsv')
   require 'faster_csv'
 rescue LoadError
   nil
 end
 
 begin
-  require Pathname('json/ext')
+  gem('json')
+  require 'json/ext'
 rescue LoadError
-  require Pathname('json/pure')
+  gem('json_pure')
+  require 'json/pure'
 end
 
 module DataMapper
   module Serialize
-
     # Serialize a Resource to JavaScript Object Notation (JSON; RFC 4627)
     #
     # @return <String> a JSON representation of the Resource
-    def to_json(options = {})
+    def to_json(*args)
+      options = args.first || {}
       result = '{ '
       fields = []
 
-      # FIXME: this should go into bunch of protected methods shared with other serialization methods
-      only_properties     = Array(options[:only])
-      excluded_properties = Array(options[:exclude])
-      exclude_read_only   = options[:without_read_only_attributes] || false
-
-      propset = self.class.properties(repository.name).reject do |p|
-        next if only_properties.include? p.name
-        excluded_properties.include?(p.name) || !(only_properties.empty? || only_properties.include?(p.name))
-      end
+      propset = properties_to_serialize(options)
 
       fields += propset.map do |property|
         "#{property.name.to_json}: #{send(property.getter).to_json}"
@@ -96,10 +91,17 @@ module DataMapper
     def to_yaml(opts = {})
       YAML::quick_emit(object_id,opts) do |out|
         out.map(nil,to_yaml_style) do |map|
-          self.class.properties(repository.name).each do |property|
+          propset = properties_to_serialize(opts)
+          propset.each do |property|
             value = send(property.name.to_sym)
             map.add(property.name, value.is_a?(Class) ? value.to_s : value)
           end
+          # add methods
+          (opts[:methods] || []).each do |meth|
+            if self.respond_to?(meth)
+              map.add(meth.to_sym, send(meth))
+            end
+          end
           (instance_variable_get("@yaml_addes") || []).each do |k,v|
             map.add(k.to_s,v)
           end
@@ -109,12 +111,31 @@ module DataMapper
 
     protected
 
+    # Returns propreties to serialize based on :only or :exclude arrays, if provided
+    # :only takes precendence over :exclude
+    #
+    # @return <Array> properties that need to be serialized
+    def properties_to_serialize(options)
+      only_properties     = Array(options[:only])
+      excluded_properties = Array(options[:exclude])
+      exclude_read_only   = options[:without_read_only_attributes] || false
+
+      self.class.properties(repository.name).reject do |p|
+        if only_properties.include? p.name
+          false
+        else
+          excluded_properties.include?(p.name) || !(only_properties.empty? || only_properties.include?(p.name))
+        end
+      end
+    end
+
+
     # Return the name of this Resource - to be used as the root element name.
     # This can be overloaded.
     #
     # @return <String> name of this Resource
     def xml_element_name
-      Extlib::Inflection.underscore(self.class.name)
+      Extlib::Inflection.underscore(self.class.name).tr("/", "-")
     end
 
     # Return a REXML::Document representing this Resource
@@ -126,7 +147,8 @@ module DataMapper
 
       #TODO old code base was converting single quote to double quote on attribs
 
-      self.class.properties(repository.name).each do |property|
+      propset = properties_to_serialize(opts)
+      propset.each do |property|
           value = send(property.name)
           node = root.add_element(property.name.to_s)
           unless property.type == String
@@ -134,6 +156,16 @@ module DataMapper
           end
           node << REXML::Text.new(value.to_s) unless value.nil?
       end
+
+      # add methods
+      (opts[:methods] || []).each do |meth|
+        if self.respond_to?(meth)
+          xml_name = meth.to_s.gsub(/[^a-z0-9_]/, '')
+          node = root.add_element(xml_name)
+          value = send(meth)
+          node << REXML::Text.new(value.to_s, :raw => true) unless value.nil?
+        end
+      end
       doc
     end
 
@@ -143,12 +175,27 @@ module DataMapper
     include Serialize
   end # module Resource
 
+  # the json gem adds Object#to_json, which breaks the DM proxies, since it
+  # happens *after* the proxy has been blank slated. This code removes the added
+  # method, so it is delegated correctly to the Collection
+  [
+    Associations::OneToMany::Proxy,
+    (Associations::ManyToOne::Proxy if defined?(Associations::ManyToOne::Proxy)),
+    Associations::ManyToMany::Proxy
+  ].each do |proxy|
+    [:to_json].each do |method|
+      proxy.send(:undef_method, :to_json) rescue nil
+    end
+  end
+
   class Collection
     def to_yaml(opts = {})
-      to_a.to_yaml(opts)
+      # FIXME: Don't double handle the YAML (remove the YAML.load)
+      to_a.collect {|x| YAML.load(x.to_yaml(opts)) }.to_yaml
     end
 
-    def to_json(opts = {})
+    def to_json(*args)
+      opts = args.first || {}
       "[" << map {|e| e.to_json(opts)}.join(",") << "]"
     end
 
@@ -166,7 +213,7 @@ module DataMapper
 
     protected
     def xml_element_name
-      Extlib::Inflection.tableize(self.model.to_s)
+      Extlib::Inflection.pluralize(Extlib::Inflection.underscore(self.model.to_s)).tr("/", "-")
     end
 
     def to_xml_document(opts={})

data/lib/dm-serializer/version.rb

@@ -1,5 +1,5 @@
 module DataMapper
   module Serializer
-    VERSION = "0.9.7"
+    VERSION = '0.9.8'
   end
 end

data/spec/fixtures/cow.rb

@@ -6,6 +6,9 @@ class Cow
   property :name,      String
   property :breed,     String
 
+  has n, :baby_cows, :class_name => 'Cow'
+  belongs_to :mother_cow, :class_name => 'Cow'
+
   def serialize_properties
     {:extra => "Extra", :another => 42}
   end

data/spec/fixtures/planet.rb

@@ -4,6 +4,11 @@ class Planet
   property :name, String, :key => true
   property :aphelion, Float
 
+  # 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'
+
   def category
     case self.name.downcase
     when "mercury", "venus", "earth", "mars" then "terrestrial"
@@ -16,3 +21,13 @@ class Planet
     self.name.downcase == "earth"
   end
 end
+
+class FriendedPlanet
+  include DataMapper::Resource
+
+  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]
+end

data/spec/fixtures/quan_tum_cat.rb

@@ -0,0 +1,15 @@
+# Yes, this crazy capitalization is intentional,
+# to test xml root element name generation
+module QuanTum
+  class Cat
+    include DataMapper::Resource
+
+    property :id, Serial
+    property :name, String
+    property :location, String
+
+    repository(:alternate) do
+      property :is_dead, Boolean
+    end
+  end
+end

data/spec/lib/serialization_method_shared_spec.rb

@@ -0,0 +1,193 @@
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+
+share_examples_for 'A serialization method' do
+  before(:all) do
+    %w[ @harness ].each do |ivar|
+      raise "+#{ivar}+ should be defined in before block" unless instance_variable_get(ivar)
+    end
+
+    DataMapper.auto_migrate!
+  end
+
+  before(:each) do
+    Cow.all.destroy!
+    Planet.all.destroy!
+    FriendedPlanet.all.destroy!
+  end
+
+  describe '(serializing single resources)' do
+    it 'should serialize Model.first' do
+      # At the moment this is implied by serializing a resource, but this
+      # test ensures the contract even if dm-core changes
+      Cow.create(
+        :id        => 89,
+        :composite => 34,
+        :name      => 'Berta',
+        :breed     => 'Guernsey'
+      )
+      result = @harness.test(Cow.first)
+      result.values_at("name", "breed").should == ["Berta", "Guernsey"]
+    end
+
+    it 'should serialize a resource' do
+      cow = Cow.new(
+        :id        => 89,
+        :composite => 34,
+        :name      => 'Berta',
+        :breed     => 'Guernsey'
+      )
+
+      result = @harness.test(cow)
+      result.values_at("id", "composite", "name", "breed").should == [89,  34, 'Berta', 'Guernsey']
+    end
+
+    it 'should exclude nil properties' do
+      cow = Cow.new(
+        :id        => 89,
+        :name      => nil
+      )
+
+      result = @harness.test(cow)
+      result.values_at("id", "composite").should == [89,  nil]
+    end
+
+    it "should only includes properties given to :only option" do
+      planet = Planet.new(
+        :name     => "Mars",
+        :aphelion => 249_209_300.4
+      )
+
+      result = @harness.test(planet, :only => [:name])
+      result.values_at("name", "aphelion").should == ["Mars", nil]
+    end
+
+    it "should serialize values returned by methods given to :methods option" do
+      planet = Planet.new(
+        :name     => "Mars",
+        :aphelion => 249_209_300.4
+      )
+
+      result = @harness.test(planet, :methods => [:category, :has_known_form_of_life?])
+      # XML currently can't serialize ? at the end of method names
+      boolean_method_name = @harness.method_name == :to_xml ? "has_known_form_of_life" : "has_known_form_of_life?"
+      result.values_at("category", boolean_method_name).should == ["terrestrial", false]
+    end
+
+    it "should only include properties given to :only option" do
+      planet = Planet.new(
+        :name     => "Mars",
+        :aphelion => 249_209_300.4
+      )
+
+      result = @harness.test(planet, :only => [:name])
+      result.values_at("name", "aphelion").should == ["Mars", nil]
+    end
+
+    it "should exclude properties given to :exclude option" do
+      planet = Planet.new(
+        :name     => "Mars",
+        :aphelion => 249_209_300.4
+      )
+
+      result = @harness.test(planet, :exclude => [:aphelion])
+      result.values_at("name", "aphelion").should == ["Mars", nil]
+    end
+
+    it "should give higher precendence to :only option over :exclude" do
+      planet = Planet.new(
+        :name     => "Mars",
+        :aphelion => 249_209_300.4
+      )
+
+      result = @harness.test(planet, :only => [:name], :exclude => [:name])
+      result.values_at("name", "aphelion").should == ["Mars", nil]
+    end
+  end
+
+  describe "(collections and proxies)" do
+    it 'should serialize Model.all' do
+      # At the moment this is implied by serializing a collection, but this
+      # test ensures the contract even if dm-core changes
+      Cow.create(
+        :id        => 89,
+        :composite => 34,
+        :name      => 'Berta',
+        :breed     => 'Guernsey'
+      )
+      result = @harness.test(Cow.all)
+      result[0].values_at("name", "breed").should == ["Berta", "Guernsey"]
+    end
+
+    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
+
+      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']
+    end
+
+    it 'should serialize an empty collection' do
+      query = DataMapper::Query.new(DataMapper::repository(:default), Cow)
+      collection = DataMapper::Collection.new(query) {}
+
+      result = @harness.test(collection)
+      result.should be_empty
+    end
+
+    it "serializes a one to many relationship" do
+      parent = Cow.new(:id => 1, :composite => 322, :name => "Harry", :breed => "Angus")
+      baby = Cow.new(:mother_cow => parent, :id => 2, :composite => 321, :name => "Felix", :breed => "Angus")
+
+      parent.save
+      baby.save
+
+      result = @harness.test(parent.baby_cows)
+      result.should be_kind_of(Array)
+
+      result[0].values_at(*%w{id composite name breed}).should == [2, 321, "Felix", "Angus"]
+    end
+
+    it "serializes a many to one relationship" do
+      parent = Cow.new(:id => 1, :composite => 322, :name => "Harry", :breed => "Angus")
+      baby = Cow.new(:mother_cow => parent, :id => 2, :composite => 321, :name => "Felix", :breed => "Angus")
+
+      parent.save
+      baby.save
+
+      result = @harness.test(baby.mother_cow)
+      result.should be_kind_of(Hash)
+      result.values_at(*%w{id composite name breed}).should == [1, 322, "Harry", "Angus"]
+    end
+
+    it "serializes a many to many relationship" do
+      p1 = Planet.create(:name => 'earth')
+      p2 = Planet.create(:name => 'mars')
+
+      FriendedPlanet.create(:planet => p1, :friend_planet => p2)
+
+      result = @harness.test(p1.reload.friend_planets)
+      result.should be_kind_of(Array)
+
+      result[0]["name"].should == "mars"
+    end
+  end
+
+  describe "(multiple repositories)" do
+    before(:all) do
+      QuanTum::Cat.auto_migrate!
+      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)}
+      @harness.test(gerry )['is_dead'].should be(nil)
+      @harness.test(george)['is_dead'].should be(false)
+    end
+  end
+end

data/spec/{unit → public}/to_csv_spec.rb

@@ -23,24 +23,24 @@ describe DataMapper::Serialize, '#to_csv' do
     peter.composite = 344
     peter.name = 'Peter'
     peter.breed = 'Long Horn'
-    peter.to_csv.chomp.should == '44,344,Peter,Long Horn'
+    peter.to_csv.chomp.split(',')[0..3].should == ['44','344','Peter','Long Horn']
   end
 
   it "should serialize a collection to CSV" do
-    @collection.to_csv.gsub(/[[:space:]]+\n/, "\n").should ==
-      "1,2,Betsy,Jersey\n" +
-      "10,20,Berta,Guernsey\n"
+    result = @collection.to_csv.gsub(/[[:space:]]+\n/, "\n")
+    result.to_a[0].split(',')[0..3].should == ['1','2','Betsy','Jersey']
+    result.to_a[1].split(',')[0..3].should == ['10','20','Berta','Guernsey']
   end
 
   describe "multiple repositories" do
     before(:all) do
-      QuantumCat.auto_migrate!
-      repository(:alternate){QuantumCat.auto_migrate!}
+      QuanTum::Cat.auto_migrate!
+      repository(:alternate){QuanTum::Cat.auto_migrate!}
     end
 
     it "should use the repsoitory for the model" do
-      gerry = QuantumCat.create(:name => "gerry")
-      george = repository(:alternate){QuantumCat.create(:name => "george", :is_dead => false)}
+      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/)
     end

data/spec/public/to_json_spec.rb

@@ -0,0 +1,94 @@
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+
+describe DataMapper::Serialize, '#to_json' do
+  #
+  # ==== ajaxy JSON
+  #
+
+  before(:all) do
+    DataMapper.auto_migrate!
+    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
+
+    @harness = Class.new(SerializerTestHarness) do
+      def method_name
+        :to_json
+      end
+
+      protected
+
+      def deserialize(result)
+        JSON.parse(result)
+      end
+    end.new
+  end
+
+  it_should_behave_like "A serialization method"
+
+  it "should serialize an array of collections" do
+    deserialized_collection = JSON.parse([@collection].to_json).first
+    betsy = deserialized_collection.first
+    berta = deserialized_collection.last
+
+    betsy["id"].should        == 1
+    betsy["composite"].should == 2
+    betsy["name"].should      == "Betsy"
+    betsy["breed"].should     == "Jersey"
+
+    berta["id"].should        == 10
+    berta["composite"].should == 20
+    berta["name"].should      == "Berta"
+    berta["breed"].should     == "Guernsey"
+  end
+
+  it "should serialize an array of extended objects" do
+    deserialized_collection = JSON.parse(@collection.to_a.to_json)
+    betsy = deserialized_collection.first
+    berta = deserialized_collection.last
+
+    betsy["id"].should        == 1
+    betsy["composite"].should == 2
+    betsy["name"].should      == "Betsy"
+    betsy["breed"].should     == "Jersey"
+
+    berta["id"].should        == 10
+    berta["composite"].should == 20
+    berta["name"].should      == "Berta"
+    berta["breed"].should     == "Guernsey"
+  end
+
+  it "handles extra properties" do
+    deserialized_hash = JSON.parse(Cow.new(:id => 1, :name => "Harry", :breed => "Angus").to_json)
+
+    deserialized_hash["extra"].should == "Extra"
+    deserialized_hash["another"].should == 42
+  end
+
+  it "handles options given to a collection properly" do
+    deserialized_collection = JSON.parse(@collection.to_json(:only => [:composite]))
+    betsy = deserialized_collection.first
+    berta = deserialized_collection.last
+
+    betsy["id"].should be_nil
+    betsy["composite"].should == 2
+    betsy["name"].should be_nil
+    betsy["breed"].should be_nil
+
+    berta["id"].should be_nil
+    berta["composite"].should == 20
+    berta["name"].should be_nil
+    berta["breed"].should be_nil
+  end
+
+  it "supports :include option for one level depth"
+
+  it "supports :include option for more than one level depth"
+
+  it "has :repository option to override used repository"
+
+end

data/spec/public/to_xml_spec.rb

@@ -0,0 +1,89 @@
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+
+describe DataMapper::Serialize, '#to_xml' do
+  #
+  # ==== enterprisey XML
+  #
+
+  before(:all) do
+    @harness = Class.new(SerializerTestHarness) do
+      def method_name
+        :to_xml
+      end
+
+      protected
+
+      def deserialize(result)
+        doc = REXML::Document.new(result)
+        root = doc.elements[1]
+        if root.attributes["type"] == "array"
+          root.elements.collect do |element|
+            a = {}
+            element.elements.each do |v|
+              a.update(v.name => cast(v.text, v.attributes["type"]))
+            end
+            a
+          end
+        else
+          a = {}
+          root.elements.each do |v|
+            a.update(v.name => cast(v.text, v.attributes["type"]))
+          end
+          a
+        end
+      end
+
+      def cast(value, type)
+        boolean_conversions = {"true" => true, "false" => false}
+        value = boolean_conversions[value] if boolean_conversions.has_key?(value)
+        value = value.to_i if value && type == "integer"
+        value
+      end
+    end.new
+  end
+
+  it_should_behave_like "A serialization method"
+
+  describe 'Resource#xml_element_name' do
+    it 'should return the class name underscored and with slashes replaced with dashes' do
+      QuanTum::Cat.new.send(:xml_element_name).should == 'quan_tum-cat'
+    end
+
+    it 'should be used as the root node name by #to_xml' do
+      planet = Planet.new
+      class << planet
+        def xml_element_name
+          "aplanet"
+        end
+      end
+
+      xml = planet.to_xml
+      REXML::Document.new(xml).elements[1].name.should == "aplanet"
+    end
+  end
+
+  describe 'Collection#xml_element_name' do
+    before(:each) do
+      query = DataMapper::Query.new(DataMapper::repository(:default), QuanTum::Cat)
+      @collection = DataMapper::Collection.new(query) {}
+    end
+
+    it 'should return the class name tableized and with slashes replaced with dashes' do
+      @collection.send(:xml_element_name).should == 'quan_tum-cats'
+    end
+
+    it 'should be used as the root node name by #to_xml' do
+      planet = Planet.new
+      @collection.load([1])
+      class << @collection
+        def xml_element_name
+          "somanycats"
+        end
+      end
+
+      xml = @collection.to_xml
+      REXML::Document.new(xml).elements[1].name.should == "somanycats"
+    end
+  end
+end

data/spec/public/to_yaml_spec.rb

@@ -0,0 +1,32 @@
+require 'pathname'
+require 'yaml'
+require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+
+describe DataMapper::Serialize, '#to_yaml' do
+  #
+  # ==== yummy YAML
+  #
+
+  before(:all) do
+    @harness = Class.new(SerializerTestHarness) do
+      def method_name
+        :to_yaml
+      end
+
+      protected
+
+      def deserialize(result)
+        stringify_keys = lambda {|hash| hash.inject({}) {|a, (key, value)| a.update(key.to_s => value) }}
+        result = YAML.load(result)
+        if result.is_a?(Array)
+          result.collect(&stringify_keys)
+        else
+          stringify_keys[result]
+        end
+      end
+    end.new
+  end
+
+  it_should_behave_like "A serialization method"
+
+end

data/spec/spec.opts

@@ -1,2 +1 @@
---format specdoc
 --colour

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
-require 'rubygems'
 require 'pathname'
+require 'rubygems'
 
-gem 'dm-core', '~>0.9.7'
+gem 'dm-core', '~>0.9.8'
 require 'dm-core'
 
 spec_dir_path = Pathname(__FILE__).dirname.expand_path
@@ -10,17 +10,13 @@ require spec_dir_path.parent + 'lib/dm-serializer'
 def load_driver(name, default_uri)
   return false if ENV['ADAPTER'] != name.to_s
 
-  lib = "do_#{name}"
-
   begin
-    gem lib, '~>0.9.7'
-    require lib
     DataMapper.setup(name, ENV["#{name.to_s.upcase}_SPEC_URI"] || default_uri)
     DataMapper::Repository.adapters[:default] =  DataMapper::Repository.adapters[name]
     DataMapper::Repository.adapters[:alternate] = DataMapper::Repository.adapters[name]
     true
-  rescue Gem::LoadError => e
-    warn "Could not load #{lib}: #{e}"
+  rescue LoadError => e
+    warn "Could not load do_#{name}: #{e}"
     false
   end
 end
@@ -31,6 +27,13 @@ HAS_SQLITE3  = load_driver(:sqlite3,  'sqlite3::memory:')
 HAS_MYSQL    = load_driver(:mysql,    'mysql://localhost/dm_core_test')
 HAS_POSTGRES = load_driver(:postgres, 'postgres://postgres@localhost/dm_core_test')
 
+class SerializerTestHarness
+  def test(object, *args)
+    deserialize(object.send(method_name, *args))
+  end
+end
+
+require spec_dir_path + 'lib/serialization_method_shared_spec'
 
 # require fixture resources
 Dir[spec_dir_path + "fixtures/*.rb"].each do |fixture_file|

data/tasks/install.rb

@@ -0,0 +1,13 @@
+def sudo_gem(cmd)
+  sh "#{SUDO} #{RUBY} -S gem #{cmd}", :verbose => false
+end
+
+desc "Install #{GEM_NAME} #{GEM_VERSION}"
+task :install => [ :package ] do
+  sudo_gem "install --local pkg/#{GEM_NAME}-#{GEM_VERSION} --no-update-sources"
+end
+
+desc "Uninstall #{GEM_NAME} #{GEM_VERSION}"
+task :uninstall => [ :clobber ] do
+  sudo_gem "uninstall #{GEM_NAME} -v#{GEM_VERSION} -Ix"
+end

data/tasks/spec.rb

@@ -0,0 +1,25 @@
+begin
+  gem 'rspec', '~>1.1.11'
+  require 'spec'
+  require 'spec/rake/spectask'
+
+  task :default => [ :spec ]
+
+  desc 'Run specifications'
+  Spec::Rake::SpecTask.new(:spec) do |t|
+    t.spec_opts << '--options' << 'spec/spec.opts' if File.exists?('spec/spec.opts')
+    t.spec_files = Pathname.glob((ROOT + 'spec/**/*_spec.rb').to_s)
+
+    begin
+      gem 'rcov', '~>0.8'
+      t.rcov = JRUBY ? false : (ENV.has_key?('NO_RCOV') ? ENV['NO_RCOV'] != 'true' : true)
+      t.rcov_opts << '--exclude' << 'spec'
+      t.rcov_opts << '--text-summary'
+      t.rcov_opts << '--sort' << 'coverage' << '--sort-reverse'
+    rescue LoadError
+      # rcov not installed
+    end
+  end
+rescue LoadError
+  # rspec not installed
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dm-serializer
 version: !ruby/object:Gem::Version 
-  version: 0.9.7
+  version: 0.9.8
 platform: ruby
 authors: 
 - Guy van den Berg
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-18 00:00:00 -08:00
+date: 2008-12-07 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -18,23 +18,13 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: 0.9.7
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.8.2
+        version: 0.9.8
     version: 
 description: DataMapper plugin for serializing DataMapper objects
 email: 
-- vandenberg.guy@gmail.com
+- vandenberg.guy [a] gmail [d] com
 executables: []
 
 extensions: []
@@ -43,6 +33,7 @@ extra_rdoc_files:
 - README.txt
 - LICENSE
 - TODO
+- History.txt
 files: 
 - History.txt
 - LICENSE
@@ -56,14 +47,17 @@ files:
 - lib/dm-serializer/version.rb
 - spec/fixtures/cow.rb
 - spec/fixtures/planet.rb
-- spec/fixtures/quatum_cat.rb
+- spec/fixtures/quan_tum_cat.rb
+- spec/lib/serialization_method_shared_spec.rb
+- spec/public/serializer_spec.rb
+- spec/public/to_csv_spec.rb
+- spec/public/to_json_spec.rb
+- spec/public/to_xml_spec.rb
+- spec/public/to_yaml_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
-- spec/unit/serializer_spec.rb
-- spec/unit/to_csv_spec.rb
-- spec/unit/to_json_spec.rb
-- spec/unit/to_xml_spec.rb
-- spec/unit/to_yaml_spec.rb
+- tasks/install.rb
+- tasks/spec.rb
 has_rdoc: true
 homepage: http://github.com/sam/dm-more/tree/master/dm-serializer
 post_install_message: 

data/spec/fixtures/quatum_cat.rb

@@ -1,11 +0,0 @@
-class QuantumCat
-  include DataMapper::Resource
-
-  property :id, Serial
-  property :name, String
-  property :location, String
-
-  repository(:alternate) do
-    property :is_dead, Boolean
-  end
-end

data/spec/unit/to_json_spec.rb

@@ -1,130 +0,0 @@
-require 'pathname'
-require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
-
-describe DataMapper::Serialize, '#to_json' do
-  #
-  # ==== ajaxy JSON
-  #
-
-  before(:all) 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
-
-    @empty_collection = DataMapper::Collection.new(query) {}
-  end
-
-  it "serializes resource to JSON" do
-    deserialized_hash = JSON.parse(Cow.new(:id => 1, :composite => 322, :name => "Harry", :breed => "Angus").to_json)
-
-    deserialized_hash["id"].should        == 1
-    deserialized_hash["composite"].should == 322
-    deserialized_hash["name"].should      == "Harry"
-    deserialized_hash["breed"].should     == "Angus"
-  end
-
-  it "excludes nil attributes" do
-    deserialized_hash = JSON.parse(Cow.new(:id => 1, :name => "Harry", :breed => "Angus").to_json)
-
-    deserialized_hash["id"].should        == 1
-    deserialized_hash["composite"].should be(nil)
-    deserialized_hash["name"].should      == "Harry"
-    deserialized_hash["breed"].should     == "Angus"
-  end
-
-  it "serializes collections to JSON by serializing each member" do
-    deserialized_collection = JSON.parse(@collection.to_json)
-    betsy = deserialized_collection.first
-    berta = deserialized_collection.last
-
-    betsy["id"].should        == 1
-    betsy["composite"].should == 2
-    betsy["name"].should      == "Betsy"
-    betsy["breed"].should     == "Jersey"
-
-    berta["id"].should        == 10
-    berta["composite"].should == 20
-    berta["name"].should      == "Berta"
-    berta["breed"].should     == "Guernsey"
-  end
-
-  it "handles extra properties" do
-    deserialized_hash = JSON.parse(Cow.new(:id => 1, :name => "Harry", :breed => "Angus").to_json)
-
-    deserialized_hash["extra"].should == "Extra"
-    deserialized_hash["another"].should == 42
-  end
-
-  it "handles empty collections just fine" do
-    deserialized_collection = JSON.parse(@empty_collection.to_json)
-    deserialized_collection.should be_empty
-  end
-
-  it "handles options given to a collection properly" do
-    deserialized_collection = JSON.parse(@collection.to_json(:only => [:composite]))
-    betsy = deserialized_collection.first
-    berta = deserialized_collection.last
-
-    betsy["id"].should be_nil
-    betsy["composite"].should == 2
-    betsy["name"].should be_nil
-    betsy["breed"].should be_nil
-
-    berta["id"].should be_nil
-    berta["composite"].should == 20
-    berta["name"].should be_nil
-    berta["breed"].should be_nil
-  end
-
-  it "serializes values returned by methods given to :methods option" do
-    deserialized_hash = JSON.parse(Planet.new(:name => "Mars", :aphelion => 249_209_300.4).to_json(:methods => [:category, :has_known_form_of_life?]))
-
-    deserialized_hash["category"].should == "terrestrial"
-    deserialized_hash["has_known_form_of_life?"].should be(false)
-  end
-
-  it "only includes properties given to :only option" do
-    deserialized_hash = JSON.parse(Planet.new(:name => "Mars", :aphelion => 249_209_300.4).to_json(:only => [:name]))
-
-    deserialized_hash["name"].should == "Mars"
-    deserialized_hash["aphelion"].should be(nil)
-  end
-
-  it "only includes properties given to :only option" do
-    deserialized_hash = JSON.parse(Planet.new(:name => "Mars", :aphelion => 249_209_300.4).to_json(:exclude => [:aphelion]))
-
-    deserialized_hash["name"].should == "Mars"
-    deserialized_hash["aphelion"].should be(nil)
-  end
-
-  it "has higher presedence for :only option" do
-    deserialized_hash = JSON.parse(Planet.new(:name => "Mars", :aphelion => 249_209_300.4).to_json(:only => [:aphelion], :exclude => [:aphelion]))
-
-    deserialized_hash["name"].should be(nil)
-    deserialized_hash["aphelion"].should == 249_209_300.4
-  end
-
-  describe "multiple repositories" do
-    before(:all) do
-      QuantumCat.auto_migrate!
-      repository(:alternate){QuantumCat.auto_migrate!}
-    end
-
-    it "should use the repsoitory for the model" do
-      gerry = QuantumCat.create(:name => "gerry")
-      george = repository(:alternate){QuantumCat.create(:name => "george", :is_dead => false)}
-      gerry.to_json.should_not match(/is_dead/)
-      george.to_json.should match(/is_dead/)
-    end
-  end
-
-  it "supports :include option for one level depth"
-
-  it "supports :include option for more than one level depth"
-
-  it "has :repository option to override used repository"
-
-end

data/spec/unit/to_xml_spec.rb

@@ -1,73 +0,0 @@
-require 'pathname'
-require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
-
-describe DataMapper::Serialize, '#to_xml' do
-  #
-  # ==== enterprisey XML
-  #
-
-  before(:all) do
-    query = DataMapper::Query.new(DataMapper::repository(:default), Cow)
-
-    @time = DateTime.now
-
-
-    @collection = DataMapper::Collection.new(query) do |c|
-      c.load([1, 2, 'Betsy', 'Jersey'])
-      c.load([10, 20, 'Berta', 'Guernsey'])
-    end
-
-    @empty_collection = DataMapper::Collection.new(query) {}
-  end
-
-  it "should serialize a resource to XML" do
-    berta = Cow.new
-    berta.id = 89
-    berta.composite = 34
-    berta.name = 'Berta'
-    berta.breed = 'Guernsey'
-
-    berta.to_xml.should == <<-EOS.compress_lines(false)
-    <cow>
-      <id type='integer'>89</id>
-      <composite type='integer'>34</composite>
-      <name>Berta</name>
-      <breed>Guernsey</breed>
-    </cow>
-  EOS
-  end
-
-  it "should serialize a collection to XML" do
-    @collection.to_xml.should == <<-EOS.compress_lines(false)
-      <#{Extlib::Inflection.tableize("Cow")} type='array'>
-        <cow>
-          <id type='integer'>1</id>
-          <composite type='integer'>2</composite>
-          <name>Betsy</name>
-          <breed>Jersey</breed>
-        </cow>
-        <cow>
-          <id type='integer'>10</id>
-          <composite type='integer'>20</composite>
-          <name>Berta</name>
-          <breed>Guernsey</breed>
-        </cow>
-      </#{Extlib::Inflection.tableize("Cow")}>
-  EOS
-  end
-
-  describe "multiple repositories" do
-    before(:all) do
-      QuantumCat.auto_migrate!
-      repository(:alternate){QuantumCat.auto_migrate!}
-    end
-
-    it "should use the repsoitory for the model" do
-      gerry = QuantumCat.create(:name => "gerry")
-      george = repository(:alternate){QuantumCat.create(:name => "george", :is_dead => false)}
-      gerry.to_xml.should_not match(/is_dead/)
-      george.to_xml.should match(/is_dead/)
-    end
-  end
-
-end

data/spec/unit/to_yaml_spec.rb

@@ -1,76 +0,0 @@
-require 'pathname'
-require 'yaml'
-require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
-
-describe DataMapper::Serialize, '#to_yaml' do
-  #
-  # ==== yummy YAML
-  #
-
-  before(:all) 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
-
-    @empty_collection = DataMapper::Collection.new(query) {}
-  end
-
-  it "serializes single resource to YAML" do
-    betsy = Cow.new(:id => 230, :composite => 22, :name => "Betsy", :breed => "Jersey")
-    deserialized_hash = YAML.load(betsy.to_yaml)
-
-    deserialized_hash[:id].should        == 230
-    deserialized_hash[:name].should      == "Betsy"
-    deserialized_hash[:composite].should == 22
-    deserialized_hash[:breed].should     == "Jersey"
-  end
-
-  it "leaves out nil properties" do
-    betsy = Cow.new(:id => 230, :name => "Betsy", :breed => "Jersey")
-    deserialized_hash = YAML.load(betsy.to_yaml)
-
-    deserialized_hash[:id].should        == 230
-    deserialized_hash[:name].should      == "Betsy"
-    deserialized_hash[:composite].should be(nil)
-    deserialized_hash[:breed].should     == "Jersey"
-  end
-
-  it "serializes a collection to YAML" do
-    deserialized_collection = YAML.load(@collection.to_yaml)
-
-    betsy = deserialized_collection.first
-    berta = deserialized_collection.last
-
-    betsy[:id].should        == 1
-    betsy[:name].should      == "Betsy"
-    betsy[:composite].should == 2
-    betsy[:breed].should     == "Jersey"
-
-    berta[:id].should        == 10
-    berta[:name].should      == "Berta"
-    berta[:composite].should == 20
-    berta[:breed].should     == "Guernsey"
-  end
-
-  it "handles empty collections just fine" do
-    YAML.load(@empty_collection.to_yaml).should be_empty
-  end
-
-  describe "multiple repositories" do
-    before(:all) do
-      QuantumCat.auto_migrate!
-      repository(:alternate){QuantumCat.auto_migrate!}
-    end
-
-    it "should use the repsoitory for the model" do
-      gerry = QuantumCat.create(:name => "gerry")
-      george = repository(:alternate){QuantumCat.create(:name => "george", :is_dead => false)}
-      gerry.to_yaml.should_not match(/is_dead/)
-      george.to_yaml.should match(/is_dead/)
-    end
-  end
-
-end