nestable_logger 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 akimatter
+
+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.rdoc

@@ -0,0 +1,17 @@
+= nestable_logger
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 akimatter. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,73 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "nestable_logger"
+    gem.summary = %Q{nestable_logger supports nesting logging descriptions}
+    gem.description = %Q{nestable_logger supports nesting logging descriptions}
+    gem.email = "akm2000@gmail.com"
+    gem.homepage = "http://github.com/akm/nestable_logger"
+    gem.authors = ["akimatter"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+  spec.rcov_opts = lambda do
+    IO.readlines("spec/rcov.opts").map {|l| l.chomp.split " "}.flatten
+  end
+end
+
+task :spec => :check_dependencies
+
+begin
+  require 'reek/adapters/rake_task'
+  Reek::RakeTask.new do |t|
+    t.fail_on_error = true
+    t.verbose = false
+    t.source_files = 'lib/**/*.rb'
+  end
+rescue LoadError
+  task :reek do
+    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
+  end
+end
+
+begin
+  require 'roodi'
+  require 'roodi_task'
+  RoodiTask.new do |t|
+    t.verbose = false
+  end
+rescue LoadError
+  task :roodi do
+    abort "Roodi is not available. In order to run roodi, you must: sudo gem install roodi"
+  end
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "nestable_logger #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/nestable_logger.rb

@@ -0,0 +1,90 @@
+# -*- coding: utf-8 -*-
+class NestableLogger
+  LEVELS = %w[debug info warn error fatal unknown].freeze
+
+  # Loggerの定数と同じ
+  DEBUG = 0
+  INFO  = 1
+  WARN  = 2
+  ERROR = 3
+  FATAL = 4
+  UNKNOWN = 5
+
+  attr_reader :options
+  def initialize(impl, options = {})
+    @impl = impl
+    @options = options || {}
+    @msg_stack = []
+    @last_index = 0
+  end
+
+  def add_method(severity, object, method_name = nil, msg = nil, &block)
+    method_name ||= caller[1].scan(/\`(.+)\'/).flatten.first
+    name = object.is_a?(Module) ? "#{object.name}.#{method_name}" : "#{object.class.name}##{method_name}"
+    name << ' ' << msg if msg
+    stack(name) do |m|
+      add(severity, m, &block)
+    end
+  end
+
+  def add_index(severity, msg = nil, &block)
+    index = (@last_index || 0).succ
+    @last_index = index
+    msg = msg ? "#{index.to_s} #{msg}" : index.to_s
+    stack(msg) do |m|
+      add(severity, m, &block)
+    end
+  end
+
+  def add(severity, msg)
+    if block_given?
+      @impl.send(LEVELS[severity.to_i], "#{msg} S")
+      begin
+        last_index_backup = @last_index
+        @last_index = 0
+        begin
+          result = yield
+        ensure
+          @last_index = last_index_backup
+        end
+        @impl.send(LEVELS[severity.to_i], "#{msg} E")
+        return result
+      rescue Exception => err
+        # 実装中にspecしたときにメッセージがややこしくなるのでSpec関係のエラーは無視
+        unless err.class.name =~ /^Spec::Mocks::/
+          @impl.send(LEVELS[severity.to_i],
+            "#{msg} ERROR\n  [#{err.class.name}] #{err.to_s}\n  " << err.backtrace.join("\n  "))
+        end
+        raise
+      end
+    else
+      @impl.send(LEVELS[severity.to_i], msg)
+    end
+  end
+
+  def stack(msg)
+    @msg_stack << (msg || '')
+    begin
+      yield(@msg_stack.join('.'))
+    ensure
+      @msg_stack.pop
+    end
+  end
+
+  (LEVELS - %w[unknown]).each do |level|
+    module_eval(<<-"EOS", __FILE__, __LINE__ + 1)
+      def #{level}_method(*args, &block)
+        add_method(#{level.upcase}, *args, &block)
+      end
+
+      def #{level}_index(*args, &block)
+        add_index(#{level.upcase}, *args, &block)
+      end
+
+      def #{level}(*args, &block)
+        add(#{level.upcase}, *args, &block)
+      end
+    EOS
+  end
+
+end

data/nestable_logger.gemspec

@@ -0,0 +1,56 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{nestable_logger}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["akimatter"]
+  s.date = %q{2010-08-05}
+  s.description = %q{nestable_logger supports nesting logging descriptions}
+  s.email = %q{akm2000@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/nestable_logger.rb",
+     "nestable_logger.gemspec",
+     "spec/nestable_logger_spec.rb",
+     "spec/rcov.opts",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/akm/nestable_logger}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{nestable_logger supports nesting logging descriptions}
+  s.test_files = [
+    "spec/nestable_logger_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/spec/nestable_logger_spec.rb

@@ -0,0 +1,118 @@
+# -*- coding: utf-8 -*-
+require File.expand_path('./spec_helper', File.dirname(__FILE__))
+
+require 'logger'
+require 'stringio'
+
+describe NestableLogger do
+
+  class TestLogger
+    attr_reader :logs
+    def initialize
+      @logs = []
+    end
+
+    def debug(msg)
+      @logs << msg
+    end
+  end
+
+  class Target1
+
+    attr_reader :logger
+    def initialize(logger)
+      @logger = logger
+    end
+
+    def foo
+      logger.debug_method(self, "foo") do
+        logger.debug_index do
+          logger.debug_index("abc")
+          # puts "foo1"
+          logger.debug_index
+          "FOO" # 最後の評価が戻り値になる
+        end
+      end
+    end
+
+    def bar
+      logger.debug_method(self) do # メソッド名が自動補完される
+        logger.debug_index do
+          logger.debug("abc")
+          # puts "foo1"
+          logger.debug("www")
+          "BAR" # 最後の評価が戻り値になる
+        end
+      end
+    end
+
+    def hook_error_and_raise_it
+      logger.debug_method(self, "foo") do
+        logger.debug_index do
+          raise StandardError, "Some exception occured"
+        end
+      end
+    end
+
+  end
+
+  describe :options do
+    before do
+      @impl = Logger.new(STDOUT)
+      @logger = NestableLogger.new(@impl)
+    end
+
+    it "何も設定しなくてもオプションは取得できる" do
+      @logger.options.should == {
+      }
+    end
+  end
+
+  describe :logging do
+    before do
+      @impl = TestLogger.new
+      @logger = NestableLogger.new(@impl)
+    end
+
+    context "nested call" do
+      it "foo" do
+        @target1 = Target1.new(@logger)
+        @target1.foo.should == "FOO" # ちゃんと戻り値が返ってくる
+        @impl.logs.should == [
+          "Target1#foo S"      ,
+          "Target1#foo.1 S"    ,
+          "Target1#foo.1.1 abc",
+          "Target1#foo.1.2"    ,
+          "Target1#foo.1 E"    ,
+          "Target1#foo E"      ,
+        ]
+      end
+
+      it "bar" do
+        @target1 = Target1.new(@logger)
+        @target1.bar.should == "BAR" # ちゃんと戻り値が返ってくる
+        @impl.logs.should == [
+          "Target1#bar S"      ,
+          "Target1#bar.1 S"    ,
+          "abc"  ,
+          "www"  ,
+          "Target1#bar.1 E"    ,
+          "Target1#bar E"      ,
+        ]
+      end
+    end
+
+    it "error log" do
+      @target1 = Target1.new(@logger)
+      lambda{
+        @target1.hook_error_and_raise_it
+      }.should raise_error(StandardError)
+      @impl.logs[0].should == "Target1#foo S"
+      @impl.logs[1].should == "Target1#foo.1 S"
+      error_lines = @impl.logs[2].split(/$/).map{|line| line.strip}
+      error_lines[0].should == "Target1#foo.1 ERROR"
+      error_lines[1].should == "[StandardError] Some exception occured"
+    end
+  end
+
+end

data/spec/rcov.opts

@@ -0,0 +1 @@
+--exclude "spec/*,gems/*" 

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'nestable_logger'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: nestable_logger
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- akimatter
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-05 00:00:00 +09:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: nestable_logger supports nesting logging descriptions
+email: akm2000@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/nestable_logger.rb
+- nestable_logger.gemspec
+- spec/nestable_logger_spec.rb
+- spec/rcov.opts
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/akm/nestable_logger
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.7
+signing_key: 
+specification_version: 3
+summary: nestable_logger supports nesting logging descriptions
+test_files: 
+- spec/nestable_logger_spec.rb
+- spec/spec_helper.rb