rtm-tmql 0.2.1

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,8 @@
+Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+License:   Apache License, Version 2.0
+
+See http://rtm.topicmapslab.de/ for instructions.
+See http://tmql4j.topicmapslab.de for information about TMQL.
+
+This Gem is bundled with the following third party libraries:
+* TMQL4J - http://tmql4j.topicmapslab.de/ (Apache 2.0 License)

data/lib/rtm/tmql.rb

@@ -0,0 +1,53 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+if Object.const_defined?("Gem") && rtmgem = Gem.loaded_specs["rtm-tmql"]
+  require 'rtm/javatmapi'
+else
+  javatmapi_path = File.expand_path(File.join(File.dirname(__FILE__), "../../../rtm-javatmapi/lib"))
+  $LOAD_PATH.unshift javatmapi_path if File.directory?(javatmapi_path)
+  require 'rtm/javatmapi'
+end
+
+Dir[File.join(File.dirname(__FILE__), 'tmql/javalibs/*.jar')].each {|file| require file }
+require 'rtm/tmql/tmql4j'
+
+module RTM
+  module TMQL
+    module Queryable
+
+      # Initialize a TMQL engine and run query instantly if a query is provided
+      def tmql(query=nil)
+        if query
+          execute_tmql(query)
+        else
+          tmql_engine
+        end
+      end
+
+      # Execute a TMQL query with the default engine
+      def execute_tmql(query)
+        tmql_engine.execute(query)
+      end
+
+      # Initialize a TMQL engine
+      def tmql_engine(params={})
+        @tmql_engine ||= TMQL::Engine.create({:construct => self}.merge(params))
+      end
+      RTM::TopicMap.register_extension(self)
+    end
+
+    # A TMQL Engine. Every TMQL-Engine for RTM must subclass this class.
+    class Engine
+      # Create a new TMQL-Engine. For now, this is hard-coded to TMQL4J.
+      # Once there are more engines, this structure could be similar to RTM::Engine
+      def self.create(params={})
+        TMQL4JEngine.new(params)
+      end
+
+      def initialize(params={})
+        @params = params
+      end
+    end
+  end
+end

data/lib/rtm/tmql/tmql4j.rb

@@ -0,0 +1,46 @@
+module RTM
+  module TMQL
+    class TMQL4JEngine < Engine
+      attr_accessor :topic_maps
+
+      def initialize(params)
+        super
+        @topic_maps = []
+        set_topic_map
+
+        @tmqlcore = de.topicmapslab.tmql4j.common.core
+        @new_tms = @topic_maps.first.engine.tmsf.newTopicMapSystem
+      end
+
+      def set_topic_map
+        if construct = @params[:construct]
+          @topic_maps << construct.topic_map || construct # because tm.topic_map is nil
+        elsif topic_map = @params[:topic_map]
+          @topic_maps << topic_map
+        end
+      end
+
+      def runtime
+        @runtime ||= @tmqlcore.process.TMQLRuntimeFactory.newFactory.newRuntime(@new_tms, @topic_maps)
+      end
+
+      def properties
+        runtime.properties
+      end
+
+      def enable_materialize_meta_model(materialize)
+        properties.enableMaterializeMetaModel(materialize)
+      end
+
+      def enable_updates(enabled)
+        properties.enableLanguageExtensionTmqlUl(enabled)
+      end
+
+      def execute(query)
+        q = runtime.run(query)
+        q.results
+      end
+
+    end
+  end
+end

data/spec/rtm-tmql_spec.rb

@@ -0,0 +1,39 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe RTM do
+  it "should have a topic map available" do
+    get_used_tm_sys_tm
+  end
+  it "should define constant TMQL" do
+    ::RTM::TMQL
+  end
+end
+
+module RTM::TopicMap
+  describe self do
+    before(:each) do
+      @tm = get_used_tm_sys_tm
+    end
+    after(:each) do
+      @tm.close
+    end
+
+    it "should have a tmql instance method" do
+      RTM::TopicMap.instance_methods.should include("tmql")
+    end
+
+    it "should respond to the tmql method" do
+      @tm.should respond_to(:tmql)
+    end
+
+    it "should run the tmql method with a string argument" do
+      pending "TMQL currently does not allow empty queries" do
+        @tm.tmql("").should_not raise_error
+      end
+    end
+
+  end
+end

data/spec/rtm/tmql/flwor.rb

@@ -0,0 +1,19 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe RTM::TopicMap do
+  describe "#tmql flwor expressions" do
+    it "should run a simple flwor expression" do
+      tm = get_used_tm_sys_tm
+      %w[a b c d e f g h i j k l m].each do |l|
+        t= tm.get!(l)
+        t.add_type("letter")
+        t["-"] = l
+      end
+      res = tm.tmql("RETURN <letters>{FOR $l in // a:b#letter RETURN <letter>{$l / tm:name}</letter>}</letters>")
+      # FIXME: write expectations
+    end
+  end
+end

data/spec/rtm/tmql/path.rb

@@ -0,0 +1,19 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe RTM::TopicMap do
+  describe "#tmql path expressions" do
+    it "should run a simple path expression" do
+      tm = get_used_tm_sys_tm
+      %w[a b c d e f g h i j k l m].each do |l|
+        t= tm.get!(l)
+        t.add_type("letter")
+        t["-"] = l
+      end
+      res = tm.tmql("a:b#letter >> instances")
+      # FIXME: write expectations
+    end
+  end
+end

data/spec/rtm/tmql/select.rb

@@ -0,0 +1,12 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe RTM::TopicMap do
+  describe "#tmql select expressions" do
+    it "should run a select path expression" do
+      pending "specs not yet implemented"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), "/../lib")
+
+require 'spec'
+require 'rtm/tmql'
+
+def implementation_for_spec
+  engine = :ontopia # if env is nil, the "normal progress will go on" # TODO: remove ontopia, as it should be chosen by connect by default
+end
+def get_used_tm_sys
+  RTM.connect(:implementation => implementation_for_spec)
+end
+
+def get_used_tm_sys_tm
+  get_used_tm_sys.create("http://www.topicmapslab.de/")
+end
+

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: rtm-tmql
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 1
+  version: 0.2.1
+platform: ruby
+authors: 
+- Benjamin Bock
+- Sven Krosse
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-04 00:00:00 +01: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
+        - 2
+        - 1
+        version: 0.2.1
+  type: :runtime
+  version_requirements: *id001
+description: The TMQL query engine for Ruby Topic Maps. See http://tmql4j.topicmapslab.de/ for more information about TMQL and TMQL4J.
+email: rtm+rtm-tmql-gem-20100304@topicmapslab.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/rtm/tmql/tmql4j.rb
+- lib/rtm/tmql.rb
+- spec/rtm/tmql/flwor.rb
+- spec/rtm/tmql/path.rb
+- spec/rtm/tmql/select.rb
+- spec/rtm-tmql_spec.rb
+- spec/spec_helper.rb
+- lib/rtm/tmql/javalibs/tmql4j-2.5.2.jar
+- LICENSE
+- DISCLAIMER
+- README
+has_rdoc: true
+homepage: http://rtm.topicmapslab.de/
+licenses: []
+
+post_install_message: You have successfully installed rtm-tmql.
+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: "Ruby Topic Maps: TMQL Query Engine"
+test_files: []
+