mole 0.0.1

data/spec/moler_spec.rb

@@ -0,0 +1,65 @@
+require File.join(File.dirname(__FILE__), "spec_helper" )           
+
+describe Mole::Moler do     
+  TEST_LOG = "/tmp/test.log"                    
+  before( :each ) do                                          
+    ::Mole.reset_configuration!
+    @io = StringIO.new
+    ::Mole.initialize( :mode => :transient, :logger_name => "Test", :log_file => @io, :moleable => true )            
+  end
+                        
+  it "should log unchecked to the db exceptions correctly" do
+    ::Mole.switch_mode :persistent        
+    ::Mole::Moler.check_it( self, 100, :blee => "Hello", :duh => "World" )
+    except_feature = MoleFeature.find_exception_feature( ::Mole.application )
+    except_feature.should_not be_nil     
+
+    log = MoleLog.find( :all, :conditions => ['mole_feature_id = ?', except_feature.id] )     
+    log.should_not           be_nil
+    log.should               have(1).mole_log     
+    log.first.user_id.should == 100
+  end
+      
+  it "should log perf exception to the db correctly" do             
+    ::Mole.switch_mode :persistent
+    ::Mole::Moler.perf_it( self, 100, :blee => "Hello", :duh => "World" )
+    perf_feature = MoleFeature.find_performance_feature( ::Mole.application )
+    perf_feature.should_not be_nil     
+
+    log = MoleLog.find( :all, :conditions => ['mole_feature_id = ?', perf_feature.id] )     
+    log.should_not           be_nil
+    log.should               have(1).mole_log     
+    log.first.user_id.should == 100
+  end
+
+  it "should mole a feature to the db correctly" do                 
+    ::Mole.switch_mode :persistent
+    ::Mole::Moler.mole_it( "Test", "fred", 100, :blee => "Hello", :duh => "World" )
+    feature = MoleFeature.find_feature( "fred", ::Mole.application, "Test".class.name )
+    feature.should_not be_nil     
+
+    log = MoleLog.find( :all, :conditions => ['mole_feature_id = ?', feature.id] )     
+    log.should_not           be_nil
+    log.should               have(1).mole_log     
+    log.first.user_id.should == 100
+  end
+  
+  it "should log unchecked exceptions to the logger correctly" do   
+    ::Mole.switch_mode :transient
+    ::Mole::Moler.check_it( self, 100, :blee => "Hello", :duh => "World" )
+    @io.string[@io.string.index( "---" )..@io.string.size].should == "--- 100 -> blee=>Hello, duh=>World\n"
+  end
+
+  it "should log perf exception to the logger correctly" do             
+    ::Mole.switch_mode :transient
+    ::Mole::Moler.perf_it( self, 100, :blee => "Hello", :duh => "World" )                                  
+    @io.string[@io.string.index( "---" )..@io.string.size].should == "--- 100 -> blee=>Hello, duh=>World\n"    
+  end
+
+  it "should mole a feature to the logger correctly" do             
+    ::Mole.switch_mode :transient
+    ::Mole::Moler.mole_it( "Test", "Fred", 100, :blee => "Hello", :duh => "World" )                                  
+    @io.string[@io.string.index( "---" )..@io.string.size].should == "--- 100 -> blee=>Hello, duh=>World\n"    
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,59 @@
+require 'rubygems'        
+require 'active_record'  
+             
+require File.join( File.dirname(__FILE__), %w[.. lib mole] )
+
+# Init the mole with defaults             
+::Mole.initialize
+         
+# Connect to the database    
+unless ActiveRecord::Base.connected?
+  db_config = YAML.load_file( File.join( File.dirname(__FILE__), %w[.. config database.yml] ) )["test"]
+  # ::ActiveRecord::Base.logger = ::Mole.logger 
+  # ::ActiveRecord::Base.logger.level = :debug
+  ::ActiveRecord::Base.establish_connection(db_config)
+end
+
+class CallStackChecker
+  class << self
+    def called
+      @called = 1
+    end
+    
+    def reset
+      @called = 0
+    end
+    
+    def called?
+      @called == 1
+    end    
+  end
+end
+                  
+gem 'rspec'
+require 'spec'
+                     
+Spec::Runner.configure do |config|  
+  config.before(:each) do
+    # from fixtures.rb in rails
+    begin
+      ActiveRecord::Base.send :increment_open_transactions
+      ActiveRecord::Base.connection.begin_db_transaction
+    rescue
+    end
+  end
+
+  config.after(:each) do      
+    begin
+      # from fixtures.rb in rails
+      if Thread.current['open_transactions'] && Thread.current['open_transactions'] > 0
+        Thread.current['open_transactions'].downto(1) do
+          ActiveRecord::Base.connection.rollback_db_transaction if ActiveRecord::Base.connection
+        end
+        Thread.current['open_transactions'] = 0
+      end
+      ActiveRecord::Base.verify_active_connections!
+    rescue
+    end
+  end
+end                           

data/spec/utils/framework_spec.rb

@@ -0,0 +1,46 @@
+require File.join(File.dirname(__FILE__), %w[.. spec_helper] )
+require 'merb'
+require 'action_controller'
+
+describe Mole::Utils::Frameworks do     
+  before( :all ) do        
+    ::Mole.reset_configuration!
+    ::Mole.initialize( :moleable => true )
+  end
+                                 
+  it "should retrieve Merb controller actions correctly" do
+    actions = Mole::Utils::Frameworks.merb_actions( MerbController )
+    actions.sort.should == %w[blee fred]
+  end
+
+  it "should retrieve Rails controller actions correctly" do
+    actions = Mole::Utils::Frameworks.rails_actions( RailsController )
+    actions.sort.should == %w[blee fred]
+  end
+  
+  class MerbController < Merb::Controller  
+    def fred
+    end
+    
+    def blee
+    end
+    
+    private
+    
+    def duh
+    end
+  end      
+  
+  class RailsController < ActionController::Base
+    def fred
+    end
+    
+    def blee
+    end
+    
+    private
+    
+    def duh
+    end
+  end
+end

data/tasks/ann.rake

@@ -0,0 +1,76 @@
+# $Id$
+
+begin
+  require 'bones/smtp_tls'
+rescue LoadError
+  require 'net/smtp'
+end
+require 'time'
+
+namespace :ann do
+
+  file PROJ.ann_file do
+    puts "Generating #{PROJ.ann_file}"
+    File.open(PROJ.ann_file,'w') do |fd|
+      fd.puts("#{PROJ.name} version #{PROJ.version}")
+      fd.puts("    by #{Array(PROJ.authors).first}") if PROJ.authors
+      fd.puts("    #{PROJ.url}") if PROJ.url
+      fd.puts("    (the \"#{PROJ.release_name}\" release)") if PROJ.release_name
+      fd.puts
+      fd.puts("== DESCRIPTION")
+      fd.puts
+      fd.puts(PROJ.description)
+      fd.puts
+      fd.puts(PROJ.changes.sub(%r/^.*$/, '== CHANGES'))
+      fd.puts
+      PROJ.ann_paragraphs.each do |p|
+        fd.puts "== #{p.upcase}"
+        fd.puts
+        fd.puts paragraphs_of(PROJ.readme_file, p).join("\n\n")
+        fd.puts
+      end
+      fd.puts PROJ.ann_text if PROJ.ann_text
+    end
+  end
+
+  desc "Create an announcement file"
+  task :announcement => PROJ.ann_file
+
+  desc "Send an email announcement"
+  task :email => PROJ.ann_file do
+    from = PROJ.ann_email[:from] || PROJ.email
+    to   = Array(PROJ.ann_email[:to])
+
+    ### build a mail header for RFC 822
+    rfc822msg =  "From: #{from}\n"
+    rfc822msg << "To: #{to.join(',')}\n"
+    rfc822msg << "Subject: [ANN] #{PROJ.name} #{PROJ.version}"
+    rfc822msg << " (#{PROJ.release_name})" if PROJ.release_name
+    rfc822msg << "\n"
+    rfc822msg << "Date: #{Time.new.rfc822}\n"
+    rfc822msg << "Message-Id: "
+    rfc822msg << "<#{"%.8f" % Time.now.to_f}@#{PROJ.ann_email[:domain]}>\n\n"
+    rfc822msg << File.read(PROJ.ann_file)
+
+    params = [:server, :port, :domain, :acct, :passwd, :authtype].map do |key|
+      PROJ.ann_email[key]
+    end
+
+    params[3] = PROJ.email if params[3].nil?
+
+    if params[4].nil?
+      STDOUT.write "Please enter your e-mail password (#{params[3]}): "
+      params[4] = STDIN.gets.chomp
+    end
+
+    ### send email
+    Net::SMTP.start(*params) {|smtp| smtp.sendmail(rfc822msg, from, to)}
+  end
+end  # namespace :ann
+
+desc 'Alias to ann:announcement'
+task :ann => 'ann:announcement'
+
+CLOBBER << PROJ.ann_file
+
+# EOF

data/tasks/annotations.rake

@@ -0,0 +1,22 @@
+# $Id$
+
+if HAVE_BONES
+
+desc "Enumerate all annotations"
+task :notes do
+  Bones::AnnotationExtractor.enumerate(
+      PROJ, PROJ.annotation_tags.join('|'), :tag => true)
+end
+
+namespace :notes do
+  PROJ.annotation_tags.each do |tag|
+    desc "Enumerate all #{tag} annotations"
+    task tag.downcase.to_sym do
+      Bones::AnnotationExtractor.enumerate(PROJ, tag)
+    end
+  end
+end
+
+end  # if HAVE_BONES
+
+# EOF

data/tasks/doc.rake

@@ -0,0 +1,48 @@
+# $Id$
+
+require 'rake/rdoctask'
+
+namespace :doc do
+
+  desc 'Generate RDoc documentation'
+  Rake::RDocTask.new do |rd|
+    rd.main = PROJ.rdoc_main
+    rd.rdoc_dir = PROJ.rdoc_dir
+
+    incl = Regexp.new(PROJ.rdoc_include.join('|'))
+    excl = Regexp.new(PROJ.rdoc_exclude.join('|'))
+    files = PROJ.files.find_all do |fn|
+              case fn
+              when excl; false
+              when incl; true
+              else false end
+            end
+    rd.rdoc_files.push(*files)
+
+    title = "#{PROJ.name}-#{PROJ.version} Documentation"
+    title = "#{PROJ.rubyforge_name}'s " + title if PROJ.rubyforge_name != title
+
+    rd.options << "-t #{title}"
+    rd.options.concat(PROJ.rdoc_opts)
+  end
+
+  desc 'Generate ri locally for testing'
+  task :ri => :clobber_ri do
+    sh "#{RDOC} --ri -o ri ."
+  end
+
+  task :clobber_ri do
+    rm_r 'ri' rescue nil
+  end
+
+end  # namespace :doc
+
+desc 'Alias to doc:rdoc'
+task :doc => 'doc:rdoc'
+
+desc 'Remove all build products'
+task :clobber => %w(doc:clobber_rdoc doc:clobber_ri)
+
+remove_desc_for_task %w(doc:clobber_rdoc)
+
+# EOF

data/tasks/gem.rake

@@ -0,0 +1,110 @@
+# $Id$
+
+require 'rake/gempackagetask'
+
+namespace :gem do
+
+  PROJ.spec = Gem::Specification.new do |s|
+    s.name = PROJ.name
+    s.version = PROJ.version
+    s.summary = PROJ.summary
+    s.authors = Array(PROJ.authors)
+    s.email = PROJ.email
+    s.homepage = Array(PROJ.url).first
+    s.rubyforge_project = PROJ.rubyforge_name
+    s.post_install_message = PROJ.post_install_message
+
+    s.description = PROJ.description
+
+    PROJ.dependencies.each do |dep|
+      s.add_dependency(*dep)
+    end
+
+    s.files = PROJ.files
+    s.executables = PROJ.executables.map {|fn| File.basename(fn)}
+    s.extensions = PROJ.files.grep %r/extconf\.rb$/
+
+    s.bindir = 'bin'
+    dirs = Dir["{#{PROJ.libs.join(',')}}"]
+    s.require_paths = dirs unless dirs.empty?
+
+    incl = Regexp.new(PROJ.rdoc_include.join('|'))
+    excl = PROJ.rdoc_exclude.dup.concat %w[\.rb$ ^(\.\/|\/)?ext]
+    excl = Regexp.new(excl.join('|'))
+    rdoc_files = PROJ.files.find_all do |fn|
+                   case fn
+                   when excl; false
+                   when incl; true
+                   else false end
+                 end
+    s.rdoc_options = PROJ.rdoc_opts + ['--main', PROJ.rdoc_main]
+    s.extra_rdoc_files = rdoc_files
+    s.has_rdoc = true
+
+    if test ?f, PROJ.test_file
+      s.test_file = PROJ.test_file
+    else
+      s.test_files = PROJ.tests.to_a
+    end
+
+    # Do any extra stuff the user wants
+#   spec_extras.each do |msg, val|
+#     case val
+#     when Proc
+#       val.call(s.send(msg))
+#     else
+#       s.send "#{msg}=", val
+#     end
+#   end
+  end
+
+  desc 'Show information about the gem'
+  task :debug do
+    puts PROJ.spec.to_ruby
+  end
+
+  pkg = Rake::PackageTask.new(PROJ.name, PROJ.version) do |pkg|
+    pkg.need_tar = PROJ.need_tar
+    pkg.need_zip = PROJ.need_zip
+    pkg.package_files += PROJ.spec.files
+  end
+  Rake::Task['gem:package'].instance_variable_set(:@full_comment, nil)
+
+  gem_file = if PROJ.spec.platform == Gem::Platform::RUBY
+      "#{pkg.package_name}.gem"
+    else
+      "#{pkg.package_name}-#{PROJ.spec.platform}.gem"
+    end
+
+  desc "Build the gem file #{gem_file}"
+  task :package => "#{pkg.package_dir}/#{gem_file}"
+
+  file "#{pkg.package_dir}/#{gem_file}" => [pkg.package_dir] + PROJ.spec.files do
+    when_writing("Creating GEM") {
+      Gem::Builder.new(PROJ.spec).build
+      verbose(true) {
+        mv gem_file, "#{pkg.package_dir}/#{gem_file}"
+      }
+    }
+  end
+
+  desc 'Install the gem'
+  task :install => [:clobber, :package] do
+    sh "#{SUDO} #{GEM} install pkg/#{PROJ.spec.full_name}"
+  end
+
+  desc 'Uninstall the gem'
+  task :uninstall do
+    sh "#{SUDO} #{GEM} uninstall -v '#{PROJ.version}' -x #{PROJ.name}"
+  end
+
+end  # namespace :gem
+
+desc 'Alias to gem:package'
+task :gem => 'gem:package'
+
+task :clobber => 'gem:clobber_package'
+
+remove_desc_for_task %w(gem:clobber_package)
+
+# EOF

data/tasks/manifest.rake

@@ -0,0 +1,49 @@
+# $Id$
+
+require 'find'
+
+namespace :manifest do
+
+  desc 'Verify the manifest'
+  task :check do
+    fn = PROJ.manifest_file + '.tmp'
+    files = manifest_files
+
+    File.open(fn, 'w') {|fp| fp.puts files}
+    lines = %x(#{DIFF} -du #{PROJ.manifest_file} #{fn}).split("\n")
+    if HAVE_FACETS_ANSICODE and ENV.has_key?('TERM')
+      lines.map! do |line|
+        case line
+        when %r/^(-{3}|\+{3})/; nil
+        when %r/^@/; Console::ANSICode.blue line
+        when %r/^\+/; Console::ANSICode.green line
+        when %r/^\-/; Console::ANSICode.red line
+        else line end
+      end
+    end
+    puts lines.compact
+    rm fn rescue nil
+  end
+
+  desc 'Create a new manifest'
+  task :create do
+    files = manifest_files
+    unless test(?f, PROJ.manifest_file)
+      files << PROJ.manifest_file
+      files.sort!
+    end
+    File.open(PROJ.manifest_file, 'w') {|fp| fp.puts files}
+  end
+
+  task :assert do
+    files = manifest_files
+    manifest = File.read(PROJ.manifest_file).split($/)
+    raise "ERROR: #{PROJ.manifest_file} is out of date" unless files == manifest
+  end
+
+end  # namespace :manifest
+
+desc 'Alias to manifest:check'
+task :manifest => 'manifest:check'
+
+# EOF

data/tasks/mole.rake

@@ -0,0 +1,115 @@
+# -----------------------------------------------------------------------------
+# MOLE Related rake tasks
+# Mole db setup upon installation
+# -----------------------------------------------------------------------------
+require 'ftools'
+
+namespace :mole do        
+  namespace :db do      
+    task :environment do     
+      require 'rubygems'
+
+      gem "activerecord", "=2.0.2"
+      require 'active_record'  
+
+      environment = ENV['MOLE_ENV'] || "test"
+      db_config = YAML.load_file( File.join( File.dirname(__FILE__), "..", "config", "test_database.yml") )[environment]
+      ::ActiveRecord::Base.establish_connection(db_config)
+    end                                                   
+                                                     
+    # ---------------------------------------------------------------------
+    # Create mole persistence tables and pre-populate
+    desc 'Create the database tables needed for the mole plugin.'
+    task :migrate_up => :environment do
+      # Create the mole_features table if it doesn't exist
+      unless ActiveRecord::Schema.tables.include?('mole_features')
+        ActiveRecord::Schema.create_table('mole_features') do |t|
+          t.column :name,             :string     
+          t.column :context,          :string
+          t.column :app_name,         :string
+          t.column :created_at,       :datetime
+          t.column :updated_at,       :datetime
+        end
+        ActiveRecord::Schema.add_index( 'mole_features', 'name' )
+        
+        # Create some default features
+        # MoleFeature.create :id => 0, :name => MoleFeature::ALL
+        # MoleFeature.create :id => 1, :name => MoleFeature::EXCEPTION
+        # MoleFeature.create :id => 2, :name => MoleFeature::PERFORMANCE
+      end
+
+      # Create the mole_logs table if it doesn't exist
+      unless ActiveRecord::Schema.tables.include?('mole_logs')
+        ActiveRecord::Schema.create_table('mole_logs') do |t|
+          t.column :mole_feature_id,  :integer
+          t.column :user_id,          :integer
+          t.column :params,           :string     
+          t.column :ip_address,       :string
+          t.column :browser_type,     :string  
+          t.column :host_name,        :string
+          t.column :created_at,       :datetime
+          t.column :updated_at,       :datetime
+        end     
+        ActiveRecord::Schema.add_index( 'mole_logs', ['mole_feature_id','user_id'] )
+        ActiveRecord::Schema.add_index( 'mole_logs', ['mole_feature_id','created_at'] )
+      end
+    end
+                                                     
+    # -------------------------------------------------------------------------
+    # Destroys mole persistence tables
+    desc 'Drop the database tables needed for the mole plugin.'
+    task :migrate_down => :environment do
+      # Delete the mole_feature table
+      if ActiveRecord::Schema.tables.include?('mole_features')
+        ActiveRecord::Schema.drop_table('mole_features')
+      end
+      
+      # Delete the mole_logs table
+      if ActiveRecord::Schema.tables.include?('mole_logs')
+        ActiveRecord::Schema.remove_index('mole_logs', ['mole_feature_id','user_id'] )        
+        ActiveRecord::Schema.drop_table('mole_logs')
+      end
+    end
+  end
+                                      
+  # ---------------------------------------------------------------------------
+  # Installs the mole plugin
+  desc 'The task that is run when you first install the plugin.'
+  task :install => :setup do
+    # Copy over the sample mole.conf file to the default location
+    destination = @plugin_base + '/../../../config'
+    File.makedirs(destination) unless File.exists?(destination)                   
+    unless File.exists?(destination + '/mole.conf')
+     File.copy(@plugin_base + '/lib/mole.conf.sample', destination + '/mole.conf') 
+    end
+
+    # Migrate the database
+    Rake::Task["mole:migrate:up"].invoke
+  end
+                           
+  # ---------------------------------------------------------------------------
+  # Removes the mole plugin and cleanup artifacts
+  desc 'The task that is run when you want to remove the plugin.'
+  task :remove => :setup do
+    # Remove the database tables
+    Rake::Task["mole:migrate:down"].invoke
+
+    # Delete the default mole.conf file
+    File.delete( "#{RAILS_ROOT}/config/mole.conf" )
+  end
+       
+  # ---------------------------------------------------------------------------  
+  desc 'Setup plugin base dir'     
+  task :setup do
+    @plugin_base = File.dirname(__FILE__) + '/..'
+  end                               
+                                                                               
+  # ---------------------------------------------------------------------------
+  # Upgrade task from MOLE version 0.002
+  # This task will setup the extra mole features columns and reset the indexes
+  # on the mole_features table. 
+  desc 'Ugrade the mole schema from version 0.002'
+  task :upgrade do
+    Rake::Task["mole:migrate:upgrade"].invoke
+  end  
+end

data/tasks/post_load.rake

@@ -0,0 +1,26 @@
+# $Id$
+
+# This file does not define any rake tasks. It is used to load some project
+# settings if they are not defined by the user.
+
+PROJ.rdoc_exclude << "^#{Regexp.escape(PROJ.manifest_file)}$"
+PROJ.exclude << "^#{Regexp.escape(PROJ.ann_file)}$"
+
+PROJ.changes ||= paragraphs_of(PROJ.history_file, 0..1).join("\n\n")
+
+PROJ.description ||= paragraphs_of(PROJ.readme_file, 'description').join("\n\n")
+
+PROJ.summary ||= PROJ.description.split('.').first
+
+PROJ.files ||=
+  if test(?f, PROJ.manifest_file)
+    files = File.readlines(PROJ.manifest_file).map {|fn| fn.chomp.strip}
+    files.delete ''
+    files
+  else [] end
+
+PROJ.executables ||= PROJ.files.find_all {|fn| fn =~ %r/^bin/}
+
+PROJ.rdoc_main ||= PROJ.readme_file
+
+# EOF

data/tasks/rubyforge.rake

@@ -0,0 +1,57 @@
+# $Id$
+
+if PROJ.rubyforge_name && HAVE_RUBYFORGE
+
+require 'rubyforge'
+require 'rake/contrib/sshpublisher'
+
+namespace :gem do
+  desc 'Package and upload to RubyForge'
+  task :release => [:clobber, :package] do |t|
+    v = ENV['VERSION'] or abort 'Must supply VERSION=x.y.z'
+    abort "Versions don't match #{v} vs #{PROJ.version}" if v != PROJ.version
+    pkg = "pkg/#{PROJ.spec.full_name}"
+
+    if $DEBUG then
+      puts "release_id = rf.add_release #{PROJ.rubyforge_name.inspect}, #{PROJ.name.inspect}, #{PROJ.version.inspect}, \"#{pkg}.tgz\""
+      puts "rf.add_file #{PROJ.rubyforge_name.inspect}, #{PROJ.name.inspect}, release_id, \"#{pkg}.gem\""
+    end
+
+    rf = RubyForge.new
+    puts 'Logging in'
+    rf.login
+
+    c = rf.userconfig
+    c['release_notes'] = PROJ.description if PROJ.description
+    c['release_changes'] = PROJ.changes if PROJ.changes
+    c['preformatted'] = true
+
+    files = [(PROJ.need_tar ? "#{pkg}.tgz" : nil),
+             (PROJ.need_zip ? "#{pkg}.zip" : nil),
+             "#{pkg}.gem"].compact
+
+    puts "Releasing #{PROJ.name} v. #{PROJ.version}"
+    rf.add_release PROJ.rubyforge_name, PROJ.name, PROJ.version, *files
+  end
+end  # namespace :gem
+
+
+namespace :doc do
+  desc "Publish RDoc to RubyForge"
+  task :release => %w(doc:clobber_rdoc doc:rdoc) do
+    config = YAML.load(
+        File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+    )
+
+    host = "#{config['username']}@rubyforge.org"
+    remote_dir = "/var/www/gforge-projects/#{PROJ.rubyforge_name}/"
+    remote_dir << PROJ.rdoc_remote_dir if PROJ.rdoc_remote_dir
+    local_dir = PROJ.rdoc_dir
+
+    Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+  end
+end  # namespace :doc
+
+end  # if HAVE_RUBYFORGE
+
+# EOF