tagged_logging 0.1.0

data/.gitignore

@@ -0,0 +1,16 @@
+*.rbc
+.bundle
+bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1 @@
+rvm ruby-1.9.2-p290@go-saas-commons

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+bundler_args: --local
+env:
+  - "TESTOPTS=-v"

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    tagged_logging (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    multi_json (1.3.4)
+    rake (0.9.2.2)
+    simplecov (0.6.2)
+      multi_json (~> 1.3)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    test-unit (2.4.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake
+  simplecov
+  tagged_logging!
+  test-unit

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 ThoughtWorks, Inc.
+
+MIT License
+
+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,98 @@
+# TaggedLogging
+
+The rails tagged logger is awesome, but it's only available in rails. This gem makes it available for non-rails applications
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tagged_logging'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tagged_logging
+
+## Usage
+
+```{ruby}
+    class MyApplication
+      include TaggedLogging
+      push_tags(MyApplication, Process.pid)
+
+      def initialize
+        info('Initializing application')
+      end
+
+      def perform
+        tagged("Perform") do
+          info("performing some task")
+        end
+      end
+
+      at_exit do
+        info('Exiting application')
+      end
+    end
+
+    app = MyApplication.new
+    app.perform
+```
+
+The above will print the following:
+
+    [2012-12-15T14:52:10+05:30] - INFO - [MyApplication] [11321] - Initializing application
+    [2012-12-15T14:52:10+05:30] - INFO - [MyApplication] [11321] [Perform] - performing some task
+    [2012-12-15T14:52:10+05:30] - INFO - [MyApplication] [11321] - Exiting application
+
+If you'd rather prefer to not pollute your class with the logger methods:
+```{ruby}
+  class MyApplication
+    class MyLogger
+      include TaggedLogging
+    end
+
+    class <<self
+      attr_accessor :logger
+    end
+
+    def logger
+      self.class.logger
+    end
+
+    self.logger = MyLogger
+    logger.push_tags(MyApplication, Process.pid)
+
+    def initialize
+      logger.info('Initializing application')
+    end
+
+    def perform
+      logger.tagged("Perform") do
+        logger.info("performing some task")
+      end
+    end
+
+    at_exit do
+      logger.info('Exiting application')
+    end
+  end
+
+  app = MyApplication.new
+  app.perform
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+# License
+
+MIT License (see the LICENSE file)

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+desc "run tests"
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/lib/tagged_logging/blank_ext.rb

@@ -0,0 +1,119 @@
+#Copied from ActiveSupport
+class Object
+  # An object is blank if it's false, empty, or a whitespace string.
+  # For example, "", "   ", +nil+, [], and {} are all blank.
+  #
+  # This simplifies:
+  #
+  #   if address.nil? || address.empty?
+  #
+  # ...to:
+  #
+  #   if address.blank?
+  unless method_defined? :blank?
+    def blank?
+      respond_to?(:empty?) ? empty? : !self
+    end
+  end
+end
+
+class NilClass
+  # +nil+ is blank:
+  #
+  #   nil.blank? # => true
+  #
+  unless method_defined? :blank?
+    def blank?
+      true
+    end
+  end
+end
+
+class FalseClass
+  # +false+ is blank:
+  #
+  #   false.blank? # => true
+  #
+  unless method_defined? :blank?
+    def blank?
+      true
+    end
+  end
+end
+
+class TrueClass
+  # +true+ is not blank:
+  #
+  #   true.blank? # => false
+  #
+  unless method_defined? :blank?
+    def blank?
+      false
+    end
+  end
+end
+
+class Array
+  # An array is blank if it's empty:
+  #
+  #   [].blank?      # => true
+  #   [1,2,3].blank? # => false
+  #
+  unless method_defined? :blank?
+    alias_method :blank?, :empty?
+  end
+end
+
+class Hash
+  # A hash is blank if it's empty:
+  #
+  #   {}.blank?                # => true
+  #   {:key => 'value'}.blank? # => false
+  #
+  unless method_defined? :blank?
+    alias_method :blank?, :empty?
+  end
+end
+
+class String
+  if defined?(Encoding) && "".respond_to?(:encode)
+    def encoding_aware?
+      true
+    end
+  else
+    def encoding_aware?
+      false
+    end
+  end
+  # 0x3000: fullwidth whitespace
+  NON_WHITESPACE_REGEXP = %r![^\s#{[0x3000].pack("U")}]!
+
+  # A string is blank if it's empty or contains whitespaces only:
+  #
+  #   "".blank?                 # => true
+  #   "   ".blank?              # => true
+  #   "　".blank?               # => true
+  #   " something here ".blank? # => false
+  #
+  def blank?
+    # 1.8 does not takes [:space:] properly
+    if encoding_aware?
+      self !~ /[^[:space:]]/
+    else
+      self !~ NON_WHITESPACE_REGEXP
+    end
+  end
+end
+
+class Numeric #:nodoc:
+  # No number is blank:
+  #
+  #   1.blank? # => false
+  #   0.blank? # => false
+  #
+  unless method_defined? :blank?
+    def blank?
+      false
+    end
+  end
+end

data/lib/tagged_logging/formatter.rb

@@ -0,0 +1,54 @@
+require 'time'
+module TaggedLogging
+  class Formatter < ::Logger::Formatter
+
+    FORMAT = "[%s] - %4s - %s - %s\n"
+
+    def call(severity, time, progname, msg)
+      str = case msg
+            when ::String
+              msg
+            when ::Exception
+              "#{ msg.message } (#{ msg.class })\n    | " <<
+                (msg.backtrace || []).join("\n    | ")
+            else
+              msg.inspect
+            end
+      FORMAT % [format_datetime(time), severity, tags_text, msg]
+    end
+
+    def push_tags(*tags)
+      tags.flatten.reject(&:blank?).tap do |new_tags|
+        current_tags.concat new_tags
+      end
+    end
+
+    def pop_tags(size = 1)
+      current_tags.pop size
+    end
+
+    def clear_tags!
+      current_tags.clear
+    end
+
+    def current_tags
+      Thread.current[:__tagged_logging_current_tags] ||= []
+    end
+
+    def tags_text
+      tags = current_tags
+      if tags.any?
+        tags.collect { |tag| "[#{tag}] " }.join.strip
+      end
+    end
+
+    private
+    def format_datetime(time)
+      if @datetime_format.nil?
+        time.iso8601
+      else
+        time.strftime(@datetime_format)
+      end
+    end
+  end
+end

data/lib/tagged_logging/logger.rb

@@ -0,0 +1,61 @@
+require 'logger'
+
+module TaggedLogging
+  def self.included(receiver)
+    receiver.class_eval do
+      extend                ClassMethods
+      include               InstanceMethods
+    end
+  end
+
+  module ClassMethods
+    def tagged(*new_tags, &block)
+      new_tags = push_tags(*new_tags)
+      yield(self)
+    ensure
+      pop_tags(new_tags.size)
+    end
+
+    [:push_tags, :pop_tags, :clear_tags!].each do |method_name|
+      define_method(method_name) do |*args, &block|
+        logger.formatter.send(method_name, *args, &block)
+      end
+    end
+
+    def logger
+      @@logger ||= ::Logger.new(STDOUT).tap do |l|
+        l.level = ::Logger::INFO
+        l.formatter = ::TaggedLogging::Formatter.new
+      end
+    end
+
+    def logger=(logger)
+      @@logger = logger
+    end
+
+    def flush
+      clear_tags!
+      logger.flush if defined?(logger.super)
+    end
+
+    [:debug, :info, :warn, :error, :fatal].each do |method_name|
+      define_method(method_name) do |*args, &block|
+        self.logger.send(method_name, *args, &block)
+      end
+    end
+  end
+
+  module InstanceMethods
+    [:debug, :info, :warn, :error, :fatal].each do |method_name|
+      define_method(method_name) do |*args, &block|
+        self.class.logger.send(method_name, *args, &block)
+      end
+    end
+
+    [:tagged, :flush, :logger, :logger=, :push_tags, :pop_tags, :clear_tags!].each do |method_name|
+      define_method(method_name) do |*args, &block|
+        self.class.send(method_name, *args, &block)
+      end
+    end
+  end
+end

data/lib/tagged_logging/version.rb

@@ -0,0 +1,8 @@
+module TaggedLogging
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+    VERSION = [MAJOR, MINOR, PATCH].compact.join('.')
+  end
+end

data/lib/tagged_logging.rb

@@ -0,0 +1,6 @@
+require "tagged_logging/version"
+require "tagged_logging/logger"
+
+module TaggedLogging
+  # Your code goes here...
+end

data/tagged_logging.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/tagged_logging/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Ketan Padegaonkar"]
+  gem.email         = ["KetanPadegaonkar@gmail.com"]
+  gem.description   = %q{Provides a rails style TaggedLogging for ruby apps}
+  gem.summary       = %q{Provides a rails style TaggedLogging for ruby apps}
+  gem.homepage      = "https://github.com/ketan/tagged-logger"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "tagged_logging"
+  gem.require_paths = ["lib"]
+  gem.version       = TaggedLogging::Version::VERSION
+
+  gem.add_development_dependency 'test-unit'
+  gem.add_development_dependency "simplecov"
+  gem.add_development_dependency 'rake'
+end

data/test/logger_test.rb

@@ -0,0 +1,103 @@
+require 'test_helper'
+require 'tagged_logging/formatter'
+require 'tagged_logging/blank_ext'
+
+class LoggerTest < Test::Unit::TestCase
+
+  class MyLogger
+    include TaggedLogging
+  end
+
+  setup do
+    @output = StringIO.new
+    @logger = MyLogger
+    @logger.logger    = ::Logger.new(@output)
+    @logger.logger.formatter = TaggedLogging::Formatter.new
+    @logger.flush
+  end
+
+  test "tagged once" do
+    @logger.tagged("BCX") { @logger.info "Funky time" }
+    assert_match "INFO - [BCX] - Funky time\n", @output.string
+  end
+
+  test "tagged twice" do
+    @logger.tagged("BCX") { @logger.tagged("Jason") { @logger.info "Funky time" } }
+    assert_match "INFO - [BCX] [Jason] - Funky time\n", @output.string
+  end
+
+  test "tagged thrice at once" do
+    @logger.tagged("BCX", "Jason", "New") { @logger.info "Funky time" }
+    assert_match "INFO - [BCX] [Jason] [New] - Funky time", @output.string
+  end
+
+  test "tagged are flattened" do
+    @logger.tagged("BCX", %w(Jason New)) { @logger.info "Funky time" }
+    assert_match "[BCX] [Jason] [New] - Funky time", @output.string
+  end
+
+  test "provides access to the logger instance" do
+    @logger.tagged("BCX") { |logger| logger.info "Funky time" }
+    assert_match "[BCX] - Funky time", @output.string
+  end
+
+  test "push and pop tags directly" do
+    assert_equal %w(A B C), @logger.push_tags('A', ['B', '  ', ['C']])
+    @logger.info 'a'
+    assert_equal %w(C), @logger.pop_tags
+    @logger.info 'b'
+    assert_equal %w(B), @logger.pop_tags(1)
+    @logger.info 'c'
+    assert_equal [], @logger.clear_tags!
+    @logger.info 'd'
+
+    assert_match "INFO - [A] [B] [C] - a", @output.string
+    assert_match "INFO - [A] [B] - b", @output.string
+    assert_match "INFO - [A] - c", @output.string
+    assert_match "INFO -  - d", @output.string
+  end
+
+  test "does not strip message content" do
+    @logger.info " \t\t Hello"
+    assert_match "INFO -  -  \t\t Hello\n", @output.string
+  end
+
+  test "tagged once with blank and nil" do
+    @logger.tagged(nil, "", "New") { @logger.info "Funky time" }
+    assert_match "INFO - [New] - Funky time", @output.string
+  end
+
+  test "keeps each tag in their own thread" do
+    @logger.tagged("BCX") do
+      Thread.new do
+        @logger.tagged("OMG") { @logger.info "Cool story bro" }
+      end.join
+      @logger.info "Funky time"
+    end
+    assert_match "INFO - [OMG] - Cool story bro", @output.string
+    assert_match "INFO - [BCX] - Funky time\n", @output.string
+  end
+
+  test "cleans up the taggings on flush" do
+    @logger.tagged("BCX") do
+      Thread.new do
+        @logger.tagged("OMG") do
+          @logger.flush
+          @logger.info "Cool story bro"
+        end
+      end.join
+    end
+    assert_match "INFO -  - Cool story bro", @output.string
+  end
+
+  test "mixed levels of tagging" do
+    @logger.tagged("BCX") do
+      @logger.tagged("Jason") { @logger.info "Funky time" }
+      @logger.info "Junky time!"
+    end
+
+    assert_match "INFO - [BCX] [Jason] - Funky time", @output.string
+    assert_match "INFO - [BCX] - Junky time!", @output.string
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/.bundle/"
+  add_filter "/bundle/"
+end
+
+Bundler.require
+require 'test/unit'

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: tagged_logging
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Ketan Padegaonkar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides a rails style TaggedLogging for ruby apps
+email:
+- KetanPadegaonkar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/tagged_logging.rb
+- lib/tagged_logging/blank_ext.rb
+- lib/tagged_logging/formatter.rb
+- lib/tagged_logging/logger.rb
+- lib/tagged_logging/version.rb
+- tagged_logging.gemspec
+- test/logger_test.rb
+- test/test_helper.rb
+- vendor/cache/multi_json-1.3.4.gem
+- vendor/cache/rake-0.9.2.2.gem
+- vendor/cache/simplecov-0.6.2.gem
+- vendor/cache/simplecov-html-0.5.3.gem
+- vendor/cache/test-unit-2.4.8.gem
+homepage: https://github.com/ketan/tagged-logger
+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: Provides a rails style TaggedLogging for ruby apps
+test_files:
+- test/logger_test.rb
+- test/test_helper.rb