entity_logger 0.0.1

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.swp
+*.swo
+*.log

data/.rspec

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 m.filippovich
+
+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,48 @@
+# EntityLogger
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'entity_logger'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install entity_logger
+
+## Usage
+```ruby
+require 'entity_logger'
+
+class Entity
+  include EntityLogger::Mixin
+
+  log Logger.new(STDOUT), 'Prefix', :some_attr, or_lambda: lambda { |e| e.some_attr + e.some_attr1 }
+
+  def some_attr
+    'Some attr'
+  end
+
+  def some_attr1
+    1
+  end
+end
+
+entity = Entity.new
+entity.info 'Some log message'
+# Prefix [Some attr] [Some attr1] Some log message
+```
+
+## 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

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/entity_logger.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/entity_logger/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["m.filippovich"]
+  gem.email         = ["fatumka@gmail.com"]
+  gem.description   = %q{Entity logger}
+  gem.summary       = %q{Extend entity with tag logging}
+  gem.homepage      = "http://twitter.com/mfilippovich"
+
+  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          = "entity_logger"
+  gem.require_paths = ["lib"]
+  gem.version       = EntityLogger::VERSION
+
+  gem.add_dependency 'activesupport', '>= 3.0'
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'rake'
+end

data/lib/entity_logger/mixin.rb

@@ -0,0 +1,56 @@
+require 'active_support/concern'
+require 'active_support/core_ext/class'
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/class/attribute'
+require 'active_support/deprecation'
+require 'entity_logger/tagged_logging'
+
+module EntityLogger
+  module Mixin
+    extend ActiveSupport::Concern
+
+    included do
+      def self.log(*attrs)
+        self.logger_writer = attrs.shift
+        self.prefix = attrs.shift
+        self.tags_for_logging = attrs
+      end
+
+    private
+      class_attribute :tags_for_logging, :logger_writer, :prefix
+    end
+
+    def log_with_tags(&block)
+      tags = extract_tags(self.tags_for_logging)
+      logger.tagged(tags) { yield } if tags
+    end
+
+    def logger
+      EntityLogger::TaggedLogging.new(self.logger_writer, self.prefix)
+    end
+
+    %w(info error debug).each do |level|
+      define_method(level) do |msg|
+        tags = extract_tags(self.tags_for_logging)
+
+        if tags
+          logger.tagged(tags) { logger.send(level, msg) }
+        else
+          logger.send(level, msg)
+        end
+      end
+    end
+
+  private
+    def extract_tags(attrs)
+      attrs.map do |attr|
+        case attr
+        when Hash
+          attr.values.first.call(self)
+        else
+          send(attr)
+        end
+      end
+    end
+  end
+end

data/lib/entity_logger/tagged_logging.rb

@@ -0,0 +1,81 @@
+require 'active_support/core_ext/object/blank'
+require 'active_support/deprecation'
+require 'active_support/buffered_logger'
+require 'logger'
+
+module EntityLogger
+  # Wraps any standard Logger class to provide tagging capabilities. Examples:
+  #
+  #   Logger = ActiveSupport::TaggedLogging.new(Logger.new(STDOUT))
+  #   Logger.tagged("BCX") { Logger.info "Stuff" }                            # Logs "[BCX] Stuff"
+  #   Logger.tagged("BCX", "Jason") { Logger.info "Stuff" }                   # Logs "[BCX] [Jason] Stuff"
+  #   Logger.tagged("BCX") { Logger.tagged("Jason") { Logger.info "Stuff" } } # Logs "[BCX] [Jason] Stuff"
+  #
+  # This is used by the default Rails.logger as configured by Railties to make it easy to stamp log lines
+  # with subdomains, request ids, and anything else to aid debugging of multi-user production applications.
+  class TaggedLogging
+    def initialize(logger, prefix)
+      @logger, @prefix = logger, prefix
+    end
+
+    def tagged(*tags)
+      new_tags = push_tags(*tags)
+      yield self
+    ensure
+      pop_tags(new_tags.size)
+    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 silence(temporary_level = Logger::ERROR, &block)
+      @logger.silence(temporary_level, &block)
+    end
+    deprecate :silence
+
+    def add(severity, message = nil, progname = nil, &block)
+      message = (block_given? ? block.call : progname) if message.nil?
+      @logger.add(severity, "#{@prefix} #{tags_text}#{message}", progname)
+    end
+
+    %w( fatal error warn info debug unknown ).each do |severity|
+      eval <<-EOM, nil, __FILE__, __LINE__ + 1
+        def #{severity}(progname = nil, &block)
+          add(Logger::#{severity.upcase}, nil, progname, &block)
+        end
+      EOM
+    end
+
+    def flush
+      clear_tags!
+      @logger.flush if @logger.respond_to?(:flush)
+    end
+
+    def method_missing(method, *args)
+      @logger.send(method, *args)
+    end
+
+    private
+      def tags_text
+        tags = current_tags
+        if tags.any?
+          tags.collect { |tag| "[#{tag}] " }.join
+        end
+      end
+
+      def current_tags
+        Thread.current[:activesupport_tagged_logging_tags] ||= []
+      end
+  end
+end

data/lib/entity_logger/version.rb

@@ -0,0 +1,3 @@
+module EntityLogger
+  VERSION = "0.0.1"
+end

data/lib/entity_logger.rb

@@ -0,0 +1,5 @@
+require "entity_logger/version"
+require 'entity_logger/mixin'
+
+module EntityLogger
+end

data/spec/entity_logger_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe EntityLogger do
+  class EntityClass2
+    include EntityLogger::Mixin
+
+    log Logger.new(STDOUT), 'Prefix', :attr22
+  end
+
+  class EntityClass
+    include EntityLogger::Mixin
+
+    log Logger.new(STDOUT), 'Prefix',
+    :attr1, :attr1, :attr3 => lambda { |e| e.attr1 + e.attr2 }
+
+    def attr1
+      'test1'
+    end
+
+    def attr2
+      'test2'
+    end
+  end
+
+  describe "#log_with_tags" do
+    it 'should wrap inner log call with tags' do
+      obj = EntityClass.new
+      obj.log_with_tags { obj.logger.info('test') }.should be_true
+    end
+  end
+
+  %w(info debug error).each do |level|
+    it "should receive logger method: #{level}" do
+      obj = EntityClass.new
+      EntityLogger::TaggedLogging.any_instance.should_receive(level.to_sym).with('Test')
+      obj.send(level, 'Test')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'rubygems'
+require 'bundler/setup'
+
+Bundler.require
+
+require 'pry'
+require 'entity_logger'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: entity_logger
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- m.filippovich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: pry
+  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: Entity logger
+email:
+- fatumka@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- entity_logger.gemspec
+- lib/entity_logger.rb
+- lib/entity_logger/mixin.rb
+- lib/entity_logger/tagged_logging.rb
+- lib/entity_logger/version.rb
+- spec/entity_logger_spec.rb
+- spec/spec_helper.rb
+homepage: http://twitter.com/mfilippovich
+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'
+      segments:
+      - 0
+      hash: -983180373507418601
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -983180373507418601
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Extend entity with tag logging
+test_files:
+- spec/entity_logger_spec.rb
+- spec/spec_helper.rb