wordfinder 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in wordfinder.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 d11wtq
+
+MIT License
+
+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,35 @@
+# WordFinder
+
+A high-level wrapper around libaspell, to find words in an ordered stream of
+characters.
+
+## Requirements & Installation
+
+This depends on libaspell, via [ffi-aspell](https://github.com/YorickPeterse/ffi-aspell).
+In order to install it, you'll need to make sure you have aspell installed, with
+the development package.
+
+On Ubuntu:
+
+    sudo apt-get install libaspell-dev
+    gem install wordfinder
+
+You may also add a line to your Gemfile:
+
+    gem "wordfinder"
+
+## Usage
+
+There is only one method in WordFinder.
+
+``` ruby
+require "wordfinder"
+
+WordFinder.words_in("threelittlepigswenttomarket")
+#=> ["three", "little", "pigs", "went", "to", "market"]
+```
+
+## Copyright & Licensing
+
+Copyright © 2012 Chris Corbyn
+Refer to the LICENSE file for details.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/word_finder.rb

@@ -0,0 +1,60 @@
+##
+# WordFinder.
+# Copyright © 2012 Chris Corbyn.
+#
+# See LICENSE file for details.
+##
+
+require "ffi"
+require "ffi/aspell"
+require "word_finder/version"
+
+module WordFinder
+  class << self
+    # Find all the words in the given phrase, ignoring unrecognized characters.
+    #
+    # Words will be accumulated to use the longest possible matches.
+    #
+    # @param [String] phrase
+    #   a sentence, which need not contain whitespace or punctuation
+    #
+    # @option [String] :lang
+    #   the language of the aspell dictionary (default "en_US")
+    #
+    # @return [Array<String>]
+    #   an Array containing all words found, in order
+    def words_in(phrase, options = {})
+      speller = FFI::Aspell::Speller.new(options[:lang] || "en_US")
+
+      matched   = []
+      unmatched = ""
+
+      phrase.each_char do |c|
+        unmatched << c
+
+        tmp, matched = matched, []
+
+        if tmp.empty?
+          if speller.correct?(unmatched)
+            matched.push(unmatched)
+            unmatched = ""
+          end
+        else
+          (0..tmp.length).each do |i|
+            word = tmp[i..-1].join + unmatched
+
+            if speller.correct?(word)
+              matched.push(word)
+              unmatched = ""
+              break
+            elsif tmp[i]
+              matched << tmp[i]
+            end
+          end
+        end
+      end
+
+      matched.reject{|m| m !~ /\w/} # remove punctuation marks
+    end
+  end
+end

data/lib/word_finder/version.rb

@@ -0,0 +1,10 @@
+##
+# WordFinder.
+# Copyright © 2012 Chris Corbyn.
+#
+# See LICENSE file for details.
+##
+
+module WordFinder
+  VERSION = "0.0.1"
+end

data/lib/wordfinder.rb

@@ -0,0 +1,8 @@
+##
+# WordFinder.
+# Copyright © 2012 Chris Corbyn.
+#
+# See LICENSE file for details.
+##
+
+require "word_finder"

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require "rspec"
+require "wordfinder"
+
+RSpec.configure do |config|
+end

data/spec/wordfinder_spec.rb

@@ -0,0 +1,71 @@
+require "spec_helper"
+
+describe WordFinder do
+  let(:words) { WordFinder.words_in(phrase) }
+
+  describe ".words_in" do
+    context "with an unstemmable word" do
+      let(:phrase) { "run" }
+
+      it "returns an Array containing the word" do
+        words.should == %w[run]
+      end
+    end
+
+    context "with a stemmable word" do
+      let(:phrase) { "running" }
+
+      it "returns an Array containing the unstemmed word" do
+        words.should == %w[running]
+      end
+    end
+
+    context "with multiple unstemmable words" do
+      let(:phrase) { "runfast" }
+
+      it "returns an Array containing the words" do
+        words.should == %w[run fast]
+      end
+    end
+
+    context "with multiple stemmable words" do
+      let(:phrase) { "runningfaster" }
+
+      it "returns an Array containing the words" do
+        words.should == %w[running faster]
+      end
+    end
+
+    context "with a word ending in junk" do
+      let(:phrase) { "runfh" }
+
+      it "returns an Array containing the valid word" do
+        words.should == %w[run f h]
+      end
+    end
+
+    context "with a word staring in junk" do
+      let(:phrase) { "qlrun" }
+
+      it "returns an Array containing the valid word" do
+        words.should == %w[q l run]
+      end
+    end
+
+    context "with word separated by junk" do
+      let(:phrase) { "gracefulqlrun" }
+
+      it "returns an Array containing the valid words" do
+        words.should == %w[graceful q l run]
+      end
+    end
+
+    context "with words separated by punctuation" do
+      let(:phrase) { "I need it, now!" }
+
+      it "returns an Array containing all words without punctuation" do
+        words.should == %w[I need it now]
+      end
+    end
+  end
+end

data/wordfinder.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/word_finder/version", __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["d11wtq"]
+  gem.email         = ["chris@w3style.co.uk"]
+  gem.description   = "Finds words in a stream of characters"
+  gem.summary       = "Finds words in a stream of characters"
+  gem.homepage      = "https://github.com/d11wtq/wordfinder"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "wordfinder"
+  gem.require_paths = ["lib"]
+  gem.version       = WordFinder::VERSION
+
+  gem.add_development_dependency "rspec"
+  gem.add_runtime_dependency "ffi"
+  gem.add_runtime_dependency "ffi-aspell"
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: wordfinder
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- d11wtq
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ffi-aspell
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Finds words in a stream of characters
+email:
+- chris@w3style.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/word_finder.rb
+- lib/word_finder/version.rb
+- lib/wordfinder.rb
+- spec/spec_helper.rb
+- spec/wordfinder_spec.rb
+- wordfinder.gemspec
+homepage: https://github.com/d11wtq/wordfinder
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Finds words in a stream of characters
+test_files:
+- spec/spec_helper.rb
+- spec/wordfinder_spec.rb
+has_rdoc: