logjam 0.0.3 → 1.0.0

data/README

@@ -49,7 +49,8 @@ which the following keys are recognised (either as Strings or Symbols)...
    -----------------------   --------------------------------------------------
    default                   A boolean indicating whether this logger is the
                              default (i.e. the one to be used when no other
-                             fits the bill).
+                             fits the bill). Only one logger should be declared
+                             as a default.
    datetime_format           The date/time format to be used by the logger. See
                              the documentation for the standard Ruby Logger
                              class for more details.
@@ -58,14 +59,16 @@ which the following keys are recognised (either as Strings or Symbols)...
                              recognised in this value. STDOUT and STDERR are
                              translated to mean the standard output or error
                              streams respectively.
-   level                     The logging level to set on the logger.
+   level                     The logging level to set on the logger. If not
+                             explicitly specified this defaults to DEBUG.
    max_size                  When rotation is set to an integer value this value
                              can be set to indicate the maximum permitted file
                              size for a log file.
    name                      The name to associate with the logger. This allows
                              loggers to be tied to classes or for the creation
                              of aliases that tie multiple names to a single
-                             logger.
+                             logger. Note that you should always use Strings
+                             (and not Symbols) when specifying aliases.
    rotation                  The frequency with which the log file is rotated.
                              This may be an integer to indicate how many old log
                              files are retained or may be a String such as
@@ -86,7 +89,9 @@ fashion. In this case the method searches for a configuration file that it can
 use given a default set of files names (basically logging.yaml, logging.yml and
 logging.json in the current working directory and in a subdirectory of the
 current working directory called config). The first of these files that it finds
-it attempts to use as configuration for the logging set up.
+it attempts to use as configuration for the logging set up. If it doesn't find
+a configuration file then this type of call becomes equivalent to passing an
+empty Hash to the configure() method.
 
 See the end of this document for some example configurations.
 
@@ -114,9 +119,12 @@ specified or if a matching logger does not exist, the class will fall back in
 using the default logger.
 
 Once this line has been added to the class definition it will cause the class to
-be extended with two methods - one called log() and one called log=(). The first
-of these retrieves the Logger instance to be used by the class instances. The
-second allows the Logger instance associated with a class to be altered.
+be extended with three methods - two class level methods (one called log() and
+one called log=()) and an instance level method called log(). The log() methods
+retrieve the Logger instance to be used by the class instances. The log=()
+method allows the Logger instance associated with a class to be altered. Note
+the instance level log() method will only be added if an existing method with
+that name does not already exist on the class.
 
 The following complete (although contrived) example gives an overview of how
 this would work...
@@ -263,3 +271,51 @@ JSON
                 {"file": "STDOUT",
                  "name": "verbose"}],
     "aliases": {"database":"verbose"}}
+
+The following configuration can be used as an example of how to drive logging
+from different parts of the code to different destinations. The configuration
+declares two loggers which deliver their output to two different log files and
+then declares aliases for those loggers that can be used to divide up the
+logging coming from different areas of the code.
+
+Hash
+   {:loggers => [{:default => true,
+                  :file    => "./log/main.log",
+                  :name    => "main"},
+                 {:file    => "./log/secondary.log",
+                  :name    => "secondary"}],
+    :aliases => {"database"   => "secondary",
+                 "model"      => "secondary",
+                 "controller" => "main"}}
+
+YAML
+   --- 
+   :loggers: 
+   - :default: true
+     :file: ./log/main.log
+     :name: main
+   - :file: ./log/secondary.log
+     :name: secondary
+   :aliases: 
+     database: secondary
+     model: secondary
+     controller: main
+
+JSON
+   {"loggers": [{"default":true,
+                 "file": "./log/main.log",
+                 "name": "main"},
+                {"file": "./log/secondary.log",
+                 "name": "secondary"}],
+    "aliases": {"database":"secondary",
+                "model": "secondary",
+                "controller": "main"}}
+
+Testing
+-------
+LogJam uses the test-unit Ruby library for testing. The best approach to running
+the tests are to create a new gemset (assuming you're using RVM), do a bundle
+install on this gemset from within the LogJam root directory and then use a
+command such as the following to run the tests...
+
+    $> ruby -I./lib -I./test ./test/unit/test_logjam.rb

data/lib/logjam/logjam.rb

@@ -69,6 +69,7 @@ module LogJam
    #           to indicate use of the default logger.
    def self.apply(target, name=nil)
       target.extend(LogJam.get_module(name))
+      target.send(:define_method, :log) {LogJam.get_logger(name)} if !target.method_defined?(:log)
    end
 
    # This method attempts to fetch the logger for a specified name. If this
@@ -86,6 +87,12 @@ module LogJam
    def self.names
       @@logjam_loggers.keys.compact
    end
+
+   # A convenience mechanism that provides an instance level access to the
+   # class level logger.
+   def log
+      self.class.log
+   end
    
    private
    

data/lib/logjam/version.rb

@@ -0,0 +1,3 @@
+module LogJam
+   VERSION="1.0.0"
+end

data/lib/logjam.rb

@@ -4,6 +4,7 @@
 # See the license.txt for details of the licensing of the code in this file.
 
 require 'logger'
+require 'logjam/version'
 require 'logjam/exceptions'
 require 'logjam/logjam_logger'
 require 'logjam/logjam'

metadata

@@ -1,37 +1,40 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: logjam
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 1.0.0
   prerelease: 
-  version: 0.0.3
 platform: ruby
-authors: 
+authors:
 - Black North
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-02-12 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: json
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-description: LogJam is a library to simplify the use of logging across libraries and applications.
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: LogJam is a library to simplify the use of logging across libraries and
+  applications.
 email: ruby@blacknorth.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
+- lib/logjam/version.rb
 - lib/logjam/logjam_logger.rb
 - lib/logjam/logjam.rb
 - lib/logjam/exceptions.rb
@@ -40,30 +43,26 @@ files:
 - README
 homepage: https://github.com/free-beer/LogJam
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.5
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A library to aggregate logging.
 test_files: []
-