rwilcox-utility_belt 1.0.7

data/lib/utility_belt/interactive_editor.rb

@@ -0,0 +1,78 @@
+# Giles Bowkett, Greg Brown, and several audience members from Giles' Ruby East presentation.
+require 'tempfile'
+class InteractiveEditor
+  DEBIAN_SENSIBLE_EDITOR = "/usr/bin/sensible-editor"
+  MACOSX_OPEN_CMD        = "open"
+  XDG_OPEN               = "/usr/bin/xdg-open"
+
+  def self.sensible_editor
+    return ENV["VISUAL"] if ENV["VISUAL"]
+    return ENV["EDITOR"] if ENV["EDITOR"]
+    return MACOSX_OPEN_CMD if Platform::IMPL == :macosx
+    if Platform::IMPL == :linux
+      if File.executable?(XDG_OPEN)
+        return XDG_OPEN
+      end
+      if File.executable?(DEBIAN_SENSIBLE_EDITOR)
+        return DEBIAN_SENSIBLE_EDITOR
+      end
+    end
+    raise "Could not determine what editor to use.  Please specify."
+  end
+
+  attr_accessor :editor
+  def initialize(editor = :vim)
+    @editor = editor.to_s
+    if @editor == "mate"
+      @editor = "mate -w"
+    end
+  end
+  def edit_interactively
+    unless @file
+      @file = Tempfile.new("irb_tempfile")
+    end
+    system("#{@editor} #{@file.path}")
+    Object.class_eval(`cat #{@file.path}`)
+    rescue Exception => error
+      puts error
+  end
+end
+
+module InteractiveEditing
+  def edit_interactively(editor = InteractiveEditor.sensible_editor)
+    unless IRB.conf[:interactive_editors] && IRB.conf[:interactive_editors][editor]
+      IRB.conf[:interactive_editors] ||= {}
+      IRB.conf[:interactive_editors][editor] = InteractiveEditor.new(editor)
+    end
+    IRB.conf[:interactive_editors][editor].edit_interactively
+  end
+  
+  def handling_jruby_bug(&block)
+    if RUBY_PLATFORM =~ /java/
+      puts "JRuby IRB has a bug which prevents successful IRB vi/emacs editing."
+      puts "The JRuby team is aware of this and working on it. But it might be unfixable."
+      puts "(http://jira.codehaus.org/browse/JRUBY-2049)"
+    else
+      yield
+    end
+  end
+
+  def vi
+    handling_jruby_bug {edit_interactively(:vim)}
+  end
+
+  def mate
+    edit_interactively(:mate)
+  end
+
+  # TODO: Hardcore Emacs users use emacsclient or gnuclient to open documents in
+  # their existing sessions, rather than starting a brand new Emacs process.
+  def emacs
+    handling_jruby_bug {edit_interactively(:emacs)}
+  end
+end
+
+# Since we only intend to use this from the IRB command line, I see no reason to
+# extend the entire Object class with this module when we can just extend the
+# IRB main object.
+self.extend InteractiveEditing if Object.const_defined? :IRB

data/lib/utility_belt/irb_options.rb

@@ -0,0 +1,3 @@
+# auto indent, _ special var
+IRB.conf[:AUTO_INDENT] = true
+IRB.conf[:EVAL_HISTORY] = 1000

data/lib/utility_belt/irb_verbosity_control.rb

@@ -0,0 +1,30 @@
+# IRB verbosity: http://groups.google.com/group/ruby-talk-google/browse_thread/thread/9c1febbe05513dc0
+module IRB 
+  def self.result_format 
+     conf[:PROMPT][conf[:PROMPT_MODE]][:RETURN] 
+  end 
+  def self.result_format=(str) 
+     result_format.replace(str) 
+  end 
+  def self.show_results 
+     self.result_format = "=> %s\n"
+  end 
+  def self.hide_results 
+     self.result_format = '' 
+  end 
+end
+
+class Object
+  def verbose
+    IRB.show_results
+  end
+  alias :v :verbose
+
+  def quiet
+    IRB.hide_results
+  end
+  alias :q :quiet
+
+  alias :x :exit
+end
+

data/lib/utility_belt/is_an.rb

@@ -0,0 +1,4 @@
+# is_a? Array bothers me
+class Object
+  alias :is_an? :is_a?
+end

data/lib/utility_belt/language_greps.rb

@@ -0,0 +1,28 @@
+# fix by Bob Hutchison:
+class String
+  unless public_method_defined? :blank?
+    def blank?
+      self !~ /\S/
+    end
+  end
+end
+
+# TODO: upgrade these to take either regexes or strings
+
+# http://gilesbowkett.blogspot.com/2006/12/smalltalk-cleverness-translated-into.html
+# http://gilesbowkett.com/blog_code_samples/122906_seaside_rails/controller.txt
+class Object
+  def grep_classes(search_term)
+    classes = []
+    ObjectSpace.each_object {|object| classes << object.name if object.is_a? Class and not object.name.blank?}
+    classes.find_all {|klass| klass.downcase.include? search_term.downcase}
+  end
+end
+
+# http://gilesbowkett.blogspot.com/2007/11/irb-what-was-that-method-again.html
+class Object
+  def grep_methods(search_term)
+    methods.find_all {|method| method.downcase.include? search_term.downcase}
+  end
+end
+

data/lib/utility_belt/not.rb

@@ -0,0 +1,15 @@
+# http://blog.jayfields.com/2007/08/ruby-adding-not-method-for-readability.html
+class Object
+  define_method :not do
+    Not.new(self)
+  end
+  class Not
+    private *instance_methods.select { |m| m !~ /(^__|^\W|^binding$)/ }
+    def initialize(subject)
+      @subject = subject
+    end
+    def method_missing(sym, *args, &blk)
+      !@subject.send(sym,*args,&blk)
+    end
+  end
+end

data/lib/utility_belt/pastie.rb

@@ -0,0 +1,34 @@
+# automate creating pasties
+%w{platform net/http utility_belt}.each {|lib| require lib}
+UtilityBelt.equip(:clipboard)
+
+module UtilityBelt
+  module Pastie
+    def pastie(stuff_to_paste = nil)
+      stuff_to_paste ||= Clipboard.read if Clipboard.available?
+      # return nil unless stuff_to_paste
+
+      pastie_url = Net::HTTP.post_form(URI.parse("http://pastie.caboo.se/pastes/create"),
+                                       {"paste_parser" => "ruby",
+                                        "paste[authorization]" => "burger",
+                                        "paste[body]" => stuff_to_paste}).body.match(/href="([^\"]+)"/)[1]
+
+      Clipboard.write(pastie_url) if Clipboard.available?
+      
+      case Platform::IMPL
+      when :macosx
+        Kernel.system("open #{pastie_url}")
+      when :mswin
+        pastie_url = pastie_url.chop if pastie_url[-1].chr == "\000"
+        Kernel.system("start #{pastie_url}")
+      end
+
+      return pastie_url
+    end
+    alias :pst :pastie
+  end
+end
+
+class Object
+  include UtilityBelt::Pastie
+end if Object.const_defined? :IRB

data/lib/utility_belt/pipe.rb

@@ -0,0 +1,24 @@
+# This extension adds a UNIX-style pipe to strings
+#
+# Synopsis:
+#
+# >> puts "UtilityBelt is better than alfalfa" | "cowsay"
+#  ____________________________________
+# < UtilityBelt is better than alfalfa >
+#  ------------------------------------
+#         \   ^__^
+#          \  (oo)\_______
+#             (__)\       )\/\
+#                 ||----w |
+#                 ||     ||
+# => nil
+#
+class String
+  def |(cmd)
+    IO.popen(cmd, 'r+') do |pipe|
+      pipe.write(self)
+      pipe.close_write
+      pipe.read
+    end
+  end
+end

data/lib/utility_belt/rails_finder_shortcut.rb

@@ -0,0 +1,18 @@
+# http://www.clarkware.com/cgi/blosxom/2007/09/03#ConsoleFindShortcut
+# Mike Clark's find() shortcut for Rails console
+
+# Creates shortcut methods for finding models.
+UTILITY_BELT_IRB_STARTUP_PROCS[:define_model_find_shortcuts] = lambda do
+  if defined? ActiveRecord::Base || defined? ActiveResource::Base
+    model_files = Dir.glob("app/models/**/*.rb")
+    table_names = model_files.map { |f| File.basename(f).split('.')[0..-2].join }
+    table_names.each do |table_name|
+      Object.instance_eval do
+        define_method(table_name) do |*args|
+          table_name.camelize.constantize.send(:find, *args)
+        end
+      end
+    end
+  end
+end
+# note: Mike wrote this for ARec, but it works on ARes too since it doesn't hit the DB

data/lib/utility_belt/rails_verbosity_control.rb

@@ -0,0 +1,8 @@
+# Rails verbosity: http://weblog.jamisbuck.org/2007/1/8/watching-activerecord-do-it-s-thing
+# Marcel said they toyed with making this the console default on core
+class Object
+  def log
+    ActiveRecord::Base.clear_active_connections!
+    ActiveRecord::Base.logger = Logger.new(STDOUT)
+  end
+end

data/lib/utility_belt/string_to_proc.rb

@@ -0,0 +1,72 @@
+# String#to_proc
+#
+# See http://weblog.raganwald.com/2007/10/stringtoproc.html
+#
+# Ported from the String Lambdas in Oliver Steele's Functional Javascript
+# http://osteele.com/sources/javascript/functional/
+#
+# This work is licensed under the MIT License:
+#
+# (c) 2007 Reginald Braithwaite
+# Portions Copyright (c) 2006 Oliver Steele
+# 
+# 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.
+
+class String
+  unless public_method_defined? :to_proc
+    def to_proc &block
+      params = []
+      expr = self
+      sections = expr.split(/\s*->\s*/m)
+      if sections.length > 1 then
+          eval_block(sections.reverse!.inject { |e, p| "(Proc.new { |#{p.split(/\s/).join(', ')}| #{e} })" }, block)
+      elsif expr.match(/\b_\b/)
+          eval_block("Proc.new { |_| #{expr} }", block)
+      else
+          leftSection = expr.match(/^\s*(?:[+*\/%&|\^\.=<>\[]|!=)/m)
+          rightSection = expr.match(/[+\-*\/%&|\^\.=<>!]\s*$/m)
+          if leftSection || rightSection then
+              if (leftSection) then
+                  params.push('$left')
+                  expr = '$left' + expr
+              end
+              if (rightSection) then
+                  params.push('$right')
+                  expr = expr + '$right'
+              end
+          else
+              self.gsub(
+                  /(?:\b[A-Z]|\.[a-zA-Z_$])[a-zA-Z_$\d]*|[a-zA-Z_$][a-zA-Z_$\d]*:|self|arguments|'(?:[^'\\]|\\.)*'|"(?:[^"\\]|\\.)*"/, ''
+              ).scan(
+                /([a-z_$][a-z_$\d]*)/i
+              ) do |v|  
+                params.push(v) unless params.include?(v)
+              end
+          end
+          eval_block("Proc.new { |#{params.join(', ')}| #{expr} }", block)
+      end
+    end
+    private
+    def eval_block(code, block)
+      eval code, block && block.binding
+    end
+  end
+end
+

data/lib/utility_belt/symbol_to_proc.rb

@@ -0,0 +1,30 @@
+#--
+# Copyright (c) 2005 David Heinemeier Hansson
+#
+# 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.
+#++
+
+class Symbol
+  unless public_method_defined? :to_proc
+    def to_proc
+      Proc.new { |*args| args.shift.__send__(self, *args) }
+    end
+  end
+end

data/lib/utility_belt/wirble.rb

@@ -0,0 +1,83 @@
+require 'wirble'
+Wirble.init
+Wirble.colorize
+
+module UtilityBelt
+  module Themes
+    def self.background(bkg)
+      case bkg
+      when :dark
+        Wirble::Colorize.colors = UtilityBelt::Themes::WIRBLE_DEFAULT_THEME
+      when :light
+        Wirble::Colorize.colors = UtilityBelt::Themes::THEME_FOR_WHITE_BKG
+      end
+    end
+    WIRBLE_DEFAULT_THEME = {
+      # delimiter colors
+      :comma              => :blue,
+      :refers             => :blue,
+
+      # container colors (hash and array)
+      :open_hash          => :green,
+      :close_hash         => :green,
+      :open_array         => :green,
+      :close_array        => :green,
+
+      # object colors
+      :open_object        => :light_red,
+      :object_class       => :white,
+      :object_addr_prefix => :blue,
+      :object_line_prefix => :blue,
+      :close_object       => :light_red,
+
+      # symbol colors
+      :symbol             => :yellow,
+      :symbol_prefix      => :yellow,
+
+      # string colors
+      :open_string        => :red,
+      :string             => :cyan,
+      :close_string       => :red,
+
+      # misc colors
+      :number             => :cyan,
+      :keyword            => :green,
+      :class              => :light_green,
+      :range              => :red,
+    }
+    THEME_FOR_WHITE_BKG = {
+      # delimiter colors
+      :comma              => :purple,
+      :refers             => :blue,
+
+      # container colors (hash and array)
+      :open_hash          => :red,
+      :close_hash         => :red,
+      :open_array         => :red,
+      :close_array        => :red,
+
+      # object colors
+      :open_object        => :dark_gray,
+      :object_class       => :purple,
+      :object_addr_prefix => :blue,
+      :object_line_prefix => :blue,
+      :close_object       => :dark_gray,
+
+      # symbol colors
+      :symbol             => :black,
+      :symbol_prefix      => :light_gray,
+
+      # string colors
+      :open_string        => :blue,
+      :string             => :dark_gray,
+      :close_string       => :blue,
+
+      # misc colors
+      :number             => :black,
+      :keyword            => :brown,
+      :class              => :red,
+      :range              => :blue,
+    }
+    COLORS = WIRBLE_DEFAULT_THEME
+  end
+end

data/lib/utility_belt/with.rb

@@ -0,0 +1,21 @@
+# Object#with -- by Dan Yoder, dev.zeraweb.com -- this is something from Pascal
+# and JavaScript. here's the use case.
+
+# instead of:
+#   some_object.do_x
+#   some_object.do_y
+#   some_object.do_z
+#
+# you can instead do:
+#   with(some_object)
+#     do_x
+#     do_y
+#     do_z
+#   end
+
+class Object
+  def with(object, &block)
+    object.instance_eval &block
+  end
+end
+

data/lib/utility_belt.rb

@@ -0,0 +1,22 @@
+# This started as my (Giles Bowkett's) .irbrc file, turned into a recipe on IRB for the Pragmatic Programmers,
+# and soon became a scrapbook of cool code snippets from all over the place. All the RDoc lives in the README.
+# Check that file for usage information, authorship, copyright, and extensive details. You can also find a
+# nice, HTMLified version of the README content at http://utilitybelt.rubyforge.org.
+
+UTILITY_BELT_IRB_STARTUP_PROCS = {} unless Object.const_defined? :UTILITY_BELT_IRB_STARTUP_PROCS
+
+%w{rubygems active_support utility_belt/equipper}.each {|internal_library| require internal_library}
+
+if Object.const_defined? :IRB
+
+  # Called when the irb session is ready, after any external libraries have been loaded. This
+  # allows the user to specify which gadgets in the utility belt to equip. (Kind of pushing the
+  # metaphor, but hey, what the hell.)
+  IRB.conf[:IRB_RC] = lambda do
+    UtilityBelt.equip(:defaults) unless UtilityBelt.equipped?
+    UTILITY_BELT_IRB_STARTUP_PROCS.each {|symbol, proc| proc.call}
+  end
+  
+  # default: dark background
+  UtilityBelt::Themes.background(:dark) if defined? UtilityBelt::Themes
+end

data/spec/convertable_to_file_spec.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+require File.join(File.dirname(__FILE__), "spec_helper")
+
+require 'spec'
+require 'irb'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'utility_belt', 'convertable_to_file')
+
+describe ConvertableToFile do
+  include ConvertableToFile
+
+  before :each do
+    @tempfile = stub("temp file", :<< => nil, :path => nil)
+    Tempfile.stub!(:open).and_yield(@tempfile)
+  end
+
+  it "should create a temp file using object id as basename" do
+    should_receive(:object_id).and_return(6789)
+    Tempfile.should_receive(:open).with("6789").and_yield(@tempfile)
+    to_file
+  end
+
+  it "should dump self to the opened temp file" do
+    @tempfile.should_receive(:<<).with(self)
+    to_file
+  end
+
+  it "should return the temp file path" do
+    @tempfile.should_receive(:path).and_return("TEMP_PATH")
+    to_file.should == "TEMP_PATH"
+  end
+end

data/spec/equipper_spec.rb

@@ -0,0 +1,70 @@
+require File.join(File.dirname(__FILE__), "spec_helper")
+require 'lib/utility_belt/equipper'
+
+# Mocks for the gadgets
+UTILITY_BELT_IRB_STARTUP_PROCS = {}
+
+module IRB
+  def self.conf
+    {}
+  end
+end
+
+describe "UtilityBelt equipper" do
+
+  ALL_GADGETS = UtilityBelt::Equipper::GADGETS
+  DEFAULT_GADGETS = UtilityBelt::Equipper::DEFAULTS
+
+  before(:all) do
+    # I know, global variables are bad, but I can't get this to work otherwise
+    Kernel.__send__(:alias_method, :old_require, :require)
+    Kernel.__send__(:define_method, :require, proc {|library| $required_libs << library[13..-1] })
+  end
+
+  before(:each) do
+    $required_libs = []
+  end
+
+  after(:each) do
+    $required_libs = nil
+  end
+
+  after(:all) do
+    Kernel.__send__(:alias_method, :require, :old_require)
+  end
+
+  it "should load all gadgets" do
+    UtilityBelt.equip(:all)
+    $required_libs.should == ALL_GADGETS
+  end
+
+  it "should load no gadgets" do
+    UtilityBelt.equip(:none)
+    $required_libs.should == []
+  end
+
+  it "should load all default gadegts" do
+    UtilityBelt.equip(:defaults)
+    $required_libs.should == DEFAULT_GADGETS
+  end
+
+  it "should load all gadgets except is_an" do
+    UtilityBelt.equip(:all, :except => ['is_an'])
+    $required_libs.should == ALL_GADGETS - ['is_an']
+  end
+
+  it "should load no gadgets except is_an" do
+    UtilityBelt.equip(:none, :except => ['is_an'])
+    $required_libs.should == ['is_an']
+  end
+
+  it "should accept a string for the except-param" do
+    UtilityBelt.equip(:none, :except => 'is_an')
+    $required_libs.should == ['is_an']
+  end
+
+  it "should accept a symbol for the except-param" do
+    UtilityBelt.equip(:none, :except => :is_an)
+    $required_libs.should == ['is_an']
+  end
+end

data/spec/hash_math_spec.rb

@@ -0,0 +1,17 @@
+require File.join(File.dirname(__FILE__), "spec_helper")
+require "lib/utility_belt/hash_math"
+describe "Hash math" do
+
+  it "should add hashes" do
+    ({:a => :b} + {:c => :d}).should == {:a => :b, :c => :d}
+  end
+
+  it "should subtract hashes" do
+    ({:a => :b, :c => :d} - {:c => :d}).should == {:a => :b}
+  end
+
+  it "should subtract key/value pairs by key" do
+    ({:a => :b, :c => :d} - :c).should == {:a => :b}
+  end
+
+end