rtm 0.1.6 → 0.2

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

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

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

@@ -0,0 +1,38 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+module RTM::Sugar
+  module Typed
+    module Types
+
+      # Returns the type of this typed construct
+      # (occurrence, role, association or name)
+      # as Array.
+      #
+      # :call-seq:
+      #   types -> Array of Topics
+      #
+      def types
+        Array.new(type)
+      end
+
+      # Returns the type and the transitive supertypes of this type
+      # of this typed construct (occurrence, role, association or name)
+      # as Array.
+      #
+      # :call-seq:
+      #   transitive_types -> Array of Topics
+      #
+      def transitive_types
+        sup_types = type.transitive_supertypes
+        if sup_types.empty?
+          sup_types = types
+        else
+          sup_types << type unless sup_types.include?(type)
+        end
+        return sup_types
+      end
+
+    end
+  end
+end

data/lib/rtm/validation.rb

@@ -1,3 +1,6 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
 module RTM
   module Validation
 
@@ -10,7 +13,7 @@ module RTM
       end
     end
 
-    module AssociationRole
+    module Role
       def valid?
         return false unless player
         return false unless type
@@ -37,7 +40,7 @@ module RTM
     module TopicMap
     end
 
-    module TopicName
+    module Name
     end
 
     module Variant
@@ -50,11 +53,11 @@ module RTM
         true
       end
     end
-    module TopicMapConstruct
+    module Construct
       def valid?
         true
       end
     end
-    RTM.register_extension( self )
+    RTM.register_extension(self)
   end
 end

data/lib/rtm/version.rb

@@ -0,0 +1,30 @@
+module RTM # :nodoc:
+  module VERSION # :nodoc:
+    unless self.const_defined?("MAJOR")
+      require 'date'
+      if Object.const_defined?("Gem") && rtmgem = Gem.loaded_specs["rtm"]
+        # 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
+      end
+      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
+      BUILD  = ENV['BUILD_NUMBER'] || COMPACTDATE
+
+      STRING = [MAJOR, MINOR, TINY].compact.join('.')
+
+      SUMMARY = "rtm #{STRING}"
+    end
+  end
+end

data/spec/helpers/spec_exampleexamplegroup.rb

@@ -0,0 +1,14 @@
+class Spec::Example::ExampleGroup
+  
+  def be_a_kind_of(expected)
+    Matcher.new :be_a_kind_of, expected do |_expected_|
+      match do |actual|
+        # actual.kind_of?(_expected_)
+        ot = _expected_.methods(true).map {|m|  _expected_.method(m) }
+        at = actual.class.methods(true).map {|m|  actual.class.method(m) }
+        at.select {|m| !ot.include? m }.empty?
+      end
+    end
+  end
+  
+end

data/spec/rtm/axes/association_spec.rb

@@ -0,0 +1,88 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+module RTM::Axes
+  class Association < ItemProxy
+    describe self do
+      before(:all) do
+        @tm = get_used_tm_sys_tm
+        @topic = @tm.get!("person")
+        @assoc = @tm.create_association("assoc_type")
+        @proxy = @assoc.axes
+      end
+      after(:all) do
+       @tm.close
+      end
+      it "should be allowed to call #tmapi and #result on a RTM::Axes::Association" do
+        @proxy.methods.should include("tmapi")
+        @proxy.methods.should include("result")
+      end
+      it "should be allowed to call #players on a RTM::Axes::Association" do
+        @proxy.methods.should include("players")
+      end
+      it "should be allowed to call #reverse_reifier on a RTM::Axes::Association" do
+        @proxy.methods.should include("reverse_reifier")
+      end
+      it "should be allowed to call #roles on a RTM::Axes::Association" do
+        @proxy.methods.should include("roles")
+      end
+      it "should be allowed to call #scope on a RTM::Axes::Association" do
+        @proxy.methods.should include("scope")
+      end
+      it "should be allowed to call #reverse_traverse on a RTM::Axes::Association" do
+        pending "should not" do 
+          @proxy.methods.should include("reverse_traverse")
+        end
+      end
+     
+      describe "#new" do
+        it "should raise an error if the underlying construct is not an Association" do
+          lambda{RTM::Axes::Association.new(1,@tm)}.should raise_error 
+        end
+        it "should not raise an error if the underlying construct is an Association" do
+          lambda{RTM::Axes::Association.new(@assoc,@tm)}.should_not raise_error 
+        end
+      end
+     
+      describe "#players" do
+        
+      end
+     
+      describe "#reverse_reifier" do
+        
+      end
+     
+      describe "#roles" do
+        #      it "should give back an empty set if the association has no roles" do
+#        a_asso = @tm.create_association("asso_type")
+#        a_asso.roles.should be_empty
+#      end
+#      it "should give back the role types of the association" do
+#        a_asso = @tm.create_association("asso_type")
+#        a_asso["a_role_type"] = "to_a_noter_topic"
+#        a_asso.roles_tta.size.should == 1
+#        a_asso["another_role_type"] = "to_another_noter_topic"
+#        a_asso.roles_tta.size.should == 2
+#        a_asso.roles_tta.include?(@tm.get("a_role_type")).should == true
+#        a_asso.roles_tta.include?(@tm.get("another_role_type")).should == true
+#      end
+#      it "should give back multiple roll-typing topics if the the same role type is used multiple times" do
+#        a_asso = @tm.create_association("asso_type")
+#        a_asso["a_role_type"] = "to_a_noter_topic"
+#        a_asso.roles_tta.size.should == 1
+#        a_asso["a_role_type"] = "to_another_noter_topic"
+#        a_asso.roles_tta.size.should == 2
+#        a_asso.roles_tta.include?(@tm.get("a_role_type")).should == true
+#        a_asso.roles_tta.select {|t| t == @tm.get("a_role_type")}.size.should == 2
+#      end
+      end
+     
+      describe "#scope" do
+        
+      end
+     
+    end
+  end
+end

data/spec/rtm/axes/associations_spec.rb

@@ -0,0 +1,60 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+module RTM::Axes
+  module Associations
+    describe self do
+      before(:all) do
+        @tm = get_used_tm_sys_tm
+        @assoc1 = @tm.create_association("assoc_type_1")
+        @assoc2 = @tm.create_association("assoc_type_2")
+        @proxy = [@assoc1.axes,@assoc2.axes].extend(Associations) 
+      end
+      after(:all) do
+        @tm.close
+      end
+    
+      it "should be allowed to call #tmapi and #result on an Associations-Array" do
+        @proxy.methods.should include("tmapi")
+        @proxy.methods.should include("result")
+      end
+      it "should be allowed to call #players on an Associations-Array" do
+        @proxy.methods.should include("players")
+      end
+      it "should be allowed to call #reverse_reifier on an Associations-Array" do
+        @proxy.methods.should include("reverse_reifier")
+      end
+      it "should be allowed to call #roles on an Associations-Array" do
+        @proxy.methods.should include("roles")
+      end
+      it "should be allowed to call #scope on an Associations-Array" do
+        @proxy.methods.should include("scope")
+      end
+      it "should be allowed to call #reverse_traverse on an Associations-Array" do
+        pending "should not" do 
+          @proxy.methods.should include("reverse_traverse")
+        end
+      end
+    
+      describe "#players" do
+        
+      end
+     
+      describe "#reverse_reifier" do
+        
+      end
+     
+      describe "#roles" do
+        
+      end
+     
+      describe "#scope" do
+        
+      end
+    
+    end
+  end
+end
+

data/spec/rtm/axes/assocs_names_occs_spec.rb

@@ -0,0 +1,9 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+module RTM::Axes
+  module AssocsNamesOccs
+end
+end

data/spec/rtm/axes/characteristic_spec.rb

@@ -0,0 +1,90 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+module RTM::Axes
+  class Characteristic < ItemProxy
+    describe self do
+      before(:all) do
+        @tm = get_used_tm_sys_tm
+        @topic = @tm.get!("person")
+        @name_value = "Hans"
+        @occ_value = "18"
+        @name = @topic.create_name(@name_value)
+        @occ = @topic.create_occurrence("Age", @occ_value)
+        @name_proxy = @name.axes
+        @occ_proxy = @occ.axes
+      end
+      after(:all) do
+       @tm.close
+      end
+      it "should be allowed to call #tmapi and #result on a RTM::TQML::Name" do
+      @name_proxy.methods.should include("tmapi")
+      @name_proxy.methods.should include("result")
+      end
+      it "should be allowed to call #atomify on a RTM::TQML::Name" do
+        @name_proxy.methods.should include("atomify")
+      end
+      it "should be allowed to call #reverse_characteristics on a RTM::TQML::Name" do
+        @name_proxy.methods.should include("reverse_characteristics")
+      end
+      it "should be allowed to call #reverse_reifier on a RTM::TQML::Name" do
+        @name_proxy.methods.should include("reverse_reifier")
+      end
+      it "should be allowed to call #scope on a RTM::TQML::Name" do
+        @name_proxy.methods.should include("scope")
+      end
+      it "should be allowed to call #tmapi and #result on a RTM::TQML::Occurrence" do
+        @occ_proxy.methods.should include("tmapi")
+        @occ_proxy.methods.should include("result")
+      end
+      it "should be allowed to call #atomify on a RTM::TQML::Occurrence" do
+        @occ_proxy.methods.should include("atomify")
+      end
+      it "should be allowed to call #reverse_characteristics on a RTM::TQML::Occurrence" do
+        @occ_proxy.methods.should include("reverse_characteristics")
+      end
+      it "should be allowed to call #reverse_reifier on a RTM::TQML::Occurrence" do
+        @occ_proxy.methods.should include("reverse_reifier")
+      end
+      it "should be allowed to call #scope on a RTM::TQML::Occurrence" do
+        @occ_proxy.methods.should include("scope")
+      end
+      
+      describe "#new" do
+        it "should raise an error if the underlying construct is not a RTM::Name or RTM::Occurrence" do
+          lambda{RTM::Axes::Name.new(1,@tm)}.should raise_error
+          lambda{RTM::Axes::Occurrence.new(1,@tm)}.should raise_error
+        end
+        it "should not raise an error if the underlying construct is a RTM::Name or RTM::Occurrence" do
+          lambda{RTM::Axes::Name.new(@name,@tm)}.should_not raise_error
+          lambda{RTM::Axes::Occurrence.new(@occ,@tm)}.should_not raise_error
+        end
+      end
+      
+      describe "#atomify" do
+        it "should give back a RTM::Axes::String" do
+          @name_proxy.atomify.should be_a_kind_of RTM::Axes::String
+          @occ_proxy.atomify.should be_a_kind_of RTM::Axes::String
+        end
+        it "should give back the values" do
+          @name_proxy.atomify.construct.should == @name_value
+          @occ_proxy.atomify.construct.should == @occ_value
+        end
+      end
+      
+      describe "#reverse_characteristics" do
+        it "should give back a RTM::Axes::Topic" do
+          @name_proxy.reverse_characteristics.should be_a_kind_of(RTM::Axes::Topic)
+          @occ_proxy.reverse_characteristics.should be_a_kind_of(RTM::Axes::Topic)
+        end
+        it "should give back the righ Topic" do
+          @name_proxy.reverse_characteristics.construct.should == @topic
+          @occ_proxy.reverse_characteristics.construct.should == @topic
+        end
+      end
+      
+    end
+  end
+end

data/spec/rtm/axes/characteristics_spec.rb

@@ -0,0 +1,85 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+module RTM::Axes
+  module Characteristics
+    describe self do
+      before(:all) do
+        @tm = get_used_tm_sys_tm
+        @name_value = "Hans"
+        @occ_value = "18"
+        @topic1 = @tm.get!("Person1")
+        @topic2 = @tm.get!("Person2")
+        @topic3 = @tm.get!("Person3")
+        @name1 = @topic1.create_name(@name_value)
+        @name2 = @topic2.create_name("Peter")
+        @name3 = @topic3.create_name(@name_value)
+        @occ1 = @topic1.create_occurrence("Number", @occ_value)
+        @occ2 = @topic2.create_occurrence("Age",  @occ_value)
+        @occ3 = @topic3.create_occurrence("Friend", @name_value)
+        
+        @proxy = [@name1.axes,@name3.axes,@occ1.axes,@occ2.axes,@occ3.axes].extend(Characteristics)
+      end
+      after(:all) do
+        @tm.close
+      end
+      
+      it "should be allowed to call #tmapi and #result on a RTM::Axes::Characteristics" do
+        @proxy.methods.should include("tmapi")
+        @proxy.methods.should include("result")
+      end
+      it "should be allowed to call #atomify on a RTM::Axes::Characteristics" do
+        @proxy.methods.should include("atomify")
+      end
+      it "should be allowed to call #reverse_characteristics on a RTM::Axes::Characteristics" do
+        @proxy.methods.should include("reverse_characteristics")
+      end
+      it "should be allowed to call #reverse_reifier on a RTM::Axes::Characteristics" do
+        @proxy.methods.should include("reverse_reifier")
+      end
+      it "should be allowed to call #scope on a RTM::Axes::Characteristics" do
+        @proxy.methods.should include("scope")
+      end
+      
+      describe "#atomify" do
+        it "should give back an Array" do
+          @proxy.atomify.should be_a_kind_of Array
+        end
+        it "should give back an Array consisting of RTM::Axes::String" do
+          @proxy.atomify.first.should be_a_kind_of RTM::Axes::String
+        end
+        it "should give back RTM::TQML::Strings" do
+          @proxy.atomify.should be_a_kind_of RTM::Axes::Strings
+        end
+        it "should give back the values" do
+          @proxy.atomify.size.should == 5
+          @proxy.atomify.map{|res| res.construct}.should include(@name_value)
+          @proxy.atomify.map{|res| res.construct}.should include(@occ_value)
+        end     
+      end
+      
+      describe "#reverse_characteristics" do
+        it "should give back an Array" do
+          @proxy.reverse_characteristics.should be_a_kind_of Array
+        end
+        it "should give back an Array consisting of RTM::Axes::Topic" do
+          @proxy.reverse_characteristics.first.should be_a_kind_of(RTM::Axes::Topic)
+        end
+        it "should give back a RTM::Axes::Topics" do
+          @proxy.reverse_characteristics.should be_a_kind_of RTM::Axes::Topics
+        end
+        it "should give back the right Topics" do
+          @proxy.reverse_characteristics.size.should == 3 #unique
+          @proxy.reverse_characteristics.map{|res| res.construct}.should include(@topic1)
+           @proxy.reverse_characteristics.map{|res| res.construct}.should include(@topic2)
+            @proxy.reverse_characteristics.map{|res| res.construct}.should include(@topic3)
+          @proxy.reverse_characteristics("Number").size.should == 1
+          @proxy.reverse_characteristics("Number").map{|res| res.construct}.should include(@topic1)
+        end     
+      end
+      
+    end
+  end
+end