mole 1.0.2 → 1.0.3

data/History.txt

@@ -1,4 +1,17 @@
-== 1.0.0 / 2008-02-13
+== 1.0.0 / 2008-02-04
 
-* 1 major enhancement
-  * Birthday!
+* 1 Initial drop
+  * Converted from rails plugin into gem
+  * Retrofited to work with pure ruby, merb and rails env
+
+== 1.0.1 / 2008-02-04
+
+* 1 Documentation enhancements
+  
+== 1.0.2 / 2008-02-04
+
+* 1 Added Snitch support
+
+== 1.0.3 / 2008-02-05
+
+* 1 Bug Fixes

data/Manifest.txt

@@ -2,7 +2,6 @@ History.txt
 Manifest.txt
 README.txt
 Rakefile
-bin/mole
 bin/molify
 config/database.yml
 config/test_database.yml

data/README.txt

@@ -97,7 +97,7 @@ The MOle allows you to easily
   any media you'll find suitable. In a rails/merb context, you'll be able to extract session/params information
   as in this case.
     
-      Posts.mole_after( :feature => :show ) { |context, feature, ret, args, block|
+      Posts.mole_after( :feature => :show ) { |context, feature, ret, block, *args|
         # Records the interaction to the database
         Mole::Moler.mole_it( context, feature, 
           context.session[:user_id],                           # Retrieves which user performed this action
@@ -115,7 +115,7 @@ The MOle allows you to easily
   the feature that causes the performance threshold to be triggered. Setting the :email option
   to true will also send out an email alert.           
      
-      Posts.mole_perf( :features => merb_actions ) do |context, feature, elapsed_time, args, block|
+      Posts.mole_perf( :features => merb_actions ) do |context, feature, elapsed_time, ret, block, *args|
         user    = context.instance_variable_get( "@user" )
         key     = context.params[:key], "N/A"                                                                     
         request = context.request.nil? ? "N/A" : context.request.remote_ip,
@@ -132,7 +132,7 @@ The MOle allows you to easily
   The unchecked exception trap works very similarly to the mole_perf trap. It will pass in
   the context of the method that triggered the exception.
     
-        Posts.mole_unchecked( :features => merb_actions ) do |context, action, boom, args, block|
+        Posts.mole_unchecked( :features => merb_actions ) do |context, action, boom, block, *args|
           sub     = context.instance_variable_get("@sub")
           user_id = "N/A"  
           user_id = sub.user.id if sub and sub.user    

data/Rakefile

@@ -27,7 +27,6 @@ PROJ.executables    = ['molify']
 
 PROJ.exclude        << %w[.DS_Store$ .swo$ .swp$]
 PROJ.tests          = FileList['test/**/test_*.rb']   
-PROJ.dependencies   = [ ["logging"] ]
 PROJ.annotation_tags << 'BOZO'
 
 desc "Clean up artifact directories"
@@ -43,5 +42,5 @@ end
 task 'gem:package' => 'manifest:assert'
 
                 
-depend_on "logging"     , "= 0.7.0"       
+depend_on "logging"     , "= 0.7.1"       
 depend_on "activerecord", "= 2.0.2"

data/lib/mole/logger.rb

@@ -40,10 +40,10 @@ module Mole
         #               email.  If that is not reached before the program
         #               exists then the at_exit handler for logging will flush
         #               the log to smtp.
-        :email_alerts_to      => nil                                    ,
-        :email_alert_level    => :error                                 ,
-        :email_alert_server   => "mail.collectiveintellect.com".freeze  ,
-        :email_alert_buffsize => 200                                    ,
+        :email_alerts_to      => nil    ,
+        :email_alert_level    => :error ,
+        :email_alert_server   => nil    ,
+        :email_alert_buffsize => 200    ,
       }
     end
 
@@ -122,10 +122,13 @@ module Mole
     def log_it( context, feature, user_id, args )
       args    ||= "no args"                           
       user_id ||= "N/A"             
-      ip_addr, browser_type = MoleLog.log_details( context )  
+      ip_addr, browser_type = MoleLog.log_details( context )
       info = []
-      args.keys.sort { |a,b| a.to_s <=> b.to_s }.each { |k| info << "#{k}=>#{args[k]}" }                                                  
-      self.info( "[#{ip_addr}/#{browser_type}]-- #{context}(#{feature}) --- #{user_id} -> #{info.join( ', ' ) }" )
+      args.keys.sort { |a,b| a.to_s <=> b.to_s }.each { |k| info << "#{k}=>#{args[k]}" }
+      buff = ""
+      buff << "[#{ip_addr}/#{browser_type}]--" if ip_addr and browser_type
+      buff << "#{context.class.name}(#{feature}) --- #{user_id} -> #{info.join( ', ' ) }"
+      self.info(  buff )
     end
   end
 end

data/lib/mole/module.rb

@@ -10,7 +10,7 @@ class Module
   #
   # Example:   
   #
-  #   MyClass.mole_perf do |context, action, elapsed_time, args|                            
+  #   MyClass.mole_perf do |context, action, elapsed_time, ret, block, *args|                            
   #     Mole::DbMole.perf_it( context.session[:user_id], 
   #                           :controller   => context.class.name,
   #                           :action       => action,                           
@@ -27,8 +27,8 @@ class Module
   # <tt>:interceptor</tt>::   The class name of your interceptor class
   # <tt>:method</tt>::        The name of the method to callback the interceptor on
   #                           once a perf condition has been trapped.
-  def mole_perf( opts={}, &filter )    
-    opts[:interceptor] ||= filter
+  def mole_perf( opts={}, &interceptor )    
+    opts[:interceptor] ||= interceptor
     opts[:method]      ||= :call             
     opts[:features]    ||= instance_methods( false )
     opts[:features].each do |feature|  
@@ -43,7 +43,7 @@ class Module
   #
   # Example:   
   #
-  #   MyClass.mole_unchecked do |context, action, boom, args|
+  #   MyClass.mole_unchecked do |context, action, boom, block, *args|
   #     Mole::Moler.check_it( context.session[:user_id], 
   #                          :controller => context.class.name,  
   #                          :action     => action,
@@ -62,8 +62,8 @@ class Module
   # <tt>:interceptor</tt>::   The class name of your interceptor class
   # <tt>:method</tt>::        The name of the method to callback the interceptor on
   #                           once an exception condition has been trapped.   
-  def mole_unchecked( opts={}, &filter )    
-    opts[:interceptor] ||= filter
+  def mole_unchecked( opts={}, &interceptor )    
+    opts[:interceptor] ||= interceptor
     opts[:method]      ||= :call             
     opts[:features]    ||= instance_methods( false )
     opts[:features].each do |feature|  
@@ -78,7 +78,7 @@ class Module
   #
   # Example:   
   #
-  #   MyClass.mole_before( :feature => :blee ) do |context, feature, *args|
+  #   MyClass.mole_before( :feature => :blee ) do |context, feature, block, *args|
   #     Mole::Moler.mole_it( context, feature, context.session[:user_id], 
   #                         :args => args )
   #   end  
@@ -93,9 +93,9 @@ class Module
   # <tt>:interceptor</tt>::   The class name of your interceptor class. If no interceptor block is specified
   # <tt>:method</tt>::        The name of the method to callback the interceptor on
   #                           once an exception condition has been trapped.     
-  def mole_before(opts = {}, &filter)   
+  def mole_before(opts={}, &interceptor)   
     raise "Missing :feature option" if opts[:feature].nil? or opts[:feature].to_s.empty?
-    opts[:interceptor] ||= filter
+    opts[:interceptor] ||= interceptor
     opts[:method] ||= :call
     feature = opts[:feature].to_s
     if before_mole_filters[feature].empty?
@@ -110,7 +110,7 @@ class Module
   #
   # Example:   
   #
-  #   MyClass.mole_after( :feature => :blee ) do |context, feature, ret_val, *args|
+  #   MyClass.mole_after( :feature => :blee ) do |context, feature, ret_val, block, *args|
   #     Mole::Moler.mole_it( context, feature, context.session[:user_id], 
   #                         :args => args )
   #   end  
@@ -194,7 +194,7 @@ class Module
       between = instance_method( method )
     rescue
       # between = find_public_class_method( method )
-      raise NameError unless(between)
+      raise "Unable to find moled feature `#{method}" unless(between)
     end
     code = <<-code
       def #{method}_with_mole (*a, &b)
@@ -205,14 +205,14 @@ class Module
         klass.apply_before_filters( klass.before_mole_filters[key], self, key, *a, &b )
         begin                                          
           elapsed = Benchmark::realtime do 
-            ret_val = between.bind(self).call(*a) 
+            ret_val = between.bind(self).call( *a, &b ) 
           end   
-          klass.apply_perf_filters( elapsed, klass.perf_mole_filters[key], self, key, *a, &b )                              
+          klass.apply_perf_filters( elapsed, klass.perf_mole_filters[key], self, key, ret_val, *a, &b )                              
         rescue => boom   
           klass.apply_unchecked_filters( boom, klass.unchecked_mole_filters[key], self, key, *a, &b )
           raise boom            
         end                                                                 
-        klass.apply_after_filters( klass.after_mole_filters[key], self, key, *a, &b )
+        klass.apply_after_filters( klass.after_mole_filters[key], self, key, ret_val, *a, &b )
         ret_val
       end
     code
@@ -224,26 +224,26 @@ class Module
    
   def apply_before_filters( filters, clazz, key, *a, &b )          #:nodoc:              
     begin
-      filters.each { |r,m| r.send(m, clazz, key, *a, &b) }
+      filters.each { |r,m| r.send( m, clazz, key, b, *a ) }
     rescue => ca_boom
       ::Mole.logger.error ">>> Mole Error: Before-Filter -- " + ca_boom
       # ca_boom.backtrace.each { |l| ::Mole.logger.error l }           
     end    
   end
                        
-  def apply_after_filters( filters, clazz, key, *a, &b )           #:nodoc:              
+  def apply_after_filters( filters, clazz, key, ret_val, *a, &b )   #:nodoc:              
     begin  
-      filters.each { |r,m| r.send(m, clazz, key, *a, &b) }
+      filters.each { |r,m| r.send( m, clazz, key, ret_val, b, *a ) }
     rescue => ca_boom    
       ::Mole.logger.error ">>> Mole Error: After-Filter -- " + ca_boom
       # ca_boom.backtrace.each { |l| ::Mole.logger.error l }           
     end    
   end
                        
-  def apply_perf_filters( elapsed, filters, clazz, key, *a )       #:nodoc:
+  def apply_perf_filters( elapsed, filters, clazz, key, ret_val, *a, &b )       #:nodoc:
     begin
       if ( elapsed >= Mole.perf_threshold  )
-        filters.each { |r,m| r.send(m, clazz, key, elapsed, *a) }            
+        filters.each { |r,m| r.send( m, clazz, key, elapsed, ret_val, b, *a ) }            
       end
     rescue => ca_boom
       ::Mole.logger.error ">>> Mole Error: Perf-Filter -- " + ca_boom
@@ -253,7 +253,7 @@ class Module
                        
   def apply_unchecked_filters( boom, filters, clazz, key, *a, &b ) #:nodoc:
     begin
-      filters.each { |r,m| r.send(m, clazz, key, boom, *a, &b ) }
+      filters.each { |r,m| r.send( m, clazz, key, boom, b, *a ) }
     rescue => ca_boom                               
       ::Mole.logger.error ">>> Mole Error: Unchecked-Filter -- " + ca_boom
       # ca_boom.backtrace.each { |l| ::Mole.logger.error l }             

data/lib/mole/version.rb

@@ -2,7 +2,7 @@ module Mole
   module Version
     MAJOR = 1
     MINOR = 0
-    TINY  = 2
+    TINY  = 3
     
     # Returns the version string for the library.
     #

data/spec/data/blee.rb

@@ -14,12 +14,18 @@ class Blee
     # puts ">>> Blee_No_Args"
   end             
   
-  def blee_args( i, p )
-    # puts ">>> Blee_Args #{i} -- #{p}"
+  def blee_args( a, b, c, d )
+    # puts ">>> Blee Many Args #{[a,b,c,d].join( "--" )}"
+    20
   end
   
-  def blee_args_ret( p )
-    "Hello #{p}"
+  def blee_block( a, b, c, d, &block )
+    # puts ">>> Blee Many Block #{[a,b,c,d,block].join( "--" )}"
+    10
+  end
+  
+  def blee_args_ret( a )
+    "Hello #{a}"
   end  
            
   def blee_raise

data/spec/models/mole_log_spec.rb

@@ -45,6 +45,7 @@ describe MoleLog do
      log.browser_type.should  == "GodZilla"
   end      
     
+  # Test Controller...
   module Moled
     class Controller
       class Request

data/spec/module_spec.rb

@@ -3,7 +3,7 @@ require File.join(File.dirname(__FILE__), "spec_helper" )
 
 describe Module do     
   before( :all ) do
-    ::Mole.initialize( :perf_threshold => 1 )
+    ::Mole.initialize( :perf_threshold => 1, :log_level => :info )
     require File.join( File.dirname(__FILE__),  %w[data blee] )                          
   end
                     
@@ -48,19 +48,20 @@ describe Module do
     CallStackChecker.should_not be_called    
   end 
   
-  it "should trap mole handler exceptions" do
-    Blee.mole_before( :feature => :crap_out ) { |context, feature, *args| 
-      raise "Something did crap out"
-      CallStackChecker.called
-    }              
-    @blee.crap_out                      
-    CallStackChecker.should_not be_called
-  end
+  # it "should trap mole handler exceptions" do
+  #   Blee.mole_before( :feature => :crap_out ) { |context, feature, *args| 
+  #     raise "Something did crap out"
+  #     CallStackChecker.called
+  #   }              
+  #   @blee.crap_out                      
+  #   CallStackChecker.should_not be_called
+  # end
   
   it "should correctly setup a before call" do
-    Blee.mole_before( :feature => :blee_no_args ) { |context, feature, *args| 
+    Blee.mole_before( :feature => :blee_no_args ) { |context, feature, block, *args| 
       context.class.should == Blee
       feature.should       == "blee_no_args"
+      block.should         be_nil
       args.should          have(0).items
       CallStackChecker.called
     }              
@@ -69,7 +70,7 @@ describe Module do
   end
   
   it "should correctly setup an after call" do
-    Blee.mole_after( :feature => :blee_no_args ) { |context, feature, *args| 
+    Blee.mole_after( :feature => :blee_no_args ) { |context, feature, ret_val, block, *args| 
       context.class.should == Blee
       feature.should       == "blee_no_args"
       args.should          have(0).items      
@@ -91,40 +92,83 @@ describe Module do
   end     
   
   it "should not trap a before call" do     
-    @blee.blee_args( "Hello", "World" )
+    @blee.blee_args( "Hello", "World", "Good", "Day" )
     CallStackChecker.should_not be_called
   end  
   
   it "should correctly trap the before call arguments" do
-    Blee.mole_before( :feature => :blee_args ) { |context, feature, *args| 
+    Blee.mole_before( :feature => :blee_args ) { |context, feature, block, *args| 
       context.class.should == Blee
       feature.should       == "blee_args"      
-      args.should          have(2).items
+      args.should          have(4).items
       args[0].should       == "Hello"
       args[1].should       == "World"
+      args[2].should       == "Good"
+      args[3].should       == "Day"                  
       CallStackChecker.called
     }              
-    @blee.blee_args( "Hello", "World" )                         
+    @blee.blee_args( "Hello", "World", "Good", "Day" )                         
     CallStackChecker.should be_called    
   end    
+
+  it "should correctly trap a before call with a block" do
+    Blee.mole_before( :feature => :blee_block ) do |context, feature, block, *args|
+      context.class.should == Blee
+      feature.should       == "blee_block"      
+      block.should_not     be_nil
+      block.call.should    == "Do it already!!"
+      args.size.should     == 4
+      args[0].should       == "Hello"
+      args[1].should       == "World"
+      args[2].should       == "Good"
+      args[3].should       == "Day"            
+      CallStackChecker.called
+    end         
+    @blee.blee_block( "Hello", "World", "Good", "Day" ) { "Do it already!!" } rescue nil
+    CallStackChecker.should be_called    
+  end 
   
-  it "should correctly trap the after call arguments" do
-    Blee.mole_after( :feature => :blee_args ) { |context, feature, *args| 
+  it "should correctly trap the after call with many arguments" do
+    Blee.mole_after( :feature => :blee_args ) { |context, feature, ret_val, block, *args| 
       context.class.should == Blee
       feature.should       == "blee_args"            
-      args.size.should     == 2
+      ret_val.should       == 20
+      args.size.should     == 4
       args[0].should       == "Hello"
       args[1].should       == "World"
+      args[2].should       == "Good"
+      args[3].should       == "Day"      
       CallStackChecker.called
     }              
-    @blee.blee_args( "Hello", "World" )                         
+    @blee.blee_args( "Hello", "World", "Good", "Day" )                         
     CallStackChecker.should be_called    
   end    
+
+  it "should correctly trap the after call with a block" do
+    Blee.mole_after( :feature => :blee_block ) do |context, feature, ret_val, block, *args|
+      context.class.should == Blee
+      feature.should       == "blee_block"      
+      block.should_not     be_nil
+      block.call.should    == "Do it already!!"
+      ret_val.should       == 10
+      args.size.should     == 4
+      args[0].should       == "Hello"
+      args[1].should       == "World"
+      args[2].should       == "Good"
+      args[3].should       == "Day"            
+      CallStackChecker.called
+    end         
+    @blee.blee_block( "Hello", "World", "Good", "Day" ) { "Do it already!!" } rescue nil
+    CallStackChecker.should be_called    
+  end 
   
   it "should correctly trap a slow call" do
-    Blee.mole_perf( :features => [:blee_slow] ) do |context, feature, elapsed_time, args, block|
+    Blee.mole_perf( :features => [:blee_slow] ) do |context, feature, elapsed_time, ret_val, block, *args|
       context.class.should == Blee
       feature.should       == "blee_slow"      
+      ret_val.should       == 1
+      block.should         be_nil      
+      args.size.should     == 0      
       elapsed_time.should  > 1      
       CallStackChecker.called
     end         
@@ -133,9 +177,11 @@ describe Module do
   end 
   
   it "should trap a private method correctly" do  
-    Blee.mole_after( :feature => :blee_private ) { |context, feature, *args| 
+    Blee.mole_after( :feature => :blee_private ) { |context, feature, ret_val, block, *args| 
       context.class.should == Blee
       feature.should       == "blee_private"            
+      ret_val.should       == "Hello"
+      block.should         be_nil      
       args.size.should     == 1
       args[0].should       == "Hello"
       CallStackChecker.called
@@ -145,9 +191,11 @@ describe Module do
   end
   
   it "should trap a protected method correctly" do
-    Blee.mole_after( :feature => :blee_protected ) { |context, feature, *args| 
+    Blee.mole_after( :feature => :blee_protected ) { |context, feature, ret_val, block, *args| 
       context.class.should == Blee
       feature.should       == "blee_protected"            
+      ret_val.should       == "Hello"
+      block.should         be_nil
       args.size.should     == 1
       args[0].should       == "Hello"
       CallStackChecker.called
@@ -158,9 +206,11 @@ describe Module do
                  
   it "should mole a static method correctly" do
     pending do
-      Blee.mole_after( :feature => :blee_static ) { |context, feature, *args| 
+      Blee.mole_after( :feature => :blee_static ) { |context, feature, ret_val, block, *args| 
         context.class.should == Blee
         feature.should       == "blee_static"            
+        ret_val.should       be_nil
+        block.should         be_nil
         args.size.should     == 0
         CallStackChecker.called
       }              

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: mole
 version: !ruby/object:Gem::Version 
-  version: 1.0.2
-date: 2008-03-02 00:00:00 -07:00
+  version: 1.0.3
+date: 2008-03-06 00:00:00 -07:00
 summary: A flexible way to track user's interactions within your ruby web applications
 require_paths: 
 - lib
@@ -33,7 +33,6 @@ files:
 - Manifest.txt
 - README.txt
 - Rakefile
-- bin/mole
 - bin/molify
 - config/database.yml
 - config/test_database.yml
@@ -82,7 +81,6 @@ rdoc_options:
 extra_rdoc_files: 
 - History.txt
 - README.txt
-- bin/mole
 - bin/molify
 executables: 
 - molify
@@ -91,15 +89,6 @@ extensions: []
 requirements: []
 
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: logging
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">"
-      - !ruby/object:Gem::Version 
-        version: 0.0.0
-    version: 
 - !ruby/object:Gem::Dependency 
   name: logging
   version_requirement: 
@@ -107,7 +96,7 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        version: 0.7.0
+        version: 0.7.1
     version: 
 - !ruby/object:Gem::Dependency 
   name: activerecord

data/bin/mole

@@ -1,8 +0,0 @@
-#!/usr/bin/env ruby
-
-require File.expand_path(
-    File.join(File.dirname(__FILE__), '..', 'lib', 'mole'))
-
-# Put your code here
-
-# EOF