mole 1.0.4 → 1.0.5

data/Manifest.txt

@@ -15,6 +15,8 @@ lib/mole/module.rb
 lib/mole/moler.rb
 lib/mole/utils/frameworks.rb
 lib/mole/version.rb
+spec/config/mole_config.rb
+spec/config/moles/fred_config.rb
 spec/data/blee.rb
 spec/db/migrate_spec.rb
 spec/emole_spec.rb

data/README.txt

@@ -86,7 +86,19 @@ The MOle allows you to easily
                     :log_file         => $stdout,
                     :log_level        => :debug,
                     :perf_threshold   => 2,
-                    :mole_config      => File.join( File.dirname(__FILE__), %w[mole.rb] ) )                            
+                    :mole_config      => File.join( File.dirname(__FILE__), %w[mole.rb] ) ) 
+  # Load the MOle configuration file(s)
+  ::Mole.load_configuration                  
+                    
+  NOTE: The mole_config can either be a single ruby file or a directory containing multiple MOle
+  configuration files. Thanks to Ian Schreuder for the suggestion !
+  
+  NOTE: For rails application you can either put the MOle initialization code in a custom initializer
+  or in your environment file ie config/environments/production.rb. You will need to make the 
+  load_configuration call in your application controller as follows:
+  
+    ::Mole.load_mole_configuration rescue nil 
+                  
                            
 * Now you'll need to create a mole.rb specification file to specify the various aspects you'll want
   to inject. This file is specified in the initialize call via the :mole_config tag.

data/lib/mole/version.rb

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

data/lib/mole.rb

@@ -66,15 +66,30 @@ unless defined? Mole
     def self.initialize( opts={} ) 
       @config = defaults.merge( opts )    
       @config[:email_alerts_to] = @config[:emole_recipients] if @config[:emole_recipients] and !@config[:emole_recipients].empty?
-      # dump                       
-      # Add the mode to the ruby lib path...
+      # Add the mole/lib to the ruby path...
       $: << libpath
-      Mole.require_all_libs_relative_to __FILE__    
-                                   
-      raise "Unable to find the MOle configuration file #{conf_file}" if conf_file and !File.exists? conf_file
-      load conf_file if conf_file and moleable?
+      Mole.require_all_libs_relative_to __FILE__                                       
     end
       
+    # Loads the mole configuration file
+    # You can either specify a directory containing mole config files or 
+    # a single mole config file via the mole_config option.
+    def self.load_mole_configuration
+      return unless moleable?      
+      raise "Unable to find the MOle configuration from `#{conf_file}" if conf_file and !File.exists? conf_file      
+      unless @config_loaded
+        @config_loader = true
+        if File.directory? conf_file
+          logger.debug "--- Loading MOle configs files from directory `#{conf_file}"          
+          load_all_moles_relative_to( conf_file )
+        else
+          logger.debug "--- Loading single MOle config #{conf_file}"          
+          load conf_file
+        end
+      end
+      @config_loaded
+    end
+    
     # Fetch the MOle configuration file
     def self.conf_file #:nodoc:
       config[:mole_config]
@@ -158,17 +173,25 @@ unless defined? Mole
       args.empty? ? PATH : ::File.join(PATH, *args)
     end
 
-    # Utility method used to rquire all files ending in .rb that lie in the
+    # Utility method used to require all files ending in .rb that lie in the
     # directory below this file that has the same name as the filename passed
     # in. Optionally, a specific _directory_ name can be passed in such that
     # the _filename_ does not have to be equivalent to the directory.
     #
     def self.require_all_libs_relative_to( fname, dir = nil ) #:nodoc:
-      dir ||= ::File.basename(fname, '.*')
-      search_me = ::File.expand_path(
-          ::File.join(::File.dirname(fname), dir, '**', '*.rb'))
-
+      dir       ||= ::File.basename(fname, '.*')
+      search_me   = ::File.expand_path( ::File.join(::File.dirname(fname), dir, '**', '*.rb'))
       Dir.glob(search_me).sort.each {|rb| require rb}
     end
+
+    # Utility method used to load all MOle config files ending in .rb that lie in the
+    # directory below this file that has the same name as the filename passed
+    # in. Optionally, a specific _directory_ name can be passed in such that
+    # the _filename_ does not have to be equivalent to the directory.
+    #
+    def self.load_all_moles_relative_to( mole_dir ) #:nodoc:
+      search_me = ::File.join( mole_dir, '**', '*.rb')
+      Dir.glob(search_me).sort.each {|rb| logger.debug "---- Loading MOle config '#{rb}'";load rb}
+    end
   end
 end

data/spec/mole_spec.rb

@@ -35,4 +35,32 @@ describe Mole do
     Mole.dump
   end
   
+  describe "load_mole_configuration" do
+    before( :each ) do
+      ::Mole.reset_configuration!
+    end
+    
+    it "should load single file correctly" do
+      ::Mole.initialize( :moleable => true, :mole_config => File.join( File.dirname(__FILE__), %w[config mole_config.rb] ) )
+      ::Mole.load_mole_configuration
+      require( File.join( File.dirname(__FILE__), %w[config mole_config.rb] ) ).should == []
+    end
+    
+    it "should load config for directory correctly" do
+      ::Mole.initialize( :moleable => true, :mole_config => File.join( File.dirname(__FILE__), %w[config moles] ) )
+      ::Mole.load_mole_configuration
+      require( File.join( File.dirname(__FILE__), %w[config moles fred_config.rb] ) ).should == []      
+    end
+    
+    it "should raise an error if the configuration file does not exist" do
+      ::Mole.initialize( :moleable => true, :mole_config => File.join( File.dirname(__FILE__), %w[config fred_mole.rb] ) )
+      lambda{ ::Mole.load_mole_configuration }.should raise_error( "Unable to find the MOle configuration from `./spec/config/fred_mole.rb" )       
+    end
+    
+    it "should raise an error if the config directory does not exist" do
+      ::Mole.initialize( :moleable => true, :mole_config => File.join( File.dirname(__FILE__), %w[config freds] ) )
+      lambda{ ::Mole.load_mole_configuration }.should raise_error( "Unable to find the MOle configuration from `./spec/config/freds" )       
+    end
+  end
+  
 end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: mole
 version: !ruby/object:Gem::Version 
-  version: 1.0.4
-date: 2008-03-06 00:00:00 -07:00
+  version: 1.0.5
+date: 2008-03-25 00:00:00 -06:00
 summary: A flexible way to track user's interactions within your ruby web applications
 require_paths: 
 - lib
@@ -46,6 +46,8 @@ files:
 - lib/mole/moler.rb
 - lib/mole/utils/frameworks.rb
 - lib/mole/version.rb
+- spec/config/mole_config.rb
+- spec/config/moles/fred_config.rb
 - spec/data/blee.rb
 - spec/db/migrate_spec.rb
 - spec/emole_spec.rb