dbdom 0.0.1

data/README.rdoc

@@ -0,0 +1,3 @@
+== Installation
+
+== Usage

data/Rakefile

@@ -0,0 +1,27 @@
+require 'rubygems'  
+require 'rake'  
+  
+begin  
+  require 'jeweler'  
+  Jeweler::Tasks.new do |gemspec|  
+    gemspec.name = "dbdom"  
+    gemspec.summary = "exposes a jdbc db via dom"  
+    gemspec.description = "exposes a jdbc db via dom"  
+    gemspec.email = "aaron.hamid@gmail.com"  
+    gemspec.homepage = "http://github.com/ahamid/dbdom"  
+    gemspec.authors = ["Aaron Hamid"]  
+    gemspec.has_rdoc = false # not yet
+    gemspec.files.exclude '.gitignore'
+    # gemspec.files.exclude 'test.sh'
+
+    # I think this is redundant because jeweler requires rubygems already
+    # gemspec.add_dependency('rubygems')
+
+    gemspec.add_dependency('maven_gem')  
+  end  
+  Jeweler::GemcutterTasks.new
+rescue LoadError  
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"  
+end  
+  
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/bin/install-deps.sh

@@ -0,0 +1,10 @@
+#!/bin/sh
+
+# the xerces impl requires the xerces jar
+# although the dependency interfaces should already
+# be in the JDK
+
+jruby -S gem install maven_gem
+jruby -S gem maven xml-apis xml-apis 1.3.04
+jruby -S gem maven xml-resolver xml-resolver 1.2
+jruby -S gem maven xerces xercesImpl 2.9.1

data/dbdom.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{dbdom}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Aaron Hamid"]
+  s.date = %q{2010-03-29}
+  s.default_executable = %q{install-deps.sh}
+  s.description = %q{exposes a jdbc db via dom}
+  s.email = %q{aaron.hamid@gmail.com}
+  s.executables = ["install-deps.sh"]
+  s.extra_rdoc_files = [
+    "README",
+     "README.rdoc"
+  ]
+  s.files = [
+    "README",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/install-deps.sh",
+     "dbdom.gemspec",
+     "lib/advice.rb",
+     "lib/dbdom.rb",
+     "lib/jdbc.rb",
+     "lib/rexml.rb",
+     "lib/xerces.rb",
+     "test.sh",
+     "test/advice_test.rb",
+     "test/dbdom_test.rb"
+  ]
+  s.homepage = %q{http://github.com/ahamid/dbdom}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{exposes a jdbc db via dom}
+  s.test_files = [
+    "test/advice_test.rb",
+     "test/dbdom_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<maven_gem>, [">= 0"])
+    else
+      s.add_dependency(%q<maven_gem>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<maven_gem>, [">= 0"])
+  end
+end
+

data/lib/advice.rb

@@ -0,0 +1,35 @@
+# simple advice support
+# see: http://refactormycode.com/codes/656-method-hooks-in-ruby-any-cleaner
+module Advice
+    def advise_before(sym, *methods)
+        advise({ :before => sym }, *methods)    
+    end
+
+    def advise_after(sym, *methods)
+        advise({ :after => sym }, *methods)    
+    end
+
+    def advise(h = {}, *methods)
+        methods.each do |meth|
+            # save original method
+            hook_method = RUBY_VERSION >= '1.9.0' ? :"__#{meth}__hooked__" : "__#{meth}__hooked__"
+            # create the copy of the hooked method          
+            alias_method hook_method, meth
+            # declare the original private
+            private hook_method
+
+            # define our new replacement method
+            define_method meth do |*args|
+                if h.has_key?(:before)
+                    method(h[:before]).call meth, args
+                end
+                # call the original method
+                val = send(:"__#{meth}__hooked__", *args)
+                if h.has_key?(:after)
+                    method(h[:after]).call meth, args
+                end
+                val
+            end
+        end
+    end
+end

data/lib/dbdom.rb

@@ -0,0 +1,13 @@
+require 'java'
+
+require 'rexml'
+
+module DbDom
+    def DbDom.createDoc(settings)
+        DbDocument.new(nil, settings)
+    end
+
+    def DbDom.xpath(node, expr)
+        XPath.match(node, expr);
+    end
+end

data/lib/jdbc.rb

@@ -0,0 +1,68 @@
+require 'java'
+
+module Java
+    module Jdbc
+        # this is apparently not necessary in Java 1.6+
+        # it implements some sort of automatic driver loading
+        def Jdbc.load_driver(driver_class)
+            Java::JavaClass.for_name(driver_class)
+        end
+
+        def Jdbc.get_connection(url, user, password)
+            return java.sql.DriverManager.getConnection(url, user, password)
+        end
+
+        def Jdbc.auto_close(object, &block)
+            begin
+                block.call object
+            ensure
+                object.close
+            end
+        end
+
+        def Jdbc.with_connection(context, &block)
+            load_driver(context[:driver_class]) if context.has_key?(:driver_class)
+            conn = get_connection(context[:url], context[:user], context[:password])
+            auto_close(conn, &block)
+        end
+
+        def Jdbc.get_tables(conn)
+            rs = conn.getMetaData.getTables(nil, nil, nil, [ "TABLE" ].to_java(:String))
+            auto_close(rs) do |rs|
+                while rs.next do
+                    yield rs.getString("TABLE_NAME")
+                end
+            end
+        end
+
+        def Jdbc.get_rows(conn, tablename)
+            auto_close(conn.createStatement) do |stmt|
+                rs = stmt.executeQuery("select * from " + tablename)
+                auto_close(rs) do |rs|
+                    metadata = rs.getMetaData
+                    column_names = []
+                    1.upto(metadata.getColumnCount) do |i|
+                        column_names << metadata.getColumnName(i)
+                    end
+                    while rs.next do
+                        column_values = []
+                        column_names.each_with_index do |name, i|
+                            column_values << rs.getString(i + 1)
+                        end
+                        yield column_names, column_values
+                    end
+                end
+            end
+        end
+
+        # TODO: determine if it's possible to just alias Module class methods        
+        #alias :with_statement :auto_close
+        #alias :with_resultset :auto_close
+        def Jdbc.with_statement(object, &block)
+            auto_close(object, &block)
+        end
+        def Jdbc.with_resultset(object, &block)
+            auto_close(object, &block)
+        end
+    end
+end

data/lib/rexml.rb

@@ -0,0 +1,109 @@
+require 'rexml/document'
+include REXML
+
+require 'advice'
+require 'jdbc'
+
+module DbDom
+    module Rexml
+
+        class DbDom
+            def createDoc(settings)
+                DbDocument.new(nil, settings)
+            end
+
+            def xpath(node, expr)
+               XPath.match(node, expr);
+            end
+        end
+
+        class DynamicElement < Element
+            extend Advice
+
+            # this is super-lame
+            # i can't find a way to intercept instance var access
+            # and the REXML Parent class does not provide an initialization hook
+            # so we basically have to wrap each and every method (well, at least
+            # the ones that interact with the @children var), in order to
+            # be able to invoke an initialization method
+            # either the design of the Parent class sucks, or I'm just missing
+            # some great idiomatic way to do this
+            EVERY_SINGLE_PARENT_METHOD = [ :add, :push, :<<, :unshift, :delete,
+                                           :each, :delete_if, :delete_at, :each_index,
+                                           :each_child, :[]=, :insert_before, :insert_after,
+                                           :to_a, :index, :size, :length, :children,
+                                           :replace_child, :deep_clone ]
+
+            advise_before :initialize_children, *Parent.instance_methods(false)
+
+            def initialize(name, parent, context)
+                super(name, parent, context)
+                @children_initialized = false
+                @initializing = false # hack to avoid re-entrancy
+            end
+
+            def initialize_children(method, *args)
+                return if @children_initialized || @initializing
+                @initializing = true
+                init_children
+                @children_initialized = true
+                @initializing = false
+            end
+
+            def init_children
+            end
+        end
+
+        class DbElement < DynamicElement
+            def initialize(parent, context)
+                super("database", parent, context)
+            end
+
+            def init_children
+                Java::Jdbc.with_connection(context) do |conn|
+                    @children = []            
+                    Java::Jdbc.get_tables(conn) do |name|
+                        @children << TableElement.new(name, nil, context);
+                    end
+                end
+            end
+        end
+
+        class TableElement < DynamicElement
+            def initialize(tablename, parent, context)
+                super("table", parent, context)
+                @tablename = tablename;
+                attributes["name"] = tablename;
+            end
+
+            def init_children
+                Java::Jdbc.with_connection(context) do |conn|
+                    rownum = 0
+                    Java::Jdbc.get_rows(conn, @tablename) do |column_names, column_values|
+                        @children << construct_row(column_names, column_values, rownum)
+                        rownum += 1
+                    end
+                end
+            end
+
+            def construct_row(column_names, column_values, rownum)
+                row = Element.new("row");
+                row.attributes["num"] = rownum.to_s
+                column_names.each_with_index do |name, i|
+                    col = Element.new(name)
+                    data = Text.new(column_values[i], false)
+                    col << data
+                    row << col
+                end
+                return row
+            end
+        end
+
+        class DbDocument < Document
+            def initialize(source = nil, context = {})
+                super(source, context)
+                @children << DbElement.new(nil, context)
+            end
+        end
+    end
+end

data/lib/xerces.rb

@@ -0,0 +1,110 @@
+require 'rubygems'
+require 'xercesImpl'
+require 'java'
+
+import org.apache.xerces.dom.ElementImpl
+import org.apache.xerces.dom.CoreDocumentImpl
+
+module DbDom
+    module Xerces
+
+        class DbDom
+            def createDoc(settings)
+                DatabaseDocument.new(settings)
+            end
+
+            def xpath(node, expr)
+                xpath = javax.xml.xpath.XPathFactory.newInstance.newXPath
+                xpath.evaluate(expr, node, javax.xml.xpath.XPathConstants::NODESET)
+            end
+        end
+
+        class DatabaseElement < org.apache.xerces.dom.ElementImpl
+            def initialize(doc)
+                super(doc, "database")
+                needsSyncChildren(true)
+                @updating = false
+            end
+
+            def synchronizeChildren
+                return if @updating # avoid re-entrancy
+                @updating = true
+                Java::Jdbc.with_connection(ownerDocument.settings) do |conn|
+                    Java::Jdbc.get_tables(conn) do |name|
+                        appendChild(TableElement.new(ownerDocument, name));
+                    end
+                end
+                super
+                @updating = false
+            end
+        end
+
+        class TableElement < org.apache.xerces.dom.ElementImpl
+            def initialize(doc, name)
+                super(doc, "table")
+                needsSyncChildren(true)
+                setAttribute("name", name)
+                @name = name
+                @updating = false
+            end
+
+            def synchronizeChildren
+                return if @updating # avoid re-entrancy
+                @updating = true
+                Java::Jdbc.with_connection(ownerDocument.settings) do |conn|
+                    rownum = 0
+                    Java::Jdbc.get_rows(conn, @name) do |column_names, column_values|
+                        appendChild(construct_row(column_names, column_values, rownum))
+                        rownum += 1
+                    end
+                end
+                super
+                @updating = false
+            end
+
+            private
+                # this implementation just grabs all rows
+                # don't iterate the resultset on demand or implement
+                # any optimizations based on specific Element navigation calls
+                def construct_row(column_names, column_values, rownum)
+                    row = ownerDocument.createElement("row");
+                    row.setAttribute("num", rownum.to_s)
+                    column_names.each_with_index do |name, i|
+                        col = ownerDocument.createElement(name)
+                        data = ownerDocument.createTextNode(column_values[i])
+                        col.appendChild(data)
+                        row.appendChild(col)
+                    end
+                    return row
+                end
+        end
+
+        class DatabaseDocument < org.apache.xerces.dom.CoreDocumentImpl
+            # http://jira.codehaus.org/browse/JRUBY-2457
+            def initialize(settings)
+                @settings = settings
+                super()
+                needsSyncChildren(true)
+                @docElement = DatabaseElement.new(self)
+                # we need to append the doc root
+                # (which makes sense but hadn't done it when I was just using DOM)
+                # xpath relies on this
+                appendChild(@docElement)
+            end
+
+            attr_reader :settings
+           
+            # Note: for some reason calling this class with 'docElement'
+            # did not result in this method being invoked
+            # I moved the initialization to the constructor
+            # this method was implemented because synchronizeChildren didn't
+            # appear to be getting called in the first place 
+            def getDocumentElement
+            #def synchronizeChildren
+            #    puts "SYNCING"
+                @docElement
+            #    super
+            end
+        end
+    end
+end

data/test.sh

@@ -0,0 +1,4 @@
+#!/bin/sh
+
+jruby -w -J-cp /usr/share/derby/lib/derby.jar -Ilib test/dbdom_test.rb
+jruby -w -Ilib test/advice_test.rb

data/test/advice_test.rb

@@ -0,0 +1,48 @@
+require 'test/unit'
+
+require 'advice'
+
+class BadClass
+    def initialize
+        @internal_field = "Hi! I'm not designed for extension!"
+    end
+
+    def get_the_internal_field
+        puts "In super method"
+        @internal_field
+    end
+end
+
+class SubClass < BadClass
+    attr_reader :before_called, :after_called, :internal_field
+
+    extend Advice
+
+    advise({ :before => :before_advice, :after => :after_advice }, :get_the_internal_field)
+
+    def before_advice(method, *args)
+        puts "I'm before!"
+        @internal_field = "Overridden"
+        @before_called = true
+    end
+
+    def after_advice(method, *args)
+        puts "I'm after!"
+        @after_called = true
+    end
+end
+
+class AdviceTest < Test::Unit::TestCase
+    def test_advice
+        s = SubClass.new
+        f = s.get_the_internal_field
+        assert s.before_called
+        assert s.after_called
+        assert_equal "Overridden", f
+        assert_equal "Overridden", s.internal_field
+    end
+end
+
+
+require 'test/unit/ui/console/testrunner'
+Test::Unit::UI::Console::TestRunner.run(AdviceTest)

data/test/dbdom_test.rb

@@ -0,0 +1,136 @@
+require 'test/unit'
+require 'rexml'
+require 'xerces'
+
+PROPERTIES = { :url => 'jdbc:derby:memory:TestDb;create=true' }
+
+Java::Jdbc.with_connection(PROPERTIES) do |conn|
+    Java::Jdbc.auto_close(conn.createStatement) do |stmt|
+        stmt.execute("create table Boat(id integer, name varchar(20))")
+        stmt.execute("insert into Boat (id, name) values (1, 'andy')")
+        stmt.execute("insert into Boat (id, name) values (2, 'akiva')")
+        stmt.execute("insert into Boat (id, name) values (3, 'jorma')")
+    end
+end
+
+class JdbcTest < Test::Unit::TestCase
+    def test_jdbc
+        Java::Jdbc.with_connection(PROPERTIES) do |conn|
+            rs = conn.getMetaData.getTables(nil, nil, nil, [ "TABLE" ].to_java(:String))
+            Java::Jdbc.auto_close(rs) do |rs|
+                assert rs.next
+                assert_equal "boat", rs.getString("TABLE_NAME").downcase
+            end
+        end
+    end
+end
+
+class RexmlDbDomTest < Test::Unit::TestCase
+    include DbDom::Rexml
+
+    def setup
+        @dbdom = DbDom.new
+    end
+    
+    def test_create_dbdocument
+        doc = @dbdom.createDoc(PROPERTIES)
+        db = doc.root
+        assert_equal 1, db.size
+        table = db[0]
+        assert_equal "boat", table.attributes["name"].downcase
+        assert_equal 3, table.size
+
+        table.children.each_with_index do |row, i|
+            assert_equal i.to_s, row.attributes["num"]
+            assert_equal 2, row.size
+            col = row[0]
+            assert_equal "id", col.name.downcase
+            assert_equal 1, col.size
+            text = col[0]
+            # ???: dbdom_test.rb:44 warning: (...) interpreted as grouped expression
+            assert_equal (i + 1).to_s, text.value
+            col = row[1]
+            assert_equal "name", col.name.downcase
+            assert_equal 1, col.size
+            text = col[0]
+            assert_equal ["andy", "akiva", "jorma"][i], text.value
+        end
+    end
+
+    def test_xpath
+        doc = @dbdom.createDoc(PROPERTIES)
+        #puts doc
+        results = @dbdom.xpath(doc, '//database');
+        assert_equal 1, results.size
+        # Rexml does not support predicates? :(
+        # http://arrogantgeek.blogspot.com/2008/01/why-ruby-sucks-1.html
+        #results = XPath.match(doc, "//table[@name='BOAT'/row/NAME");
+        results = @dbdom.xpath(doc, "//table/row/NAME/text()");
+        assert_equal 3, results.size
+        who = ""
+        results.each { |t| who << t.value << " " }
+        puts "On a boat: " + who
+    end
+end
+
+class XercesDbDomTest < Test::Unit::TestCase
+    include DbDom::Xerces
+
+    def setup
+        @dbdom = DbDom.new
+    end
+
+    # damn, bite me
+    # dbdom_test.rb:88:in `const_missing': uninitialized constant Test::Unit::TestSuite::PASSTHROUGH_EXCEPTIONS (NameError)
+	# from /usr/local/bin/../Cellar/jruby/1.4.0/lib/ruby/1.8/test/unit/testcase.rb:82:in `run'
+	# from /usr/local/bin/../Cellar/jruby/1.4.0/lib/ruby/1.8/test/unit/testsuite.rb:34:in `run'
+	# from /usr/local/bin/../Cellar/jruby/1.4.0/lib/ruby/1.8/test/unit/testsuite.rb:33:in `each'
+	# from /usr/local/bin/../Cellar/jruby/1.4.0/lib/ruby/1.8/test/unit/testsuite.rb:33:in `run'
+	# from /usr/local/bin/../Cellar/jruby/1.4.0/lib/ruby/1.8/test/unit/ui/testrunnermediator.rb:46:in `run_suite'
+	# from /usr/local/bin/../Cellar/jruby/1.4.0/lib/ruby/1.8/test/unit/ui/console/testrunner.rb:67:in `start_mediator'
+	# from /usr/local/bin/../Cellar/jruby/1.4.0/lib/ruby/1.8/test/unit/ui/console/testrunner.rb:41:in `start'
+	# from /usr/local/bin/../Cellar/jruby/1.4.0/lib/ruby/1.8/test/unit/ui/testrunnerutilities.rb:29:in `run'
+    # http://stackoverflow.com/questions/1145318/getting-uninitialized-constant-error-when-trying-to-run-tests
+    def test_create_dbdocument
+        doc = @dbdom.createDoc(PROPERTIES)
+        db = doc.documentElement
+        assert_equal 1, db.childNodes.length
+        table = db.childNodes.item(0)
+        assert_equal "boat", table.getAttribute("name").downcase
+        assert_equal 3, table.childNodes.length
+        table.childNodes.length.times do |i|
+            row = table.childNodes.item(i)
+            assert_equal i.to_s, row.getAttribute("num")
+            assert_equal 2, row.childNodes.length
+            col = row.childNodes.item(0)
+            assert_equal "id", col.nodeName.downcase
+            assert_equal 1, col.childNodes.length
+            text = col.childNodes.item(0)
+            # ???: dbdom_test.rb:44 warning: (...) interpreted as grouped expression
+            assert_equal (i + 1).to_s, text.nodeValue
+            col = row.childNodes.item(1)
+            assert_equal "name", col.nodeName.downcase
+            assert_equal 1, col.childNodes.length
+            text = col.childNodes.item(0)
+            assert_equal ["andy", "akiva", "jorma"][i], text.nodeValue
+        end
+    end
+
+    def test_xpath
+        doc = @dbdom.createDoc(PROPERTIES)
+        results = @dbdom.xpath(doc, '//database');
+        assert_equal 1, results.length
+        results = @dbdom.xpath(doc, "//table[@name='BOAT']/row/NAME/text()");
+        assert_equal 3, results.length
+        who = ""
+        results.length.times do |i|
+            who << results.item(i).nodeValue << " "
+        end
+        puts "On a boat: " + who
+    end
+end
+
+require 'test/unit/ui/console/testrunner'
+Test::Unit::UI::Console::TestRunner.run(JdbcTest)
+Test::Unit::UI::Console::TestRunner.run(RexmlDbDomTest)
+Test::Unit::UI::Console::TestRunner.run(XercesDbDomTest)

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: dbdom
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+    - 0
+    - 0
+    - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+  - Aaron Hamid
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-29 00:00:00 -04:00
+default_executable: install-deps.sh
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: maven_gem
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 0
+            version: "0"
+    type: :runtime
+    version_requirements: *id001
+description: exposes a jdbc db via dom
+email: aaron.hamid@gmail.com
+executables: 
+  - install-deps.sh
+extensions: []
+
+extra_rdoc_files: 
+  - README
+  - README.rdoc
+files: 
+  - README
+  - README.rdoc
+  - Rakefile
+  - VERSION
+  - bin/install-deps.sh
+  - dbdom.gemspec
+  - lib/advice.rb
+  - lib/dbdom.rb
+  - lib/jdbc.rb
+  - lib/rexml.rb
+  - lib/xerces.rb
+  - test.sh
+  - test/advice_test.rb
+  - test/dbdom_test.rb
+has_rdoc: true
+homepage: http://github.com/ahamid/dbdom
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+  - --charset=UTF-8
+require_paths: 
+  - lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+          - 0
+        version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+          - 0
+        version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: exposes a jdbc db via dom
+test_files: 
+  - test/advice_test.rb
+  - test/dbdom_test.rb