easy_log4r 0.0.2 → 0.0.3

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/lib/easy_log4r/easy_logger.rb

@@ -1,4 +1,12 @@
+##
+# EasyLogger
+#
+# This class is what sets up the EasyLog4r Logger in your class when you include it in the class.
+#
 module EasyLog4r::EasyLogger
+
+  ##
+  # Included hook which calls EasyLog4r::Logger#add_logger
   def self.included(base)
     EasyLog4r::Logger.add_logger(base, EasyLog4r::Logger.get_logger(base))
   end

data/lib/easy_log4r/logger.rb

@@ -1,21 +1,71 @@
+##
+# Class that creates Log4r::Loggers with some basic defaults and also modifies base classes to referece said Loggers.
+#
 class EasyLog4r::Logger
   require 'log4r'
   include Log4r
 
+  ##
+  # Adds log4r class variable, as well as Base::log4r and Base#log4r
   def self.add_logger(base, logger)
     base.class_variable_set(:@@log4r, logger)
-    base.instance_eval{ def log4r; class_variable_get(:@@log4r); end }
-    base.class_eval{ def log4r; class_variable_get(:@@log4r); end }
+    base.class_eval do 
+      def log4r; class_variable_get(:@@log4r); end
+      def self.log4r; class_variable_get(:@@log4r); end
+    end
   end
 
+  ##
+  # Provides the default Loggers, which are null_loggers with the default outputters.
   def self.default_logger(name)
     logger = null_logger(name)
-    formatter = Log4r::PatternFormatter.new(:pattern => "[%l] %d %c :: %m")
-    logger.outputters = [Log4r::StdoutOutputter.new(:formatter => formatter),
-                         Log4r::StderrOutputter.new(:formatter => formatter)]
+    logger.outputters = default_outputters
+
     return logger
   end
 
+  ##
+  # Creates or returns default outputters.
+  #
+  # Those outputters are a Log4r::StdoutOutputter and a Log4r::StderrOutputter, both of which have a default Log4r::Formatter
+  def self.default_outputters
+    return @outputters if @outputters
+    @outputters = []
+    formatter = default_formatter
+
+    if out = Log4r::Outputter['formatted_stdout']
+      @outputters << out
+    else
+      @outputters << Log4r::StdoutOutputter.new('formatted_stdout', :formatter => formatter)
+    end
+
+    if out = Log4r::Outputter['formatted_stderr']
+      @outputters << out
+    else
+      @outputters << Log4r::StderrOutputter.new('formatted_stderr', :formatter => formatter)
+    end
+
+    return @outputters
+  end
+
+  ##
+  # Creates or returns the default formatter.
+  #
+  # The formatter is a Log4r::PatternFormatter with the following pattern:
+  #   "[%l] %d @@%c :: %m"
+  #
+  # For example:
+  #   Base.log4r.info("This is only a test")
+  #   => [INFO] 2012-07-30 12:00:00 PM @@Base :: This is only a test
+  def self.default_formatter
+    return @formatter if @formatter
+    @formatter = Log4r::PatternFormatter.new(:pattern => "[%l] %d @@%c :: %m")
+
+    return @formatter
+  end
+
+  ##
+  # Creates a Log4r::Logger with the given name and clears all Outputters
   def self.null_logger(name)
     logger = Log4r::Logger.new(name)
     logger.outputters = []
@@ -23,6 +73,10 @@ class EasyLog4r::Logger
     return logger
   end
 
+  ##
+  # Given a Class, this will return either an existing Log4r::Logger, that could be defined via XML or YAML options, or a fresh new logger, that has the name of the class, as represented by Class.to_s, as its name. 
+  #
+  # If the second option is given any value which resolves to true, it will provide a Log4r::Logger with no Outputters.
   def self.get_logger(base, null=false)
     clas = base.to_s
     logger = null ? null_logger(clas) : Log4r::Logger[clas]

data/lib/easy_log4r/null_logger.rb

@@ -1,4 +1,12 @@
+##
+# Creates a Log4rLogger with no Outputters, or overwrites the default Logger provided by EasyLog4r::EasyLogger, removing it's Outputters
+#
+# This enables you to keep your log4r statements in your code without producing any output whatsoever.
+#
 module EasyLog4r::NullLogger
+
+  ##
+  # Included hook which nullifies the default Logger by removing its Outputters
   def self.included(base)
     EasyLog4r::Logger.add_logger(base, EasyLog4r::Logger.get_logger(base, :null))
   end

data/lib/easy_log4r.rb

@@ -1,4 +1,12 @@
-class EasyLog4r
+##
+# Base Class for EasyLog4r. Standard includes for the rest of the gem.
+#
+# To use EasyLog4r, just include the gem in your Gemfile, then drop the following into your class:
+#   include EasyLog4r::EasyLogger
+#
+# This produces a log4r method on the class and any instance that can be used to access a Log4r::Logger with some simple defaults.
+#
+module EasyLog4r
   require 'easy_log4r/logger'
   require 'easy_log4r/easy_logger'
   require 'easy_log4r/null_logger'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easy_log4r
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -146,7 +146,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -759292738703420716
+      hash: 295757693681432550
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: