format_exception 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4548192228f4401a9406cda8cad72e9e9199274e
-  data.tar.gz: 64e00e6ec34e825f4807f8723810fb976c7f5c4e
+  metadata.gz: ffe2b381b1536f380b63639ec159f1464dd17b74
+  data.tar.gz: 465db21e56eb05d16147b8f55aff078850821b0d
 SHA512:
-  metadata.gz: e75be10a7baf9635c90801f8e81c5e7957e93cf3f1a852799501e8ca7202f45e0d5467002f312d4e6eba1e89c3675ebea43d52b7a20cc0013008ca5e4a1d0569
-  data.tar.gz: 206542474ae658cf3039c82758ad579d4dc67bea91935b66beb5fe66d5f5837685c4018574228ed78de8a798091a38a1282f830d00190c100b0fb7b1d8476434
+  metadata.gz: 6855f0be228cc57688decd3d9ccb4c74e8687d26c42eac23cedc772c4570552dff449cde14fbba05cfbea252befc4f5bbb9b0012e92d1c491b73883b2a55a69f
+  data.tar.gz: b3beeb426b4cd48d962de0bf441a7d11d60d4f087545048ce0dda33494c0b98d272dbd80a44dbc8eecd170c26803dd90b91f52f7a7d6d2b7eca57125cbef1e2b

data/README.md

@@ -1,10 +1,12 @@
+[![Gem Version](https://badge.fury.io/rb/format_exception.svg)](http://badge.fury.io/rb/format_exception) [![Build Status](https://travis-ci.org/hetznerZA/format_exception.svg?branch=master)](https://travis-ci.org/hetznerZA/format_exception)
+
 # FormatException
 
 A module of utility methods for string formatting exceptions.
 
 ## Documentation
 
-For documentation of the released gem, see [rubydoc.info](http://www.rubydoc.info/gems/format_exception).
+For documentation, follow the _Documentation_ link of the released gem on [rubygems.org](https://rubygems.org/gems/format_exception).
 
 ## Installation
 

data/lib/format_exception.rb

@@ -6,7 +6,26 @@ require "strscan"
 #
 # Provides utility methods for formatting an exception as a String.
 #
-# @example The contextual clean format
+# @example Classic format
+#
+#   require "format_exception"
+#
+#   def make_mistake
+#     begin
+#       raise "Deliberate mistake"
+#     rescue Exception => ex
+#       $stderr.puts FormatException.classic(ex)
+#     end
+#   end
+#
+#   make_mistake
+#
+#   # Prints:
+#   #
+#   # example.rb:7:in `make_mistake': Deliberate mistake (RuntimeError)
+#   #         example.rb:13:in `<main>'
+#
+# @example Contextual clean format to Logger
 #
 #   require "logger"
 #   require "format_exception"
@@ -16,7 +35,7 @@ require "strscan"
 #     File.open("message.txt", "r") do |io|
 #       puts io.read
 #     end
-#   rescue IOError => ex
+#   rescue StandardError => ex
 #     logger.error(FormatException[ex, "Printing welcome message"])
 #   end
 #
@@ -27,6 +46,43 @@ require "strscan"
 #   #         foo.rb:10:in `open'
 #   #         foo.rb:10:in `<main>'
 #
+# @example Contextual custom format
+#
+#   require "format_exception"
+#
+#   def make_mistake
+#     begin
+#       raise "Deliberate mistake"
+#     rescue Exception => ex
+#       $stderr.puts FormatException.format("%:m%C(\"%M\") at %f\n%R", ex, "Testing formatter")
+#     end
+#   end
+#
+#   make_mistake
+#
+#   # Prints
+#   #
+#   # Testing formatter: RuntimeError("Deliberate mistake") at example.rb:7:in `make_mistake'
+#   #         example.rb:13:in `<main>'
+#
+# @example Data format
+#
+#   require "format_exception"
+#
+#   def make_mistake
+#     begin
+#       raise "Deliberate mistake"
+#     rescue Exception => ex
+#       $stderr.puts FormatException.classic(ex).to_s
+#     end
+#   end
+#
+#   make_mistake
+#
+#   # Prints:
+#   #
+#   # {:name=>"RuntimeError", :message=>"Deliberate mistake", :backtrace=>["(irb):19:in `make_mistake'", ...]}
+#
 module FormatException
 
   ##
@@ -85,6 +141,31 @@ module FormatException
     format(CLEAN_FORMAT, e, context_message)
   end
 
+  ##
+  # Format exception as symbol-keyed dictionary
+  #
+  # If the +context_message+ is given, it is included as the +:context_message+ key.
+  #
+  # @param [Exception] e
+  #   the exception to format
+  # @param [String] context_message
+  #   the additional message to include in the dictionary
+  # @return [Hash] the data representation of the exception
+  #   * +:name+ (String) exception class name
+  #   * +:message+ (String) exception message
+  #   * +:backtrace+ (Array) exception backtrace
+  #   * +:context_message+ (String) +context_message+ if specified
+  #
+  def self.data(e, context_message = nil)
+    {
+      name: e.class.to_s,
+      message: e.message,
+      backtrace: e.backtrace,
+    }.tap { |h|
+      h[:context_message] = context_message if context_message
+    }
+  end
+
   ##
   # Format exception as per printf-like format specifier
   #
@@ -126,4 +207,5 @@ module FormatException
     end
     formatted
   end
+
 end

data/lib/format_exception/version.rb

@@ -1,3 +1,3 @@
 module FormatException
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: format_exception
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Sheldon Hearn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-11 00:00:00.000000000 Z
+date: 2018-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -91,9 +91,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: Exception formatter
 test_files: []
-has_rdoc: