bruce-banner 0.0.3

data/.gitignore

@@ -0,0 +1,22 @@
+*.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'
+
+# Specify your gem's dependencies in bruce-banner.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 bjh
+
+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,108 @@
+bruce-banner
+# BruceBanner
+
+I am a lazy b****
+I debug old school quite a lot and usually end up typing this pattern over and over:  
+```ruby
+puts '*' * 40
+puts "thing: #{thing}"
+```
+
+Since my laziness knows no bounds I created this so I can do this instead:
+
+```ruby
+bb thing
+```
+
+## Usage
+
+in irb:
+
+```ruby
+require 'bruce-banner'
+
+# NOTE: if sticking a Hash directly in the call you may need the parens
+bb({one:1, two:2}) 
+
+# output with the default settings
+------------------
+{:one=>1, :two=>2}
+```
+
+Even better magic shamelessy stolen from Jim Weirich.  
+You pass a block with the name of a variable and it will print the name and the value.
+
+```ruby
+magic = "this is voodoo magic!"
+bb {:magic} 
+
+# outputs
+----------------------------
+magic: this is voodoo magic!
+
+# NOTE: passing the block overrides any passed in value but will pick up defaults
+bb(magic, after:true) {:magic}
+
+# outputs
+----------------------------
+magic: this is voodoo magic!
+----------------------------
+```
+
+## Configuration Options
+
+`:count`  set the size of the banner string. Will be overridden if `size_to_fit` is true.  
+`:string` set the string to be repeated as the banner. Default is `'-'`  
+`:before` print the banner string before the payload? Defaults is `true`  
+`:after`  print the banner string after the payload?  Defaults is `false`  
+`:size_to_fit` counts the size of the payload string and uses that value as the banner size. Default is `true`. Will override `count` if set to `true`.
+
+```ruby
+BruceBanner.configuration do |defaults_hash|
+    defaults_hash[:count] = 60
+    defaults_hash[:size_to_fit] = false
+end
+```
+
+You can also override the defaults on a per call basis:
+
+```ruby
+bb({one:1, two:2}, after:true, string:'*')
+
+# outputs
+******************
+{:one=>1, :two=>2}
+******************
+```
+
+## And just for fun!
+
+```ruby
+BruceBanner.make_him_angry!
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bruce-banner'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bruce-banner
+
+
+## TODO
+
+make the output string more configurable, possibly allow creation of a message template.  
+i.e. 
+```ruby
+BruceBanner.template = "%s: %s"
+bb("thing", 1432) #=> thing: 1432
+```
+
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bruce-banner.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bruce-banner/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "bruce-banner"
+  gem.version       = BruceBanner::VERSION
+  gem.authors       = ["bjh"]
+  gem.email         = ["bjh@fake.fake"]
+  gem.description   = %q{wraps `puts' output with a banner}
+  gem.summary       = %q{gem summary: I am a lazy bitch...hence the birth of this gem.}
+  gem.homepage      = "https://github.com/bjh/bruce-banner"
+
+  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/lib/bruce-banner/version.rb

@@ -0,0 +1,3 @@
+module BruceBanner
+  VERSION = "0.0.3"
+end

data/lib/bruce-banner.rb

@@ -0,0 +1,94 @@
+require "bruce-banner/version"
+
+module BruceBanner
+
+  def self.make_him_angry!
+    # ASCII art from http://www.oocities.org/joan_stark/hulk.txt
+    output = []
+    output << "                 ,#####,                "
+    output << "                 #_   _#                "
+    output << "                 |e` `e|                "
+    output << "                 |  u  |                "
+    output << "                 \\  =  /                "
+    output << "                 |\\___/|                "
+    output << "        ___ ____/:     :\\____ ___       "
+    output << "      .'   `.-===-\\   /-===-.`   '.     "
+    output << '     /      .-"""""-.-"""""-.      \    '
+    output << "    /'             =:=             '\\   "
+    output << "  .'  ' .:    o   -=:=-   o    :. '  `. "
+    output << "  (.'   /'. '-.....-'-.....-' .'\\   '.) "
+    output << "  /' ._/   \".       :       .\"   \\_. '\\ "
+    output << " |  .'|      \".  ---:---  .\"     |'.  | "
+    output << " |  : |       |  ---:---  |      | :  | "
+    output << "  \\ : |       |_____:_____|      | : /  "
+    output << "  /   (       |----|------|      )   \\  "
+    output << " /... .|      /`   |     '\\    |. ...\\  "
+    output << "|::::/''     /    .L__.    \\   ''\\::::| "
+    output << " \"\"\"\"       /      / \\      \\     \"\"\"\"  "
+    output << "           :      /   \\      :          "
+    output << "           |     /     \\     |          "
+    output << "           \\    /       \\    /          "
+    output << "            )  |         |  (           "
+    output << "           /   |         |   \\          "
+    output << "          (/\\/\\|         |/\\/\\)         "
+    output << "           \\  |           |  /          "
+    output << "            ) |           | (           "
+    output << "       _.-'`   \\         /   `'-._      "
+    output << "      :________/         \\________;     "
+    output << ""
+    output << "ASCII art from http://www.oocities.org/joan_stark/hulk.txt"
+
+    puts output.join "\n"
+  end
+
+  module Configuration
+    attr_accessor :defaults
+  end
+
+
+  # this is where the magic happens...
+  module ::Kernel
+    # block magic shamelessly stolen from Jim Weirich (with a small tweak)
+    # http://www.justskins.com/forums/print-out-a-variables-101209.html
+    def bb(what="", options={}, &block)
+      options = BruceBanner.defaults.merge(options)
+
+      if block_given?
+        name = block.call.to_s
+        what = "#{name}: #{eval(name, block.binding)}"
+      end
+
+      if options[:size_to_fit]
+        options[:count] = what.to_s.size
+      end
+
+      puts(options[:string] * options[:count]) if options[:before]
+      puts "#{what}"
+      puts(options[:string] * options[:count]) if options[:after]
+    end
+
+
+    # def debug(&block)
+    #   name = block.call.to_s
+    #   bb "#{name} = #{eval(name, block.binding)}"
+    # end
+  end
+
+  # configure-ater-iter-voodoo
+  def self.configuration
+    yield(self.defaults) if block_given?
+  end
+
+  extend Configuration
+
+  # Hulk SMASH!
+  attr_accessor :defaults
+
+  self.defaults = {
+    count:40,
+    string:'-',
+    before:true,
+    after:false,
+    size_to_fit:true
+  }
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: bruce-banner
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- bjh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-21 00:00:00.000000000 Z
+dependencies: []
+description: wraps `puts' output with a banner
+email:
+- bjh@fake.fake
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bruce-banner.gemspec
+- lib/bruce-banner.rb
+- lib/bruce-banner/version.rb
+homepage: https://github.com/bjh/bruce-banner
+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.25
+signing_key: 
+specification_version: 3
+summary: ! 'gem summary: I am a lazy bitch...hence the birth of this gem.'
+test_files: []