logutils 0.4.0 → 0.5.0

data/Manifest.txt

@@ -9,5 +9,5 @@ lib/logutils/db/models.rb
 lib/logutils/db/schema.rb
 lib/logutils/logger.rb
 lib/logutils/version.rb
-test/test_helper.rb
+test/helper.rb
 test/test_logger.rb

data/README.md

@@ -1,5 +1,7 @@
 # logutils
 
+[![Build Status](https://secure.travis-ci.org/geraldb/logutils.png?branch=master)](http://travis-ci.org/geraldb/logutils)
+
 Another Logger in Ruby
 
 * [github.com/geraldb/logutils](https://github.com/geraldb/logutils)
@@ -11,7 +13,7 @@ Logging levels:
 [ALL] < DEBUG < INFO < WARN < ERROR < FATAL < [OFF]
 
 
-Start off getting a logger e.g.:
+Start by getting a logger e.g.:
 
     logger = LogUtils::Logger.new
 
@@ -90,7 +92,6 @@ To clean out all log records from the database use:
 
 ### All together now
 
-
     require 'logutils'
     
     include LogUtils    # lets you use Logger instead of LogUtils::Logger
@@ -98,17 +99,14 @@ To clean out all log records from the database use:
     logger = Logger[ 'Test' ]
     logger.info 'hello LogUtils'
     
-    require 'logutils/db'
     
-    LOG_DB_PATH = './log.db'
+    require 'logutils/db'   # nb: will also require 'active_record'
     
     LOG_DB_CONFIG = {
       :adapter   =>  'sqlite3',
-      :database  =>  LOG_DB_PATH
+      :database  =>  './log.db'
     }
     
-    require 'active_record'
-    
     pp LOG_DB_CONFIG
     ActiveRecord::Base.establish_connection( LOG_DB_CONFIG )
     
@@ -121,19 +119,30 @@ To clean out all log records from the database use:
 
 That's it.
 
+
+## Real World Usage
+
+[world.db.ruby](https://github.com/geraldb/world.db.ruby) - `world.db` Command Line Tool
+
+[sport.db.ruby](https://github.com/geraldb/sport.db.ruby) - `sport.db` Command Line Tool
+
+[Sportbook](http://geraldb.github.com/sportbook) - A free, open source sports betting pool
+in Ruby on Rails (version 3.2 and up). 
+
+
 ## Todos
 
 - [ ] Add UNKNOWN level - why? why not? check std logger
 
 
-
 ## Alternatives
 
+* [log4r](https://github.com/colbygk/log4r)  - Logging Library modeled after log4j in the Java world
+* [slf4r](https://github.com/mkristian/slf4r) - Logging Library modeled after slf4j in the Java world
+* [yell](https://github.com/rudionrails/yell)
+* [logging](https://github.com/TwP/logging)
 * [Ruby Toolbox Logging Category](https://www.ruby-toolbox.com/categories/Logging)
-* [log4r]()
-* [slf4r](https://www.ruby-toolbox.com/projects/slf4r)
-* [yell]()
-* [logging](https://rubygems.org/gems/logging)
+
 
 ## License
 

data/Rakefile

@@ -4,7 +4,7 @@ require './lib/logutils/version.rb'
 
 Hoe.spec 'logutils' do
   
-  self.version = LogUtils::Kernel::VERSION
+  self.version = LogKernel::VERSION
   
   self.summary = 'Another Logger'
   self.description = summary
@@ -25,4 +25,4 @@ Hoe.spec 'logutils' do
    :required_ruby_version => '>= 1.9.2'
   }
   
-end
+end

data/lib/logutils.rb

@@ -20,7 +20,7 @@ require 'logutils/version'
 require 'logutils/logger'
 
 
-module LogUtils::Kernel
+module LogKernel
 =begin   # not needed for now; keep it for later
 
   def self.root
@@ -45,7 +45,7 @@ module LogUtils
     puts "depreceated API call LogUtils[] - use Logger[] / LogUtils::Logger[] instead"
     
     # for now always return single instance, that is, use standard/default logger for all
-    LogUtils::Kernel::STDLOGGER
+    LogKernel::STDLOGGER
   end
 
   ###################################
@@ -58,9 +58,7 @@ module LogUtils
   #  logger = Logger[ SportDb::Reader ] or
   #  logger = Logger[ 'SportDb::Reader' ] etc.
 
-  Logger = LogUtils::Kernel::Logger
-  include LogUtils::Kernel::Level    # e.g. export ALL,DEBUG,INFO,WARN,etc.
-
+  Logger = LogKernel::Logger
 
 
   #####
@@ -89,12 +87,9 @@ module LogUtils
   #  end
 
   module Logging
-    include LogUtils::Kernel::Level # e.g. lets you use ALL,DEBUG,INFO,WARN,etc.
-
     def logger
-      @logger ||= LogUtils::Kernel::Logger[ self ]
+      @logger ||= LogKernel::Logger[ self ]
     end
   end
 
 end  # module LogUtils
-

data/lib/logutils/db.rb

@@ -16,7 +16,7 @@ require 'logutils/db/deleter'
 
 module LogDb
 
-  include LogUtils::Kernel   # NB: will also include VERSION constant e.g. LogDB::VERSION == LogUtils::Kernel::VERSION
+  include LogKernel   # NB: will also include VERSION constant e.g. LogDB::VERSION == LogUtils::Kernel::VERSION
 
   def self.banner
     "logdb #{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
@@ -29,22 +29,22 @@ end
 
 LogDB = LogDb
 
+
+
 ###########################
 
 module LogDb
 
-  class DbListener
+  class DbHandler
     include LogDb::Models
     
     def write( ev )
-      if( ev.fatal? || ev.error? || ev.warn? )
+      if( ev.fatal? || ev.error? || ev.warn? || ev.unknown? )
         ## create log entry in db table (logs)
         Log.create!( level: ev.level, msg: ev.msg, pid: ev.pid, tid: ev.tid, ts: ev.ts )
       end
     end # method write
-  end  # class DbListener
-
-  STDDBLISTENER = DbListener.new   # default/standard db listener
+  end  # class DbHandler
 
   def self.create
     CreateDb.up
@@ -61,11 +61,14 @@ module LogDb
     # to be done
   end
 
+
+  STDDBHANDLER = DbHandler.new   # default/standard db handler
+
   def self.setup   # check: use different name?  e.g. configure or connect ?? why or why not?
     # turn on logging to db  - assumes active connection
-    STDLOGGER.listeners << STDDBLISTENER
+    STDLOGGER.handlers << STDDBHANDLER
   end
- 
+
 
 end # module LogDb
 

data/lib/logutils/logger.rb

@@ -1,7 +1,9 @@
 
-module LogUtils::Kernel
+module LogKernel
   
-  ## private "kernel" - with include LogUtils - do NOT include everything
+  #####
+  # private "kernel" do NOT include everything into LogUtils
+  #  only "export" public API in LogUtils
   
   
   #####
@@ -15,30 +17,43 @@ module LogUtils::Kernel
   #               debug         = 5 etc.
 
   module Level
-    ALL   = 0
-    DEBUG = 1
-    INFO  = 2
-    WARN  = 3
-    ERROR = 4
-    FATAL = 5
-    OFF   = 6
+    ALL     = 0
+    DEBUG   = 1
+    INFO    = 2
+    WARN    = 3
+    ERROR   = 4
+    FATAL   = 5
+    UNKNOWN = 6    ## make unknown higher than off? why? why not?
+    OFF     = 7
   end
 
+  LEVEL_NAME =
+    [
+     'all',     # 0
+     'debug',   # 1
+     'info',    # 2
+     'warn',    # 3
+     'error',   # 4
+     'fatal',   # 5
+     'unknown', # 6
+     'off'      # 7
+    ]
+  
+  # map symbol to levelno; if not match map to UNKNOWN
+  LEVEL_HASH = {
+      all:     Level::ALL,
+      debug:   Level::DEBUG,
+      info:    Level::INFO,
+      warn:    Level::WARN,
+      error:   Level::ERROR,
+      fatal:   Level::FATAL,
+      off:     Level::OFF
+    }
+
 
   class Event
     include Level   # lets you access Level::DEBUG with just DEBUG etc.
 
-    LEVEL_NAME =
-    [
-     'all',    # 0
-     'debug',  # 1
-     'info',   # 2
-     'warn',   # 3
-     'error',  # 4
-     'fatal',  # 5
-     'off'     # 6
-    ]
-
     def initialize( levelno, msg )
       @levelno = levelno    # pass in integer e.g. 0,1,2,3,etc.
       @msg     = msg
@@ -52,7 +67,8 @@ module LogUtils::Kernel
     def level
       LEVEL_NAME[ @levelno ]
     end
-
+    
+    attr_reader :levelno
     attr_reader :msg
     attr_reader :pid   # process_id
     attr_reader :tid   # thread_id
@@ -70,6 +86,10 @@ module LogUtils::Kernel
     def warn?
       @levelno == WARN
     end
+    
+    def unknown?
+      @levelno == UNKNOWN
+    end
 
 
     def to_s
@@ -80,17 +100,17 @@ module LogUtils::Kernel
   end # class Event
 
 
-  class ConsoleListener
+  class ConsoleHandler
     def write( ev )
-      if( ev.fatal? || ev.error? || ev.warn? )
+      if( ev.fatal? || ev.error? || ev.warn? || ev.unknown? )
         STDERR.puts ev.to_s
       else
         STDOUT.puts ev.to_s
       end
     end
-  end  # class ConsoleListener
+  end  # class ConsoleHandler
   
-  STDLISTENER = ConsoleListener.new  # default/standard console listener
+  STDHANDLER = ConsoleHandler.new  # default/standard log handler
 
 
   class Logger
@@ -99,14 +119,33 @@ module LogUtils::Kernel
     def self.[]( class_or_name )
       STDLOGGER
     end
-
+    
+    def self.root
+      STDLOGGER
+    end
+    
     def initialize
-      @listeners = []
-      @listeners << STDLISTENER  # by default log to console
+      @handlers = []
+      @handlers << STDHANDLER   # by default log to console
+
+      ## todo/check: pass levelno through to handlers?
+      #   do we need a "global" levelno in the logger?
+      @levelno = ALL
     end
     
-    attr_reader :listeners
+    attr_reader :handlers
+    
+    
+    #####
+    # NB: use :debug, :info, :warn, :error, etc as argument
+    #
+    #  if invalid argument gets passed in, level gets set to UNKNOWN
     
+    def level=( key )
+      @levelno = LEVEL_HASH.fetch( key, UNKNOWN )
+    end
+
+
     def debug( msg )
       write( Event.new( DEBUG, msg ) )
     end
@@ -126,15 +165,21 @@ module LogUtils::Kernel
     def fatal( msg )
       write( Event.new( FATAL, msg ) )
     end
+    
+    def unknown( msg )
+      write( Event.new( UNKNOWN, msg ) )
+    end
 
   private
 
     def write( ev )
-      @listeners.each { |l| l.write( ev ) }
+      if ev.levelno >= @levelno
+        @handlers.each { |l| l.write( ev ) }
+      end
     end
     
   end # class Logger
   
   STDLOGGER = Logger.new    # single instance - default/standard logger
 
-end # module LogUtils
+end # module LogKernel

data/lib/logutils/version.rb

@@ -2,8 +2,9 @@
 module LogUtils
   # NB: keep LogUtils namespace clean
   #  only include public API that gets included w/  include LogUtils in other modules
+  # move all non public code/apis to LogKernel (including VERSION)
 end
 
-module LogUtils::Kernel
-  VERSION = '0.4.0'
+module LogKernel
+  VERSION = '0.5.0'
 end

data/test/test_logger.rb

@@ -4,7 +4,7 @@
 #  or better
 #     rake test
 
-require 'test_helper'
+require 'helper'
 
 class TestLogger < MiniTest::Unit::TestCase
   include LogUtils        # lets us use Logger instead of LogUtils::Logger
@@ -20,9 +20,9 @@ class TestLogger < MiniTest::Unit::TestCase
     
     ### nb: for now all return LogUtils::Kernel::STDLOGGER
     
-    assert(l1 == LogUtils::Kernel::STDLOGGER )
-    assert(l2 == LogUtils::Kernel::STDLOGGER )
-    assert(l3 == LogUtils::Kernel::STDLOGGER )
+    assert(l1 == LogKernel::STDLOGGER )
+    assert(l2 == LogKernel::STDLOGGER )
+    assert(l3 == LogKernel::STDLOGGER )
   end
   
   class SampleClass
@@ -38,8 +38,8 @@ class TestLogger < MiniTest::Unit::TestCase
      obj  = SampleClass.new
      obj2 = Sample2Class.new
      
-     assert( obj.logger == LogUtils::Kernel::STDLOGGER )
-     assert( obj2.logger == LogUtils::Kernel::STDLOGGER )
+     assert( obj.logger == LogKernel::STDLOGGER )
+     assert( obj2.logger == LogKernel::STDLOGGER )
   end
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logutils
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-23 00:00:00.000000000 Z
+date: 2013-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &69924980 !ruby/object:Gem::Requirement
+  requirement: &72260240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.10'
   type: :development
   prerelease: false
-  version_requirements: *69924980
+  version_requirements: *72260240
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: &69924650 !ruby/object:Gem::Requirement
+  requirement: &72259940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +32,7 @@ dependencies:
         version: '3.3'
   type: :development
   prerelease: false
-  version_requirements: *69924650
+  version_requirements: *72259940
 description: Another Logger
 email: opensport@googlegroups.com
 executables: []
@@ -51,7 +51,7 @@ files:
 - lib/logutils/db/schema.rb
 - lib/logutils/logger.rb
 - lib/logutils/version.rb
-- test/test_helper.rb
+- test/helper.rb
 - test/test_logger.rb
 - .gemtest
 homepage: https://github.com/geraldb/logutils
@@ -82,5 +82,4 @@ signing_key:
 specification_version: 3
 summary: Another Logger
 test_files:
-- test/test_helper.rb
 - test/test_logger.rb