dm-serializer 0.9.11 → 0.10.0

data/spec/public/to_json_spec.rb

@@ -1,5 +1,4 @@
-require 'pathname'
-require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+require 'spec_helper'
 
 describe DataMapper::Serialize, '#to_json' do
   #
@@ -10,10 +9,14 @@ describe DataMapper::Serialize, '#to_json' 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
+    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))
 
     @harness = Class.new(SerializerTestHarness) do
       def method_name

data/spec/public/to_xml_spec.rb

@@ -1,5 +1,4 @@
-require 'pathname'
-require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+require 'spec_helper'
 
 {
   'REXML'  => nil,
@@ -27,29 +26,35 @@ require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
         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"]))
+          f = lambda do |element|
+            case element.attributes["type"]
+            when "hash"
+              element.elements.to_a.inject({}) do |a, e|
+                a.update(e.name => f[e])
+              end
+            when "array"
+              element.elements.collect do |e|
+                f[e]
+              end
+            else
+              if element.elements.empty?
+                cast(element.text, element.attributes["type"])
+              else
+                element.elements.to_a.inject({}) do |a, e|
+                  a.update(e.name => f[e])
+                end
               end
-              a
-            end
-          else
-            a = {}
-            root.elements.each do |v|
-              a.update(v.name => cast(v.text, v.attributes["type"]))
             end
-            a
           end
+
+          doc = REXML::Document.new(result)
+          f[doc.elements[1]]
         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 = value.to_i if value && ["integer", "datamapper::types::serial"].include?(type)
           value
         end
       end.new
@@ -62,7 +67,7 @@ require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
     it "should not include the XML prologue, so that the result can be embedded in other XML documents" do
       planet = Planet.new
       xml = planet.to_xml(:element_name => "aplanet")
-      xml.should_not =~ /\A<\?xml/
+      xml.should_not match(/\A<?xml/)
     end
 
     describe ':element_name option for Resource' do
@@ -81,24 +86,27 @@ require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
 
     describe ':collection_element_name for Collection' do
       before(:each) do
-        query = DataMapper::Query.new(DataMapper::repository(:default), QuanTum::Cat)
-        @collection = DataMapper::Collection.new(query) {}
+        @model = QuanTum::Cat
+        @query = DataMapper::Query.new(DataMapper::repository(:default), @model)
+        @collection = DataMapper::Collection.new(@query)
       end
 
       it 'when not specified the class name tableized and with slashes replaced with dashes should be used as the root node name' do
-        xml = @collection.to_xml
+        xml = DataMapper::Collection.new(@query).to_xml
         REXML::Document.new(xml).elements[1].name.should == "quan_tum-cats"
       end
 
       it 'should be used as the root node name by #to_xml' do
-        @collection.load([1])
+        resources = @model.load([ { 'id' => 1 } ], @query)
+        @collection = DataMapper::Collection.new(@query, resources)
 
         xml = @collection.to_xml(:collection_element_name => "somanycats")
         REXML::Document.new(xml).elements[1].name.should == "somanycats"
       end
 
       it 'should respect :element_name for collection elements' do
-        @collection.load([1])
+        resources = @model.load([ { 'id' => 1 } ], @query)
+        @collection = DataMapper::Collection.new(@query, resources)
 
         xml = @collection.to_xml(:collection_element_name => "somanycats", :element_name => 'cat')
         REXML::Document.new(xml).elements[1].elements[1].name.should == "cat"

data/spec/public/to_yaml_spec.rb

@@ -1,6 +1,4 @@
-require 'pathname'
-require 'yaml'
-require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+require 'spec_helper'
 
 describe DataMapper::Serialize, '#to_yaml' do
   #
@@ -13,20 +11,18 @@ describe DataMapper::Serialize, '#to_yaml' do
         :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)
-        (process = lambda {|object|
+        process = lambda {|object|
           if object.is_a?(Array)
             object.collect(&process)
           elsif object.is_a?(Hash)
-            stringify_keys[object]
+            object.inject({}) {|a, (key, value)| a.update(key.to_s => process[value]) }
           else
             object
           end
-        })[result]
+        }
+        process[result]
       end
     end.new
   end
@@ -34,4 +30,26 @@ describe DataMapper::Serialize, '#to_yaml' do
   it_should_behave_like 'A serialization method'
   it_should_behave_like 'A serialization method that also serializes core classes'
 
+  it 'should allow static YAML dumping' do
+    object = Cow.create(
+      :id        => 89,
+      :composite => 34,
+      :name      => 'Berta',
+      :breed     => 'Guernsey'
+    )
+    result = @harness.deserialize(YAML.dump(object))
+    result['name'].should == 'Berta'
+  end
+
+  it 'should allow static YAML dumping of a collection' do
+    object = Cow.create(
+      :id        => 89,
+      :composite => 34,
+      :name      => 'Berta',
+      :breed     => 'Guernsey'
+    )
+    result = @harness.deserialize(YAML.dump(Cow.all))
+    result[0]['name'].should == 'Berta'
+  end
+
 end

data/spec/spec.opts

@@ -1 +1,2 @@
 --colour
+--loadby random

data/spec/spec_helper.rb

@@ -1,11 +1,18 @@
-require 'pathname'
 require 'rubygems'
 
-gem 'dm-core', '0.9.11'
+# use local dm-core if running from a typical dev checkout.
+lib = File.join('..', '..', 'dm-core', 'lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib)
 require 'dm-core'
 
-spec_dir_path = Pathname(__FILE__).dirname.expand_path
-$LOAD_PATH.unshift(spec_dir_path.parent + 'lib/')
+# use local dm-validations if running from dm-more directly
+lib = File.join('..', 'dm-validations', 'lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib)
+require 'dm-validations'
+
+# Support running specs with 'rake spec' and 'spec'
+$LOAD_PATH.unshift('lib') unless $LOAD_PATH.include?('lib')
+
 require 'dm-serializer'
 
 def load_driver(name, default_uri)
@@ -34,9 +41,9 @@ class SerializerTestHarness
   end
 end
 
-require spec_dir_path + 'lib/serialization_method_shared_spec'
+require 'spec/lib/serialization_method_shared_spec'
 
 # require fixture resources
-Dir[(spec_dir_path + "fixtures/*.rb").to_s].each do |fixture_file|
+Dir.glob("spec/fixtures/*.rb").each do |fixture_file|
   require fixture_file
 end

data/tasks/install.rb

@@ -4,7 +4,7 @@ end
 
 desc "Install #{GEM_NAME} #{GEM_VERSION}"
 task :install => [ :package ] do
-  sudo_gem "install --local pkg/#{GEM_NAME}-#{GEM_VERSION} --no-update-sources"
+  sudo_gem "install pkg/#{GEM_NAME}-#{GEM_VERSION} --no-update-sources"
 end
 
 desc "Uninstall #{GEM_NAME} #{GEM_VERSION}"

data/tasks/spec.rb

@@ -1,6 +1,4 @@
 begin
-  gem 'rspec', '~>1.2'
-  require 'spec'
   require 'spec/rake/spectask'
 
   task :default => [ :spec ]
@@ -8,16 +6,18 @@ begin
   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).map { |f| f.to_s }
+    t.libs      << 'lib' << 'spec' # needed for CI rake spec task, duplicated in spec_helper
 
     begin
-      gem 'rcov', '~>0.8'
+      require 'rcov'
       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
+    rescue SyntaxError
+      # rcov syntax invalid
     end
   end
 rescue LoadError

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dm-serializer
 version: !ruby/object:Gem::Version 
-  version: 0.9.11
+  version: 0.10.0
 platform: ruby
 authors: 
 - Guy van den Berg
@@ -9,19 +9,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-29 00:00:00 -07:00
+date: 2009-09-16 00:00:00 -07:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: dm-core
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        version: 0.9.11
-    version: 
+dependencies: []
+
 description: DataMapper plugin for serializing DataMapper objects
 email: 
 - vandenberg.guy [a] gmail [d] com
@@ -30,19 +21,20 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README.textile
+- README.rdoc
 - LICENSE
 - TODO
-- History.txt
+- History.rdoc
 files: 
-- 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
@@ -69,11 +61,13 @@ files:
 - tasks/install.rb
 - tasks/spec.rb
 has_rdoc: true
-homepage: http://github.com/sam/dm-more/tree/master/dm-serializer
+homepage: http://github.com/datamapper/dm-more/tree/master/dm-serializer
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --main
-- README.txt
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -91,9 +85,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: datamapper
-rubygems_version: 1.3.1
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: DataMapper plugin for serializing DataMapper objects
 test_files: []
 

data/README.textile

@@ -1,61 +0,0 @@
-h1. dm-serializer
-
-h2. Overview
-
-dm-serializer allows DataMapper models and collections to be serialized to a variety of formats (currently JSON, XML, YAML and CSV).
-
-h2. How it works
-
-One method is added to each model/collection for each serialization type - @to_json@, @to_xml@, @to_yaml@, and @to_csv@. With the exception of @to_csv@, all of these methods share the same interface. @to_json@ will be used for examples. Any method specific behaviour is documented in its own section below.
-
-<pre><code>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" }</code></pre>
-
-You can include associations by passing the association accessor the @:methods@ option.
-
-If you want to only load a particular serialization method, that's cool, you can do that:
-
-<pre><code>require 'dm-serializer/to_json'</code></pre>
-
-h2. to_xml
-
-@to_xml@ supports some extra options to allow you to override the element names
-
-<pre><code>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></code></pre>
-
-If you would like a nice speed boost (~5x), require @libxml@ or @nokogiri@ before @dm-serializer@, and that library will be used rather than REXML.
-
-h2. to_csv
-
-@to_csv@ currently doesn't support any options yet. It will in the future. It will not support serializing child associations.
-
-h2. Arrays, Hashes, and other core classes
-
-@dm-serializer@ only adds serialization methods to DataMapper objects and collections, however some libraries used (json, yaml) add methods to core classes, such as @Array@. Note that passing @dm-serializer@ options (such as @:only@) to these methods is *not supported*.
-
-<pre><code>Cow.all.to_a.to_yaml(:only => 'name') # WILL NOT WORK</code></pre>
-
-h2. 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.