showterm 0.2.6 → 0.2.7

data/bin/showterm

@@ -3,32 +3,81 @@
 require 'readline'
 require File.join(File.dirname(File.dirname(__FILE__)), 'lib/showterm')
 
+if '-e' == ARGV[0]
+  $edit_timings = true
+  ARGV.shift
+end
+
 if ARGV.include?('-h') || ARGV.include?('--help')
   puts <<-EOF
-Usage: showterm <command to run>
+Usage: showterm [-e] <command to run>
 
 showterm will record the exact output of your session, and upload it to the
 internet where it can be replayed by anyone to whom you give the URL.
+
+You can pass `-e` as the first arg and it will allow you to edit the timings
+file before uploading. This can be nice if you want to take long pauses (such
+as searching an answer out) in between commands.
  EOF
  exit
 end
 
+def save which, data
+  path = "/tmp/showtime.#$$.#{which}"
+  File.open(path, 'w') do |f|
+    f.write(data)
+  end
+  path
+end
+
+def leave_trace message, sf, tf
+  script_path = save 'script', sf
+  times_path = save 'times', tf
+  puts message
+  puts %(your work is safe in "#{script_path}" and "#{times_path}")
+  puts "To try uploading manually, use:"
+  puts %(ruby -rshowterm -e'Showterm.upload! File.read("/tmp/showtime.#$$.script"), File.read("/tmp/showtime.#$$.times")')
+end
+
+puts 'showterm recording. (Exit shell when done.)'
 sf, tf = Showterm.record! *ARGV
-begin
-  Showterm.upload! sf, tf
-rescue => e
-  File.open("/tmp/showtime.#$$.script", 'w') do |f|
-    f.write(sf)
+puts 'showterm recording finished.'
+
+if $edit_timings
+  editor = ENV.fetch('VISUAL', ENV.fetch('EDITOR', 'vim'))
+  tips = if 'vim' == editor
+    <<-TIPS
+Hot vim tips:
+  Use :cq  from vim to exit nonzero, and cancel the upload
+  Use :%s/^[0-9]\./0./  to get rid of all longish pauses.
+    TIPS
+  else
+    <<-CONSOLATION_TIPS
+If you can make your editor return nonzero, it will cancel the upload.
+    CONSOLATION_TIPS
   end
+  puts <<-TEXT
 
-  File.open("/tmp/showtime.#$$.times", 'w') do |f|
-    f.write(sf)
+Recording done, now it's time to dress up those timings!
+#{tips}
+[Hit Enter to edit]
+  TEXT
+  $stdin.readline
+  times_path = save 'times', tf
+  success = system(editor, times_path)
+  if success
+    tf = File.read(times_path)
+  else
+    leave_trace "OK, discarding edits and skipping upload.", sf, tf
+    exit 1
   end
+end
+
+begin
+  puts "Uploading..."
+  puts Showterm.upload! sf, tf
+rescue => e
   puts [e] + e.backtrace
   puts "-" * 80
-  puts "DON'T PANIC"
-  puts %(your work is safe in "/tmp/showtime.#$$.script" and "/tmp/showtime.#$$.times")
-  puts "To try uploading manually use:"
-
-  puts %(ruby -rshowterm -e'Showterm.upload! File.read("/tmp/showtime.#$$.script"), File.read("/tmp/showtime.#$$.times")')
+  leave_trace "DON'T PANIC", sf, tf
 end

data/lib/showterm.rb

@@ -13,15 +13,11 @@ module Showterm
   # @param [*String] cmd
   # @return [scriptfile, timingfile]  the two halves of a termshow
   def record!(*cmd)
-    if use_script?
-      puts 'showterm recording, exit when done'
-      ret = record_with_script(*cmd)
+    ret = if use_script?
+      record_with_script(*cmd)
     else
-      puts 'showterm recording, exit when done'
-      ret = record_with_ttyrec(*cmd)
+      record_with_ttyrec(*cmd)
     end
-    puts 'showterm recording finished, uploading...'
-
     ret
   end
 
@@ -39,7 +35,6 @@ module Showterm
   # @param [String] timingfile  The timings
   # @param [Integer] cols  The width of the terminal
   def upload!(scriptfile, timingfile, cols=terminal_width)
-    retried = false
     request = Net::HTTP::Post.new("/scripts")
     request.set_form_data(:scriptfile => scriptfile,
                           :timingfile => timingfile,
@@ -47,7 +42,7 @@ module Showterm
 
     response = http(request)
     raise response.body unless Net::HTTPSuccess === response
-    puts response.body
+    response.body
   rescue => e
     raise if retried
     retried = true

data/showterm.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "showterm"
-  s.version = "0.2.6"
+  s.version = "0.2.7"
   s.platform = Gem::Platform::RUBY
   s.author = "Conrad Irwin"
   s.email = "conrad.irwin@gmail.com"

metadata

@@ -1,24 +1,32 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: showterm
-version: !ruby/object:Gem::Version
-  version: 0.2.6
+version: !ruby/object:Gem::Version 
+  hash: 25
   prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 7
+  version: 0.2.7
 platform: ruby
-authors:
+authors: 
 - Conrad Irwin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-10 00:00:00.000000000 Z
+
+date: 2012-11-06 00:00:00 Z
 dependencies: []
+
 description: Integrates with showterm.io for awesome sharability.
 email: conrad.irwin@gmail.com
-executables:
+executables: 
 - showterm
-extensions:
+extensions: 
 - ext/extconf.rb
 extra_rdoc_files: []
-files:
+
+files: 
 - LICENSE.MIT
 - README.md
 - bin/showterm
@@ -38,27 +46,37 @@ files:
 - showterm.gemspec
 homepage: http://github.com/Conradirwin/showterm
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Allows you to make screen casts of your terminal really easily
 test_files: []
+
 has_rdoc: