rtm 0.1.0 → 0.1.1

data/lib/activetopicmaps.rb

@@ -0,0 +1,229 @@
+require 'rtm'
+# Yep, this is the easter egg I told of on the website.
+# See the source code at the very end of this file for an explanation.
+# Pleace note, this is not beta code, not even alpha - it's just an experiment.
+
+module ActiveTopicMaps
+  class Base
+    def self.inherited(klass)
+      klass.send(:include, ActiveTopicMaps::Topic)
+    end
+  end
+
+  module Topic
+    def self.included(klass)
+      klass.extend(ClassMethods)
+    end
+    def initialize(topic)
+      @topic = topic
+    end
+    def topic;@topic;end
+
+    module ClassMethods
+      def acts_as_topic
+        self.class_eval <<-EOS
+          def method_missing(name, *args)
+            @topic.send(name, *args)
+          end
+          
+          alias atm_old_respond_to? respond_to?
+          def respond_to?(*args)
+            atm_old_respond_to?(*args) || @topic.respond_to?(*args)
+          end
+
+          alias old_methods methods
+          def methods
+            @methods ||= (old_methods + @topic.methods).uniq
+          end
+        EOS
+      end
+      
+#      def acts_smart
+#        self.class_eval <<-EOS
+#          alias atm_old_method_missing method_missing
+#          def method_missing(name, *args)
+#            if @topic.respond_to?(name)
+#              @topic.send(name, *args)
+#            else
+#              begin
+#                if name =~ /=$/
+#                  smart_setter(name, *args)
+#                else
+#                  smart_getter(name, *args)
+#                end
+#              rescue
+#                atm_old_method_missing(name, *args)
+#              end
+#            end
+#          end
+#
+#          def smart_getter(name, *args)
+#            val = instance_variable_set(("smart_prop_" + name.to_s).to_sym, smart_prop_name)
+#            prefix = ""
+#            smart_prop_name ||= (iname = @topic["#{prefix}#{name}"].first) ? iname.value : nil
+#            instance_variable_set(name, smart_prop_name)
+#          end
+#
+#          def smart_setter(name, *args)
+#
+#          end
+#          
+#          alias atm_old_respond_to? respond_to?
+#          def respond_to?(*args)
+#            atm_old_respond_to?(*args) || @topic.respond_to?(*args)
+#          end
+#          EOS
+#      end
+
+      def name(name, type="")
+        prop_getter(name, type, "-")
+        prop_setter(name, type, "-")
+      end
+
+      def occurrence(name, type=nil)
+        type ||= name
+        prop_getter(name, type)
+        prop_setter(name, type)
+      end
+
+      def prop_getter(name, type, prefix="")
+        self.class_eval <<-EOS
+        def #{name}
+          @#{name} ||= (iname = @topic["#{prefix}#{type}"].first) ? iname.value : nil
+        end
+        EOS
+      end
+
+      def prop_setter(name, type, prefix="")
+        self.class_eval <<-EOS
+        def #{name}=(name)
+          old = @topic["#{prefix}#{type}"].first
+          @#{name} = if old
+            old.value = name
+          else
+            @topic["#{prefix}#{type}"] = name
+          end
+        end
+        EOS
+      end
+      
+      def binassoc(name, rt1, at, rt2, klass)
+          eval(<<-EOS)
+          class RTM::AR::Topic
+          index_property_set :#{name}, :type => :Topic, :rule => {
+            :transitive => true,
+            :role_type => "#{rt1}",
+            :association_type => "#{at}",
+            :association_arity => 2,
+            :other_role_type => "#{rt2}",
+            :add => "#{name.to_s.singularize}",
+          }
+          end
+          EOS
+          self.class_eval <<-EOS
+          def #{name}
+            @topic.#{name}.map{|o| #{klass}.new(o)}
+          end
+          def add_#{name.to_s.singularize}(o)
+            @topic.add_#{name.to_s.singularize}(o.topic)
+          end
+          def remove_#{name.to_s.singularize}(o)
+            @topic.remove_#{name.to_s.singularize}(o.topic)
+          end
+          EOS
+      end
+      
+      def topic_map(base_uri_or_tm)
+        @tm = base_uri_or_tm.is_a?(RTM::TopicMap) ? base_uri_or_tm : RTM.create(base_uri_or_tm)
+      end
+      
+      def create(ref)
+        self.new(@tm.get!(ref))
+      end
+      alias get! create
+      
+      def find(ref)
+        t = @tm.get(ref)
+        self.new(t) if t
+      end
+      alias get find
+    end
+  end
+end
+
+
+#require 'activetopicmaps'
+#RTM.connect
+#
+#class Person < ActiveTopicMaps::Base
+#  topic_map "urn:/base"
+#
+#  name :name
+#  occurrence :age
+#  occurrence :shoesize, "http://rtm.rubyforge.org/psi/shoesize" # this tells ActiveTM to use this as occurrence type
+#
+#  def to_s
+#    a = " (#{age})" if age
+#    "#{name}#{a}"
+#  end
+#end
+#
+#class Country
+#  include ActiveTopicMaps::Topic
+#
+#  topic_map "urn:/base"
+#
+#  acts_as_topic
+#
+#  name :name
+#  occurrence :population
+#  occurrence :size
+#
+#  binassoc :inhabitants, "country", "country-inhabitant", "inhabitant", :Person
+#
+#  def to_s
+#    "There is a country called #{name} with #{population} inhabitants and a size of #{size} km^2.\n" +
+#      "These are some of the inhabitants: #{inhabitants.map{|i| i.to_s}.join(", ")}."
+#  end
+#end
+#
+## create a new object with a (new?) topic
+#p = Person.create("max")
+#
+## set name, age, shoesize
+#p.name = "Max Mustermann"
+#p.age = 30
+#p.shoesize = 44 # european ;)
+#
+## print out the name
+#puts p.name
+#
+## create a new object, using a topic (might be queried before, ... you know)
+#h = Person.new(RTM[0].get!("hans"))
+#
+## set name
+#h.name = "Hans Maier"
+## set another name (overwrites the old one! this is different from topic["-name"] !!!)
+#h.name = "Hans Meyer"
+#
+## don't know what that does, maybe you?
+#puts h.name
+#
+## Norway is the item identifier, here
+#no=Country.create("Norway")
+#
+#no.name="Norway"
+#no.population = "4.743.000"
+#no.size = "385.199"
+#
+## use real person objects here
+#no.add_inhabitant h
+#no.add_inhabitant p
+#
+## use this nice to_s method we provided above
+#puts no.to_s
+#
+## find hans
+#puts "Trying to find Hans: #{Person.find("hans")}"
+## won't find otto
+#puts "Trying to find Otto: #{Person.find("otto")}"

data/lib/rtm/backend/active_record/association_and_role.rb

@@ -0,0 +1,54 @@
+module RTM::AR
+  class Association < Reifiable
+    include RTM::Association
+    wrapper_cache
+
+    parent :topic_map
+    property :type, :aka => [:ty,:t], :rw => true, :type => :Topic, :wrap => true
+    property_set :scope, :type => :Topic, :wrap => true
+    property_set :roles, :aka => [:r, :association_roles],  :type => :AssociationRole, :wrap => true,
+      :create => :role, :create_aka => [:cr, :create_association_role],
+      :create_args => [ {:name => :player, :type => :Topic}, {:name => :type, :type => :Topic}]
+    
+    property_set :role_players, :aka => [:players, :rp, :pl], :type => :Topic, :wrap => true
+    property_set :role_types, :aka => [:types, :rt], :type => :Topic, :wrap => true
+    
+    equality [:scope, :type, :roles]
+  end
+
+  class AssociationRole < Reifiable
+    include RTM::AssociationRole
+    wrapper_cache
+
+    parent :association
+    property :player, :aka => [:pl,:topic], :rw => true, :type => :Topic, :wrap => true
+    property :type, :aka => [:ty,:t], :rw => true, :type => :Topic, :wrap => true
+
+    def counterparts
+      self.parent.roles.reject{|r| r.id==self.id}
+    end
+    def counterplayers
+      self.counterparts.map{|r| r.player}
+    end
+    def counterpart
+      n = self.parent.roles.size
+      raise "Association must be unary or binary to use counterpart method. Please use counterparts for n-ary associations." if n > 2
+      return nil if n == 1
+      self.parent.roles.reject{|r| r.id==self.id}.first
+    end
+    def counterplayer
+      n = self.parent.roles.size
+      raise "Association must be unary or binary to use counterplayer method. Please use counterplayers for n-ary associations." if n > 2
+      return nil if n == 1
+      self.parent.roles.reject{|r| r.id==self.id}.first.player
+    end
+    def peers
+      self.counterpart.player.roles.select{|r| r.type == cp.type}.counterpart
+    end
+    def peerplayers
+      self.peers.map{|r| r.player}
+    end
+    
+    equality [:type, :player, :parent]
+  end
+end

data/lib/rtm/backend/active_record/locators.rb

@@ -0,0 +1,53 @@
+module RTM::AR
+  class Locator < TMDelegator
+    include RTM::Locator
+
+    delegate :+
+    delegate :-
+    #delegate :==
+    delegate :id
+
+    delegate :get
+    delegate :hash
+    delegate :resolve_relative
+    delegate :to_s, :to => :reference
+    delegate :to_uri
+    delegate :uri
+    delegate :reference, :rw => true, :save => true
+    alias :value :reference
+    alias :value= :reference=
+
+    equality [:reference]
+
+    def self.wrap(obj)
+      return nil unless obj
+      raise "Double wrapping" if obj.respond_to?(:__getobj__)
+      case obj.class.name
+      when "RTM::AR::TMDM::ItemIdentifier"
+        ItemIdentifier.wrap(obj)
+      when "RTM::AR::TMDM::SubjectIdentifier"
+        SubjectIdentifier.wrap(obj)
+      when "RTM::AR::TMDM::SubjectLocator"
+        SubjectLocator.wrap(obj)
+      else
+        raise "Can't wrap object. Class for wrapping #{obj.class} unknown (object: #{obj})"
+      end
+    end
+  end
+
+  class ItemIdentifier < Locator
+    include RTM::ItemIdentifier
+    wrapper_cache
+    property :topic_map_construct, :type => :TopicMapConstruct, :wrap => true
+  end
+  class SubjectIdentifier < Locator
+    include RTM::SubjectIdentifier
+    wrapper_cache
+    property :topic, :type => :Topic, :wrap => true
+  end
+  class SubjectLocator < Locator
+    include RTM::SubjectLocator
+    wrapper_cache
+    property :topic, :type => :Topic, :wrap => true    
+  end
+end

data/lib/rtm/backend/active_record/name_variant_occurrence.rb

@@ -0,0 +1,44 @@
+module RTM::AR
+  class TopicName < Reifiable
+    include RTM::TopicName
+    wrapper_cache
+
+    parent :topic
+    property :type, :aka => [:ty,:t], :rw => true, :type => :Topic, :wrap => true
+    property_set :scope, :type => :Topic, :wrap => true
+
+    property_set :variants, :aka => :v, :type => :Variant, :wrap => true,
+      :create => :variant, :create_aka => :cv,
+      :create_args => [ {:name => :value, :type => [:String, :Locator]}, {:name => :scope, :type => :Collection}]
+
+    property :value, :rw => true, :type => :String
+
+    equality [:value, :type, :scope, :parent]
+  end
+
+  class Variant < Reifiable
+    include RTM::Variant
+    wrapper_cache
+
+    parent :topic_name, :aka => :name
+    property :value, :rw => true, :type => :String
+    property :datatype, :rw => true, :type => :Locator #, :wrap => true
+    property_set :scope, :type => :Topic, :wrap => true
+
+    equality [:value, :datatype, :scope, :parent]
+  end
+
+  class Occurrence < Reifiable
+    include RTM::Occurrence
+    wrapper_cache
+
+    parent :topic
+    property :value, :rw => true, :type => :String
+    property :datatype, :rw => true, :type => :String
+
+    property_set :scope, :type => :Topic, :wrap => true
+    property :type, :aka => [:ty,:t], :rw => true, :type => :Topic, :wrap => true
+
+    equality [:value, :datatype, :scope, :type, :parent]
+  end
+end

data/lib/rtm/backend/active_record/quaaxtm2rtm.rb

@@ -0,0 +1,113 @@
+require 'active_record'
+
+
+module RTM
+  module AR
+    module TMDM
+      class Topic < ActiveRecord::Base;end
+      class ItemIdentifier < ActiveRecord::Base
+        belongs_to :topic_map_construct
+      end
+      class SubjectIdentifier < ActiveRecord::Base
+        belongs_to :topic
+      end
+
+      class SubjectLocator < ActiveRecord::Base
+        belongs_to :topic
+      end
+      
+      class QuaaxTM2RTM < ActiveRecord::Migration
+        def self.up
+          rename_table("qtm_topicmap", "topic_maps" )
+          rename_column("topic_maps", "baselocator", "base_locator")
+
+          rename_table("qtm_topic", "topics")
+          rename_column("topics", "topicmap_id", "topic_map_id")
+
+          add_column :topics, :reified_id, :integer
+          add_column :topics, :reified_type, :string
+
+          rename_table "qtm_association", "associations"
+          rename_column "associations", "type_id", "ttype_id"
+          rename_column "associations", "topicmap_id", "topic_map_id"
+
+          rename_table "qtm_assocrole", "association_roles"
+          rename_column "association_roles", "type_id", "ttype_id"
+          rename_column "association_roles", "reference", "topic_id"
+          
+          rename_table "qtm_topicname", "topic_names"
+          rename_column "topic_names", "type_id", "ttype_id"
+
+          rename_table "qtm_occurrence", "occurrences"
+          rename_column "occurrences", "type_id", "ttype_id"
+          
+          rename_table "qtm_variant", "variants"
+          rename_column "variants", "topicname_id", "topic_name_id"
+          
+          rename_table "qtm_topicmapconstructref", "item_identifiers"
+          rename_column "item_identifiers", "locator", "reference"
+          add_column :item_identifiers, :topic_map_id, :integer
+          ItemIdentifier.reset_column_information
+          ItemIdentifier.find(:all).each do |si|
+            si.update_attribute :topic_map_id, si.topic_map_construct.topic_map_id
+          end
+          
+          create_table :item_identifiers do |t|
+            t.column :topic_map_id, :integer, :null => false
+            t.column :reference, :string, :null => false
+            t.column :topic_map_construct_id, :integer
+            t.column :topic_map_construct_type, :string
+          end
+          SubjectIdentifier.reset_column_information
+          SubjectIdentifier.find(:all).each do |si|
+            si.update_attribute :topic_map_id, si.topic.topic_map_id
+          end
+          
+          rename_table "qtm_subjectidentifier", "subject_identifiers"
+          rename_column :subject_identifiers, "locator", "reference"
+          add_column :subject_identifiers, :topic_map_id, :integer
+          
+          SubjectIdentifier.reset_column_information
+          SubjectIdentifier.find(:all).each do |si|
+            si.update_attribute :topic_map_id, si.topic.topic_map_id
+          end
+          
+          rename_table "qtm_subjectlocator", "subject_locators"
+          rename_column :subject_locators, "locator", "reference"
+          add_column :subject_locators, :topic_map_id, :integer
+          
+          Topic.reset_column_information
+          SubjectLocator.reset_column_information
+          SubjectLocator.find(:all).each do |si|
+            si.update_attribute :topic_map_id, si.topic.topic_map_id
+          end
+
+          create_table :scoped_objects_topics do |t|
+            t.column :scoped_object_id, :integer
+            t.column :scoped_object_type, :string
+            t.column :topic_id, :integer
+          end
+          
+          # TODO: instance of
+          #       scope
+          #       reifier
+        end
+
+        def self.down
+          raise "not supported"
+        end
+
+      end
+    end
+  end
+end
+
+#if __FILE__ == $0
+#  puts "Generating SQLite3 Databse tmdm.sqlite3."
+#  ActiveRecord::Base.establish_connection(
+#    :adapter => "sqlite3",
+#    :database  => "tmdm.sqlite3"
+#  )
+#  RTM::AR::TMDM::QuaaxTM2RTM.migrate(:up)
+#end
+

data/lib/rtm/backend/active_record/quaaxtm2rtmviews.rb

@@ -0,0 +1,134 @@
+require 'active_record'
+
+
+module RTM
+  module AR
+    module TMDM
+      class Topic < ActiveRecord::Base;end
+      class ItemIdentifier < ActiveRecord::Base
+        belongs_to :topic_map_construct
+      end
+      class SubjectIdentifier < ActiveRecord::Base
+        belongs_to :topic
+      end
+
+      class SubjectLocator < ActiveRecord::Base
+        belongs_to :topic
+      end
+      
+      class QuaaxTM2RTMViews < ActiveRecord::Migration
+        def self.up
+          create_view "topic_maps", "select id, baselocator from qtm_topicmap" do |t|
+            t.column :id
+            t.column :base_locator
+          end
+
+          create_view "topics", "select id, topicmap_id, null, null from qtm_topic" do |t|
+            t.column :id
+            t.column :topic_map_id
+            t.column :reified_id
+            t.column :reified_type
+          end
+
+          create_view "associations", "select id, topicmap_id, type_id from qtm_association" do |t|
+            t.column :id
+            t.column :topic_map_id
+            t.column :ttype_id
+          end
+
+          create_view "association_roles", "select id, association_id, type_id, reference from qtm_assocrole" do |t|
+            t.column :id
+            t.column :association_id
+            t.column :ttype_id
+            t.column :topic_id
+          end
+
+          create_view "topic_names", "select id, topic_id, type_id, value from qtm_topicname" do |t|
+            t.column :id
+            t.column :topic_id
+            t.column :ttype_id
+            t.column :value
+          end
+
+          create_view "occurrence", "select id, topic_id, type_id, value, datatype from qtm_occurrence" do |t|
+            t.column :id
+            t.column :topic_id
+            t.column :ttype_id
+            t.column :value
+            t.column :datatype
+          end
+
+          create_view "variants", "select id, topicname_id, value, datatype from qtm_variant" do |t|
+            t.column :id
+            t.column :topic_name_id
+            t.column :value
+            t.column :datatype
+          end
+
+          rename_table "qtm_topicmapconstructref", "item_identifiers"
+          rename_column "item_identifiers", "locator", "reference"
+          add_column :item_identifiers, :topic_map_id, :integer
+          ItemIdentifier.reset_column_information
+          ItemIdentifier.find(:all).each do |si|
+            si.update_attribute :topic_map_id, si.topic_map_construct.topic_map_id
+          end
+          
+          create_table :item_identifiers do |t|
+            t.column :topic_map_id, :integer, :null => false
+            t.column :reference, :string, :null => false
+            t.column :topic_map_construct_id, :integer
+            t.column :topic_map_construct_type, :string
+          end
+          SubjectIdentifier.reset_column_information
+          SubjectIdentifier.find(:all).each do |si|
+            si.update_attribute :topic_map_id, si.topic.topic_map_id
+          end
+          
+          rename_table "qtm_subjectidentifier", "subject_identifiers"
+          rename_column :subject_identifiers, "locator", "reference"
+          add_column :subject_identifiers, :topic_map_id, :integer
+          
+          SubjectIdentifier.reset_column_information
+          SubjectIdentifier.find(:all).each do |si|
+            si.update_attribute :topic_map_id, si.topic.topic_map_id
+          end
+          
+          rename_table "qtm_subjectlocator", "subject_locators"
+          rename_column :subject_locators, "locator", "reference"
+          add_column :subject_locators, :topic_map_id, :integer
+          
+          Topic.reset_column_information
+          SubjectLocator.reset_column_information
+          SubjectLocator.find(:all).each do |si|
+            si.update_attribute :topic_map_id, si.topic.topic_map_id
+          end
+
+          create_table :scoped_objects_topics do |t|
+            t.column :scoped_object_id, :integer
+            t.column :scoped_object_type, :string
+            t.column :topic_id, :integer
+          end
+          
+          # TODO: instance of
+          #       scope
+          #       reifier
+        end
+
+        def self.down
+          raise "not supported"
+        end
+
+      end
+    end
+  end
+end
+
+#if __FILE__ == $0
+#  puts "Generating SQLite3 Databse tmdm.sqlite3."
+#  ActiveRecord::Base.establish_connection(
+#    :adapter => "sqlite3",
+#    :database  => "tmdm.sqlite3"
+#  )
+#  RTM::AR::TMDM::QuaaxTM2RTM.migrate(:up)
+#end
+