utility_belt 1.0.6 → 1.1.0

data/bin/amazon

@@ -8,11 +8,10 @@ filenames = option_parser.parse(ARGV)
 abort "Usage: amazon -b bucket_name file_name" unless @bucket && filenames
 
 # require files, populate hash
-UTILITY_BELT_IRB_STARTUP_PROCS = {}
-utility_belt_lib = File.dirname(__FILE__) + '/../lib'
-require "#{utility_belt_lib}/mac_clipboard"
-require "#{utility_belt_lib}/amazon_upload_shortcut"
-UTILITY_BELT_IRB_STARTUP_PROCS[:define_s3_convenience_methods].call
+require 'utility_belt'
+UtilityBelt.equip(:amazon_upload_shortcut)
+UtilityBelt.equip(:clipboard)
+include UtilityBelt::AmazonUploadShortcut
 
 # baddabing, baddaboom
 filenames.each {|filename| puts aws_upload(@bucket, filename)}

data/bin/google

@@ -1,18 +1,7 @@
 #!/usr/bin/env ruby
-%w{rubygems platform cgi}.each {|library| require library}
+%w{rubygems platform net/http utility_belt}.each {|library| require library}
 
-if :macosx != Platform::IMPL
-  abort "Utility Belt's command-line Google shortcut only works on OS X. Sorry."
-else
-  require "#{File.dirname(__FILE__) + '/../lib'}/mac_clipboard"
-  search_term = ARGV[0] || MacClipboard.read
-  if search_term.empty?
-    puts "Usage: google search_term_without_spaces"
-    puts "       google 'search term with spaces'"
-    puts "       google"
-    puts "              (if invoking without command-line args, must have text in clipboard)"
-    puts "              (if you're seeing this there's a good chance you copied an image or something)"
-    exit
-  end
-  system("open http://google.com/search?q=#{CGI.escape(search_term)}")
-end
+UtilityBelt.equip(:google)
+include UtilityBelt::Google
+
+google(ARGV[0])

data/bin/pastie

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+%w{rubygems utility_belt}.each {|library| require library}
+UtilityBelt.equip(:pastie)
+include UtilityBelt::Pastie
+
+pastie(ARGV[0])

data/lib/utility_belt.rb

@@ -3,37 +3,20 @@
 # 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 = {}
+UTILITY_BELT_IRB_STARTUP_PROCS = {} unless Object.const_defined? :UTILITY_BELT_IRB_STARTUP_PROCS
 
-%w{rubygems
-   platform
-   wirble
-   net/http
-   tempfile}.each {|library| require library}
-%w{init colorize}.each {|message| Wirble.send(message)}
-%w{mac_clipboard
-   is_an
-   pastie
-   themes
-   irb_verbosity_control
-   rails_verbosity_control
-   command_history
-   not
-   language_greps
-   rails_finder_shortcut
-   amazon_upload_shortcut
-   irb_options
-   interactive_editor
-   string_to_proc
-   symbol_to_proc
-   hash_math
-   with}.each {|internal_library| require internal_library}
+%w{rubygems utility_belt/equipper}.each {|internal_library| require internal_library}
 
-# default: dark background
-UtilityBelt::Themes.background(:dark)
+if Object.const_defined? :IRB
 
-# Called when the irb session is ready, after any external libraries have been loaded. I can't
-# remember why I did this. it might be a cargo cult thing.
-IRB.conf[:IRB_RC] = lambda do
-  UTILITY_BELT_IRB_STARTUP_PROCS.each {|symbol, proc| proc.call}
+  # 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/lib/utility_belt/amazon_upload_shortcut.rb

@@ -0,0 +1,25 @@
+# S3 (http://amazon.rubyforge.org/)
+%w{aws/s3 cgi platform}.each {|lib| require lib}
+
+module UtilityBelt
+  module AmazonUploadShortcut
+    def aws_upload(bucket,filename)
+      AWS::S3::Base.establish_connection!(:access_key_id => ENV['AMAZON_ACCESS_KEY_ID'], 
+                                          :secret_access_key => ENV['AMAZON_SECRET_ACCESS_KEY'])
+      AWS::S3::S3Object.store(filename, open(filename), bucket, :access => :public_read)
+      url = "http://s3.amazonaws.com/#{bucket}/#{filename}".gsub(/ /, "%20")
+      Clipboard.write(url) if Clipboard.available?
+      url
+    end
+  end
+end
+    
+class Object
+  include UtilityBelt::AmazonUploadShortcut
+end if Object.const_defined? :IRB
+
+# a quick note: the "google" command uses CGI.escape, but the URLs produced by CGI.escape
+# don't seem to succeed here, in practice. this may differ by OS and/or browser. Let me
+# know if you see something weird -- the Utility Belt mailing list is here:
+#
+# http://rubyforge.org/mailman/listinfo/utilitybelt-tinkering

data/lib/utility_belt/clipboard.rb

@@ -0,0 +1,52 @@
+# original clipboard code: http://project.ioni.st/post/1334#snippet_1334
+# turned it into a class to make it flexxy:
+# http://gilesbowkett.blogspot.com/2007/09/improved-auto-pastie-irb-code.html
+# Extended to handle windows and linux as well
+require 'platform'
+
+module UtilityBelt
+  class Clipboard
+    
+    def self.available?
+      @@implemented || false
+    end
+    
+    case Platform::IMPL
+    when :macosx
+
+      def self.read
+        IO.popen('pbpaste') {|clipboard| clipboard.read}
+      end
+
+      def self.write(stuff)
+        IO.popen('pbcopy', 'w+') {|clipboard| clipboard.write(stuff)}
+      end
+      @@implemented = true
+  
+    when :mswin
+
+      begin
+        # Try loading the win32-clipboard gem
+        require 'win32/clipboard'
+
+        def self.read
+          Win32::Clipboard.data
+        end
+
+        def self.write(stuff)
+          Win32::Clipboard.set_data(stuff)
+        end
+        @@implemented = true
+
+      rescue LoadError
+        raise "You need the win32-clipboard gem for clipboard functionality!"
+      end
+  
+    else
+      raise "No suitable clipboard implementation for your platform found!"
+    end
+    
+  end
+end
+
+Clipboard = UtilityBelt::Clipboard if Object.const_defined? :IRB

data/lib/{command_history.rb → utility_belt/command_history.rb}

@@ -23,6 +23,8 @@
 #  $Id: history.rb 50 2007-07-30 18:55:09Z ben $
 #
 
+require 'tempfile'
+
 class Object
   def history(how_many = 50)
     history_size = Readline::HISTORY.size
@@ -54,15 +56,28 @@ class Object
     end
     file.close
   end
+  
+  # hack to handle JRuby bug
+  def handling_jruby_bug(&block)
+    if RUBY_PLATFORM =~ /java/
+      puts "JRuby IRB has a bug which prevents successful IRB vi interoperation."
+      puts "The JRuby team is aware of this and working on it."
+      puts "(http://jira.codehaus.org/browse/JRUBY-2049)"
+    else
+      yield
+    end
+  end
 
   # TODO: history_write should go to a file, or the clipboard, or a file which opens in an application
   def history_to_vi
-    file = Tempfile.new("irb_tempfile")
-    get_lines(0..(Readline::HISTORY.size - 1)).each do |line|
-      file << "#{line}\n"
+    handling_jruby_bug do
+      file = Tempfile.new("irb_tempfile")
+      get_lines(0..(Readline::HISTORY.size - 1)).each do |line|
+        file << "#{line}\n"
+      end
+      file.close
+      system("vim #{file.path}")
     end
-    file.close
-    system("vim #{file.path}")
   end
   alias :hvi :history_to_vi
 

data/lib/utility_belt/convertable_to_file.rb

@@ -0,0 +1,34 @@
+require 'tempfile'
+
+# This module adds a method, #to_file, which dumps the contents of self into a
+# temp file and then returns the path of that file.  This is particularly useful
+# when calling out to shell commands which expect their input in the form of
+# files.
+#
+# Example: use UNIX 'diff' to compare two objects:
+#
+#    >> a = ["foo", "bar", "baz"].join("\n")
+#    => "foo\nbar\nbaz"
+#    >> b = ["foo", "buz", "baz"].join("\n")
+#    => "foo\nbuz\nbaz"
+#    >> puts `diff #{a.to_file} #{b.to_file}`
+#    2c2
+#    < bar
+#    ---
+#    > buz
+#    => nil
+#
+module ConvertableToFile
+  def to_file
+    path = nil
+    Tempfile.open(object_id.to_s) do |tempfile|
+      tempfile << self
+      path = tempfile.path
+    end
+    path
+  end
+end
+
+class Object
+  include ConvertableToFile
+end

data/lib/utility_belt/equipper.rb

@@ -0,0 +1,72 @@
+# Allow to select which gadgets to equip
+#
+# Author: Markus Prinz <markus.prinz@qsig.org>
+
+module UtilityBelt
+  class << self
+    def equip(*args)
+      Equipper.equip(*args)
+    end
+    def equipped?
+      Equipper.equipped?
+    end
+  end
+  module Equipper
+    GADGETS = Dir[File.join(File.dirname(__FILE__), '*.rb')].map{|file| File.basename(file)[0..-4]}.reject{|gadget| "equipper" == gadget }
+
+    DEFAULTS = %w{wirble
+                  hash_math
+                  command_history
+                  interactive_editor
+                  irb_options
+                  irb_verbosity_control}
+
+    @equipped = false
+
+    class << self
+      def equip(*args)
+        return if args.empty?
+
+        gadgets_to_equip = []
+
+        # Special case using :all or :none
+        if args[0].is_a?(Symbol) && [:all, :none, :defaults].include?(args[0])
+          what = args[0]
+
+          unless args[1].nil?
+            exceptions = args[1].has_key?(:except) ? args[1][:except] : []
+
+            # Handle special case where we get a string or a symbol instead of an array
+            exceptions = exceptions.to_s.to_a unless exceptions.is_a?( Array )
+          else
+            exceptions = []
+          end
+
+          case what
+          when :all
+            gadgets_to_equip.push(*(GADGETS - exceptions))
+          when :none
+            gadgets_to_equip.push(*exceptions)
+          when :defaults
+            gadgets_to_equip.push(*DEFAULTS)
+          end
+        # otherwise, args is a list of gadgets to equip
+        else
+          args.each do |arg|
+            gadget = arg.to_s
+
+            # Silently ignore unkown gadgets
+            gadgets_to_equip << gadget if GADGETS.include? gadget
+          end
+        end
+
+        gadgets_to_equip.each{|gadget| require "utility_belt/#{gadget}" }
+
+        @equipped ||= true
+      end
+      def equipped?
+        @equipped
+      end
+    end
+  end
+end

data/lib/utility_belt/google.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+%w{rubygems platform cgi}.each {|library| require library}
+
+UtilityBelt.equip(:clipboard)
+
+module UtilityBelt
+  module Google
+    def google(search_term = nil)
+      search_term ||= Clipboard.read if Clipboard.available?
+      if search_term.empty?
+        puts "Usage: google search_term_without_spaces           (Unix command line only)"
+        puts "       google 'search term with spaces'            (Unix or IRB)"
+        puts "       google                                      (Unix or IRB)"
+        puts "              (if invoking without args, must have text in clipboard)"
+      else
+        url = "http://google.com/search?q=#{CGI.escape(search_term)}"
+        case Platform::IMPL
+        when :macosx
+          Kernel.system("open #{url}")
+        when :windows
+          Kernel.system("start #{url}")
+        #when :linux
+        else
+          puts "Sorry, don't know how to open an URL from the command line on your platform"
+        end
+      end
+    end
+  end
+end
+
+class Object
+  include UtilityBelt::Google
+end if Object.const_defined? :IRB

data/lib/utility_belt/hash_math.rb

@@ -0,0 +1,10 @@
+class Hash
+  alias :+ :merge
+  def -(other)
+    if other.is_a? Hash
+      reject { |k,v| other[k] == v }
+    else
+      reject { |k,v| k == other }
+    end
+  end
+end

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."
+      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