cologger 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Peng Sun
+
+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,65 @@
+#Cologger
+*Add some color to your logs!*
+
+## Installation
+This utils is packed as a gem, so, simply run `gem install cologger` to install it. 
+
+Current version is 0.1.0
+
+## Usage
+Using cologger is quite easy && straight forward.
+
+Start by creating a new logger
+
+```
+logger = Cologger.new
+```
+
+Next, set the log level you want. By default, cologger outputs all the logs to your console, which means setting the level to `LEVEL_DEBUG`. For more info about level, check out the `Log levels` section below.
+
+```
+logger.log_level = Cologger.LEVEL_DEBUG
+```
+
+After that, you can start logging. For example, 
+
+```
+logger.fatal "universe", "the world is crashing"
+logger.error "brain", "what is going on here?"
+logger.warn "road", "watch your step sir"
+logger.info "FYI", "the big bang theory is funny"
+logger.debug "program", "anything still working?"
+```
+
+And, here's what you got:
+
+![colorful log](Screenshot.png)
+
+## Log
+The first parameter of any log method, like the `universe` in the `fatal` log above, is taken as a tag, the other strings, concated by a space character, is treated as the log content.
+
+## Log levels
+Same as ruby `logger`, there are 5 levels. Namely, 
+
+- FATAL, an unhandleable error that results in a program crash
+- ERROR, a handleable error condition
+- WARN, a warning
+- INFO, generic (useful) information about system operation
+- DEBUG, low-level information for developers
+
+The levels are ordered desendingly according to thier level of importance.
+
+## TODO
+- Support file as output dev
+- Customize log format
+- Customize log level color
+
+
+## Dependency
+
+This gem depends on the cute [`colored' gem](https://github.com/defunkt/colored)  by [defunk](https://github.com/defunkt). 
+
+Thanks sir!
+
+## Change log
+- 0.1.0, initial version. 

data/lib/cologger.rb

@@ -0,0 +1,76 @@
+require 'colored'
+require 'date'
+
+# Extending ruby's logger by adding some color in it!
+#
+class Cologger
+
+  # an unhandleable error that results in a program crash
+  LEVEL_FATAL = 0
+
+  # a handleable error condition
+  LEVEL_ERROR = 1
+
+  # a warning
+  LEVEL_WARN  = 2
+
+  # generic (useful) information about system operation
+  LEVEL_INFO  = 3
+
+  # low-level information for developers
+  LEVEL_DEBUG = 4
+
+  # fatal in red
+  COLOR_FATAL = 'red'
+
+  # error in magenta
+  COLOR_ERROR = 'magenta'
+
+  # warn in yellow
+  COLOR_WARN  = 'yellow'
+
+  # info in green
+  COLOR_INFO  = 'green'
+
+  # debug in cyan
+  COLOR_DEBUG = 'cyan'
+
+  attr_accessor :log_level
+
+  def initialize
+    @log_level = LEVEL_DEBUG # default to log everything
+  end
+
+  def method_missing(method, *args, &block)
+    if respond_to? method
+      log(method, *args)
+    end
+  end
+
+  def respond_to? (method, include_all=false)
+    Cologger.constants.include? sym_for(method, "LEVEL")
+  end
+
+  private
+  def sym_for method, prefix = nil
+    str = "#{method.to_s.upcase}"
+    str = "#{prefix}_#{str}" if prefix
+    str.to_sym
+  end
+
+  def log(method, *args)
+    level = Cologger.const_get(sym_for method, "LEVEL")
+    color = Cologger.const_get(sym_for method, "COLOR")
+
+    return unless level <= @log_level
+
+    tag, *content_array = args
+    content = content_array.join(" ")
+    log  = "#{sym_for method} "
+    log += "[#{DateTime.now.iso8601}] "
+    log += "[#{tag}] #{content}"
+
+    puts log.send(color) # TODO fixme!
+  end
+
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: cologger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Peng Sun
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colored
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: colored
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: ! "  Simple log util that adds some colors to your logs.\n\n  For more
+  information, please visit 'https://github.com/void-main/Cologger'\n"
+email: voidmain1313113@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- LICENSE
+- lib/cologger.rb
+homepage: http://github.com/void-main/Cologger
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Log with color!
+test_files: []