termdump 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4837eea42355201b14f0cee3c1181f50e1f7a06a
+  data.tar.gz: 953466fc7b97cd9bea4a765df361438d017f79e8
+SHA512:
+  metadata.gz: b96f0653fde8b878bde672c3e230752521e45958cd20020d24e6d9fb6fb3d1b3eb57baa4f0c0ead2a395a968c6ea1e93e399436394509b8cf35ae54dbcd58a74
+  data.tar.gz: c130b998cb570f3b839d43c25277a50402ab7ffdb0952a83755946b15eea106c050ae795a01ec1351742d3a47fc6ebbabc7a9bed050ba3875c926207c36b20f3

data/README.md

@@ -0,0 +1,80 @@
+# termdump
+
+[![Build Status](https://travis-ci.org/spacewander/termdump.svg?branch=master)](http://travis-ci.org/spacewander/termdump)
+
+Dump your (pseudo)terminal session and replay it. You can use it to bootstrap daily work.
+
+## Usage
+
+```shell
+Usage: termdump [options] [session]
+    -i, --init                       initialize configure interactively
+    -e, --edit [session]             edit session
+    -d, --delete [session]           delete session
+    -s, --save [session]             save session
+        --stdout                     print dump result to stdout while saving a session
+        --exclude                    exclude current pty while saving a session
+    -l, --list                       list all sessions
+    -v, --version                    print version
+```
+
+### initialize configure
+
+```shell
+$ termdump -i
+```
+
+### dump a session
+
+```shell
+$ termdump -s mydailywork
+# or `termdump -s mydailywork --exclude`
+# if you want to exclude the pty running this command
+```
+
+### load a session
+
+```shell
+$ termdump mydailywork
+```
+
+### edit a session
+
+```shell
+$ termdump -e mydailywork
+```
+
+### delete a session
+
+```shell
+$ termdump -d mydailywork
+```
+
+Read more in [session syntax and examples](sessions.md) and [configure](configure.md).
+
+## Supported terminal
+
+- [x] gnome-terminal
+- [x] terminator
+- [x] xterm
+- [x] guake
+- [ ] urxvt
+- [ ] konsole
+- [ ] xfce4-terminal
+
+If you want to support Terminal X, you can write a terminal file under
+https://github.com/spacewander/termdump/tree/master/lib/termdump/terminal and then send me a pr.
+Currently there is not a plan to support terminals in OS X platform, since I don't have OS X to test with.
+If you want to implement one, you may need to use [cliclick](https://github.com/BlueM/cliclick) instead of `xdotool`.
+
+## Requirements
+
+Current requirements are `ps` and `xdotool`.
+We use `ps` to get the result of terminal session, and `xdotool` to emulate typing.
+
+`ps` has been shipped with your OS probably.
+You can install `xdotool` via [this guide](http://www.semicomplete.com/projects/xdotool/#idp9392).
+
+## Video
+
+TODO

data/Rakefile

@@ -0,0 +1,20 @@
+#!/usr/bin/env rake
+# encoding: UTF-8
+
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/test_*.rb'
+  t.verbose = false
+  # so we can type `rake TEST="xxx"` instead of `rake TEST="test/test_xxx.rb"`
+  test = ENV['TEST']
+  unless test.nil?
+    ENV['TEST'] = 'test/test_' + test unless test.start_with? 'test/test_'
+    ENV['TEST'] += '.rb' unless test.end_with? '.rb'
+  end
+end
+
+task :default => :test

data/bin/termdump

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require 'termdump'
+
+TermDump::Command.new(ARGV).run

data/etc/Rakefile

@@ -0,0 +1,19 @@
+#!/usr/bin/env rake
+# encoding: UTF-8
+
+require 'rake'
+require 'fileutils'
+
+task :prepare do
+  bash_completion_dir = '/etc/bash_completion.d'
+  if Dir.exist?(bash_completion_dir)
+    FileUtils.cp './termdump', bash_completion_dir
+  end
+  #FileUtils.cp './_termdump', '/usr/share/zsh/functions/Completion/_termdump'
+  
+  man_page_dir = '/usr/share/man/man1'
+  if Dir.exist?(man_page_dir)
+    FileUtils.cp 'termdump.1', man_page_dir
+  end
+end
+task :default => :prepare

data/etc/_termdump

@@ -0,0 +1,25 @@
+#compdef termdump
+
+local state session_dir
+session_dir="(~/.config/termdump/session/)"
+
+_arguments \
+    {-i,--init}'[initialize configure interactively]' \
+    {-e,--edit}'[edit session]: :->session' \
+    {-d,--delete}'[delete session]: :->session' \
+    {-s,--save}'[save session]: :->save' \
+    {-l,--list}'[list all sessions]' \
+    {-v,--version}'[print version]' \
+    {-h,--help}'[show usage message]' \
+    '*:load session:->session' && return 0
+
+case "$state" in
+    session )
+        _files -W ${session_dir} -g '*.yml(:t:r)'
+        ;;
+    save )
+        _arguments \
+            '--exclude[exclude current pty while saving a session]' \
+            '--stdout[print dump result to stdout while saving a session]' \
+            '*:save session:_files -W ${session_dir} -g "*.yml(:t:r)"'
+esac

data/etc/man.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+pandoc -s -t man termdump.1.md -o termdump.1

data/etc/termdump

@@ -0,0 +1,47 @@
+# bash completion script for termdump
+_termdump() {
+    local pre cur
+
+    COMPREPLY=()
+    pre=${COMP_WORDS[COMP_CWORD-1]}
+    cur=${COMP_WORDS[COMP_CWORD]}
+
+    list_session_dir() {
+         find ~/.config/termdump/session/ -iname '*.yml' -exec basename -s '.yml' {} \;
+    }
+
+    case "$pre" in
+    -e|--edit|-d|--delete )
+        COMPREPLY=( $( compgen -W "$(list_session_dir)" ) )
+        return 0
+        ;;
+    -i )
+        return 0
+        ;;
+    -l|--list )
+        COMPREPLY=( $( compgen -W "-d --delete -e --edit" ) )
+        return 0
+        ;;
+    -s )
+        COMPREPLY=( $( compgen -W "--exclude --stdout" -- $cur ) )
+        COMPREPLY+=( $( compgen -W "$(list_session_dir)" -- $cur ) )
+        return 0
+    esac
+    
+    complete_options() {
+        local opts
+        opts='-i --init -d --delete -e --edit -h --help -l --list -s --save 
+        -v --version'
+        echo "$opts"
+    }
+
+    case "$cur" in
+    -* )
+        COMPREPLY=( $( compgen -W "$(complete_options)" -- $cur ) )
+        ;;
+    * )
+        COMPREPLY=( $( compgen -W "$(complete_options)" -- $cur ) )
+        COMPREPLY+=( $( compgen -W "$(list_session_dir)" -- $cur ) )
+    esac
+}
+complete -F _termdump filenames termdump

data/etc/termdump.1

@@ -0,0 +1,79 @@
+.TH "TERMDUMP" "1" "Jul 17, 2015" "Termdump User Manuals" ""
+.SH NAME
+.PP
+termdump \-\- Dump your pty session and replay it
+.SH SYNOPSIS
+.PP
+termdump [\f[I]option\f[]] [\f[I]session\f[]]
+.SH DESCRIPTION
+.PP
+Dump your (pseudo)terminal session and replay it.
+You can use it to bootstrap daily work.
+.SH OPTIONS
+.TP
+.B \-h, \-\-help
+output usage information
+.RS
+.RE
+.TP
+.B \-i, \-\-init
+initialize configure interactively
+.RS
+.RE
+.TP
+.B \-e, \-\-edit \f[I]session\f[]
+edit session
+.RS
+.RE
+.TP
+.B \-d, \-\-delete \f[I]session\f[]
+delete session
+.RS
+.RE
+.TP
+.B \-s, \-\-save \f[I]session\f[]
+save session
+.RS
+.RE
+.TP
+.B \-l, \-\-list
+list all sessions
+.RS
+.RE
+.TP
+.B \-v, \-\-version
+print version
+.RS
+.RE
+.PP
+If you run \f[C]termdump\f[] with a session name only, it will replay
+the session.
+.SH SAVE OPTIONS
+.TP
+.B \-\-stdout
+print dump result to stdout while saving a session
+.RS
+.RE
+.TP
+.B \-\-exclude
+exclude current pty while saving a session
+.RS
+.RE
+.SH EXAMPLE
+.PP
+At the first time you use this tool, you may need to run
+\f[C]termdump\ \-i\f[] to set up configure.
+.PP
+Then you can run \f[C]termdump\ \-s\ [\-\-exclude]\f[] to save your
+current pty session.
+.PP
+Run \f[C]termdump\ \-l\f[] to list all saved sessions,
+\f[C]termdump\ \-e\f[] to edit one, and \f[C]termdump\ \-d\f[] to delete
+one.
+.PP
+To replay your session, you can run \f[C]termdump\ [session]\f[].
+.SH REPORTING BUGS
+.PP
+<https://github.com/spacewander/termdump/issues>
+.SH AUTHORS
+spacewander <spacewanderlzx@gmail.com>.

data/etc/termdump.1.md

@@ -0,0 +1,61 @@
+% TERMDUMP(1) Termdump User Manuals
+% spacewander <spacewanderlzx@gmail.com>
+% Jul 17, 2015
+
+# NAME
+termdump -- Dump your pty session and replay it
+
+# SYNOPSIS
+
+termdump [*option*] [*session*]
+
+# DESCRIPTION
+
+Dump your (pseudo)terminal session and replay it. You can use it to bootstrap daily work.
+
+# OPTIONS
+
+-h, --help
+:   output usage information
+
+-i, --init
+:   initialize configure interactively
+
+-e, --edit *session*
+:   edit session
+
+-d, --delete *session*
+:   delete session
+
+-s, --save *session*
+:   save session
+
+-l, --list
+:   list all sessions
+
+-v, --version
+:   print version
+
+If you run `termdump` with a session name only, it will replay the session.
+
+# SAVE OPTIONS
+
+--stdout
+:   print dump result to stdout while saving a session
+
+--exclude
+:   exclude current pty while saving a session
+
+# EXAMPLE
+
+At the first time you use this tool, you may need to run `termdump -i` to set up configure.
+
+Then you can run `termdump -s [--exclude]` to save your current pty session.
+
+Run `termdump -l` to list all saved sessions, `termdump -e` to edit one, and `termdump -d` to delete one.
+
+To replay your session, you can run `termdump [session]`.
+
+# REPORTING BUGS
+
+<https://github.com/spacewander/termdump/issues>

data/lib/termdump/command.rb

@@ -0,0 +1,81 @@
+require 'ostruct'
+require 'optparse'
+
+require 'termdump/main'
+require 'termdump/version'
+
+module TermDump
+  class Command
+    def initialize args
+      @args = OpenStruct.new(:stdout => false, :action => :load, :list => false,
+                             :session => '', :exclude => false)
+      OptionParser.new do |opts|
+        opts.banner = "Usage: termdump [options] [session]"
+        opts.on('-i', '--init', 'initialize configure interactively') {
+          @args.action = :init
+        }
+        opts.on('-e', '--edit [session]', 'edit session') do |name|
+          @args.action = :edit
+          name.nil? ? @args.list = true : @args.session = name
+        end
+        opts.on('-d', '--delete [session]', 'delete session') do |name|
+          @args.action = :delete
+          name.nil? ? @args.list = true : @args.session = name
+        end
+        opts.on('-s', '--save [session]', 'save session') do |name|
+          @args.action = :save
+          name.nil? ? @args.list = true : @args.session = name
+        end
+
+        opts.on_tail('--stdout', 'print dump result to stdout while saving a session') {
+          @args.stdout = true 
+        }
+        opts.on_tail('--exclude', 'exclude current pty while saving a session') {
+          @args.exclude = true
+        }
+        opts.on_tail('-l', '--list', 'list all sessions') { 
+          @args.list = true
+        }
+        opts.on_tail('-v', '--version', 'print version') do
+          puts VERSION
+          exit 0
+        end
+        opts.parse! args
+
+        # :load is the default action if no option given
+        if @args.action == :load
+          args.size > 0 ? @args.session = args[0] : @args.list = true
+        end
+        # --stdout should be used with --save
+        if @args.stdout || @args.exclude
+          if @args.action != :save
+            puts opts.help 
+            exit 1
+          end
+        end
+      end
+    end
+
+    def run
+      main = Main.new
+      if @args.action == :save
+        main.save @args.session, @args.stdout, @args.exclude
+      elsif @args.action == :init
+        main.init
+      elsif @args.list
+        main.list @args.action
+      else
+        name = @args.session
+        case @args.action
+        when :delete
+          main.delete_session name
+        when :edit
+          main.edit_session name
+        when :load
+          main.load_session name
+        end
+      end
+    end
+     
+  end
+end