coloured_logger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 923b9a83f70092681c1c512aab5a6064e10393be
+  data.tar.gz: 78ec6f7454b9a86ea9b9757c9e7193cc61040b72
+SHA512:
+  metadata.gz: 6ad9df360686fcfee8367f8c46dde5bb70ab31e74f082c64f6e07fecc5cca177bbe0ccd5905007ef05a7ea2330cb793f8492b806135c829181e69b4c78f1a72f
+  data.tar.gz: e363765d799eecc8a95554fee499462431c43043e857ef6030ca024ecf65727c69a61c5b330260d799a487a5ff68dea7b59558daab8d8c7912dc9791b8e1ad74

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.1
+before_install: gem install bundler -v 1.10.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in coloured_logger.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Sushma Satish
+
+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,50 @@
+# ColouredLogger
+
+Coloured Logger provides a handy way to colorize your logs based on the log severity: (debug, info, warn, error, fatal, unknown, perf)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'coloured_logger'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install coloured_logger
+
+## Usage
+
+```ruby
+ColouredLogger::CLogger.debug("method_or_task_name","message to be logged")
+ColouredLogger::CLogger.info("method_or_task_name","message to be logged")
+ColouredLogger::CLogger.warn("method_or_task_name","message to be logged")
+ColouredLogger::CLogger.error("method_or_task_name","message to be logged")
+ColouredLogger::CLogger.fatal("method_or_task_name","message to be logged")
+ColouredLogger::CLogger.unknown("method_or_task_name","message to be logged")
+start_time = Time.now.ago(10.minute)
+ColouredLogger::CLogger.log_time("method_or_task_name",start_time,"to finish job")
+```
+
+![alt tag](https://github.com/sushmasatish/coloured_logger/blob/master/docs/demo_output.png)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sushmasatish/coloured_logger.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "coloured_logger"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/coloured_logger.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'coloured_logger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "coloured_logger"
+  spec.version       = ColouredLogger::VERSION
+  spec.authors       = ["Sushma Satish"]
+  spec.email         = ["sushmasatish@gmail.com"]
+
+  spec.summary       = %q{Provides a handy tool to colorize logs.}
+  spec.description   = %q{Using coloured logger, now all your logs are coloured based on their severity.}
+  spec.homepage      = "https://github.com/sushmasatish/coloured_logger"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.4"
+  spec.add_development_dependency "rspec"
+end

data/lib/coloured_logger.rb

@@ -0,0 +1,74 @@
+require 'singleton'
+require 'active_support/all'
+require 'coloured_logger/version'
+require 'coloured_logger/logger'
+
+module ColouredLogger
+  class CLogger
+    include Singleton
+
+    attr_reader :logger
+
+    SEVERITY_TO_COLOR_MAP = {'DEBUG'=>'36', 'INFO'=>'32', 'WARN'=>'33', 'ERROR'=>'31', 'FATAL'=>'31', 'UNKNOWN'=>'37', 'PERF'=>'35'}
+    SEVERITY_TO_BACKGROUND_COLOR_MAP = {'DEBUG'=>'0', 'INFO'=>'0', 'WARN'=>'0', 'ERROR'=>'0', 'FATAL'=>'103', 'UNKNOWN'=>'0', 'PERF'=>'0'}
+
+      def initialize
+      @logger = Logger.new(STDOUT)
+      # Logger.LEVEL = DEBUG - logs all levels, INFO - would not log debug level.
+      @logger.level = Logger::DEBUG
+      @logger.formatter = proc do |severity, time, progname, msg|
+            formatted_severity = sprintf("%-5s",severity.to_s)
+            formatted_time = sprintf("[%s]", time.strftime("%Y-%m-%d %H:%M:%S"))
+            date_color ='1;34'
+            severity_color = SEVERITY_TO_COLOR_MAP[severity]
+            background_color = SEVERITY_TO_BACKGROUND_COLOR_MAP[severity]
+            "\033[#{date_color}m#{formatted_time} \033[#{background_color};#{severity_color}m#{formatted_severity}\033[0m-- #{msg.to_s.strip}\n"
+        end
+    end
+
+    def formatted_method(method)
+      sprintf("%-20s", method)
+    end
+
+    # low-level information for developers
+    def self.debug(method, message)
+      formatted_method = CLogger.instance.formatted_method(method)
+      CLogger.instance.logger.debug("#{formatted_method}: #{message}")
+    end
+
+    # generic (useful) information about system operation
+    def self.info(method, message)
+      formatted_method = CLogger.instance.formatted_method(method)
+      CLogger.instance.logger.info("#{formatted_method}: #{message}")
+    end
+
+    def self.warn(method, message)
+      formatted_method = CLogger.instance.formatted_method(method)
+      CLogger.instance.logger.warn("#{formatted_method}: #{message}")
+    end
+
+    def self.error(method, message)
+      formatted_method = CLogger.instance.formatted_method(method)
+      CLogger.instance.logger.error("#{formatted_method}: #{message}")
+    end
+
+    def self.fatal(method, message)
+      formatted_method = CLogger.instance.formatted_method(method)
+      CLogger.instance.logger.fatal("#{formatted_method}: #{message}")
+    end
+
+    def self.unknown(method, message)
+      formatted_method = CLogger.instance.formatted_method(method)
+      CLogger.instance.logger.unknown("#{formatted_method}: #{message}")
+    end
+
+    # Logs time taken to execute a task
+    def self.log_time(method, start_time, task_name)
+      end_time = Time.now
+      formatted_method = CLogger.instance.formatted_method(method)
+      time_taken = end_time - start_time
+      formatted_time_taken = sprintf("[%.4f sec]", time_taken)
+      CLogger.instance.logger.perf("#{formatted_method}: Time taken to #{task_name} - \033[35m#{formatted_time_taken}\033[0m")
+    end
+  end
+end

data/lib/coloured_logger/logger.rb

@@ -0,0 +1,15 @@
+require 'logger'
+
+class Logger
+  def self.custom_level(tag)
+    SEV_LABEL << tag
+    idx = SEV_LABEL.size - 1
+
+    define_method(tag.downcase.gsub(/\W+/, '_').to_sym) do |progname, &block|
+      add(idx, nil, progname, &block)
+    end
+  end
+
+# Adding PERF custom level
+  custom_level 'PERF'
+end

data/lib/coloured_logger/version.rb

@@ -0,0 +1,3 @@
+module ColouredLogger
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: coloured_logger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sushma Satish
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Using coloured logger, now all your logs are coloured based on their
+  severity.
+email:
+- sushmasatish@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- coloured_logger.gemspec
+- docs/demo_output.png
+- lib/coloured_logger.rb
+- lib/coloured_logger/logger.rb
+- lib/coloured_logger/version.rb
+homepage: https://github.com/sushmasatish/coloured_logger
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Provides a handy tool to colorize logs.
+test_files: []