perquackey 0.7.2 → 0.7.3

data/CHANGELOG.rdoc

@@ -1,3 +1,6 @@
+== 0.7.3 -- 2010-04-29
+* Document C extension.
+
 == 0.7.2 -- 2010-04-21
 * Clean up command-line options.
 * Write a perquackey(1) man page.

data/TODO.rdoc

@@ -1,4 +1,3 @@
-* Include the C extension in the rdoc.
 * Use the web interface for in-game support:
   * Capture words
   * Calculate score

data/ext/perquackey/anagrams.c

@@ -9,7 +9,7 @@
 static VALUE mPerquackey;
 static VALUE mAnagrams;
 
-void chop(char *string) {
+static void chop(char *string) {
   int length = strlen(string);
 
   if (length > 0 && string[length-1] == '\n') {
@@ -17,7 +17,7 @@ void chop(char *string) {
   }
 }
 
-int anagram_p(char *letters, char *word) {
+static int anagram_p(char *letters, char *word) {
   static char scratch_pad[MAX_LENGTH];
   register char *scratch_pad_ptr;
 
@@ -34,7 +34,15 @@ int anagram_p(char *letters, char *word) {
   return TRUE;
 }
 
-VALUE Anagrams_anagrams(VALUE self, VALUE letters) {
+/*
+ * Document-class: Anagrams
+ * Document-method: anagrams
+ *
+ * call-seq:
+ *   anagrams(letters) -> array
+ *
+ */
+static VALUE Anagrams_anagrams(VALUE self, VALUE letters) {
   return rb_apply(
            rb_apply(self,
                     rb_intern("enum_for"),
@@ -43,7 +51,15 @@ VALUE Anagrams_anagrams(VALUE self, VALUE letters) {
            rb_ary_new());
 }
 
-VALUE Anagrams_each_anagram(VALUE self, VALUE letters_value) {
+/*
+ * Document-class: Anagrams
+ * Document-method: each_anagram
+ *
+ * call-seq:
+ *   each_anagram(letters) { |anagram| ... } -> nil
+ *
+ */
+static VALUE Anagrams_each_anagram(VALUE self, VALUE letters_value) {
   rb_io_t *stream;
   char     word[MAX_LENGTH];
   char    *letters = RSTRING(letters_value)->ptr;
@@ -61,6 +77,18 @@ VALUE Anagrams_each_anagram(VALUE self, VALUE letters_value) {
   return Qnil;
 }
 
+/*
+ * Anagrams extends a File-backed IO stream with the ability to yield each
+ * anagram of the given letters it contains:
+ *
+ *  File.open('/usr/share/dict/words') do |stream|
+ *    stream.extend(Anagrams)
+ *    stream.each_anagram('asdfuiop') do |anagram|
+ *      puts anagram
+ *    end
+ *  end
+ *
+ */
 void Init_anagrams() {
   mPerquackey = rb_define_module("Perquackey");
   mAnagrams = rb_define_module_under(mPerquackey, "Anagrams");

data/lib/perquackey.rb

@@ -3,7 +3,7 @@ require 'rbconfig'
 require 'rbconfig/datadir'
 
 module Perquackey
-  VERSION = '0.7.2'
+  VERSION = '0.7.3'
 
   autoload :Anagrams,   'perquackey/anagrams'
   autoload :Application,'perquackey/application'

data/man/perquackey.1

@@ -77,8 +77,8 @@ 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!
+Matthew Todd, \fImatthewtodd\fR on GitHub. 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

@@ -66,8 +66,8 @@ 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!
+Matthew Todd, [matthewtodd](http://github.com/matthewtodd) on GitHub. Do drop
+me a line if you use `perquackey` -- I'd love to hear from you!
 
 ## SEE ALSO
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 7
-  - 2
-  version: 0.7.2
+  - 3
+  version: 0.7.3
 platform: ruby
 authors: 
 - Matthew Todd
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-21 00:00:00 +03:00
+date: 2010-04-29 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -75,30 +75,26 @@ extra_rdoc_files:
 - CHANGELOG.rdoc
 - README.rdoc
 - TODO.rdoc
+- ext/perquackey/anagrams.c
 files: 
-- .gitignore
 - CHANGELOG.rdoc
-- Gemfile
-- Gemfile.lock
 - README.rdoc
-- Rakefile
 - TODO.rdoc
 - bin/perquackey
 - data/perquackey/dict/TWL06.txt
 - data/perquackey/templates/index.erb
 - data/perquackey/templates/layout.erb
-- ext/perquackey/anagrams.c
 - ext/perquackey/extconf.rb
-- lib/perquackey.rb
+- ext/perquackey/anagrams.c
 - lib/perquackey/application.rb
 - lib/perquackey/console.rb
 - lib/perquackey/dictionary.rb
 - lib/perquackey/game.rb
 - lib/perquackey/server.rb
 - lib/perquackey/word_table.rb
+- lib/perquackey.rb
 - man/perquackey.1
 - man/perquackey.1.ronn
-- perquackey.gemspec
 - test/dictionary_test.rb
 - test/helper.rb
 - test/word_table_test.rb
@@ -111,7 +107,7 @@ rdoc_options:
 - --main
 - README.rdoc
 - --title
-- perquackey-0.7.2
+- perquackey-0.7.3
 - --inline-source
 require_paths: 
 - lib

data/.gitignore

@@ -1,6 +0,0 @@
-.rvmrc
-Makefile
-*.bundle
-*.gem
-*.o
-rdoc

data/Gemfile

@@ -1,9 +0,0 @@
-source :rubygems
-
-gem 'sinatra'
-
-group :development do
-  gem 'redgreen'
-  gem 'ronn'
-  gem 'shoe'
-end

data/Gemfile.lock

@@ -1,43 +0,0 @@
---- 
-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/Rakefile

@@ -1,3 +0,0 @@
-require 'shoe'
-
-Shoe::Tasks.define('perquackey.gemspec')

data/perquackey.gemspec

@@ -1,35 +0,0 @@
-$:.unshift File.expand_path('../lib', __FILE__)
-require 'perquackey'
-
-Gem::Specification.new do |spec|
-  spec.name    = 'perquackey'
-  spec.version = Perquackey::VERSION
-
-  spec.summary = 'Provides console session and simple webapp for looking up Perquackey word matches'
-  spec.description = spec.summary
-  spec.author = 'Matthew Todd'
-  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)
-    `git ls-files -z --cached --other --exclude-standard #{glob}`.split("\0")
-  end
-
-  spec.files       = spec.git_files
-  spec.executables = spec.git_files('bin/*').map &File.method(:basename)
-  spec.extensions  = spec.git_files('ext/**/extconf.rb')
-  spec.test_files  = spec.git_files('test/{,**/}*_test.rb')
-
-  spec.extra_rdoc_files = spec.git_files('{,**/}*.rdoc')
-  spec.rdoc_options     = %W(
-    --main README.rdoc
-    --title #{spec.full_name}
-    --inline-source
-  )
-end