opener-ner-base 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8b12de8ee2e71e39bfa794f3a348fecd60c8c9a8
+  data.tar.gz: 4d47bc08a613b62ff3a68a84546266ef934c88b1
+SHA512:
+  metadata.gz: bc5a4b1aaed45611d5653fe1a98c83b16de04b949d12881d8a6805073a7bfdede4a020200dcb0b6a314e27bf00f5450f78aa6aea7149377a71d5a36162084b58
+  data.tar.gz: 5a2d575e5628db0f3fd7b845690f5d553759437dec59df627700f7010e8ce303eddcc4e59dc5a6ff97274f395e1b0b13fad8cf4d2cba2b14ca894ce519220130

data/README.md

@@ -0,0 +1,77 @@
+[![Build Status](https://drone.io/github.com/opener-project/ner-base/status.png)](https://drone.io/github.com/opener-project/ner-base/latest)
+
+# NER Base
+
+This repository contains the source code used for performing Named Entity
+Recognition for the following languages:
+
+* Dutch
+* English
+* German
+* Italian
+* Spanish
+* French
+
+## Requirements
+
+* Java 1.7 or newer
+* Ruby 1.9.2 or newer
+
+Development requirements:
+
+* Maven
+* Bundler
+
+## Installation
+
+Installing as a regular Gem:
+
+    gem install opener-ner-base
+
+Using Bundler:
+
+    gem 'opener-ner-base',
+      :git    => 'git@github.com:opener-project/ner-base.git',
+      :branch => 'master'
+
+Using specific install:
+
+    gem install specific_install
+    gem specific_install opener-ner-base \
+       -l https://github.com/opener-project/ner-base.git
+
+## Usage
+
+    cat some_input_file.kaf | ner-en
+
+## Contributing
+
+First make sure all the required dependencies are installed:
+
+    bundle install
+
+Then compile the required Java code:
+
+    bundle exec rake compile
+
+For this you'll need to have Java 1.7 and Maven installed. These requirements
+are verified for you before the Rake task calls Maven.
+
+## Testing
+
+To run the tests (which are powered by Cucumber), simply run the following:
+
+    bundle exec rake
+
+This will take care of verifying the requirements, installing the required Java
+packages and running the tests.
+
+For more information on the available Rake tasks run the following:
+
+    bundle exec rake -T
+
+## Structure
+
+This repository comes in two parts: a collection of Java source files and Ruby
+source files. The Java code can be found in the `core/` directory, everything
+else will be Ruby source code.

data/bin/ner-de

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/opener/ners/base'
+
+kernel = Opener::Ners::Base.new(:args => ARGV, :language => 'de')
+input  = STDIN.tty? ? nil : STDIN.read
+
+puts kernel.run(input)

data/bin/ner-en

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/opener/ners/base'
+
+kernel = Opener::Ners::Base.new(:args => ARGV, :language => 'en')
+input  = STDIN.tty? ? nil : STDIN.read
+
+puts kernel.run(input)

data/bin/ner-es

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/opener/ners/base'
+
+kernel = Opener::Ners::Base.new(:args => ARGV, :language => 'es')
+input  = STDIN.tty? ? nil : STDIN.read
+
+puts kernel.run(input)

data/bin/ner-fr

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/opener/ners/base'
+
+kernel = Opener::Ners::Base.new(:args => ARGV, :language => 'fr')
+input  = STDIN.tty? ? nil : STDIN.read
+
+puts kernel.run1(input)

data/bin/ner-it

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/opener/ners/base'
+
+kernel = Opener::Ners::Base.new(:args => ARGV, :language => 'it')
+input  = STDIN.tty? ? nil : STDIN.read
+
+puts kernel.run(input)

data/bin/ner-nl

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/opener/ners/base'
+
+kernel = Opener::Ners::Base.new(:args => ARGV, :language => 'nl')
+input  = STDIN.tty? ? nil : STDIN.read
+
+puts kernel.run(input)

data/lib/opener/ners/base.rb

@@ -0,0 +1,64 @@
+require 'open3'
+require 'java'
+require 'stringio'
+
+require File.expand_path("../../../../core/target/ehu-nerc-1.0.jar", __FILE__)
+import 'ehu.nerc.Annotate'
+import 'ixa.kaflib.KAFDocument'
+import 'java.io.InputStreamReader'
+
+require_relative 'base/version'
+
+module Opener
+  module Ners
+    ##
+    # Base NER class that supports various languages such as Dutch and English.
+    #
+    # @!attribute [r] args
+    #  @return [Array]
+    # @!attribute [r] options
+    #  @return [Hash]
+    #
+    class Base
+      attr_reader :args, :options
+
+      ##
+      # @param [Hash] options
+      #
+      # @option options [Array] :args The commandline arguments to pass to the
+      #  underlying Java code.
+      #
+      def initialize(options = {})
+        @args    = options.delete(:args) || []
+        @options = options
+      end
+
+      ##
+      # Runs the command and returns the output of STDOUT, STDERR and the
+      # process information.
+      #
+      # @param [String] input The input to process.
+      # @return [Array]
+      #
+      def run(input)
+        input     = StringIO.new(input) unless input.kind_of?(IO)
+        annotator = Java::ehu.nerc.Annotate.new(language)
+        reader    = InputStreamReader.new(input.to_inputstream)
+        kaf       = KAFDocument.create_from_stream(reader)
+
+        kaf.add_linguistic_processor("entities","ehu-nerc-"+language,"now","1.0")
+        annotator.annotateNEsToKAF(kaf)
+
+        return kaf.to_string
+      end
+
+      ##
+      # @return [String]
+      #
+      def language
+        return options[:language]
+      end
+
+    end # Base
+  end # Ners
+end # Opener

data/lib/opener/ners/base/version.rb

@@ -0,0 +1,7 @@
+module Opener
+  module Ners
+    class Base
+      VERSION = '2.0.0'
+    end # Base
+  end # Ners
+end # Opener

data/opener-ner-base.gemspec

@@ -0,0 +1,25 @@
+require File.expand_path('../lib/opener/ners/base/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = 'opener-ner-base'
+  gem.version       = Opener::Ners::Base::VERSION
+  gem.authors       = ['development@olery.com']
+  gem.summary       = 'Base NER component for languages such as English.'
+  gem.description   = gem.summary
+  gem.homepage      = 'http://opener-project.github.com/'
+
+  gem.files = Dir.glob([
+    'core/target/ehu-nerc-*.jar',
+    'lib/**/*',
+    '*.gemspec',
+    'README.md'
+  ]).select { |file| File.file?(file) }
+
+  gem.executables = Dir.glob('bin/*').map { |file| File.basename(file) }
+
+  gem.add_dependency 'opener-build-tools'
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'cucumber'
+  gem.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: opener-ner-base
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- development@olery.com
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2014-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: opener-build-tools
+  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: rspec
+  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: :development
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  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: :development
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: :development
+description: Base NER component for languages such as English.
+email:
+executables:
+- ner-nl
+- ner-it
+- ner-es
+- ner-en
+- ner-de
+- ner-fr
+extensions: []
+extra_rdoc_files: []
+files:
+- core/target/ehu-nerc-1.0.jar
+- lib/opener/ners/base.rb
+- lib/opener/ners/base/version.rb
+- opener-ner-base.gemspec
+- README.md
+- bin/ner-nl
+- bin/ner-it
+- bin/ner-es
+- bin/ner-en
+- bin/ner-de
+- bin/ner-fr
+homepage: http://opener-project.github.com/
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.1.9
+signing_key:
+specification_version: 4
+summary: Base NER component for languages such as English.
+test_files: []
+has_rdoc: