class_logger 0.2 → 1.0

data/.gitignore

@@ -1,3 +1,4 @@
 pkg/*
 *.gem
 .bundle
+*.log

data/README.md

@@ -26,10 +26,13 @@ ClassLogger supports a bunch of options that are passed straight to the Logger.
   <dd>Set this to how many logfiles you want to keep after rotating (or set +rotate+ above)</dd>
 
   <dt><strong>:path</strong></dt>
-  <dd>The path to your log folder. (Default: "%&lt;rails_root>s/log") -- see Interpolations section</dd>
+  <dd>The path to your log folder. (Default: "%{rails_root}/log") -- see Interpolations section</dd>
+
+  <dt><strong>:file</strong></dt>
+  <dd>This is the name of your logfile. (Use: "%{class_name}" to interpolate the class's name) (Default: "%{class_name}.log") -- see Interpolations section</dd>
 
   <dt><strong>:in</strong></dt>
-  <dd>This is the name of your logfile. (Use: "%&lt;class_name>s" to interpolate the class's name) (Default: "%&lt;class_name>s.log") -- see Interpolations section</dd>
+  <dd><strong>Overrides :file &amp; :path!</strong> If you include this setting, it will break the filename from the path and use those options.</dd>
 
   <dt><strong>:as</strong></dt>
   <dd>This is the method your logger will be available to the class as. (Default: logger)</dd>
@@ -47,11 +50,14 @@ Interpolations
 The following can be used in the *path* or *in* options.
 
 <dl>
-  <dt><strong>%&lt;rails_root>s</strong></dt>
+  <dt><strong>%{rails_root}</strong></dt>
   <dd>Will replace itself with Rails.root when in a rails app</dd>
 
-  <dt><strong>%&lt;class_name>s</strong></dt>
+  <dt><strong>%{class_name}</strong></dt>
   <dd>Will replace itself with the name of the class.</dd>
+
+  <dt><strong>%{caller_path_}</strong></dt>
+  <dd>Will replace itself the path of the calling file. (Useful if you want logs relative to your scripts location)</dd>
 </dl>
   
 Example Usage
@@ -64,7 +70,7 @@ Example Usage
     has_logger
   
     def process!
-      logger.info "Creating transation: #{amount}"  # => goes to log/transaction.log
+      logger.info "Creating transation: #{amount}"  # => goes to RAILS_ROOT/log/transaction.log
     end
   end
   
@@ -73,41 +79,32 @@ Example Usage
   # specifying a custom logfile and logger name
   class Transaction &lt; ActiveRecord::Base
     include ClassLogger
-    has_logger :in => 'gateway.log', :as => :gateway_logger
+    has_logger :file => 'gateway.log', :as => :gateway_logger
   
     def process!
-      gateway_logger.info "Creating transation: #{amount}"  # => goes to log/gateway.log
-      logger.info "Hello default logger!"                   # => goes to log/&lt;environment>.log
+      gateway_logger.info "Creating transation: #{amount}"  # => goes to RAILS_ROOT/log/gateway.log
+      logger.info "Hello default logger!"                   # => goes to default rails logger
     end
   end
   
   # overriding active record's default logger with a custom logfile
   class Transaction &lt; ActiveRecord::Base
     include ClassLogger
-    has_logger :in => 'gateway.log'
+    has_logger :file => 'gateway.log'
   
     def process!
-      logger.info "Creating transation: #{amount}"  # => goes to log/gateway.log
+      logger.info "Creating transation: #{amount}"  # => goes to RAILS_ROOT/log/gateway.log
     end
   end
 
   # create a logger for a module
   module Something
     include ClassLogger
-    has_logger :path => File.expand_path("../log", __FILE__), :in => 'my_module.log'
-    has_logger :path => '/var/log', :in => 'utoh.log', :as => :utoh_logger
-    
-    # has_logger only makes instance methods, so we need to wrap it up
-    def self.logger
-      self.loggers[:logger]
-    end
-    
-    def self.utoh
-      self.loggers[:utoh_logger]
-    end
+    has_logger :in => "%{caller_path}/log/my_module.log"
+    has_logger :in => "/var/log/utoh.log", :as => :utoh_logger
   end
-  Something.logger.info "Testing 123"
-  Something.utoh.error "oops!"
+  Something.logger.info "Testing 123" # => goes to ./log/my_module.log
+  Something.utoh_logger.error "oops!" # => goes to /var/log/utoh.log
   
   # inside a class with a custom formatter
   class Something
@@ -116,9 +113,9 @@ Example Usage
       :formatter => proc{ |severity, time, program_name, message| "[%s](Something): %s\n" % [severity, message] }
 
     def initialize
-      logger.debug "Created Something."
+      logger.debug "Created Something." # => goes to ../log/something.log
     end
   end
   Something.new
-  Something.loggers[:logger].debug "System logger"
+  Something.loggers[:logger].debug "System logger" # alter entry point to logger
 </pre>

data/examples/examples.rb

@@ -0,0 +1,42 @@
+require File.expand_path('../../lib/class_logger', __FILE__)
+$log_path = File.dirname(__FILE__)
+
+# test module functionality
+module Hello
+  include ClassLogger
+  has_logger :in => "%{class_name}.log", :as => :my_logger
+  
+  def self.alternate
+    loggers[:my_logger]
+  end
+end
+Hello.my_logger.info "Hai"
+Hello.alternate.info "Hai der!"
+
+# test class functionality
+class Gateway
+  include ClassLogger
+  has_logger :path => $log_path, :level => Logger::ERROR
+  has_logger :in => "%{caller_path}/transaction.log", :as => :transaction_logger,
+    :formatter => proc{ |severity, time, program_name, message| "[%s-Transaction]: %s\n" % [severity, message] }
+  
+  def initialize
+    logger.info "Wont show up"
+    logger.error "Will show up"
+  end
+  
+  def transact!
+    transaction_logger.info "Transacted"
+  end
+end
+
+g = Gateway.new
+g.transact!
+
+# test default functionality
+class Default
+  include ClassLogger
+  has_logger :path => "%{caller_path}"
+end
+
+Default.new.logger.info "Testing"

data/lib/class_logger.rb

@@ -12,8 +12,9 @@ module ClassLogger
         :rotate => nil,
         :max_size => nil,
         :keep => nil,
-        :path => "%<rails_root>s/log",
-        :in => "%<class_name>s.log",
+        :in => nil,
+        :path => "%{rails_root}/log",
+        :file => "%{class_name}.log",
         :as => :logger,
         :formatter => proc{ |severity, time, program_name, message| "[%s,%s]: %s\n" % [severity, time, message] },
         :level => ::Logger::DEBUG
@@ -30,10 +31,16 @@ module ClassLogger
     def setup_logger(options)
       interpolations = {
         :rails_root => (defined?(Rails) ? Rails.root : ''),
-        :class_name => self.to_s.downcase
+        :class_name => self.to_s.downcase,
+        :caller_path => (File.dirname(caller[1]) rescue '.')
       }
-      
-      file_path = File.join(options[:path], options[:in]).to_s % interpolations
+
+      if i = options[:in]
+        options[:file] = File.basename(i)
+        options[:path] = File.dirname(i)
+      end  
+
+      file_path = File.join(options[:path], options[:file]).to_s % interpolations
       if (rotate = options[:rotate])
         _logger = ::Logger.new(file_path, rotate)
       else
@@ -44,8 +51,9 @@ module ClassLogger
 
       as = options[:as]
       self.loggers[as] = _logger
+      
       define_method(as){ self.class.loggers[as] }
-      define_singleton_method(as){ loggers[as] }
+      (class << self; self; end).class_eval{ define_method(as){ loggers[as] }}
     end
   end
 end

data/lib/class_logger/version.rb

@@ -1,3 +1,3 @@
 module ClassLogger
-  VERSION = '0.2'
+  VERSION = '1.0'
 end

metadata

@@ -2,7 +2,7 @@
 name: class_logger
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: "0.2"
+  version: "1.0"
 platform: ruby
 authors: 
 - Rob Hurring
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-08 00:00:00 -05:00
+date: 2011-03-10 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -29,6 +29,7 @@ files:
 - README.md
 - Rakefile
 - class_logger.gemspec
+- examples/examples.rb
 - lib/class_logger.rb
 - lib/class_logger/version.rb
 has_rdoc: true