ruby-dictionary 1.0.0

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Matt Huggins
+
+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,59 @@
+# Dictionary
+
+[ruby-dictionary](https://github.com/mhuggins/ruby-dictionary] provides a
+simple dictionary that allows for checking existence of words and finding a
+subset of words given a prefix.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ruby-dictionary'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby-dictionary
+
+## Usage
+
+A dictionary is created by passing an array of strings to the initializer.
+
+    dictionary = Dictionary.new(%w(a ab abs absolute absolutes absolutely
+                                   absolve be bee been bees bend bent best))
+
+Alternatively, words can be read in from a file (raw or gzip compressed) as
+well.
+
+    dictionary = Dictionary.from_file('path/to/uncompressed.txt')
+    dictionary = Dictionary.from_file('path/to/compressed.txt.gz')
+
+It is assumed that the file contains one word per line.  However, a separator
+can be passed to the method as an optional second parameter if that's not the
+case.
+
+    dictionary = Dictionary.from_file('path/to/uncompressed.txt', ' ')
+    dictionary = Dictionary.from_file('path/to/compressed.txt.gz', ',')
+
+Once a dictionary is loaded, the `#exists?` method can be used to determine if
+a word exists.
+
+    dictionary.exists?('bees')       # => true
+    dictionary.exists?('wasps')      # => false
+
+The `#starting_with` method returns a sorted array of all words starting with
+the provided string.
+
+    dictionary.starting_with('bee')  # => ["bee", "been", "bees"]
+    dictionary.starting_with('foo')  # => []
+
+## 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,6 @@
+require 'bundler/gem_tasks'
+
+Dir.glob('tasks/**/*.rake').each(&method(:import))
+
+desc 'Default: run unit specs'
+task default: :spec

data/lib/ruby-dictionary.rb

@@ -0,0 +1,2 @@
+require 'ruby-dictionary/dictionary'
+require 'ruby-dictionary/version'

data/lib/ruby-dictionary/dictionary.rb

@@ -0,0 +1,73 @@
+# encoding: utf-8
+
+require 'zlib'
+require 'ruby-dictionary/word_path'
+
+class Dictionary
+  def initialize(word_list)
+    @word_path = parse_words(word_list)
+  end
+
+  def exists?(word)
+    path = word_path(word)
+    !!(path && path.leaf?)
+  end
+
+  def starting_with(prefix)
+    prefix = prefix.to_s.strip.downcase
+    path = word_path(prefix)
+    return [] if path.nil?
+
+    words = [].tap do |words|
+      words << prefix if path.leaf?
+      words.concat(path.suffixes.collect! { |suffix| "#{prefix}#{suffix}" })
+    end
+
+    words.sort!
+  end
+
+  def hash
+    self.class.hash ^ @word_path.hash
+  end
+
+  def ==(obj)
+    obj.class == self.class && obj.hash == self.hash
+  end
+
+  def inspect
+    "#<#{self.class.name}>"
+  end
+
+  def to_s
+    inspect
+  end
+
+  def self.from_file(path, separator = "\n")
+    contents = case path
+                 when String then File.read(path)
+                 when File then path.read
+                 else raise ArgumentError, "path must be a String or File"
+               end
+
+    if contents.start_with?("\x1F\x8B")
+      gz = Zlib::GzipReader.new(StringIO.new(contents))
+      contents = gz.read
+    end
+
+    new(contents.split(separator))
+  end
+
+  private
+
+  def parse_words(word_list)
+    raise ArgumentError, "word_list should be an array of strings" unless word_list.kind_of?(Array)
+
+    WordPath.new.tap do |word_path|
+      word_list.each { |word| word_path << word.to_s }
+    end
+  end
+
+  def word_path(str)
+    @word_path.find(str)
+  end
+end

data/lib/ruby-dictionary/version.rb

@@ -0,0 +1,5 @@
+module Ruby
+  module Dictionary
+    VERSION = '1.0.0'
+  end
+end

data/lib/ruby-dictionary/word_path.rb

@@ -0,0 +1,77 @@
+class Dictionary
+  class WordPath
+    def initialize
+      @is_leaf = false
+      @word_paths = {}
+    end
+
+    def leaf?
+      @is_leaf
+    end
+
+    def leaf=(is_leaf)
+      @is_leaf = !!is_leaf
+    end
+
+    def <<(word)
+      raise ArgumentError, "must be a string" unless word.kind_of?(String)
+      _append(word.strip.downcase)
+    end
+
+    def find(word)
+      raise ArgumentError, "must be a string" unless word.kind_of?(String)
+      _find(word.strip.downcase)
+    end
+
+    def suffixes
+      [].tap do |suffixes|
+        @word_paths.each do |letter, path|
+          suffixes << letter if path.leaf?
+          suffixes.concat(path.suffixes.collect { |suffix| "#{letter}#{suffix}" })
+        end
+      end
+    end
+
+    def hash
+      self.class.hash ^ @is_leaf.hash ^ @word_paths.hash
+    end
+
+    def ==(obj)
+      obj.class == self.class && obj.hash == self.hash
+    end
+
+    def inspect
+      "#<WordPath @is_leaf=#@is_leaf @word_paths={#{@word_paths.keys.join(',')}}>"
+    end
+
+    def to_s
+      inspect
+    end
+
+    protected
+
+    def _find(word)
+      word_path = @word_paths[word[0]]
+      return nil unless word_path
+
+      if word.size == 1
+        word_path
+      else
+        word_path._find(word[1, word.size])
+      end
+    end
+
+    def _append(word)
+      return if word.empty?
+
+      char = word[0]
+      word_path = @word_paths[char] ||= self.class.new
+
+      if word.size == 1
+        word_path.leaf = true
+      else
+        word_path._append(word[1, word.size])
+      end
+    end
+  end
+end

data/ruby-dictionary.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruby-dictionary/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'ruby-dictionary'
+  gem.version       = Ruby::Dictionary::VERSION
+  gem.authors       = ['Matt Huggins']
+  gem.email         = ['matt.huggins@gmail.com']
+  gem.description   = %q{Dictionary class for ruby that allows for checking
+                         existence and finding words starting with a given
+                         prefix.}
+  gem.summary       = 'Simple dictionary class for checking existence of words'
+  gem.homepage      = 'https://github.com/mhuggins/ruby-dictionary'
+
+  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.require_paths = ['lib']
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+end

data/spec/fixtures/uncompressed_lined.txt

@@ -0,0 +1,16 @@
+a
+ab
+abs
+absolute
+absolutely
+
+be
+bee
+bees
+been
+
+zoo
+zoos
+zebra
+
+yuck

data/spec/fixtures/uncompressed_piped.txt

@@ -0,0 +1 @@
+a|ab|abs|absolute|absolutely||be|bee|bees|been||zoo|zoos|zebra||yuck

data/spec/ruby-dictionary/dictionary_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+describe Dictionary do
+  subject { Dictionary.new(word_list) }
+
+  let(:word_list) { %w(a ab abs absolute absolutely be bee bees been zoo zoos zebra yuck) }
+
+  describe '#exists?' do
+    it 'finds existing single-letter words' do
+      subject.exists?('a').should be_true
+    end
+
+    it 'finds existing multi-letter words' do
+      subject.exists?('ab').should be_true
+    end
+
+    it "doesn't find non-existing single-letter words" do
+      subject.exists?('e').should be_false
+    end
+
+    it "doesn't find non-existing multi-letter words" do
+      subject.exists?('eggsactly').should be_false
+    end
+  end
+
+  describe '#starting_with' do
+    it 'finds all words starting with a single letter' do
+      words = subject.starting_with('a')
+      words.size.should eq 5
+      words.should include 'a'
+      words.should include 'absolutely'
+      words.each { |word| word.should start_with 'a' }
+    end
+
+    it 'finds all words starting with multiple letters' do
+      words = subject.starting_with('abso')
+      words.size.should eq 2
+      words.should include 'absolute'
+      words.should include 'absolutely'
+      words.each { |word| word.should start_with 'a' }
+    end
+
+    it 'finds no words starting with unmatched single letter' do
+      subject.starting_with('e').should be_empty
+    end
+
+    it 'finds no words starting with unmatched multiple letters' do
+      subject.starting_with('absolutetastic').should be_empty
+    end
+  end
+
+  describe '#inspect' do
+    specify { subject.inspect.should eq '#<Dictionary>' }
+  end
+
+  describe '#to_s' do
+    specify { subject.to_s.should eq '#<Dictionary>' }
+  end
+
+  describe '.from_file' do
+    subject { Dictionary.from_file(dictionary_path, separator) }
+
+    let(:separator) { "\n" }
+
+    shared_examples 'loaded dictionary' do
+      it 'loads all words' do
+        subject.starting_with('a').size.should eq 5
+        subject.starting_with('b').size.should eq 4
+        subject.starting_with('y').size.should eq 1
+        subject.starting_with('z').size.should eq 3
+      end
+
+      it 'does not load nonexistent words' do
+        ('c'..'x').each do |letter|
+          subject.starting_with(letter).should be_empty
+        end
+      end
+    end
+
+    describe 'with compressed file' do
+      describe 'separated by line' do
+        let(:dictionary_path) { 'spec/fixtures/compressed_lined.txt.gz' }
+        it_behaves_like 'loaded dictionary'
+      end
+
+      describe 'separated by pipe' do
+        let(:dictionary_path) { 'spec/fixtures/compressed_piped.txt.gz' }
+        let(:separator) { '|' }
+        it_behaves_like 'loaded dictionary'
+      end
+    end
+
+    describe 'with uncompressed file' do
+      describe 'separated by line' do
+        let(:dictionary_path) { 'spec/fixtures/uncompressed_lined.txt' }
+        it_behaves_like 'loaded dictionary'
+      end
+
+      describe 'separated by pipe' do
+        let(:dictionary_path) { 'spec/fixtures/uncompressed_piped.txt' }
+        let(:separator) { '|' }
+        it_behaves_like 'loaded dictionary'
+      end
+    end
+  end
+end

data/spec/ruby-dictionary/word_path_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe Dictionary::WordPath do
+  subject { Dictionary::WordPath.new }
+
+  describe '#leaf=' do
+    it 'should set to false' do
+      subject.leaf = false
+      subject.should_not be_leaf
+    end
+
+    it 'should set to true' do
+      subject.leaf = true
+      subject.should be_leaf
+    end
+  end
+
+  describe '#find' do
+    before do
+      subject << 'potato'
+    end
+
+    it 'finds existing word paths' do
+      word_path = subject.find('potat')
+      word_path.should be_a Dictionary::WordPath
+      word_path.should eq Dictionary::WordPath.new.tap { |wp| wp << 'o' }
+    end
+
+    it 'does not find nonexistent word paths' do
+      subject.find('potable').should be_nil
+    end
+  end
+
+  describe '#<<' do
+    before do
+      subject.find('pot').should be_nil
+    end
+
+    it 'appends word to dictionary' do
+      subject << 'potato'
+      subject.find('pot').should_not be_nil
+    end
+  end
+
+  describe '#suffixes' do
+    before do
+      subject << 'pot'
+      subject << 'potato'
+      subject << 'potable'
+      subject << 'pert'
+      subject << 'jar'
+    end
+
+    it 'finds all words with the given suffix' do
+      word = subject.find('pot')
+      word.suffixes.should eq %w(ato able)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'ruby-dictionary'

data/tasks/debug.rake

@@ -0,0 +1,4 @@
+desc 'Open an irb session preloaded with this library'
+task :console do
+  sh 'irb -rubygems -I lib -r ruby-dictionary.rb'
+end

data/tasks/rspec.rake

@@ -0,0 +1,6 @@
+require 'rspec/core/rake_task'
+
+desc 'Run all examples'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = %w(--color)
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: ruby-dictionary
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Matt Huggins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2157439500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157439500
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2157439080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157439080
+description: ! "Dictionary class for ruby that allows for checking\n                         existence
+  and finding words starting with a given\n                         prefix."
+email:
+- matt.huggins@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ruby-dictionary.rb
+- lib/ruby-dictionary/dictionary.rb
+- lib/ruby-dictionary/version.rb
+- lib/ruby-dictionary/word_path.rb
+- ruby-dictionary.gemspec
+- spec/fixtures/compressed_lined.txt.gz
+- spec/fixtures/compressed_piped.txt.gz
+- spec/fixtures/uncompressed_lined.txt
+- spec/fixtures/uncompressed_piped.txt
+- spec/ruby-dictionary/dictionary_spec.rb
+- spec/ruby-dictionary/word_path_spec.rb
+- spec/spec_helper.rb
+- tasks/debug.rake
+- tasks/rspec.rake
+homepage: https://github.com/mhuggins/ruby-dictionary
+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.10
+signing_key: 
+specification_version: 3
+summary: Simple dictionary class for checking existence of words
+test_files:
+- spec/fixtures/compressed_lined.txt.gz
+- spec/fixtures/compressed_piped.txt.gz
+- spec/fixtures/uncompressed_lined.txt
+- spec/fixtures/uncompressed_piped.txt
+- spec/ruby-dictionary/dictionary_spec.rb
+- spec/ruby-dictionary/word_path_spec.rb
+- spec/spec_helper.rb