logutils 0.2.0 → 0.3.0

data/Manifest.txt

@@ -3,8 +3,10 @@ Manifest.txt
 README.md
 Rakefile
 lib/logutils.rb
+lib/logutils/db.rb
 lib/logutils/db/deleter.rb
 lib/logutils/db/models.rb
 lib/logutils/db/schema.rb
 lib/logutils/logger.rb
 lib/logutils/version.rb
+test/test.rb

data/README.md

@@ -20,6 +20,64 @@ use methods e.g.
     logger.error "another msg"
     logger.fatal "another msg"
 
+To get a Logger use
+
+    logger = LogUtils[ self ]
+
+or
+
+    logger = LogUtils[ 'SportDb::Reader' ]
+
+### Log to the database using `LogDb`
+
+NB: To use the `LogDb` machinery require the module, that is, issue:
+
+    require 'logutils/db'
+
+To create the database tables use:
+
+    LogDb.create
+
+To start logging to the database (established connection required) use:
+
+    LogDb.setup
+
+To clean out all log records from the database use:
+
+    LogDb.delete!
+
+
+### All together now
+
+
+    require 'logutils'
+    
+    logger = LogUtils[ 'Test' ]
+    logger.info 'hello LogUtils'
+    
+    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'
+
+
+That's it.
+
 
 ## Alternatives
 

data/lib/logutils.rb

@@ -5,6 +5,7 @@
 #
 # 1.9.x: ruby -Ilib lib/logutils.rb
 
+
 # core and stlibs
 
 require 'yaml'
@@ -13,32 +14,16 @@ require 'logger'
 require 'fileutils'
 
 
-# rubygems / 3rd party libs
-
-require 'active_record'   ## todo: add sqlite3? etc.
-
-
 # our own code
 
 require 'logutils/version'
 
-require 'logutils/db/models'
-require 'logutils/db/schema'
-require 'logutils/db/deleter'
-
 require 'logutils/logger'
 
 
 module LogUtils
 
-end  # module LogUtils
-
-
-module LogDB
-
-  def self.banner
-    "logdb #{LogUtils::VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
-  end
+=begin   # not needed for now; keep it for later
 
   def self.root
     "#{File.expand_path( File.dirname(File.dirname(__FILE__)) )}"
@@ -48,23 +33,16 @@ module LogDB
     "#{root}/config"
   end
 
-  def self.create
-    CreateDB.up
-  end
-
-  # delete ALL records (use with care!)
-  def self.delete!
-    puts '*** deleting log table records/data...'
-    Deleter.new.run
-  end # method delete!
+=end
 
+  ###########
+  # use it like:
+  #  logger = LogUtils[ self ]  or
+  #  logger = LogUtils[ 'SportDb::Reader' ] etc.
 
-  def self.stats
-    # to be done
+  def self.[]( class_or_name )
+    # for now always return single instance, that is, use standard/default logger for all
+    STDLOGGER
   end
 
-
-end # module LogDB
-
-## say hello
-puts LogDB.banner
+end  # module LogUtils

data/lib/logutils/db.rb

@@ -0,0 +1,74 @@
+
+#########################################
+# NB: only load on demand
+#  we do NOT want to pull in activerecord gem/dep for simple scripts
+
+# rubygems / 3rd party libs
+
+require 'active_record'   ## todo: add sqlite3? etc.
+
+# our own code
+
+require 'logutils/db/models'
+require 'logutils/db/schema'
+require 'logutils/db/deleter'
+
+
+module LogDb
+
+  VERSION = LogUtils::VERSION
+
+  def self.banner
+    "logdb #{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
+  end
+
+end
+
+###########################################3
+## fix: remove old alias for LogDb
+
+LogDB = LogDb
+
+###########################
+
+module LogDb
+
+  class DbListener
+    include LogDB::Models
+    
+    def write( ev )
+      if( ev.fatal? || ev.error? || ev.warn? )
+        ## 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
+
+  def self.create
+    CreateDb.up
+  end
+
+  # delete ALL records (use with care!)
+  def self.delete!
+    puts '*** deleting log table records/data...'
+    Deleter.new.run
+  end # method delete!
+
+
+  def self.stats
+    # to be done
+  end
+
+  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
+  end
+ 
+
+end # module LogDb
+
+
+# say hello
+puts LogDb.banner

data/lib/logutils/db/deleter.rb

@@ -1,10 +1,10 @@
 
-module LogDB
+module LogDb
 
-  class Deleter    
-    include LogDB::Models
+  class Deleter
+    include LogDb::Models
 
-    def run( args=[] )
+    def run
       # for now delete all tables
       
       Log.delete_all
@@ -12,4 +12,4 @@ module LogDB
     
   end # class Deleter
   
-end # module LogDB
+end # module LogDb

data/lib/logutils/db/models.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-module LogDB
+module LogDb
   module Models
 
 
@@ -10,4 +10,4 @@ end # class Log
 
 
   end # module Models
-end # module LogDB
+end # module LogDb

data/lib/logutils/db/schema.rb

@@ -1,7 +1,7 @@
 
-module LogDB
+module LogDb
 
-class CreateDB   ## fix/todo: change to ActiveRecord::Migration why? why not?
+class CreateDb   ## fix/todo: change to ActiveRecord::Migration why? why not?
 
 def self.up
 
@@ -39,6 +39,6 @@ end
 
 end # method up
 
-end # class CreateDB
+end # class CreateDb
 
-end # module LogDB
+end # module LogDb

data/lib/logutils/logger.rb

@@ -8,8 +8,11 @@ module LogUtils
     ERROR = 'error'
     FATAL = 'fatal'
   end
-  
+
+
   class Event
+    include Level
+
     def initialize( level, msg )
       @level = level
       @msg   = msg
@@ -27,17 +30,50 @@ module LogUtils
     attr_reader :ts    # timestamp
 
 
-    def to_s()
-      "[#{level}-#{pid}.#{tid}] #{msg}"
+    def fatal?
+      @level == FATAL
+    end
+
+    def error?
+      @level == ERROR
+    end
+
+    def warn?
+      @level == WARN
+    end
+
+
+    def to_s
+      # "[#{level}-#{pid}.#{tid}] #{msg}"
+      "[#{level}] #{msg}"
     end
 
   end # class Event
+
+
+  class ConsoleListener
+    def write( ev )
+      if( ev.fatal? || ev.error? || ev.warn? )
+        STDERR.puts ev.to_s
+      else
+        STDOUT.puts ev.to_s
+      end
+    end
+  end  # class ConsoleListener
   
-  
+  STDLISTENER = ConsoleListener.new  # default/standard console listener
+
+
   class Logger
-    include LogDB::Models
     include Level
     
+    def initialize
+      @listeners = []
+      @listeners << STDLISTENER  # by default log to console
+    end
+    
+    attr_reader :listeners
+    
     def debug( msg )
       write( Event.new( DEBUG, msg ) )
     end
@@ -61,14 +97,11 @@ module LogUtils
   private
 
     def write( ev )
-      puts ev.to_s
-      
-      if( [FATAL, ERROR, WARN].include?( ev.level ) )
-        ## 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
+      @listeners.each { |l| l.write( ev ) }
     end
     
   end # class Logger
   
+  STDLOGGER = Logger.new    # single instance - default/standard logger
+
 end # module LogUtils

data/lib/logutils/version.rb

@@ -1,5 +1,5 @@
 
 module LogUtils
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end  # module LogUtils
 

data/test/test.rb

@@ -0,0 +1,33 @@
+
+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'
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: logutils
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: 
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Gerald Bauer
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-02-20 00:00:00 Z
+date: 2013-02-21 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rdoc
@@ -61,11 +61,14 @@ files:
 - README.md
 - Rakefile
 - lib/logutils.rb
+- lib/logutils/db.rb
 - lib/logutils/db/deleter.rb
 - lib/logutils/db/models.rb
 - lib/logutils/db/schema.rb
 - lib/logutils/logger.rb
 - lib/logutils/version.rb
+- test/test.rb
+- .gemtest
 homepage: https://github.com/geraldb/logutils
 licenses: 
 - Public Domain