logutils 0.3.0 → 0.4.0

data/Manifest.txt

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

data/README.md

@@ -8,25 +8,66 @@ Another Logger in Ruby
 
 Logging levels:
 
-DEBUG < INFO < WARN < ERROR < FATAL
+[ALL] < DEBUG < INFO < WARN < ERROR < FATAL < [OFF]
 
-use methods e.g.
 
-    logger = LoggerUtils::Logger.new
-    
+Start off getting a logger e.g.:
+
+    logger = LogUtils::Logger.new
+
+or
+
+    include LogUtils
+   
+    logger = Logger.new
+
+now you're ready to log using the methods `#debug`, `#info`, `#warn`, etc.
+
     logger.debug "msg"
     logger.info "another msg"
     logger.warn "another msg"
     logger.error "another msg"
     logger.fatal "another msg"
 
+
 To get a Logger use
 
-    logger = LogUtils[ self ]
+    logger = Logger[ self ]  # pass in object reference
+
+or
+
+    logger = Logger[ SportDb::Reader ]    # pass in class reference
 
 or
 
-    logger = LogUtils[ 'SportDb::Reader' ]
+    logger = Logger[ 'SportDb::Reader' ]  # pass in class name (as string)
+
+
+### `Logging` Mixin
+
+Note: In a class for convenience you can include the logging machinery
+with a single line using the Logging mixin e.g.
+
+    include LogUtils::Logging
+
+This will add/mixin the logger attribute reader e.g.
+
+    def logger
+      @logger ||= Logger[ self ]
+    end
+
+plus the constants for all logging levels, that is, FATAL, ERROR, WARN, etc.
+
+Example:
+
+    class SampleClass
+      include Logging
+    
+      def initialize
+        logger.info 'hello SampleClass'
+      end
+    end
+
 
 ### Log to the database using `LogDb`
 
@@ -52,7 +93,9 @@ To clean out all log records from the database use:
 
     require 'logutils'
     
-    logger = LogUtils[ 'Test' ]
+    include LogUtils    # lets you use Logger instead of LogUtils::Logger
+    
+    logger = Logger[ 'Test' ]
     logger.info 'hello LogUtils'
     
     require 'logutils/db'
@@ -78,6 +121,11 @@ To clean out all log records from the database use:
 
 That's it.
 
+## Todos
+
+- [ ] Add UNKNOWN level - why? why not? check std logger
+
+
 
 ## Alternatives
 

data/Rakefile

@@ -4,7 +4,7 @@ require './lib/logutils/version.rb'
 
 Hoe.spec 'logutils' do
   
-  self.version = LogUtils::VERSION
+  self.version = LogUtils::Kernel::VERSION
   
   self.summary = 'Another Logger'
   self.description = summary

data/lib/logutils.rb

@@ -10,7 +10,6 @@
 
 require 'yaml'
 require 'pp'
-require 'logger'
 require 'fileutils'
 
 
@@ -21,8 +20,7 @@ require 'logutils/version'
 require 'logutils/logger'
 
 
-module LogUtils
-
+module LogUtils::Kernel
 =begin   # not needed for now; keep it for later
 
   def self.root
@@ -34,15 +32,69 @@ module LogUtils
   end
 
 =end
+end
+
+
+module LogUtils
 
   ###########
-  # use it like:
-  #  logger = LogUtils[ self ]  or
-  #  logger = LogUtils[ 'SportDb::Reader' ] etc.
+  # deprecated - remove old api!!!
 
   def self.[]( class_or_name )
+    
+    puts "depreceated API call LogUtils[] - use Logger[] / LogUtils::Logger[] instead"
+    
     # for now always return single instance, that is, use standard/default logger for all
-    STDLOGGER
+    LogUtils::Kernel::STDLOGGER
+  end
+
+  ###################################
+  # export public api from kernel
+
+
+  ##############################
+  #  use it like:
+  #  logger = Logger[ self ]  or
+  #  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.
+
+
+
+  #####
+  # use it like
+  #
+  #  class SampleClass
+  #    include LogUtils::Logging
+  #    ...
+  #  end
+  #
+  #  or
+  #
+  #  include LogUtils
+  #
+  #  class SampleClass
+  #    include Logging
+  #    ...
+  #  end
+  #
+  #  class AnotherSampleClass
+  #    include Logging
+  #    ...
+  #    def sample_method
+  #       logger.debug "calling sample_method"
+  #    end
+  #  end
+
+  module Logging
+    include LogUtils::Kernel::Level # e.g. lets you use ALL,DEBUG,INFO,WARN,etc.
+
+    def logger
+      @logger ||= LogUtils::Kernel::Logger[ self ]
+    end
   end
 
 end  # module LogUtils
+

data/lib/logutils/db.rb

@@ -16,7 +16,7 @@ require 'logutils/db/deleter'
 
 module LogDb
 
-  VERSION = LogUtils::VERSION
+  include LogUtils::Kernel   # 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}]"
@@ -34,7 +34,7 @@ LogDB = LogDb
 module LogDb
 
   class DbListener
-    include LogDB::Models
+    include LogDb::Models
     
     def write( ev )
       if( ev.fatal? || ev.error? || ev.warn? )
@@ -63,7 +63,7 @@ module LogDb
 
   def self.setup   # check: use different name?  e.g. configure or connect ?? why or why not?
     # turn on logging to db  - assumes active connection
-    LogUtils::STDLOGGER.listeners << STDDBLISTENER
+    STDLOGGER.listeners << STDDBLISTENER
   end
  
 

data/lib/logutils/logger.rb

@@ -1,21 +1,47 @@
 
-module LogUtils
+module LogUtils::Kernel
   
+  ## private "kernel" - with include LogUtils - do NOT include everything
+  
+  
+  #####
+  # use like:
+  #  LEVEL_NAME[ DEBUG ]  will return  'debug'
+  #  LEVEL_NAME[ ERROR ]  will return  'error' etc.
+  
+  ### todo: reverse level integers ??? why? why not??
+  # more logical  no output     = 0 (off)
+  #               everything    = 6 (all)
+  #               debug         = 5 etc.
+
   module Level
-    DEBUG = 'debug'
-    INFO  = 'info'
-    WARN  = 'warn'
-    ERROR = 'error'
-    FATAL = 'fatal'
+    ALL   = 0
+    DEBUG = 1
+    INFO  = 2
+    WARN  = 3
+    ERROR = 4
+    FATAL = 5
+    OFF   = 6
   end
 
 
   class Event
-    include Level
-
-    def initialize( level, msg )
-      @level = level
-      @msg   = msg
+    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
       
       @pid   = Process.pid
       @tid   = Thread.current.object_id
@@ -23,7 +49,10 @@ module LogUtils
       @ts    = Time.now
     end
 
-    attr_reader :level
+    def level
+      LEVEL_NAME[ @levelno ]
+    end
+
     attr_reader :msg
     attr_reader :pid   # process_id
     attr_reader :tid   # thread_id
@@ -31,15 +60,15 @@ module LogUtils
 
 
     def fatal?
-      @level == FATAL
+      @levelno == FATAL
     end
 
     def error?
-      @level == ERROR
+      @levelno == ERROR
     end
 
     def warn?
-      @level == WARN
+      @levelno == WARN
     end
 
 
@@ -66,7 +95,11 @@ module LogUtils
 
   class Logger
     include Level
-    
+
+    def self.[]( class_or_name )
+      STDLOGGER
+    end
+
     def initialize
       @listeners = []
       @listeners << STDLISTENER  # by default log to console

data/lib/logutils/version.rb

@@ -1,5 +1,9 @@
 
 module LogUtils
-  VERSION = '0.3.0'
-end  # module LogUtils
+  # NB: keep LogUtils namespace clean
+  #  only include public API that gets included w/  include LogUtils in other modules
+end
 
+module LogUtils::Kernel
+  VERSION = '0.4.0'
+end

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+
+## $:.unshift(File.dirname(__FILE__))
+
+
+## minitest setup
+
+# require 'minitest/unit'
+require 'minitest/autorun'
+
+# include MiniTest::Unit  # lets us use TestCase instead of MiniTest::Unit::TestCase
+
+
+## our own code
+
+require 'logutils'

data/test/test_logger.rb

@@ -0,0 +1,45 @@
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_logger.rb
+#  or better
+#     rake test
+
+require 'test_helper'
+
+class TestLogger < MiniTest::Unit::TestCase
+  include LogUtils        # lets us use Logger instead of LogUtils::Logger
+
+  ####
+  # just for testing testing machinery
+  #  simple tests
+
+  def test_root
+    l1 = Logger[ self ]
+    l2 = Logger[ 'Test' ]
+    l3 = Logger[ TestLogger ]
+    
+    ### nb: for now all return LogUtils::Kernel::STDLOGGER
+    
+    assert(l1 == LogUtils::Kernel::STDLOGGER )
+    assert(l2 == LogUtils::Kernel::STDLOGGER )
+    assert(l3 == LogUtils::Kernel::STDLOGGER )
+  end
+  
+  class SampleClass
+    include LogUtils  # NB: constant from containing class not available (only if class is nested in module)
+    include Logging
+  end
+  
+  class Sample2Class
+    include LogUtils::Logging
+  end
+  
+  def test_class
+     obj  = SampleClass.new
+     obj2 = Sample2Class.new
+     
+     assert( obj.logger == LogUtils::Kernel::STDLOGGER )
+     assert( obj2.logger == LogUtils::Kernel::STDLOGGER )
+  end
+  
+end

metadata

@@ -1,61 +1,45 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: logutils
-version: !ruby/object:Gem::Version 
-  hash: 19
+version: !ruby/object:Gem::Version
+  version: 0.4.0
   prerelease: 
-  segments: 
-  - 0
-  - 3
-  - 0
-  version: 0.3.0
 platform: ruby
-authors: 
+authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-02-21 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rdoc
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &69924980 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 19
-        segments: 
-        - 3
-        - 10
-        version: "3.10"
+      - !ruby/object:Gem::Version
+        version: '3.10'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: hoe
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *69924980
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: &69924650 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 3
-        - 3
-        version: "3.3"
+      - !ruby/object:Gem::Version
+        version: '3.3'
   type: :development
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: *69924650
 description: Another Logger
 email: opensport@googlegroups.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - Manifest.txt
-files: 
+files:
 - History.md
 - Manifest.txt
 - README.md
@@ -67,43 +51,36 @@ files:
 - lib/logutils/db/schema.rb
 - lib/logutils/logger.rb
 - lib/logutils/version.rb
-- test/test.rb
+- test/test_helper.rb
+- test/test_logger.rb
 - .gemtest
 homepage: https://github.com/geraldb/logutils
-licenses: 
+licenses:
 - Public Domain
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --main
 - README.md
-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 
-      hash: 55
-      segments: 
-      - 1
-      - 9
-      - 2
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.9.2
-required_rubygems_version: !ruby/object:Gem::Requirement 
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: logutils
-rubygems_version: 1.8.24
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: Another Logger
-test_files: []
-
+test_files:
+- test/test_helper.rb
+- test/test_logger.rb

data/test/test.rb

@@ -1,33 +0,0 @@
-
-puts "before require 'logutils'"
-require 'logutils'
-
-puts "LogUtils::VERSION #{LogUtils::VERSION}"
-
-logger = LogUtils[ 'Test' ]
-logger.info 'hello LogUtils'
-
-puts "before require 'logutils/db'"
-require 'logutils/db'
-
-
-LOG_DB_PATH = './log.db'
-
-LOG_DB_CONFIG = {
-  :adapter   =>  'sqlite3',
-  :database  =>  LOG_DB_PATH
-}
-
-require 'active_record'
-
-pp LOG_DB_CONFIG
-ActiveRecord::Base.establish_connection( LOG_DB_CONFIG )
-
-
-LogDb.create
-
-LogDb.setup
-
-logger.info 'hola LogUtils'
-logger.warn 'servus LogUtils'
-