itermwindow 0.4.0

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## 0.4.0
+
+* Support `iTermfile` for easy per-project terminal definitions.
+* Add tab coloring.
+* Add options hashes to important blocks.
+

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2009 Chris Powers
+Copyright (c) 2011 John Bintz
+
+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,70 @@
+# iTermWindow
+
+*Make iTerm obey your command! Start up your complex development environment quickly and easily.*
+
+The typical Rails project requires three or tour terminal windows/tabs open at once:
+
+* The Rails app itself running using `rails s`
+* Two continuous testing environments, powered by Guard or Autotest, running on your Ruby and JavaScript code
+* A console ready for committing code or other maintenance tasks
+* A log file or two
+
+Opening all the necessary terminals, starting the right processes in each, and making them easily identifiable
+is a long, slow process when done by hand. But guess what -- computers can be used to automate processes that
+otherwise would be laborious when done manually!
+
+Enter *iTermWindow*, a terminal window/tab multiplexer and command runner for Mac OS X and iTerm, the really
+awesome Terminal.app replacement. iTerm's scriptability and customization allows one to create complex
+project configurations for one's terminal setups.
+
+## Installation
+
+`gem install itermwindow` or add it to your Gemfile.
+
+## Usage
+
+The `iterm-window` executable will open and run an `iTermfile` file in the current directory. 
+An `iTermfile` file looks like this:
+
+``` ruby
+open :dir => Dir.pwd do
+  default_tab :console
+
+  open_tab :rails, :color => :rails do
+    rails "s"
+  end
+
+  open_tab :rspec, :color => :rspec do
+    guard "-g rspec"
+  end
+
+  open_tab :log, :color => "DDB" do
+    tail "+F -fr log/sphinx.log"
+  end
+end
+```
+
+In a nutshell:
+
+* `open` blocks open new iTerm windows.
+* `current` blocks use the cirrent iTerm window.
+  * Inside `open` or `current` blocks you can open a new tab with `open_tab`.
+  * Specify a tab to be the selected tab with `default_tab`.
+    * Inside of a tab, you can write text into the terminal with `write_text`.
+    * Set the title of the tab with `set_title`.
+    * Or run a command magically (using `method_missing`).
+
+`open_tab` and `default_tab` can take an options hash:
+
+* `:dir` changes to the given directory before executing commands.
+* `:color` changes the window chrome and tab color to the given hex code (3 or 6 hex digits) or built-in color. See ItermWindow.colors for the list of available colors.
+
+`open` can also take an options hash:
+
+* `:dir` changes all tabs to the given directory before executing commands.
+
+More docs coming soon! Also, look at `lib/iterm_window.rb` for more usage examples.
+
+* Developed March 17, 2008 by Chris Powers
+* Extended June 2011 and beyond by John Bintz and (hopefully) many others
+

data/bin/iterm-window

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'iterm_window'
+
+ItermWindow.run_file(File.read('iTermfile'))
+

data/lib/iterm_window.rb

@@ -0,0 +1,298 @@
+# Developed March 17, 2008 by Chris Powers
+#
+# 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.
+#
+# 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.
+#
+# EXAMPLE - Open a new iTerm window, cd to a project and open it in TextMate
+#
+#   ItermWindow.open do
+#     open_tab :my_tab do
+#       write "cd ~/projects/my_project/trunk"
+#       write "mate ./"
+#     end
+#   end
+#
+# EXAMPLE - Use the current iTerm window, cd to a project and open in TextMate, launch the server and the console and title them
+#
+#   ItermWindow.current do
+#     open_tab :project_dir do
+#       write "cd ~/projects/my_project/trunk"
+#       write "mate ./"
+#       set_title "MyProject Dir"
+#     end
+#
+#     open_tab :server do
+#       write "cd ~/projects/my_project/trunk"
+#       write "script/server -p 3005"
+#       set_title "MyProject Server"
+#     end
+#
+#     open_tab :console do
+#       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.
+#
+#   ItermWindow.current do
+#     open_tab :project_dir do
+#       write "cd ~/projects/my_project/trunk"
+#       write "mate ./"
+#     end
+#
+#     open_bookmark :server, 'MyProject Server'
+#     open_bookmark :console, 'MyProject Console'
+#
+#     project_dir.select
+#   end
+#
+# EXAMPLE - Arbitrarily open two tabs, switch between them and run methods/blocks with Tab#select method and Tab#write directly
+#
+#   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
+
+require 'tempfile'
+
+# The ItermWindow class models an iTerm terminal window and allows for full control via Ruby commands.
+class ItermWindow
+  attr_reader :tab_color_files
+
+  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',
+  }
+
+  # While you can directly use ItermWindow.new, using either ItermWindow.open or
+  # ItermWindow.current is the preferred method.
+  def initialize
+    @buffer = []
+    @tabs = {}
+    @tab_color_files = []
+    @default_tab = nil
+  end
+
+  def self.run_file(file)
+    instance_eval(file)
+  end
+
+  # Creates a new terminal window, runs the block on it
+  def self.open(options = {}, &block)
+    self.new.run(:new, options, &block)
+  end
+
+  # Selects the first terminal window, runs the block on it
+  def self.current(&block)
+    self.new.run(:current, &block)
+  end
+
+  def run(window_type = :new, options = {}, &block)
+    @options = options
+    run_commands window_type, &block
+    send_output
+  end
+
+  # Creates a new tab from a bookmark, runs the block on it
+  def open_bookmark(name, bookmark, &block)
+    create_tab(name, bookmark, &block)
+  end
+
+  # Creates a new tab from 'Default Session', runs the block on it
+  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)
+  end
+
+  # Outputs a single line of Applescript code
+  def output(command)
+    @buffer << command.gsub("'", '"').gsub('\\', '\\\\\\')
+  end
+
+  def concatenated_buffer
+    @buffer.join("\n")
+  end
+
+  private
+
+  # Outputs @buffer to the command line as an osascript function
+  def send_output
+    shell_out
+  end
+
+  # 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?
+    @tabs[@default_tab].select if @default_tab
+    output "end tell"
+    output "end tell"
+  end
+
+  # Creates a new Tab object, either default or from a bookmark,
+  # and creates a convenience method for retrieval
+  def create_tab(name, bookmark=nil, options = {}, &block)
+    @tabs[name] = Tab.new(self, name, bookmark, @options.merge(options), &block)
+    create_tab_convenience_method(name)
+  end
+
+  def create_tab_convenience_method(name)
+    (class << self; self; end).send(:define_method, name) do
+      @tabs[name]
+    end
+  end
+
+  def shell_out
+    Tempfile.open('iterm') do |f|
+      f.print concatenated_buffer
+      f.close
+      system %{osascript #{f.path}}
+    end
+  end
+
+
+  # The Tab class models a tab (session) in an iTerm terminal window and allows for it to be controlled by Ruby.
+  class Tab
+
+    attr_reader :name
+    attr_reader :bookmark
+
+    def initialize(window, name, bookmark = nil, options = {}, &block)
+      @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"
+      write "cd #{options[:dir]}" if options[:dir]
+      tab_color options[:color] if options[:color]
+
+      execute_block &block if block_given?
+    end
+
+    # 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
+
+    # 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
+
+    # 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
+
+    # 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
+
+    # 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
+
+    def method_missing(name, *args)
+      write("#{name} #{args.join(' ')}")
+    end
+
+    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
+
+    private
+
+    def output(command)
+      @window.output command
+    end
+
+    def create_tab_color_file(color)
+      file = Tempfile.open('iterm').path + '.tc'
+      File.open(file, 'wb') { |f| f.puts self.class.create_tab_color(ensure_color(color)) }
+      @window.tab_color_files << file
+      file
+    end
+
+    def ensure_color(color)
+      case color
+      when Symbol
+        ItermWindow.colors[color]
+      else
+        color
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: itermwindow
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.4.0
+platform: ruby
+authors: 
+- Chris Powers
+- John Bintz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-12 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.6.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: fakefs
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: 
+email: 
+- chrisjpowers@gmail.com
+- john@coswellproductions.com
+executables: 
+- iterm-window
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- LICENSE
+- CHANGELOG.md
+- lib/iterm_window.rb
+- bin/iterm-window
+has_rdoc: true
+homepage: http://github.com/johnbintz/iterm_window
+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.6.2
+signing_key: 
+specification_version: 3
+summary: The ItermWindow class models an iTerm terminal window and allows for full control via Ruby commands.
+test_files: []
+