opener-constituent-parser 1.2.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17c9bf39ed9de3611af506a873d80ffe2c97c62d
-  data.tar.gz: 187167d805ca45c4e8efc203c8dced7df507fb52
+  metadata.gz: 5d4d5d7dee45b0d08dce3332e006938f7eaa7bb9
+  data.tar.gz: ccc39744d5b99cdf0ee50fc24fe06f470b05cefa
 SHA512:
-  metadata.gz: 04922fb8abd60ecbacb764c1aa99f6b517bc382848c7d2cb58dd44f1156a56211fb0c1677fbf7da3bc2a603bbd2b5ef9bd095a763ec2f47fa76cce7a449ca028
-  data.tar.gz: 6ba8d3d75403ab77d29a5e7ad4f74214fc91c25ba5616570aa2b872f3d7c65b101c8a01b69714d0a0913f331b2dda74d3d7f74ce4f97745325b297de71ecda6c
+  metadata.gz: d2122084413b9222904f36b9298fce09415062890b2c585bcdbd6df810f2320659d1d076fc947ba18d23f8a3fac995253a22df710199c4d026b6e115572ba776
+  data.tar.gz: e287ac2e702360efcb619e5078fccf32769197a1cccc4f6575315c8f3dfb88442f9fa42d055798d93b9b5e88953fd0c85694c30bbda4c06c8981454a5e815765

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2014 OpeNER Project Consortium
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -1,7 +1,9 @@
-Constituent-Parser
-------------------
+# Constituent Parser
 
-The constituent parser wraps several other constituent parsers into a component that parses the 6 main opener languages. Each language uses it's own parser and core. For more information on the specific languages, please check the individual cores.
+The constituent parser wraps several other constituent parsers into a component
+that parses the 6 main opener languages. Each language uses it's own parser and
+core. For more information on the specific languages, please check the
+individual cores.
 
 * [English, Spanish and French](https://github.com/opener-project/constituent-parser-base) - OpeNER
 * [German](https://github.com/opener-project/constituent-parser-de) - Stanford Based
@@ -10,56 +12,59 @@ The constituent parser wraps several other constituent parsers into a component
 
 ### 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
------------------
+## Quick Use Example
 
 Installing the constituent-parser can be done by executing:
 
     gem install opener-constituent-parser
 
-Please bare in mind that all components in OpeNER take KAF as an input and output KAF by default.
+Please keep 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 constituent parser as a regular shell command: by its name. Once installed the gem normaly sits in your path so you can call it directly from anywhere.
+You should now be able to call the constituent parser as a regular shell
+command: by its name. Once installed the gem normaly 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.
+This aplication reads a text from standard input in order to identify the
+language.
 
     cat some_kind_of_kaf_file.kaf | constituent-parser
 
-
 This is an excerpt of an example output:
 
-```
-<!--he-->
-      <t id="ter761">
-        <span>
-          <target id="t761" />
-        </span>
-      </t>
-      <!--added-->
-      <t id="ter762">
-        <span>
-          <target id="t762" />
-        </span>
-      </t>
-      <!--.-->
-      <t id="ter763">
-        <span>
-          <target id="t763" />
-        </span>
-      </t>
-      <!--Tree edges-->
-      <edge id="tre2051" from="nter1328" to="nter1327" />
-      <edge id="tre2052" from="nter1329" to="nter1328" />
-      <edge id="tre2053" from="nter1330" to="nter1329" />
-      <edge id="tre2054" from="nter1331" to="nter1330" head="yes" />
-      <edge id="tre2055" from="nter1332" to="nter1331" head="yes" />
-      <edge id="tre2056" from="nter1333" to="nter1332" />
-
-```
+    <!--he-->
+    <t id="ter761">
+      <span>
+        <target id="t761" />
+      </span>
+    </t>
+    <!--added-->
+    <t id="ter762">
+      <span>
+        <target id="t762" />
+      </span>
+    </t>
+    <!--.-->
+    <t id="ter763">
+      <span>
+        <target id="t763" />
+      </span>
+    </t>
+    <!--Tree edges-->
+    <edge id="tre2051" from="nter1328" to="nter1327" />
+    <edge id="tre2052" from="nter1329" to="nter1328" />
+    <edge id="tre2053" from="nter1330" to="nter1329" />
+    <edge id="tre2054" from="nter1331" to="nter1330" head="yes" />
+    <edge id="tre2055" from="nter1332" to="nter1331" head="yes" />
+    <edge id="tre2056" from="nter1333" to="nter1332" />
 
 ### Webservices
 
@@ -67,27 +72,33 @@ You can launch a language identification webservice by executing:
 
     constituent-parser-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:
 
     constituent-parser-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 `--help` option.
 
 ### Daemon
 
-Last but not least the constituent parser 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 constituent parser comes shipped with a daemon that can
+read jobs (and write) jobs to and from Amazon SQS queues. For more information
+type:
 
     constituent-parser-daemon -h
 
+## Description of dependencies
 
-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:
@@ -105,8 +116,7 @@ If you want to use the Dutch constituent parser you need to have:
 Language Extension
 ------------------
 
-  TODO
-
+TODO
 
 Where to go from here
 ---------------------
@@ -117,10 +127,10 @@ Where to go from here
 Report problem/Get help
 -----------------------
 
-If you encounter problems, please email support@opener-project.eu or leave an issue in the 
+If you encounter problems, please email support@opener-project.eu or leave an
+issue in the
 [issue tracker](https://github.com/opener-project/constituent-parser/issues).
 
-
 Contributing
 ------------
 
@@ -129,5 +139,3 @@ Contributing
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
-
-

data/bin/constituent-parser

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

data/bin/constituent-parser-daemon

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

data/bin/constituent-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-constituent-parser',
+  File.expand_path('../../config.ru', __FILE__)
+)
 
-cli = Puma::CLI.new([rack_config] + ARGV)
-cli.run
+parser.run

data/exec/constituent-parser.rb

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

data/lib/opener/constituent_parser.rb

@@ -1,10 +1,9 @@
 require 'open3'
-require 'optparse'
+require 'slop'
 require 'nokogiri'
 require 'opener/constituent_parsers/base'
 require 'opener/constituent_parsers/nl'
 require 'opener/constituent_parsers/de'
-require 'opener/core'
 
 require_relative 'constituent_parser/version'
 require_relative 'constituent_parser/cli'
@@ -25,7 +24,7 @@ module Opener
     # @return [Hash]
     #
     DEFAULT_OPTIONS = {
-      :args     => [],
+      :args => [],
     }.freeze
 
     ##
@@ -37,41 +36,30 @@ module Opener
     end
 
     ##
-    # Processes the input and returns an array containing the output of STDOUT,
-    # STDERR and an object containing process information.
+    # Processes the input KAF document and returns a new KAF document as a
+    # String.
     #
     # @param [String] input
     # @return [String]
     #
     def run(input)
-      begin
-      args = options[:args].dup
-        language = language(input)
-        if language_constant_defined?(language)
-          kernel = language_constant(language).new(:args => args)
-        else
-          kernel = ConstituentParsers::Base.new(
-            :args     => args,
-            :language => language
-          )
-        end
+      args     = options[:args].dup
+      language = language(input)
 
-        return kernel.run(input)
-      rescue Exception => error
-        return Opener::Core::ErrorLayer.new(input, error.message, self.class).add
+      if language_constant_defined?(language)
+        kernel = language_constant(language).new(:args => args)
+      else
+        kernel = ConstituentParsers::Base.new(
+          :args     => args,
+          :language => language
+        )
       end
-    end
 
-    ##
-    # @return [String]
-    #
-    def output_type
-      return :xml
+      return kernel.run(input)
     end
 
     protected
 
-
     ##
     # Returns `true` if the current language has a dedicated kernel class.
     #

data/lib/opener/constituent_parser/cli.rb

@@ -1,90 +1,64 @@
 module Opener
   class ConstituentParser
     ##
-    # CLI wrapper around {Opener::ConstituentParser} using OptionParser.
+    # CLI wrapper around {Opener::ConstituentParser} 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   = 'constituent-parser'
-          opts.summary_indent = '  '
+      def run(argv = ARGV)
+        parser.parse(argv)
+      end
 
-          opts.on('-h', '--help', 'Shows this help message') do
-            show_help
-          end
+      ##
+      # @return [Slop]
+      #
+      def configure_slop
+        return Slop.new(:strict => false, :indent => 2, :help => true) do
+          banner 'Usage: constituent-parser [OPTIONS]'
 
-          opts.on('-v', '--version', 'Shows the current version') do
-            show_version
-          end
+          separator <<-EOF.chomp
 
-          opts.on(
-            '-l',
-            '--language [VALUE]',
-            'Uses this specific language'
-          ) do |value|
-            @options[:language] = value
-          end
+About:
 
-          opts.separator <<-EOF
+    Constituent parser for various languages such as English and Dutch. This
+    command reads input from STDIN.
 
-Examples:
+Example:
 
-  cat input_file.kaf | #{opts.program_name}
-  cat input_file.kaf | #{opts.program_name} -l nl
+    cat some_file.kaf | constituent-parser
           EOF
-        end
-      end
 
-      ##
-      # @param [String] input
-      #
-      def run(input)
-        option_parser.parse!(options[:args])
+          separator "\nOptions:\n"
+
+          on :v, :version, 'Shows the current version' do
+            abort "property-tagger v#{VERSION} on #{RUBY_DESCRIPTION}"
+          end
 
-        runner = ConstituentParser.new(options)
+          on :l=, :language=, 'Sets a specific language to use', :as => String
 
-        stdout, stderr, process = runner.run(input)
+          run do |opts, args|
+            parser = ConstituentParser.new(
+              :args     => args,
+              :language => opts[:language]
+            )
 
-        if process
-          if process.success?
-            puts stdout
+            input = STDIN.tty? ? nil : STDIN.read
 
-            STDERR.puts(stderr) unless stderr.empty?
-          else
-            abort stderr
+            puts parser.run(input)
           end
-        else
-          puts stdout
         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 # ConstituentParser
 end # Opener

data/lib/opener/constituent_parser/server.rb

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

data/lib/opener/constituent_parser/version.rb

@@ -1,5 +1,5 @@
 module Opener
   class ConstituentParser
-    VERSION = '1.2.3'
+    VERSION = '2.0.0'
   end # ConstituentParser
 end # Opener

data/opener-constituent-parser.gemspec

@@ -7,6 +7,7 @@ Gem::Specification.new do |gem|
   gem.summary     = 'Constituent parser including a webservice.'
   gem.description = gem.summary
   gem.has_rdoc    = 'yard'
+  gem.license     = 'Apache 2.0'
 
   gem.required_ruby_version = '>= 1.9.2'
 
@@ -14,22 +15,23 @@ Gem::Specification.new do |gem|
     'lib/**/*',
     '*.gemspec',
     'README.md',
+    'LICENSE.txt',
     'exec/**/*',
     'config.ru'
   ]).select { |file| File.file?(file) }
 
   gem.executables = Dir.glob('bin/*').map { |file| File.basename(file) }
 
-  gem.add_dependency 'opener-webservice'
-  gem.add_dependency 'sinatra', '~>1.4.2'
   gem.add_dependency 'opener-constituent-parser-base', ['~> 1.0', '>= 1.0.6']
   gem.add_dependency 'opener-constituent-parser-nl', '~> 1.0'
   gem.add_dependency 'opener-constituent-parser-de', '~> 1.1'
-  gem.add_dependency 'puma'
+
+  gem.add_dependency 'opener-daemons', '~> 2.2'
+  gem.add_dependency 'opener-webservice', '~> 2.1'
+  gem.add_dependency 'opener-core', '~> 2.2'
+
   gem.add_dependency 'nokogiri'
-  gem.add_dependency 'httpclient'
-  gem.add_dependency 'opener-daemons'
-  gem.add_dependency 'opener-core', "~> 1.0"
+  gem.add_dependency 'slop', '~> 3.5'
 
   gem.add_development_dependency 'rake'
 end

metadata

@@ -1,43 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: opener-constituent-parser
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 2.0.0
 platform: ruby
 authors:
 - development@olery.com
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-06-24 00:00:00.000000000 Z
+date: 2014-11-24 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: opener-webservice
-  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'
-  prerelease: false
-  type: :runtime
-- !ruby/object:Gem::Dependency
-  name: sinatra
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.4.2
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.4.2
-  prerelease: false
-  type: :runtime
 - !ruby/object:Gem::Dependency
   name: opener-constituent-parser-base
   version_requirements: !ruby/object:Gem::Requirement
@@ -87,49 +59,49 @@ dependencies:
   prerelease: false
   type: :runtime
 - !ruby/object:Gem::Dependency
-  name: puma
+  name: opener-daemons
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.2'
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.2'
   prerelease: false
   type: :runtime
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: opener-webservice
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
   prerelease: false
   type: :runtime
 - !ruby/object:Gem::Dependency
-  name: httpclient
+  name: opener-core
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.2'
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.2'
   prerelease: false
   type: :runtime
 - !ruby/object:Gem::Dependency
-  name: opener-daemons
+  name: nokogiri
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -143,17 +115,17 @@ dependencies:
   prerelease: false
   type: :runtime
 - !ruby/object:Gem::Dependency
-  name: opener-core
+  name: slop
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3.5'
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3.5'
   prerelease: false
   type: :runtime
 - !ruby/object:Gem::Dependency
@@ -179,21 +151,23 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- README.md
-- bin/constituent-parser
-- bin/constituent-parser-daemon
-- bin/constituent-parser-server
-- config.ru
-- exec/constituent-parser.rb
 - lib/opener/constituent_parser.rb
+- lib/opener/constituent_parser/version.rb
+- lib/opener/constituent_parser/server.rb
 - lib/opener/constituent_parser/cli.rb
 - lib/opener/constituent_parser/public/markdown.css
-- lib/opener/constituent_parser/server.rb
-- lib/opener/constituent_parser/version.rb
 - lib/opener/constituent_parser/views/index.erb
 - opener-constituent-parser.gemspec
+- README.md
+- LICENSE.txt
+- exec/constituent-parser.rb
+- config.ru
+- bin/constituent-parser
+- bin/constituent-parser-daemon
+- bin/constituent-parser-server
 homepage:
-licenses: []
+licenses:
+- Apache 2.0
 metadata: {}
 post_install_message:
 rdoc_options: []
@@ -211,8 +185,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.2.2
+rubygems_version: 2.1.9
 signing_key:
 specification_version: 4
 summary: Constituent parser including a webservice.
 test_files: []
+has_rdoc: yard