opener-coreference 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7d548066b2b01126731767de74d0d65b6d4e97e
-  data.tar.gz: da1251f7753ba64023a08530e5eec5297885e248
+  metadata.gz: a4c0ed7263d9611c6b45b61763fb537123f6c013
+  data.tar.gz: 23d975c528e4b83344dd00b3340a0d87839a47ea
 SHA512:
-  metadata.gz: ca8028edf7ed4ca51ff9c566cd6b4446b94d4f39aebf39d9ecc0fb841b8a03000eea9898d98c9380a90f293f027f7f48739f579e9e90cb5f2d8b7208f5025f69
-  data.tar.gz: 4dbee8e088a0fe050813c3e0ad05dfe13dd39b73ac5259355bdcf39eb094ba21c28e92e635d15f18ee3e24d8a5a727497e1390bba2b54728576a8674de3e36f4
+  metadata.gz: 372ac8cd1630f9273577caf8a5731e64c9566ce246ef98ab49a16a22a18caeffd841d6dd7511f589525ad648497026b149cc928e6cf081cdfa16908a3cff15a8
+  data.tar.gz: ea6b8eee06116d21c78c052a5e6d84aba32dc7becfc56626bfb6b6e0dc07cd92644dc97ee682787be08334e0d7419cd6a67e8cc9a3bbd7a9da4224427fc60274

data/README.md

@@ -11,11 +11,8 @@ The implementation is a result of a collaboration between the IXA NLP <http://ix
 
 ### Confused by some terminology?
 
-This software is part of a larger collection of natural language processing
-tools known as "the OpeNER project". You can find more information about the
-project at [the OpeNER portal](http://opener-project.github.io). There you can
-also find references to terms like KAF (an XML standard to represent linguistic
-annotations in texts), component, cores, scenario's and pipelines.
+This software is part of a larger collection of natural language processing tools known as "the OpeNER project". You can find more information about the project at [the OpeNER portal](http://opener-project.github.io). There you can also find references to terms like KAF (an XML standard to represent linguistic annotations in texts), component, cores, scenario's and pipelines.
+
 
 Quick Use Example
 -----------------
@@ -24,13 +21,11 @@ Installing the coreference can be done by executing:
 
     gem install opener-coreference
 
-Please bare in mind that all components in OpeNER take KAF as an input and
-output KAF by default.
+Please bare in mind that all components in OpeNER take KAF as an input and output KAF by default.
 
 ### Command line interface
 
-You should now be able to call the coreference as a regular shell
-command: by its name. Once installed the gem normalyl sits in your path so you can call it directly from anywhere.
+You should now be able to call the coreference as a regular shell command: by its name. Once installed the gem normalyl sits in your path so you can call it directly from anywhere.
 
 This aplication reads a text from standard input in order to identify the language.
 
@@ -62,26 +57,20 @@ You can launch a language identification webservice by executing:
 
     coreference-server
 
-This will launch a mini webserver with the webservice. It defaults to port 9292,
-so you can access it at <http://localhost:9292>.
+This will launch a mini webserver with the webservice. It defaults to port 9292, so you can access it at <http://localhost:9292>.
 
-To launch it on a different port provide the `-p [port-number]` option like
-this:
+To launch it on a different port provide the `-p [port-number]` option like this:
 
     coreference-server -p 1234
 
 It then launches at <http://localhost:1234>
 
-Documentation on the Webservice is provided by surfing to the urls provided
-above. For more information on how to launch a webservice run the command with
-the ```-h``` option.
+Documentation on the Webservice is provided by surfing to the urls provided above. For more information on how to launch a webservice run the command with the ```-h``` option.
 
 
 ### Daemon
 
-Last but not least the coreference comes shipped with a daemon that
-can read jobs (and write) jobs to and from Amazon SQS queues. For more
-information type:
+Last but not least the coreference comes shipped with a daemon that can read jobs (and write) jobs to and from Amazon SQS queues. For more information type:
 
     coreference-daemon -h
 
@@ -89,8 +78,7 @@ information type:
 Description of dependencies
 ---------------------------
 
-This component runs best if you run it in an environment suited for OpeNER
-components. You can find an installation guide and helper tools in the [OpeNER installer](https://github.com/opener-project/opener-installer) and an
+This component runs best if you run it in an environment suited for OpeNER components. You can find an installation guide and helper tools in the [OpeNER installer](https://github.com/opener-project/opener-installer) and an
 [installation guide on the Opener Website](http://opener-project.github.io/getting-started/how-to/local-installation.html)
 
 At least you need the following system setup:
@@ -103,12 +91,7 @@ At least you need the following system setup:
 Adapting CorefGraph-en to your language
 ---------------------------------------
 
-There are a number of changes needed to be made to make CorefGraph works for
-other languages. Although we have try to keep the language dependent features
-to a minimum, you will still need to create some dictionaries for your own
-language and make some very minor changes in the code. Here is the list of very
-file in the Corefgraph module that needs to be changed.  Every change except
-one (see below) to be done in the **$project/core/corefgraph/resources** directory:
+There are a number of changes needed to be made to make CorefGraph works for other languages. Although we have try to keep the language dependent features to a minimum, you will still need to create some dictionaries for your own language and make some very minor changes in the code. Here is the list of very file in the Corefgraph module that needs to be changed. Every change except one (see below) to be done in the **$project/core/corefgraph/resources** directory:
 
 * dictionaries/$lang\_determiners.py
 * dictionaries/$lang\_pronouns.py
@@ -137,22 +120,21 @@ one (see below) to be done in the **$project/core/corefgraph/resources** directo
 The Core
 --------
 
-The component is a fat wrapper around the actual language technology core. You
-can find the core technolies in the following repositories:
+The component is a fat wrapper around the actual language technology core. You can find the core technolies in the following repositories:
 
 * [Coreference-base](https://github.com/opener-project/coreference-base)
 
 Where to go from here
 ---------------------
 
-* [Check the project websitere](http://opener-project.github.io)
+* [Check the project website](http://opener-project.github.io)
 * [Checkout the webservice](http://opener.olery.com/coreference)
 
 Report problem/Get help
 -----------------------
 
-If you encounter problems, please email <support@opener-project.eu> or leave an
-issue in the [issue tracker](https://github.com/opener-project/coreference/issues).
+If you encounter problems, please email <support@opener-project.eu> or leave an issue in the 
+[issue tracker](https://github.com/opener-project/coreference/issues).
 
 
 Contributing

data/lib/opener/coreference.rb

@@ -4,6 +4,7 @@ require 'nokogiri'
 
 require_relative 'coreference/version'
 require_relative 'coreference/cli'
+require_relative 'coreference/error_layer'
 
 module Opener
   class Coreference
@@ -37,16 +38,22 @@ module Opener
     # @return [Array]
     #
     def run(input)
-      language = language_from_kaf(input)
-      args = options[:args].dup
+      begin
+        language = language_from_kaf(input)
+        args = options[:args].dup
 
-      if language_constant_defined?(language)
-        kernel = language.new(:args => args)
-      else
-        kernel = Coreferences::Base.new(:args => args, :language => language)
+        if language_constant_defined?(language)
+          kernel = language.new(:args => args)
+        else
+          kernel = Coreferences::Base.new(:args => args, :language => language)
+        end
+        stdout, stderr, process = kernel.run(input)
+        raise stderr unless process.success?
+        return stdout
+        
+      rescue Exception => error
+        return ErrorLayer.new(input, error.message, self.class).add
       end
-
-      return kernel.run(input)
     end
 
     protected

data/lib/opener/coreference/cli.rb

@@ -57,13 +57,7 @@ Supported Languages (taken from kaf lang element):
 
         stdout, stderr, process = tokenizer.run(input)
 
-        if process.success?
-          puts stdout
-
-          STDERR.puts(stderr) unless stderr.empty?
-        else
-          abort stderr
-        end
+        puts stdout
       end
 
       private

data/lib/opener/coreference/error_layer.rb

@@ -0,0 +1,88 @@
+module Opener
+  class Coreference
+    ##
+    # Add Error Layer to KAF file instead of throwing an error.
+    #
+    class ErrorLayer
+      attr_accessor :input, :document, :error, :klass
+      
+      def initialize(input, error, klass)
+        @input    = input.to_s
+        # Make sure there is always a document, even if it is empty.
+        @document = Nokogiri::XML(input) rescue Nokogiri::XML(nil)
+        @error    = error
+        @klass    = klass
+      end
+      
+      def add
+        if is_xml?
+          unless has_errors_layer?
+            add_errors_layer
+          end
+        else
+          add_root
+          add_text
+          add_errors_layer
+        end
+        add_error
+        
+        xml = !!document.encoding ? document.to_xml : document.to_xml(:encoding => "UTF-8")
+        
+        return xml
+      end
+      
+      ##
+      # Check if the document is a valid XML file.
+      #
+      def is_xml?
+        !!document.root
+      end
+      
+      ##
+      # Add root element to the XML file.
+      #
+      def add_root
+        root = Nokogiri::XML::Node.new "KAF", document
+        document.add_child(root)
+      end
+      
+      ##
+      # Check if the document already has an errors layer.
+      #
+      def has_errors_layer?
+        !!document.at('errors')
+      end
+      
+      ##
+      # Add errors element to the XML file.
+      #
+      def add_errors_layer
+        node = Nokogiri::XML::Node.new "errors", document
+        document.root.add_child(node)
+      end
+      
+      ##
+      # Add the text file incase it is not a valid XML document. More
+      # info for debugging.
+      #
+      def add_text
+        node = Nokogiri::XML::Node.new "raw", document
+        node.inner_html = input
+        document.root.add_child(node)
+        
+      end
+      
+      ##
+      # Add the actual error to the errors layer.
+      #
+      def add_error
+        node = document.at('errors')
+        error_node = Nokogiri::XML::Node.new "error", node
+        error_node['class']   = "#{klass.to_s} #{klass::VERSION}"
+        error_node.inner_html = error
+        node.add_child(error_node)
+      end     
+      
+    end # ErrorLayer
+  end # Coreference
+end # Opener

data/lib/opener/coreference/version.rb

@@ -1,5 +1,5 @@
 module Opener
   class Coreference
-    VERSION = "1.0.3"
+    VERSION = "1.0.4"
   end
 end

metadata

@@ -1,147 +1,147 @@
 --- !ruby/object:Gem::Specification
 name: opener-coreference
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - development@olery.com
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-05-23 00:00:00.000000000 Z
+date: 2014-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.4'
+  prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency
   name: httpclient
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
   prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: nokogiri
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
   prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: opener-coreference-base
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: opener-coreference-base
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
   prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: opener-webservice
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: opener-webservice
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
   prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: puma
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: puma
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
   prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: opener-daemons
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: opener-daemons
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+  type: :runtime
 - !ruby/object:Gem::Dependency
   name: opener-core
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.1.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.1.2
+  prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  prerelease: false
+  type: :development
 description: Gem that wraps the coreference code
-email: 
+email:
 executables:
 - coreference
-- coreference-server
 - coreference-daemon
+- coreference-server
 extensions: []
 extra_rdoc_files: []
 files:
@@ -153,33 +153,33 @@ files:
 - exec/coreference.rb
 - lib/opener/coreference.rb
 - lib/opener/coreference/cli.rb
+- lib/opener/coreference/error_layer.rb
 - lib/opener/coreference/public/markdown.css
 - lib/opener/coreference/server.rb
 - lib/opener/coreference/version.rb
 - lib/opener/coreference/views/index.erb
 - opener-coreference.gemspec
-homepage: 
+homepage:
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
+rubyforge_project:
 rubygems_version: 2.2.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Gem that wraps the coreference code
 test_files: []
-has_rdoc: yard