manywords 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0facce806f1a0848860e6a4979e2aaf3490670ee
+  data.tar.gz: 668abe4571f4572595a3c1d9eba01a945fe3a9a1
+SHA512:
+  metadata.gz: a04a8cdf330f52f5c765610ab43debc09b320a3090297ee19f14e4552a990dc1e0071269098e3d64622c8140867640e28b809e0018af9f07799a15a3c9a70a6b
+  data.tar.gz: 375101bbb42c48cad6df8ca65603e86881bc35a3eec60e52f9d3cdc379870606177809daac764f835c7f969880fbe6c6d6b9825fc0f8ada4c7ae6e58cc5b712c

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Stephen H. Gerstacker
+
+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,39 @@
+# Manywords
+
+You may be playing a word game and be stuck. Use this gem to find all of the possible words that exist with a given word combination. You can also provide a regular expression to filter you search.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'manywords'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install manywords
+
+## Usage
+
+To just find all possible words, run the following:
+
+    $ manywords abcde
+
+To filter your search, run the following:
+
+    $ manywords ^...$
+
+By default, manywords uses the UNIX standard dictionary file, `/usr/share/dict/words`.  If your platform doesn't have this file, or you would like to provide your own, use the `--dictionary` flag.
+
+    $ manywords --dictionary /path/to/dict abcde
+
+## 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,12 @@
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib/manywords'
+  t.test_files = FileList['test/lib/manywords/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test
+

data/bin/manywords

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'manywords/command'
+
+Manywords::Command.run
+

data/lib/manywords/command.rb

@@ -0,0 +1,74 @@
+require 'manywords'
+require 'methadone'
+
+module Manywords
+
+  class Command
+    include Methadone::Main
+    include Methadone::CLILogging
+
+    def self.run
+
+      main do |letters, pattern = ''|
+        # Make sure the given dictionary exists
+        unless File.exists? options['dictionary']
+          $stderr.puts "Could not load the dictionary"
+          return
+        end
+
+        # Load the dictionary
+        dictionary = DictionaryNode.new
+        File.open(options['dictionary'], 'r') do |file|
+          puts "Reading the dictionary..."
+
+          file.each_line do |line|
+            # Skip proper nouns
+            next if line =~ /[A-Z]/
+
+            # Skip 1 letter words
+            line.strip!
+            next if line.length <= 1
+
+            # Clean up the line
+            line.downcase!
+
+            # Add it!
+            dictionary.add_word line
+          end
+
+          puts "Read #{dictionary.count} words."
+        end
+
+        # Construct the pattern if given
+        regex = Regexp.new(pattern)
+
+        walker = Walker.new
+        walker.walk letters do |word|
+          result = dictionary.find_word word
+
+          if result == :yes
+            test_word = word.is_a?(Array) ? word.join('') : word.to_s
+
+            puts test_word if regex =~ test_word
+          end
+
+          result
+        end
+      end
+
+      version     Manywords::VERSION
+      description 'Determine word combinations'
+      arg         :letters, :required
+      arg         :pattern, :optional
+
+      options['dictionary'] = '/usr/share/dict/words'
+      on('-d PATH', '--dictionary', 'Dictionary')
+
+      go!
+    end
+
+  end
+
+end
+
+

data/lib/manywords/dictionary_node.rb

@@ -0,0 +1,53 @@
+module Manywords
+
+  class DictionaryNode
+
+    attr_reader :count
+
+    def initialize
+      @count = 0;
+      @letters = {}
+      @word = false
+    end
+
+    def add_word(word, idx = 0)
+      # If we've reached the end of the word, mark it as so
+      if idx == word.length
+        @word = true
+        return
+      end
+
+      # A word will be added, so increment
+      @count += 1
+
+      # Get the letter and add it to the tree if we need to
+      letter = word[idx]
+      @letters[letter] = DictionaryNode.new unless @letters.key?(letter)
+
+      # Go to the next letter
+      @letters[letter].add_word word, idx + 1
+    end
+
+    def find_word(word, idx = 0)
+      if !word.is_a?(String) && !word.is_a?(Array)
+        raise "find_word requires an Array or a String"
+      end
+
+      # We've reached the end, so this is either a word or a partial word
+      if idx == word.length
+        return @word ? :yes : :maybe
+      end
+
+      # Check if this letter is valid
+      letter = word[idx]
+      if @letters.key? letter
+        # Valid, so go to the next letter
+        @letters[letter].find_word word, idx + 1
+      else
+        :no
+      end
+    end
+
+  end
+
+end

data/lib/manywords/version.rb

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

data/lib/manywords/walker.rb

@@ -0,0 +1,31 @@
+module Manywords
+
+  class Walker
+
+    def walk(letters, &block)
+      list = letters.split ''
+      list.sort!
+      permutations [], list, &block
+    end
+
+    private
+
+    def permutations(prefix, available, &block)
+      # Visit the prefix
+      result = block.call prefix
+
+      # Do we continue from here?
+      if (result != :no)
+        available.each_with_index do |letter, idx|
+          next_available = available.dup
+          next_available.delete_at(idx)
+
+          permutations prefix + [ letter ], next_available, &block
+        end
+      end
+    end
+
+  end
+
+end
+

data/lib/manywords.rb

@@ -0,0 +1,7 @@
+require "manywords/dictionary_node"
+require "manywords/walker"
+require "manywords/version"
+
+module Manywords
+  # Your code goes here...
+end

data/manywords.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'manywords/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "manywords"
+  spec.version       = Manywords::VERSION
+  spec.authors       = ["Stephen H. Gerstacker"]
+  spec.email         = ["stephen@shortround.net"]
+  spec.description   = %q{Discover words in random letters}
+  spec.summary       = %q{Given a set of random letters, find all of the words in it}
+  spec.homepage      = "http://shortround.net"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "methadone", "~> 1.2.6"
+
+  spec.required_ruby_version = '>= 2.0.0'
+end

data/test/lib/manywords/dictionary_node_test.rb

@@ -0,0 +1,70 @@
+require_relative '../../test_helper'
+
+module Manywords
+
+  describe DictionaryNode do
+
+    it "must be initially empty" do
+      node = DictionaryNode.new
+      node.count.must_equal 0
+    end
+
+    it "must add a word" do
+      node = DictionaryNode.new
+
+      node.add_word 'hello'
+      node.count.must_equal 1
+
+      node.add_word 'world'
+      node.count.must_equal 2
+    end
+
+    it "must return maybe if empty" do
+      node = DictionaryNode.new
+
+      node.find_word('').must_equal :maybe
+      node.find_word([]).must_equal :maybe
+    end
+
+    it "must verify a word is valid" do
+      node = DictionaryNode.new
+      node.add_word 'hello'
+
+      node.find_word('hello').must_equal :yes
+      node.find_word(%w{h e l l o}).must_equal :yes
+    end
+
+    it "must verify an invalid word is invalid" do
+      node = DictionaryNode.new
+      node.add_word 'hello'
+
+      node.find_word('world').must_equal :no
+      node.find_word(%w{w o r l d}).must_equal :no
+    end
+
+    it "must verify a series of letters could potentially be a word" do
+      node = DictionaryNode.new
+      node.add_word 'post'
+      node.add_word 'postfix'
+
+      node.find_word('p').must_equal :maybe
+      node.find_word('po').must_equal :maybe
+      node.find_word('pos').must_equal :maybe
+      node.find_word('post').must_equal :yes
+      node.find_word('postf').must_equal :maybe
+      node.find_word('postfi').must_equal :maybe
+      node.find_word('postfix').must_equal :yes
+
+      node.find_word(%w{p}).must_equal :maybe
+      node.find_word(%w{p o}).must_equal :maybe
+      node.find_word(%w{p o s}).must_equal :maybe
+      node.find_word(%w{p o s t}).must_equal :yes
+      node.find_word(%w{p o s t f}).must_equal :maybe
+      node.find_word(%w{p o s t f i}).must_equal :maybe
+      node.find_word(%w{p o s t f i x}).must_equal :yes
+    end
+
+  end
+
+end
+

data/test/lib/manywords/version_test.rb

@@ -0,0 +1,10 @@
+require_relative '../../test_helper'
+
+describe Manywords do
+
+  it "must be versioned" do
+    Manywords::VERSION.wont_be_nil
+  end
+
+end
+

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require File.expand_path('../../lib/manywords.rb', __FILE__)
+

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: manywords
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stephen H. Gerstacker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: methadone
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.6
+description: Discover words in random letters
+email:
+- stephen@shortround.net
+executables:
+- manywords
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/manywords
+- lib/manywords.rb
+- lib/manywords/command.rb
+- lib/manywords/dictionary_node.rb
+- lib/manywords/version.rb
+- lib/manywords/walker.rb
+- manywords.gemspec
+- test/lib/manywords/dictionary_node_test.rb
+- test/lib/manywords/version_test.rb
+- test/test_helper.rb
+homepage: http://shortround.net
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Given a set of random letters, find all of the words in it
+test_files:
+- test/lib/manywords/dictionary_node_test.rb
+- test/lib/manywords/version_test.rb
+- test/test_helper.rb