perquackey 0.7.1 → 0.7.2

data/CHANGELOG.rdoc

@@ -1,4 +1,10 @@
-== Git
+== 0.7.2 -- 2010-04-21
+* Clean up command-line options.
+* Write a perquackey(1) man page.
+* `gem check --test perquackey` should work now!
+* Require at least Ruby 1.8.7 -- building on 1.8.6 fails.
+
+== 0.7.1 -- 2010-04-15
 * Refactor Dictionary to have Ruby parts, with a C extension starting at the fgets on the IO stream.
 * Reorganize code for autoloading.
 * Reorganize code to properly use datadir.

data/Gemfile

@@ -1,8 +1,9 @@
 source :rubygems
 
-gem 'perquackey', :path => File.expand_path('.')
+gem 'sinatra'
 
 group :development do
   gem 'redgreen'
-  gem 'shoe', '0.5.0'
+  gem 'ronn'
+  gem 'shoe'
 end

data/Gemfile.lock

@@ -0,0 +1,43 @@
+--- 
+dependencies: 
+  shoe: 
+    group: 
+    - :development
+    version: ">= 0"
+  ronn: 
+    group: 
+    - :development
+    version: ">= 0"
+  sinatra: 
+    group: 
+    - :default
+    version: ">= 0"
+  redgreen: 
+    group: 
+    - :development
+    version: ">= 0"
+specs: 
+- rake: 
+    version: 0.8.7
+- configuration: 
+    version: 1.1.0
+- hpricot: 
+    version: 0.8.2
+- launchy: 
+    version: 0.3.5
+- rack: 
+    version: 1.1.0
+- rdiscount: 
+    version: 1.6.3.1
+- redgreen: 
+    version: 1.2.2
+- ronn: 
+    version: "0.5"
+- shoe: 
+    version: 0.6.0
+- sinatra: 
+    version: "1.0"
+hash: 43e16f41a78020948379f93caebbae6705f7a82c
+sources: 
+- Rubygems: 
+    uri: http://gemcutter.org

data/TODO.rdoc

@@ -1,4 +1,3 @@
-* Dictionary should take some kind of IO object.
 * Include the C extension in the rdoc.
 * Use the web interface for in-game support:
   * Capture words

data/bin/perquackey

@@ -1,4 +1,18 @@
 #!/usr/bin/env ruby
 
-require 'perquackey'
+begin
+  require 'perquackey'
+rescue LoadError
+  raise unless $!.message =~ /\bperquackey$/
+
+  lib = File.expand_path('../../lib', __FILE__)
+  if !$:.include?(lib)
+    warn "WARN: #{$!}.\n  Trying again with #{lib} on the $LOAD_PATH..."
+    $:.unshift(lib)
+    retry
+  end
+
+  raise
+end
+
 Perquackey::Application.run!(ARGV)

data/data/perquackey/templates/index.erb

@@ -2,11 +2,13 @@
   <input name="letters"
         value="<%= letters %>"
  autocomplete="on"
+     autosave="perquackey"
     autofocus="on"
     maxlength="13"
       pattern="[a-z]{10}([a-z]{3})?"
   placeholder="Type your letters here."
      required="on"
+      results="12"
         title="Perquackey rolls are 10 or 13 letters."
          type="search"
   />

data/lib/perquackey.rb

@@ -3,7 +3,7 @@ require 'rbconfig'
 require 'rbconfig/datadir'
 
 module Perquackey
-  VERSION = '0.7.1'
+  VERSION = '0.7.2'
 
   autoload :Anagrams,   'perquackey/anagrams'
   autoload :Application,'perquackey/application'
@@ -14,6 +14,13 @@ module Perquackey
   autoload :WordTable,  'perquackey/word_table'
 
   def self.datadir
-    Pathname.new RbConfig.datadir('perquackey')
+    @@datadir ||= begin
+      datadir = RbConfig.datadir('perquackey')
+      if !File.exist?(datadir)
+        warn "WARN: #{datadir} does not exist.\n  Trying again with relative data directory..."
+        datadir = File.expand_path('../../data/perquackey', __FILE__)
+      end
+      Pathname.new(datadir)
+    end
   end
 end

data/lib/perquackey/application.rb

@@ -7,35 +7,34 @@ module Perquackey
     end
 
     def initialize
-      @mode = :console
+      @defaults = %w(--console)
 
-      @options = OptionParser.new do |opts|
-        opts.banner = "Usage: #{File.basename($0)} [OPTIONS]"
+      @options  = OptionParser.new do |opts|
+        opts.banner  = "Usage: #{File.basename($0)} [-c|-s]"
+        opts.version = Perquackey::VERSION
         opts.separator ''
-        opts.separator 'Specific options:'
 
-        opts.on('-s', '--server [PORT]', 'Run a web server.') do |port|
+        opts.on('-c', '--console', 'Run an interactive console.') do
+          @mode = :console
+        end
+
+        opts.on('-s', '--server[=port]', 'Run an http server.') do |port|
           @mode = :server
           @port = port || 3000
         end
 
         opts.separator ''
-        opts.separator 'Common options:'
-
-        opts.on_tail('-h', '--help', 'Show this message.') do
-          puts opts
-          exit
-        end
-
-        opts.on_tail('-v', '--version', 'Print version and exit.') do
-          puts "perquackey #{Perquackey::VERSION}"
-          exit
-        end
+        opts.separator 'Defaults:'
+        opts.separator "#{opts.summary_indent}#{@defaults.join(' ')}"
       end
     end
 
     def run!(argv)
-      @options.parse!(argv)
+      begin
+        @options.parse(@defaults.dup.concat(argv))
+      rescue OptionParser::ParseError
+        @options.abort($!)
+      end
 
       case @mode
       when :console

data/man/perquackey.1

@@ -0,0 +1,84 @@
+.\" generated with Ronn/v0.5
+.\" http://github.com/rtomayko/ronn/
+.
+.TH "PERQUACKEY" "1" "April 2010" "Matthew Todd" "RubyGems Manual"
+.
+.SH "NAME"
+\fBperquackey\fR \-\- print a list of anagrams
+.
+.SH "SYNOPSIS"
+\fBperquackey\fR
+.
+.br
+\fBperquackey\fR \-\-server[=\fIport\fR]
+.
+.SH "DESCRIPTION"
+\fBperquackey\fR prints a list of anagrams for a given letter set, arranged in
+columns by length. It's designed as a companion to the Perquackey word game,
+vindicating you on the tough rolls and taunting you when you're blind to the \fII\fR \fIN\fR \fIG\fR right in front of your nose. Use with caution.
+.
+.SH "OPTIONS"
+By default, \fBperquackey\fR runs an interactive console for you to type in your
+letters. You can change that with the following options:
+.
+.TP
+\fB\-c\fR, \fB\-\-console\fR
+Run an interactive console. Being the default mode, this option exists
+purely for the sake of symmetry.
+.
+.TP
+\fB\-s\fR, \fB\-\-server\fR[=\fIport\fR]
+Run an http server. You can then type your letters in and see results at \fIhttp://localhost:port/\fR, where \fIport\fR defaults to \fI3000\fR.
+.
+.P
+\fBperquackey\fR also responds to the following standard options:
+.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Print a help message and exit.
+.
+.TP
+\fB\-v\fR, \fB\-\-version\fR[=all]
+Print \fBperquackey\fR's version number and exit. If \fB=all\fR is given, also
+print version numbers of \fBperquackey\fR's dependencies. (This is standard \fBoptparse\fR behavior that deserves more attention!)
+.
+.SH "EXAMPLE"
+Run an interactive console session, look up anagrams for "amwortixet," and exit:
+.
+.IP "" 4
+.
+.nf
+
+$ perquackey
+Type ctrl\-d or quit to exit.
+> amwortixet
+aim aero aimer attire omitter amoretti
+air airt amort extort toxemia
+ait amie armet imaret tritoma
+ami amir axiom matier wartime
+are atom axite matrix
+arm emir extra matter
+art emit irate ratite
+ate exam ixora remixt
+att exit mater rotate
+
+(...and so on...)
+
+> quit
+Goodbye.
+.
+.fi
+.
+.IP "" 0
+.
+.SH "BUGS"
+Anagrams are generated from an internal copy of TWL06, the standard accepted
+word list at North American Scrabble tournaments. You're going to see some
+weird ones. ("Ixora"?!)
+.
+.SH "AUTHOR"
+Matthew Todd, \fI@matthewtodd\fR on GitHub and Twitter. Do drop me a line if you
+use \fBperquackey\fR \-\- I'd love to hear from you!
+.
+.SH "SEE ALSO"
+\fIhttp://en.wikipedia.org/wiki/Perquackey\fR, \fIhttp://en.wikipedia.org/wiki/Tournament_Word_List\fR, \fIhttp://perquackey.matthewtodd.org/\fR

data/man/perquackey.1.ronn

@@ -0,0 +1,76 @@
+perquackey(1) -- print a list of anagrams
+=========================================
+
+## SYNOPSIS
+
+`perquackey`  
+`perquackey` --server[=_port_]
+
+## DESCRIPTION
+
+`perquackey` prints a list of anagrams for a given letter set, arranged in
+columns by length. It's designed as a companion to the Perquackey word game,
+vindicating you on the tough rolls and taunting you when you're blind to the
+_I_ _N_ _G_ right in front of your nose. Use with caution.
+
+## OPTIONS
+
+By default, `perquackey` runs an interactive console for you to type in your
+letters. You can change that with the following options:
+
+  * `-c`, `--console`:
+    Run an interactive console. Being the default mode, this option exists
+    purely for the sake of symmetry.
+
+  * `-s`, `--server`[=_port_]:
+    Run an http server. You can then type your letters in and see results at
+    <http://localhost:port/>, where <port> defaults to _3000_.
+
+`perquackey` also responds to the following standard options:
+
+  * `-h`, `--help`:
+    Print a help message and exit.
+
+  * `-v`, `--version`[=all]:
+    Print `perquackey`'s version number and exit. If `=all` is given, also
+    print version numbers of `perquackey`'s dependencies. (This is standard
+    `optparse` behavior that deserves more attention!)
+
+## EXAMPLE
+
+Run an interactive console session, look up anagrams for "amwortixet," and exit:
+
+    $ perquackey
+    Type ctrl-d or quit to exit.
+    > amwortixet
+    aim aero aimer attire omitter amoretti
+    air airt amort extort toxemia
+    ait amie armet imaret tritoma
+    ami amir axiom matier wartime
+    are atom axite matrix
+    arm emir extra matter
+    art emit irate ratite
+    ate exam ixora remixt
+    att exit mater rotate
+
+    (...and so on...)
+
+    > quit
+    Goodbye.
+
+## BUGS
+
+Anagrams are generated from an internal copy of TWL06, the standard accepted
+word list at North American Scrabble tournaments. You're going to see some
+weird ones. ("Ixora"?!)
+
+## AUTHOR
+
+Matthew Todd, _@matthewtodd_ on GitHub and Twitter. Do drop me a line if you
+use `perquackey` -- I'd love to hear from you!
+
+## SEE ALSO
+
+<http://en.wikipedia.org/wiki/Perquackey>,
+<http://en.wikipedia.org/wiki/Tournament_Word_List>,
+<http://perquackey.matthewtodd.org/>

data/perquackey.gemspec

@@ -11,8 +11,10 @@ Gem::Specification.new do |spec|
   spec.email  = 'matthew.todd@gmail.com'
   spec.homepage = 'http://github.com/matthewtodd/perquackey'
 
+  spec.required_ruby_version = '>= 1.8.7'
   spec.add_runtime_dependency 'sinatra'
   spec.add_development_dependency 'redgreen'
+  spec.add_development_dependency 'ronn'
   spec.add_development_dependency 'shoe'
 
   def spec.git_files(glob=nil)

data/test/helper.rb

@@ -1,6 +1,9 @@
-require 'perquackey'
 require 'test/unit'
+require 'perquackey'
 
-if $stdout.tty?
-  require 'redgreen'
+begin
+  require 'redgreen' if $stdout.tty?
+rescue LoadError
+  # It's nice not to have hard dependencies on any gems for testing, so that
+  # it's super-easy for your users to run `gem check --test perquackey.`
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 7
-  - 1
-  version: 0.7.1
+  - 2
+  version: 0.7.2
 platform: ruby
 authors: 
 - Matthew Todd
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-16 00:00:00 +03:00
+date: 2010-04-21 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,7 +42,7 @@ dependencies:
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: shoe
+  name: ronn
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
@@ -53,6 +53,18 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: shoe
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
 description: Provides console session and simple webapp for looking up Perquackey word matches
 email: matthew.todd@gmail.com
 executables: 
@@ -67,6 +79,7 @@ files:
 - .gitignore
 - CHANGELOG.rdoc
 - Gemfile
+- Gemfile.lock
 - README.rdoc
 - Rakefile
 - TODO.rdoc
@@ -83,6 +96,8 @@ files:
 - lib/perquackey/game.rb
 - lib/perquackey/server.rb
 - lib/perquackey/word_table.rb
+- man/perquackey.1
+- man/perquackey.1.ronn
 - perquackey.gemspec
 - test/dictionary_test.rb
 - test/helper.rb
@@ -96,7 +111,7 @@ rdoc_options:
 - --main
 - README.rdoc
 - --title
-- perquackey-0.7.1
+- perquackey-0.7.2
 - --inline-source
 require_paths: 
 - lib
@@ -105,8 +120,10 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version 
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="