format_exception 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d80328dd66e21a3a58ca8d3ba455a2fc51220e75
+  data.tar.gz: 2dffab1f7c1421c02a622797e2e4ddbbb4bd0008
+SHA512:
+  metadata.gz: 64ca99310e1ebdbb3ffd5023f427e7dc4c4db8eb50d2f9cda1c6c5934c0f5405f8286955f39ded23eec1420d7e94c3e2054714e49387370418e6b9bdb07bb726
+  data.tar.gz: 998c51089e13986a3d5f625310aebdefe0736d377885c0b413fdb11ba6b125419167b904e4628f11c31d952e1680af451db770638dc07a1af82537118e290c48

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/README.md

@@ -0,0 +1,36 @@
+# FormatException
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/format_exception`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'format_exception'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install format_exception
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/format_exception.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task :default => :spec
+
+RSpec::Core::RakeTask.new(:spec)

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "format_exception"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/format_exception.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'format_exception/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "format_exception"
+  spec.version       = FormatException::VERSION
+  spec.authors       = ["Sheldon Hearn"]
+  spec.email         = ["sheldonh@starjuice.net"]
+
+  spec.summary       = %q{Exception formatter}
+  spec.description   = %q{A tiny exception formatter}
+  spec.homepage      = "https://github.com/hetznerZA/format_exception"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.5"
+end

data/lib/format_exception/version.rb

@@ -0,0 +1,3 @@
+module FormatException
+  VERSION = "0.1.0"
+end

data/lib/format_exception.rb

@@ -0,0 +1,81 @@
+require "format_exception/version"
+
+##
+# Simple exception formatter
+#
+# Provides utility methods for formatting an exception as a String.
+#
+# @example The contextual clean format
+#
+#   require "logger"
+#   require "format_exception"
+#
+#   logger = Logger.new($stderr)
+#   begin
+#     File.open("message.txt", "r") do |io|
+#       puts io.read
+#     end
+#   rescue IOError => ex
+#     logger.error(FormatException[ex, "Printing welcome message"])
+#   end
+#
+#   # Prints
+#   #
+#   # E, [2017-02-11T01:56:08.763049 #4302] ERROR -- : Printing welcome message: Errno::ENOENT: No such file or directory @ rb_sysopen - message.txt:
+#   #	foo.rb:10:in `initialize'
+#   #	foo.rb:10:in `open'
+#   #	foo.rb:10:in `<main>'
+#
+module FormatException
+
+  ##
+  # The contextual clean format
+  #
+  # Format the exception as per {clean}, but with an optional +context_message+
+  # prepended to the first line.
+  #
+  # @param [Exception] e
+  #   the exception to format
+  # @param [String] context_message
+  #   the additional message to prepend to the formatted exception
+  # @return [String] the formatted exception
+  #
+  def self.[](e, context_message = nil)
+    if context_message
+      "#{context_message}: " + clean(e)
+    else
+      clean(e)
+    end
+  end
+
+  ##
+  # The Ruby interpreter's default format
+  #
+  # Formats the exception exactly as the Ruby interpreter would if the exception
+  # was uncaught. The first line includes the first line of the backtrace, and the
+  # exception class name and message, with the rest of the backtrace on subsequent,
+  # indented lines.
+  #
+  # @param [Exception] e
+  #   the exception to format
+  # @return [String] the formatted exception
+  #
+  def self.classic(e)
+    "#{e.backtrace.first}: #{e.message} (#{e.class})\n\t" + e.backtrace.drop(1).join("\n\t")
+  end
+
+  ##
+  # The log-friendly format
+  #
+  # Formats the exception as the Rails logger would, with the exception class name
+  # and message on the first line, with the backtrace on subsequent, indented lines.
+  #
+  # @param [Exception] e
+  #   the exception to format
+  # @return [String] the formatted exception
+  #
+  def self.clean(e)
+    "#{e.class}: #{e.message}:\n\t" + e.backtrace.join("\n\t")
+  end
+
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: format_exception
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sheldon Hearn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: A tiny exception formatter
+email:
+- sheldonh@starjuice.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- format_exception.gemspec
+- lib/format_exception.rb
+- lib/format_exception/version.rb
+homepage: https://github.com/hetznerZA/format_exception
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Exception formatter
+test_files: []
+has_rdoc: