compound_splitter 0.0.1

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,2 @@
+rvm:
+  - 1.9.3

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 David Tuite
+
+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,67 @@
+# CompoundSplitter
+
+Split compoind words into their component parts. For example, 'rainyday' ->
+'rainy day'.
+
+    CompoundSplitter.split('longwalk')
+    # => ['long', 'walk']
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'compound_splitter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install compound_splitter
+
+## Usage
+
+**Basic Usage**
+
+    splitter = CompoundSplitter::Splitter.new
+    splitter.split('rainyday')
+    # => ['rainy', 'day']
+
+    splitter.split('wickedweather')
+    # => ['wicked', 'weather']
+
+**Shortcut**
+
+There is a shortcut `split` method available on the top-level namespace.
+
+    CompoundSplitter.split('longwalk')
+    # => ['long', 'walk']
+
+The longer version should be used wherever possible since doing so will
+prevent loading and prepearing of the dictionary multiple times.
+
+**The Dictionary File**
+The compound splitter assumes you have a dictionary file
+in your file system at `/usr/share/dict/words`. If you would like
+to use a different dictionary file then you can create a new dictionary
+object and pass it into the splitters initializer.
+
+    dict = CompoundSplitter::Dictionary.new('path/to/dictionary/file')
+
+    splitter = CompoundSplitter::Splitter.new(dict)
+    splitter.split('rainyday')
+    # => ['rainy', 'day']
+
+## Acknologements
+
+This gem is basically a translation to Ruby of a [Stack Overflow answer](http://stackoverflow.com/a/481773/574190)
+by Darius Bacon. The answer was given in python. Thus credit for the implementation should go to Darius.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/compound_splitter.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/compound_splitter/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["David Tuite"]
+  gem.email         = ["dtuite@gmail.com"]
+  gem.description   = %q{Split concatenated words}
+  gem.summary       = %q{Split words which have been concatenated together. eg. 'wickedweather' -> 'wicked weather'}
+  gem.homepage      = "https://github.com/dtuite/compound_splitter"
+
+  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          = "compound_splitter"
+  gem.require_paths = ["lib"]
+  gem.version       = CompoundSplitter::VERSION
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+end

data/lib/compound_splitter/dictionary.rb

@@ -0,0 +1,55 @@
+module CompoundSplitter
+  class Dictionary
+    attr_accessor :file_location
+
+    def initialize(file_location = nil)
+      @file_location = file_location || '/usr/share/dict/words'
+    end
+
+    # Read a file of newline separated words into a downcased array.
+    def words
+      unless @words
+        f = File.read(file_location)
+        @words = []
+        f.each_line { |l| @words << l.chomp.downcase }
+      end
+      @words
+    end
+
+    # Assign the length of the longest word in the dictionary.
+    def max_word_length
+      @max_word_length ||= words.max.length
+    end
+
+    # Assign the total number of words in the dictionary. It's a float
+    # because we're going to divide by it later on.
+    def total_word_count
+      @total_word_count ||= words.length.to_f
+    end
+
+    def ocurrances_hash
+      @ocurrances_hash ||= self.class.count_dupes(words.sort)
+    end
+
+    def [](lookup_word)
+      ocurrances_hash[lookup_word]
+    end
+
+    # Get the probability of a specific word ocurring in the dictionary.
+    def word_prob(word)
+      # Return the number of ocurrances of a word in the dictionary or 0
+      count = self[word] || 0
+      # Divide by the total number of words.
+      count / total_word_count
+    end
+
+  private
+
+    # Turn an array of words into a hash where each word has a key
+    # and each value is the number of ocurrances of the key in the array.
+    # INFO: http://stackoverflow.com/a/5470797/574190
+    def self.count_dupes(words_array)
+      words_array.inject(Hash.new(0)) { |h, e| h[e] += 1 ; h }
+    end
+  end
+end

data/lib/compound_splitter/splitter.rb

@@ -0,0 +1,42 @@
+module CompoundSplitter
+  class Splitter
+    attr_accessor :dictionary
+
+    def initialize(dictionary = nil)
+      @dictionary = dictionary || Dictionary.new
+    end
+
+    def viterbi_split(compound)
+      return [] if compound.empty?
+
+      probs, lasts = [1.0], [0]
+
+      1.upto(compound.length) do |i|
+
+        biggest = [0, i - dictionary.max_word_length].max
+
+        all_probs = []
+        biggest.upto(i - 1).each do |j|
+          part_of_compound = compound[j..(i-1)]
+          probability_part_is_word = dictionary.word_prob(part_of_compound)
+          something = [(probs[j] || 0.0) * probability_part_is_word, j]
+          all_probs << something
+        end
+
+        probs << all_probs.max[0]
+        lasts << all_probs.max[1]
+      end
+
+      words = []
+      i = compound.length
+      while 0 < i
+        words << compound[lasts[i]..(i-1)]
+        i = lasts[i]
+      end
+
+      # [words.reverse, probs[-1]]
+      words.reverse
+    end
+
+  end
+end

data/lib/compound_splitter/version.rb

@@ -0,0 +1,3 @@
+module CompoundSplitter
+  VERSION = "0.0.1"
+end

data/lib/compound_splitter.rb

@@ -0,0 +1,9 @@
+require "compound_splitter/version"
+require "compound_splitter/splitter"
+require "compound_splitter/dictionary"
+
+module CompoundSplitter
+  def self.split(compound)
+    Splitter.viterbi_split(compound)
+  end
+end

data/spec/compound_splitter/dictionary_spec.rb

@@ -0,0 +1,76 @@
+require "spec_helper"
+
+describe CompoundSplitter::Dictionary do
+  let(:dict) { File.expand_path('spec/fixtures/dictionary1.txt') }
+  subject { CompoundSplitter::Dictionary.new(dict) }
+
+
+  describe "initialiation" do
+    subject { CompoundSplitter::Dictionary.new }
+
+    it "should have a default dictionary file location" do
+      subject.file_location.should == '/usr/share/dict/words'
+    end
+  end
+
+  describe "words" do
+    it "should return an array of downcased words" do
+      expected = %w[rainy day help need help]
+      subject.words.should == expected
+    end
+
+    it "should memoize" do
+      File.should_receive(:read).with(dict) { dict }
+      subject.words
+      subject.words
+    end
+  end
+
+  describe "max_word_length" do
+    it "should return the length of the longest word in the dictionary" do
+      subject.max_word_length.should == 5
+    end
+
+    it "should memoize"
+  end
+
+  describe "total_word_count" do
+    it "should return the total number of words in the dictionary" do
+      subject.total_word_count.should == 5.0
+    end
+  end
+
+  describe "word_prob" do
+    it "should return the probability of a word being real" do
+      subject.word_prob('help').should == 0.4
+    end
+
+    it "should return 0 for non-existant words" do
+      subject.word_prob('grinnick').should == 0
+    end
+  end
+
+  describe "ocurrances_hash" do
+    it "should return a hash" do
+      subject.ocurrances_hash.should be_instance_of(Hash)
+    end
+
+    it "should have words as keys" do
+      subject.ocurrances_hash.keys.should include('help')
+    end
+
+    it "should have word ocurrance counts as values" do
+      subject.ocurrances_hash['help'].should == 2
+    end
+
+    it "should memoize"
+  end
+
+  describe "[]" do
+    it "should lookup words in the ocurrances_hash" do
+      word = "help"
+      subject.ocurrances_hash.should_receive(:[]).with(word)
+      subject[word]
+    end
+  end
+end

data/spec/compound_splitter/splitter_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+describe CompoundSplitter::Splitter do
+  subject { CompoundSplitter::Splitter.new }
+
+  describe "viterbi_split" do
+    it "should return rainy day for rainyday" do
+      subject.viterbi_split('rainyday').should == %w[rainy day]
+    end
+
+    it "should return w for w" do
+      subject.viterbi_split('w').should == %w[w]
+    end
+
+    it "should return pen island for penisland" do
+      subject.viterbi_split('penisland').should == %w[penis land]
+    end
+
+    it "should do something with ''" do
+      subject.viterbi_split('').should == []
+    end
+  end
+end

data/spec/compound_splitter_spec.rb

@@ -0,0 +1,10 @@
+require "spec_helper"
+
+describe CompoundSplitter do
+  it "should delegate to splitter" do
+    compound = 'wickedweather'
+    CompoundSplitter::Splitter.should_receive(:viterbi_split)
+      .with(compound)
+    CompoundSplitter.split(compound)
+  end
+end

data/spec/fixtures/dictionary1.txt

@@ -0,0 +1,5 @@
+rainy
+day
+heLp
+Need
+help

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require "compound_splitter"

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: compound_splitter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- David Tuite
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70221998391920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70221998391920
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70221998391360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70221998391360
+description: Split concatenated words
+email:
+- dtuite@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- compound_splitter.gemspec
+- lib/compound_splitter.rb
+- lib/compound_splitter/dictionary.rb
+- lib/compound_splitter/splitter.rb
+- lib/compound_splitter/version.rb
+- spec/compound_splitter/dictionary_spec.rb
+- spec/compound_splitter/splitter_spec.rb
+- spec/compound_splitter_spec.rb
+- spec/fixtures/dictionary1.txt
+- spec/spec_helper.rb
+homepage: https://github.com/dtuite/compound_splitter
+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.16
+signing_key: 
+specification_version: 3
+summary: Split words which have been concatenated together. eg. 'wickedweather' ->
+  'wicked weather'
+test_files:
+- spec/compound_splitter/dictionary_spec.rb
+- spec/compound_splitter/splitter_spec.rb
+- spec/compound_splitter_spec.rb
+- spec/fixtures/dictionary1.txt
+- spec/spec_helper.rb