taglog 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ryo Nakamura
+
+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,77 @@
+# Taglog
+Taglog provides taggable logger extension to any class which has `#logger` method.
+
+## Installation
+```
+$ gem install taglog
+```
+
+## Usage
+
+### Basic
+```ruby
+# a class which has `#logger` method
+class A
+  def hello
+    logger.debug("hello")
+  end
+
+  def log
+    io.string
+  end
+
+  private
+
+  def logger
+    @logger ||= Logger.new(io)
+  end
+
+  def io
+    @io ||= StringIO.new
+  end
+end
+
+# extend class A with Taglog
+A.extend Taglog.new("class A")
+
+# use logger
+a = A.new
+a.hello
+a.hello
+a.hello
+puts a.log
+```
+
+```
+D, [2012-12-11T00:16:03.032614 #679] DEBUG -- : [class A] hello
+D, [2012-12-11T00:16:03.252622 #679] DEBUG -- : [class A] hello
+D, [2012-12-11T00:16:03.680119 #679] DEBUG -- : [class A] hello
+```
+
+### Rails
+```ruby
+# Gemfile
+group :development do
+  gem "taglog"
+end
+```
+
+```ruby
+# config/environments/development.rb
+require "active_record/log_subscriber"
+require "action_view/log_subscriber"
+require "action_controller/log_subscriber"
+    ActiveRecord::LogSubscriber.extend Taglog.new("M")
+      ActionView::LogSubscriber.extend Taglog.new("V")
+ActionController::LogSubscriber.extend Taglog.new("C")
+```
+
+```
+$ rails s
+...
+[C] Processing by EntriesController#show as HTML
+[C]   Parameters: {"id"=>"1234567"}
+[V]   Rendered entries/show.html.erb (7.5ms)
+[M]   Entry Exists (6.4ms)  SELECT 1 AS one FROM ...
+[C] Completed 200 OK in 88ms ...
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/taglog.rb

@@ -0,0 +1,57 @@
+require "taglog/version"
+require "logger"
+require "stringio"
+
+# Wrap a class that has `#logger` method to insert tag
+# without over defining actual logger's methods.
+class Taglog < Module
+  LEVELS = Logger::Severity.constants.map(&:downcase)
+
+  def initialize(tag)
+    @tag = tag
+  end
+
+  def extended(base)
+    tag = @tag
+    base.class_eval do
+      define_method(:logger_with_tag) do
+        Proxy.new(self, tag)
+      end
+      alias_method :logger_without_tag, :logger
+      alias_method :logger, :logger_with_tag
+    end
+  end
+
+  class Proxy
+    def initialize(context, tag)
+      @context = context
+      @tag     = tag
+    end
+
+    LEVELS.each do |level|
+      define_method(level) do |message|
+        delegate(level, tagged(message))
+      end
+    end
+
+    def method_missing(name, *args)
+      delegate(name, *args)
+    end
+
+    private
+
+    attr_reader :context, :tag
+
+    def tagged(message)
+      "[#{tag}] #{message}"
+    end
+
+    def delegate(method_name, *args)
+      logger.send(method_name, *args)
+    end
+
+    def logger
+      context.send(:logger_without_tag)
+    end
+  end
+end

data/lib/taglog/version.rb

@@ -0,0 +1,3 @@
+class Taglog < Module
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "taglog"
+
+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
+end

data/spec/taglog_spec.rb

@@ -0,0 +1,63 @@
+require "spec_helper"
+require "logger"
+require "stringio"
+
+describe Taglog do
+  let(:taglog) do
+    described_class.new(tag)
+  end
+
+  let(:tag) do
+    "tag"
+  end
+
+  let(:logger) do
+    Logger.new(io).tap do |this|
+      this.formatter = formatter
+    end
+  end
+
+  let(:formatter) do
+    proc {|_, _, _, message| message }
+  end
+
+  let(:io) do
+    StringIO.new
+  end
+
+  let(:result) do
+    io.string
+  end
+
+  let(:klass) do
+    logger = logger()
+    Class.new do
+      define_method(:logger) do
+        logger
+      end
+    end
+  end
+
+  describe "#extended" do
+    before do
+      klass.extend taglog
+    end
+
+    describe "#info" do
+      it "is wrapped by tag" do
+        klass.new.logger.info("message")
+        result.should == "[tag] message"
+      end
+    end
+
+    describe "#method_missing" do
+      before do
+        logger.stub(:missing => "missing")
+      end
+
+      it "is delegated to original logger" do
+        klass.new.logger.missing.should == "missing"
+      end
+    end
+  end
+end

data/taglog.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'taglog/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "taglog"
+  gem.version       = Taglog::VERSION
+  gem.authors       = ["Ryo Nakamura"]
+  gem.email         = ["ryo-nakamura@cookpad.com"]
+  gem.description   = "Taglog provides taggable logger extension"
+  gem.summary       = "Taggable logger extension"
+  gem.homepage      = "https://github.com/r7kamura/taglog"
+
+  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.require_paths = ["lib"]
+
+  gem.add_development_dependency "rspec", "2.12.0"
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: taglog
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ryo Nakamura
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-12-11 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 2
+        - 12
+        - 0
+        version: 2.12.0
+  type: :development
+  version_requirements: *id001
+description: Taglog provides taggable logger extension
+email: 
+- ryo-nakamura@cookpad.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/taglog.rb
+- lib/taglog/version.rb
+- spec/spec_helper.rb
+- spec/taglog_spec.rb
+- taglog.gemspec
+homepage: https://github.com/r7kamura/taglog
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Taggable logger extension
+test_files: 
+- spec/spec_helper.rb
+- spec/taglog_spec.rb