opener-kaf-naf-parser 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b56f23da566c734261e96e6ffb2ce0d70e1ddb76
-  data.tar.gz: acf4525a3c6783ab154a2be067a61b4eb0d6f669
+  metadata.gz: 6f5aaa78b3700c42cc998864b448bb9d68ec528a
+  data.tar.gz: 8548321691a1ed22ceec59df5b668428766dae6f
 SHA512:
-  metadata.gz: 0df0b939aaea16c508084f64abf55c523cedec7eb6fbed566bd8ab07a4f445f61e01603bdbb6379c4df9975ff4d9461d5a170b578a395b1c966319f47fe28788
-  data.tar.gz: fdd941e5c62e566d0989de1562f4048b15864f79e6a26c1bfdc3c8fff49e6baca8209d3e021317cd1d0edbde8a90d1d870bfaf84daf7ee03e86929f3ac38dffa
+  metadata.gz: 0d63c868e56951e07d3588f8c8daeb0e77daeeeb2ba9f7ef4b7c81ffb08859133616ed8de27ad90c6578364fa338066de20cf45e97d9e35e892653c9e7178735
+  data.tar.gz: b305e47c22c75ce957b12bc44e640db1e31ba1df9e5143cc00c9744749ae75f4d45d7ee0d5257995f9cda5233ca3293d810e91ddf968bc6d714dc735f6e7aaa2

data/README.md

@@ -1,5 +1,4 @@
-Introduction
-------------
+# KAF NAF Parser
 
 This library converts KAF to NAF and NAF to KAF. It also contains a webservice
 for doing exactly this.
@@ -16,14 +15,13 @@ 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
------------------
+## Quick Use Example
 
 Installing the kaf-naf-parser can be done by executing:
 
     gem install opener-kaf-naf-parser
 
-Please bare in mind that all components in OpeNER take KAF as an input and
+Please keep in mind that all components in OpeNER take KAF as an input and
 output KAF by default.
 
 It ships with 3 command line tools and a webservice:
@@ -57,8 +55,12 @@ jobs (and write) jobs to and from Amazon SQS queues. For more information type:
 
     kaf-naf-parser-daemon -h
 
-Description of dependencies
----------------------------
+## Description of dependencies
+
+The working part of this OpeNER component is the KafNafParserPy Python library.
+More documentation on this library can be found here
+http://kyoto.let.vu.nl/~izquierdo/api/KafNafParserPy/ and at
+[KafNafParserPy Github Page](https://github.com/cltl/KafNafParserPy).
 
 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
@@ -72,21 +74,18 @@ At least you need the following system setup:
 * Ruby 1.9.3 or newer
 * Python 2.6
 
-Where to go from here
----------------------
+## Where to go from here
 
 * [Check the project website](http://opener-project.github.io)
 * [Checkout the webservice](http://opener.olery.com/kaf-naf-parser)
 
-Report problem/Get help
------------------------
+## 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/kaf-naf-parser/issues).
 
-Contributing
-------------
+## Contributing
 
 1. Fork it <http://github.com/opener-project/kaf-naf-parser/fork>
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/bin/kaf-naf-parser

@@ -2,7 +2,7 @@
 
 require_relative '../lib/opener/kaf_naf_parser'
 
-cli = Opener::KafNafParser::CLI.new(:args => ARGV)
+cli = Opener::KafNafParser::CLI.new
 
-cli.run(STDIN.tty? ? nil : STDIN.read)
+cli.run
 

data/bin/kaf-naf-parser-daemon

@@ -2,9 +2,9 @@
 
 require 'opener/daemons'
 
-exec_path = File.expand_path('../../exec/kaf-naf-parser.rb', __FILE__)
-
-Opener::Daemons::Controller.new(
+controller = Opener::Daemons::Controller.new(
   :name      => 'kaf-naf-parser',
-  :exec_path => exec_path
-)
+  :exec_path => File.expand_path('../../exec/kaf-naf-parser.rb', __FILE__)
+)
+
+controller.run

data/bin/kaf-naf-parser-server

@@ -1,8 +1,10 @@
 #!/usr/bin/env ruby
 
-require 'puma/cli'
+require 'opener/webservice'
 
-rack_config = File.expand_path('../../config.ru', __FILE__)
+parser = Opener::Webservice::OptionParser.new(
+  'opener-kaf-naf-parser',
+  File.expand_path('../../config.ru', __FILE__)
+)
 
-cli = Puma::CLI.new([rack_config] + ARGV)
-cli.run
+parser.run

data/bin/kaf-to-naf

@@ -2,6 +2,6 @@
 
 require_relative '../lib/opener/kaf_naf_parser'
 
-cli = Opener::KafNafParser::CLI.new(:args => ARGV, :conversion=>"to-naf")
+cli = Opener::KafNafParser::CLI.new
 
-cli.run(STDIN.tty? ? nil : STDIN.read)
+cli.run(ARGV + ['--nonaf'])

data/bin/naf-to-kaf

@@ -2,6 +2,6 @@
 
 require_relative '../lib/opener/kaf_naf_parser'
 
-cli = Opener::KafNafParser::CLI.new(:args => ARGV, :conversion=>"to-kaf")
+cli = Opener::KafNafParser::CLI.new
 
-cli.run(STDIN.tty? ? nil : STDIN.read)
+cli.run(ARGV + ['--tokaf'])

data/config.ru

@@ -1,4 +1,3 @@
 require File.expand_path('../lib/opener/kaf_naf_parser', __FILE__)
-require File.expand_path('../lib/opener/kaf_naf_parser/server', __FILE__)
 
 run Opener::KafNafParser::Server

data/core/kaf-naf-parser.py

@@ -8,7 +8,7 @@ this_folder = os.path.dirname(os.path.realpath(__file__))
 # can be used to load packages (e.g. a locally installed copy of lxml).
 sys.path.append(os.path.join(this_folder, 'site-packages/pre_install'))
 
-from KafNafParser import KafNafParser
+from KafNafParserPy import KafNafParser
 
 def main(argv):
   conversion = ""

data/exec/kaf-naf-parser.rb

@@ -1,9 +1,9 @@
 #!/usr/bin/env ruby
 
 require 'opener/daemons'
+
 require_relative '../lib/opener/kaf_naf_parser'
 
-options = Opener::Daemons::OptParser.parse!(ARGV)
-daemon  = Opener::Daemons::Daemon.new(Opener::KafNafParser, options)
+daemon = Opener::Daemons::Daemon.new(Opener::KafNafParser)
 
-daemon.start
+daemon.start

data/lib/opener/kaf_naf_parser.rb

@@ -1,8 +1,9 @@
 require 'open3'
-require 'optparse'
+require 'slop'
 
 require_relative 'kaf_naf_parser/version'
 require_relative 'kaf_naf_parser/cli'
+require_relative 'kaf_naf_parser/server'
 
 module Opener
   ##
@@ -20,8 +21,8 @@ module Opener
     # @return [Hash]
     #
     DEFAULT_OPTIONS = {
-      :args => [],
-      :conversion => "to-kaf"
+      :args       => [],
+      :conversion => 'to-kaf'
     }.freeze
 
     ##
@@ -40,26 +41,49 @@ module Opener
     # @return [String]
     #
     def command
-      return "python -E #{kernel} #{options[:args].join(' ')} #{conversion}"
+      args = options[:args].join(' ')
+
+      return "python -E #{kernel} #{args} #{conversion}"
     end
 
+    ##
+    # @return [String]
+    #
     def conversion
       "--#{options[:conversion].gsub(/-/,'')}"
     end
 
     ##
-    # Processes the input and returns an Array containing the output of STDOUT,
-    # STDERR and an object containing process information.
+    # Processes a given input KAF/NAF document and returns a new document in the
+    # opposite format.
     #
-    # @param [String] input The text of which to detect the language.
-    # @return [Array]
+    # @param [String] input
+    # @return [String]
     #
     def run(input)
-      return Open3.capture3(command, :stdin_data => input)
+      stdout, stderr, process = capture(input)
+
+      raise stderr unless process.success?
+
+      return stdout
     end
 
     protected
 
+    ##
+    # capture3 method doesn't work properly with Jruby, so
+    # this is a workaround
+    #
+    def capture(input)
+      Open3.popen3(*command.split(" ")) {|i, o, e, t|
+        out_reader = Thread.new { o.read }
+        err_reader = Thread.new { e.read }
+        i.write input
+        i.close
+        [out_reader.value, err_reader.value, t.value]
+      }
+    end
+
     ##
     # @return [String]
     #

data/lib/opener/kaf_naf_parser/cli.rb

@@ -1,92 +1,66 @@
 module Opener
   class KafNafParser
     ##
-    # CLI wrapper around {Opener::LanguageIdentifier} using OptionParser.
+    # CLI wrapper around {Opener::KafNafParser} using Slop.
     #
-    # @!attribute [r] options
-    #  @return [Hash]
-    # @!attribute [r] option_parser
-    #  @return [OptionParser]
+    # @!attribute [r] parser
+    #  @return [Slop]
     #
     class CLI
-      attr_reader :options, :option_parser
+      attr_reader :parser
+
+      def initialize
+        @parser = configure_slop
+      end
 
       ##
-      # @param [Hash] options
+      # @param [Array] argv
       #
-      def initialize(options = {})
-        @options = DEFAULT_OPTIONS.merge(options)
-
-        @option_parser = OptionParser.new do |opts|
-          opts.program_name   = 'kaf-naf-parser'
-          opts.summary_indent = '  '
-
-          opts.on('-h', '--help', 'Shows this help message') do
-            show_help
-          end
-
-          opts.on('-v', '--version', 'Shows the current version') do
-            show_version
-          end
+      def run(argv = ARGV)
+        parser.parse(argv)
+      end
 
-          opts.on('-k', '--tokaf', 'Parses input to KAF') do
-            @options[:conversion] = "to-kaf"
-          end
+      ##
+      # @return [Slop]
+      #
+      def configure_slop
+        return Slop.new(:strict => false, :indent => 2, :help => true) do
+          banner 'Usage: kaf-naf-parser [OPTIONS]'
 
-          opts.on('-n', '--tonaf', 'Parses input to NAF') do
-            @options[:conversion] = "to-naf"
-          end
+          separator <<-EOF.chomp
 
-          opts.on('-l', '--log', 'Enable logging to STDERR') do
-            @options[:logging] = true
-          end
+About:
 
-          opts.separator <<-EOF
+    Component for converting KAF documents to NAF documents and vice-versa.
+    This command reads input from STDIN.
 
-Examples:
+Example:
 
-  cat example.kaf | #{opts.program_name} --tonaf    # Basic usage
-  cat example.kaf | #{opts.program_name} --tonaf -l # Logs information to STDERR
+    cat some_file.kaf | kaf-naf-parser --tonaf
           EOF
-        end
-      end
 
-      ##
-      # @param [String] input
-      #
-      def run(input)
-        option_parser.parse!(options[:args])
+          separator "\nOptions:\n"
 
-        tagger = KafNafParser.new(options)
+          on :v, :version, 'Shows the current version' do
+            abort "kaf-naf-parser v#{VERSION} on #{RUBY_DESCRIPTION}"
+          end
 
-        stdout, stderr, process = tagger.run(input)
+          on :k, :tokaf, 'Converts NAF to KAF'
+          on :n, :tonaf, 'Converts KAF to NAF'
 
-        if process.success?
-          puts stdout
+          run do |opts, args|
+            conversion = opts[:tonaf] ? 'to-naf' : 'to-kaf'
+            parser     = KafNafParser.new(
+              :args       => args,
+              :conversion => conversion
+            )
 
-          if options[:logging] and !stderr.empty?
-            STDERR.puts(stderr)
+            input = STDIN.tty? ? nil : STDIN.read
+
+            puts parser.run(input)
           end
-        else
-          abort stderr
         end
       end
-
-      private
-
-      ##
-      # Shows the help message and exits the program.
-      #
-      def show_help
-        abort option_parser.to_s
-      end
-
-      ##
-      # Shows the version and exits the program.
-      #
-      def show_version
-        abort "#{option_parser.program_name} v#{VERSION} on #{RUBY_DESCRIPTION}"
-      end
     end # CLI
   end # KafNafParser
 end # Opener

data/lib/opener/kaf_naf_parser/server.rb

@@ -1,5 +1,3 @@
-require 'sinatra/base'
-require 'httpclient'
 require 'opener/webservice'
 
 module Opener
@@ -7,10 +5,11 @@ module Opener
     ##
     # Polarity tagger server powered by Sinatra.
     #
-    class Server < Webservice
+    class Server < Webservice::Server
       set :views, File.expand_path('../views', __FILE__)
-      text_processor KafNafParser
-      accepted_params :input, :conversion
+
+      self.text_processor  = KafNafParser
+      self.accepted_params = [:conversion]
     end # Server
   end # KafNafParser
 end # Opener

data/lib/opener/kaf_naf_parser/version.rb

@@ -1,5 +1,5 @@
 module Opener
   class KafNafParser
-    VERSION = '1.1.0'
+    VERSION = '2.0.0'
   end # KafNafVersion
 end # Opener

data/opener-kaf-naf-parser.gemspec

@@ -1,16 +1,16 @@
 require File.expand_path('../lib/opener/kaf_naf_parser/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.name                  = 'opener-kaf-naf-parser'
-  gem.version               = Opener::KafNafParser::VERSION
-  gem.authors               = ['ruben.izquierdobevia@vu.nl','development@olery.com']
-  gem.summary               = 'Parser to translate KAF to NAF and back.'
-  gem.description           = gem.summary
-  gem.homepage              = "http://github.com/cltl/KafNafParserPy"
-  gem.required_ruby_version = '>= 1.9.2'
-  gem.extensions            = ['ext/hack/Rakefile']
+  gem.name        = 'opener-kaf-naf-parser'
+  gem.version     = Opener::KafNafParser::VERSION
+  gem.authors     = ['ruben.izquierdobevia@vu.nl','development@olery.com']
+  gem.summary     = 'Parser to translate KAF to NAF and back.'
+  gem.description = gem.summary
+  gem.homepage    = "http://github.com/cltl/KafNafParserPy"
+  gem.extensions  = ['ext/hack/Rakefile']
+  gem.license     = 'Apache 2.0'
 
-  gem.license = 'Apache 2.0'
+  gem.required_ruby_version = '>= 1.9.2'
 
   gem.files = Dir.glob([
     'core/*',
@@ -27,13 +27,11 @@ Gem::Specification.new do |gem|
 
   gem.executables = Dir.glob('bin/*').map { |file| File.basename(file) }
 
+  gem.add_dependency 'opener-daemons', '~> 2.2'
+  gem.add_dependency 'opener-webservice', '~> 2.1'
+  gem.add_dependency 'opener-core', '~> 2.2'
+
   gem.add_dependency 'builder'
-  gem.add_dependency 'sinatra', '~>1.4.3'
-  gem.add_dependency 'httpclient'
-  gem.add_dependency 'uuidtools'
-  gem.add_dependency 'opener-webservice'
-  gem.add_dependency 'puma'
-  gem.add_dependency 'opener-daemons'
 
   gem.add_development_dependency 'rspec', '~> 3.0'
   gem.add_development_dependency 'cucumber'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opener-kaf-naf-parser
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - ruben.izquierdobevia@vu.nl
@@ -9,94 +9,52 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-25 00:00:00.000000000 Z
+date: 2014-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: builder
-  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'
-- !ruby/object:Gem::Dependency
-  name: sinatra
+  name: opener-daemons
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.3
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.3
-- !ruby/object:Gem::Dependency
-  name: httpclient
-  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'
-- !ruby/object:Gem::Dependency
-  name: uuidtools
-  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'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: opener-webservice
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: puma
+  name: opener-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: opener-daemons
+  name: builder
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="