terminitor 0.3.2 → 0.4.0

data/.gitignore

@@ -1,4 +1,5 @@
 pkg/*
 *.gem
 .bundle
+.rvmrc
 *.swp

data/README.md

@@ -296,6 +296,7 @@ Cores allow Terminitor to operate on a variety of platforms. They abstract the g
 
  * MacCore        - Mac OS X Terminal
  * KonsoleCore    - KDE Konsole
+ * ITermCore      - Mac OS X iTerm
 
 Feel free to contribute more cores so that Terminitor can support your terminal of choice :)
 
@@ -308,6 +309,13 @@ Limitations
 Right now the Mac OS X Terminal tabs are created by invoking keystrokes which means there are limitations with the terminal being in
 focus during execution of these commands. Obviously the long term goal is to solve this issue as well but in all honesty, this solution works well enough most of the time.
 
+
+#### ITermCore ####
+
+Currently the iTerm Core only provides basic functionality such as opening tabs, windows, and executing commands within them. The capture
+and settings functionality will be integrated soon.
+
+
 #### Fetching ####
 
 The fetch task only pulls off Github repositories at the moment. Later on, this functionality will be extended to non github repository.
@@ -334,6 +342,8 @@ Thanks to the following people for their contributions so far:
  * Alexey Kuleshov ([kulesa](https://github.com/kulesa)) for contributing the terminal settings and terminal settings capture functionality
  * Arthur Gunn     ([gunn](https://github.com/gunn)) for contributing a path to support tab syntax and load path.
  * Elliot Winkler  ([mcmire](https://github.com/mcmire)) for adding 1.8.6 compatiblity and ensuring tabs open in order.
+ * Justin Hilemen  ([bobthecow](https://github.com/bobthecow)) for fixing the list command to remove the term extensions.
+ * recurser        ([recurser](https://github.com/recurser)) for adding basic iTerm support.
  
 Acknowledgements
 -----------------

data/lib/terminitor.rb

@@ -1,6 +1,6 @@
 lib_dir = File.expand_path("..", __FILE__)
 $:.unshift( lib_dir ) unless $:.include?( lib_dir )
-
+      
 require 'terminitor/yaml'
 require 'terminitor/dsl'
 require 'terminitor/runner'
@@ -15,6 +15,8 @@ module Terminitor
     require 'appscript'
     autoload :MacCore,        'terminitor/cores/mac_core'
     autoload :MacCapture,     'terminitor/capture/mac_capture'  
+    autoload :ItermCore,      'terminitor/cores/iterm_core'
+    autoload :ItermCapture,   'terminitor/capture/iterm_capture' 
   when %r{linux}
     require 'dbus'
     autoload :KonsoleCore,    'terminitor/cores/konsole_core'

data/lib/terminitor/capture/iterm_capture.rb

@@ -0,0 +1,51 @@
+module Terminitor
+  # Captures terminal windows and tabs for Mac OS X 
+  class ItermCapture < AbstractCapture
+    include Appscript
+    
+    # Defines what options of window or tab to capture and how
+    # just in case we'll need to get other properties
+    OPTIONS_MASK = {
+      :window => {
+        :bounds => "bounds"
+      },
+      :tab => {
+        :settings => "current_settings.name"
+      }
+    }
+    
+    # Initialize @terminal with Terminal.app, Load the Windows, store the Termfile
+    # Terminitor::MacCore.new('/path')
+    def initialize
+      @terminal = app('iTerm.app')
+    end
+
+    # Returns settings of currently opened windows and tabs.    
+    def capture_windows
+      windows = []
+      # for some reason terminal.windows[] contain duplicated elements
+      @terminal.windows.get.uniq.each do |window| 
+        if window.visible.get
+          tabs = window.tabs.get.inject([]) do |tabs, tab|
+            tabs << {:options => object_options(tab)}
+          end
+          windows << {:options => object_options(window), :tabs => tabs}
+        end
+      end
+      windows
+    end
+    
+    # Returns hash of options of window or tab
+    def object_options(object)
+      options = {}
+      class_ =  object.class_.get
+      if class_ && OPTIONS_MASK[class_]
+        OPTIONS_MASK[class_].each_pair do |option, getter|
+          value = object.instance_eval(getter).get
+          options[option] = value
+        end
+      end
+      options
+    end
+  end
+end

data/lib/terminitor/cli.rb

@@ -30,7 +30,7 @@ module Terminitor
     def list
       say "Global scripts: \n"
       Dir.glob("#{ENV['HOME']}/.terminitor/*").each do |file|
-        say "  * #{File.basename(file).gsub('.yml','')} #{grab_comment_for_file(file)}"
+        say "  * #{File.basename(file, '.term')} #{grab_comment_for_file(file)}"
       end
     end
 

data/lib/terminitor/cores/iterm_core.rb

@@ -0,0 +1,145 @@
+module Terminitor
+  # Mac OS X Core for Terminitor
+  # This Core manages all the interaction with Appscript and the Terminal
+  class ItermCore < AbstractCore
+    include Appscript
+    
+    ALLOWED_OPTIONS = {
+      :window => [:bounds, :visible, :miniaturized],
+      :tab => [:settings, :selected]
+    }
+    
+    # Initialize @terminal with Terminal.app, Load the Windows, store the Termfile
+    # Terminitor::MacCore.new('/path')
+    def initialize(path)
+      super
+      @terminal = app('iTerm')
+      @windows  = @terminal.terminals
+      @delayed_options = []
+    end
+            
+    # executes the given command via appscript
+    # execute_command 'cd /path/to', :in => #<tab>
+    def execute_command(cmd, options = {})      
+      if options[:in]
+        options[:in].write(:text => "#{cmd}")
+      else
+        active_window.write(:text => "#{cmd}")
+      end
+    end
+
+    # Opens a new tab and returns itself.
+    # TODO : handle options (?)
+    def open_tab(options = nil)
+      session = current_terminal.sessions.end.make( :new => :session )
+      session.exec(:command => ENV['SHELL'])
+      session
+    end
+    
+    # Opens A New Window, applies settings to the first tab and returns the tab object.
+    # TODO : handle options (?)
+    def open_window(options = nil)
+      window  = terminal.make( :new => :terminal )
+      session = window.sessions.end.make( :new => :session )
+      session.exec(:command => ENV['SHELL'])
+      session
+    end
+
+    # Returns the Terminal Process
+    # We need this method to workaround appscript so that we can instantiate new tabs and windows.
+    # otherwise it would have looked something like window.make(:new => :tab) but that doesn't work.
+    def terminal_process
+      app("System Events").application_processes["iTerm.app"]
+    end
+    
+    # Returns the last instantiated tab from active window
+    def return_last_tab
+      current_terminal.sessions.last.get rescue false
+    end
+
+    # returns the active windows
+    def active_window
+      current_terminal.current_session.get
+    end
+    
+    # Returns the current terminal
+    def current_terminal
+      @terminal.current_terminal
+    end
+
+    # Sets options of the given object
+    def set_options(object, options = {})
+      options.each_pair do |option, value| 
+        case option
+        when :settings   # works for windows and tabs, for example :settings => "Grass"
+          begin
+            object.current_settings.set(@terminal.settings_sets[value])
+          rescue Appscript::CommandError => e
+            puts "Error: invalid settings set '#{value}'"
+          end
+        when :bounds # works only for windows, for example :bounds => [10,20,300,200]
+          # the only working sequence to restore window size and position! 
+          object.bounds.set(value)
+          object.frame.set(value)
+          object.position.set(value)
+        when :selected # works for tabs, for example tab :active => true
+          delayed_option(option, value, object)
+        when :miniaturized # works for windows only
+          delayed_option(option, value, object)
+        when :name
+          # ignore it.
+        else # trying to apply any other option
+          begin
+            object.instance_eval(option.to_s).set(value)
+          rescue
+            puts "Error setting #{option} = #{value} on #{object.inspect}"
+          end
+        end
+      end
+    end
+    
+    # Apply delayed options and remove them from the queue
+    def set_delayed_options
+      @delayed_options.length.times do 
+        option = @delayed_options.shift
+        option[:object].instance_eval(option[:option]).set(option[:value])
+      end
+    end
+
+    private
+    
+    # These methods are here for reference so I can ponder later
+    # how I could possibly use them.
+    # And Currently aren't tested. =(
+    
+    # returns a window by the id
+    def window_by_id(id)
+      @windows.ID(id)
+    end
+
+    # grabs the window id.
+    def window_id(window)
+      window.id_.get
+    end
+
+    # set_window_title #<Window>, "hi"
+    # Note: This sets all the windows to the same title.
+    def set_window_title(window, title)
+      window.custom_title.set(title)
+    end
+    
+    # selects options allowed for window or tab
+    def allowed_options(object_type, options)
+      Hash[ options.select {|option, value| ALLOWED_OPTIONS[object_type].include?(option) }]
+    end
+    
+    # Add option to the list of delayed options
+    def delayed_option(option, value, object)
+      @delayed_options << {
+        :option => option.to_s, 
+        :value => value, 
+        :object => object
+      }
+    end
+  end
+end

data/lib/terminitor/runner.rb

@@ -6,7 +6,12 @@ module Terminitor
     # find_core RUBY_PLATFORM
     def find_core(platform)
       core = case platform.downcase
-      when %r{darwin} then Terminitor::MacCore
+      when %r{darwin} then 
+        if ENV['TERM_PROGRAM'] == 'iTerm.app'
+          Terminitor::ItermCore
+        else
+          Terminitor::MacCore
+        end
       when %r{linux}  then Terminitor::KonsoleCore # TODO check for gnome and others
       else nil
       end
@@ -15,7 +20,12 @@ module Terminitor
     # Defines how to capture terminal settings on the specified platform
     def capture_core(platform)
       core = case platform.downcase
-      when %r{darwin} then Terminitor::MacCapture
+      when %r{darwin} then 
+        if ENV['TERM_PROGRAM'] == 'iTerm.app'
+          Terminitor::ItermCapture
+        else
+          Terminitor::MacCapture
+        end
       when %r{linux}  then Terminitor::KonsoleCapture # TODO check for gnome and others
       else nil
       end
@@ -109,4 +119,5 @@ module Terminitor
     end
 
   end
+  
 end

data/lib/terminitor/version.rb

@@ -1,3 +1,3 @@
 module Terminitor
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

data/test/cli_test.rb

@@ -23,8 +23,8 @@ context "Terminitor" do
       File.open(File.join(@path,'bar.yml'),"w") { |f| f.puts @template }
       capture(:stdout) { Terminitor::Cli.start(['list']) }
     end
-    asserts_topic.matches %r{foo - COMMENT OF SCRIPT HERE}
-    asserts_topic.matches %r{bar - COMMENT OF SCRIPT HERE}
+    asserts_topic.matches %r{foo\.yml - COMMENT OF SCRIPT HERE}
+    asserts_topic.matches %r{bar\.yml - COMMENT OF SCRIPT HERE}
   end
 
   asserts "#init creates .terminitor" do

data/test/cores/iterm_core_test.rb

@@ -0,0 +1,67 @@
+require File.expand_path('../../teststrap',__FILE__)
+
+if platform?("darwin") # Only run test if it's darwin
+  context "ItermCore" do
+    setup do
+      any_instance_of(Terminitor::ItermCore) do |core|
+        stub(core).app('iTerm')           { mock!.terminals { true } }
+        stub(core).load_termfile('/path/to') { true }
+      end
+     @iterm_core = Terminitor::ItermCore.new('/path/to')  
+    end
+
+    asserts "#terminal_process calls System Events" do
+      core = topic.dup
+      mock(core).app('System Events') { mock!.application_processes.returns("iTerm.app" => true) }
+      core.terminal_process
+    end
+
+    context "#open_tab" do
+
+      should "return the current tab" do
+        core = topic.dup
+        mock(core).current_terminal.stub!.sessions.stub!.end.
+          stub!.make(:new => :session).stub!.
+          exec(:command => ENV['SHELL'])
+        core.open_tab
+      end
+
+    end
+
+    context "#open_window" do
+    
+      should "return the last tab" do
+        core = topic.dup
+        mock(core).terminal.stub!.make(:new=>:terminal).
+          stub!.sessions.stub!.end.stub!.make(:new=>:session).
+          stub!.exec(:command => ENV['SHELL'])
+        core.open_window
+      end
+    end
+    
+    asserts "#return_last_tab returns the last tab" do
+     core = topic.dup
+     mock(core).current_terminal.stub!.sessions.stub!.
+       last.stub!.get.returns(true)
+     core.return_last_tab
+    end
+    
+    asserts "#execute_command executes" do
+      core = topic.dup
+      mock(core).active_window.stub!.write(:text => "hasta").returns(true)
+      core.execute_command('hasta')
+    end
+    
+    asserts "#active_window gives window" do
+      core = topic.dup
+      mock(core).current_terminal.stub!.current_session.stub!.get.returns(true)
+      core.active_window
+    end
+
+  end
+else
+  context "itermCore" do
+    puts "Nothing to do, you are not on OSX"
+  end
+end
+

data/test/runner_test.rb

@@ -28,7 +28,11 @@ context "Runner" do
 
 
   context "#find_core" do
-    should("have Darwin") { @test_runner.find_core('darwin') }.equals Terminitor::MacCore
+    if ENV['TERM_PROGRAM'] == 'iTerm.app'
+      should("have Darwin") { @test_runner.find_core('darwin') }.equals Terminitor::ItermCore
+    else
+      should("have Darwin") { @test_runner.find_core('darwin') }.equals Terminitor::MacCore
+    end
 
     if platform?('linux') # TODO Gotta be a better way.
       should("have KDE") { @test_runner.find_core('linux') }.equals Terminitor::KonsoleCore
@@ -36,7 +40,11 @@ context "Runner" do
   end
   
   context "#capture_core" do 
-    should("have Darwin") { @test_runner.capture_core('darwin') }.equals Terminitor::MacCapture
+    if ENV['TERM_PROGRAM'] == 'iTerm.app'
+      should("have Darwin") { @test_runner.capture_core('darwin') }.equals Terminitor::ItermCapture
+    else
+      should("have Darwin") { @test_runner.capture_core('darwin') }.equals Terminitor::MacCapture
+    end
   end
 
   context "#open_in_editor" do

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 2
-  version: 0.3.2
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Arthur Chiu
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-11 00:00:00 -08:00
+date: 2011-02-01 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -142,9 +142,11 @@ files:
 - lib/terminitor.rb
 - lib/terminitor/abstract_capture.rb
 - lib/terminitor/abstract_core.rb
+- lib/terminitor/capture/iterm_capture.rb
 - lib/terminitor/capture/konsole_capture.rb
 - lib/terminitor/capture/mac_capture.rb
 - lib/terminitor/cli.rb
+- lib/terminitor/cores/iterm_core.rb
 - lib/terminitor/cores/konsole_core.rb
 - lib/terminitor/cores/mac_core.rb
 - lib/terminitor/dsl.rb
@@ -158,6 +160,7 @@ files:
 - test/abstract_core_test.rb
 - test/capture/mac_capture_test.rb
 - test/cli_test.rb
+- test/cores/iterm_core_test.rb
 - test/cores/konsole_core_test.rb
 - test/cores/mac_core_test.rb
 - test/dsl_test.rb