iterm_window 0.3.5 → 0.3.6

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Chris Powers
+Copyright (c) 2014 Chris Powers
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -17,4 +17,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,78 @@
+# iTermWindow
+
+*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 `osascript` 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 in the code using
+the tab name as an `ItermWindow` method.
+
+## EXAMPLE - Open a new iTerm window, cd to a project and open it in TextMate
+
+```ruby
+require 'rubygems'
+require 'iterm_window'
+
+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
+
+```ruby
+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.
+
+```ruby
+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
+
+```ruby
+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
+```

data/lib/iterm_window.rb

@@ -119,7 +119,7 @@ class ItermWindow
 
   # Initializes the terminal window
   def run_commands(window_type, &block)
-    window_types = {:new => '(make new terminal)', :current => 'first terminal'}
+    window_types = {:new => '(make new terminal)', :current => 'current 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"
@@ -212,4 +212,4 @@ class ItermWindow
 
   end
 
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iterm_window
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
   prerelease: 
 platform: ruby
 authors:
@@ -17,7 +17,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- README.rdoc
+- README.md
 - LICENSE
 - lib/iterm_window.rb
 homepage: http://github.com/chrisjpowers/iterm_window

data/README.rdoc

@@ -1,69 +0,0 @@
-= iTermWindow
-
-<em>Developed March 17, 2008 by Chris Powers</em>
-
-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 in the code using
-the tab name as an ItermWindow method.
-
-== EXAMPLE - Open a new iTerm window, cd to a project and open it in TextMate
-
-  require 'rubygems'
-  require 'iterm_window'
-
-  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
-
-== 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