dm-serializer 0.9.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Guy van den Berg
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,4 @@
+dm-serializer
+=============
+
+DataMapper plugin for serializing DataMapper objects.

data/Rakefile

@@ -0,0 +1,65 @@
+require 'rubygems'
+require 'spec'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+require 'pathname'
+
+CLEAN.include '{log,pkg}/'
+
+spec = Gem::Specification.new do |s|
+  s.name             = 'dm-serializer'
+  s.version          = '0.9.2'
+  s.platform         = Gem::Platform::RUBY
+  s.has_rdoc         = true
+  s.extra_rdoc_files = %w[ README LICENSE TODO ]
+  s.summary          = 'DataMapper plugin for serializing DataMapper objects'
+  s.description      = s.summary
+  s.author           = 'Guy van den Berg'
+  s.email            = 'vandenberg.guy@gmail.com'
+  s.homepage         = 'http://github.com/sam/dm-more/tree/master/dm-serializer'
+  s.require_path     = 'lib'
+  s.files            = FileList[ '{lib,spec}/**/*.rb', 'spec/spec.opts', 'Rakefile', *s.extra_rdoc_files ]
+  s.add_dependency('dm-core', "=#{s.version}")
+end
+
+task :default => [ :spec ]
+
+WIN32 = (RUBY_PLATFORM =~ /win32|mingw|cygwin/) rescue nil
+SUDO  = WIN32 ? '' : ('sudo' unless ENV['SUDOLESS'])
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Install #{spec.name} #{spec.version} (default ruby)"
+task :install => [ :package ] do
+  sh "#{SUDO} gem install --local pkg/#{spec.name}-#{spec.version} --no-update-sources", :verbose => false
+end
+
+desc "Uninstall #{spec.name} #{spec.version} (default ruby)"
+task :uninstall => [ :clobber ] do
+  sh "#{SUDO} gem uninstall #{spec.name} -v#{spec.version} -I -x", :verbose => false
+end
+
+namespace :jruby do
+  desc "Install #{spec.name} #{spec.version} with JRuby"
+  task :install => [ :package ] do
+    sh %{#{SUDO} jruby -S gem install --local pkg/#{spec.name}-#{spec.version} --no-update-sources}, :verbose => false
+  end
+end
+
+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(Pathname.new(__FILE__).dirname + 'spec/**/*_spec.rb')
+
+  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
+end

data/TODO

@@ -0,0 +1,8 @@
+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

@@ -0,0 +1,160 @@
+require Pathname('rexml/document')
+
+begin
+  require 'faster_csv'
+rescue LoadError
+  nil
+end
+
+begin
+  require Pathname('json/ext')
+rescue LoadError
+  require Pathname('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 = {})
+      result = '{ '
+      fields = []
+
+      # FIXME: this should go into bunch of protected methods shared with other serialization methods
+      only_properties     = options[:only]    || []
+      excluded_properties = options[:exclude] || []
+      exclude_read_only   = options[:without_read_only_attributes] || false
+
+      propset = self.class.properties(repository.name)
+
+      # FIXME: this ugly condition is here because PropertySet does not support reject/select yet.
+      unless only_properties.empty?
+        propset.each do |property|
+          fields << "#{property.name.to_json}: #{send(property.getter).to_json}" if only_properties.include?(property.name.to_sym)
+        end
+      else
+        propset.each do |property|
+          fields << "#{property.name.to_json}: #{send(property.getter).to_json}" unless excluded_properties.include?(property.name.to_sym)
+        end
+      end
+
+      if self.class.respond_to?(:read_only_attributes) && exclude_read_only
+        self.class.read_only_attributes.each do |property|
+          fields << "#{property.to_json}: #{send(property).to_json}"
+        end
+      end
+
+      # add methods
+      (options[:methods] || []).each do |meth|
+        if self.respond_to?(meth)
+          fields << "#{meth.to_json}: #{send(meth).to_json}"
+        end
+      end
+
+      result << fields.join(', ')
+      result << ' }'
+      result
+    end
+
+    # Serialize a Resource to comma-separated values (CSV).
+    #
+    # @return <String> a CSV representation of the Resource
+    def to_csv(writer = '')
+      FasterCSV.generate(writer) do |csv|
+        row = []
+        self.class.properties(repository.name).each do |property|
+         row << send(property.name).to_s
+        end
+        csv << row
+      end
+    end
+
+    # Serialize a Resource to XML
+    #
+    # @return <REXML::Document> an XML representation of this Resource
+    def to_xml(opts = {})
+      to_xml_document(opts).to_s
+    end
+
+    # Serialize a Resource to YAML
+    #
+    # @return <YAML> a YAML representation of this Resource
+    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|
+            value = send(property.name.to_sym)
+            map.add(property.name, value.is_a?(Class) ? value.to_s : value)
+          end
+          (instance_variable_get("@yaml_addes") || []).each do |k,v|
+            map.add(k.to_s,v)
+          end
+        end
+      end
+    end
+
+    protected
+
+    # 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)
+    end
+
+    # Return a REXML::Document representing this Resource
+    #
+    # @return <REXML::Document> an XML representation of this Resource
+    def to_xml_document(opts={})
+      doc = REXML::Document.new
+      root = doc.add_element(xml_element_name)
+
+      #TODO old code base was converting single quote to double quote on attribs
+
+      self.class.properties(repository.name).each do |property|
+          value = send(property.name)
+          node = root.add_element(property.name.to_s)
+          if property.key?
+            node.attributes["type"] = property.type.to_s.downcase
+          end
+          node << REXML::Text.new(value.to_s) unless value.nil?
+      end
+      doc
+    end
+
+  end # module Serialize
+
+  module Resource
+    include Serialize
+  end # module Resource
+
+  class Collection
+    def to_yaml(opts = {})
+      to_a.to_yaml(opts)
+    end
+
+    def to_json(opts = {})
+      "[" << map {|e| e.to_json(opts)}.join(",") << "]"
+    end
+
+    def to_xml
+      result = ""
+      each do |item|
+        result << item.to_xml + "\n"
+      end
+      result
+    end
+
+    def to_csv
+      result = ""
+      each do |item|
+        result << item.to_csv + "\n"
+      end
+      result
+    end
+  end
+
+end # module DataMapper

data/spec/fixtures/cow.rb

@@ -0,0 +1,8 @@
+class Cow
+  include DataMapper::Resource
+
+  property :id,        Integer, :key => true
+  property :composite, Integer, :key => true
+  property :name,      String
+  property :breed,     String
+end

data/spec/fixtures/planet.rb

@@ -0,0 +1,18 @@
+class Planet
+  include DataMapper::Resource
+
+  property :name, String, :key => true
+  property :aphelion, Float
+
+  def category
+    case self.name.downcase
+    when "mercury", "venus", "earth", "mars" then "terrestrial"
+    when "jupiter", "saturn", "uranus", "neptune" then "gas giants"
+    when "pluto" then "dwarf planets"
+    end
+  end
+
+  def has_known_form_of_life?
+    self.name.downcase == "earth"
+  end
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+require 'rubygems'
+require 'pathname'
+
+gem 'dm-core', '=0.9.2'
+require 'dm-core'
+
+spec_dir_path = Pathname(__FILE__).dirname.expand_path
+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.2'
+    require lib
+    DataMapper.setup(name, ENV["#{name.to_s.upcase}_SPEC_URI"] || default_uri)
+    DataMapper::Repository.adapters[:default] =  DataMapper::Repository.adapters[name]
+    true
+  rescue Gem::LoadError => e
+    warn "Could not load #{lib}: #{e}"
+    false
+  end
+end
+
+ENV['ADAPTER'] ||= 'sqlite3'
+
+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')
+
+
+# require fixture resources
+Dir[spec_dir_path + "fixtures/*.rb"].each do |fixture_file|
+  require fixture_file
+end

data/spec/unit/serializer_spec.rb

@@ -0,0 +1,8 @@
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+
+describe DataMapper::Serialize do
+  it "is included into DataMapper::Resource" do
+    Cow.new.should be_kind_of(DataMapper::Serialize)
+  end
+end

data/spec/unit/to_csv_spec.rb

@@ -0,0 +1,34 @@
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+
+describe DataMapper::Serialize, '#to_csv' do
+  #
+  # ==== blah, it's CSV
+  #
+
+  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 "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.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"
+  end
+end

data/spec/unit/to_json_spec.rb

@@ -0,0 +1,109 @@
+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 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
+
+  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

@@ -0,0 +1,42 @@
+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)
+
+    @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.gsub(/[[:space:]]+\n/, "\n").should ==
+      "<cow><id type='integer'>1</id><composite type='integer'>2</composite><name>Betsy</name><breed>Jersey</breed></cow>\n" +
+      "<cow><id type='integer'>10</id><composite type='integer'>20</composite><name>Berta</name><breed>Guernsey</breed></cow>\n"
+  end
+end

data/spec/unit/to_yaml_spec.rb

@@ -0,0 +1,62 @@
+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
+
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: dm-serializer
+version: !ruby/object:Gem::Version 
+  version: 0.9.2
+platform: ruby
+authors: 
+- Guy van den Berg
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-06-25 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.9.2
+    version: 
+description: DataMapper plugin for serializing DataMapper objects
+email: vandenberg.guy@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+- TODO
+files: 
+- lib/dm-serializer.rb
+- spec/fixtures/cow.rb
+- spec/fixtures/planet.rb
+- 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
+- spec/spec.opts
+- Rakefile
+- README
+- LICENSE
+- TODO
+has_rdoc: true
+homepage: http://github.com/sam/dm-more/tree/master/dm-serializer
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: DataMapper plugin for serializing DataMapper objects
+test_files: []
+