fsck 0.0.2 → 0.0.3

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 0.0.3
+
+* better caching, better performance
+
 ### 0.0.2
 
 * fluff at end of method with punctuation bug fix

data/README.md

@@ -6,6 +6,7 @@ Fsck allows you to express your feelings while you're developing. It does this b
     gem install fsck
 
 ## Examples
+
 Fsck allows you to have a sense of closure during your everyday development life. Here's some examples:
 
 *A difficult problem causing you frustration? Tell it how you feel.*
@@ -20,7 +21,9 @@ Fsck allows you to have a sense of closure during your everyday development life
     (1..10).awesome_inject_is_awesome(&:+)
 
 ## Usage
-**Spot Usage**
+
+### Spot Usage
+
 Fsck comes as a module that you can include wherever you want.
 
     require "fsck"
@@ -36,18 +39,33 @@ Fsck comes as a module that you can include wherever you want.
     my_object = MyClass.new
     my_object.calling_my_awesome_method # => 42
 
-**Deep Usage**
+### Deep Usage
+
 Fsck also provides a way to use its functionality on every object in ruby.
 
     require "fsck/deep"
 
     42.gimme_succ # => 43
     ary = Array.new_array_please # => []
+    
+## Fsck: How does it work?
+
+Fsck achieves its functionality by greatly abusing `method_missing`. Each time a fscked method is called, every method defined on the object is examined. The method with the longest name is assumed to be the *intended* method.
+
+The examination process splits the word of each method name, building a regex that allows for any number of other words to be inserted wherever. If you aren't careful with the words you choose, you may unintentionally call another method.
+
+    # you may expect this to call #each, but it will instead call #each_value
+    my_hash.what_i_need_is_each_set_of_key_plus_value { |k,v| puts k }
 
 ## Origin
+
 Fsck is named after the use of the Unix file system utility, specifically as it is applied to [profanity](http://en.wikipedia.org/wiki/Fsck#Use_as_profanity).
 
 **NOTE:** This gem has nothing to do with the Unix file system utility
 
+## Disclaimer
+
+Your application will take a more than trivial performance hit if you use this gem. The benchmark I ran on Fixnum (bench.rb) shows that using a fscked method is roughly 20 times slower. This only tests the performance of repeated fscked method calls (which should be most common use). If you're dynamically building a fscked method call based on some variable, you can expect much worse performance. Use at your own risk.
+
 ## License
 MIT License. Copyright 2011 Chris Thorn.

data/bench.rb

@@ -0,0 +1,21 @@
+$:.unshift File.join(File.dirname(__FILE__), "lib")
+
+require "benchmark"
+require "fsck/deep"
+
+N = 1_000
+
+Benchmark.bm(10) do |r|
+  r.report("vanilla") { N.times { 42.succ } }
+  r.report("fscked") { N.times { 42.gimme_succ_please } }
+end
+
+# v0.0.3
+#                 user     system      total        real
+# vanilla     0.000000   0.000000   0.000000 (  0.000246)
+# fscked      0.010000   0.000000   0.010000 (  0.005068)
+
+# results on my machine (v0.0.2)
+#                 user     system      total        real
+# vanilla     0.000000   0.000000   0.000000 (  0.000130)
+# fscked      2.960000   0.090000   3.050000 (  3.053142)

data/lib/fsck/version.rb

@@ -1,3 +1,3 @@
 module Fsck
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/fsck.rb

@@ -1,5 +1,9 @@
 module Fsck
   def method_missing(sym, *args, &block)
+    @_fsck_method_name_cache ||= {}
+    
+    return send(@_fsck_method_name_cache[sym], *args, &block) if @_fsck_method_name_cache[sym]
+    
     fscked_method = sym.to_s
     
     if punctuation = fscked_method[/[!?=]$/]
@@ -7,23 +11,20 @@ module Fsck
     end
     
     matches = methods.select do |m|
-      fscked_method =~ /^#{__fsck_cache__(m)}#{punctuation}$/
+      fscked_method =~ /^#{__fsck_method_regex_str__(m)}#{punctuation}$/
     end
 
     if matches.empty?
       super
     else
-      send(matches.sort_by(&:length).last, *args, &block)
+      @_fsck_method_name_cache[sym] = matches.sort_by(&:length).last
+      send(@_fsck_method_name_cache[sym], *args, &block)
     end
   end
   
   private
-  def __fsck_cache__(method)
-    @_fsck_method_name_cache ||= {}
-    
-    return @_fsck_method_name_cache[method] if @_fsck_method_name_cache[method]
-    
+  def __fsck_method_regex_str__(method)
     words = method.to_s.delete("!?=").split("_").map { |w| Regexp.escape(w) }
-    @_fsck_method_name_cache[method] = "(\\w*_)?#{words.join('\w*_\w*')}(_\\w*)?"
+    "(\\w*_)?#{words.join('\w*_\w*')}(_\\w*)?"
   end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Chris Thorn
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-05 00:00:00 -09:00
+date: 2011-01-06 00:00:00 -09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,6 +47,7 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
+- bench.rb
 - fsck.gemspec
 - lib/fsck.rb
 - lib/fsck/deep.rb