exception_formatter 0.1.0

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
+/.idea
+/coverage*
+Gemfile.lock

data/.rspec

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

data/Capfile

@@ -0,0 +1,16 @@
+require "tb_setup_ci/recipes"
+
+set :user, "jenkins"
+set :ci_job, "exception_formatter"
+set :ci_job_git_branch, "master"
+set :repository, "git@git.thomasbaustert.de:repos/exception_formatter.git"
+
+#set :db_config_dir, "test/dummy/config/"
+
+set :ci_run_tests, false
+set :ci_run_specs, true
+set :ci_run_coverage, false
+set :ci_coverage_task, "app:spec:rcov"
+
+role :ci, "ci.thomasbaustert.de"
+

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Thomas Baustert
+
+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,89 @@
+# ExceptionFormatter
+
+*I was sick of writing "#{exception.class.name}: #{exception.message}\\n#{exception.backtrace.join("\\n")}"*
+
+Simple formatter for ruby exception messages.
+
+Features:
+
+* Custom format pattern
+* Nested exception support
+* ActiveRecord:::RecordInvalid exception support
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'exception_formatter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install exception_formatter
+
+## Examples
+
+### Using default pattern
+
+If no pattern is given the default pattern is used (see ExceptionFormatter::DEFAULT_PATTERN):
+
+    begin
+      ... code ... code ... code
+    rescue => ex
+      Rails.logger.error ExceptionFormatter.format(ex)
+    end
+
+Will produce the string:
+
+      StandardError: the exception message
+      file:31
+      file:76
+
+### Using custom pattern
+
+    begin
+      ... code ... code ... code
+    rescue => ex
+      Rails.logger.error ExceptionFormatter.format(ex, pattern: "[%k] %m\nStacktrace:\n%b")
+    end
+
+Will produce the string:
+
+      [StandardError] the exception message
+      Stacktrace:
+      file:31
+      file:76
+
+Alternatively use instance method:
+
+    FORMATTER = ExceptionFormatter.new(pattern: "[%k] %m\n%b")
+
+    begin
+      ... code ... code ... code
+    rescue => ex
+      Rails.logger.error FORMATTER.format(ex)
+    end
+
+## Available pattern
+
+    %b         = exception backtrace joined with "\n"
+    %c         = cause, the nested exception message (by calling exception.cause.message)
+    %c{method} = cause, the nested exception message (by calling exception.method.message)
+                 (useful if nested exception does not respond to #cause but to #reason or what ever)
+    %k         = exception class name
+    %m         = exception message
+    %r         = record errors, the record error messages in case of ActiveRecord:::RecordInvalid exception
+                 (by calling exception.record.errors.full_messages)
+    %x{method} = message return by calling exception.send(method)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# running spec as rake default tasks
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+
+Bundler::GemHelper.install_tasks

data/exception_formatter.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'exception_formatter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "exception_formatter"
+  spec.version       = ExceptionFormatter::VERSION
+  spec.authors       = ["Thomas Baustert"]
+  spec.email         = ["business@thomasbaustert.de"]
+  spec.description   = %q{Simple formatter for ruby exception messages.}
+  spec.summary       = %q{Simple formatter for ruby exception messages.}
+  spec.homepage      = "https://github.com/thomasbaustert/exception_formatter"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec'
+end

data/lib/exception_formatter/version.rb

@@ -0,0 +1,3 @@
+class ExceptionFormatter
+  VERSION = "0.1.0"
+end

data/lib/exception_formatter.rb

@@ -0,0 +1,52 @@
+require "exception_formatter/version"
+
+class ExceptionFormatter
+
+  DEFAULT_PATTERN = "%k: %m\n%b"
+
+  def self.format(exception, options = {})
+    self.new(options).format(exception)
+  end
+
+  def initialize(options = {})
+    @pattern = options[:pattern] ? options[:pattern].to_s : DEFAULT_PATTERN
+  end
+
+
+  def format(exception)
+    s = @pattern.dup
+    s = s.gsub('%b', exception.backtrace.join("\n"))
+    s = s.gsub(/%c{(\w+)}/) { |match| exception_cause(exception, $1) }
+    s = s.gsub('%c', exception_cause(exception, :cause))
+    s = s.gsub('%k', exception.class.name)
+    s = s.gsub('%m', exception.message.to_s)
+    s = s.gsub('%r', exception_record_errors(exception))
+    s = s.gsub(/%x{(\w+)}/) { |match| exception_method(exception, $1) }
+    s
+  end
+
+  private
+
+  def exception_cause(exception, method)
+    if exception.respond_to?(method) && exception.send(method).respond_to?(:message)
+      exception.send(method).message
+    else
+      ""
+    end
+  end
+
+  def exception_record_errors(exception)
+    if exception.respond_to?(:record) &&
+       exception.record.respond_to?(:errors)
+       exception.record.errors.respond_to?(:full_messages)
+      exception.record.errors.full_messages.to_s
+    else
+      ""
+    end
+  end
+
+  def exception_method(exception, method)
+    exception.respond_to?(method) ? exception.send(method) : ""
+  end
+
+end

data/spec/exception_formatter_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+require 'exception_formatter'
+
+describe ExceptionFormatter do
+
+  describe "::format" do
+
+    it "delegates to #format" do
+      exception = double('exception', message: "error", backtrace: ["file:1", "file:2"])
+      formatter = double('exception_formatter')
+
+      ExceptionFormatter.should_receive(:new).with(pattern: "%m\n%b").and_return(formatter)
+      formatter.should_receive(:format).with(exception)
+
+      ExceptionFormatter.format(exception, pattern: "%m\n%b")
+    end
+
+    context "no pattern given" do
+      it "returns default message with exception message and backtrace " do
+        exception = new_exception(class: double("FooError", name: "FooError"))
+        formatter = ExceptionFormatter.new
+        formatter.format(exception).should == "FooError: A Error Message\nline1\nline2"
+      end
+    end
+
+    context "pattern %m" do
+      it "returns message with exception message" do
+        exception = new_exception(message: "a freaking error")
+        ExceptionFormatter.format(exception, pattern: "%m").should == "a freaking error"
+      end
+    end
+
+    context "pattern %k" do
+      it "returns message with exception class" do
+        exception = new_exception(class: double("StandardError", name: "StandardError"))
+        ExceptionFormatter.format(exception, pattern: "%k").should == "StandardError"
+      end
+    end
+
+    context "pattern %b" do
+      it "returns message with exception backtrace" do
+        exception = new_exception(backtrace: ["file:42", "file:76"])
+        ExceptionFormatter.format(exception, pattern: "%b").should == "file:42\nfile:76"
+      end
+    end
+
+    context "pattern %c" do
+      context "exception respond to cause" do
+        it "returns message with exception cause" do
+          exception = new_exception(cause: new_exception(message: "cause error"))
+          ExceptionFormatter.format(exception, pattern: "%c").should == "cause error"
+        end
+      end
+
+      context "exception does respond to cause but not to cause.message" do
+        it "returns message without exception cause" do
+          exception = new_exception(cause: double("object_without_message"))
+          ExceptionFormatter.format(exception, pattern: "%c").should == ""
+        end
+      end
+
+      context "exception does not respond to cause" do
+        it "returns message without exception cause" do
+          exception = new_exception
+          ExceptionFormatter.format(exception, pattern: "%c").should == ""
+        end
+      end
+    end
+
+    context "pattern %c{method}" do
+      it "returns message with exception message return by method" do
+        exception = new_exception(reason: new_exception(message: "error reason"))
+        ExceptionFormatter.format(exception, pattern: "%c{reason}").should == "error reason"
+      end
+    end
+
+    context "%r" do
+      context "ActiveRecord:::RecordInvalid exception" do
+        it "returns message with record error messages" do
+          record = double('record', errors: double("ActiveModel::Errors", full_messages: ["Name must be present", "Url is invalid"]))
+          exception = double('exception', message: "ActiveRecord::RecordInvalid", backtrace: ["file:1", "file:2"], record: record)
+          ExceptionFormatter.format(exception, pattern: "%r").should == '["Name must be present", "Url is invalid"]'
+          ExceptionFormatter.format(exception, pattern: "%m: %r\n%b").
+              should == %Q{ActiveRecord::RecordInvalid: ["Name must be present", "Url is invalid"]\nfile:1\nfile:2}
+        end
+      end
+    end
+
+    context "pattern %x{method}" do
+      context "exception respond to method" do
+        it "returns message with exception.send(mathod)" do
+          exception = new_exception(awesome_message: "this is a awesome message")
+          ExceptionFormatter.format(exception, pattern: "%x{awesome_message}").should == "this is a awesome message"
+        end
+      end
+
+      context "exception does not respond to method" do
+        it "returns blank string" do
+          exception = new_exception
+          ExceptionFormatter.format(exception, pattern: "%x{awesome_message}").should == ""
+        end
+      end
+    end
+
+  end
+
+  def new_exception(options = {})
+    double('exception', { message: "A Error Message", backtrace: ["line1", "line2"] }.merge(options))
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# 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
+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,114 @@
+--- !ruby/object:Gem::Specification
+name: exception_formatter
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors:
+- Thomas Baustert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: rake
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: rspec
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+description: Simple formatter for ruby exception messages.
+email:
+- business@thomasbaustert.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Capfile
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- exception_formatter.gemspec
+- lib/exception_formatter.rb
+- lib/exception_formatter/version.rb
+- spec/exception_formatter_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/thomasbaustert/exception_formatter
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 3825082566233634308
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 3825082566233634308
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Simple formatter for ruby exception messages.
+test_files:
+- spec/exception_formatter_spec.rb
+- spec/spec_helper.rb