utility_belt 1.0.6 → 1.1.0

data/lib/utility_belt/pastie.rb

@@ -0,0 +1,33 @@
+# 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
+        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/prompt.rb

@@ -0,0 +1 @@
+

data/lib/{themes.rb → utility_belt/wirble.rb}

@@ -1,3 +1,7 @@
+require 'wirble'
+Wirble.init
+Wirble.colorize
+
 module UtilityBelt
   module Themes
     def self.background(bkg)

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,32 @@
+require File.join(File.dirname(__FILE__), "spec_helper")
+require "lib/utility_belt/hash_math"
+describe "Hash math" do
+  
+  before do
+    @a = { :a => 1 }
+    @b = { :b => 2 }
+    @c = { :a => 1, :b => 2}
+  end
+  
+  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
+  
+  it "should return a new object instead of mutating the operands" do
+    (@c - @a).should_not === @c
+  end
+  
+  it "should not alter the state of the operands" do
+    (@c - @b).should == @a # but...
+    @c.should == { :a => 1, :b => 2 }
+  end
+
+end

data/spec/interactive_editor_spec.rb

@@ -0,0 +1,146 @@
+#!/usr/bin/env ruby
+require File.join(File.dirname(__FILE__), "spec_helper")
+
+require 'spec'
+require 'irb'
+require 'delegate'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'utility_belt', 'interactive_editor')
+
+# Using SimpleDelegator allows us to replace the constants without triggering a
+# "constant redefined" warning.
+module StubPlatform
+  ARCH = SimpleDelegator.new(:x86)
+  OS   = SimpleDelegator.new(:unix)
+  IMPL = SimpleDelegator.new(:linux)
+end
+
+# Sneak a stub Platform class into InteractiveEditor so that we don't have to
+# override constants on the real Platform module
+#
+# P.S. This ugliness is why libraries should always prefer to expose methods
+# over constants.
+class InteractiveEditor
+  Platform = StubPlatform
+end
+
+describe InteractiveEditor, "given no clues as to what editor to use" do
+  before :each do
+    ENV.delete("VISUAL")
+    ENV.delete("EDITOR")
+    Kernel.stub!(:test).and_return(false)
+    File.stub!(:executable?).and_return(false)
+  end
+
+  it "should complain" do
+    lambda do
+      InteractiveEditor.sensible_editor
+    end.should raise_error
+  end
+end
+
+describe InteractiveEditor,
+         "given a Mac OS X platform and no editor environment vars" do
+
+  before :each do
+    ENV.delete("VISUAL")
+    ENV.delete("EDITOR")
+    @old_impl = StubPlatform::IMPL.__getobj__
+    StubPlatform::IMPL.__setobj__(:macosx)
+  end
+
+  after :each do
+    StubPlatform::IMPL.__setobj__(@old_impl)
+  end
+
+  it "should use the OS X 'open' command as the default editor" do
+    InteractiveEditor.sensible_editor.should == "open"
+  end
+end
+
+# xdg-open is a facility from the freedesktop.org, available on some recent free
+# desktop operating systems (like Ubuntu).  It uses the desktop environments
+# filetype associations to determine what program to open a file in.
+describe InteractiveEditor,
+         "given a Linux OS and no environment vars" do
+
+  before :each do
+    ENV.delete("VISUAL")
+    ENV.delete("EDITOR")
+    @old_impl = StubPlatform::IMPL.__getobj__
+    StubPlatform::OS.__setobj__(:linux)
+    File.stub!(:executable?).and_return(true)
+  end
+
+  after :each do
+    StubPlatform::IMPL.__setobj__(@old_impl)
+  end
+
+  it "should attempt to use 'xdg-open' command as the default editor" do
+    File.should_receive(:executable?).
+      with("/usr/bin/xdg-open").
+      and_return(true)
+    InteractiveEditor.sensible_editor.should == "/usr/bin/xdg-open"
+  end
+end
+
+# /usr/bin/sensible-editor is a Debian-ism AFAIK
+describe InteractiveEditor,
+         "given the existence of /usr/bin/sensible-editor and no xdg-open" do
+  it "should use /usr/bin/sensible-editor as the default editor" do
+    File.should_receive(:executable?).
+      with("/usr/bin/xdg-open").
+      and_return(false)
+    File.should_receive(:executable?).
+      with("/usr/bin/sensible-editor").
+      and_return(true)
+    InteractiveEditor.sensible_editor.should == "/usr/bin/sensible-editor"
+  end
+end
+
+describe InteractiveEditor, "given an EDITOR environment variable" do
+  before :each do
+    File.stub!(:executable?).and_return(true)
+    ENV["EDITOR"] = "MY_EDITOR"
+  end
+
+  after :each do
+    ENV.delete("EDITOR")
+  end
+
+  it "should use the EDITOR environment variable to determine a sensible editor" do
+    InteractiveEditor.sensible_editor.should == "MY_EDITOR"
+  end
+end
+
+describe InteractiveEditor, "given a VISUAL environment variable" do
+  before :each do
+    File.stub!(:executable?).and_return(true)
+    ENV["EDITOR"] = "MY_EDITOR"
+    ENV["VISUAL"] = "MY_VISUAL_EDITOR"
+  end
+
+  after :each do
+    ENV.delete("EDITOR")
+    ENV.delete("VISUAL")
+  end
+
+  it "should use the environment variable to determine a sensible editor" do
+    InteractiveEditor.sensible_editor.should == "MY_VISUAL_EDITOR"
+  end
+end
+
+describe InteractiveEditing, "(calling out to an external editor)" do
+  before :each do
+    @it          = Object.new
+    @it.extend(InteractiveEditing)
+    @editor      = stub("Editor", :edit_interactively => nil)
+    @editor_path = stub("Editor Path")
+    InteractiveEditor.stub!(:sensible_editor).and_return(@editor_path)
+    InteractiveEditor.stub!(:new).and_return(@editor)
+  end
+
+  it "should use InteractiveEditor to determine default editor" do
+    @it.edit_interactively
+    IRB.conf[:interactive_editors][@editor_path].should equal(@editor)
+  end
+end

data/{test → spec}/language_greps_spec.rb

@@ -1,6 +1,7 @@
-require "lib/language_greps"
+require File.join(File.dirname(__FILE__), "spec_helper")
+require "lib/utility_belt/language_greps"
 describe "language greps" do
-  
+
   it "should handle String#blank?" do
     "".should be_blank
   end

data/spec/pastie_spec.rb

@@ -0,0 +1,92 @@
+require File.join(File.dirname(__FILE__), "spec_helper")
+require 'rubygems'
+gem 'rspec'
+require 'spec'
+Platform = Module.new unless Object.const_defined?('Platform')
+Net = Module.new unless Object.const_defined?('Net')
+
+require File.expand_path(File.join(File.dirname(__FILE__),'..','lib/utility_belt'))
+UtilityBelt.equip(:pastie)
+include UtilityBelt::Pastie
+Clipboard = UtilityBelt::Clipboard unless Object.const_defined?('Clipboard')
+
+describe "pastie being called" do
+
+  before(:all) do
+    Net::HTTP = mock('HTTP') unless Net.const_defined?('HTTP')
+    URI = mock('URI') unless Object.const_defined?('URI')
+    Clipboard = mock('clipboard') unless Object.const_defined?('Clipboard')
+  end
+
+  before(:each) do
+    @page = mock('page')
+    @page.stub!(:body).and_return('href="foo"')
+    Net::HTTP.stub!(:post_form).and_return(@page)
+    URI.stub!(:parse)
+    Clipboard.stub!(:read)
+    Clipboard.stub!(:write)
+    Kernel.stub!(:system)
+  end
+
+  it "should be available in global namespace and not blow-up with default stub/mocking" do
+    pastie
+  end
+
+  it "should uri-parse the pastie uri" do
+    URI.should_receive(:parse).with("http://pastie.caboo.se/pastes/create")
+    pastie
+  end
+
+  it "should pass the uri-parsed result into the post" do
+    URI.should_receive(:parse).and_return('a_uri_object')
+    Net::HTTP.should_receive(:post_form).with('a_uri_object', anything()).and_return(@page)
+    pastie
+  end
+
+  it "should call system open on the pastie return" do
+    @page.should_receive(:body).and_return('href="returned_url"')
+    case Platform::IMPL
+    when :macosx
+      Kernel.should_receive(:system).with("open returned_url")
+    when :mswin
+      Kernel.should_receive(:system).with("start returned_url")
+    end
+    pastie
+  end
+
+  it "should write resulting url into the clipboard" do
+    @page.should_receive(:body).and_return('href="returned_url"')
+    Clipboard.should_receive(:write).with('returned_url')
+    pastie
+  end
+
+  describe "with no parameter it uses the clipboard" do
+    it "should read the clipboard" do
+      Clipboard.should_receive(:read)
+      pastie
+    end
+
+    it "should put the clipboard results in the post to pastie" do
+      Clipboard.should_receive(:read).and_return('bar')
+      Net::HTTP.should_receive(:post_form).with(anything(),{"paste_parser" => "ruby",
+        "paste[authorization]" => "burger",
+        "paste[body]" => 'bar'}).and_return(@page)
+      pastie
+    end
+  end
+
+ describe "with a parameter instead" do
+   #TODO: windows/linux safer now, since no clipboard functionality?
+    it "should not even read the clipboard" do
+      Clipboard.should_not_receive(:read)
+      pastie "baz"
+    end
+
+    it "should pass in the parameter instead" do
+      Net::HTTP.should_receive(:post_form).with(anything(),{"paste_parser" => "ruby",
+        "paste[authorization]" => "burger",
+        "paste[body]" => 'baz'}).and_return(@page)
+      pastie "baz"
+    end
+  end
+end