opener-ned 2.4.0 → 2.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 09f9b6ffd9cc7898e271c3c7c3a555798e261107
-  data.tar.gz: ae16fc7df8452b5585aa20f73eda8c5cfca3174f
+  metadata.gz: b6c0f8c10e46991a6c5d92768a4336a7112fdb52
+  data.tar.gz: 75f1f11a4d2f4e31e1bc479cf0e1a5b35535126c
 SHA512:
-  metadata.gz: 4a4f028aa1f9b75c78f8aa5414d5322fdac50452c192f6dffcd22a31a89827eb0bd6c51cb2cc42a7addacbe7f94701f6005c3fee8fdf7c6293c5210e562d0b2a
-  data.tar.gz: 1671a9ef77c20f1a8dea11e0ef4c1c03ecac70648abb3b34e180b4a62b7dc1624b1b18fd1bced94d0e1c7bd6a842387c93bcfaa791acbdfcde383acfae9e52b1
+  metadata.gz: 1c1a3843a2b23bef511adc25d4eebd5ac2072d62678d9a4ce59e7297c791dad092cc31d630b35589059d5f88d4d3b050a217d9e8c92d4b0c4b9e60447f3becb2
+  data.tar.gz: ca9bad5047147879798d6b237007d97918dc82a62eb2d5e6a1958ed2a8bf1b114cbbcb02f84d7ce51ffc0dc661d71aae01895bf9960023912a38f8c35b365913

data/lib/opener/ned/cli.rb

@@ -21,6 +21,8 @@ module Opener
           opts.program_name   = 'ned'
           opts.summary_indent = '  '
 
+          opts.separator "\nOptions:\n\n"
+
           opts.on('-h', '--help', 'Shows this help message') do
             show_help
           end
@@ -33,6 +35,10 @@ module Opener
             @options[:logging] = true
           end
 
+          opts.on('--no-time', 'Disables timestamps') do
+            @options[:enable_time] = false
+          end
+
           opts.separator <<-EOF
 
 Examples:

data/lib/opener/ned/version.rb

@@ -1,5 +1,5 @@
 module Opener
   class Ned
-    VERSION = '2.4.0'
+    VERSION = '2.4.1'
   end # Ned
 end # Opener

data/lib/opener/ned.rb

@@ -2,6 +2,7 @@ require 'optparse'
 require 'java'
 require 'stringio'
 require 'nokogiri'
+require 'opener/core'
 
 require File.expand_path('../../../core/target/ehu-ned-1.0.jar', __FILE__)
 
@@ -9,12 +10,11 @@ require_relative 'ned/version'
 require_relative 'ned/cli'
 
 import 'java.io.InputStreamReader'
-
 import 'ixa.kaflib.KAFDocument'
 
 module Opener
   ##
-  # Ruby wrapper around the Java based Ned tool that's powered by DBpedia.
+  # Ruby wrapper around the Java based NED tool that's powered by DBpedia.
   #
   # @!attribute [r] options
   #  @return [Hash]
@@ -22,17 +22,22 @@ module Opener
   class Ned
     attr_reader :options
 
+    ##
+    # The DBpedia endpoints for every language code.
+    #
+    # @return [Hash]
+    #
     LANGUAGE_ENDPOINTS = {
-      "en"=>"http://spotlight.sztaki.hu:2222",
-      "nl"=>"http://nl.dbpedia.org/spotlight",
-      "fr"=>"http://spotlight.sztaki.hu:2225",
-      "de"=>"http://de.dbpedia.org/spotlight",
-      "es"=>"http://spotlight.sztaki.hu:2231",
-      "it"=>"http://spotlight.sztaki.hu:2230",
-      "ru"=>"http://spotlight.sztaki.hu:2227",
-      "pt"=>"http://spotlight.sztaki.hu:2228",
-      "hu"=>"http://spotlight.sztaki.hu:2229",
-      "tr"=>"http://spotlight.sztaki.hu:2235"
+      "en" => "http://spotlight.sztaki.hu:2222",
+      "nl" => "http://nl.dbpedia.org/spotlight",
+      "fr" => "http://spotlight.sztaki.hu:2225",
+      "de" => "http://de.dbpedia.org/spotlight",
+      "es" => "http://spotlight.sztaki.hu:2231",
+      "it" => "http://spotlight.sztaki.hu:2230",
+      "ru" => "http://spotlight.sztaki.hu:2227",
+      "pt" => "http://spotlight.sztaki.hu:2228",
+      "hu" => "http://spotlight.sztaki.hu:2229",
+      "tr" => "http://spotlight.sztaki.hu:2235"
     }
 
     ##
@@ -41,8 +46,9 @@ module Opener
     # @return [Hash]
     #
     DEFAULT_OPTIONS = {
-      :args    => [],
-      :logging => false
+      :args        => [],
+      :logging     => false,
+      :enable_time => true
     }.freeze
 
     ##
@@ -54,49 +60,84 @@ module Opener
     # @option options [TrueClass|FalseClass] :logging When set to `true`
     #  logging is enabled. This is disabled by default.
     #
+    # @option options [TrueClass|FalseClass] :enable_time When set to `true`
+    #  the output will include timestamps.
+    #
     def initialize(options = {})
       @options = DEFAULT_OPTIONS.merge(options)
     end
 
+    ##
+    # Performs NED on the given input document. The return value is the
+    # resulting KAF document.
+    #
+    # @param [String] input The input KAF document.
+    # @return [String]
+    #
     def run(input)
-      begin
-        if !input or input.strip.empty?
-          raise ArgumentError, 'No input specified'
-        end
+      if !input or input.strip.empty?
+        raise ArgumentError, 'No input specified'
+      end
 
-        language = language_from_kaf(input)
+      language  = language_from_kaf(input)
+      input_io  = StringIO.new(input)
+      reader    = InputStreamReader.new(input_io.to_inputstream)
+      document  = KAFDocument.create_from_stream(reader)
+      annotator = new_annotator
+      endpoint  = options.fetch(:endpoint, uri_for_language(language))
 
-        input_io  = StringIO.new(input)
-        reader    = InputStreamReader.new(input_io.to_inputstream)
-        document  = KAFDocument.create_from_stream(reader)
-        annotator = Java::ehu.ned.Annotate.new
+      annotator.disambiguateNEsToKAF(
+        document,
+        endpoint.to_s
+      )
 
-        annotator.disableLogging unless options[:logging]
+      return document.to_string
 
-        endpoint = options.fetch(:endpoint, uri_for_language(language))
+    rescue Exception => error
+      return Opener::Core::ErrorLayer.new(input, error.message, self.class).add
+    end
 
-        annotator.disambiguateNEsToKAF(
-          document,
-          endpoint.to_s
-        )
+    private
+
+    ##
+    # Creates and configures a new Annotate class.
+    #
+    # @return [Java::ehu.ned.Annotate]
+    #
+    def new_annotator
+      annotator = Java::ehu.ned.Annotate.new
 
-        return document.to_string
+      unless options[:logging]
+        annotator.disableLogging
+      end
 
-      rescue Exception => error
-        return Opener::Core::ErrorLayer.new(input, error.message, self.class).add
+      unless options[:enable_time]
+        annotator.disableTimestamp
       end
-    end
 
-    private
+      return annotator
+    end
 
+    ##
+    # Returns the language from the KAF document.
+    #
+    # @param [String] input The input KAF document.
+    # @return [String]
+    #
     def language_from_kaf(input)
       document = Nokogiri::XML(input)
-      language = document.at('KAF').attr('xml:lang')
+
+      return document.at('KAF').attr('xml:lang')
     end
 
+    ##
+    # Returns the endpoint URL for the given language.
+    #
+    # @param [String] language
+    # @return [String]
+    #
     def uri_for_language(language)
-      LANGUAGE_ENDPOINTS[language]+"/rest/disambiguate"
+      return LANGUAGE_ENDPOINTS[language] + "/rest/disambiguate"
     end
-
   end # Ned
 end # Opener

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opener-ned
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.4.1
 platform: ruby
 authors:
 - development@olery.com
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-06-24 00:00:00.000000000 Z
+date: 2014-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra