simplelogger 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 [vkhatri (Virender Khatri)](http://github.com/vkhatri)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,95 @@
+simplelogger
+============
+
+simplelogger is a simple Ruby file & console message logger 
+
+
+* Log messages to file, console, STDOUT, STDERR, ..
+* Log levels are standard in addition of few new
+* Support uuencoded message logging
+* Logs different message severity with different color coding 
+
+
+## Install
+
+    sudo gem install simplelogger
+
+## Getting Started
+
+    require 'rubygems'
+    require 'simplelogger'
+
+    options = {:file => 'lof_file_name', options ..}
+    log = Simplelogger.new(options)
+    log.info "message"
+    log.warning "message"
+    log.error "message"
+    log.fatal "message"
+    log.debug "message"
+    log.notice "message"
+    log.success "message"
+    log.fail "message"
+    log.underscore 'underscore message'
+    
+    # Print console message with color using Term::Ansicolor 
+    puts log.color.red 'i am red'
+    
+    log.stdout 'standard output'
+    log.stderr 'standard error output'
+    log._puts 'just puts'
+    log._print 'just print'
+		
+    log.close
+
+## Options
+
+    :file => string
+        log file name
+
+    :program_name => string
+        program name
+
+    :enable_debug => boolean
+        display and log debug messages, default no logging to console & file
+
+    :enable_nocolor => boolean
+        disable colorful messages on console, default enabled
+
+    :enable_verbose => boolean
+        display messages on console (except debug), default messages are only logged to the log file
+
+    :enable_uuencode => boolean
+        uuencode log messages
+
+    :time_format => string
+        user time format, e.g. "%Y-%m-%d_%H-%M-%S", default set to iso8601
+
+    :console_style => string
+        'full' -> display full log message on console
+        'message' -> display log level + log message on console
+        default set to 'full'
+
+
+## Copyright
+
+The MIT License (MIT)
+
+Copyright (c) 2013 [vkhatri (Virender Khatri)](http://github.com/vkhatri)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/lib/simplelogger.rb

@@ -0,0 +1,191 @@
+# Author: vkhatri (Virender Khatri)
+#
+# Description: A Simple Ruby Logger module with colorful console logging support 
+#
+
+
+require 'rubygems'
+require 'term/ansicolor'
+require 'time'
+require 'etc'
+
+class Simplelogger
+
+  attr_reader :hostname, :color, :logfile, :options, :user
+  attr_accessor :enable_verbose, :enable_debug, :enable_nocolor, :enable_uuencode, :console_style, :time_format, :program_name
+
+  def initialize(opts = {})
+    # Options:
+    #   :file => string
+    #     log file name
+    #   :program_name => string
+    #     program name
+    #   :enable_debug => boolean
+    #     display and log debug messages, default no logging to console & file
+    #   :enable_nocolor => boolean
+    #     disable colorful messages on console, default enabled
+    #   :enable_verbose => boolean
+    #     display messages on console (except debug), default messages are only logged to the log file
+    #   :enable_uuencode => boolean
+    #     uuencode log messages
+    #   :time_format => string
+    #     user time format, e.g. "%Y-%m-%d_%H-%M-%S", default set to iso8601
+    #
+    #   :console_style => string 
+    #     'full' -> display full log message on console
+    #     'message' -> display log level + log message on console
+    #     default set to 'full'
+    #   
+
+    raise "missing :file option" if not opts[:file]
+    @logfile = File.new(opts[:file], "a") ; @logfile.sync = true
+
+    @options = opts
+    @color = Term::ANSIColor
+    $stdout.sync = true
+    @hostname = ENV['HOSTNAME'] || 'unknown_hostname'
+    @user = Etc.getlogin || 'unknown_user'
+
+    @time_format = opts[:time_format]
+    @program_name = opts[:program_name] || 'unknown_program'
+    @console_style = opts[:console_style] || 'full'
+    @enable_verbose = opts[:enable_verbose]
+    @enable_debug = opts[:enable_debug]
+    @enable_uuencode = opts[:enable_uuencode]
+    @enable_nocolor = opts[:enable_nocolor]
+  end
+
+  def close
+    logfile.close if logfile.closed?
+  end
+
+  def current_time
+    if time_format
+      Time.new.strftime(time_format)
+    else
+      Time.now.iso8601(5)
+    end
+  end
+
+  def uuencode(string)
+    if enable_uuencode
+      [string].pack("u")
+    else
+      string
+    end
+  end
+
+  def log(level, string)
+    string = uuencode(string)
+    message = "#{current_time} #{hostname} #{user} #{program_name} #{level}: #{string}"
+    logfile.puts message
+    message = "#{level}: #{string}" if console_style == 'message'
+    if enable_verbose
+      if enable_nocolor
+        puts message
+      else
+        case level
+        when 'INFO'
+          puts color.green message
+        when 'WARNING'
+          puts color.yellow message
+        when 'ERROR'
+          puts color.red message
+        when 'FATAL'
+          puts color.red message
+        when 'NOTICE'
+          puts color.blue message
+        when 'INIT'
+          puts color.bold(color.blue(message))
+        when 'SUCCESS'
+          puts color.green message
+        when 'FAILURE'
+          puts color.red message
+        else
+          puts message
+        end
+      end
+    end
+  end
+
+  def info(string)
+    string = uuencode(string)
+    log('INFO',string)
+  end
+
+  def debug(string)
+    # Default debug messages are not logged, kept it out of 'log'
+    if enable_debug
+      string = uuencode(string)
+      message = "#{current_time} #{hostname} #{user} #{program_name} DEBUG: #{string}"
+      logfile.puts message
+      message = "DEBUG: #{string}" if console_style == 'message'
+      if enable_nocolor
+        puts messages
+      else
+        puts color.magenta message
+      end
+    end 
+  end
+
+  def warning(string)
+    string = uuencode(string)
+    log('WARNING',string)
+  end
+
+  def error(string)
+    string = uuencode(string)
+    log('ERROR',string)
+  end
+
+  def fatal(string)
+    string = uuencode(string)
+    log('FATAL',string)
+  end
+
+  def notice(string)
+    string = uuencode(string)
+    log('NOTICE',string)
+  end
+
+  def init(string)
+    string = uuencode(string)
+    log('INIT',string)
+  end
+
+  def success(string)
+    string = uuencode(string)
+    log('SUCCESS',string)
+  end
+
+  def fail(string)
+    string = uuencode(string)
+    log('FAILURE',string)
+  end
+
+  def underscore(string)
+    string = uuencode(string)
+    puts color.underscore string
+  end
+
+  def stderr(string)
+    string = uuencode(string)
+    $stderr.write string
+  end
+
+  def stdout(string)
+    string = uuencode(string)
+    $stdout.write string
+  end
+
+  def _puts(string)
+    string = uuencode(string)
+    puts string
+  end
+
+  def _print(string)
+    string = uuencode(string)
+    print string
+  end
+
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: simplelogger
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- vkhatri (Virender Khatri)
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-11-04 00:00:00 +05:30
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: term-ansicolor
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Simple Ruby module to log messages to file & console
+email: vir.khatri@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- LICENSE
+- lib/simplelogger.rb
+has_rdoc: true
+homepage: https://github.com/vkhatri/simplelogger
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Ruby File/Console Message Logger
+test_files: []
+