dm-serializer 0.9.11 → 0.10.0

data/{History.txt → History.rdoc}

@@ -1,4 +1,11 @@
-=== 0.9.11 / 2009-03-29
+=== 0.10.0 / 2009-10-15
+
+  * Support serialization of dm-validation errors collection (#718)
+  * Don't require json gem on ruby 1.9 (#776)
+  * Allow YAML.dump(dm_object) (#792)
+  * Correctly serialize child objects (#829)
+
+=== 0.9.11
 
 * No changes this version
 

data/Manifest.txt

@@ -1,11 +1,12 @@
-History.txt
+History.rdoc
 LICENSE
 Manifest.txt
-README.textile
+README.rdoc
 Rakefile
 TODO
 autotest/discover.rb
 autotest/dmserializer_rspec.rb
+benchmarks/to_json.rb
 benchmarks/to_xml.rb
 lib/dm-serializer.rb
 lib/dm-serializer/common.rb

data/README.rdoc

@@ -0,0 +1,64 @@
+= dm-serializer
+
+== Overview
+
+dm-serializer allows DataMapper models and collections to be serialized to a variety of formats (currently JSON, XML, YAML and CSV).
+
+== How it works
+
+One method is added to each model/collection for each serialization type - <tt>to_json</tt>, <tt>to_xml</tt>, <tt>to_yaml</tt>, and <tt>to_csv</tt>. With the exception of <tt>to_csv</tt>, all of these methods share the same interface. <tt>to_json</tt> will be used for examples. Any method specific behaviour is documented in its own section below.
+
+  require 'dm-serializer'
+
+  class Cow
+    include DataMapper::Resource
+
+    property :id,   Integer, :key => true
+    property :name, String
+
+    def description
+      "A Cow"
+    end
+  end
+
+  cow = Cow.create(
+    :id    => 1,
+    :name  => "Berta"
+  )
+
+  cow.to_json                      # => { "id": 1, "name": "Berta" }
+  cow.to_json(:only    => [:name]) # => { "name": "Berta" }
+  cow.to_json(:exclude => [:id])   # => { "name": "Berta" }
+  cow.to_json(:methods => [:desc]) # => { "id": 1, "name": "Berta", "desc": "A Cow" }
+
+You can include associations by passing the association accessor the <tt>:methods</tt> option.
+
+If you want to only load a particular serialization method, that's cool, you can do that:
+
+  require 'dm-serializer/to_json'
+
+== to_xml
+
+<tt>to_xml</tt> supports some extra options to allow you to override the element names
+
+  cow.to_xml(:element_name => 'bovine') # => <bovine><id>1</id><name>Berta</name></bovine>
+  cows.to_xml(:collection_element_name => 'kine')   # => <kine><bovine><id>1</id><name>Berta</name></bovine></kine>
+
+
+If you would like a nice speed boost (~5x), require <tt>libxml</tt> or <tt>nokogiri</tt> before <tt>dm-serializer</tt>, and that library will be used rather than REXML.
+
+== to_csv
+
+<tt>to_csv</tt> currently doesn't support any options yet. It will in the future. It will not support serializing child associations.
+
+
+== Arrays, Hashes, and other core classes
+
+<tt>dm-serializer</tt> only adds serialization methods to DataMapper objects and collections, however some libraries used (json, yaml) add methods to core classes, such as <tt>Array</tt>. Note that passing <tt>dm-serializer</tt> options (such as <tt>:only</tt>) to these methods is *not supported*.
+
+  Cow.all.to_a.to_yaml(:only => 'name') # WILL NOT WORK
+
+
+== Beware
+
+If you go spelunking through the code you will find other undocumented options. Use at your own risk, I plan on removing or changing these in the near future.

data/Rakefile

@@ -1,5 +1,4 @@
 require 'pathname'
-require 'rubygems'
 
 ROOT    = Pathname(__FILE__).dirname.expand_path
 JRUBY   = RUBY_PLATFORM =~ /java/
@@ -14,10 +13,10 @@ GEM_NAME = 'dm-serializer'
 GEM_VERSION = DataMapper::Serializer::VERSION
 GEM_DEPENDENCIES = [['dm-core', GEM_VERSION]]
 GEM_CLEAN = %w[ log pkg coverage ]
-GEM_EXTRAS = { :has_rdoc => true, :extra_rdoc_files => %w[ README.textile LICENSE TODO History.txt ] }
+GEM_EXTRAS = { :has_rdoc => true, :extra_rdoc_files => %w[ README.rdoc LICENSE TODO History.rdoc ] }
 
 PROJECT_NAME = 'datamapper'
-PROJECT_URL  = "http://github.com/sam/dm-more/tree/master/#{GEM_NAME}"
+PROJECT_URL  = "http://github.com/datamapper/dm-more/tree/master/#{GEM_NAME}"
 PROJECT_DESCRIPTION = PROJECT_SUMMARY = 'DataMapper plugin for serializing DataMapper objects'
 
 [ ROOT, ROOT.parent ].each do |dir|

data/benchmarks/to_json.rb

@@ -0,0 +1,137 @@
+require "rubygems"
+require 'pathname'
+require 'better-benchmark'
+
+gem 'dm-core', '0.10.0'
+require 'dm-core'
+
+spec_dir_path = Pathname(__FILE__).dirname.expand_path
+$LOAD_PATH.unshift(spec_dir_path.parent + 'lib/')
+require 'dm-serializer'
+
+def load_driver(name, default_uri)
+  begin
+    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 LoadError => e
+    warn "Could not load do_#{name}: #{e}"
+    false
+  end
+end
+
+HAS_SQLITE3  = load_driver(:sqlite3,  'sqlite3::memory:')
+
+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_old(*args)
+      options = args.first || {}
+      result = '{ '
+      fields = []
+
+      propset = properties_to_serialize(options)
+
+      fields += propset.map do |property|
+        "#{property.name.to_json}: #{send(property.name).to_json}"
+      end
+
+      # add methods
+      (options[:methods] || []).each do |meth|
+        if self.respond_to?(meth)
+          fields << "#{meth.to_json}: #{send(meth).to_json}"
+        end
+      end
+
+      # Note: if you want to include a whole other model via relation, use :methods
+      # comments.to_json(:relationships=>{:user=>{:include=>[:first_name],:methods=>[:age]}})
+      # add relationships
+      # TODO: This needs tests and also needs to be ported to #to_xml and #to_yaml
+      (options[:relationships] || {}).each do |rel,opts|
+        if self.respond_to?(rel)
+          fields << "#{rel.to_json}: #{send(rel).to_json(opts)}"
+        end
+      end
+
+      result << fields.join(', ')
+      result << ' }'
+      result
+    end
+  end
+
+  class Collection
+    def to_json_old(*args)
+      opts = args.first || {}
+      '[' << map { |e| e.to_json_old(opts) }.join(',') << ']'
+    end
+  end
+end
+
+
+
+
+class Cow
+  include DataMapper::Resource
+
+  property :id,        Integer, :key => true
+  property :composite, Integer, :key => true
+  property :name,      String
+  property :breed,     String
+
+  has n, :baby_cows, :model => 'Cow'
+  belongs_to :mother_cow, :model => 'Cow', :nullable => true
+end
+
+DataMapper.auto_migrate!
+cow = Cow.create(
+  :id        => 89,
+  :composite => 34,
+  :name      => 'Berta',
+  :breed     => 'Guernsey'
+)
+
+10.times do |n|
+  Cow.create(
+    :id         => n*10,
+    :composite  => n,
+    :name       => "Bertha"*n,
+    :breed      => "Mooing#{n}"
+  )
+end
+
+all_cows = Cow.all.reload
+
+puts "Benchmarking single resource serialization."
+puts "Set 1: old method"
+puts "Set 2: new method"
+result = Benchmark.compare_realtime(
+    :iterations => 10,
+    :inner_iterations => 20000,
+    :verbose => true
+) { |iteration|
+  cow.to_json_old
+}.with { |iteration|
+  cow.to_json
+}
+
+Benchmark.report_on result
+
+puts
+
+puts "Benchmarking collection serialization."
+puts "Set 1: old method"
+puts "Set 2: new method"
+result = Benchmark.compare_realtime(
+    :iterations => 10,
+    :inner_iterations => 5000,
+    :verbose => true
+) { |iteration|
+  all_cows.to_json_old
+}.with { |iteration|
+  all_cows.to_json
+}
+
+Benchmark.report_on result

data/benchmarks/to_xml.rb

@@ -1,7 +1,7 @@
 require "rubygems"
 require 'pathname'
 
-gem 'dm-core', '0.9.11'
+gem 'dm-core', '0.10.0'
 require 'dm-core'
 
 spec_dir_path = Pathname(__FILE__).dirname.expand_path
@@ -30,8 +30,8 @@ class Cow
   property :name,      String
   property :breed,     String
 
-  has n, :baby_cows, :class_name => 'Cow'
-  belongs_to :mother_cow, :class_name => 'Cow'
+  has n, :baby_cows, :model => 'Cow'
+  belongs_to :mother_cow, :model => 'Cow'
 end
 
 require "benchwarmer"

data/lib/dm-serializer/common.rb

@@ -8,7 +8,7 @@ module DataMapper
       only_properties     = Array(options[:only])
       excluded_properties = Array(options[:exclude])
 
-      self.class.properties(repository.name).reject do |p|
+      model.properties(repository.name).reject do |p|
         if only_properties.include? p.name
           false
         else
@@ -16,9 +16,13 @@ module DataMapper
         end
       end
     end
-  end
 
-  module Resource
-    include Serialize
+    Model.append_inclusions self
+
+    class Support
+      def self.dm_validations_loaded?
+        DataMapper.const_defined?("Validate")
+      end
+    end
   end
 end

data/lib/dm-serializer/to_csv.rb

@@ -4,11 +4,11 @@ if RUBY_VERSION >= '1.9.0'
  require 'csv'
 else
   begin
-    gem 'fastercsv', '~>1.4.0'
+    gem 'fastercsv', '~>1.5.0'
     require 'fastercsv'
     CSV = FasterCSV
   rescue LoadError
-    nil
+    # do nothing
   end
 end
 
@@ -19,9 +19,8 @@ module DataMapper
     # @return <String> a CSV representation of the Resource
     def to_csv(writer = '')
       CSV.generate(writer) do |csv|
-        row = []
-        self.class.properties(repository.name).each do |property|
-          row << send(property.name).to_s
+        row = model.properties(repository.name).map do |property|
+          send(property.name).to_s
         end
         csv << row
       end
@@ -30,11 +29,33 @@ module DataMapper
 
   class Collection
     def to_csv
-      result = ""
+      result = ''
       each do |item|
         result << item.to_csv + "\n"
       end
       result
     end
   end
+
+  if Serialize::Support.dm_validations_loaded?
+
+    module Validate
+      class ValidationErrors
+        def to_csv(writer = '')
+          CSV.generate(writer) do |csv|
+            errors.each do |key, value|
+              value.each do |error|
+                row = []
+                row << key.to_s
+                row << error.to_s
+                csv << row
+              end
+            end
+          end
+        end
+      end
+    end
+
+  end
+
 end

data/lib/dm-serializer/to_json.rb

@@ -1,12 +1,6 @@
 require 'dm-serializer/common'
 
-begin
-  gem('json')
-  require 'json/ext'
-rescue LoadError
-  gem('json_pure')
-  require 'json/pure'
-end
+require 'json'
 
 module DataMapper
   module Serialize
@@ -15,19 +9,19 @@ module DataMapper
     # @return <String> a JSON representation of the Resource
     def to_json(*args)
       options = args.first || {}
-      result = '{ '
-      fields = []
+
+      result = {}
 
       propset = properties_to_serialize(options)
 
-      fields += propset.map do |property|
-        "#{property.name.to_json}: #{send(property.getter).to_json}"
+      propset.each do |property|
+        result[property.name] = send(property.name)
       end
 
       # add methods
       (options[:methods] || []).each do |meth|
         if self.respond_to?(meth)
-          fields << "#{meth.to_json}: #{send(meth).to_json}"
+          result[meth] = send(meth)
         end
       end
 
@@ -37,16 +31,20 @@ module DataMapper
       # TODO: This needs tests and also needs to be ported to #to_xml and #to_yaml
       (options[:relationships] || {}).each do |rel,opts|
         if self.respond_to?(rel)
-          fields << "#{rel.to_json}: #{send(rel).to_json(opts)}"
+          result[rel] = send(rel).to_json(opts.merge(:to_json => false))
         end
       end
 
-      result << fields.join(', ')
-      result << ' }'
-      result
+      # default to making JSON
+      if options.fetch(:to_json, true)
+        result.to_json
+      else
+        result
+      end
     end
   end
 
+
   module Associations
     # 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
@@ -67,7 +65,28 @@ module DataMapper
   class Collection
     def to_json(*args)
       opts = args.first || {}
-      "[" << map {|e| e.to_json(opts)}.join(",") << "]"
+
+      options = opts.merge(:to_json => false)
+      collection = map { |e| e.to_json(options) }
+
+      # default to making JSON
+      if opts.fetch(:to_json, true)
+        collection.to_json
+      else
+        collection
+      end
     end
   end
+
+  if Serialize::Support.dm_validations_loaded?
+
+    module Validate
+      class ValidationErrors
+        def to_json(*args)
+          errors.to_hash.to_json
+        end
+      end
+    end
+
+  end
 end