2010-03-27 15:29:57 +00:00
|
|
|
# Developed March 17, 2008 by Chris Powers
|
2010-09-12 01:09:14 +00:00
|
|
|
#
|
2009-02-20 14:43:47 +00:00
|
|
|
# The ItermWindow class models an iTerm terminal window and allows for full control via Ruby commands.
|
|
|
|
# Under the hood, this class is a wrapper of iTerm's Applescript scripting API. Methods are used to
|
|
|
|
# generate Applescript code which is run as an <tt>osascript</tt> command when the ItermWindow initialization
|
|
|
|
# block is closed.
|
2010-09-12 01:09:14 +00:00
|
|
|
#
|
2009-02-20 14:43:47 +00:00
|
|
|
# ItermWindow::Tab models a tab (session) in an iTerm terminal window and allows for it to be controlled by Ruby.
|
|
|
|
# These tabs can be created with either the ItermWindow#open_bookmark method or the ItermWindow#open_tab
|
|
|
|
# method. Each tab is given a name (symbol) by which it can be accessed later as a method of ItermWindow.
|
2010-09-12 01:09:14 +00:00
|
|
|
#
|
2009-02-20 14:43:47 +00:00
|
|
|
# EXAMPLE - Open a new iTerm window, cd to a project and open it in TextMate
|
2010-09-12 01:09:14 +00:00
|
|
|
#
|
2009-02-20 14:43:47 +00:00
|
|
|
# ItermWindow.open do
|
|
|
|
# open_tab :my_tab do
|
|
|
|
# write "cd ~/projects/my_project/trunk"
|
|
|
|
# write "mate ./"
|
|
|
|
# end
|
|
|
|
# end
|
2010-09-12 01:09:14 +00:00
|
|
|
#
|
2009-02-20 14:43:47 +00:00
|
|
|
# EXAMPLE - Use the current iTerm window, cd to a project and open in TextMate, launch the server and the console and title them
|
2010-09-12 01:09:14 +00:00
|
|
|
#
|
2009-02-20 14:43:47 +00:00
|
|
|
# ItermWindow.current do
|
|
|
|
# open_tab :project_dir do
|
|
|
|
# write "cd ~/projects/my_project/trunk"
|
|
|
|
# write "mate ./"
|
|
|
|
# set_title "MyProject Dir"
|
|
|
|
# end
|
2010-09-12 01:09:14 +00:00
|
|
|
#
|
|
|
|
# open_tab :server do
|
2009-02-20 14:43:47 +00:00
|
|
|
# write "cd ~/projects/my_project/trunk"
|
|
|
|
# write "script/server -p 3005"
|
|
|
|
# set_title "MyProject Server"
|
|
|
|
# end
|
2010-09-12 01:09:14 +00:00
|
|
|
#
|
|
|
|
# open_tab :console do
|
2009-02-20 14:43:47 +00:00
|
|
|
# write "cd ~/projects/my_project/trunk"
|
|
|
|
# write "script/console"
|
|
|
|
# set_title "MyProject Console"
|
|
|
|
# end
|
|
|
|
# end
|
|
|
|
#
|
|
|
|
# EXAMPLE - Same thing, but use bookmarks that were made for the server and console. Also, switch focus back to project dir.
|
2010-09-12 01:09:14 +00:00
|
|
|
#
|
2009-02-20 14:43:47 +00:00
|
|
|
# ItermWindow.current do
|
|
|
|
# open_tab :project_dir do
|
|
|
|
# write "cd ~/projects/my_project/trunk"
|
|
|
|
# write "mate ./"
|
|
|
|
# end
|
2010-09-12 01:09:14 +00:00
|
|
|
#
|
2009-02-20 14:43:47 +00:00
|
|
|
# open_bookmark :server, 'MyProject Server'
|
|
|
|
# open_bookmark :console, 'MyProject Console'
|
2010-09-12 01:09:14 +00:00
|
|
|
#
|
2009-02-20 14:43:47 +00:00
|
|
|
# project_dir.select
|
2010-09-12 01:09:14 +00:00
|
|
|
# end
|
|
|
|
#
|
2009-02-20 14:43:47 +00:00
|
|
|
# EXAMPLE - Arbitrarily open two tabs, switch between them and run methods/blocks with Tab#select method and Tab#write directly
|
2010-09-12 01:09:14 +00:00
|
|
|
#
|
2009-02-20 14:43:47 +00:00
|
|
|
# ItermWindow.open do
|
|
|
|
# open_tab :first_tab
|
|
|
|
# open_tab :second_tab
|
|
|
|
# first_tab.select do
|
|
|
|
# write 'cd ~/projects'
|
|
|
|
# write 'ls'
|
|
|
|
# end
|
|
|
|
# second_tab.write "echo 'hello there!'"
|
|
|
|
# first_tab.select # brings first tab back to focus
|
|
|
|
# end
|
|
|
|
|
2011-07-02 20:57:31 +00:00
|
|
|
require 'tempfile'
|
2009-02-20 14:43:47 +00:00
|
|
|
|
|
|
|
# The ItermWindow class models an iTerm terminal window and allows for full control via Ruby commands.
|
|
|
|
class ItermWindow
|
2011-07-02 20:57:31 +00:00
|
|
|
attr_reader :tab_color_files
|
2010-09-12 01:09:14 +00:00
|
|
|
|
2011-07-12 15:22:41 +00:00
|
|
|
class << self
|
|
|
|
def colors=(colors)
|
|
|
|
@colors = colors
|
|
|
|
end
|
|
|
|
|
|
|
|
def colors
|
|
|
|
@colors
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
ItermWindow.colors = {
|
|
|
|
:rails => 'F99',
|
|
|
|
:rspec => '99F',
|
|
|
|
:js => '9F9',
|
|
|
|
:doc => 'FF9',
|
|
|
|
:log => 'DFF',
|
|
|
|
}
|
|
|
|
|
2010-09-12 01:09:14 +00:00
|
|
|
# While you can directly use ItermWindow.new, using either ItermWindow.open or
|
2009-02-20 14:43:47 +00:00
|
|
|
# ItermWindow.current is the preferred method.
|
2010-09-12 01:09:14 +00:00
|
|
|
def initialize
|
2009-02-20 14:43:47 +00:00
|
|
|
@buffer = []
|
|
|
|
@tabs = {}
|
2011-07-02 20:57:31 +00:00
|
|
|
@tab_color_files = []
|
2011-07-12 15:22:41 +00:00
|
|
|
@default_tab = nil
|
2009-02-20 14:43:47 +00:00
|
|
|
end
|
2010-09-12 01:09:14 +00:00
|
|
|
|
2011-07-12 15:31:16 +00:00
|
|
|
def self.run_file(file)
|
|
|
|
instance_eval(file)
|
|
|
|
end
|
|
|
|
|
2009-02-20 14:43:47 +00:00
|
|
|
# Creates a new terminal window, runs the block on it
|
2011-07-12 15:22:41 +00:00
|
|
|
def self.open(options = {}, &block)
|
|
|
|
self.new.run(:new, options, &block)
|
2009-02-20 14:43:47 +00:00
|
|
|
end
|
2010-09-12 01:09:14 +00:00
|
|
|
|
2009-02-20 14:43:47 +00:00
|
|
|
# Selects the first terminal window, runs the block on it
|
|
|
|
def self.current(&block)
|
2010-09-12 01:09:14 +00:00
|
|
|
self.new.run(:current, &block)
|
|
|
|
end
|
|
|
|
|
2011-07-12 15:22:41 +00:00
|
|
|
def run(window_type = :new, options = {}, &block)
|
|
|
|
@options = options
|
2010-09-12 01:09:14 +00:00
|
|
|
run_commands window_type, &block
|
|
|
|
send_output
|
2009-02-20 14:43:47 +00:00
|
|
|
end
|
2010-09-12 01:09:14 +00:00
|
|
|
|
2009-02-20 14:43:47 +00:00
|
|
|
# Creates a new tab from a bookmark, runs the block on it
|
|
|
|
def open_bookmark(name, bookmark, &block)
|
|
|
|
create_tab(name, bookmark, &block)
|
|
|
|
end
|
2010-09-12 01:09:14 +00:00
|
|
|
|
2009-02-20 14:43:47 +00:00
|
|
|
# Creates a new tab from 'Default Session', runs the block on it
|
2011-07-12 15:22:41 +00:00
|
|
|
def open_tab(name, options = {}, &block)
|
|
|
|
create_tab(name, 'Default Session', options, &block)
|
|
|
|
@default_tab = name if options[:default]
|
|
|
|
end
|
|
|
|
|
|
|
|
def default_tab(name, options = {}, &block)
|
|
|
|
open_tab(name, options.merge(:default => true), &block)
|
2009-02-20 14:43:47 +00:00
|
|
|
end
|
2010-09-12 01:09:14 +00:00
|
|
|
|
2009-02-20 14:43:47 +00:00
|
|
|
# Outputs a single line of Applescript code
|
|
|
|
def output(command)
|
2011-07-02 20:57:31 +00:00
|
|
|
@buffer << command.gsub("'", '"').gsub('\\', '\\\\\\')
|
2009-02-20 14:43:47 +00:00
|
|
|
end
|
2010-09-12 01:09:14 +00:00
|
|
|
|
2011-07-02 20:57:31 +00:00
|
|
|
def concatenated_buffer
|
|
|
|
@buffer.join("\n")
|
|
|
|
end
|
2010-09-12 01:09:14 +00:00
|
|
|
|
2009-02-20 14:43:47 +00:00
|
|
|
private
|
2010-09-12 01:09:14 +00:00
|
|
|
|
2009-02-20 14:43:47 +00:00
|
|
|
# Outputs @buffer to the command line as an osascript function
|
|
|
|
def send_output
|
2011-07-02 20:57:31 +00:00
|
|
|
shell_out
|
2009-02-20 14:43:47 +00:00
|
|
|
end
|
2010-09-12 01:09:14 +00:00
|
|
|
|
2009-02-20 14:43:47 +00:00
|
|
|
# Initializes the terminal window
|
|
|
|
def run_commands(window_type, &block)
|
|
|
|
window_types = {:new => '(make new terminal)', :current => 'first terminal'}
|
|
|
|
raise ArgumentError, "ItermWindow#run_commands should be passed :new or :current." unless window_types.keys.include? window_type
|
|
|
|
output "tell application 'iTerm'"
|
|
|
|
output "activate"
|
|
|
|
output "set myterm to #{window_types[window_type]}"
|
|
|
|
output "tell myterm"
|
|
|
|
self.instance_eval(&block) if block_given?
|
2011-07-12 15:22:41 +00:00
|
|
|
@tabs[@default_tab].select if @default_tab
|
2009-02-20 14:43:47 +00:00
|
|
|
output "end tell"
|
|
|
|
output "end tell"
|
|
|
|
end
|
2010-09-12 01:09:14 +00:00
|
|
|
|
|
|
|
# Creates a new Tab object, either default or from a bookmark,
|
|
|
|
# and creates a convenience method for retrieval
|
2011-07-12 15:22:41 +00:00
|
|
|
def create_tab(name, bookmark=nil, options = {}, &block)
|
|
|
|
@tabs[name] = Tab.new(self, name, bookmark, @options.merge(options), &block)
|
2010-09-12 01:09:14 +00:00
|
|
|
create_tab_convenience_method(name)
|
|
|
|
end
|
|
|
|
|
|
|
|
def create_tab_convenience_method(name)
|
|
|
|
(class << self; self; end).send(:define_method, name) do
|
|
|
|
@tabs[name]
|
|
|
|
end
|
2009-02-20 14:43:47 +00:00
|
|
|
end
|
2010-09-12 01:09:14 +00:00
|
|
|
|
2011-07-02 20:57:31 +00:00
|
|
|
def shell_out
|
|
|
|
Tempfile.open('iterm') do |f|
|
|
|
|
f.print concatenated_buffer
|
|
|
|
f.close
|
|
|
|
system %{osascript #{f.path}}
|
|
|
|
end
|
2009-02-20 14:43:47 +00:00
|
|
|
end
|
|
|
|
|
2010-09-12 01:09:14 +00:00
|
|
|
|
2009-02-20 14:43:47 +00:00
|
|
|
# The Tab class models a tab (session) in an iTerm terminal window and allows for it to be controlled by Ruby.
|
|
|
|
class Tab
|
2010-09-12 01:09:14 +00:00
|
|
|
|
2009-02-20 14:43:47 +00:00
|
|
|
attr_reader :name
|
|
|
|
attr_reader :bookmark
|
2010-09-12 01:09:14 +00:00
|
|
|
|
2011-07-12 15:22:41 +00:00
|
|
|
def initialize(window, name, bookmark = nil, options = {}, &block)
|
2009-02-20 14:43:47 +00:00
|
|
|
@name = name
|
|
|
|
@bookmark = bookmark
|
|
|
|
@window = window
|
|
|
|
@currently_executing_block = false
|
|
|
|
output "launch session '#{@bookmark}'"
|
|
|
|
# store tty id for later access
|
|
|
|
output "set #{name}_tty to the tty of the last session"
|
2011-07-12 15:22:41 +00:00
|
|
|
write "cd #{options[:dir]}" if options[:dir]
|
|
|
|
tab_color options[:color] if options[:color]
|
|
|
|
|
2009-02-20 14:43:47 +00:00
|
|
|
execute_block &block if block_given?
|
|
|
|
end
|
2010-09-12 01:09:14 +00:00
|
|
|
|
2009-02-20 14:43:47 +00:00
|
|
|
# Brings a tab into focus, runs a block on it if passed
|
|
|
|
def select(&block)
|
|
|
|
if block_given?
|
|
|
|
execute_block &block
|
|
|
|
else
|
|
|
|
output "select session id #{name}_tty"
|
|
|
|
end
|
|
|
|
end
|
2010-09-12 01:09:14 +00:00
|
|
|
|
2009-02-20 14:43:47 +00:00
|
|
|
# Writes a command into the terminal tab
|
|
|
|
def write(command)
|
|
|
|
if @currently_executing_block
|
|
|
|
output "write text '#{command}'"
|
|
|
|
else
|
|
|
|
execute_block { write command }
|
|
|
|
end
|
|
|
|
end
|
2010-09-12 01:09:14 +00:00
|
|
|
|
2009-02-20 14:43:47 +00:00
|
|
|
# Sets the title of the tab (ie the text on the iTerm tab itself)
|
|
|
|
def set_title(str)
|
|
|
|
if @currently_executing_block
|
|
|
|
output "set name to '#{str}'"
|
|
|
|
else
|
|
|
|
execute_block { set_title = str }
|
|
|
|
end
|
|
|
|
end
|
2010-09-12 01:09:14 +00:00
|
|
|
|
2011-07-02 20:57:31 +00:00
|
|
|
# Sets the title of the tab (ie the text on the iTerm tab itself)
|
|
|
|
def tab_color(color)
|
|
|
|
if @currently_executing_block
|
|
|
|
output "write text 'cat #{file = create_tab_color_file(color)} && rm #{file}'"
|
|
|
|
else
|
|
|
|
execute_block { tab_color(color) }
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2009-02-20 14:43:47 +00:00
|
|
|
# Runs a block on this tab with proper opening and closing statements
|
|
|
|
def execute_block(&block)
|
|
|
|
@currently_executing_block = true
|
|
|
|
output "tell session id #{name}_tty"
|
|
|
|
self.instance_eval(&block)
|
|
|
|
output "end tell"
|
|
|
|
@currently_executing_block = false
|
|
|
|
end
|
2010-09-12 01:09:14 +00:00
|
|
|
|
2011-07-12 15:22:41 +00:00
|
|
|
def method_missing(name, *args)
|
|
|
|
write("#{name} #{args.join(' ')}")
|
|
|
|
end
|
|
|
|
|
2011-07-02 20:57:31 +00:00
|
|
|
def self.create_tab_color(color)
|
|
|
|
raise ArgumentError.new("bad hex color: #{color}") if color.downcase[%r{[^a-f0-9]}] || !([ 3, 6 ].include?(color.length))
|
|
|
|
%w{red green blue}.zip(color.scan(
|
|
|
|
(case color.length
|
|
|
|
when 3
|
|
|
|
/./
|
|
|
|
when 6
|
|
|
|
/../
|
|
|
|
end)
|
|
|
|
).collect { |part|
|
|
|
|
part += part if part.length == 1
|
|
|
|
part.hex
|
|
|
|
}).collect do |color, brightness|
|
|
|
|
"\033]6;1;bg;#{color};brightness;#{brightness}\a"
|
|
|
|
end.join
|
|
|
|
end
|
|
|
|
|
2009-02-20 14:43:47 +00:00
|
|
|
private
|
2010-09-12 01:09:14 +00:00
|
|
|
|
2009-02-20 14:43:47 +00:00
|
|
|
def output(command)
|
|
|
|
@window.output command
|
|
|
|
end
|
|
|
|
|
2011-07-02 20:57:31 +00:00
|
|
|
def create_tab_color_file(color)
|
|
|
|
file = Tempfile.open('iterm').path + '.tc'
|
2011-07-12 15:22:41 +00:00
|
|
|
File.open(file, 'wb') { |f| f.puts self.class.create_tab_color(ensure_color(color)) }
|
2011-07-02 20:57:31 +00:00
|
|
|
@window.tab_color_files << file
|
|
|
|
file
|
|
|
|
end
|
2011-07-12 15:22:41 +00:00
|
|
|
|
|
|
|
def ensure_color(color)
|
|
|
|
case color
|
|
|
|
when Symbol
|
|
|
|
ItermWindow.colors[color]
|
|
|
|
else
|
|
|
|
color
|
|
|
|
end
|
|
|
|
end
|
2009-02-20 14:43:47 +00:00
|
|
|
end
|
2011-07-02 20:57:31 +00:00
|
|
|
end
|