opener-pos-tagger 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 07f3de5037f2f39ec57ee5876be849250cfccbc4
-  data.tar.gz: 142309416cc14524f49cef9a9049697891475211
+  metadata.gz: 80ec8069d4c1890a8d2b7ecdaa701c19d0734870
+  data.tar.gz: 532bf8459370aeb8d8156caa4f3a07231a6efb7e
 SHA512:
-  metadata.gz: 42ef72b680c15793b8fe89664399821662a05cc456b758230567f947dfbba4f16b3a36045b01d1f24be40afdc1c5a4464d8d1d390314a36f7566fe3588c84b6c
-  data.tar.gz: 4dc50eec3b12499aa368dcf59b8cebd746f14f5fab0fcbed8a4aa5d5102917bbce853a3a137e2f400f0761c82c75dd7b1befa33280bdcf1bd7828fab9932ba2c
+  metadata.gz: e607af97829002ff07f436e300f7aa5facc1ce0675fbe31736ce3d5a322cf5479f96cbf8615be4acd003289558056489d3652e362b0802e6c69af47f8bb717c5
+  data.tar.gz: cf05156f800dd0a7c10dcf4e03e88b8adf2776d24e15e065b6b5ceab6b1fd4e8217b443a917d91bab6bed15bafabaabb483265fad59417705b2b7e41a9769a8b

data/README.md

@@ -5,11 +5,7 @@ Component that wraps the different existing POS Taggers.
 
 ### 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
 -----------------
@@ -18,13 +14,11 @@ Installing the pos-tagger can be done by executing:
 
     gem install opener-pos-tagger
 
-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 POS tagger 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 POS tagger 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.
 
@@ -74,8 +68,7 @@ Will result in
           </span>
         </term>
         <term lemma="text" morphofeat="FM" pos="O" tid="t_5" type="open">
-          <span>
-            <target id="w5"/>
+          <span>            <target id="w5"/>
           </span>
         </term>
       </terms>
@@ -87,34 +80,27 @@ You can launch a language identification webservice by executing:
 
     pos-tagger-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:
 
     pos-tagger-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 POS tagger 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 POS tagger comes shipped with a daemon that can read jobs (and write) jobs to and from Amazon SQS queues. For more information type:
 
     pos-tagger-daemon -h
 
 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 [installation guide on the Opener Website](http://opener-project.github.io/getting-started/how-to/local-installation.html)
+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:
 
@@ -135,22 +121,22 @@ Language Extension
 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: 
+
 <https://github.com/opener-project/?query=pos>
 <https://github.com/opener-project/?query=pos>
 
 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/pos-tagger)
 
 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/pos-tagger/issues).
+If you encounter problems, please email <support@opener-project.eu> or leave an issue in the 
+[issue tracker](https://github.com/opener-project/pos-tagger/issues).
 
 
 Contributing

data/lib/opener/pos_tagger.rb

@@ -6,6 +6,7 @@ require 'optparse'
 
 require_relative 'pos_tagger/version'
 require_relative 'pos_tagger/cli'
+require_relative 'pos_tagger/error_layer'
 
 module Opener
   ##
@@ -45,15 +46,19 @@ module Opener
     # @return [Array]
     #
     def run(input)
-      language = language_from_kaf(input)
+      begin
+        language = language_from_kaf(input)
 
-      unless valid_language?(language)
-        raise ArgumentError, "The specified language (#{language}) is invalid"
-      end
+        unless valid_language?(language)
+          raise ArgumentError, "The specified language (#{language}) is invalid"
+        end
 
-      kernel = language_constant(language).new(:args => options[:args])
+        kernel = language_constant(language).new(:args => options[:args])
 
-      return kernel.run(input)
+        return kernel.run(input)
+      rescue Exception => error
+        return ErrorLayer.new(input, error.message, self.class).add
+      end
     end
 
     alias tag run

data/lib/opener/pos_tagger/error_layer.rb

@@ -0,0 +1,85 @@
+module Opener
+  class POSTagger
+    ##
+    # 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
+        return document.to_xml(:encoding => "UTF-8")
+      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 # POSTagger
+end # Opener

data/lib/opener/pos_tagger/version.rb

@@ -1,5 +1,5 @@
 module Opener
   class POSTagger
-    VERSION = "2.1.0"
+    VERSION = "2.1.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opener-pos-tagger
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - development@olery.com
 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: opener-pos-tagger-base
@@ -209,6 +209,7 @@ files:
 - exec/pos-tagger.rb
 - lib/opener/pos_tagger.rb
 - lib/opener/pos_tagger/cli.rb
+- lib/opener/pos_tagger/error_layer.rb
 - lib/opener/pos_tagger/public/markdown.css
 - lib/opener/pos_tagger/server.rb
 - lib/opener/pos_tagger/version.rb
@@ -239,4 +240,3 @@ signing_key:
 specification_version: 4
 summary: Gem that wraps up the different existing pos-taggers
 test_files: []
-has_rdoc: yard