tcf2nif 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f244b1143fade6e88fec59ad9adfe89d6f78da75
+  data.tar.gz: 25e7e33477ae1cfded5ffad85b56d6c6e511eaca
+SHA512:
+  metadata.gz: ba6d13d4d65d6fc591940a549c8d69ba03ea2036d5346c0c36cce13e7b72427e142f15e55055192107e1ccba4e1cd2e6071f83c1778f9805e901a2a2458c9da0
+  data.tar.gz: 9e07c4317a514f6283e5983352e86585cb290bd520a6c9a22dd4fbb5246d370e5946ccb0355aee0282810db2a8e0e6f206308f5b70e601c9b6cdd3a4ba702809

data/.gitignore

@@ -0,0 +1,37 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea
+spec/out/*.ttl
+spec/out/*.nt
+spec/out/plainprov/*.ttl
+spec/out/tcf2nif
+spec/coverage
+spec/out/miserables.n3
+spec/out/phantom.n3
+spec/out/screw.n3
+spec/logs/misplain.log
+spec/logs/phanplain.log
+spec/logs/screwplain.log
+spec/out/plainprov/miserables.nt
+spec/out/plainprov/phantom.nt
+spec/out/plainprov/phantom.ttl
+spec/out/plainprov/screw.nt
+
+/.ipynb_checkpoints/
+spec/out/*.*
+jack.*
+newchain.xml
+testchain.xml
+screw.xml
+otherchain.xml
+token.txt
+spec/out/modularized/phantom.n3
+spec/out/modularized/phantom.ttl
+spec/out/modularized/tools.ttl

data/.gitlab-ci.yml

@@ -0,0 +1,25 @@
+before_script:
+  - echo off 
+  - source /etc/profile.d/rvm.sh
+  - rvm use 2.2@mine
+  - echo on
+  #- gem install bundler
+  - bundle install 
+  #- bundle exec rake db:create
+
+rspec: 
+  script: "rake spec"
+  tags: 
+    - ~slow
+  only: 
+    - branches
+
+#staging: 
+#  script: "cap deploy stating"
+#  type: deploy
+#  tags: 
+#    - capistrano
+#    - debian
+#  except:
+#    - stable
+#    - /^deploy-.*$/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tcf2nif.gemspec
+gemspec
+
+gem 'iruby'

data/LICENSE.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,112 @@
+# tcf2nif
+
+![Gitlab CI Information](http://ci.streusel.org/projects/1/status.png?ref=master)
+
+`tcf2nif` is a NLP data converter from the TCF format (used by WebLicht) to the RDF-based NIF format. At the moment, it has a limited functionality.
+
+## License
+
+tcf2nif is released under the GNU Lesser General Public License (version 3). See `LICENSE.txt` for details.
+
+
+## Version History
+
+### 0.2.1 - tiny correction for making CI succeed again (30 Oct 2015)
+
+- support for a new test output directory was added, now CI succeeds again
+
+### 0.2.0 - First working exe scripts (30 Oct 2015)
+
+- Adds first versions of the executable scripts for doc conversions
+
+    - __txt2tcf__ (converts plain text to TCF, using WebLicht)
+    - __tcf2nif__ (converts TCF/WebLicht documents to NIF)
+
+### 0.1.0 - Initial prototype (22 Sep 2015)
+
+- This is the proof of concept version with minimal functionality
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tcf2nif'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tcf2nif
+
+## Usage
+
+See the [Jupyter notebook][notebook] for a hands-on experience and code examples.
+
+This gem provides a proof of concept for reading TCF data (the file format used by [the WebLicht services][weblicht]).
+
+### Reading TCF documents
+
+In a nutshell, an instance of a TcfDocument can be obtained from any `IO` object that contains a representation of a TCF XML stream:
+
+``` Ruby
+@tcf_document = Tcf2Nif::TcfDocument.new(@io)
+```
+
+where `@io` is a Ruby IO object (a file, a stream, etc.). This TCF document can then be queried in different ways:
+
+``` Ruby
+# get the primary text
+puts @tcf_document.text
+# get an enumeration of Tcf2Nif::Token instances.
+# these tokens contain the word form,
+# and, if the respective services have been performed,
+# also some annotations.
+@tcf_document.tokens.each do |token|
+  # do something clever with the tokens
+  puts token.form
+  puts token.pos?    # true iff pos annotation is present
+  puts token.lemma?  # true iff lemma annotation is present
+  puts token.pos     # returns the pos annotation
+  puts token.lemma   # returns the lemma annotation  
+end
+# Depending on what is present in the TCF file,
+# you can also access some other levels of annotations:
+@tcf_document.geo_annotations
+@tcf_document.dependency_map
+```
+
+### Conversion to NIF
+
+The `Tcf2Nif::Transformer` class provides instances that can convert from a TCF document to an RDF graph containing NIF.
+
+``` Ruby
+@transformer = Tcf2Nif::Transformer.new(@tcf_doc, {})
+graph = @trans.transform() # creates an instance of RDF::Graph
+puts graph.size
+RDF::Writer.open('path/to/outputfile'), :format => :ntriples) do |writer|
+  writer << RDF::Repository.new do |repo|
+    repo << graph
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec tcf2nif` to use the code located in this directory, ignoring other installed copies of this gem.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/tcf2nif/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+[notebook]: ./Tcf2Nif.ipynb "The Tcf2Nif Jupyter Notebook"
+[weblicht]: http://weblicht.sfs.uni-tuebingen.de/weblichtwiki/index.php/Main_Page

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/Tcf2Nif.ipynb

@@ -0,0 +1,197 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Comparison of the different conversion routines\n",
+    "\n",
+    "First, import the relevant stuff."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "metadata": {
+    "collapsed": false,
+    "scrolled": false
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "Object"
+      ]
+     },
+     "execution_count": 5,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "require 'rspec'\n",
+    "require 'tcf2nif'\n",
+    "include Tcf2Nif"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {
+    "collapsed": true
+   },
+   "source": [
+    "## Vanilla NIF approach\n",
+    "\n",
+    "Then create our sample documents and a transformer object. "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "metadata": {
+    "collapsed": false
+   },
+   "outputs": [],
+   "source": [
+    "@testfile = File.open(File.join('.', 'spec', 'assets', 'phantom.xml'), 'r')\n",
+    "@tcf_doc = TcfDocument.new(@testfile)\n",
+    "@trans = Transformer.new(@tcf_doc, {})"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Now, for the vanilla approach, we do a basic conversion."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "collapsed": false
+   },
+   "outputs": [],
+   "source": [
+    "graph = @trans.transform(:noprov)\n",
+    "puts graph.size"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "We can also run the `noprov` RSpec tasks. "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "collapsed": false
+   },
+   "outputs": [],
+   "source": [
+    "RSpec.configure do |config|\n",
+    "  config.filter_run_including :noprov => true\n",
+    "  config.run_all_when_everything_filtered = true\n",
+    "end\n",
+    "RSpec::Core::Runner::run(['spec'])"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Plain NIF approach\n",
+    "\n",
+    "This approach reifies some of the RDF in order to make annotations identifiable. "
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Finally, read TCF, transform to NIF, and show us the number of triples."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "collapsed": false
+   },
+   "outputs": [],
+   "source": []
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "collapsed": true
+   },
+   "outputs": [],
+   "source": []
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Pos Tagger Comparison\n",
+    "\n",
+    "This section contains SPARQL stuff for comparing POS taggers. With plain NIF, a query could be something like this:"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "```SPARQL\n",
+    "prefix xsd:  <http://www.w3.org/2001/XMLSchema#>\n",
+    "prefix skos: <http://www.w3.org/2004/02/skos/core#>\n",
+    "prefix owl:  <http://www.w3.org/2002/07/owl#>\n",
+    "prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#>\n",
+    "prefix rdf:  <http://www.w3.org/1999/02/22-rdf-syntax-ns#>\n",
+    "prefix nif:  <http://persistence.uni-leipzig.org/nlp2rdf/ontologies/nif-core#>\n",
+    "prefix penn: <http://purl.org/olia/penn.owl#>\n",
+    "prefix ex:   <http://example.org/tcf2nif/example.txt#>\n",
+    "\n",
+    "SELECT ?begin ?end ?anchor ?pos WHERE {\n",
+    "  ?nif\n",
+    "    nif:beginIndex ?begin ;\n",
+    "    nif:endIndex ?end ;\n",
+    "    nif:beginIndex \"4991\"^^xsd:nonNegativeInteger ;\n",
+    "    nif:anchorOf ?anchor ;\n",
+    "    nif:oliaLink ?pos .\n",
+    "}\n",
+    "```"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "results in two answers:\n",
+    "\n",
+    "- 4991, 4996, judge, <http://purl.org/olia/penn.owl#NN>\n",
+    "- 4991, 4996, judge, <http://purl.org/olia/penn.owl#VB>"
+   ]
+  }
+ ],
+ "metadata": {
+  "celltoolbar": "Raw Cell Format",
+  "kernelspec": {
+   "display_name": "Ruby 2.2.1",
+   "language": "ruby",
+   "name": "ruby"
+  },
+  "language_info": {
+   "file_extension": "rb",
+   "mimetype": "application/x-ruby",
+   "name": "ruby",
+   "version": "2.2.1"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 0
+}