ardm-serializer 1.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b9a3b759e035df936b3dedfd92358708957ac7e8
+  data.tar.gz: dff5952407b0df0c25c9652d56af3de02e7e049c
+SHA512:
+  metadata.gz: 5679f89c1bcae61186706075dea152605ffdfdb71a285ec5bf82c19a10f7bdea8ca8ba29d06960145a96274b329fbb51369dec99014b11f1cb9484da55e77439
+  data.tar.gz: f513b39338c5da07f3d070e5cab7a9b5b459f81d02122f3fef834e926b335611ad63eaae3ef6f14b820169be65e02f387afa6c1f697292f3982c96f81fe77178

data/.gitignore

@@ -0,0 +1,35 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## Rubinius
+*.rbc
+
+## PROJECT::GENERAL
+*.gem
+coverage
+rdoc
+pkg
+tmp
+doc
+log
+.yardoc
+measurements
+
+## BUNDLER
+.bundle
+Gemfile.*
+
+## PROJECT::SPECIFIC
+spec/db/

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+sudo: false
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.5
+  - 2.2.0
+matrix:
+  allow_failures:
+    - rvm: 2.1.5
+    - rvm: 2.2.0

data/Gemfile

@@ -0,0 +1,81 @@
+require 'pathname'
+
+source 'https://rubygems.org'
+
+gemspec
+
+SOURCE         = ENV.fetch('SOURCE', :git).to_sym
+REPO_POSTFIX   = SOURCE == :path ? ''                                : '.git'
+DATAMAPPER     = SOURCE == :path ? Pathname(__FILE__).dirname.parent : 'http://github.com/ar-dm'
+DM_VERSION     = '~> 1.2.0'
+DO_VERSION     = '~> 0.10.6'
+DM_DO_ADAPTERS = %w[ sqlite postgres mysql oracle sqlserver ]
+CURRENT_BRANCH = ENV.fetch('GIT_BRANCH', 'master')
+
+gem 'fastercsv',  '~> 1.5'
+gem 'multi_json', '~> 1.0'
+gem 'json',       '~> 1.6', :platforms => [ :ruby_18, :jruby ]
+gem 'json_pure',  '~> 1.6', :platforms => [ :mswin ]
+
+gem 'ardm-core', DM_VERSION,
+  SOURCE  => "#{DATAMAPPER}/ardm-core#{REPO_POSTFIX}",
+  :branch => CURRENT_BRANCH
+
+group :development do
+  gem 'ardm-validations', DM_VERSION,
+    SOURCE  => "#{DATAMAPPER}/ardm-validations#{REPO_POSTFIX}",
+    :branch => CURRENT_BRANCH
+end
+
+group :testing do
+  gem 'nokogiri',    '~> 1.6'
+  gem 'libxml-ruby', '~> 2.0', :platforms => [ :mri, :mswin ]
+end
+
+platforms :mri_18 do
+  group :quality do
+
+    gem 'rcov',      '~> 0.9.10'
+    gem 'yard',      '~> 0.7.2'
+    gem 'yardstick', '~> 0.4'
+
+  end
+end
+
+group :datamapper do
+
+  adapters = ENV['ADAPTER'] || ENV['ADAPTERS']
+  adapters = adapters.to_s.tr(',', ' ').split.uniq - %w[ in_memory ]
+
+  if (do_adapters = DM_DO_ADAPTERS & adapters).any?
+    do_options = {}
+    do_options[:git] = "#{DATAMAPPER}/do#{REPO_POSTFIX}" if ENV['DO_GIT'] == 'true'
+
+    gem 'data_objects', DO_VERSION, do_options.dup
+
+    do_adapters.each do |adapter|
+      adapter = 'sqlite3' if adapter == 'sqlite'
+      gem "do_#{adapter}", DO_VERSION, do_options.dup
+    end
+
+    gem 'ardm-do-adapter', DM_VERSION,
+      SOURCE  => "#{DATAMAPPER}/ardm-do-adapter#{REPO_POSTFIX}",
+      :branch => CURRENT_BRANCH
+  end
+
+  adapters.each do |adapter|
+    gem "ardm-#{adapter}-adapter", DM_VERSION,
+      SOURCE  => "#{DATAMAPPER}/ardm-#{adapter}-adapter#{REPO_POSTFIX}",
+      :branch => CURRENT_BRANCH
+  end
+
+  plugins = ENV['PLUGINS'] || ENV['PLUGIN']
+  plugins = plugins.to_s.tr(',', ' ').split.push('ardm-migrations').uniq
+
+  plugins.each do |plugin|
+    gem plugin, DM_VERSION,
+      SOURCE  => "#{DATAMAPPER}/#{plugin}#{REPO_POSTFIX}",
+      :branch => CURRENT_BRANCH
+  end
+
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 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.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

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'rake'
+
+FileList['tasks/**/*.rake'].each { |task| import task }

data/ardm-serializer.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/dm-serializer/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name             = "ardm-serializer"
+  gem.version          = DataMapper::Serializer::VERSION
+
+  gem.authors          = [ 'Martin Emde', 'Guy van den Berg', 'Dan Kubb' ]
+  gem.email            = [ 'me@martinemde.com', "dan.kubb@gmail.com" ]
+  gem.summary          = 'Ardm fork of dm-serializer'
+  gem.description      = "DataMapper plugin for serializing Resources and Collections"
+  gem.homepage         = "https://github.com/ar-dm/ardm-serializer"
+  gem.license          = 'MIT'
+
+  gem.files            = `git ls-files`.split("\n")
+  gem.test_files       = `git ls-files -- {spec}/*`.split("\n")
+  gem.extra_rdoc_files = %w[LICENSE README.rdoc]
+  gem.require_paths    = [ "lib" ]
+
+  gem.add_runtime_dependency 'ardm-core',  '~> 1.2'
+  gem.add_runtime_dependency 'fastercsv',  '~> 1.5'
+  gem.add_runtime_dependency 'multi_json', '~> 1.0'
+  gem.add_runtime_dependency 'json',       '~> 1.6'
+  gem.add_runtime_dependency 'json_pure',  '~> 1.6'
+
+  gem.add_development_dependency 'rake',  '~> 0.9'
+  gem.add_development_dependency 'rspec', '~> 1.3'
+end

data/benchmarks/to_json.rb

@@ -0,0 +1,137 @@
+require "rubygems"
+require 'pathname'
+require 'better-benchmark'
+
+gem 'dm-core', '1.0.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', :required => false
+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

@@ -0,0 +1,89 @@
+require "rubygems"
+require 'pathname'
+
+gem 'dm-core', '1.0.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:')
+
+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'
+end
+
+require "benchwarmer"
+
+TIMES = 2000
+DataMapper.auto_migrate!
+cow = Cow.create(
+  :id        => 89,
+  :composite => 34,
+  :name      => 'Berta',
+  :breed     => 'Guernsey'
+)
+all_cows = Cow.all
+
+puts "REXML"
+Benchmark.warmer(TIMES) do
+  group("Serialization:") do
+    report "Single Resource" do
+      cow.to_xml
+    end
+    report "Collection" do
+      all_cows.to_xml
+    end
+  end
+end
+
+require 'nokogiri'
+load 'dm-serializer/xml_serializers.rb'
+
+puts "Nokogiri"
+Benchmark.warmer(TIMES) do
+  group("Serialization:") do
+    report "Single Resource" do
+      cow.to_xml
+    end
+    report "Collection" do
+      all_cows.to_xml
+    end
+  end
+end
+
+require 'libxml'
+load 'dm-serializer/xml_serializers.rb'
+
+puts "LibXML"
+Benchmark.warmer(TIMES) do
+  group("Serialization:") do
+    report "Single Resource" do
+      cow.to_xml
+    end
+    report "Collection" do
+      all_cows.to_xml
+    end
+  end
+end