rtm-rails 0.3.0

data/DISCLAIMER

@@ -0,0 +1,13 @@
+Copyright 2008-2010 Topic Maps Lab, University of Leipzig.
+
+Licensed under the Apache License, Version 2.0 (the "License"); 
+you may not use this file except in compliance with the License. 
+You may obtain a copy of the License at 
+
+  http://www.apache.org/licenses/LICENSE-2.0 
+
+Unless required by applicable law or agreed to in writing, software 
+distributed under the License is distributed on an "AS IS" BASIS, 
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
+See the License for the specific language governing permissions and limitations 
+under the License.

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README

@@ -0,0 +1,84 @@
+==== Topic Maps for Rails (rtm-rails)
+RTM-Rails is the Rails-Adapter for Ruby Topic Maps. It allows simple configuration of topicmaps in config/topicmaps.yml.
+
+==== Overview
+From a developer's perspective, RTM is a schema-less database management system.
+The Topic Maps standard (described below) on which RTM is based provides a way of creating a self-describing schema just by using it.
+You can use RTM as a complement data storage to ActiveRecord in your Rails apps.
+
+==== Quickstart - existing Rails project
+ jruby script/generate topicmaps
+
+Run the command above after installing rtm-rails. This will create
+* a minimal default configuration: config/topicmaps.yml and
+* a file with more examples and explanations config/topicmaps.example.yml
+* a file README.topicmaps.txt which contains more information how to use it and where to find more information
+* an initializer to load the topicmaps at startup
+* a rake task to migrate the topic maps backends
+in your rails application.
+
+==== Quickstart - new Rails project
+
+For a new Rails application these are the complete initial steps:
+ jruby -S rails my_topicmaps_app
+ cd my_topicmaps_app
+ jruby -S script/generate jdbc
+ jruby -S script/generate topicmaps
+ # The following lines are necessary because Rails does not have a template
+ # for the H2 database and Ontopia does not support the Rails default SQLite3.
+ sed -e "s/sqlite3/h2/" config/database.yml > config/database.yml.h2
+ mv config/database.yml.h2 config/database.yml
+ # Prepare the database and then check if all is OK
+ jruby -S rake topicmaps:migrate_backends
+ jruby -S rake topicmaps:check
+
+==== Usage inside the application
+
+When everything is fine, let's create our first topic:
+ jruby -S script/console
+ TM[:example].get!("http://example.org/my/first/topic")
+ # and save the topic map
+ TM[:example].commit
+
+Access the configured topic maps anywhere in your application like this:
+ TM[:example]
+
+To retrieve all topics, you can do
+ TM[:example].topics
+
+To retrieve a specific topic by its subject identifier:
+ TM[:example].get("http://example.org/my/topic")
+
+Commit the changes to the database permanently:
+ TM[:example].commit
+
+... or abort the transaction:
+ TM[:example].abort
+
+More information can be found on http://rtm.topicmapslab.de/
+
+==== Minimal configuration
+ default:
+   topicmaps:
+     example: http://rtm.topicmapslab.de/example1/
+
+The minimal configuration creates a single topic map, named :example with the locator given.
+This topic map will be persisted in the same database as your ActiveRecord connection if not specified otherwise.
+The default backend is OntopiaRDBMS (from the rtm-ontopia gem).
+A more complete configuration can be found in config/topicmaps.example.yml after running "jruby script/generate topicmaps".
+It also includes how to specifiy multiple connections to different data stores and so on.
+
+==== Topic Maps
+Topic Maps is an international industry standard (ISO13250) for interchangeably representing information
+about the structure of information resources used to define topics, and the relationships between topics.
+A set of one or more interrelated documents that employs the notation defined by this International Standard is called a topic map.
+A topic map defines a multidimensional topic space - a space in which the locations are topics,
+and in which the distances between topics are measurable in terms of the number of intervening topics
+which must be visited in order to get from one topic to another, and the kinds of relationships that define
+the path from one topic to another, if any, through the intervening topics, if any.
+In addition, information objects can have properties, as well as values for those properties, assigned to them.
+The Topic Maps Data Model which is used in this implementation can be found on http://www.isotopicmaps.org/sam/sam-model/.
+
+==== License
+Copyright 2009 Topic Maps Lab, University of Leipzig.
+Apache License, Version 2.0

data/lib/rtm-rails.rb

@@ -0,0 +1,4 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+require File.join(File.dirname(__FILE__), 'rtm/rails')

data/lib/rtm/rails.rb

@@ -0,0 +1,285 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+unless Object.const_defined?("Gem") && rtmgem = Gem.loaded_specs["rtm-rails"]
+  javatmapi_path = File.expand_path(File.join(File.dirname(__FILE__), "../../../rtm/lib"))
+  $LOAD_PATH.unshift javatmapi_path if File.directory?(javatmapi_path)
+end
+require 'rtm'
+
+module RTM
+  # The RTM-Rails Gem largely remodels the Rails startup sequence and
+  # initializes the application {TopicMap}s TopicMap {TopicMap} from the topicmaps configuration
+  # file (Defaults to +config/topicmaps.yml+).
+  # The {TopicMap} s defined there can then be accessed using {TM} bla {TM.[identifier]}
+  module Rails
+    class << self
+      # The Configuration instance used to configure the Rails environment
+      def configuration
+        @@configuration
+      end
+
+      def configuration=(configuration)
+        @@configuration = configuration
+      end
+
+      def initialized?
+        @initialized || false
+      end
+
+      def initialized=(initialized)
+        @initialized ||= initialized
+      end
+    end
+
+    class Configuration
+      # The path to the topicmaps configuration file to use. (Defaults to
+      # <tt>config/topicmaps.yml</tt>.)
+      # @see Rails::Configuration#database_configuration_file
+      attr_accessor :topicmaps_configuration_file
+
+      # The connection configuration for the current environment as collected
+      # from the configuration files.
+      attr_accessor :connections
+
+      # The topicmaps configuration for the current environment as collected
+      # from the configuration files.
+      attr_accessor :topicmaps
+
+      # Create a new Configuration instance, initialized with the default
+      # values.
+      def initialize
+        self.topicmaps_configuration_file = default_topicmaps_configuration_file
+      end
+
+      # Loads and returns the contents of the #database_configuration_file.
+      # The contents of the file are processed via ERB before being sent
+      # through YAML::load.
+      # @see Rails::Configuration#database_configuration
+      def topicmaps_configuration
+        require 'erb'
+        YAML::load(ERB.new(::IO.read(topicmaps_configuration_file)).result)
+      end
+
+      def default_topicmaps_configuration_file
+        File.join(::Rails.root, 'config', 'topicmaps.yml')
+      end
+    end
+
+    class Initializer
+      attr_reader :configuration
+
+      # @see Rails::Initializer.run
+      def self.run(configuration = Configuration.new)
+        yield configuration if block_given?
+        initializer = new configuration
+        initializer.process
+        initializer
+      end
+
+      # Create a new Initializer instance that references the given
+      # Configuration instance.
+      # @see Rails::Initializer#initialize
+      def initialize(configuration)
+        @configuration = configuration
+      end
+
+      # Sequentially step through all of the available initialization
+      # routines, in order (view execution order in source).
+      def process
+        RTM::Rails.configuration = configuration
+
+        load_configuration
+
+        initialize_topicmaps_systems
+
+        check_systems_initialized
+
+        initialize_topicmaps
+
+        RTM::Rails.initialized = true
+      end
+
+      # Get the database configuration from ActiveRecord, or if ActiveRecord
+      # is not loaded: load it manually.
+      def load_configuration
+        # load the default topicmaps configuration file
+        complete_config = configuration.topicmaps_configuration || {}
+
+        # load the config from the default section
+        default_config = complete_config["default"] || {}
+        default_config.symbolize_keys!
+        # load the config from the current-environment section
+        environment_config = complete_config[::Rails.env] || {}
+        environment_config.symbolize_keys!
+
+        # obtain the current configuration by merging default config and the
+        # current environment's config. This is a one-step deep-merge as we
+        # just want to merge inside the subkeys.
+        current_configuration = default_config
+        environment_config.keys.each do |key|
+          if current_configuration.key?(key) && current_configuration[key].is_a?(Hash)
+            current_configuration[key].merge!(environment_config[key])
+          else
+            current_configuration[key] = environment_config[key]
+          end
+        end
+
+        # set the topicmaps configuration
+        configuration.topicmaps = (current_configuration[:topicmaps] || {}).symbolize_keys
+
+        # expand shortcuts in topicmaps configuration
+        configuration.topicmaps.each do |identifier, tm_config|
+          # Convert the topicmap configuration to a Hash if the topicmap was
+          # specified using the locator-only shortcut.
+          configuration.topicmaps[identifier] = tm_config = {:locator => tm_config} unless tm_config.is_a?(Hash)
+
+          tm_config.symbolize_keys!
+        end
+
+        # read the connections configuration
+        current_connections = current_configuration[:connections] || {}
+        current_connections.symbolize_keys!
+
+        # get default connection (if specified)
+        default_connection = current_configuration[:connection]
+
+        # if no default connection was specified look for the rails one.
+        default_connection ||= ::Rails::Configuration.new.database_configuration[::Rails.env]
+
+        # use the explicitly defined default connection or the above-loaded
+        current_connections[:default] ||= default_connection
+
+        # set the connections configuration
+        configuration.connections = current_connections
+
+        # expand shortcuts in connection configuration
+        configuration.connections.each do |identifier, con_config|
+          con_config.symbolize_keys!
+        end
+
+        # forget default connection if no topicmap uses it and use_for_topicmaps is false
+        keep_default = false
+        keep_default = true if configuration.topicmaps.any? {|identifier, tm| ! tm.key?(:connection) || tm[:connection].to_s == "default"}
+        keep_default = true if configuration.connections[:default][:use_for_topicmaps]
+        configuration.connections.delete(:default) unless keep_default
+      end
+
+      # Connect to the TopicMap engine(s) using the configured settings
+      def initialize_topicmaps_systems
+        configuration.connections.each do |identifier, conf|
+          # If the connection was declared but not defined, copy over the data from default
+          conf ||= configuration.connections[:default].merge(:identifier => identifier)
+          RTM.connect(conf.merge(:identifier => identifier))
+        end
+      end
+
+      # Some Topic Maps backends like the Ontopia RDBMS backend need some
+      # setup, e.g. some database tables. This method checks if these
+      # preconditions are met.
+      def check_systems_initialized
+        failed_connections = RTM.connections.reject { |identifier,con| con.check }
+        unless failed_connections.empty?
+          puts "Warning: The following topicmap connection(s) are not properly prepared: #{failed_connections.map{|identifier,con| identifier}.to_sentence}"
+          puts "         Maybe you added them recently to your config but forgot 'rake topicmaps:migrate_backends'?"
+        end
+      end
+
+      # Get or create the topic maps and make them available in {TM[]}
+      def initialize_topicmaps
+        configuration.topicmaps.each do |identifier, tm_config|
+          # Get the configured connection (or create it if it was given inline)
+          con = case con_spec = tm_config[:connection]
+          when nil # nothing specified => default connection
+            RTM.connections[:default]
+          when Symbol, String # name given => named connection
+            RTM.connections[con_spec.to_sym]
+          when Hash # inline config given
+            c = connect_anonymous(con_spec)
+            puts "Warning: The connection for topicmap '#{identifier}' is not yet prepared. Please run the topicmaps:migrate_backends rake task." unless c.check
+            c
+          else
+            raise "Cannot determine connection for #{con_spec.inspect}"
+          end
+
+          begin
+            tm = con.create(tm_config[:locator])
+            TM::Manager.register_map(identifier, tm)
+          rescue NativeException => ne
+            if ne.cause.is_a?(Java::NetOntopiaUtils::OntopiaRuntimeException) &&
+                ne.cause.message =~ /The datatype type is unknown and the property 'net.ontopia.topicmaps.impl.rdbms.Platforms' is not set./ &&
+                (dbname = con.property("net.ontopia.topicmaps.impl.rdbms.Database")) =~ /sqlite/
+              puts "Warning: An Exception was thrown by the Ontopia RDBMS backend"
+              puts "         This was probably because you're trying to use '#{dbname}', which is not supported by Ontopia."
+            end
+            raise ne
+          end
+        end
+      end
+
+      def connect_anonymous(con_spec)
+        con_spec.symbolize_keys!
+        RTM.connect(con_spec)
+      end
+
+      def connect_all_anonymous_connections
+        topicmaps_with_anonymous_connections = configuration.topicmaps.select {|identifier, tm_config| Hash === tm_config[:connection]}
+        topicmaps_with_anonymous_connections.map do |identifier, tm_config|
+          connection_config = tm_config[:connection].merge(:identifier => "anon_connection_for_tm_#{identifier}".to_sym)
+          connect_anonymous(connection_config)
+        end
+      end
+    end
+  end
+
+  # The TopicMapManager manages TopicMaps by registering a Topic Map using an
+  # identifier. The identifier is used to easily access the TopicMap
+  # everywhere without passing around the instance manually.
+  class TopicMapManager
+    attr_reader :topic_maps
+
+    def initialize
+      @topic_maps = {}
+    end
+
+    def register_map(identifier, map)
+      raise "A topic map with the identifier #{identifier.inspect} is already registered" if @topic_maps.keys.include?(identifier)
+      # TODO maybe we should allow to connect here?
+      @topic_maps[identifier] = map
+    end
+
+    def remove_map(identifier)
+      # TODO: maybe it should be removed from the system here?
+      @topic_maps.delete(identifier)
+    end
+
+    def [](identifier)
+      raise "There is no topic map registered with identifier #{identifier.inspect}" unless @topic_maps.keys.include?(identifier)
+      @topic_maps[identifier]
+    end
+  end
+end
+
+# The module TM can be used to easily access the TopicMaps used in an
+# application. It uses a TopicMapManager and provides access to a TopicMap by
+# using the Hash access method: {TM[]} or {TM.[]} or {TM.[bla]} or {TM.[](*args)}. TopicMaps can be configured in the
+# +config/topicmaps.yaml+ file.
+module TM
+  Manager = RTM::TopicMapManager.new
+
+  # Returns a TopicMap
+  #
+  # @param [Types] identifier of the TopicMap to return.
+  # @return [RTM::TopicMap] with the given identifier
+  def self.[](*args)
+    if args.size == 0
+      Manager.topic_maps
+    else
+      Manager[*args]
+    end
+  end
+end
+
+def TM(*args)
+  TM[*args]
+end

data/lib/rtm/rails/rake_tasks.rb

@@ -0,0 +1,35 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+namespace :topicmaps do
+
+  task :load_config => :rails_env do
+    initializer = RTM::Rails::Initializer.new(RTM::Rails::Configuration.new)
+    initializer.load_configuration
+    initializer.initialize_topicmaps_systems
+    initializer.connect_all_anonymous_connections
+  end
+
+  desc "Migrate RTM Backends to prepare them for storing topic maps"
+  task :migrate_backends => :load_config do
+    RTM.connections.each do |identifier, con|
+      unless con.check
+        print "Migrating #{identifier}..."
+        con.migrate
+        puts "done"
+      end
+    end
+  end
+
+  desc "Check if all RTM Backends are properly set up"
+  task :check => :load_config do
+    fine, failed = RTM.connections.partition { |identifier,con| con.check }
+    if failed.empty?
+      puts "All #{fine.size} topicmap connections seem to be set up fine: #{fine.map{|identifier,con| identifier}.to_sentence}"
+    else
+      puts "The following #{fine.size} topicmap connections are OK: #{fine.map{|identifier,con| identifier}.to_sentence}"
+      puts "The following #{failed.size} topicmap connections are NOT properly prepared: #{failed.map{|identifier,con| identifier}.to_sentence}"
+      puts "Run '#{$0} topicmaps:migrate_backends' to prepare them."
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,9 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+# This file was generated by the "topicmaps" generator, which is provided
+# by the rtm-rails gem.
+
+require 'rtm/rails'
+
+RTM::Rails::Initializer.run

data/rails_generators/templates/README.txt

@@ -0,0 +1,33 @@
+This file was created by the topicmaps generator which is provided by the
+rtm-rails Gem.
+
+1. Configure the topic maps for your application in
+
+    config/topicmaps.yml
+
+
+2. Migrate your backends to make them ready for your topic maps:
+
+    jruby -S rake topicmaps:migrate_backends 
+
+
+3. Use your topic maps in your application code:
+
+
+    TM[:mymap].topics.each do |topic|
+      # do something with the topic
+    end
+
+    TM[:another_map].get("xsd:integer") # get an existing topic
+    
+    TM[:some_map].get!("a:b") # get topic (or create it if it does not exist)
+
+
+See http://rubygems.org/gems/rtm-rails for information about the Gem.
+See http://rtm.topicmapslab.de/ for information about RTM.
+See http://www.topicmapslab.de/ for general information about Topic Maps.
+
+
+==== License for RTM and RTM-Rails
+Copyright 2009 Topic Maps Lab, University of Leipzig.
+Apache License, Version 2.0

data/rails_generators/templates/topicmaps.example.yml

@@ -0,0 +1,128 @@
+# == config/topicmaps.example.yml - Example Topic Maps configuration file
+# Configure your topic maps in config/topicmaps.yml as described here. It
+# works like configuring databases.
+#
+# === Default Environment
+# Most people want the same topic maps in all environments. The special
+# environment "default" is the basis for all other enviroments. The simplest
+# configuration is
+#
+default:
+  topicmaps:
+    example1: http://rtm.topicmapslab.de/example1/
+#
+# which provides a topic map called example1 with the given locator for all
+# environments. This topic map is accessible as TM[:example1] in the
+# application.
+#
+# The above example makes the following assumptions:
+# * The database settings are from the Rails config from database.yml
+# * If a database is configured (i.e. an adapter is set)
+#     the backend is ontopia_rdbms
+# * else
+#     the backend is ontopia (which is in-memory)
+#
+# More details about that in the Defaults section at the end.
+#
+# === Connections
+# A topic map is persisted in a backend. By default the same database
+# connection that ActiveRecord uses will be used. This default is configured
+# in the config/database.yml file. To override this default, specify your own
+# connection as follows.
+#
+development:
+  connection:
+    adapter: h2
+    database: db/development
+  topicmaps:
+    example2: http://rtm.topicmapslab.de/example2/
+#
+# We choose the development environment and define a connection using the
+# h2 adapter. H2 will create multiple files using the given database name as
+# basis. Everything in the connection section works exactly like in the
+# standard rails configuration. As above, also a topic map is configured.
+# This topic map is accessible as TM[:example2] in the application.
+#
+# === Multiple Connections
+# RTM allows to connect to multiple backends at the same time. To connect to
+# multiple backends use the connections keyword. Each connection specified
+# here must have a name to identify the connection. The following example
+# creates two connections for the production environment: one persistent
+# (called primary) using mysql and one temporary (called tmp) in memory.
+# As with the topic maps, the names are arbitrary.
+#
+production:
+  connections:
+    primary:
+      adapter: mysql
+      encoding: utf8
+      reconnect: false
+      database: my_app_mysql_production
+      pool: 5
+      username: root
+      password:
+      socket: /tmp/mysql.sock
+    tmp:
+      backend: ontopia
+    tmp2:
+  topicmaps:
+    example4:
+      locator: http://rtm.topicmapslab.de/example4/
+      connection: primary
+    example5:
+      locator: http://rtm.topicmapslab.de/example5/
+      connection: tmp
+    example6:
+      locator: http://rtm.topicmapslab.de/example6/
+      connection: tmp2
+    example7:
+      locator: http://example.org/7
+      connection:
+        adapter: h2
+        database: db/development
+
+# The connection tmp2 above provides no further information so it falls back
+# to the defaults: the ontopia in-memory backend (same as the connection tmp).
+#
+# Instead of an connection name, example 7 defines the connection inline. The
+# inline definition works exactly like the separate ones.
+#
+# === Defaults
+# As mentioned above, there are defaults for most settings. There are two
+# major sections and consequently two sets of defaults.
+#
+# ==== Defaults for Connections
+# Connections can defined stand-alone in the connections-section and for a
+# specific topic map in its connection-property.
+#
+# Stand-alone connections must have a name. If no properties are provided, the
+# default connection is used. If no default connection was specified, the
+# database properties from the Rails database.yml are used. Instead of
+# properties, also the name of another connection can be provided to create an
+# alias to this connection.
+#
+# A connection for a specific topic map can also refer to a named connection
+# (or the default connection if nothing is provided). To create an anonymous
+# connection a Hash of properties can be used.
+#
+# The connection must include the adapter details which are equivalent to
+# the adapter settings used in ActiveRecord::Base.
+# Some backends, like the Ontopia backend support additional settings which
+# can also be provided here.
+#
+# All connections are migrated using the rake task topicmaps:migrate_backend
+# and checked with the rake task topicmaps:check. The default connection is
+# only included there if it is used by at least one topicmap or the property
+# use_for_topicmaps is set:
+#   use_for_topicmaps: true
+#
+# ==== Defaults for topic maps.
+# Each topic map has a name, similar to a named connection. There are no
+# anonymous or default topic maps.
+# Next to the name of the topic map there can be either a +locator+ or a
+# +Hash+ of properties. A locator is an IRI which is an internationalized URI,
+# see RFC 3987, http://www.ietf.org/rfc/rfc3987.txt for details.
+# If a Hash of properties is provided it must include a key +locator+.
+#
+# A specific connection can be provided using the +connection+ keyword. If
+# left out, the default connection is used.

data/rails_generators/templates/topicmaps.rake

@@ -0,0 +1,17 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+#
+# This file was generated by the "topicmaps" generator, which is provided by
+# the rtm-rails gem.
+#
+# This file allows you to use your topic maps in your rails tasks and provides
+# the Topic Maps backend migration tasks
+
+begin
+  require "rtm/rails"
+  require "rtm/rails/rake_tasks"
+rescue MissingSourceFile => msfe
+  puts "ERROR: Failed to load rtm/rails. Please make sure you have the rtm-rails gem installed."
+  puts "       Maybe you're using standard C-Ruby's rake instead of JRuby's rake? Try jruby -S rake..." unless defined?(JRUBY_VERSION)
+  raise msfe
+end

data/rails_generators/templates/topicmaps.yml

@@ -0,0 +1,11 @@
+# == config/topicmaps.yml - Topic Maps configuration file
+# Configure your topic maps here. It works like configuring databases.
+
+# This creates a topic map :example with the base locator defined. The topic
+# maps defined in section default will be available in all Rails environments.
+# Add sections named after the enviroments to define different topic maps in
+# each environment. See the file topicmaps.example for more examples.
+# This topic map is accessible as TM[:example] in the application
+default:
+  topicmaps:
+    example: http://rtm.topicmapslab.de/example/

data/rails_generators/topicmaps_generator.rb

@@ -0,0 +1,21 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+class TopicmapsGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.directory 'config/initializers'
+      m.template '../../rails/init.rb', File.join('config', 'initializers', 'topicmaps.rb')
+      m.template 'topicmaps.yml', File.join('config', 'topicmaps.yml')
+      m.template 'topicmaps.example.yml', File.join('config', 'topicmaps.example.yml')
+      m.directory 'lib/tasks'
+      m.template 'topicmaps.rake', File.join('lib', 'tasks', 'topicmaps.rake')
+      m.template 'README.txt', 'README.topicmaps.txt'
+    end
+  end
+
+  protected
+  def banner
+    "Usage: #{$0} jdbc\nGenerate Topic Maps bootstrapping files for your Rails application."
+  end
+end

data/tasks/topicmaps_tasks.rake

@@ -0,0 +1,13 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+#
+# This is the vendor/plugin-version of the rake tasks. The generator version
+# which is used with the rtm-rails Gem is in rails_generators/templates.
+#
+# This file allows you to use your topic maps in your rails tasks and provides
+# the Topic Maps backend migration tasks
+
+# The relative loading is necessary for usage of rtm-rails as a plugin
+rtm_rails_dir = File.dirname(__FILE__) + "/../lib/"
+require "#{rtm_rails_dir}rtm/rails"
+require "#{rtm_rails_dir}rtm/rails/rake_tasks"

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification 
+name: rtm-rails
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
+platform: ruby
+authors: 
+- Benjamin Bock
+- Arnim Bleier
+- Uta Schulze
+- Daniel Exner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-13 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rtm-javatmapi
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 0
+        version: 0.3.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rtm-ontopia
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 0
+        version: 0.3.0
+  type: :runtime
+  version_requirements: *id002
+description: |
+  ==== Topic Maps for Rails (rtm-rails)
+  RTM-Rails is the Rails-Adapter for Ruby Topic Maps. It allows simple configuration of topicmaps in config/topicmaps.yml.
+  
+  ==== Overview
+  From a developer's perspective, RTM is a schema-less database management system.
+  The Topic Maps standard (described below) on which RTM is based provides a way of creating a self-describing schema just by using it.
+  You can use RTM as a complement data storage to ActiveRecord in your Rails apps.
+  
+  ==== Quickstart - existing Rails project
+   jruby script/generate topicmaps
+  
+  Run the command above after installing rtm-rails. This will create
+  * a minimal default configuration: config/topicmaps.yml and
+  * a file with more examples and explanations config/topicmaps.example.yml
+  * a file README.topicmaps.txt which contains more information how to use it and where to find more information
+  * an initializer to load the topicmaps at startup
+  * a rake task to migrate the topic maps backends
+  in your rails application.
+  
+  ==== Quickstart - new Rails project
+  
+  For a new Rails application these are the complete initial steps:
+   jruby -S rails my_topicmaps_app
+   cd my_topicmaps_app
+   jruby -S script/generate jdbc
+   jruby -S script/generate topicmaps
+   # The following lines are necessary because Rails does not have a template
+   # for the H2 database and Ontopia does not support the Rails default SQLite3.
+   sed -e "s/sqlite3/h2/" config/database.yml > config/database.yml.h2
+   mv config/database.yml.h2 config/database.yml
+   # Prepare the database and then check if all is OK
+   jruby -S rake topicmaps:migrate_backends
+   jruby -S rake topicmaps:check
+  
+  ==== Usage inside the application
+  
+  When everything is fine, let's create our first topic:
+   jruby -S script/console
+   TM[:example].get!("http://example.org/my/first/topic")
+   # and save the topic map
+   TM[:example].commit
+  
+  Access the configured topic maps anywhere in your application like this:
+   TM[:example]
+  
+  To retrieve all topics, you can do
+   TM[:example].topics
+  
+  To retrieve a specific topic by its subject identifier:
+   TM[:example].get("http://example.org/my/topic")
+  
+  Commit the changes to the database permanently:
+   TM[:example].commit
+  
+  ... or abort the transaction:
+   TM[:example].abort
+  
+  More information can be found on http://rtm.topicmapslab.de/
+  
+  ==== Minimal configuration
+   default:
+     topicmaps:
+       example: http://rtm.topicmapslab.de/example1/
+  
+  The minimal configuration creates a single topic map, named :example with the locator given.
+  This topic map will be persisted in the same database as your ActiveRecord connection if not specified otherwise.
+  The default backend is OntopiaRDBMS (from the rtm-ontopia gem).
+  A more complete configuration can be found in config/topicmaps.example.yml after running "jruby script/generate topicmaps".
+  It also includes how to specifiy multiple connections to different data stores and so on.
+  
+  ==== Topic Maps
+  Topic Maps is an international industry standard (ISO13250) for interchangeably representing information
+  about the structure of information resources used to define topics, and the relationships between topics.
+  A set of one or more interrelated documents that employs the notation defined by this International Standard is called a topic map.
+  A topic map defines a multidimensional topic space - a space in which the locations are topics,
+  and in which the distances between topics are measurable in terms of the number of intervening topics
+  which must be visited in order to get from one topic to another, and the kinds of relationships that define
+  the path from one topic to another, if any, through the intervening topics, if any.
+  In addition, information objects can have properties, as well as values for those properties, assigned to them.
+  The Topic Maps Data Model which is used in this implementation can be found on http://www.isotopicmaps.org/sam/sam-model/.
+  
+  ==== License
+  Copyright 2009 Topic Maps Lab, University of Leipzig.
+  Apache License, Version 2.0
+
+email: rtm+rtm-rails-gem-20100413@topicmapslab.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/rtm/rails/rake_tasks.rb
+- lib/rtm/rails.rb
+- lib/rtm-rails.rb
+- rails/init.rb
+- rails_generators/topicmaps_generator.rb
+- rails_generators/templates/topicmaps.rake
+- tasks/topicmaps_tasks.rake
+- rails_generators/templates/README.txt
+- rails_generators/templates/topicmaps.example.yml
+- rails_generators/templates/topicmaps.yml
+- LICENSE
+- DISCLAIMER
+- README
+has_rdoc: true
+homepage: http://rtm.topicmapslab.de/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: rtm
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: RTM-Rails is the Rails-Adapter for Ruby Topic Maps. It allows configuring connections and topicmaps in config/topicmaps.yml.
+test_files: []
+