readable_message 0.0.1

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+gemspec
+gem "rspec"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Brandon Hansen
+
+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,42 @@
+# ReadableMessage
+
+Print out exceptions (or any message that responds to :class, :message, and/or :backtrace) to the console
+surrounded by "*" * 80.  Makes it a bit easier to debug errors printed to standard out.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'readable_message'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install readable_message
+
+## Usage
+
+`console(e, *args)` // Takes a string or any object that responds to :class, :message, and/or :backtrace
+or
+`ReadableMessage::Formatter.new(e, *args).to_s`
+
+where `*args` is a list of methods that should be called on the object (to_s, to_i, backtrace, etc)
+
+The output to console will appear something as-
+
+  ********************************************************************************
+  String
+  "hi"
+  ********************************************************************************
+
+
+## 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 @@
+require "bundler/gem_tasks"

data/lib/readable_message/version.rb

@@ -0,0 +1,3 @@
+module ReadableMessage
+  VERSION = "0.0.1"
+end

data/lib/readable_message.rb

@@ -0,0 +1,50 @@
+require "readable_message/version"
+
+module ReadableMessage
+  
+  class Formatter
+    
+    def initialize(message, *args)
+      @message = message
+      @messages = args.concat([:class, :message, :backtrace, :inspect]).flatten.collect { |arg| 
+        Message.new(@message, arg) 
+      }
+    end
+    
+    def to_s
+      wrapper { body }
+    end
+    
+    private
+    
+    def body
+      @messages.each { |msg| puts msg.to_s unless msg.to_s.nil? }
+    end
+    
+    def wrapper
+      puts "*" * 80
+      yield if block_given?
+      puts  "*" * 80
+    end
+    
+  end
+  
+  class Message
+    
+    def initialize(str, method)
+      @str, @method = str, method
+    end
+    
+    def to_s
+      @str.send(@method).to_s if @str.respond_to?(@method.to_sym)
+    end
+    
+  end
+  
+end
+
+module Kernel
+  def readable(msg, *args)
+    ReadableMessage::Formatter.new(msg, args).to_s
+  end
+end

data/readable_message.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'readable_message/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "readable_message"
+  gem.version       = ReadableMessage::VERSION
+  gem.authors       = ["Brandon Hansen"]
+  gem.email         = ["brandonh@ibethel.org"]
+  gem.description   = %q{Prints out an exception message, class name, and backtrace to the console.}
+  gem.summary       = %q{Prints out an exception message, class name, and backtrace to the console.}
+  gem.homepage      = "https://github.com/ready4god2513/readable_message"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/spec/readable_message_spec.rb

@@ -0,0 +1,8 @@
+require "spec_helper"
+
+describe ReadableMessage do
+  
+  subject { Kernel }
+  it { should respond_to(:readable) }
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require "rubygems"
+require "bundler/setup"
+
+require "readable_message"
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter     = "documentation"
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: readable_message
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Brandon Hansen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-07 00:00:00.000000000 Z
+dependencies: []
+description: Prints out an exception message, class name, and backtrace to the console.
+email:
+- brandonh@ibethel.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/readable_message.rb
+- lib/readable_message/version.rb
+- readable_message.gemspec
+- spec/readable_message_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ready4god2513/readable_message
+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.24
+signing_key: 
+specification_version: 3
+summary: Prints out an exception message, class name, and backtrace to the console.
+test_files:
+- spec/readable_message_spec.rb
+- spec/spec_helper.rb