MikeSofaer-sax-mapper 0.0.1

data/README

@@ -0,0 +1,44 @@
+SAXMapper is a database persistence extension to SAXMachine.
+It uses DataObjects/MySQL going in, and DataMapper coming back out.
+
+SAXual Replication supports getting multiple instances of an object without an
+explicit wrapper class, just by specifying the wrapper tag, using parse_multiple.
+
+You can also set a column as a remote primary key, and it will overwrite rather
+than add records where that key is a duplicate (you need to separately set
+the column to be have a unique index, since it uses ON DUPLICATE KEY UPDATE)
+
+Finally, you can mark fields as required, and it will raise an expection if the
+XML is missing that field.
+
+Many thanks to Paul Dix, who helped me integrate this with SAXMachine, and Dan
+Kubb, who helped me with DataObjects and gave hints on memory footprint.
+All bugs and memory leaks are mine, though!
+
+Example:
+
+require 'sax-mapper'
+class Person
+  include SaxMapper
+  element :sourced_id, :required => true
+  element :given, :as => :given_name, :required => true
+  element :family, :as => :family_name, :required => true
+  element :email, :required => true
+
+  table "people"
+  tag :person
+  key_column :sourced_id
+end
+
+Person.parse_multiple(xml) will return an array of Person objects, found inside
+<person></person> tags.  You can save them to the DB with Person.save(array)
+
+Multiple values with the same sourced_id will replace each other in the DB.
+
+Query batching is not built in, you have to slice the array.
+
+gem install MikeSofaer-sax-mapper
+
+Enjoy!
+
+SAXMapper is written by Michael Sofaer, July 2009, and MIT licenced.

data/Rakefile

@@ -0,0 +1,14 @@
+require "spec"
+require "spec/rake/spectask"
+require 'lib/sax-mapper.rb'
+
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "\"#{File.dirname(__FILE__)}/spec/spec.opts\""]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+task :install do
+  rm_rf "*.gem"
+  puts `gem build sax-mapper.gemspec`
+  puts `sudo gem install sax-mapper-#{SaxMapper::VERSION}.gem`
+end

data/lib/sax-mapper.rb

@@ -0,0 +1,101 @@
+require 'sax-machine'
+require 'dm-core'
+
+module SaxMapper
+  class MissingElementError < Exception; end
+
+  def self.included(base)
+    base.send(:include, SAXMachine)
+    base.extend SaverMethods
+  end
+
+  module SaverMethods
+    def parse(xml)
+      ret = super(xml)
+      ret.validate
+      return ret
+    end
+
+    def parse_multiple(xml)
+      klass = collection_class
+      ret = klass.parse(xml)
+      ret.rows.each{|o| o.validate}
+      ret.rows
+    end
+
+    def columns_with_types
+      column_names.each{|c| yield c, data_class(c) || String}
+    end
+
+    def connection
+      DataMapper.repository(:default).adapter
+    end
+
+    def table(value)
+      @table_name = value
+    end
+
+    def tag(value)
+      @tag = value
+    end
+
+    def key_column(value)
+      @key_column = value
+    end
+
+    def datamapper_class
+      klass = self.dup
+      klass.send(:include, DataMapper::Resource)
+      klass.storage_names[:default] = @table_name
+      klass.property(:id, DataMapper::Types::Serial)
+      klass.property(:created_at, DateTime, :nullable => false)
+      klass.property(:updated_at, DateTime, :nullable => false)
+      columns_with_types { |n, t| klass.property(n, t, :field => n.to_s) }
+      klass
+    end
+
+    def collection_class
+      klass = self
+      tag = @tag
+      Class.new do
+        include SaxMapper
+        elements tag, :as => :rows, :class => klass
+      end
+    end
+
+    def sql(rows)
+      _sql = "INSERT INTO "+ @table_name + "(" + column_names.join(', ') + ", created_at, updated_at) VALUES " +
+        ([("(" + (["?"] * (column_names.size + 2)).join(',') + ")")] * rows.size).join(',')
+      _sql << duplicate_key_clause if @key_column
+      _sql
+    end
+    def bind_values(rows)
+      names = column_names
+      datetime = DateTime.now
+      array = []
+      rows.each{|row| row.add_bind_values!(names, array, datetime)}
+      array
+    end
+    def duplicate_key_clause
+      " ON DUPLICATE KEY UPDATE " + (column_names - [:created_at, @key_column]).map {|c| c.to_s + "=VALUES(" + c.to_s + ")"}.join(', ')
+    end
+
+    def save(rows)
+      connection.execute sql(rows), *bind_values(rows)
+    end
+  end
+
+  def add_bind_values!(column_names, bind_array, datetime)
+    column_names.each do |c|
+      val = self.send(c)
+      bind_array << ((self.class.data_class(c) == DateTime && val) ? (DateTime.parse(val)) : val)
+    end
+    bind_array << datetime << datetime
+  end
+
+  def validate
+    self.class.instance_variable_get('@sax_config').instance_variable_get('@top_level_elements').select{ |e| e.required? }.each do |element|
+      raise MissingElementError.new("Missing the required attribute " + element.name) unless send(element.instance_variable_get('@as'))
+    end
+  end
+end

data/spec/sax-mapper/sax-mapper_spec.rb

@@ -0,0 +1,89 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "SaxMapper" do
+  before :each do
+    @klass = Class.new do
+      include SaxMapper
+      element :title
+      element :written_on, :class => DateTime
+      table "documents"
+      tag :document
+    end
+  end
+  it "should function as a SAXMachine class" do
+    document = @klass.parse("<title>Hello, Everyone!</title>")
+    document.title.should == "Hello, Everyone!"
+  end
+  describe "DataMapper" do
+    before(:each) do
+      DataMapper.setup(:default, 'mysql://localhost/saxual_replication_test')
+      @adapter = DataMapper.repository.adapter
+    end
+    it "should have the database connection" do
+      @adapter.query "show tables"
+    end
+    it "should have a DataMapper class" do
+      @klass.datamapper_class.all.should be_a(Array)
+    end
+    it "should be able to auto-migrate the document table" do
+      DataMapper.auto_migrate!
+    end
+    describe "with multiple columns" do
+      before(:each) do
+        @document = @klass.parse("<xml><title>Someone's Cat</title><written_on>March 5 2007</written_on></xml>")
+      end
+      after(:each) do
+        @adapter.execute "delete from documents"
+      end
+      it "should generate the correct bind values for the specified columns" do
+        @klass.column_names.should =~ [:title, :written_on]
+        array = []
+        @document.add_bind_values!(@klass.column_names, array, DateTime.now)
+        array[0].should == "Someone's Cat"
+        array[1].should be_a(DateTime)
+        array[2].should be_a(DateTime)
+        array[3].should be_a(DateTime)
+      end
+      it "should generate the correct bind values from a class call" do
+        array = @klass.bind_values([@document,@document])
+        array[0].should == "Someone's Cat"
+        array[4].should == "Someone's Cat"
+        array[1].should be_a(DateTime)
+        array[5].should be_a(DateTime)
+      end
+      it "should generate the correct SQL from a class call" do
+        @klass.sql([@document,@document]).should == "INSERT INTO documents(title, written_on, created_at, updated_at) VALUES (?,?,?,?),(?,?,?,?)"
+      end
+      describe "multiple records" do
+        before(:each) do
+          @xml = "<xml><document><title>Hello, Everyone!</title></document><document><title>Someone's Cat</title></document></xml>"
+        end
+
+        it "should be possible to parse two records" do
+          rows = @klass.parse_multiple(@xml)
+          rows.size.should == 2
+        end
+
+        it "should be able to save two records" do
+          documents = @klass.parse_multiple(@xml)
+          @klass.save documents
+          @klass.datamapper_class.all[0].title.should == "Hello, Everyone!"
+          @klass.datamapper_class.all[1].title.should == "Someone's Cat"
+        end
+      end
+      describe "replication" do
+        it "should update fields on rows with a repeated primary key" do
+          @klass.key_column :written_on
+          @adapter.execute "create unique index key_column on documents(written_on)"
+          t = DateTime.now.to_s
+          xml1 = "<document><title>Hello, Everyone!</title><written_on>#{t}</written_on></document>"
+          xml2 = "<document><title>Someone's Cat</title><written_on>#{t}</written_on></document>"
+          @klass.save [@klass.parse(xml1)]
+          @klass.save [@klass.parse(xml2)]
+          @klass.datamapper_class.all.size.should == 1
+          @klass.datamapper_class.all[0].title.should == "Someone's Cat"
+        end
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--diff
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require "rubygems"
+require "spec"
+
+# gem install redgreen for colored test output
+begin require "redgreen" unless ENV['TM_CURRENT_LINE']; rescue LoadError; end
+
+path = File.expand_path(File.dirname(__FILE__) + "/../lib/")
+$LOAD_PATH.unshift(path) unless $LOAD_PATH.include?(path)
+
+require "lib/sax-mapper"
+
+# Spec::Runner.configure do |config|
+# end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: MikeSofaer-sax-mapper
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Michael Sofaer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-21 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: pauldix-sax-machine
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.0.14
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: 
+description: 
+email: mike@sofaer.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/sax-mapper.rb
+- README
+- Rakefile
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/sax-mapper/sax-mapper_spec.rb
+has_rdoc: false
+homepage: http://github.com/MikeSofaer/sax-mapper
+licenses: 
+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.3.5
+signing_key: 
+specification_version: 2
+summary: Database replication from XML with SAXMachine
+test_files: []
+