terminitor 0.4.1 → 0.5.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    terminitor (0.4.0)
+    terminitor (0.4.1)
       github (~> 0.6.0)
       rb-appscript
       text-format (= 1.0.0)
@@ -25,11 +25,9 @@ GEM
       rake (>= 0.8.1)
     rake (0.8.7)
     rb-appscript (0.6.0)
-    riot (0.12.1)
+    riot (0.12.2)
       rr
-      term-ansicolor
     rr (1.0.2)
-    term-ansicolor (1.0.5)
     text-format (1.0.0)
       text-hyphen (~> 1.0.0)
     text-hyphen (1.0.0)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Arthur Chiu
+
+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

@@ -1,7 +1,16 @@
 Terminitor
 ===========
 
-Terminitor automates your development workflow setup. Less time setting up,  more time getting things done.
+Terminitor automates your development workflow setup. Less time setting up, more time getting things done.
+
+Upgrading Terminitor from 0.4.1 and under
+------------------------------------------
+
+For those upgrading from Terminitor 0.4.1, please run:
+
+    $ terminitor update
+
+This will move your terminitor files to the new directory located at .config/terminitor 
 
 Installation
 ------------
@@ -45,7 +54,7 @@ This will open your default editor (set through the $TERM_EDITOR or $EDITOR vari
 
 #### YAML Syntax ( Legacy ) ####
     
-    # ~/.terminitor/foo.yml
+    # ~/.config/terminitor/foo.yml
     # you can make as many tabs as you wish...
     # tab names are actually arbitrary at this point too.
     ---
@@ -208,7 +217,7 @@ __windows__
 
 ### Running Terminitor Projects ###
 
-Once the project file has been declared to your satisfaction, simply execute any project defined in the `~/.terminitor` directory with:
+Once the project file has been declared to your satisfaction, simply execute any project defined in the `~/.config/terminitor` directory with:
 
     $ terminitor start foo
 
@@ -296,6 +305,7 @@ Cores allow Terminitor to operate on a variety of platforms. They abstract the g
 
  * MacCore        - Mac OS X Terminal
  * KonsoleCore    - KDE Konsole
+ * TerminatorCore - [Terminator](http://www.tenshu.net/terminator/)
  * ITermCore      - Mac OS X iTerm
 
 Feel free to contribute more cores so that Terminitor can support your terminal of choice :)
@@ -326,6 +336,19 @@ The fetch task only pulls off Github repositories at the moment. Later on, this
 This feature is currently only available in Mac OS X at the moment.
 
 
+#### Terminator support ####
+
+This feature currently requires the "xdotool" utility to be installed and in
+the search path. The xdotool homepage is
+http://www.semicomplete.com/blog/projects/xdotool/.
+
+
+#### Windows suppport ####
+
+Windows support is currently limited to plain cmd.exe. It is also
+limited to only creating new windows, as cmd.exe does not support tabs.
+
+
 Authors
 -------
 
@@ -338,12 +361,16 @@ Contributors
 Thanks to the following people for their contributions so far:
 
  * Pat George      ([pcg79](https://github.com/pcg79)) for contributing a patch for when a project is not found.
+ * Tim Gossett     ([[MrGossett](https://github.com/MrGossett)) for a patch to fix comment reading
  * Flavio Castelli ([flavio](https://github.com/flavio)) for contributing Konsole(KDE) core.
  * 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.
+ * Dave Perrett    ([recurser](https://github.com/recurser)) for adding basic iTerm support.
+ * Ilkka Laukkanen ([ilkka](https://github.com/achiu/terminitor/commits/master?author=ilkka)) for Terminator core and other fixes
+ * Elia Schito     ([elia](https://github.com/achiu/terminitor/commits/master?author=elia)) for patch to allow usage of "&" for background operations
+ * Dotan J. Nahum  ([[jondot](https://github.com/jondot)) for adding windows(cmd.exe) support
  
 Acknowledgements
 -----------------

data/lib/terminitor.rb

@@ -20,6 +20,17 @@ module Terminitor
   when %r{linux}
     require 'dbus'
     autoload :KonsoleCore,    'terminitor/cores/konsole_core'
-    autoload :KonsoleCapture, 'terminitor/capture/konsole_capture'    
+    autoload :KonsoleCapture, 'terminitor/capture/konsole_capture'
+    autoload :TerminatorCore, 'terminitor/cores/terminator_core'
+    autoload :TerminatorCapture, 'terminitor/capture/terminator_capture'
+  when %r{mswin|mingw}
+	require 'windows/process'
+	require 'windows/handle'
+	require 'win32/process'
+	require 'windows/window'
+
+	require 'terminitor/cores/cmd_core/input'
+	require 'terminitor/cores/cmd_core/windows_console'
+	autoload :CmdCore, 'terminitor/cores/cmd_core/cmd_core'
   end
 end

data/lib/terminitor/abstract_core.rb

@@ -4,6 +4,7 @@ module Terminitor
     attr_accessor :terminal, :windows, :working_dir, :termfile
 
     # set the terminal object, windows, and load the Termfile.
+    # @param [String] path to termfile
     def initialize(path)
       @termfile = load_termfile(path)
     end
@@ -26,6 +27,9 @@ module Terminitor
 
     # this command will run commands in the designated window
     # run_in_window 'window1', {:tab1 => ['ls','ok']}
+    # @param [String] name of window
+    # @param [Hash] Hash of window's content extracted from Termfile
+    # @param [Hash] Hash of options
     def run_in_window(window_name, window_content, options = {})
       window_options = window_content[:options]
       first_tab = true
@@ -44,19 +48,22 @@ module Terminitor
         else
           tab = ( tab_key == 'default' ? active_window : open_tab(tab_options) ) # give us the current window if its default, else open a tab.
         end
-        tab_content[:commands].insert(0, window_content[:before]).flatten! if window_content[:before] # append our before block commands.
-        tab_content[:commands].insert(0, 'clear') if tab_name || !@working_dir.to_s.empty? # clean up prompt
-        tab_content[:commands].insert(0, "PS1=$PS1\"\\e]2;#{tab_name}\\a\"") if tab_name   # add title to tab
+        # append our before block commands.
+        tab_content[:commands].insert(0, window_content[:before]).flatten! if window_content[:before]
+        # clean up prompt
+        tab_content[:commands].insert(0, 'clear') if tab_name || !@working_dir.to_s.empty?
+        # add title to tab
+        tab_content[:commands].insert(0, "PS1=$PS1\"\\e]2;#{tab_name}\\a\"") if tab_name
         tab_content[:commands].insert(0, "cd \"#{@working_dir}\"") unless @working_dir.to_s.empty?
-        tab_content[:commands].each do |cmd|
-          execute_command(cmd, :in => tab)
-        end
+        tab_content[:commands].each { |cmd| execute_command(cmd, :in => tab) }
       end
       set_delayed_options
     end
 
     # Loads commands via the termfile and returns them as a hash
     # if it matches legacy yaml, parse as yaml, else use new dsl
+    # @param  [String] path to termfile
+    # @return [Hash] returns a hash containing termfile details
     def load_termfile(path)
       File.extname(path) == '.yml' ? Terminitor::Yaml.new(path).to_hash : Terminitor::Dsl.new(path).to_hash
     end
@@ -67,11 +74,14 @@ module Terminitor
 
     # Executes the Command
     # should use the :in key to interact with terminal object.
+    # @param [String] command to be ran.
+    # @param [Hash] options hash
     # execute_command 'cd /path/to', {:in => #<TerminalObject>}
     def execute_command(cmd, options = {})
     end
 
     # Opens a new tab and returns itself.
+    # @param [Hash] options hash.
     def open_tab(options = nil)
       @working_dir = Dir.pwd # pass in current directory.
     end
@@ -81,6 +91,7 @@ module Terminitor
     end
 
     # Opens a new window and returns the tab object.
+    # @param [Hahs] options hash.
     def open_window(options = nil)
       @working_dir = Dir.pwd # pass in current directory.      
     end

data/lib/terminitor/capture/cmd_capture.rb

@@ -0,0 +1,7 @@
+module Terminitor
+  class CmdCapture < AbstractCapture
+    def initialize
+      super
+    end
+  end
+end

data/lib/terminitor/capture/terminator_capture.rb

@@ -0,0 +1,9 @@
+module Terminitor
+  # Captures terminal windows and tabs for Terminator
+  class TerminatorCapture < AbstractCapture
+    def initialize
+      super
+    end
+  end
+end
+

data/lib/terminitor/cli.rb

@@ -29,14 +29,14 @@ module Terminitor
     desc "list", "lists all terminitor scripts"
     def list
       say "Global scripts: \n"
-      Dir.glob("#{ENV['HOME']}/.terminitor/*").each do |file|
+      Dir.glob("#{TERM_PATH}/*").each do |file|
         say "  * #{File.basename(file, '.term')} #{grab_comment_for_file(file)}"
       end
     end
 
     desc "init", "create initial root terminitor folder"
     def init
-      empty_directory "#{ENV['HOME']}/.terminitor"
+      empty_directory TERM_PATH
     end
 
     desc "edit PROJECT_NAME", "open termitor script"
@@ -91,5 +91,16 @@ module Terminitor
       remove_file path
     end
 
+    desc "update", "update Terminitor to new global path(.config/.terminitor)"
+    def update
+      if File.exists?(old_path = File.join(ENV['HOME'],'.terminitor/'))
+        FileUtils.cp_r "#{old_path}/.", TERM_PATH
+        FileUtils.rm_r old_path
+        say "Terminitor has updated your global folder to ~/.config/terminitor/ !"
+      else
+        say "Old .terminitor/ global path doesn't exist. cool."
+      end
+    end
+
   end
 end

data/lib/terminitor/cores/cmd_core/cmd_core.rb

@@ -0,0 +1,35 @@
+module Terminitor
+  class CmdCore < AbstractCore
+    attr_reader :current_window
+
+    CMD_XLT = {
+      'clear' => 'cls'
+    }
+    
+    def initialize(path)
+      @current_window = CurrentWindowsConsole.new
+      super
+    end
+
+    def execute_command(cmd, options = {})
+      cmd = CMD_XLT[cmd] || cmd
+      cmd += "\n" if (cmd =~ /\n\Z/).nil?
+      (options[:in] || current_window).send_command(cmd)
+    end
+
+    def open_tab(options = nil)
+      create_window 
+    end
+
+    def open_window(options = nil)
+      create_window
+    end 
+
+    def create_window
+      WindowsConsole.new :name=>'cmd'
+    end
+  end
+end
+
+
+

data/lib/terminitor/cores/cmd_core/input.rb

@@ -0,0 +1,273 @@
+module Terminitor
+  #
+  # Thanks win32/autogui!
+  #
+  module Input
+
+    # MSDN virtual key codes
+    VK_LBUTTON = 0x01
+    VK_RBUTTON = 0x02
+
+    VK_CANCEL = 0x03
+    VK_BACK = 0x08
+    VK_TAB = 0x09
+    VK_CLEAR = 0x0c
+    VK_RETURN = 0x0d
+    VK_SHIFT = 0x10
+    VK_CONTROL = 0x11
+    VK_MENU = 0x12
+    VK_PAUSE = 0x13
+    VK_ESCAPE = 0x1b
+    VK_SPACE = 0x20
+    VK_PRIOR = 0x21
+    VK_NEXT = 0x22
+    VK_END = 0x23
+    VK_HOME = 0x24
+    VK_LEFT = 0x25
+    VK_UP = 0x26
+    VK_RIGHT = 0x27
+    VK_DOWN = 0x28
+    VK_SELECT = 0x29
+    VK_EXECUTE = 0x2b
+    VK_SNAPSHOT = 0x2c
+    VK_INSERT = 0x2d
+    VK_DELETE = 0x2e
+    VK_HELP = 0x2f
+
+    VK_0 = 0x30
+    VK_1 = 0x31
+    VK_2 = 0x32
+    VK_3 = 0x33
+    VK_4 = 0x34
+    VK_5 = 0x35
+    VK_6 = 0x36
+    VK_7 = 0x37
+    VK_8 = 0x38
+    VK_9 = 0x39
+    VK_A = 0x41
+    VK_B = 0x42
+    VK_C = 0x43
+    VK_D = 0x44
+    VK_E = 0x45
+    VK_F = 0x46
+    VK_G = 0x47
+    VK_H = 0x48
+    VK_I = 0x49
+    VK_J = 0x4a
+    VK_K = 0x4b
+    VK_L = 0x4c
+    VK_M = 0x4d
+    VK_N = 0x4e
+    VK_O = 0x4f
+    VK_P = 0x50
+    VK_Q = 0x51
+    VK_R = 0x52
+    VK_S = 0x53
+    VK_T = 0x54
+    VK_U = 0x55
+    VK_V = 0x56
+    VK_W = 0x57
+    VK_X = 0x58
+    VK_Y = 0x59
+    VK_Z = 0x5a
+
+    VK_LWIN = 0x5b
+    VK_RWIN = 0x5c
+    VK_APPS = 0x5d
+
+    VK_NUMPAD0 = 0x60
+    VK_NUMPAD1 = 0x61
+    VK_NUMPAD2 = 0x62
+    VK_NUMPAD3 = 0x63
+    VK_NUMPAD4 = 0x64
+    VK_NUMPAD5 = 0x65
+    VK_NUMPAD6 = 0x66
+    VK_NUMPAD7 = 0x67
+    VK_NUMPAD8 = 0x68
+    VK_NUMPAD9 = 0x69
+    VK_MULTIPLY = 0x6a
+    VK_ADD = 0x6b
+    VK_SEPARATOR = 0x6c
+    VK_SUBTRACT = 0x6d
+    VK_DECIMAL = 0x6e
+    VK_DIVIDE = 0x6f
+
+    VK_F1 = 0x70
+    VK_F2 = 0x71
+    VK_F3 = 0x72
+    VK_F4 = 0x73
+    VK_F5 = 0x74
+    VK_F6 = 0x75
+    VK_F7 = 0x76
+    VK_F8 = 0x77
+    VK_F9 = 0x78
+    VK_F10 = 0x79
+    VK_F11 = 0x7a
+    VK_F12 = 0x7b
+
+    VK_NUMLOCK = 0x90
+    VK_SCROLL = 0x91
+    VK_OEM_EQU = 0x92
+    VK_LSHIFT = 0xa0
+    VK_RSHIFT = 0xa1
+    VK_LCONTROL = 0xa2
+    VK_RCONTROL = 0xa3
+    VK_LMENU = 0xa4
+    VK_RMENU = 0xa5
+
+    VK_OEM_1 = 0xba         # US ";:"
+    VK_OEM_PLUS = 0xbb
+    VK_OEM_COMMA = 0xbc
+    VK_OEM_MINUS = 0xbd
+    VK_OEM_PERIOD = 0xbe
+    VK_OEM_2 = 0xbf         # US "/?"
+    VK_OEM_3 = 0xc0         # US '`~'
+    VK_OEM_4 = 0xdb         # US "[{"
+    VK_OEM_5 = 0xdc         # US '\|'
+    VK_OEM_6 = 0xdd         # US ']}'
+    VK_OEM_7 = 0xde         # US quotes
+    VK_OEM_8 = 0xdf         # none
+
+    # delay in seconds between keystrokes
+    KEYBD_KEYDELAY = 0
+
+    # keybd_event
+    KEYBD_EVENT_KEYUP = 2
+    KEYBD_EVENT_KEYDOWN = 0
+
+    Windows::API.auto_namespace = 'Terminitor::Input'
+    Windows::API.auto_constant  = true
+    Windows::API.auto_method    = true
+    Windows::API.auto_unicode   = false
+
+    Windows::API.new('keybd_event', 'IILL', 'V', 'user32')
+    Windows::API.new('mouse_event', 'LLLLL', 'V', 'user32')
+
+    # Send keystroke to the focused window, keystrokes are virtual keycodes
+    #
+    # @example send 2+2<CR>
+    #
+    #     keystroke(VK_2, VK_ADD, VK_2, VK_RETURN)
+    #
+    def keystroke(*keys)
+      return if keys.empty?
+
+      keybd_event keys.first, 0, KEYBD_EVENT_KEYDOWN, 0
+      sleep KEYBD_KEYDELAY
+      keystroke *keys[1..-1]
+      sleep KEYBD_KEYDELAY
+      keybd_event keys.first, 0, KEYBD_EVENT_KEYUP, 0
+    end
+
+    # String together keystrokes, simulates the user typing.
+    #
+    # Note: This method can be slow for large strings.  Consider using
+    # the clipboard instead.
+    #
+    # @see Clipboard
+    #
+    # @example send 2+2<CR>
+    #
+    #     type_in("2+2\n")
+    #
+    # @param [String] string of characters to simulate typing
+    def type_in(string)
+      string.each_char do |char|
+        keystroke(*char_to_virtual_keycode(char))
+      end
+    end
+
+    private
+
+    # convert a single character to a virtual keycode
+    #
+    # @param [Char] char is the character to convert
+    #
+    # @return [Array] of virtual keycodes
+    def char_to_virtual_keycode(char)
+
+      unless char.size == 1
+        raise "virtual keycode conversion is for single characters only"
+      end
+
+      code = char.unpack('U')[0]
+
+      case char
+        when '0'..'9'
+          [code - ?0 + 0x30]
+        when 'A'..'Z'
+          [VK_SHIFT, code]
+        when 'a'..'z'
+          [code - ?a + ?A]
+        when ' '
+          [code]
+        when '+'
+          [VK_ADD]
+        when '='
+          [VK_OEM_PLUS]
+        when ','
+          [VK_OEM_COMMA]
+        when '.'
+          [VK_OEM_PERIOD]
+        when '-'
+          [VK_OEM_MINUS]
+        when '_'
+          [VK_SHIFT, VK_OEM_MINUS]
+
+        when ';'
+          [VK_OEM_1]
+        when ':'
+          [VK_SHIFT, VK_OEM_1]
+        when '/'
+          [VK_OEM_2]
+        when '?'
+          [VK_SHIFT, VK_OEM_2]
+        when '`'
+          [VK_OEM_3]
+        when '~'
+          [VK_SHIFT, VK_OEM_3]
+        when '['
+          [VK_OEM_4]
+        when '{'
+          [VK_SHIFT, VK_OEM_4]
+        when '\\'
+          [VK_OEM_5]
+        when '|'
+          [VK_SHIFT, VK_OEM_5]
+        when ']'
+          [VK_OEM_6]
+        when '}'
+          [VK_SHIFT, VK_OEM_6]
+        when "'"
+          [VK_OEM_7]
+        when '"'
+          [VK_SHIFT, VK_OEM_7]
+
+        when '!'
+          [VK_SHIFT, VK_1]
+        when '@'
+          [VK_SHIFT, VK_2]
+        when '#'
+          [VK_SHIFT, VK_3]
+        when '$'
+          [VK_SHIFT, VK_4]
+        when '%'
+          [VK_SHIFT, VK_5]
+        when '^'
+          [VK_SHIFT, VK_6]
+        when '&'
+          [VK_SHIFT, VK_7]
+        when '*'
+          [VK_SHIFT, VK_8]
+        when '('
+          [VK_SHIFT, VK_9]
+        when ')'
+          [VK_SHIFT, VK_0]
+        when "\n"
+          [VK_RETURN]
+        else
+          raise "No conversion exists for character #{char}"
+      end
+    end
+  end
+end