catcher 0.9.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Kacper Cieśla
+
+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,68 @@
+Catcher
+====
+
+Everytime you create a thread in ruby, you need to add some exception handling to know if something goes wrong (and what exactly went wrong). Similary when you do background processing unless you already use some bigger framework for this. And when you have multiple threads, each one doing something that may or may not succeed, that's where you really appreciate logging done well.
+
+This gem encapsulates pattern I use. First, somewhere in initialization you decide where to log:
+
+    Catcher.setup_logger "shit_happens.log"
+
+Arguments are the same as for Logger.new. Then in your classes:
+
+    class Foo
+      include Catcher::Logger
+
+      def self.bar
+        log.info "gangnam style"
+      end
+    end
+
+It could be also instance method. It will produce something like this:
+
+    I, [2012-10-30 10:56:45 #20295]  INFO -- : Foo : gangnam style
+
+So by default you have timestamps (how could you live without them?!), and class name because you don't like to repeat yourself. Now the catching stuff:
+
+    Catcher.block "I'm gonnna do science here" do
+      raise "oops"
+    end
+
+Exception gets catched and logged like this:
+
+    E, [2012-10-30 11:00:32 #23305] ERROR -- : Exception raised by 'I'm gonnna do science here'
+      [RuntimeError] oops
+      (irb):3:in `block in irb_binding'
+      /comboy/projects/os/catcher/lib/catcher.rb:9:in `block'
+      (irb):2:in `irb_binding'
+      (.. full backtrace here ..)
+
+And finally forget about Thread.new, just use:
+
+    Catcher.thread "doing science" do
+      # your stuff
+    end
+
+Which is equal to Thread.new with Catcher.block inside.
+
+Description strings in Catcher.block and Catcher.thread are optional, but very much recommended. Comments and suggestions are very much welome.
+
+Happy threading.
+
+Usage
+------
+
+In your Gemfile:
+
+    gem 'catcher'
+
+Author
+-------
+
+Kacper Cieśla
+
+License
+-------
+
+Catcher is released under the MIT license.
+
+

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Catcher'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/catcher.rb

@@ -0,0 +1,49 @@
+require 'logger'
+require 'catcher/prefixed_logger'
+require 'catcher/logger'
+
+module Catcher
+
+  def self.block(progname = nil)
+    begin
+      yield
+    rescue Exception => e
+      log_exception e, progname
+    end
+  end
+
+  def self.thread(progname = nil)
+    Thread.new do
+      block progname do
+        yield
+      end
+    end
+  end
+
+  def self.log_exception(e, progname)
+    text = progname ? "Exception raised by '#{progname}'\n\t"  : ""
+    if e.kind_of? Exception
+      text << "[#{e.class}] #{e.message}\n\t#{e.backtrace.join("\n\t")}"
+    else
+      # This software is UFO ready
+      text << "Some not very exceptional object raised o_O #{e.inspect} [#{e.class}]"
+    end
+    Catcher.logger.error text
+  end
+
+  def self.logger
+    @logger || setup_logger(STDOUT)
+  end
+
+  def self.logger=(logger)
+    @logger = logger
+  end
+
+  def self.setup_logger(*args)
+    @logger = ::Logger.new(*args)
+    @logger.formatter = ::Logger::Formatter.new 
+    @logger.datetime_format = "%Y-%m-%d %H:%M:%S "
+    @logger
+  end
+end
+

data/lib/catcher/logger.rb

@@ -0,0 +1,18 @@
+module Catcher
+  module Logger
+     module LogMethods
+       def log
+         return @logger if @logger
+         class_prefix = self.to_s
+         # Q: Hey dude, why don't you just use Catcher.logger.progname?
+         # A: Because thread safety
+         @logger = PrefixedLogger.new Catcher.logger, class_prefix
+       end
+     end
+
+     def self.included(klass)
+       klass.send :include, LogMethods
+       klass.send :extend, LogMethods
+     end
+  end
+end

data/lib/catcher/prefixed_logger.rb

@@ -0,0 +1,38 @@
+module Catcher
+  
+   class PrefixedLogger
+     def initialize(logger, prefix)
+       @logger = logger
+       @prefix = prefix + ' : '
+     end
+
+     # OK, I feel bad about this repetition below.
+     # But define_method won't define method with block argument,
+     # and I don't feel like using eval. Feel free to improve
+
+     def debug(progname = nil, &block)
+       @logger.add(::Logger::DEBUG, nil, @prefix + progname.to_s, &block)
+     end
+
+     def info(progname = nil, &block)
+       @logger.add(::Logger::INFO, nil, @prefix + progname.to_s, &block)
+     end
+
+     def warn(progname = nil, &block)
+       @logger.add(::Logger::WARN, nil, @prefix + progname.to_s, &block)
+     end
+
+     def error(progname = nil, &block)
+       @logger.add(::Logger::ERROR, nil, @prefix + progname.to_s, &block)
+     end
+
+     def fatal(progname = nil, &block)
+       @logger.add(::Logger::FATAL, nil, @prefix + progname.to_s, &block)
+     end
+
+     def unknown(progname = nil, &block)
+       @logger.add(::Logger::UNKNOWN, nil, @prefix + progname.to_s, &block)
+     end
+
+   end
+end

data/lib/catcher/version.rb

@@ -0,0 +1,3 @@
+module Catcher
+  VERSION = "0.9.0"
+end

data/test/catcher/logger_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+require 'catcher'
+
+class TestClass
+  include Catcher::Logger
+
+  def foo
+    log.info "instance method"
+  end
+
+  def self.foo
+    log.info "class method"
+  end
+end
+
+describe Catcher::Logger do
+  before do
+    @output = ""
+    io = StringIO.new @output
+    Catcher.setup_logger io
+  end
+
+  it "works with instance methods" do
+    TestClass.new.foo
+    @output.strip.must_match /I, \[(.*)\] *INFO -- : #<TestClass:0x[a-z0-9]+> : instance method$/
+  end
+
+  it "works with class methods" do
+    TestClass.foo
+    @output.strip.must_match /I, \[(.*)\] *INFO -- : TestClass : class method$/
+  end
+
+  # TODO test coverage other log methods (debug, fatel etc.)
+end

data/test/catcher_test.rb

@@ -0,0 +1,72 @@
+require 'test_helper'
+
+describe Catcher do
+
+  it { Catcher.logger.wont_be_nil }
+  it { Catcher.logger.must_be_kind_of Logger }
+  let(:output) { "" }
+  let(:io) { StringIO.new output }
+
+  describe "logger=" do
+    before do
+      @logger = Logger.new(nil)
+      Catcher.logger = @logger
+    end
+
+    it { assert_equal Catcher.logger, @logger }
+  end
+
+  it "formats logs properly" do
+    Catcher.setup_logger io
+    Catcher.logger.info "foo"
+    output.strip.must_match /I, \[(.*)\] *INFO -- : foo$/
+  end
+
+  describe ".thread" do
+    it "returns thread" do
+      t = Catcher.thread { sleep 0.1 }
+      t.must_be_kind_of Thread
+    end
+
+    it "executes" do
+      a = 1
+      Catcher.thread("my thread") { a = 2 }.join
+      a.must_equal 2
+    end
+
+    it "executes without description" do
+      a = 1
+      Catcher.thread { a = 2 }.join
+      a.must_equal 2
+    end
+  end
+
+  describe ".block" do
+    before { Catcher.setup_logger io }
+
+    it "does not raise and logs exception" do
+      Catcher.block("something") { raise "boom" }
+      output.must_match /E, \[(.*)\] *ERROR -- : Exception raised by 'something'/m
+    end
+
+    it "workns without description" do
+      a = 1
+      Catcher.block { a = 2 }
+      assert_equal a, 2
+    end
+
+  end
+
+  it "logs exception" do
+    ex = nil
+    begin; raise "the hell"; rescue => e; ex = e; end
+    ex.must_be_kind_of RuntimeError
+
+    Catcher.setup_logger io
+    Catcher.log_exception(ex, "from here")
+    output.must_match /E, \[(.*)\] *ERROR -- : Exception raised by 'from here'/m
+    output.must_match /\[RuntimeError\] the hell/m
+    output.must_match /test\/catcher_test\.rb:\d+/m
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'minitest/spec'
+require 'minitest/autorun'

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: catcher
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+  prerelease: 
+platform: ruby
+authors:
+- Kacper Cieśla
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-30 00:00:00.000000000 Z
+dependencies: []
+description: Keep readable logs for your multithreaded ruby scripts
+email:
+- kacper.ciesla@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/catcher.rb
+- lib/catcher/prefixed_logger.rb
+- lib/catcher/logger.rb
+- lib/catcher/version.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+- test/test_helper.rb
+- test/catcher_test.rb
+- test/catcher/logger_test.rb
+homepage: https://github.com/comboy/catcher
+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.23
+signing_key: 
+specification_version: 3
+summary: Keep readable logs for your multithreaded ruby scripts
+test_files:
+- test/test_helper.rb
+- test/catcher_test.rb
+- test/catcher/logger_test.rb