rtm 0.2.1 → 0.3.0

data/lib/rtm/sugar/topic_map/remove.rb

@@ -0,0 +1,49 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+module RTM::Sugar::TopicMap
+  module Remove
+
+    # Removes all variants, names, occurrences, roles, asssociations and
+    # topics (esp. reifier) from this topic map.
+    def clear
+      set_reifier(nil)
+        
+      variants.to_a.each do |v|
+        v.set_reifier(nil)
+        v.remove
+      end
+               
+      names.to_a.each do |n|
+        n.set_reifier(nil)
+        n.remove
+      end
+        
+      occurrences.to_a.each do |o|
+        o.set_reifier(nil)
+        o.remove
+      end
+           
+      roles.to_a.each do |r|
+        r.set_reifier(nil)
+        r.remove
+      end
+             
+      associations.to_a.each do |a|
+        a.set_reifier(nil)
+        a.remove
+      end
+
+      types.to_a.each do |type|
+        type.instances.to_a.each do |instance|
+          instance.remove_type(type)
+        end
+      end
+
+      topics.to_a.each do |t|
+        t.remove
+      end
+
+    end
+  end
+end

data/lib/rtm/sugar/topic_map/{themes.rb → scoped.rb}

@@ -1,10 +1,9 @@
 # Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
 # License:   Apache License, Version 2.0
 
-
 module RTM::Sugar
   module TopicMap
-    module Themes
+    module Scoped
 
       # Returns all topics in the topic map used
       # in the scope property of Associations.
@@ -12,40 +11,40 @@ module RTM::Sugar
       # The result may be empty.
       #
       # :call-seq:
-      #   association_themes -> Array of Topics
+      #   association_themes -> Collection of Topics
       #
       def association_themes
-        scoped_index.get_association_themes.to_a
+        scoped_index.getAssociationThemes
       end
 
       # Returns all topics in the topic map used
       # in the scope property of Names.
       #
       # :call-seq:
-      #   name_themes -> Array of Topics
+      #   name_themes -> Collection of Topics
       #
       def name_themes
-        scoped_index.get_name_themes.to_a
+        scoped_index.getNameThemes
       end
 
       # Returns all topics in the topic map used
       # in the scope property of Occurrences.
       #
       # :call-seq:
-      #   occurrence_themes -> Array of Topics
+      #   occurrence_themes -> Collection of Topics
       #
       def occurrence_themes
-        scoped_index.get_occurrence_themes.to_a
+        scoped_index.getOccurrenceThemes
       end
 
       # Returns all topics in the topic map used
       # in the scope property of Variants.
       #
       # :call-seq:
-      #   variant_themes -> Array of Topics
+      #   variant_themes -> Collection of Topics
       #
       def variant_themes
-        scoped_index.get_variant_themes.to_a
+        scoped_index.getVariantThemes
       end
 
     end

data/lib/rtm/sugar/topic_map/types.rb

@@ -0,0 +1,50 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+module RTM::Sugar
+  module TopicMap
+    module Types
+
+      # Returns all topics in this topic map that are used
+      # as types of associations.
+      #
+      # :call-seq:
+      #   association_types -> Collection of Topics
+      #
+      def association_types
+        type_instance_index.getAssociationTypes
+      end
+
+      # Returns the all Topics in this TopicMap that are used
+      # as types of Roles.
+      #
+      # :call-seq:
+      #   role_types -> Collection of Topics
+      #
+      def role_types
+        type_instance_index.getRoleTypes
+      end
+
+      # Returns all Topics in this TopicMap that are used
+      # as types of Names.
+      #
+      # :call-seq:
+      #   name_types -> Collection of Topics
+      #
+      def name_types
+        type_instance_index.getNameTypes
+      end
+
+      # Returns all Topics in this TopicMap that are used
+      # as types of Occurrences.
+      #
+      # :call-seq:
+      #   occurrence_types -> Collection of Topics
+      #
+      def occurrence_types
+        type_instance_index.getOccurrenceTypes
+      end
+
+    end
+  end
+end

data/lib/rtm/sugar/variant/topic.rb

@@ -0,0 +1,17 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+module RTM::Sugar::Variant
+  module Topic
+
+    # Return the topic this variant belongs to.
+    #
+    # :call-seq:
+    #   topic -> Topic
+    #
+    def topic
+      return self.parent.parent
+    end
+
+  end
+end

data/lib/rtm/topology.rb

@@ -0,0 +1,134 @@
+module RTM
+
+  # Topology information about a Topic Map.
+  # This class provides some statistical and structural information about a topic map.
+  # All methods take an optional modifier OR block which specifies how a Topic Maps construct shall be transformed before it is returned.
+  # Some modifiers are defined in the sub module Modifier.
+  class Topology
+    # @return [RTM::TopicMap] The topic map this topology provides information about.
+    attr_reader :topic_map
+
+    def initialize(topic_map)
+      @topic_map = topic_map
+    end
+
+    # A list of constructs defined in TMDM which have a (single) type
+    SINGLE_TYPED_CONSTRUCTS = %w[name occurrence association role]
+
+    # A list of constructs defined in TMDM which may have multiple types
+    TYPED_CONSTRUCTS = ["topic"] + SINGLE_TYPED_CONSTRUCTS
+
+    # A list of constructs defined in TMDM which are scopeable
+    SCOPEABLE_CONSTRUCTS = %w[name variant occurrence association]
+
+    SINGLE_TYPED_CONSTRUCTS.each do |item|
+      # define_method "#{item}_types" do |modifier=nil, &block|
+      eval(<<-EOS)
+        def #{item}_types(modifier=nil, &block)
+          modifier ||= block || Modifier.default
+          @#{item}_types ||= Hash[@topic_map.#{item}_types.map{|i| [modifier.call(i), i.typed_#{item}s.size]}]
+        end
+        def #{item}_types_count(modifier=nil, &block)
+          @#{item}_types_count ||= @topic_map.#{item}_types.size
+        end
+      EOS
+    end
+
+    SCOPEABLE_CONSTRUCTS.each do |item|
+      eval(<<-EOS)
+        def #{item}_themes(modifier=nil, &block)
+          modifier ||= block || Modifier.default
+          @#{item}_themes ||= Hash[@topic_map.#{item}_themes.map{|i| [modifier.call(i), i.scoped_#{item}s.size]}]
+        end
+        def #{item}_themes_count(modifier=nil, &block)
+          @#{item}_themes_count ||= @topic_map.#{item}_themes.size
+        end
+      EOS
+    end
+
+
+    # The number of topics in this topic map
+    # @return [Number]
+    def topics_count(modifier=nil, &block)
+      @topic_map.topics.size
+    end
+
+    # The number of associations in this topic map
+    # @return [Number]
+    def associations_count(modifier=nil, &block)
+      @topic_map.associations.size
+    end
+
+    # The following are not available in RTM yet
+    # def names_count
+    #   @topic_map.names.size
+    # end
+    # def occurrences_count
+    #   @topic_map.occurrences.size
+    # end
+    # def variants_count
+    #   @topic_map.variants.size
+    # end
+
+    # All topology information in one step
+    # @return [Hash] with all topology information. Keys correspond to method names, values to their returned results.
+    def all(modifier=nil, &block)
+      modifier ||= block || Modifier.default
+      puts "modifier: #{modifier.inspect}"
+      ms = self.methods - Object.new.methods - %w[topic_map all]
+      Hash[ms.map {|m| [m, self.send(m, modifier)]}]
+    end
+
+    # String representation of all topology information
+    # @return [String] with all topology information
+    def to_s(modifier=nil, &block)
+      modifier ||= block || Modifier.best_name
+      all(modifier).sort_by{|k,v| k}.map {|k,v| "#{k}: #{v.inspect}"}.join("\n")
+    end
+
+
+    # Manages Modifiers which may be applied to Constructs (or only to Topics?!)
+    module Modifier
+      # The nop Modifier just returns the construct given as is: <code>{|x| x}</code>
+      #
+      # @return [#call] The nop Modifier which is a callable object which takes one argument and returns this argument.
+      def nop
+        Proc.new {|x| x}
+      end
+
+      # The best_name Modifier returns the best name for a Construct: <code>{|x| x.best_name}</code>
+      #
+      # @return [#call] The best_name Modifier returns a name suitable for human consumption
+      def best_name
+        Proc.new {|x| x.best_name}
+      end
+
+      # The reference Modifier returns a reference for a Construct: <code>{|x| x.reference}</code>
+      #
+      # @return [#call] The reference Modifier returns a name suitable for human consumption
+      def reference
+        Proc.new {|x| x.reference}
+      end
+
+      # Make all instance methods available as class methods, too.
+      extend self
+
+      # The default modifier is {#nop}
+      # @return [#call] the default modifier
+      attr_reader :default
+
+      # Set the default modifier
+      @default = nop
+    end
+
+    # The TopologyExtension for RTM::TopicMap adds an #topology method to a topic map which provides an overview over a topic map.
+    module TopologyExtension
+      # Topology information about this TopicMap.
+      # @return [Topology] an object which provides some topology information
+      def topology
+        RTM::Topology.new(self)
+      end
+      RTM::TopicMap.register_extension(self)
+    end
+  end
+end

data/lib/rtm/version.rb

@@ -6,22 +6,27 @@ module RTM # :nodoc:
         # Try to determine version from Gem, if we're loaded from there
         today = rtmgem.date
       elsif File.exist?(File.join(File.dirname(__FILE__), "../../../.hg"))
-        # Try to get the latest Mercurial commit date
-         hg_date_string = `hg --cwd "#{File.dirname(__FILE__)}" parent --template "{date|isodate}"`
-         today = Date.parse(hg_date_string)
-      else
-        # Fall back to current day
-        today = Date.today
+        begin
+          # Try to get the latest Mercurial commit date
+           hg_date_string = `hg --cwd "#{File.dirname(__FILE__)}" parent --template "{date|isodate}"`
+           today = Date.parse(hg_date_string)
+         rescue Exception => e
+           warn("We're running from Mercurial, but Mercurial binary 'hg' is not in system path (or something else with parsing version from hg went wront)")
+         end
       end
+      # Fall back to current day if not set before
+      today ||= Date.today
+
       DATE = [today.year, today.month, today.day]
       ISODATE = "%04d-%02d-%02d" % DATE # => "2010-01-26"
       COMPACTDATE = "%04d%02d%02d" % DATE # => "20100126"
 
       MAJOR  = 0
-      MINOR  = 2
-      TINY   = 1
+      MINOR  = 3
+      TINY   = 0
       BUILD  = ENV['BUILD_NUMBER'] || COMPACTDATE
 
+      #STRING = [MAJOR, MINOR, TINY, BUILD].compact.join('.')
       STRING = [MAJOR, MINOR, TINY].compact.join('.')
 
       SUMMARY = "rtm #{STRING}"

data/spec/rtm/engine_spec.rb

@@ -0,0 +1,45 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+require File.dirname(__FILE__) + '/../spec_helper'
+
+module RTM
+  class Engine
+
+    describe self do
+
+      describe "#identifier" do
+        before(:all) do
+          @connection = RTM.connect(:implementation => implementation_for_spec)
+          @tested = false
+        end
+        it "should return :ontopia if ontopia is used" do
+          if implementation_for_spec == :ontopia
+            @connection.identifier.should == :ontopia
+            @tested = true
+          elsif implementation_for_spec == :tinytim
+            @connection.identifier.should == :tinytim
+            @tested = true
+          elsif implementation_for_spec == :activerecord
+            @connection.identifier.should == :activerecord
+            @tested = true
+          elsif implementation_for_spec == :tm2jdbc
+            @connection.identifier.should == :tm2jdbc
+            @tested = true
+          elsif implementation_for_spec == :hatana
+            @connection.identifier.should == :hatana
+            @tested = true
+          elsif implementation_for_spec == :sesametm
+            @connection.identifier.should == :sesametm
+            @tested = true
+          else
+            # engine not found
+          end
+          @tested.should be_true
+        end
+      end
+
+    end  # of describe self
+
+  end
+end

data/spec/rtm/io/tmapix_from_spec.rb

@@ -14,31 +14,31 @@ module RTM::IO::TmapiXFrom::TopicMap
     end
 
     describe "#from_ltm" do
-      it "import into an empty topic map" do
+      it "should import into an empty topic map" do
         @tm.from_ltm(File.dirname(__FILE__) + "/../../resources/toyTM.ltm")
       end
     end
 
     describe "#from_ctm" do
-      it "import into an empty topic map" do
+      it "should import into an empty topic map" do
         @tm.from_ctm(File.dirname(__FILE__) + "/../../resources/toyTM.ctm")
       end
     end
 
     describe "#from_jtm" do
-      it "import into an empty topic map" do
+      it "should import into an empty topic map" do
         #@tm.from_jtm(File.dirname(__FILE__) + "/../../resources/toyTM.jtm")
       end
     end
 
     describe "#from_tmxml" do
-      it "import into an empty topic map" do
+      it "should import into an empty topic map" do
         #@tm.from_tmxml(File.dirname(__FILE__) + "/../../resources/toyTM.tmxml")
       end
     end
 
     describe "#from_xtm10" do
-      it "import into an empty topic map" do
+      it "should import into an empty topic map" do
         #@tm.from_xtm10(File.dirname(__FILE__) + "/../../resources/toyTM_xtm10.xtm")
       end
       it "should provide an alias for from_xtm1" do
@@ -47,7 +47,7 @@ module RTM::IO::TmapiXFrom::TopicMap
     end
 
     describe "#from_xtm20" do
-      it "import into an empty topic map" do
+      it "should import into an empty topic map" do
         @tm.from_xtm20(File.dirname(__FILE__) + "/../../resources/toyTM.xtm")
       end
       it "should provide an alias for from_xtm2" do
@@ -56,10 +56,10 @@ module RTM::IO::TmapiXFrom::TopicMap
     end
 
     describe "#from_xtm" do
-      it "import into an empty topic map from xtm v2.0" do
+      it "should import into an empty topic map from xtm v2.0" do
         @tm.from_xtm20(File.dirname(__FILE__) + "/../../resources/toyTM.xtm")
       end
-      it "import into an empty topic map from xtm v1.0" do
+      it "should import into an empty topic map from xtm v1.0" do
         #@tm.from_xtm10(File.dirname(__FILE__) + "/../../resources/toyTM_xtm10.xtm")
       end
     end