pressletter 0.0.1 → 0.0.2

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+bundler_args: --without productivity
+script: 'bundle exec rspec'
+notifications:
+  recipients:
+    - justin@testdouble.com

data/Gemfile

@@ -3,7 +3,7 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in pressletter.gemspec
 gemspec
 
-group :development do
+group :productivity do
   gem 'guard'
   gem 'guard-rspec'
   gem 'growl'

data/README.md

@@ -1,16 +1,46 @@
 # Pressletter
 
+[![Build Status](https://secure.travis-ci.org/searls/pressletter.png)](http://travis-ci.org/searls/pressletter)
+
 Letterpress is a fantastic game for iOS written by [Loren Brichter](http://www.atebits.com). Pressletter is a gem that solves Letterpress boards using an included plaintext dictionary of words.
 
+## Installation
+
+### global install
+
+To install pressletter to your system, run:
+
+```
+$ gem install pressletter
+```
+
+### bundler
+
+If you're using [Bundler](http://gembundler.com), add the pressletter gem to your Gemfile:
+
+``` ruby
+source 'https://rubygems.org'
+
+gem 'pressletter'
+```
+
+and then run:
+
+```
+$ bundle install
+```
+
+Inside your Bundler project, the binary can then be accessed with `bundle exec pressletter`.
+
 ## Example
 
-Here's what a board looked like in a game I played with @steveklabnik:
+Here's what a board looked like in a game I played with [@steveklabnik](https://github.com/steveklabnik):
 
 ![pressletter Screen](http://i.minus.com/ibv4sMC7Msl5Fv.png)
 
-Using the pressletter gem, you can take a look at what words *would* have been possible to play by passing in all 25 available letters (including any repeats, since the rules dictate that each letter is consumed as it is used).
+Using the pressletter gem, you can search for playable words by providing the 25 letters on the game board (even any repeats, since the game rules stipulate that each letter can only be used as many times as it appears on the board).
 
-As you can see in the screen, those letters (in lexical order) are: `E I P T C T B N T Y M E I P H O X V I T K M Z I B`.
+For instance, the letters in the provided screenshot are: `E I P T C T B N T Y M E I P H O X V I T K M Z I B`.
 
 ### command-line
 
@@ -37,13 +67,30 @@ E I P T C T B N T Y M E I P H O X V I T K M Z I B
 
 ```
 
-### ruby
+In each case, the results will print in order of largest-to-smallest length (with secondary alphabetical order for words of the same length). The output looks like:
+
+```
+$ pressletter eiptctbntymeiphoxvitkmzib
+COMPETITIVITE
+BIOETHICIEN
+...
+XI
+```
+
+### Ruby
+
+You can, of course, also look for solutions using pure ruby. The public API is exceedingly simple:
+
+**Pressletter.solve(letters[, config])**
+
+For input, all that's needed is a string or array of candidate letters. A config object that responds to `dictionary_location` with a path of a dictionary file can also be optionally provided. An array (sorted largest-to-smallest) of valid words is returned.
 
-Here's an interactive shell session that uses the gem programmatically:
+Here's an interactive session that uses the gem programmatically:
 
 ``` ruby
 $ irb
 irb(main):001:0> require 'pressletter'
+=> true
 irb(main):002:0> letters = ["e", "i", "p", "t", "c", "t", "b", "n", "t", "y", "m", "e", "i", "p", "h", "o", "x", "v", "i", "t", "k", "m", "z", "i", "b"]
 => ["e", "i", "p", "t", "c", "t", "b", "n", "t", "y", "m", "e", "i", "p", "h", "o", "x", "v", "i", "t", "k", "m", "z", "i", "b"]
 irb(main):003:0> Pressletter.solve(letters)

data/benchmarks/benchmark.rb

@@ -0,0 +1,92 @@
+module Bench
+  def self.mark(name, &experiment)
+    @marks ||= Marks.new
+    @marks.add(name, &experiment)
+  end
+
+  def self.run
+    return unless @marks
+    @marks.run
+  end
+
+  class Marks
+    def initialize
+      @marks = {}
+    end
+
+    def add(name, &experiment)
+      raise "Benchmark named \"#{name}\" was already defined!" if @marks.has_key?(name)
+      @marks[name] = {:experiment => experiment }
+    end
+
+    def run
+      require 'benchmark'
+
+      Results.new(
+        @marks.map do |(name, mark)|
+          begin
+            {
+              :name => name,
+              :errors => nil,
+              :time => Benchmark.measure(&mark[:experiment]).total
+            }
+          rescue
+            {
+              :name => name,
+              :errors => [$!.message],
+              :time => nil
+            }
+          end
+        end
+      )
+    end
+  end
+
+  class Results
+    def initialize(results)
+      @results = results
+    end
+
+    def as_array
+      @results
+    end
+
+    def total_time
+      raise failure_message if failures?
+      @results.map {|r| r[:time] }.inject(&:+)
+    end
+
+    def average_time
+      total_time / @results.size
+    end
+
+  private
+
+    def failure_message
+      "Errors occurred, total benchmark time is meaningless:\n\n #{errors}"
+    end
+
+    def failures?
+      @results.any? {|r| r[:errors] }
+    end
+
+    def errors
+      @results.map { |r| r[:errors] }.flatten.compact.join("\n")
+    end
+  end
+
+
+end
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'pressletter'
+
+Bench.mark "eiptctbntymeiphoxvitkmzib" do
+  Pressletter.solve("eiptctbntymeiphoxvitkmzib")
+end
+
+# Bench.mark "agslumxaeyylyuwfoszmddjhi" do
+#   Pressletter.solve("agslumxaeyylyuwfoszmddjhi")
+# end
+
+puts Bench.run.total_time

data/lib/pressletter/core/find_words.rb

@@ -10,6 +10,7 @@ module Pressletter::Core
 private
 
   def letters_can_buy?(letters, word)
+    return if impossible?(letters, word)
     letters = letters.as_hash.dup
     word.dup.split('').all? do |char|
       decrement_char!(char, letters)
@@ -20,4 +21,8 @@ private
     letters[char] -= 1 if letters[char] && letters[char] > 0
   end
 
+  def impossible?(letters, word)
+    word.split('').any? { |c| !letters.as_array.include?(c) }
+  end
+
 end

data/lib/pressletter/version.rb

@@ -1,3 +1,3 @@
 module Pressletter
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pressletter
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -73,12 +73,14 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - assets/dictionary.txt
+- benchmarks/benchmark.rb
 - bin/pressletter
 - lib/pressletter.rb
 - lib/pressletter/core/create_letters.rb