termdump 0.2.0

data/lib/termdump/terminal/base/terminal_helper.rb

@@ -0,0 +1,35 @@
+require 'shellwords'
+
+module TermDump
+  module TerminalHelper
+
+    # Doing convertion below and join them with '+'
+    # case 0 : <Ctrl><Shift><Alt><Super> => Ctrl Shift Alt Super
+    # case 1 : [A-Z] => [a-z]
+    # case 2 : <Primary> => Ctrl
+    # case 3 : [0-9] [a-z] UpDownLeftRight F[0-12] Return space... => not changed
+    # For example, 
+    # '<Primary><Shift>A' => 'Ctrl+Shift+a'
+    # '<Alt>space' => 'Alt+space'
+    def convert_key_sequence in_sequence
+      in_sequence.tr_s!('[<>]', ' ')
+      out_sequence = in_sequence.split.map do |key|
+        if /^[[:upper:]]$/.match(key)
+          key.downcase
+        elsif key == 'Primary'
+          'Ctrl'
+        else
+          key
+        end
+      end
+      out_sequence.join('+')
+    end
+    
+    # escape the command string so that it can be executed safily in the shell
+    def escape cmd
+      # not woking under windows, but I don't think I will support windows :)
+      Shellwords.escape cmd
+    end
+
+  end
+end

data/lib/termdump/terminal/gnome_terminal.rb

@@ -0,0 +1,44 @@
+require_relative 'base/base'
+
+module TermDump
+  # This Terminal class is for [gnome-terminal](https://wiki.gnome.org/Apps/Terminal)
+  class Terminal < BasicTerminal
+    def initialize config
+      @user_defined_config = config
+      @keybindings = '/apps/gnome-terminal/keybindings'
+      @config = {
+        'new_window' => get_configure_key('new_window'),
+        'new_tab' => get_configure_key('new_tab')
+      }
+
+      @default_config = {
+        'new_window' => 'ctrl+alt+t',
+        'new_tab' => 'ctrl+shift+t',
+      }
+    end
+
+    def get_configure_key key
+      value = IO.popen(
+        "gconftool -g '#{@keybindings}/#{key}' 2>/dev/null").read.chomp
+      convert_key_sequence(value) if value != ''
+    end
+
+    def exec cwd, cmd
+      sleep 0.5
+      `xdotool getactivewindow type #{escape("cd #{cwd}\n")}`
+      `xdotool getactivewindow type #{escape("#{cmd}\n")}` unless cmd.nil?
+    end
+
+    def window name, cwd, cmd
+      # `getactivewindow key` not work on gnome-terminal, bug?
+      `xdotool key #{configure 'new_window'}`
+      exec cwd, cmd
+    end
+
+    def tab name, cwd, cmd
+      `xdotool key #{configure 'new_tab'}`
+      exec cwd, cmd
+    end
+  end
+end
+

data/lib/termdump/terminal/guake.rb

@@ -0,0 +1,48 @@
+require_relative 'base/base'
+
+module TermDump
+  # This Terminal class is for [guake](http://guake-project.org/)
+  # See `man guake`
+  class Terminal < BasicTerminal
+    def initialize config
+      @user_defined_config = config
+      @keybindings = '/apps/guake/keybindings'
+      @config = {
+        'new_tab' => get_configure_key('new_tab')
+      }
+
+      @default_config = {
+        'new_window' => 'F12',
+        'new_tab' => 'ctrl+shift+t'
+      }
+    end
+
+    def get_configure_key key
+      value = IO.popen(
+        "gconftool -g '#{@keybindings}/#{key}' 2>/dev/null").read.chomp
+      value if value != ''
+    end
+
+    # There is no 'window' concept in guake. 
+    # Only one terminal instance exists all the time. So treat it as tab
+    def window name, cwd, cmd
+      tab name, cwd, cmd
+    end
+
+    def tab name, cwd, cmd
+      with_name = ''
+      with_cwd = ''
+      with_cmd = ''
+      with_name = "-r #{escape(name)}" unless name.nil? || name == ''
+      with_cwd = "-n #{escape(cwd)}" unless cwd.nil? || cwd == ''
+      with_cmd = "-e #{escape(cmd)}" unless cmd.nil? || cmd == ''
+      `guake #{with_name} #{with_cwd} #{with_cmd}`
+    end
+
+    def exec cwd, cmd
+      exec_cmd = "cd #{cwd}"
+      exec_cmd += " && #{cmd}" unless cmd.nil? || cmd == ''
+      `guake -e #{escape(exec_cmd)}`
+    end
+  end
+end

data/lib/termdump/terminal/terminator.rb

@@ -0,0 +1,94 @@
+require_relative 'base/base'
+
+module TermDump
+  # This Terminal class is for [terminator](http://gnometerminator.blogspot.sg/p/introduction.html)
+  # See `man terminator` and `man termintor_config`
+  class Terminal < BasicTerminal
+    def initialize config
+      @user_defined_config = config
+      # the config file will be ~/.config/terminator/config, 
+      # but it may be overridden with $XDG_CONFIG_HOME 
+      # (in which case it will be $XDG_CONFIG_HOME/terminator/config)
+      if ENV['XDG_CONFIG_HOME'].nil?
+        configure = "#{Dir.home}/.config/terminator/config"
+      else
+        configure = "#{ENV['XDG_CONFIG_HOME']}/terminator/config"
+      end
+      if File.exist?(configure)
+        lines = IO.readlines(configure)
+        @config = parse_configure lines
+      else
+        @config = {}
+      end
+      @default_config = {
+        'new_window' => 'ctrl+shift+i',
+        'new_tab' => 'ctrl+shift+t',
+        'new_vsplit' => 'ctrl+shift+e',
+        'new_hsplit' => 'ctrl+shift+o'
+      }
+    end
+
+    CONFIGURE_KEY_MAPPER = {
+      'new_tab' => 'new_tab',
+      'split_vert' => 'new_vsplit',
+      'split_horiz' => 'new_hsplit',
+      'new_window' => 'new_window'
+    }
+    # Parse lines and fill @config with key mapper result.
+    #
+    # The configure format of terminator:
+    #[keybindings]
+    #  full_screen = <Ctrl><Shift>F11
+    #
+    # We only care about the keybindings.
+    def parse_configure lines
+      config = {}
+      in_keybindings = false
+      lines.each do |line|
+        line.rstrip!
+        if in_keybindings
+          if line.start_with?('[') || line == ''
+            in_keybindings = false
+          else
+            key, value = line.split('=', 2)
+            key.strip!
+            first, _, third = value.rpartition('#')
+            value = (first != "" ? first.strip : third.strip)
+            key = CONFIGURE_KEY_MAPPER[key]
+            unless key.nil? || value == ''
+              config[key] = convert_key_sequence(value)
+            end
+          end
+        end 
+        in_keybindings = true if line == '[keybindings]'
+      end
+      config
+    end
+
+    def exec cwd, cmd
+      sleep 0.5
+      `xdotool getactivewindow type #{escape("cd #{cwd}\n")}`
+      `xdotool getactivewindow type #{escape("#{cmd}\n")}` unless cmd.nil?
+    end
+
+    def window name, cwd, cmd
+      `xdotool getactivewindow key #{configure 'new_window'}`
+      exec cwd, cmd
+    end
+
+    def tab name, cwd, cmd
+      `xdotool getactivewindow key #{configure 'new_tab'}`
+      exec cwd, cmd
+    end
+
+    def vsplit name, cwd, cmd
+      `xdotool getactivewindow key #{configure 'new_vsplit'}`
+      exec cwd, cmd
+    end
+
+    def hsplit name, cwd, cmd
+      `xdotool getactivewindow key #{configure 'new_hsplit'}`
+      exec cwd, cmd
+    end
+  end
+end

data/lib/termdump/terminal/xterm.rb

@@ -0,0 +1,22 @@
+require_relative 'base/base'
+
+module TermDump
+  # This Terminal class is for xterm
+  # See `man xterm`
+  class Terminal < BasicTerminal
+    def initialize config
+    end
+
+    def exec cwd, cmd
+      sleep 0.5
+      `xdotool getactivewindow type #{escape("cd #{cwd}\n")}`
+      `xdotool getactivewindow type #{escape("#{cmd}\n")}` unless cmd.nil?
+    end
+
+    def window name, cwd, cmd
+      IO.popen("xterm &") # `xterm &` is blocking
+      exec cwd, cmd
+    end
+  end
+end
+

data/lib/termdump/version.rb

@@ -0,0 +1,4 @@
+module TermDump
+  VERSION = '0.2.0'
+end
+

data/lib/termdump.rb

@@ -0,0 +1 @@
+require 'termdump/command'

data/test/run_cmd.sh

@@ -0,0 +1,8 @@
+#!/bin/sh
+
+# test features which can't be tested automatically
+script="../bin/termdump"
+"$script" -s # save and ask for a name
+"$script" -e # edit one
+"$script" # load one
+"$script" -d # delete one

data/test/test_basic_terminal.rb

@@ -0,0 +1,32 @@
+require 'minitest/autorun'
+
+require 'termdump/terminal/base/base'
+
+class TestBasicTerminal < MiniTest::Test
+  def test_configure
+    bt = TermDump::BasicTerminal.new({'new_window' => 'ctrl+n'})
+    assert_raises KeyError do
+      bt.configure 'new_tab'
+    end
+    assert_equal 'ctrl+n', bt.configure('new_window')
+  end
+
+  def test_convert_key_sequence
+    bt = TermDump::BasicTerminal.new({})
+    assert_equal 'Ctrl+a+Shift', bt.convert_key_sequence('<Ctrl>A<Shift>')
+    assert_equal 'Ctrl+Shift+a', bt.convert_key_sequence('<Primary><Shift>A')
+    assert_equal 'Alt+space', bt.convert_key_sequence('<Alt>space')
+    assert_equal 'Super+plus', bt.convert_key_sequence('<Super>plus')
+    assert_equal 'a', bt.convert_key_sequence('A')
+    assert_equal 'Shift+a', bt.convert_key_sequence('<Shift>A')
+  end 
+
+  def test_escape
+    bt = TermDump::BasicTerminal.new({})
+    res = IO.popen("echo #{bt.escape("com && this")}").read.chomp
+    assert_equal "com && this", res
+    res = IO.popen("echo #{bt.escape("com || this")}").read.chomp
+    assert_equal "com || this", res
+  end
+
+end

data/test/test_command.rb

@@ -0,0 +1,66 @@
+require 'minitest/autorun'
+
+require 'termdump/command'
+
+class TestCommand < MiniTest::Test
+  def setup
+    @comm = TermDump::Command.new([])
+  end
+
+  def get_parsed_args args
+    TermDump::Command.new(args.split).instance_variable_get(:@args)
+  end
+
+  def test_args
+    # list all sessions
+    args = get_parsed_args "-l"
+    assert_equal true, args.list
+    args = get_parsed_args ""
+    assert_equal :load, args.action
+    assert_equal true, args.list
+
+    # delete one session
+    args = get_parsed_args "-d ruby"
+    assert_equal false, args.list
+    assert_equal :delete, args.action
+    assert_equal 'ruby', args.session
+
+    # list all sessions and delete one
+    args = get_parsed_args "-d"
+    assert_equal :delete, args.action
+    assert_equal true, args.list
+
+    # load one session
+    args = get_parsed_args "ruby"
+    assert_equal :load, args.action
+    assert_equal 'ruby', args.session
+    assert_equal false, args.list
+
+    # edit one session
+    args = get_parsed_args "-e ruby"
+    assert_equal :edit, args.action
+    assert_equal 'ruby', args.session
+
+    # dump to a session
+    args = get_parsed_args "-s"
+    assert_equal :save, args.action
+    assert_equal true, args.list
+    args = get_parsed_args "-s ruby"
+    assert_equal 'ruby', args.session
+
+    # print result to stdout(works with -s)
+    args = get_parsed_args "-s ruby --stdout"
+    assert_equal true, args.stdout
+
+    # initialize interactively
+    args = get_parsed_args "-i"
+    assert_equal :init, args.action
+
+    # dump exclude current tab
+    args = get_parsed_args "-s ruby --exclude"
+    assert_equal true, args.exclude
+    args = get_parsed_args "-s ruby --exclude --stdout"
+    assert_equal true, args.stdout
+    assert_equal true, args.exclude
+  end
+end

data/test/test_gnome_terminal.rb

@@ -0,0 +1,13 @@
+require 'minitest/autorun'
+
+require 'termdump/terminal/gnome_terminal'
+
+class TestGnomeTerminal < MiniTest::Test
+  @@term = TermDump::Terminal.new({})
+
+  def test_get_configure_key
+    nonexist = @@term.get_configure_key 'nonexist'
+    assert_nil nonexist
+    # in travi ci, since gconftool does not exist, all key will get empty result
+  end
+end

data/test/test_main.rb

@@ -0,0 +1,241 @@
+require 'minitest/autorun'
+require 'yaml'
+
+require 'termdump/main'
+
+class TestMain < MiniTest::Test
+  def setup
+    @main = TermDump::Main.new
+  end
+
+  def test_read_configure
+    config = {'terminal' => 'mock', 'new_window' => 'ctrl+n' }
+    IO.write "config_fixture", YAML.dump(config)
+    TermDump::Main.class_variable_set :@@config_file, "config_fixture"
+    main = TermDump::Main.new
+    assert_equal config, main.instance_variable_get(:@config)
+    File.delete "config_fixture"
+  end
+
+  def test_session_actions
+    Dir.rmdir("tmp") if Dir.exist?("tmp")
+    Dir.mkdir "tmp"
+    path = File.join Dir.pwd, "tmp"
+    TermDump::Main.class_variable_set :@@session_dir, path
+    status = @main.search_session 'nonexistent'
+    assert_equal File.join(path, 'nonexistent.yml'), status[:name]
+    assert_equal false, status[:exist]
+
+    @main.save 'termdump', true, false # print to stdout
+    assert_equal 2, Dir.entries(path).size
+    # print to stdout and exclude current ptty
+    # The output is the same as above, as the parent of `rake test` is `rake`
+    # but not the session leader
+    @main.save 'termdump', true, true 
+
+    @main.save 'termdump', false, false
+    assert_equal 3, Dir.entries(path).size
+    status = @main.search_session 'termdump'
+    assert_equal true, status[:exist]
+    # edit_session can't be tested automatically
+    res = @main.load_file 'termdump'
+    assert_equal true, res.is_a?(Hash)
+
+    task = @main.check res # the output of res may be modified
+    assert_equal true, task.is_a?(Hash)
+
+    @main.delete_session 'termdump'
+    assert_equal 2, Dir.entries(path).size
+    Dir.rmdir "tmp"
+  end
+
+  def test_path
+    prefix = @main.exact_commom_prefix(['~/termdump/bin', '~/termdump/lib', 
+                               '~/termdump/test', '~'])
+    assert_equal "~/termdump", prefix
+    prefix = @main.exact_commom_prefix(['~', '/root', '/root/some'])
+    assert_equal "/root", prefix
+    prefix = @main.exact_commom_prefix(['~/github/bin', '~/termdump/bin'])
+    assert_equal "", prefix
+    prefix = @main.exact_commom_prefix(['~/github/bin', '~/termdump/bin', 
+                                        '~/termdump/some'])
+    assert_equal "", prefix
+  end
+
+  def test_dump
+    ptree = {
+      '1000' => {
+        '1234' => ['~/termdump', TermDump::Process.new('1235', '1234', 'S+', 'vim')],
+        '2468' => ['~/github']
+      },
+      '1111' => {
+        '2345' => ['~/termdump', TermDump::Process.new('2346', '2345', 'S+', 'pry')]
+      }
+    }
+    path_prefix = {'$HOME' => '~'}
+    expected = { '$HOME' => '~',
+      'window0' => {
+        'cwd' => '~/termdump',
+        'command' => 'vim',
+        'tab0' => {
+          'cwd' => '~/github'
+        }
+      },
+      'window1' => {
+        'cwd' => '~/termdump',
+        'command' => 'pry'
+      }
+    }
+    assert_equal expected, YAML.load(@main.dump(ptree, path_prefix))
+  end
+
+  def test_parse_variables
+    ptree = { 
+      '$HOME' => '~',
+      'window0' => {
+        'cwd' => '~/${HOME}',
+        'tab0' => {
+          'cwd' => '${HOME}/termdump',
+          'command' => 'vim'
+        }
+      }
+    }
+    expected = {
+      'window0' => {
+        'cwd' => "#{Dir.home}/~",
+        'tab0' => {
+          'cwd' => "#{Dir.home}/termdump", 'command' => 'vim'
+        }
+      }
+    }
+    assert_equal expected, @main.parse_variables(ptree)
+
+    # multiple variables
+    ptree = { 
+      '$HOME' => '~',
+      '$PROJECT' => 'termdump',
+      '$other' => '~/github',
+      'window0' => {
+        'tab0' => { 'cwd' => '${HOME}/${PROJECT}/bin' },
+        'tab1' => { 'cwd' => '${HOME}/${PROJECT}/lib' },
+        'tab2' => { 'cwd' => '${other}'}
+      }
+    }
+    expected = {
+      'window0' => {
+        'tab0' => { 'cwd' => "#{Dir.home}/termdump/bin"},
+        'tab1' => { 'cwd' => "#{Dir.home}/termdump/lib"},
+        'tab2' => { 'cwd' => "#{Dir.home}/github" }
+      }
+    }
+    assert_equal expected, @main.parse_variables(ptree)
+
+    # escape
+    ptree = { 
+      '$0' => '~/termdump',
+      'window0' => {
+        'tab0' => { 'cwd' => '${0}/bin' },
+        'tab1' => { 'cwd' => '\${0}/lib' },
+      }
+    }
+    expected = {
+      'window0' => {
+        'tab0' => { 'cwd' => "#{Dir.home}/termdump/bin"},
+        'tab1' => { 'cwd' => '\${0}/lib'},
+      }
+    }
+    assert_equal expected, @main.parse_variables(ptree)
+  end
+
+  def test_check_node
+    node = {
+      'cwd' => Dir.home,
+      'window0' => { 'cwd' => Dir.home},
+      'tab0' => {
+        'tab0' => {
+          'vsplit' => {
+            'hsplit' => {},
+            'cwd' => Dir.home,
+            'tab0' => {}
+          },
+          'hsplit' => {}
+        }
+      }
+    }
+    expected =  {
+      'cwd' => Dir.home,
+      "tab0" => {
+        'cwd' => Dir.home,
+        "tab0" => {
+          "vsplit" => {
+            "hsplit" => {"cwd"=>Dir.home}, 
+            "cwd" => Dir.home
+          }, 
+          "hsplit" => {"cwd"=>Dir.home},
+          'cwd' => Dir.home
+        }
+      }
+    }
+    assert_equal expected, @main.check_node(node, :tab)
+  end
+
+  def test_cwd_not_exists
+    node = {
+      'tab' => {'cwd' => '.'}
+    }
+    # 'cwd' not found in window
+    assert_raises TermDump::SessionSyntaxError do
+      @main.check_node node, :window
+    end
+    # use parent's working directory
+    @main.check_node node, :window, Dir.home
+    assert_equal Dir.home, node['cwd']
+  end
+
+  def test_can_not_cd_to
+    node = {'cwd' => Dir.home}
+    @main.check_node node, :window
+    pwd = Dir.pwd
+    node = {'cwd' => pwd}
+    @main.check_node node, :window
+    # can't cd to
+    assert_raises TermDump::SessionSyntaxError do
+      @main.check_node({'cwd' => 'foo'}, :window, pwd)
+    end
+  end
+
+  def test_support_relative_path
+    node = {'cwd' => '.'}
+    pwd = Dir.pwd
+    @main.check_node node, :window, pwd
+    assert_equal pwd, node['cwd']
+    node = {'cwd' => '.'}
+    # missing base working directory
+    assert_raises TermDump::SessionSyntaxError do
+      @main.check_node node, :window
+    end
+  end
+
+  def test_node_should_be_hash
+    node = { 'tab' => 'cwd' }
+    # tab should be a node
+    assert_raises TermDump::SessionSyntaxError do
+      @main.check_node node, :window
+    end
+  end
+
+  def test_cwd_should_be_string
+    node = {'cwd' => {}}
+    assert_raises TermDump::SessionSyntaxError do
+      @main.check_node node, :window
+    end
+  end
+
+  def test_command_should_be_string
+    node = {'cwd' => Dir.home, 'command' => {}}
+    assert_raises TermDump::SessionSyntaxError do
+      @main.check_node node, :window
+    end
+  end
+
+end