nlp-pure 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c4f6247383c48cd71d5ccebf6cc937023d1a880b
+  data.tar.gz: b33e1b19f2bfb5d49c6082f10699f06e2052e32c
+SHA512:
+  metadata.gz: 7dee5b3c6947d08ef7e8b92a7332baeaaf8785969f98673613a7de2287dbba65dfb06a6f05990036013abaf01235f0017cb75cdf64be27770cc0c06046e30d99
+  data.tar.gz: a01ebec79d05301998d3618c1cd4e1b9cfa23982b36834cee17c529559b2bf36b5a32ea11d843469574924c42be245f192a636a3ee7f288490f7516e39f0a589

data/.gitignore

@@ -0,0 +1,31 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+/vendor/
+/.bundle/
+/.sass-cache/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+Gemfile.lock
+.rvmrc
+.ruby-version
+.rbx
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+*.swp
+.DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/.rubocop.yml

@@ -0,0 +1,105 @@
+AllCops:
+  Exclude:
+    - Guardfile
+    - 'vendor/**/*'
+
+  RunRailsCops: false
+
+AlignParameters:
+  Enabled: false
+ClassAndModuleChildren:
+  Enabled: false
+Encoding:
+  Enabled: false
+LineLength:
+  Max: 200
+HashSyntax:
+  Exclude:
+    - Rakefile
+    - 'spec/**/*'
+    - 'test/**/*'
+
+# Don't fail on whitespace between method names and arguments
+Style/SingleSpaceBeforeFirstArg:
+  Enabled: false
+
+# Indent private/protected/public as deep as method definitions
+Style/AccessModifierIndentation:
+  EnforcedStyle: indent
+  SupportedStyles:
+    - outdent
+    - indent
+
+Style/AlignHash:
+
+  # table - left alignment of keys, hash rockets, and values
+  EnforcedHashRocketStyle: table
+  # table - left alignment of keys and values
+  EnforcedColonStyle: key
+
+  EnforcedLastArgumentHashStyle: always_inspect
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/AndOr:
+  # Whether `and` and `or` are banned only in conditionals (conditionals)
+  # or completely (always).
+  EnforcedStyle: always
+
+# Checks if usage of %() or %Q() matches configuration.
+Style/BarePercentLiterals:
+  EnforcedStyle: percent_q
+
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+
+# Checks formatting of special comments
+Style/CommentAnnotation:
+  Keywords:
+    - TODO
+    - FIXME
+    - OPTIMIZE
+    - HACK
+    - REVIEW
+    - PCI
+    - LEGAL
+    - NOTE
+
+Style/IndentationWidth:
+  # Number of spaces for each indentation level.
+  Width: 2
+
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+Style/EmptyLineBetweenDefs:
+  # If true, this parameter means that single line method definitions don't
+  # need an empty line between them.
+  AllowAdjacentOneLineDefs: false
+
+Style/EmptyLinesAroundBlockBody:
+  EnforcedStyle: no_empty_lines
+
+Style/EmptyLinesAroundClassBody:
+  EnforcedStyle: no_empty_lines
+
+Style/EmptyLinesAroundModuleBody:
+  EnforcedStyle: no_empty_lines
+
+# Checks whether the source file has a utf-8 encoding comment or not
+Style/Encoding:
+  EnforcedStyle: when_needed
+
+Style/HashSyntax:
+  EnforcedStyle: ruby19
+
+Style/MethodName:
+  EnforcedStyle: snake_case
+
+# Allow safe assignment in conditions.
+Style/ParenthesesAroundCondition:
+  AllowSafeAssignment: true
+
+Style/RaiseArgs:
+  EnforcedStyle: exploded

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+sudo: false
+cache: bundler
+rvm:
+  - 2.2
+  - 2.1
+  - 2.0.0
+  - jruby
+  - rbx-2
+matrix:
+  allow_failures:
+    - rvm: rbx-2
+    - rvm: jruby
+bundler_args: --without development

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# 0.0.2
+
+Added `NlpPure::Segmenting::DefaultWord` module for segmenting text into words.
+
+# 0.0.1
+
+Repository created February 14, 2015.

data/CONTRIBUTING.md

@@ -0,0 +1,23 @@
+Pull requests are welcomed! Here’s a quick guide:
+
+1. Fork the repo.
+
+2. Run the tests. We only take pull requests with passing tests, and it's great
+to know that you have a clean slate: `bundle && rake`
+
+3. Add a test for your change. Only refactoring and documentation changes
+require no new tests. If you are adding functionality or fixing a bug, we need
+a test!
+
+4. Make the test pass.
+
+5. Push to your fork and submit a pull request.
+
+Syntax:
+
+* Two spaces, no tabs.
+* No trailing whitespace. Blank lines should not have any space.
+* Prefer &&/|| over and/or.
+* MyClass.my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+* a = b and not a=b.
+* Follow the conventions you see used in the source already.

data/Gemfile

@@ -0,0 +1,22 @@
+source 'https://rubygems.org'
+gemspec
+
+platforms :rbx do
+  gem 'rubysl', '~> 2.0'         # if using anything in the ruby standard library
+  gem 'psych'                    # if using yaml
+  gem 'minitest'                 # if using minitest
+  gem 'rubinius-developer_tools' # if using any of coverage, debugger, profiler
+end
+
+platforms :jruby do
+  gem 'jruby-openssl'
+  gem 'activerecord-jdbcsqlite3-adapter'
+end
+
+group :test do
+  gem 'rake'
+  gem 'rspec', '~> 3.0.0'
+  gem 'guard-rspec'
+  gem 'guard-rubocop'
+  gem 'coveralls', require: false
+end

data/Guardfile

@@ -0,0 +1,20 @@
+guard :rspec, cmd: "bundle exec rspec", all_on_start: false, all_after_pass: false, failed_mode: :none do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+end
+
+guard :rubocop, all_on_start: false, keep_failed: false do
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Reid Parham
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,91 @@
+# NLP Pure
+
+[![Code Climate](https://codeclimate.com/github/parhamr/nlp-pure/badges/gpa.svg)](https://codeclimate.com/github/parhamr/nlp-pure)
+[![Build Status](https://travis-ci.org/parhamr/nlp-pure.svg?branch=master)](https://travis-ci.org/parhamr/nlp-pure) 
+[![Coverage Status](https://coveralls.io/repos/parhamr/nlp-pure/badge.png?branch=master)](https://coveralls.io/r/parhamr/nlp-pure) 
+
+Natural language processing algorithms implemented in pure Ruby with minimal dependencies.
+
+NOTE: this is not affiliated with, endorsed by, or in any way connected with [Pure NLP](http://purenlp.com/), a trademark of John La Valle.
+
+This project aims to provide functionality similar to [Treat](https://github.com/louismullie/treat), [open-nlp](https://github.com/louismullie/open-nlp), and [stanford-core-nlp](https://rubygems.org/gems/stanford-core-nlp) but with fewer dependencies. The code is tested against English language but the algorithm implementations aim to be flexible for other languages.
+
+
+## Requirements
+
+TODO
+
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```
+gem 'nlp-pure'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install nlp-pure
+```
+
+
+## Usage
+
+
+### Word Segmentation
+
+```
+$ bundle exec irb
+irb(main):001:0> require_relative './lib/nlp_pure/segmenting/default_word'
+=> true
+irb(main):002:0> NlpPure::Segmenting::DefaultWord.parse 'The quick brown fox jumps over the lazy dog.'
+=> ["The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog."]
+irb(main):003:0> NlpPure::Segmenting::DefaultWord.parse 'The New York-based company hired new staff.'
+=> ["The", "New", "York", "based", "company", "hired", "new", "staff."]
+irb(main):004:0> NlpPure::Segmenting::DefaultWord.parse 'The U.S.A. is a member of NATO.'
+=> ["The", "U.S.A.", "is", "a", "member", "of", "NATO."]
+irb(main):005:0> NlpPure::Segmenting::DefaultWord.parse "Mary had a little lamb,\nHis fleece was white as snow,\nAnd everywhere that Mary went,\nThe lamb was sure to go."
+=> ["Mary", "had", "a", "little", "lamb,", "His", "fleece", "was", "white", "as", "snow,", "And", "everywhere", "that", "Mary", "went,", "The", "lamb", "was", "sure", "to", "go."]
+```
+
+
+## Supported Ruby Versions
+
+This library aims to support and is [tested against](https://travis-ci.org/parhamr/nlp-pure) the following Ruby
+implementations:
+
+* Ruby 2.0
+* Ruby 2.1
+* Ruby 2.2
+* [JRuby](http://www.jruby.org/)
+* [Rubinius](http://rubini.us/)
+
+If something doesn't work on one of these interpreters, it's a bug.
+
+This library may inadvertently work (or seem to work) on other Ruby
+implementations, however support will only be provided for the versions listed
+above.
+
+
+## Versioning
+
+This library aims to adhere to [Semantic Versioning 2.0.0](http://semver.org/). Violations
+of this scheme should be reported as bugs. Specifically, if a minor or patch
+version is released that breaks backward compatibility, that version should be
+immediately yanked and/or a new version should be immediately released that
+restores compatibility. Breaking changes to the public API will only be
+introduced with new major versions. As a result of this policy, you can (and
+should) specify a dependency on this gem using the [Pessimistic Version
+Constraint](http://docs.rubygems.org/read/chapter/16#page74) with two digits of precision. For example:
+
+```ruby
+spec.add_dependency 'nlp-pure', '~> 0.1'
+```

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+begin
+  require 'rspec/core/rake_task'
+  require 'rubocop/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+
+  task :rubocop do
+    require 'rubocop'
+    cli = RuboCop::CLI.new
+    cli.run
+  end
+
+  task :default => [:spec, :rubocop]
+rescue LoadError => e
+  STDERR << "#{e.class}: #{e.message} (#{e.backtrace[0]})"
+end

data/lib/nlp_pure.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+require 'nlp_pure/version'
+fail "NLP Pure #{NlpPure::VERSION} does not support Ruby 1.9." if RUBY_PLATFORM != 'java' && RUBY_VERSION < '2.0.0'
+
+#
+module NlpPure
+  NAME = 'NlpPure'
+  LICENSE = 'See LICENSE for details.'
+
+  DEFAULTS = {}
+
+  def self.logger
+    NlpPure::Logging.logger
+  end
+
+  def self.logger=(log)
+    NlpPure::Logging.logger = log
+  end
+end

data/lib/nlp_pure/logging.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+require 'time'
+require 'logger'
+
+#
+module NlpPure
+  #
+  module Logging
+    #
+    class Pretty < Logger::Formatter
+      def call(severity, time, program_name, message)
+        "#{time.utc.iso8601(2)} #{::Process.pid} #{severity}: #{message}\n"
+      end
+    end
+
+    def self.initialize_logger(log_target = STDOUT)
+      oldlogger = defined?(@logger) ? @logger : nil
+      @logger = Logger.new(log_target)
+      @logger.level = Logger::INFO
+      @logger.formatter = Pretty.new
+      oldlogger.close if oldlogger
+      @logger
+    end
+
+    def self.logger
+      defined?(@logger) ? @logger : initialize_logger
+    end
+
+    def self.logger=(log)
+      @logger = (log ? log : Logger.new('/dev/null'))
+    end
+
+    def logger
+      NlpPure::Logging.logger
+    end
+  end
+end

data/lib/nlp_pure/segmenting.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+#
+module NlpPure
+  # Namespace for segmenting implementations
+  module Segmenting
+  end
+end

data/lib/nlp_pure/segmenting/default_word.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+module NlpPure
+  module Segmenting
+    #
+    module DefaultWord
+      DEFAULT_OPTIONS = {
+        # hyphen, en dash, em dash, and string
+        split: /[\-–—\s]/
+      }.freeze
+      def self.parse(*args)
+        unless args.nil? || args.empty?
+          input = args[0].to_s
+          input.split(options[:split])
+        end
+      end
+
+      # NOTE: exposed as a method for easy mock/stub
+      def self.options
+        DEFAULT_OPTIONS
+      end
+    end
+  end
+end
+
+require_relative '../segmenting'

data/lib/nlp_pure/version.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+#
+module NlpPure
+  VERSION = '0.0.2'
+end

data/nlp-pure.gemspec

@@ -0,0 +1,20 @@
+# encoding: utf-8
+require File.expand_path('../lib/nlp_pure/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Reid Parham']
+  gem.email         = ['reid.parham@gmail.com']
+  gem.description   = gem.summary = 'Natural language processing algorithms implemented in pure Ruby with minimal dependencies'
+  gem.homepage      = 'https://github.com/parhamr/nlp-pure'
+  gem.license       = 'MIT'
+
+  gem.executables   = []
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- spec/*`.split("\n")
+  gem.name          = 'nlp-pure'
+  gem.require_paths = ['lib']
+  gem.version       = NlpPure::VERSION
+  gem.add_development_dependency      'rake', '~> 10.4'
+  gem.add_development_dependency      'rspec', '~> 3.0'
+  gem.add_development_dependency      'coveralls', '~> 0.7'
+end

data/spec/lib/nlp_pure_spec.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'nlp_pure'
+
+describe NlpPure do
+  describe '[module]' do
+    it 'is defined' do
+      expect(defined?(NlpPure)).to be_truthy
+    end
+  end
+end

data/spec/lib/segmenting/default_word_spec.rb

@@ -0,0 +1,72 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'nlp_pure/segmenting/default_word'
+
+describe NlpPure::Segmenting::DefaultWord do
+  describe '[module]' do
+    it 'is defined' do
+      expect(defined?(NlpPure::Segmenting::DefaultWord)).to be_truthy
+    end
+  end
+
+  describe '.parse' do
+    context 'English' do
+      let(:english_simple_sentence) { 'The quick brown fox jumps over the lazy dog.' }
+      let(:english_hyphen_sentence) { 'The New York-based company hired new staff.' }
+      let(:english_dash_sentence) { 'The quick brown fox—full of energy—jumps over the lazy dog.' }
+      let(:english_abbreviation_sentence) { 'The U.S.A. is a member of NATO.' }
+      let(:english_simple_paragraph) { 'Mary had a little lamb. The lamb’s fleece was white as snow. Everywhere that Mary went, the lamb was sure to go.' }
+      let(:english_simple_line_breaks) { "Mary had a little lamb,\nHis fleece was white as snow,\nAnd everywhere that Mary went,\nThe lamb was sure to go." }
+
+      context '(with default options)' do
+        context 'with `nil` argument' do
+          it 'does not raise error' do
+            expect { NlpPure::Segmenting::DefaultWord.parse(nil) }.to_not raise_error
+          end
+
+          it 'returns Array' do
+            expect(NlpPure::Segmenting::DefaultWord.parse(nil)).to be_an Array
+          end
+        end
+
+        context 'without arguments' do
+          it 'does not raise error' do
+            expect { NlpPure::Segmenting::DefaultWord.parse }.to_not raise_error
+          end
+
+          it 'returns nil' do
+            expect(NlpPure::Segmenting::DefaultWord.parse).to eq nil
+          end
+        end
+
+        it 'returns Array' do
+          expect(NlpPure::Segmenting::DefaultWord.parse(english_simple_sentence)).to be_an Array
+        end
+
+        it 'correctly counts words' do
+          expect(NlpPure::Segmenting::DefaultWord.parse(english_simple_sentence).length).to eq(9)
+        end
+
+        it 'correctly segments hyphens' do
+          expect(NlpPure::Segmenting::DefaultWord.parse(english_hyphen_sentence).length).to eq(8)
+        end
+
+        it 'correctly segments dashes' do
+          expect(NlpPure::Segmenting::DefaultWord.parse(english_dash_sentence).length).to eq(12)
+        end
+
+        it 'does not segment abbreviations' do
+          expect(NlpPure::Segmenting::DefaultWord.parse(english_abbreviation_sentence).length).to eq(7)
+        end
+
+        it 'correctly counts with longer texts' do
+          expect(NlpPure::Segmenting::DefaultWord.parse(english_simple_paragraph).length).to eq(22)
+        end
+
+        it 'correctly counts with line breaks' do
+          expect(NlpPure::Segmenting::DefaultWord.parse(english_simple_line_breaks).length).to eq(22)
+        end
+      end
+    end
+  end
+end

data/spec/lib/segmenting_spec.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'nlp_pure/segmenting'
+
+describe NlpPure::Segmenting do
+  describe '[module]' do
+    it 'is defined' do
+      expect(defined?(NlpPure::Segmenting)).to be_truthy
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+require 'rspec'
+require 'coveralls'
+
+Coveralls.wear!
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: nlp-pure
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Reid Parham
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: Natural language processing algorithms implemented in pure Ruby with
+  minimal dependencies
+email:
+- reid.parham@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/nlp_pure.rb
+- lib/nlp_pure/logging.rb
+- lib/nlp_pure/segmenting.rb
+- lib/nlp_pure/segmenting/default_word.rb
+- lib/nlp_pure/version.rb
+- nlp-pure.gemspec
+- spec/lib/nlp_pure_spec.rb
+- spec/lib/segmenting/default_word_spec.rb
+- spec/lib/segmenting_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/parhamr/nlp-pure
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Natural language processing algorithms implemented in pure Ruby with minimal
+  dependencies
+test_files:
+- spec/lib/nlp_pure_spec.rb
+- spec/lib/segmenting/default_word_spec.rb
+- spec/lib/segmenting_spec.rb
+- spec/spec_helper.rb
+has_rdoc: