format_exception 0.1.0 → 0.2.0

checksums.yaml

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/.yardopts

@@ -0,0 +1,4 @@
+--no-private
+--exclude README.md
+--readme README.rdoc
+-

data/README.md

@@ -1,8 +1,10 @@
 # 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.
+A module of utility methods for string formatting exceptions.
 
-TODO: Delete this and the text above, and describe your gem
+## Documentation
+
+For documentation of the released gem, see [rubydoc.info](http://www.rubydoc.info/gems/format_exception).
 
 ## Installation
 
@@ -20,10 +22,6 @@ 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.

data/README.rdoc

@@ -0,0 +1,10 @@
+= FormatException
+
+Provides utility methods for formatting an exception as a String.
+
+Two very common formats are supported directly, with other formats made possible with a printf-like format specifier.
+The inclusion of a context message is also supported
+
+The methods are provided by the module {FormatException}.
+
+The implementation is covered by an rspec test suite in the {https://github.com/hetznerZA/format_exception FormatException repo}.

data/lib/format_exception/version.rb

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

data/lib/format_exception.rb

@@ -29,23 +29,20 @@ require "format_exception/version"
 module FormatException
 
   ##
-  # The contextual clean format
+  # The classic format (see {classic})
   #
-  # Format the exception as per {clean}, but with an optional +context_message+
-  # prepended to the first line.
+  CLASSIC_FORMAT = "%f: %:m%M (%C)\n%R"
+
+  ##
+  # The clean format (see {clean})
   #
-  # @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
+  CLEAN_FORMAT = "%:m%C: %M:\n%B"
+
+  ##
+  # Alias for {clean}
   #
   def self.[](e, context_message = nil)
-    if context_message
-      "#{context_message}: " + clean(e)
-    else
-      clean(e)
-    end
+    clean(e, context_message)
   end
 
   ##
@@ -53,15 +50,20 @@ module FormatException
   #
   # 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,
+  # exception message and class name, with the rest of the backtrace on subsequent,
   # indented lines.
   #
+  # If the +context_message+ is given, it is included on the first line, between
+  # the first line of the backtrace and the exception message.
+  #
   # @param [Exception] e
   #   the exception to format
+  # @param [String] context_message
+  #   the additional message to include in the formatted exception
   # @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")
+  def self.classic(e, context_message = nil)
+    format(CLASSIC_FORMAT, e, context_message)
   end
 
   ##
@@ -70,12 +72,57 @@ module FormatException
   # 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.
   #
+  # If the +context_message+ is given, it is 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.clean(e)
-    "#{e.class}: #{e.message}:\n\t" + e.backtrace.join("\n\t")
+  def self.clean(e, context_message = nil)
+    format(CLEAN_FORMAT, e, context_message)
   end
 
+  ##
+  # Format exception as per printf-like format specifier
+  #
+  # The following format specifiers are supported:
+  #
+  # * +%C+  - the exception class name
+  # * +%M+  - the exception message
+  # * +%m+  - the context message if given
+  # * +%:m+ - the context message, a colon and a space, if the context message is given
+  # * +%f+  - the first line of the backtrace, unindented
+  # * +%r+  - all lines of the backtrace but the first, newline-separated, unindented
+  # * +%R+  - all lines of the backtrace but the first, newline-separated, indented
+  # * +%b+  - all lines of the backtrace, newline-separated, unindented
+  # * +%B+  - all lines of the backtrace, newline-separated, indented
+  # * +%%+  - a literal +%+
+  #
+  def self.format(f, e, c = nil)
+    scanner = StringScanner.new(f)
+    formatted = ""
+    loop do
+      formatted << scanner.scan(/[^%]*/)
+      token = scanner.scan(/%:?./)
+      case token
+      when "%C" then formatted << e.class.to_s
+      when "%M" then formatted << e.message
+      when "%m" then formatted << c if c
+      when "%:m" then formatted << "#{c}: " if c
+      when "%f" then formatted << e.backtrace.first
+      when "%r" then formatted << e.backtrace.drop(1).join("\n")
+      when "%R" then formatted << ("\t" + e.backtrace.drop(1).join("\n\t"))
+      when "%b" then formatted << e.backtrace.join("\n")
+      when "%B" then formatted << ("\t" + e.backtrace.join("\n\t"))
+      when "%%" then formatted << "%"
+      when nil then break
+      else
+        raise ArgumentError, "unknown format specifier '#{scanner.matched}'"
+      end
+      break if scanner.eos?
+    end
+    formatted
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: format_exception
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Sheldon Hearn
@@ -61,8 +61,11 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
+- ".yardopts"
 - Gemfile
 - README.md
+- README.rdoc
 - Rakefile
 - bin/console
 - bin/setup