braise 0.1.0 → 1.0.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YmY1MzdhOGJlOTMxZDJhYjFiNzJiZTgyZTI2NjY0ODkxMjVmYjI5Nw==
+    ZGI0MzZlMDcwYTE5MzcyYTJiYTUwYWQ0MDU1M2Q1NzdkYWQ4M2U2OA==
   data.tar.gz: !binary |-
-    Nzk4MzI2NjhhMThiMTgwMDFlOGEzY2YzMzIzNGEzN2EzNGRiMDZmNQ==
+    MzM5YTViMTEwNGY5NjdlOTE3MzdkYzhkMTllMjBjYzRlYWVmMjY0MQ==
 SHA512:
   metadata.gz: !binary |-
-    YTVhNzdhOGE0NTczZWFkYzE3NzU4YTA0ZmVlMzU2MDRiNzAzMTg4ODE2NWZk
-    MDMzMzU5NWMzNjNlOWE5MjhiYmY2YjNlZDIyMjQ5NzAwZGQ4NmY3MmVkNmQ3
-    NmFhODc5YjU4Mjk1MzEzZjU0NjM3YzFmNzc2ZDdmOTU0ODQxYWE=
+    YmFhYzVlZWQ5NTU0NDEwMGIxNWU2ZDkxOWE1N2Y4ZmVkMmM3M2YwYTFhZjAz
+    ZDAwOTBkYWM3MjdjYTFkZjM1Y2E4YzM3YmRmMzAzYzg0N2E4MDUxMTAzY2Qz
+    NDlmOTNlOWU2ZTExNjM1YzYxMzQwNjc4YmRkNzczMWE0MWQyZjY=
   data.tar.gz: !binary |-
-    NDJhNWRlYThhZDdiMzE2MzA4ZDdmZDM4ZTgwOWYzY2RmMWUxYjliZDJhN2Yz
-    NWE3N2E3ODkyZGZjYjQ4NDA5N2UyNWIzNTc0Yzc4OTViZTRiZWM2OWQ0YTM1
-    MDNiNTY3MTBiYzIyZjQwNWIzN2Q0OWU0MTE0MjhlMTIxMGU5YzM=
+    MGM0NGM3Y2FmOWJmODJiYjM3MGQ2MTJhYzg3MGE5YjZlY2JhMjFlNjYxNTUy
+    ODcwMDQ5NDE4ZTMxZjEwMjc2YmExNDk2ZjIyMDBmMDU0YjcwOWYzOWFkZDk2
+    YThkMDBhZjk5NzVlMjIyNTA0MjU2OGQwZjQzNjU4MTM5ODIyOWQ=

data/.rspec

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

data/README.md

@@ -1,27 +1,63 @@
 # Braise
 
-TODO: Write a gem description
+Braise is a tool to help debug ruby applications by providing shortcuts for the `raise` method.
 
-## Installation
+Braise comes with 2 helper methods, `braise` and `craise`.
 
-Add this line to your application's Gemfile:
+`braise` (short for *brief raise*) eliminates the need for calling inspect on an object
+```
+braise obj # is equivalent to "raise obj.inspect"
+```
 
-    gem 'braise'
+`craise` (short for *colorful raise*) allows you to specify options for coloring terminal output
+```
+# will raise an exception using white text on a red background for terminal output
+# this is equivalent to "raise ANSI.white_on_red obj.inspect"
+craise obj
+```
 
-And then execute:
+Braise uses the [ansi](https://github.com/rubyworks/ansi) gem for specifying font color on the terminal. See ansi's [documentation](http://rubydoc.info/github/rubyworks/ansi/master/ANSI/Mixin) for a full list of available color schemes.
 
-    $ bundle
+## Installation
+### Ruby applications
+On the command line, simply run:
+```
+$ gem install braise
+```
 
-Or install it yourself as:
+Then in the ruby program, require braise:
+```
+require 'braise'
+```
 
-    $ gem install braise
+See the `examples` folder for specific examples of the `braise` and `craise` methods.
 
-## Usage
+### Rails applications
+It is recommended that you put the braise gem in the `:development` group of the Gemfile:
+```
+  group :development do
+    # ...other development gems
+    gem 'braise'
+  end
+```
+
+The gem will still work if you add it to top level of the Gemfile, but probably shouldn't be since Braise is intended to be used as a debugging tool.
+
+Then bundle per usual:
+
+    $ bundle
 
-TODO: Write usage instructions here
+If you'd like to override the default color scheme or set additional flags, you can use an initializer like `/config/initializers/braise.rb` :
+```
+if defined?(Braise) # check to make Braise is defined in the current environment
+  # override the default color scheme, use white_on_green
+  Braise::Settings.configure({:color => ANSI.white_on_green})
+end
+```
 
 ## Contributing
 
+0. Check to see if the issue exists in the project's [tracker](https://github.com/MrAlexLau/braise/issues).
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)

data/braise.gemspec

@@ -7,8 +7,8 @@ Gem::Specification.new do |spec|
   spec.name          = "braise"
   spec.version       = Braise::VERSION
   spec.authors       = ["Alex Lau"]
-  spec.description   = "Better raise for ruby"
-  spec.summary       = "Add extra options to ruby's raise method."
+  spec.description   = "Syntatic sugar for the raise method"
+  spec.summary       = "Shortcuts `raise obj.inspect` and makes it easy to add color terminal output"
   spec.homepage      = "https://github.com/MrAlexLau/braise"
   spec.license       = "MIT"
 
@@ -19,5 +19,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
   spec.add_dependency "ansi"
 end

data/{example/braise_example.rb → examples/braise_usage.rb}

@@ -1,7 +1,6 @@
 require 'braise'
-require 'ansi'
 include Braise
 
 arr = [1, 2, 3]
 
-braise arr
+braise arr # equivalent to "raise arr.inspect"

data/examples/craise_usage.rb

@@ -0,0 +1,14 @@
+require 'braise'
+require 'ansi'
+
+include Braise
+
+arr = [1, 2, 3]
+
+# Braise.configure({:color => ANSI.red}) # set default font color to red
+# Braise.configure({:color => ANSI.on_green}) # set default background color to green
+Braise.configure({:color => ANSI.white_on_yellow}) # set default font color to white and background color to yellow
+
+# raise an exception that writes colorful output to the terminal
+# equivalent to "raise ANSI.on_green arr.inspect"
+craise arr 

data/lib/braise.rb

@@ -1,32 +1,39 @@
-require "braise/version"
-require "ansi"
+require 'braise/version'
+require 'ansi'
 
 module Braise
-  @@config = { :color => ANSI.white_on_red,
-               :additional_flags => "" }
+  class Settings
+    @@config = { :color => ANSI.white_on_red,
+                 :additional_flags => '' }
 
-  @@valid_config_keys = @@config.keys
+    @@valid_config_keys = @@config.keys
+
+    def self.get_options(opts={})
+      Settings.stringify_options(@@config.merge(opts))
+    end
+
+    def self.configure(opts={})
+      opts.each {|k,v| @@config[k.to_sym] = v if @@valid_config_keys.include? k.to_sym}
+    end
+
+    private
+
+    def self.stringify_options(opts)
+      return opts.values.join(' ').strip
+    end
+  end
 
   # brief raise
   def braise(obj)
     raise obj.inspect
   end
 
-  # colored raise
+  # colorful raise
   def craise(obj, opts={})
-    opts_str = stringify_options(@@config.merge(opts))
+    opts_str = Settings.get_options(opts)
 
     raise (opts_str + obj.inspect + ANSI.clear)
   end
-
-  def configure(opts={})
-    opts.each {|k,v| @@config[k.to_sym] = v if @@valid_config_keys.include? k.to_sym}
-  end
-
-  private 
-
-  def stringify_options(opts_hash)
-    return opts_hash.inject(""){|result, pair| result.to_s + " " + pair[1].to_s}.strip
-  end
-
 end
+
+include Braise

data/lib/braise/version.rb

@@ -1,3 +1,3 @@
 module Braise
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/spec/braise_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+include Braise
+
+describe Braise do
+  before(:each) do
+    @@config = { :color => ANSI.white_on_red, :additional_flags => "" }
+  end
+
+  describe 'braise' do
+    it 'should raise an exception on an inspected array' do
+      arr = [1, 2]
+
+      begin
+        braise arr
+      rescue Exception => e
+        e.message.should eq(arr.inspect)
+      end
+    end
+  end # end braise
+
+  describe 'craise' do
+    it 'should raise an exception with colorful font on an inspected array' do
+      arr = [1, 2]
+
+      begin
+        craise arr
+      rescue Exception => e
+        e.message.should eq(ANSI.white_on_red + arr.inspect + ANSI.clear)
+      end
+    end
+
+    it 'should raise an exception with a green background' do
+      Braise::Settings.configure({:color => ANSI.green})
+      arr = [1, 2]
+
+      begin
+        craise arr
+      rescue Exception => e
+        e.message.should eq(ANSI.green + arr.inspect + ANSI.clear)
+      end
+    end
+  end # end craise
+
+
+  describe 'Settings' do
+    describe 'configure' do
+      it 'should set color option' do
+        # white_on_red is the default color scheme
+        Braise::Settings.get_options().should eq(ANSI.white_on_red)
+
+        # example background color
+        Braise::Settings.configure({:color => ANSI.on_green})
+        Braise::Settings.get_options().should eq(ANSI.on_green)
+
+        # example font color
+        Braise::Settings.configure({:color => ANSI.red})
+        Braise::Settings.get_options().should eq(ANSI.red)
+
+        # example mixed color
+        Braise::Settings.configure({:color => ANSI.black_on_yellow})
+        Braise::Settings.get_options().should eq(ANSI.black_on_yellow)
+      end
+
+      it 'should set additional_flags option' do
+        opts_before = Braise::Settings.get_options()
+        additional_opts = 'any other option'
+
+        # example background additional_flags
+        Braise::Settings.configure({:additional_flags => additional_opts})
+        Braise::Settings.get_options().should eq("#{opts_before} #{additional_opts}")
+      end
+
+      it 'should set both options at once' do
+        additional_opts = 'any other option'
+
+        Braise::Settings.get_options().should_not eq("#{ANSI.blue} #{additional_opts}")
+        Braise::Settings.configure({:color => ANSI.blue, :additional_flags => additional_opts})
+        Braise::Settings.get_options().should eq("#{ANSI.blue} #{additional_opts}")
+      end
+
+      it 'should not set key with invalid name' do
+        invalid_string = 'a string'
+        opts_before = Braise::Settings.get_options()
+
+        Braise::Settings.configure({:invalid_key => invalid_string})
+        Braise::Settings.get_options().index(invalid_string).should be_nil
+      end
+    end # end configure
+
+    describe 'stringify_options' do
+      it 'should convert empty hash to empty string' do
+        Braise::Settings.stringify_options({}).should be_empty
+      end
+
+      it 'should convert options hash to string' do
+        # results should be separated by spaces
+        Braise::Settings.stringify_options({:key1 => 'value1', :key2 => 'value2'}).should eq('value1 value2')
+        Braise::Settings.stringify_options({:key1 => 'value1', :key2 => 'value2', :key3 => 'value3'}).should eq('value1 value2 value3')
+      end
+    end # end stringify_options
+  end # end Settings
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'ansi'
+require 'braise'
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: braise
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Alex Lau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-29 00:00:00.000000000 Z
+date: 2014-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ansi
   requirement: !ruby/object:Gem::Requirement
@@ -52,22 +66,25 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Better raise for ruby
+description: Syntatic sugar for the raise method
 email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - braise.gemspec
-- example/braise_example.rb
-- example/craise_example.rb
+- examples/braise_usage.rb
+- examples/craise_usage.rb
 - lib/braise.rb
 - lib/braise/version.rb
+- spec/braise_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/MrAlexLau/braise
 licenses:
 - MIT
@@ -91,5 +108,7 @@ rubyforge_project:
 rubygems_version: 2.1.10
 signing_key: 
 specification_version: 4
-summary: Add extra options to ruby's raise method.
-test_files: []
+summary: Shortcuts `raise obj.inspect` and makes it easy to add color terminal output
+test_files:
+- spec/braise_spec.rb
+- spec/spec_helper.rb

data/example/craise_example.rb

@@ -1,8 +0,0 @@
-require 'braise'
-require 'ansi'
-include Braise
-
-arr = [1, 2, 3]
-
-Braise.configure({:color => ANSI.on_green})
-craise arr