guessmethod 0.0.4 → 0.0.5

data/History.txt

@@ -1,8 +1,5 @@
-== 0.0.4 2007-07-18
+== 0.0.5 2007-07-18
 
-* a few minor bits:
-  * renamed GuessMethodClassMethods to the more correct GuessConstant
-  * changed the gem description in the Rakefile
-  * moved const_missing aliasing to GuessConstant
-  * tweaked the readme
-  * auto included GuessMethod into Object
+* a little thing
+  * capped the longest object.inspect that will show
+  * added an option :active to GuessMethod::Options, so you can turn it off if need be

data/README.txt

@@ -14,10 +14,12 @@ If you accidentally try to access <tt>File::RDWr</tt>, you'll get <tt>File::RDWR
 
 == Options
 
-<tt>GuessMethod::Options</tt> is a hash with configuration values.  The keys :insert_weight,
-:delete_weight, and :substitution_weight change the behavior of the levenshtein calculation.
-:threshold determines how close a method or constant name needs to be to be counted as a 'match'.
-Values over 2 can give you unpredictable results, especially for short names. 
+<tt>GuessMethod::Options</tt> is a hash with configuration values.
+
+* <code>GuessMethod::Options[:insert_weight]</code>, <code>GuessMethod::Options[:delete_weight]</code>, and <code>GuessMethod::Options[:substitution_weight]</code> change how the levenshtein distance is calculated between method and constant names.  The default values are all 1.
+* <code>GuessMethod::Options[:threshold]</code> determines what levenshtein distance a method or constant must be within to count as a possible match.  Values over 2 can give you unpredictable results, especially for short names.  The default value is 2.
+* <code>GuessMethod::Options[:max_inspect_length]</code> is, for now, the longest an object's inspect value can be before it's not displayed in messages, and is replaced with simply the standard #<Object:0x91842923>. The default value is 25.
+* <code>GuessMethod::Options[:active]</code> determines whether or not GuessMethod does its thing.  If set to false (or nil) it'll step aside.  Useful for when it gets in the way of something going off correctly (which happens sometimes).
 
 = Warning
 

data/lib/guessmethod.rb

@@ -14,7 +14,9 @@ module GuessMethod
     :insert_weight => 1,
     :delete_weight => 1,
     :substitution_weight => 1,
-    :threshold => 2
+    :threshold => 2,
+    :max_inspect_length => 25,
+    :active => true
   }
   
   def self.included(base)
@@ -30,17 +32,21 @@ module GuessMethod
   end
   
   def guess_method_missing(meth, *args, &block)
-    possible_methods = Guesser.find_closest(self.methods, meth)
-    case possible_methods.size
-    when 1
-      call_method = possible_methods.first
-      $stderr.puts Outputter.replacing_method(meth, call_method, self)
-      self.send(call_method, *args, &block)
-    when 0
-      $stderr.puts Outputter.no_method_in_threshold(meth, self)
-      old_method_missing(meth, *args, &block)
+    if Options[:active]
+      possible_methods = Guesser.find_closest(self.methods, meth)
+      case possible_methods.size
+      when 1
+        call_method = possible_methods.first
+        $stderr.puts Outputter.replacing_method(meth, call_method, self)
+        self.send(call_method, *args, &block)
+      when 0
+        $stderr.puts Outputter.no_method_in_threshold(meth, self)
+        old_method_missing(meth, *args, &block)
+      else
+        $stderr.puts Outputter.ambiguous_method(meth, possible_methods, self)
+        old_method_missing(meth, *args, &block)
+      end
     else
-      $stderr.puts Outputter.ambiguous_method(meth, possible_methods, self)
       old_method_missing(meth, *args, &block)
     end
   end
@@ -69,9 +75,14 @@ module GuessMethod
     Formatter = HighLine.new
     
     def self.object(obj)  #:nodoc:
-      message = Formatter.color(obj.inspect, :green, :bold)
-      message << ':'
-      message << Formatter.color(obj.class, :green)
+      inspected = obj.inspect
+      if obj.inspect.length > Options[:max_inspect_length]
+        Formatter.color("#<#{obj.class}:0x#{(obj.object_id*2).to_s(16)}>", :green)
+      else
+        message = Formatter.color(obj.inspect, :green, :bold)
+        message << ':'
+        message << Formatter.color(obj.class, :green)
+      end
     end
     
     def self.ambiguous_method(meth, possibilities, obj) #:nodoc:

data/lib/guessmethod/version.rb

@@ -2,7 +2,7 @@ module GuessMethod #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 0
-    TINY  = 4
+    TINY  = 5
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/website/index.html

@@ -33,7 +33,7 @@
     <h1>Guess Method</h1>
     <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/guessmethod"; return false'>
       <p>Get Version</p>
-      <a href="http://rubyforge.org/projects/guessmethod" class="numbers">0.0.4</a>
+      <a href="http://rubyforge.org/projects/guessmethod" class="numbers">0.0.5</a>
     </div>
     <h1>&#x2192; &#8216;guessmethod&#8217;</h1>
 
@@ -65,27 +65,34 @@ const_missing handle the problem.</p>
 	<h2>Demonstration of usage</h2>
 
 
-<pre>mvb:~ cms$ irb
-001:0&gt; require 'guessmethod'
+<pre>001:0&gt; require 'rubygems'
 true
-002:0&gt; Stirng.tos
+002:0&gt; require 'guessmethod'
+true
+003:0&gt; Stirng.tos
 attention: replacing non-existant constant Stirng with String for Object
 attention: sending to_s instead of tos to String:Class
 "String" 
-003:0&gt; ['1','2','3'].mp {|x| x.to_}
+004:0&gt; ['1','2','3'].mp {|x| x.tof}
 attention: sending map instead of mp to ["1", "2", "3"]:Array
-ambigious method: to_ possible matches to_a, to_i, to_s, to_f for "1":String
-NoMethodError: undefined method `to_' for "1":String
-        from /usr/local/lib/ruby/gems/1.8/gems/guessmethod-0.0.3/lib/guessmethod.rb:23:in `old_method_missing'
-        from /usr/local/lib/ruby/gems/1.8/gems/guessmethod-0.0.3/lib/guessmethod.rb:50:in `method_missing'
-        from (irb):3
-        from /usr/local/lib/ruby/gems/1.8/gems/guessmethod-0.0.3/lib/guessmethod.rb:44:in `map'
-        from /usr/local/lib/ruby/gems/1.8/gems/guessmethod-0.0.3/lib/guessmethod.rb:44:in `send'
-        from /usr/local/lib/ruby/gems/1.8/gems/guessmethod-0.0.3/lib/guessmethod.rb:44:in `method_missing'
-        from (irb):3
-004:0&gt; eixt
+attention: sending to_f instead of tof to "1":String
+attention: sending to_f instead of tof to "2":String
+attention: sending to_f instead of tof to "3":String
+[1.0, 2.0, 3.0]
+005:0&gt; eixt
 attention: sending exit instead of eixt to main:Object
-mvb:~ cms$</pre>
+</pre>
+
+	<p>There are a number of options available which affect how GuessMethod works.</p>
+
+
+	<ul>
+	<li><code>GuessMethod::Options[:insert_weight]</code>, <code>GuessMethod::Options[:delete_weight]</code>, <code>GuessMethod::Options[:substitution_weight]</code> change how the levenshtein distance is calculated between method and constant names.  The default values are all 1.</li>
+		<li><code>GuessMethod::Options[:threshold]</code> determines what levenshtein distance a method or constant must be within to count as a possible match.  Values over 2 can give you unpredictable results, especially for short names.  The default value is 2.</li>
+		<li><code>GuessMethod::Options[:max_inspect_length]</code> is, for now, the longest an object&#8217;s inspect value can be before it&#8217;s not displayed in messages, and is replaced with simply the standard #<Object:0x91842923>. The default value is 25.</li>
+		<li><code>GuessMethod::Options[:active]</code> determines whether or not GuessMethod does its thing.  If set to false (or nil) it&#8217;ll step aside.  Useful for when it gets in the way of something going off correctly (which happens sometimes).</li>
+	</ul>
+
 
 	<h2>How to submit patches</h2>
 
@@ -110,7 +117,7 @@ mvb:~ cms$</pre>
 
 	<p>Comments are welcome. Send an email to chris @@ tie-rack .. org.</p>
     <p class="coda">
-      website generated via <a href="mailto:drnicwilliams@gmail.com">Dr Nic</a>'s <a href="http://newgem.rubyforge.org/">newgem</a>, on 23rd July 2007<br>
+      website generated via <a href="mailto:drnicwilliams@gmail.com">Dr Nic</a>'s <a href="http://newgem.rubyforge.org/">newgem</a>, on 26th July 2007<br>
       Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
     </p>
 </div>

data/website/index.txt

@@ -23,27 +23,30 @@ h2. Installing
 
 h2. Demonstration of usage
 
-<pre>mvb:~ cms$ irb
-001:0> require 'guessmethod'
+<pre>001:0> require 'rubygems'
 true
-002:0> Stirng.tos
+002:0> require 'guessmethod'
+true
+003:0> Stirng.tos
 attention: replacing non-existant constant Stirng with String for Object
 attention: sending to_s instead of tos to String:Class
 "String"
-003:0> ['1','2','3'].mp {|x| x.to_}
+004:0> ['1','2','3'].mp {|x| x.tof}
 attention: sending map instead of mp to ["1", "2", "3"]:Array
-ambigious method: to_ possible matches to_a, to_i, to_s, to_f for "1":String
-NoMethodError: undefined method `to_' for "1":String
-        from /usr/local/lib/ruby/gems/1.8/gems/guessmethod-0.0.3/lib/guessmethod.rb:23:in `old_method_missing'
-        from /usr/local/lib/ruby/gems/1.8/gems/guessmethod-0.0.3/lib/guessmethod.rb:50:in `method_missing'
-        from (irb):3
-        from /usr/local/lib/ruby/gems/1.8/gems/guessmethod-0.0.3/lib/guessmethod.rb:44:in `map'
-        from /usr/local/lib/ruby/gems/1.8/gems/guessmethod-0.0.3/lib/guessmethod.rb:44:in `send'
-        from /usr/local/lib/ruby/gems/1.8/gems/guessmethod-0.0.3/lib/guessmethod.rb:44:in `method_missing'
-        from (irb):3
-004:0> eixt
+attention: sending to_f instead of tof to "1":String
+attention: sending to_f instead of tof to "2":String
+attention: sending to_f instead of tof to "3":String
+[1.0, 2.0, 3.0]
+005:0> eixt
 attention: sending exit instead of eixt to main:Object
-mvb:~ cms$</pre>
+</pre>
+
+There are a number of options available which affect how GuessMethod works.
+
+* <code>GuessMethod::Options[:insert_weight]</code>, <code>GuessMethod::Options[:delete_weight]</code>, <code>GuessMethod::Options[:substitution_weight]</code> change how the levenshtein distance is calculated between method and constant names.  The default values are all 1.
+* <code>GuessMethod::Options[:threshold]</code> determines what levenshtein distance a method or constant must be within to count as a possible match.  Values over 2 can give you unpredictable results, especially for short names.  The default value is 2.
+* <code>GuessMethod::Options[:max_inspect_length]</code> is, for now, the longest an object's inspect value can be before it's not displayed in messages, and is replaced with simply the standard #<Object:0x91842923>. The default value is 25.
+* <code>GuessMethod::Options[:active]</code> determines whether or not GuessMethod does its thing.  If set to false (or nil) it'll step aside.  Useful for when it gets in the way of something going off correctly (which happens sometimes).
 
 h2. How to submit patches
 

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: guessmethod
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
-date: 2007-07-23 00:00:00 -06:00
+  version: 0.0.5
+date: 2007-07-26 00:00:00 -06:00
 summary: an aggressive spell checker for irb
 require_paths: 
 - lib