rtm-ontopia 0.2.0 → 0.2.1

data/lib/rtm/ontopia.rb

@@ -1,117 +1,176 @@
 # Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
 # License:   Apache License, Version 2.0
 
-begin
+if Object.const_defined?("Gem") && rtmgem = Gem.loaded_specs["rtm-ontopia"]
   require 'rtm/javatmapi'
-rescue LoadError
+else
   javatmapi_path = File.expand_path(File.join(File.dirname(__FILE__), "../../../rtm-javatmapi/lib"))
   if File.directory?(javatmapi_path)
-    $:.unshift javatmapi_path
+    $LOAD_PATH.unshift javatmapi_path
     require 'rtm/javatmapi'
   end
 end
 
 Dir[File.join(File.dirname(__FILE__), 'ontopia/javalibs/*.jar')].each {|file| require file }
-require (File.dirname(__FILE__) + '/ontopia/io/to_cxtm')
+require File.join(File.dirname(__FILE__), '/ontopia/io/to_cxtm')
 
 module RTM
   class Ontopia < JavaTMAPI
+    require File.join(File.dirname(__FILE__), '/ontopia/rdbms/properties')
     identifier :ontopia
   
     def initialize(*args)
       super
-      set_tmsf(Java::NetOntopiaTopicmapsImplTmapi2::TopicMapSystemFactory.new)
+      if @params[:store] == :rdbms
+        # enhance all ontopia properties from rails-style config
+        ontopia_properties = RTM::Ontopia::Rdbms::Properties.rails2ontopia(@params[:store_config])
+
+
+        # FIXME: this works only if properties was not specified as file
+        @params[:properties] ||= {}
+        ontopia_properties.each do |k,v|
+          @params[:properties][k] = v.to_s unless @params[:properties].key?(k)
+        end
+      end
+
+      tmsf = Java::NetOntopiaTopicmapsImplTmapi2::TopicMapSystemFactory.new
+      set_tmsf(tmsf)
       set_properties(@params[:properties])
       set_features(@params[:features])
       create_system
     end
+
+    # Migrate the Database to contain the Ontopia RDBMS schema. Uses the connection data provided with connect
+    def migrate_database
+      self.class.migrate_database(@params[:store_config])
+    end
+
+    # Drops the Ontopia schema from the database. This corresponds to migrating the database down.
+    def migrate_database_down
+      self.class.migrate_database_down(@params[:store_config])
+    end
+
+    # Migrate the Database to contain the Ontopia RDBMS schema.
+    # Uses a Rails-style database configuration hash to connect to the database.
+    #
+    # Additional hash-keys to override the defaults:
+    #   :connection => an existing connection to be used instead of creating using given parameters
+    #   :schema_sql => directly supply sql to execute instead of :schema_file or autodetect
+    #   :schema_file => directly supply sql file to execute instead of autodetect
+    #   :adapter_schema_name => directly supply the schema name (generic, h2, mysql, oracle8, oracle9i, oracle10g, postresql, sqlserver)
+    #   :direction => :up|:down  create or drop schema (defaults to :up)
+    #
+    def self.migrate_database(config)
+      require 'active_record' unless defined?(ActiveRecord)
+      require 'jdbc_adapter' unless defined?(ActiveRecord::ConnectionAdapters::Jdbc)
+
+      # create a new anonymous class extending ActiveRecord::Base for a separate connection
+      anonymous_active_record_base = Class.new(ActiveRecord::Base)
+
+      # use a supplied connection or create one using the config
+      connection = config[:connection]
+      unless connection
+        # connect to backend using the anonymous base class
+        anonymous_active_record_base.establish_connection(config)
+        connection = anonymous_active_record_base.connection
+      end
+
+      # see if we were provided with a schema directly or get it from file
+      schema_sql = config[:schema_sql]
+      unless schema_sql
+        # should we migrate up or down?
+        direction = config[:direction] || :up
+        create_or_drop = direction.to_s == "up" ? "create" : "drop"
+
+        # get the adapter name for ontopia from the config
+        adapter_schema_name = config[:adapter_schema_name] || config[:adapter].sub(/^jdbc/, '')
+
+        # check if it is one of the available adapters
+        available_schemas = %w[generic h2 mysql oracle8 oracle9i oracle10g postresql sqlserver]
+        adapter_schema_name = "generic" unless available_schemas.include?(adapter_schema_name)
+
+        # find the corresponding schema file
+        schema_file = config[:schema_file] || File.join(File.dirname(__FILE__), "/../../res/rdbms/setup/#{adapter_schema_name}.#{create_or_drop}.sql")
+        raise "Could not find schema definition file #{File.expand_path(schema_file)}." unless File.exist?(schema_file)
+
+        # read the schema
+        schema_sql = File.read(schema_file)
+      end
+
+      # execute the schema
+      connection.execute(schema_sql)
+    end
+
+    # Drops the Ontopia schema from the database. This corresponds to migrating the database down.
+    def self.migrate_database_down(params={})
+      migrate_database(params.merge(:direction => :down))
+    end
   end
 end
 
-module Java::OrgTmapiCore::TopicMap
-  include RTM::TopicMap
-  JavaImplementations.add(self,net.ontopia.topicmaps.impl.tmapi2.TopicMapImpl)
-  superize
-end
+
+Java::OrgTmapiCore::TopicMap.register_java_implementation net.ontopia.topicmaps.impl.tmapi2.TopicMapImpl
 
 module Java::OrgTmapiCore::Topic 
-  include RTM::Topic
-  JavaImplementations.add(self,net.ontopia.topicmaps.impl.tmapi2.TopicImpl)
-  superize
+  register_java_implementation net.ontopia.topicmaps.impl.tmapi2.TopicImpl
 end
 
 module Java::OrgTmapiCore::Association
-  include RTM::Association
-  JavaImplementations.add(self,net.ontopia.topicmaps.impl.tmapi2.AssociationImpl)
-  superize
+  register_java_implementation net.ontopia.topicmaps.impl.tmapi2.AssociationImpl
 end
 
 module Java::OrgTmapiCore::Name    
-  include RTM::Name
-  JavaImplementations.add(self,net.ontopia.topicmaps.impl.tmapi2.NameImpl)
-  superize
+  register_java_implementation net.ontopia.topicmaps.impl.tmapi2.NameImpl
 end
 
-# there is nothing superized in occurrence
-# module Java::OrgTmapiCore::Occurrence
-#   include RTM::Occurrence
-#   JavaImplementations.add(self,net.ontopia.topicmaps.impl.tmapi2.OccurrenceImpl)
-#   superize
-# end
+ module Java::OrgTmapiCore::Occurrence
+   register_java_implementation net.ontopia.topicmaps.impl.tmapi2.OccurrenceImpl
+ end
 
-# ther is nothing superized in variant
-# module Java::OrgTmapiCore::Variant
-#   include RTM::Variant
-#   JavaImplementations.add(self,net.ontopia.topicmaps.impl.tmapi2.VariantImpl)
-#   superize
-# end
+module Java::OrgTmapiCore::Variant
+  register_java_implementation net.ontopia.topicmaps.impl.tmapi2.VariantImpl
+end
 
 module Java::OrgTmapiCore::Role
-  include RTM::Role
-  JavaImplementations.add(self,net.ontopia.topicmaps.impl.tmapi2.RoleImpl)
-  superize
+  register_java_implementation net.ontopia.topicmaps.impl.tmapi2.RoleImpl
 end
 
 module Java::OrgTmapiCore::Scoped
-  include RTM::Scoped
-  JavaImplementations.add(self,net.ontopia.topicmaps.impl.tmapi2.ScopedImpl)
-  JavaImplementations.add(self,net.ontopia.topicmaps.impl.tmapi2.AssociationImpl)
-  JavaImplementations.add(self,net.ontopia.topicmaps.impl.tmapi2.NameImpl)
-  JavaImplementations.add(self,net.ontopia.topicmaps.impl.tmapi2.OccurrenceImpl)
-  JavaImplementations.add(self,net.ontopia.topicmaps.impl.tmapi2.VariantImpl)
-  superize
+  register_java_implementation net.ontopia.topicmaps.impl.tmapi2.ScopedImpl
+  register_java_implementation net.ontopia.topicmaps.impl.tmapi2.AssociationImpl
+  register_java_implementation net.ontopia.topicmaps.impl.tmapi2.NameImpl
+  register_java_implementation net.ontopia.topicmaps.impl.tmapi2.OccurrenceImpl
+  register_java_implementation net.ontopia.topicmaps.impl.tmapi2.VariantImpl
 end
 
 module Java::OrgTmapiCore::Typed
-  include RTM::Typed
-  JavaImplementations.add(self,net.ontopia.topicmaps.impl.tmapi2.AssociationImpl)
-  JavaImplementations.add(self,net.ontopia.topicmaps.impl.tmapi2.NameImpl)
-  JavaImplementations.add(self,net.ontopia.topicmaps.impl.tmapi2.OccurrenceImpl)
-  JavaImplementations.add(self,net.ontopia.topicmaps.impl.tmapi2.RoleImpl)
-  superize
+  register_java_implementation net.ontopia.topicmaps.impl.tmapi2.AssociationImpl
+  register_java_implementation net.ontopia.topicmaps.impl.tmapi2.NameImpl
+  register_java_implementation net.ontopia.topicmaps.impl.tmapi2.OccurrenceImpl
+  register_java_implementation net.ontopia.topicmaps.impl.tmapi2.RoleImpl
 end
 
 module Java::OrgTmapiCore::Construct
-  include RTM::Construct
-  JavaImplementations.add(self,net.ontopia.topicmaps.impl.tmapi2.ConstructImpl)
-  JavaImplementations.add(self,net.ontopia.topicmaps.impl.tmapi2.TopicMapImpl)
-  JavaImplementations.add(self,net.ontopia.topicmaps.impl.tmapi2.TopicImpl)
-  JavaImplementations.add(self,net.ontopia.topicmaps.impl.tmapi2.AssociationImpl)
-  JavaImplementations.add(self,net.ontopia.topicmaps.impl.tmapi2.NameImpl)
-  JavaImplementations.add(self,net.ontopia.topicmaps.impl.tmapi2.OccurrenceImpl)
-  JavaImplementations.add(self,net.ontopia.topicmaps.impl.tmapi2.VariantImpl)
-  JavaImplementations.add(self,net.ontopia.topicmaps.impl.tmapi2.RoleImpl)
-  superize
+  register_java_implementation net.ontopia.topicmaps.impl.tmapi2.ConstructImpl
+  register_java_implementation net.ontopia.topicmaps.impl.tmapi2.TopicMapImpl
+  register_java_implementation net.ontopia.topicmaps.impl.tmapi2.TopicImpl
+  register_java_implementation net.ontopia.topicmaps.impl.tmapi2.AssociationImpl
+  register_java_implementation net.ontopia.topicmaps.impl.tmapi2.NameImpl
+  register_java_implementation net.ontopia.topicmaps.impl.tmapi2.OccurrenceImpl
+  register_java_implementation net.ontopia.topicmaps.impl.tmapi2.VariantImpl
+  register_java_implementation net.ontopia.topicmaps.impl.tmapi2.RoleImpl
 end
 
 module Java::OrgTmapiCore::Reifiable
-  include RTM::Reifiable
-  JavaImplementations.add(self,net.ontopia.topicmaps.impl.tmapi2.ReifiableImpl)
-  superize
+  register_java_implementation net.ontopia.topicmaps.impl.tmapi2.ReifiableImpl
 end
 
 module Java::OrgTmapiCore::Locator    
-  include RTM::Locator
-  JavaImplementations.add(self,net.ontopia.topicmaps.impl.tmapi2.LocatorImpl)
-  superize
+  register_java_implementation net.ontopia.topicmaps.impl.tmapi2.LocatorImpl
+end
+
+module Java::OrgTmapiCore::DatatypeAware
+  register_java_implementation net.ontopia.topicmaps.impl.tmapi2.DatatypeAwareImpl
+  register_java_implementation net.ontopia.topicmaps.impl.tmapi2.VariantImpl
+  register_java_implementation net.ontopia.topicmaps.impl.tmapi2.OccurrenceImpl
 end

data/lib/rtm/ontopia/io/to_cxtm.rb

@@ -10,13 +10,28 @@ module RTM::IO
   
   module Ontopia
     module TopicMap
-      def to_cxtm(filename, base_iri = nil)
+      def to_cxtm(file=nil)
         raise("Only supported for Ontopia.") unless self.kind_of?(net.ontopia.topicmaps.impl.tmapi2.TopicMapImpl)
-        out_file = java.io.FileOutputStream.new(filename) 
-        writer = net.ontopia.topicmaps.xml.CanonicalXTMWriter.new(out_file)
+        if file
+          if file.is_a?(java.io.OutputStream)
+            out_stream = file
+          else
+            out_stream = java.io.BufferedOutputStream.new(java.io.FileOutputStream.new(file))
+          end
+        else
+          # if no file was given we want to return a string which will be written into a stream by the writer
+          out_stream = java.io.ByteArrayOutputStream.new
+        end
+
+        writer = net.ontopia.topicmaps.xml.CanonicalXTMWriter.new(out_stream)
         writer.write(self.wrapped)
-        out_file.flush
-        out_file.close      
+        out_stream.flush
+
+        # close the file unless we were provided with a stream
+        out_stream.close unless file && file.is_a?(java.io.OutputStream)
+
+        # if there was no file, we have a ByteArrayOutputStream. Get the String out of it (and return it)
+        out_stream.to_s unless file
       end
     end
     

data/lib/rtm/ontopia/rdbms/properties.rb

@@ -0,0 +1,148 @@
+module RTM::Ontopia::Rdbms
+
+  module Properties
+    def self.rails2ontopia(config)
+      ontopia_properties = {}
+      ontopia_prefix = "net.ontopia.topicmaps."
+      ontopia_properties["#{ontopia_prefix}store"] = config[:store] || "rdbms"
+      ontopia_rdbms_prefix = "#{ontopia_prefix}impl.rdbms."
+
+      adapter = config[:adapter].sub(/^jdbc/, '')
+
+      adapter_config = "#{adapter}_config".to_s
+      config = DatabaseDefaults.send(adapter_config, config) if DatabaseDefaults.respond_to?(adapter_config)
+
+      ontopia_properties["#{ontopia_rdbms_prefix}Database"] = adapter
+      ontopia_properties["#{ontopia_rdbms_prefix}DriverClass"] = config[:driver]
+      ontopia_properties["#{ontopia_rdbms_prefix}ConnectionString"] = config[:url]
+      ontopia_properties["#{ontopia_rdbms_prefix}UserName"] = config[:username] || "sa"
+      ontopia_properties["#{ontopia_rdbms_prefix}Password"] = config[:password] || ""
+      ontopia_properties["#{ontopia_rdbms_prefix}ConnectionPool"] = true
+      ontopia_properties["#{ontopia_rdbms_prefix}BatchUpdates"] = true
+      ontopia_properties["#{ontopia_rdbms_prefix}StorePool.MinimumSize"] = 2
+
+      ontopia_properties
+    end
+
+    # The defaults for database connections here were extracted from the *_connection methods from
+    # activerecord-jdbc-adapter-0.9.2.
+    # They had to be copied here because we don't want to establish connections here.
+    # The definitions where slightly extended, e.g. the host is optional and defaults to localhost.
+    module DatabaseDefaults
+      # enhances a config hash using the defaults for cachedb
+      def cachedb_config(config)
+        config[:host] ||= "localhost"
+        config[:port] ||= 1972
+        config[:url] ||= "jdbc:Cache://#{config[:host]}:#{config[:port]}/#{config[:database]}"
+        config[:driver] ||= "com.intersys.jdbc.CacheDriver"
+        config
+      end
+
+      # enhances a config hash using the defaults for db2
+      def db2_config(config)
+        config[:adapter] ||= "jdbc"
+        config[:driver] ||= "com.ibm.db2.jcc.DB2Driver"
+        config[:url] ||= "jdbc:db2:#{config[:database]}"
+        config
+      end
+
+      # enhances a config hash using the defaults for derby
+      def derby_config(config)
+        config[:url] ||= "jdbc:derby:#{config[:database]};create=true"
+        config[:driver] ||= "org.apache.derby.jdbc.EmbeddedDriver"
+        config
+      end
+
+      # enhances a config hash using the defaults for hsqldb
+      def hsqldb_config(config)
+        config[:url] ||= "jdbc:hsqldb:#{config[:database]}" # Ontopia adds ";MVCC=true"
+        config[:driver] ||= "org.hsqldb.jdbcDriver"
+        config
+      end
+
+      # enhances a config hash using the defaults for h2
+      def h2_config(config)
+        config[:url] ||= "jdbc:h2:#{config[:database]}"
+        config[:url] << config[:h2_params] if config[:h2_params]
+        config[:driver] ||= "org.h2.Driver"
+        config
+      end
+
+      # enhances a config hash using the defaults for informix
+      def informix_config(config)
+        config[:host] ||= "localhost"
+        config[:servername] ||= config[:host]
+        config[:port] ||= 9088
+        config[:url] ||= "jdbc:informix-sqli://#{config[:host]}:#{config[:port]}/#{config[:database]}:INFORMIXSERVER=#{config[:servername]}"
+        config[:driver] = 'com.informix.jdbc.IfxDriver'
+        config
+      end
+
+      # enhances a config hash using the defaults for mysql
+      def mssql_config(config)
+        config[:host] ||= "localhost"
+        config[:adapter] ||= "jdbc" # Ontopia example: sqlserver
+        config[:url] ||= "jdbc:jtds:sqlserver://localhost:1433/weblog_development" # Ontopia example: jdbcspy:jdbc:sqlserver://127.0.0.1\\ONTOPIA;databaseName=topicmaps;lockTimeout=60000
+        config[:driver] ||= 'net.sourceforge.jtds.jdbc.Driver' # Ontopia example: com.microsoft.sqlserver.jdbc.SQLServerDriver
+        config
+      end
+      alias :sqlserver_config :mssql_config
+
+      # enhances a config hash using the defaults for mysql
+      def mysql_config(config)
+        config[:host] ||= "localhost"
+        config[:port] ||= 3306
+        config[:encoding] ||= 'utf8'
+        url_options = "zeroDateTimeBehavior=convertToNull&jdbcCompliantTruncation=false&useUnicode=true&characterEncoding=#{config[:encoding]}"
+        if config[:url]
+          config[:url] = config[:url]['?'] ? "#{config[:url]}&#{url_options}" : "#{config[:url]}?#{url_options}"
+        else
+          config[:url] = "jdbc:mysql://#{config[:host]}:#{config[:port]}/#{config[:database]}?#{url_options}"
+        end
+        config[:driver] = "com.mysql.jdbc.Driver"
+        config
+      end
+
+      # enhances a config hash using the defaults for oracle
+      def oracle_config(config)
+        config[:host] ||= "localhost"
+        config[:port] ||= 1521
+        config[:url] ||= "jdbc:oracle:thin:@#{config[:host]}:#{config[:port]}:#{config[:database]}"
+        config[:driver] ||= "oracle.jdbc.driver.OracleDriver"
+        config
+      end
+      alias :oracle8_config :oracle_config
+      alias :oracle9i_config :oracle_config
+      alias :oracle10g_config :oracle_config
+
+      # enhances a config hash using the defaults for postgresql
+      def postgresql_config(config)
+        config[:host] ||= "localhost"
+        config[:port] ||= 5432
+        config[:url] ||= "jdbc:postgresql://#{config[:host]}:#{config[:port]}/#{config[:database]}"
+        config[:url] << config[:pg_params] if config[:pg_params]
+        config[:driver] ||= "org.postgresql.Driver"
+        config
+      end
+
+      # enhances a config hash using the defaults for sqlite3
+      def sqlite3_config(config)
+        config[:database] ||= config[:dbfile]
+
+        # Allow database path relative to RAILS_ROOT, but only if
+        # the database path is not the special path that tells
+        # Sqlite to build a database only in memory.
+        if Object.const_defined?(:RAILS_ROOT) && ':memory:' != config[:database]
+          config[:database] = File.expand_path(config[:database], RAILS_ROOT)
+        end
+
+        config[:url] ||= "jdbc:sqlite:#{config[:database]}"
+        config[:driver] ||= "org.sqlite.JDBC"
+        config
+      end
+
+      # Make all instance methods also available as module methods
+      extend self
+    end
+  end
+end

data/res/rdbms/config/db.h2.props

@@ -0,0 +1,8 @@
+net.ontopia.topicmaps.impl.rdbms.Database=h2
+net.ontopia.topicmaps.impl.rdbms.ConnectionString=jdbc:h2:/tmp/test2;MVCC=true
+net.ontopia.topicmaps.impl.rdbms.DriverClass=org.h2.Driver
+
+net.ontopia.topicmaps.impl.rdbms.UserName=sa
+net.ontopia.topicmaps.impl.rdbms.Password=
+
+net.ontopia.topicmaps.impl.rdbms.ConnectionPool=true

data/res/rdbms/config/db.mysql.props

@@ -0,0 +1,8 @@
+net.ontopia.topicmaps.impl.rdbms.Database=mysql
+net.ontopia.topicmaps.impl.rdbms.ConnectionString=jdbc:mysql://localhost/topicmaps?useUnicode=yes&characterEncoding=utf8&relaxAutoCommit=true
+net.ontopia.topicmaps.impl.rdbms.DriverClass=com.mysql.jdbc.Driver
+
+net.ontopia.topicmaps.impl.rdbms.UserName=foo
+net.ontopia.topicmaps.impl.rdbms.Password=bar
+
+net.ontopia.topicmaps.impl.rdbms.ConnectionPool=true

data/res/rdbms/config/db.oracle8.props

@@ -0,0 +1,8 @@
+net.ontopia.topicmaps.impl.rdbms.Database=oracle8
+net.ontopia.topicmaps.impl.rdbms.ConnectionString=jdbc:oracle:thin:@127.0.0.1:1521:TOPICMAPS
+net.ontopia.topicmaps.impl.rdbms.DriverClass=oracle.jdbc.driver.OracleDriver
+
+net.ontopia.topicmaps.impl.rdbms.UserName=foo
+net.ontopia.topicmaps.impl.rdbms.Password=bar
+
+net.ontopia.topicmaps.impl.rdbms.ConnectionPool=true