rtm 0.2.1 → 0.3.0

data/README

@@ -34,6 +34,6 @@ The Topic Maps Data Model which is used in this implementation can be found on h
 * rtm-tmql: Adds support for the Topic Maps Query Language (TMQL), http://isotopicmaps.org/tmql/
 * rtm-tmcl: Adds support for the Topic Maps Constraint Language (TMCL), http://isotopicmaps.org/tmcl/
 
-==== License 
+==== License
 Copyright 2009 Topic Maps Lab, University of Leipzig.
 Apache License, Version 2.0

data/lib/rtm.rb

@@ -12,123 +12,51 @@
 $LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__))
 
 module RTM
-  module Topic
-  end
+  module Topic; end
 
-  module Association
-  end
+  module Association; end
 
-  module Occurrence
-  end
+  module Occurrence; end
 
-  module Reifiable
-  end
+  module Reifiable; end
 
-  module Name
-  end
+  module Name; end
 
-  module Role
-  end
+  module Role; end
 
-  module Scoped
-  end
+  module Scoped; end
 
-  module Typed
-  end
+  module Typed; end
 
-  module Variant
-  end
+  module Variant; end
 
-  module Locator
-  end
+  module Locator; end
 
-  module Construct
-  end
+  module Construct; end
 
-  module Reifiable
-  end
+  module Reifiable; end
 
   module TopicMap
     attr_accessor :engine
   end
 
-  module TopicMapSystem
-  end
+  module TopicMapSystem; end
 
-  module ItemIdentifier
-  end
+  module ItemIdentifier; end
 
-  module SubjectIdentifier
-  end
+  module SubjectIdentifier; end
 
-  module SubjectLocator
-  end
+  module SubjectLocator; end
 
-  module DatatypeAware
-  end
+  module DatatypeAware; end
 end
 
 require 'rtm/version'
 require 'rtm/extensions'
-require "rtm/engine"
+require 'rtm/engine'
+require 'rtm/connection'
 require 'rtm/psi'
-require "rtm/navigation"
-require "rtm/axes"
-require "rtm/sugar"
-require "rtm/io"
-
-module RTM
-  # Connects to a topic map engine.
-  # The optional parameter can be used to
-  # select the backend.
-  #
-  # :call-seq:
-  #   RTM.connect(:implementation => :ontopia)            -> Ontopia backend
-  #   RTM.connect(:implementation => :tinytim)            -> tinyTim backend
-  #   RTM.connect(:implementation => :activerecord)       -> Active Record backend
-  #   RTM.connect(:implementation => :sesametm)           -> SesameTM backend
-  #   RTM.connect(:implementation => :merged)             -> Merged TMAPI backend
-  #
-  def self.connect(params = {}, *args)
-    engine = Engine.load!(params[:implementation])
-    connection = engine.new(params)
-    add_connection(connection)
-    connection
-  end
-
-  # Returns all connections grouped by their backend
-  #
-  # :call-seq:
-  #   connections -> Hash
-  #
-  def self.connections
-    @connections ||= Hash.new{|h,k| h[k] = []}
-    @connections
-  end
-
-  # Returns all connections. The optional argument may specify the backend
-  # the connections should use.
-  #
-  # :call-seq:
-  #   [] -> all connections as Hash
-  #   [:tinytim] -> all connections using TinyTiM
-  #   [:ontopia] -> all connections using Ontopia
-  #   [:sesame] -> all connections using SesameTM
-  #   [:activerecord] -> all connectioms using RTM AR
-  #
-  def self.[](args = nil)
-      return @connections[args] if args
-      connections
-  end
-
-  def self.included(klass)
-    @@meine_implementierungen ||= []
-    @@meine_implementierungen << klass
-    self.included_modules.each {|im| klass.extend(im)}
-  end
-
-  private
-  def self.add_connection(connection)
-    self.connections[connection.class.identifier] << connection
-  end
-end
+require 'rtm/navigation'
+require 'rtm/axes'
+require 'rtm/sugar'
+require 'rtm/io'

data/lib/rtm/connection.rb

@@ -0,0 +1,51 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+module RTM
+  module Connections
+    # Connects to a topic map engine using the specificed backend and configuration
+    #
+    # @example Connect to Ontopia backend (in memory)
+    #   RTM.connect(:backend => :ontopia)
+    # @example Connect to Ontopia backend (relational database), here: using the H2 adapter
+    #   RTM.connect(:backend => :ontopia_rdbms, :config => { :adapter => 'jdbch2', :database => "db-rtm-ontopia"})
+    # @example Connect to tinyTim backend (in memory)
+    #   RTM.connect(:backend => :tinytim)
+    # @example Connect to Active Record backend (relational database)
+    #   RTM.connect(:backend => :activerecord)
+    # @example Connect to SesameTM backend
+    #   RTM.connect(:backend => :sesametm)
+    # @example Connect to Hatana backend (in memory, with different stores)
+    #   RTM.connect(:backend => :hatana)
+    # @param [Hash] params the options to create the connection with.
+    # @option params [Symbol] :backend (:ontopia) the backend
+    # @option params [Symbol] :implementation @deprecated use :backend instead
+    # @option params [Hash] :config (nil) the backend-specific configuration
+    # @return [Engine] The connection object
+    def connect(params = {}, *args)
+      params ||= {} # this is needed to handle passing nil
+      engine = Engine.load!(params[:backend] || params[:implementation])
+      connection = engine.connect(params)
+      connections[params[:identifier]] = connection if params[:identifier]
+      connection
+    end
+
+    # Return all connections or a particular connection.
+    # @overload connections
+    #   Returns all registered connections, keyed by their identifiers.
+    #   @return [Hash]
+    # @overload connections(identifier)
+    #   @param [Symbol] identifier of the registered connection
+    #   @return [Engine] the connection object
+    def connections(*args)
+      @connections ||= {}
+      if args.size > 0
+        @connections[*args]
+      else
+        @connections
+      end
+    end
+
+    RTM.extend(self)
+  end
+end

data/lib/rtm/engine.rb

@@ -9,12 +9,12 @@ module RTM
     def self.inherited(subclass)
       Engine.add(subclass) # this MUST be Engine and not self! Otherwise every intermediate class in the inheritance chain will have it's own list
     end
-    
+
     def self.add(engine)
       @engines ||= []
       @engines << engine
     end
-    
+
     def self.identifier(i=nil)
       if i
         # setter / declaration
@@ -24,31 +24,29 @@ module RTM
         @identifier
       end
     end
-    
+
     def self.all
       @engines ||= []
       @engines.reject!{|e| e.abstract?} # this needs to be done here because in the inherited hook the method is not yet available.
       @engines
     end
-    
+
     def self.list
       all.map{|e| e.identifier}
     end
-    
+
     def self.[](identifier)
       all.find {|e| e.identifier == identifier}
     end
-    
+
     def self.load(engine_name)
-      if Object.const_defined?("Gem") && rtmgem = Gem.loaded_specs["rtm"]
-        require "rtm/#{engine_name}"
-      else
-        engine_path = File.expand_path(File.join(File.dirname(__FILE__), "../../../rtm-#{engine_name}/lib"))
-        if File.directory?(engine_path)
-          $LOAD_PATH.unshift engine_path
-          require "rtm/#{engine_name}"
-        end
+      engine_gem_name = engine_name
+      engine_gem_name = engine_name.to_s.split("_").first if engine_gem_name.to_s =~ /_/
+      unless Object.const_defined?("Gem") && rtmgem = Gem.loaded_specs["rtm"]
+        engine_path = File.expand_path(File.join(File.dirname(__FILE__), "../../../rtm-#{engine_gem_name}/lib"))
+        $LOAD_PATH.unshift engine_path if File.directory?(engine_path)
       end
+      require "rtm/#{engine_gem_name}"
       self[engine_name]
     end
 
@@ -65,13 +63,11 @@ module RTM
       end
       engine || load(engine_name)
     end
-    
+
     def self.detect(preferred=nil)
       if preferred # return the users preference, if given
         implementation = preferred
-      elsif engine_name = ENV['RTM_IMPLEMENTATION'] # inspect system environment
-        implementation = engine_name.to_sym
-      elsif engine_name = ENV['RTM_ENGINE'] # inspect system environment (alternative)
+      elsif engine_name = ENV['RTM_BACKEND'] || ENV['RTM_IMPLEMENTATION'] || ENV['RTM_ENGINE'] # inspect system environment (several alternatives)
         implementation = engine_name.to_sym
       elsif implementation = self.list.first # check if one is already loaded
         warn("No engine implementation was specified for RTM.connect. Using the first already loaded engine (#{implementation.inspect}).")
@@ -91,11 +87,26 @@ module RTM
       end
     end
 
+    def self.connect(*args)
+      self.new(*args)
+    end
+
     attr_reader :connections
 
     def initialize(params={})
       @params = params
     end
 
+    # returns an identifier of the engine, e.g. :ontopia or :ontopia_rdbms
+    def identifier
+      self.class.identifier
+    end
+
+    # Check if everything is set up. This should be overwritten by backends
+    # which need special setup, like a database schema migration.
+    def check
+      true
+    end
+
   end
 end

data/lib/rtm/extensions.rb

@@ -50,13 +50,11 @@ module RTM
       # super
       # puts "[RTMEXT] including #{self} into #{klass} in #{caller(1).first}"
       register_implementation(klass)
-      klass.class_eval do
+      klass.class_eval <<-EOS
         def self.included(klass2)
-          # puts "[RTMIMPLEXT] #{self} was included into #{klass2} in #{caller(1).first}"
-          # self.ancestors.select {|anc| anc.respond_to?(:register_implementation)}.each{|anc| anc.register_implementation(klass2) }
           self.ancestors.find {|anc| anc.respond_to?(:register_implementation)}.register_implementation(klass2)
         end
-      end
+      EOS
     end
 
     # Register an implementation to this module.
@@ -65,7 +63,6 @@ module RTM
     # Due to Ruby's restrictions on calling protected methods from other modules extending the very same module Extendable,
     # this method must be public.
     def register_implementation(klass)
-      # super if self.class.superclass.respond_to?(:register_implementation)
       @implementations ||= []
       @implementations << klass
     end

data/lib/rtm/helpers/uri.rb

@@ -1,7 +1,7 @@
 # Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
 # License:   Apache License, Version 2.0
 
-module RTM::RTM
+module RTM
   def is_uri?(test)
    begin
     URI(test)

data/lib/rtm/io/tmapix_from.rb

@@ -49,7 +49,7 @@ module RTM::IO
       #   from_ltm(filename)
       #
       def from_ltm(*args)
-        from_anything(org.tmapix.io.LTMTopicMapReader, *args)
+        from_anything(Java::OrgTmapixIo::LTMTopicMapReader, *args)
       end
 
       # Reads a Topic Map from an CTM File
@@ -59,7 +59,7 @@ module RTM::IO
       #   from_ctm(filename)
       #
       def from_ctm(*args)
-        from_anything(org.tmapix.io.CTMTopicMapReader, *args)
+        from_anything(Java::OrgTmapixIo::CTMTopicMapReader, *args)
       end
 
       # Reads a JSON Topic Maps (JTM) File
@@ -70,7 +70,7 @@ module RTM::IO
       #
       def from_jtm(*args)
         # seems not to acceped all files that are found to be valid by the JTM validator
-        from_anything(org.tmapix.io.JTMTopicMapReader, *args)
+        from_anything(Java::OrgTmapixIo::JTMTopicMapReader, *args)
       end
 
       # Reads a Friendly Topic Maps XML (TM/XML) File
@@ -81,7 +81,7 @@ module RTM::IO
       #   from_tmxml(filename)
       #
       def from_tmxml(*args)
-        from_anything(org.tmapix.io.TMXMLTopicMapReader, *args)
+        from_anything(Java::OrgTmapixIo::TMXMLTopicMapReader, *args)
       end
 
       # Reads a XML Topic Maps (XTM) 1.0 File
@@ -91,7 +91,7 @@ module RTM::IO
       #   from_xtm10(filename)
       #
       def from_xtm10(*args)
-        from_anything(org.tmapix.io.XTM10TopicMapReader, *args)
+        from_anything(Java::OrgTmapixIo::XTM10TopicMapReader, *args)
       end
       alias :from_xtm1 :from_xtm10
 
@@ -114,7 +114,7 @@ module RTM::IO
       #   from_xtm(filename)
       #
       def from_xtm(*args)
-        from_anything(org.tmapix.io.XTMTopicMapReader, *args)
+        from_anything(Java::OrgTmapixIo::XTMTopicMapReader, *args)
       end
 
       # Reads a Notation3 (N3) File
@@ -128,7 +128,7 @@ module RTM::IO
       #
       def from_n3(filename, vocab)
         raise "Only supported for TMAPI backends!!" unless self.kind_of? Java::OrgTmapiCore::TopicMap
-        reader = org.tmapix.io.N3TopicMapReader.new self,  java.io.File.new(filename)
+        reader = Java::OrgTmapixIo::N3TopicMapReader.new self,  java.io.File.new(filename)
         reader.setMappingSource(java.io.File.new(vocab))
         reader.read
       end
@@ -144,7 +144,7 @@ module RTM::IO
       #
       def from_rdfxml(filename, vocab)
         raise "Only supported for TMAPI backends!!" unless self.kind_of? Java::OrgTmapiCore::TopicMap
-        reader = org.tmapix.io.RDFXMLTopicMapReader.new self,  java.io.File.new(filename)
+        reader = Java::OrgTmapixIo::RDFXMLTopicMapReader.new self,  java.io.File.new(filename)
         reader.setMappingSource(java.io.File.new(vocab))
         reader.read
       end

data/lib/rtm/io/tmapix_to.rb

@@ -99,7 +99,7 @@ module RTM::IO
       #   to_xtm20(file, base_iri)
       #
       def to_xtm20(*args)
-        to_anything(org.tmapix.io.XTM20TopicMapWriter, *args)
+        to_anything(Java::OrgTmapixIo::XTM20TopicMapWriter, *args)
       end
       alias :to_xtm :to_xtm20
       alias :to_xtm2 :to_xtm20
@@ -120,7 +120,7 @@ module RTM::IO
       #   to_xtm10(file, base_iri)
       #
       def to_xtm10(*args)
-        to_anything(org.tmapix.io.XTM10TopicMapWriter, *args)
+        to_anything(Java::OrgTmapixIo::XTM10TopicMapWriter, *args)
       end
       alias :to_xtm1 :to_xtm10
 
@@ -140,7 +140,7 @@ module RTM::IO
       #   to_jtm(file, base_iri)
       #
       def to_jtm(*args)
-        to_anything(org.tmapix.io.JTMTopicMapWriter, *args)
+        to_anything(Java::OrgTmapixIo::JTMTopicMapWriter, *args)
       end
       alias :to_json :to_jtm
 
@@ -160,7 +160,7 @@ module RTM::IO
       #   to_ltm(file, base_iri)
       #
       def to_ltm(*args)
-        to_anything(org.tmapix.io.LTMTopicMapWriter, *args)
+        to_anything(Java::OrgTmapixIo::LTMTopicMapWriter, *args)
       end
 
       # Serializes an RTM::TopicMap to TM/XML.
@@ -179,7 +179,7 @@ module RTM::IO
       #   to_tmxml(file, base_iri)
       #
       def to_tmxml(*args)
-        to_anything(org.tmapix.io.TMXMLTopicMapWriter, *args)
+        to_anything(Java::OrgTmapixIo::TMXMLTopicMapWriter, *args)
       end
 
       # Serializes an RTM::TopicMap to CTM.
@@ -215,7 +215,7 @@ module RTM::IO
         else
           args.push(default_params)
         end
-        to_anything(de.topicmapslab.ctm.writer.core.CTMTopicMapWriter, *args)
+        to_anything(Java::DeTopicmapslabCtmWriterCore::CTMTopicMapWriter, *args)
       end
     end
     RTM.register_extension(self)