scrabble-solver 0.1

data/bin/scrabble-solver

@@ -0,0 +1,68 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require File.dirname(__FILE__) + '/../lib/scrabble-solver'
+
+options = Hash.new(nil)
+
+# Use the optparse library to populate the options hash.
+OptionParser.new do |o|
+  o.banner = 'Usage: scrabble-solver tiles [options]'
+
+  # Add the README contents to the --help flag.
+  o.separator "\n" + File.read(File.dirname(__FILE__) + '/../README.md') + "\n"
+
+  o.separator "Optional arguments:"
+
+  o.on '-h', '--help', 'Display this message' do
+    puts o
+    exit
+  end
+
+  o.on '--longer-than LENGH',
+       'Only return words longer than LENGTH.' do |length|
+    options[:longer_than] = length
+  end
+
+  o.on '--shorter-than LENGH',
+       'Only return words shorter than LENGTH.' do |length|
+    options[:shorter_than] = length
+  end
+
+  o.on '--starts-with PREFIX',
+       'Only return words that start with PREFIX.' do |prefix|
+    options[:starts_with] = prefix
+  end
+
+  o.on '--ends-with SUFFIX',
+       'Only return words that end with SUFFIX.' do |suffix|
+    options[:ends_with] = suffix
+  end
+
+  o.on '--contains PART',
+       'Only return words that contain PART. Must be combined with --at.' do |part|
+    options[:contains] = part
+  end
+
+  o.on '--at INDEX',
+       'The index to search for --contains at.' do |index|
+    options[:at] = index
+  end
+
+  o.on '--word-file FILE',
+       'The word file to use. Defaults to a preset list of words.' do |file|
+    options[:word_file] = file
+  end
+end.parse!
+
+# Pull the tiles from the first argument.
+letters = ARGV[0]
+
+# Exit the program if no first argument was supplied.
+if letters.nil?
+  puts "You need to supply letters to work with as the first argument."
+  exit
+end
+
+# If all is well, solve :)
+puts Scrabble::Solver.words_for letters, options

data/lib/scrabble-solver.rb

@@ -0,0 +1,3 @@
+Dir[File.dirname(__FILE__) + "/scrabble-solver/*.rb"].each do |file|
+  require file
+end

data/lib/scrabble-solver/solver.rb

@@ -0,0 +1,110 @@
+module Scrabble
+  module Solver
+    # The name of the file to use as a word dictionary. This file can be any
+    # file that contains a list of words, one word per line.
+    @word_file_name = File.dirname(__FILE__) + "/../../assets/words.txt"
+
+    # Set a new word file. Exit the program if the file does not exist.
+    #
+    # If the file does exist, the cached word list is cleared out and the
+    # next time the word list is requested, the new list from the new file
+    # is returned and subsequently cached.
+    def self.word_file_name= file_name
+      if File.exists? file_name
+        # Reset the word list
+        @word_list      = nil
+        @word_file_name = file_name
+      else
+        puts "The file name #{file_name} is not valid."
+        exit
+      end
+    end
+
+    # Reads in the words.txt file and returns an array containing all of the words
+    # in that file.
+    #
+    # Example:
+    #
+    #   Scrabble::Solver.word_list.each do |word|
+    #     puts word
+    #   end
+    def self.word_list
+      @word_list ||= File.open(@word_file_name) do |file|
+        file.readlines.map do |line|
+          line.chomp
+        end.delete_if do |line|
+          line.length < 2
+        end
+      end
+
+      @word_list.clone
+    end
+
+    # Gets an array of words that would fit the current board of Scrabble
+    # tiles.
+    #
+    # Example:
+    #
+    #   Scrabble::Solver.words_for "there"
+    #   # => An array of words that the tiles t, h, e, r, e could make.
+    #
+    #   Scrabble::Solver.words_for "there?"
+    #   # => An array of words that the tiles t, h, e, r, e plus a blank tile
+    #   #    could make.
+    def self.words_for letters, options = Hash.new(nil)
+      letters  = letters.downcase.split(//)
+      unknowns = letters.count "?"
+      letters.delete "?"
+
+      # Set a new word file if the option has been specified
+      if options[:word_file]
+        self.word_file_name = options[:word_file]
+      end
+
+      words = word_list.keep_if do |word|
+        # Split the word into its letters.
+        word = word.split(//)
+
+        # Strip the letters that are in our hand from the word.
+        letters.each do |letter|
+          unless word.index(letter).nil?
+            word.delete_at word.index(letter)
+          end
+        end
+
+        # Only return the word if the remaining letters is equal to the number
+        # of unknowns.
+        word.length == unknowns
+      end
+
+      # Filter only words that start with a specific sequence.
+      if options[:starts_with]
+        words.keep_if { |word| word.start_with? options[:starts_with] }
+      end
+
+      # Filter words that only end in a certain sequence.
+      if options[:ends_with]
+        words.keep_if { |word| word.end_with? options[:ends_with] }
+      end
+
+      # Fitler only words shorter than a given amount.
+      if options[:shorter_than]
+        words.keep_if { |word| word.length < options[:shorter_than].to_i }
+      end
+
+      # Filter words only longer than a given amount.
+      if options[:longer_than]
+        words.keep_if { |word| word.length > options[:longer_than].to_i }
+      end
+
+      # Filter words that contain a specific sequence at a given 1-based index.
+      if options[:contains] and options[:at]
+        words.keep_if do |word|
+          word[options[:at].to_i - 1, options[:contains].length] == options[:contains]
+        end
+      end
+
+      return words
+    end
+  end
+end

data/spec/scrabble-solver/solver_spec.rb

@@ -0,0 +1,181 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+module Scrabble
+  describe Solver do
+    # Specify the name of the test word file.
+    let(:test_word_file) do
+      File.dirname(__FILE__) + "/../assets/test_word_list.txt"
+    end
+
+    # Path to the solver executable
+    let (:executable) do
+      File.dirname(__FILE__) + "/../../bin/scrabble-solver"
+    end
+
+    context "Direct" do
+      it "should return a list of words that can be made" do
+        words = Solver.words_for "there"
+        words.should include "three", "there", "ether", "the", "thee", "tee"
+      end
+
+      it "should be able to use blank tiles with ?" do
+        words = Solver.words_for "g?me"
+        words.should include "game", "egg", "peg", "gel", "germ", "get", "go", "gum"
+      end
+
+      it "should be able to use a start_with argument successfully" do
+        words = Solver.words_for "geg", starts_with: "eg"
+        words.should include "egg"
+      end
+
+      it "should be able to use an ends_with argument successfully" do
+        words = Solver.words_for "pngi", ends_with: "ing"
+        words.should include "ping"
+      end
+
+      it "should be able to use a combination of starts_with and ends_with" do
+        words = Solver.words_for "crcak", starts_with: "cr", ends_with: "k"
+        words.should include "crack"
+      end
+
+      it "should be able to filter words by length" do
+        words = Solver.words_for "diegtlkwj", longer_than: "4"
+        words.each do |word|
+          word.length.should be > 4
+        end
+
+        # Ensure that some words were actually checked in the above loop.
+        words.length.should be > 0, "No words scanned."
+      end
+
+      it "should be able to filter by length, less than" do
+        words = Solver.words_for "diegtlkwj", shorter_than: "4"
+        words.each do |word|
+          word.length.should be < 4
+        end
+
+        # Ensure that some words were actually checked in the above loop.
+        words.length.should be > 0, "No words scanned."
+      end
+
+      it "should be able to filter by length both less than and greater than" do
+        words = Solver.words_for "diegtlkwj", shorter_than: "6", longer_than: "4"
+        words.each do |word|
+          word.length.should be > 4 and word.length.should be < 6
+        end
+
+        # Ensure that some words were actually checked in the above loop.
+        words.length.should be > 0, "No words scanned."
+      end
+
+      it "should be able to return only words that have a specific letter at " +
+        "a given index" do
+        words = Solver.words_for "diegti?wj", contains: "i", at: "2"
+        words.each do |word|
+          word[1].should == "i"
+        end
+
+        # Ensure that some words were actually checked in the above loop.
+        words.length.should be > 0, "No words scanned."
+        end
+
+      it "should be able to return only words that have a specific middle part" do
+        words = Solver.words_for "diegti?wj", contains: "it", at: "2"
+        words.each do |word|
+          word[1, 2].should == "it"
+        end
+
+        # Ensure that some words were actually checked in the above loop.
+        words.length.should be > 0, "No words scanned."
+      end
+
+      it "should be able to take a new word file if specified" do
+        words = Solver.words_for "????", word_file: test_word_file
+        words.should be_empty
+      end
+    end
+
+    context "Command-line" do
+      it "should return a list of words that can be made" do
+        words = `#{executable} tehre`.split(/\n/)
+        words.should include "three", "there", "ether", "the", "thee", "tee"
+      end
+
+      it "should be able to use blank tiles with ?" do
+        words = `#{executable} g?me`.split(/\n/)
+        words.should include "game", "egg", "peg", "gel", "germ", "get", "go", "gum"
+      end
+
+      it "should be able to use a start_with argument successfully" do
+        words = `#{executable} geg --starts-with eg`.split(/\n/)
+        words.should include "egg"
+      end
+
+      it "should be able to use an ends_with argument successfully" do
+        words = `#{executable} pngi --ends-with ing`.split(/\n/)
+        words.should include "ping"
+      end
+
+      it "should be able to use a combination of starts_with and ends_with" do
+        words = `#{executable} crcak --starts-with cr --ends-with k`.split(/\n/)
+        words.should include "crack"
+      end
+
+      it "should be able to filter words by length" do
+        words = `#{executable} diegtlkwj --longer-than 4`.split(/\n/)
+        words.each do |word|
+          word.length.should be > 4
+        end
+
+        # Ensure that some words were actually checked in the above loop.
+        words.length.should be > 0, "No words scanned."
+      end
+
+      it "should be able to filter by length, less than" do
+        words = `#{executable} diegtlkwj --shorter-than 4`.split(/\n/)
+        words.each do |word|
+          word.length.should be < 4
+        end
+
+        # Ensure that some words were actually checked in the above loop.
+        words.length.should be > 0, "No words scanned."
+      end
+
+      it "should be able to filter by length both less than and greater than" do
+        words = `#{executable} diegtlkwj --shorter-than 6 --longer-than 4`.split(/\n/)
+        words.each do |word|
+          word.length.should be > 4 and word.length.should be < 6
+        end
+
+        # Ensure that some words were actually checked in the above loop.
+        words.length.should be > 0, "No words scanned."
+      end
+
+      it "should be able to return only words that have a specific letter at " +
+        "a given index" do
+        words = `#{executable} diegtlkwj --contains i --at 2`.split(/\n/)
+        words.each do |word|
+          word[1].should == "i"
+        end
+
+        # Ensure that some words were actually checked in the above loop.
+        words.length.should be > 0, "No words scanned."
+        end
+
+      it "should be able to return only words that have a specific middle part" do
+        words = `#{executable} diegti?wj --contains it --at 2`.split(/\n/)
+        words.each do |word|
+          word[1, 2].should == "it"
+        end
+
+        # Ensure that some words were actually checked in the above loop.
+        words.length.should be > 0, "No words scanned."
+      end
+
+      it "should be able to take a new word file if specified" do
+        words = `#{executable} ???? --word-file #{test_word_file}`.split(/\n/)
+        words.should be_empty
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/../lib/scrabble-solver"

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: scrabble-solver
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Sam Rose
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-08 00:00:00.000000000Z
+dependencies: []
+description: Want to win at Scrabble while staying inside your comfy command line
+  interface? No problem! Scrabble solver lets you do that.
+email: samwho@lbak.co.uk
+executables:
+- scrabble-solver
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/scrabble-solver
+- lib/scrabble-solver.rb
+- lib/scrabble-solver/solver.rb
+- spec/scrabble-solver/solver_spec.rb
+- spec/spec_helper.rb
+- assets/words.txt
+- .gemtest
+- README.md
+- LICENSE
+- Gemfile
+- Guardfile
+homepage: http://github.com/samwho/scrabble-solver
+licenses:
+- GPL-2
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: A command line Scrabble solving utility.
+test_files: []