matches 1.0.2 → 1.0.3

data/README.md

@@ -5,6 +5,15 @@ Matches is an easy DSL for defining regular-expression-based methods in Ruby.
 
 Start playing with matches:
 
+    # If needed
+    sudo gem install gemcutter
+    gem tumble
+    
+    sudo gem install matches
+
+Then, in a Ruby file somewhere:
+
+    require 'rubygems'
     require 'matches'
     
     class Hippo
@@ -12,11 +21,11 @@ Start playing with matches:
         @verbs = []
       end
       
-      matches /(\w+)\!/ do |verb|
+      matches /^(\w+)\!$/ do |verb|
         @verbs << verb
       end
       
-      matches /(\w+)ed\?/ do |verb|
+      matches /^(\w+)ed\?$/ do |verb|
         @verbs.include?(verb)
       end
     end
@@ -28,3 +37,4 @@ Start playing with matches:
     herman.touched?
     ==> true
 
+[Read the guide](http://wiki.github.com/pnc/matches) to learn more.

data/README.rdoc

@@ -2,15 +2,48 @@
 
 Matches is an easy DSL for defining regular-expression-based methods in Ruby.
 
+Start playing with matches:
+
+    # If needed
+    sudo gem install gemcutter
+    gem tumble
+    
+    sudo gem install matches
+
+Then, in a Ruby file somewhere:
+
+    require 'rubygems'
+    require 'matches'
+    
+    class Hippo
+      def initialize
+        @verbs = []
+      end
+      
+      matches /^(\w+)\!$/ do |verb|
+        @verbs << verb
+      end
+      
+      matches /^(\w+)ed\?$/ do |verb|
+        @verbs.include?(verb)
+      end
+    end
+
+    herman = Hippo.new
+    herman.fatten!
+    herman.touch!
+    
+    herman.touched?
+    ==> true
+
+Read the guide at http://wiki.github.com/pnc/matches to learn more.
+
 == Note on Patches/Pull Requests
  
 * Fork the project.
+* Write some specs and maybe a feature.
 * Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but
-   bump version in a commit by itself I can ignore when I pull)
+* Commit!
 * Send me a pull request. Bonus points for topic branches.
 
 == Copyright

data/Rakefile

@@ -10,7 +10,7 @@ begin
                          expressions rather than names, and automatically
                          configires method_missing to handle them.}
     gem.email = "pncalvin@gmail.com"
-    gem.homepage = "http://github.com/pnc/matches"
+    gem.homepage = "http://wiki.github.com/pnc/matches"
     gem.authors = ["Phil Calvin"]
     gem.add_development_dependency "rspec", ">= 1.2.9"
     gem.add_development_dependency "cucumber", ">= 0"
@@ -40,7 +40,7 @@ Rake::RDocTask.new do |rdoc|
 
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "matches #{version}"
-  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('README.rdoc')
   rdoc.rdoc_files.include('lib/*.rb')
 end
 

data/VERSION

@@ -1 +1 @@
-1.0.2
+1.0.3

data/lib/match_method.rb

@@ -1,22 +1,30 @@
+# A MatchMethod a method that has a regular expression rather than a name.
+# It simply stores a proc and the regular expression. To use:
+# 
+#     mm = new MatchMethod(:matcher => /foo(w+)/, :proc => Proc.new {puts inspect})
+#     fancy_object = Object.new
+#     mm.match(fancy_object, :foobar)
+#     => <Object:0x1018746f8> 
+#
 class MatchMethod
   attr_accessor :matcher, :proc
   
   # Allows properties to be specified in the constructor.
   # E.g.,
-  #   MetaMethod.new(:matcher => /foo/)
+  #   MatchMethod.new(:matcher => /foo/)
   def initialize(args)
     args.each do |key, value|
       send("#{key}=", value)
     end
   end
   
-  # Returns whether this MetaMethod is capable of matching the given
+  # Returns whether this MatchMethod is capable of matching the given
   # message.
   def matches?(message)
     !!(message.to_s =~ matcher)
   end
   
-  # Calls the method's proc if the message matches.
+  # Calls the method's +proc+ on the given +instance+.
   def match(instance, message, *args)
     groups = message.to_s.match(matcher)[1..-1]
     

data/lib/matches.rb

@@ -1,6 +1,9 @@
 require File.dirname(__FILE__) + "/match_method"
 
+# Defines all the necessary components to allow defining dynamic methods.
 module MatchDef
+  # Defines a new class method that allows you to define dynamic methods.
+  # Takes a regular expression and a block, which are stored and called later.
   def matches(regexp, &block)
     @@match_methods ||= []
     
@@ -8,6 +11,8 @@ module MatchDef
                                         :proc => block )
     self.class_eval {
       unless respond_to?(:match_method_missing)
+        # Defines a +method_missing+ that is aware of the
+        # dynamically-defined methods and will call them if appropriate.
         def match_method_missing(message, *args)
           # Attempt to evaluate this using a MetaMethod
           result = @@match_methods.find do |mm|
@@ -25,9 +30,12 @@ module MatchDef
     }
   end
   
+  # Allows you to delete all defined dynamic methods on a class.
+  # This permits testing.
   def reset_meta_methods
     @@match_methods = []
   end
 end
 
+# Squirt these into Class so they're available in new classes.
 Class.class_eval { include MatchDef }

data/matches.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{matches}
-  s.version = "1.0.2"
+  s.version = "1.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Phil Calvin"]
@@ -38,7 +38,7 @@ Gem::Specification.new do |s|
      "spec/spec.opts",
      "spec/spec_helper.rb"
   ]
-  s.homepage = %q{http://github.com/pnc/matches}
+  s.homepage = %q{http://wiki.github.com/pnc/matches}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.5}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: matches
 version: !ruby/object:Gem::Version 
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors: 
 - Phil Calvin
@@ -64,7 +64,7 @@ files:
 - spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: true
-homepage: http://github.com/pnc/matches
+homepage: http://wiki.github.com/pnc/matches
 licenses: []
 
 post_install_message: