shelr 0.10.0 → 0.11.0

data/VERSION

@@ -1 +1 @@
-0.10.0
+0.11.0

data/bin/shelr

@@ -9,17 +9,28 @@ BASENAME = File.basename(__FILE__)
 HELP     = <<-HELP
 
   Usage: #{BASENAME} command [arg]
-    
-  Commands:
-    setup API_KEY   - setup
+
+  Recording:
+
     record          - record new shellcast
+
+  Publishing:
+
     push last       - publish last record
     push RECORD_ID  - publish
+
+  Replaying:
+
     list            - print list of records
     play last       - play last local record
     play RECORD_ID  - play local record
     play RECORD_URL - play remote record
 
+  Setup:
+
+    setup API_KEY   - set your API key
+    backend [ttyrec|script] - setup recorder backend
+
   Visit: http://shelr.tv/ for more info.
 
 HELP
@@ -28,7 +39,7 @@ case ARGV[0]
 when '-h', '--help'
   puts HELP
 when 'record'
-	Shelr::Recorder.record!
+        Shelr::Recorder.record!
 when 'list'
   Shelr::Player.list
 when 'play'
@@ -60,6 +71,13 @@ when 'setup'
     puts "\n\tUsage: #{BASENAME} setup API_KEY\n\n"
     exit
   end
+when 'backend'
+  if ARGV[1]
+    Shelr.backend = ARGV[1]
+  else
+    puts "\n\tUsage: #{BASENAME} backend [ttyrec|script]\n\n"
+    exit
+  end
 else
   puts HELP
 end

data/lib/shelr/recorder.rb

@@ -3,21 +3,21 @@ module Shelr
   class Recorder
 
     HEADER = <<-EOH
- ____                        _ _             
-|  _ \ ___  ___ ___  _ __ __| (_)_ __   __ _ 
+ ____                        _ _
+|  _ \ ___  ___ ___  _ __ __| (_)_ __   __ _
 | |_) / _ \/ __/ _ \| '__/ _` | | '_ \ / _` |
 |  _ <  __/ (_| (_) | | | (_| | | | | | (_| |
 |_| \_\___|\___\___/|_|  \__,_|_|_| |_|\__, |
-                                       |___/ 
+                                       |___/
     EOH
 
     FOOTER = <<-EOF
- _____ _       _     _              _ 
+ _____ _       _     _              _
 |  ___(_)_ __ (_)___| |__   ___  __| |
 | |_  | | '_ \| / __| '_ \ / _ \/ _` |
 |  _| | | | | | \__ \ | | |  __/ (_| |
 |_|   |_|_| |_|_|___/_| |_|\___|\__,_|
-                                      
+
     EOF
 
     def self.record!
@@ -34,8 +34,9 @@ module Shelr
       puts HEADER
       puts "Your session started"
       puts "Type Ctrl+D or exit to finish recording"
-      system(script_cmd)
+      system(recorder_cmd)
       restore_terminal
+      save_as_typescript if Shelr.backend == 'ttyrec'
       puts FOOTER
       puts
       puts "Replay  : #{Shelr::APP_NAME} play last"
@@ -57,6 +58,20 @@ module Shelr
 
     private
 
+    def save_as_typescript
+      puts '=> Converting ttyrec -> typescript'
+
+      ttyrecord  = File.open(record_file('ttyrecord'), 'r')
+      converter  = Shelr::TTYRec.new(ttyrecord)
+      typescript = converter.parse.to_typescript
+
+      [:typescript, :timing].each do |part|
+        File.open(record_file(part.to_s), 'w') do |f|
+          f.write(typescript[part])
+        end
+      end
+    end
+
     def check_record_dir
       FileUtils.mkdir_p(record_dir) unless File.exists?(record_dir)
     end
@@ -85,9 +100,13 @@ module Shelr
       File.join(Shelr.data_dir(record_id), name)
     end
 
-    def script_cmd
-      "script -c 'bash' #{record_file('typescript')} -t 2> #{record_file('timing')}"
+    def recorder_cmd
+      case Shelr.backend
+      when 'script'
+        "script #{record_file('typescript')} -t 2> #{record_file('timing')}"
+      when 'ttyrec'
+        "ttyrec #{record_file('ttyrecord')}"
+      end
     end
-
   end
 end

data/lib/shelr/ttyrec.rb

@@ -0,0 +1,47 @@
+module Shelr
+  class TTYRec
+
+    def initialize(ttyrec)
+      @io = ttyrec
+      @timeline = []
+    end
+
+    def parse
+      while !@io.eof?
+        frame = {}
+        
+        sec, usec, len = @io.read(12).unpack('VVV')
+        data = @io.read(len)
+        
+        prev_timestamp ||= [ sec, usec ].join('.').to_f
+        curr_timestamp   = [ sec, usec ].join('.').to_f
+        
+        offset = curr_timestamp - prev_timestamp
+
+        frame = {
+          :offset => "%5.6f" % offset,
+          :data   => data,
+          :length => len
+        }
+        
+        @timeline << frame
+
+        prev_timestamp = curr_timestamp
+        prev_data = data
+      end
+      
+      self
+    end
+
+    def to_typescript
+      script = { :typescript => "Script started...\n", :timing => "" }
+
+      @timeline.each do |frame|
+        script[:timing] += [frame[:offset], ' ', frame[:length], "\n"].join
+        script[:typescript] += frame[:data]
+      end
+
+      script
+    end
+  end
+end

data/lib/shelr.rb

@@ -1,18 +1,19 @@
 require 'fileutils'
-require 'yaml'
 require 'json'
 
 module Shelr
 
-  APP_NAME   = 'shelr'
-  DATA_DIR   = File.join(ENV['HOME'], '.local', 'share', APP_NAME)
-  CONFIG_DIR = File.join(ENV['HOME'], '.config', APP_NAME)
-  API_KEY    = File.join(CONFIG_DIR, 'api_key')
-  API_URL    = ENV['SHELR_LOCAL'] ? 'http://localhost:3000' : 'http://shelr.tv'
+  APP_NAME    = 'shelr'
+  DATA_DIR    = File.join(ENV['HOME'], '.local', 'share', APP_NAME)
+  CONFIG_DIR  = File.join(ENV['HOME'], '.config', APP_NAME)
+  API_KEY     = File.join(CONFIG_DIR, 'api_key')
+  API_URL     = ENV['SHELR_LOCAL'] ? 'http://localhost:3000' : 'http://shelr.tv'
+  BACKEND_CFG = File.join(CONFIG_DIR, 'backend')
 
   autoload :Recorder,  'shelr/recorder.rb'
   autoload :Player,    'shelr/player.rb'
   autoload :Publisher, 'shelr/publisher.rb'
+  autoload :TTYRec,    'shelr/ttyrec.rb'
 
   class << self
     def api_key
@@ -21,10 +22,19 @@ module Shelr
     end
 
     def api_key=(key)
-      FileUtils.mkdir_p(CONFIG_DIR) unless File.exist?(CONFIG_DIR)
+      ensure_config_dir_exist
       File.open(API_KEY, 'w+') { |f| f.puts(key.strip) }
     end
 
+    def backend
+      @backend ||= File.read(BACKEND_CFG).strip || 'script'
+    end
+
+    def backend=(bin)
+      ensure_config_dir_exist
+      File.open(BACKEND_CFG, 'w+') { |f| f.puts(bin.strip) }
+    end
+
     def data_dir(record_id)
       id = record_id.strip == 'last' ? last_id : record_id.to_s
       File.join(Shelr::DATA_DIR, id)
@@ -33,6 +43,12 @@ module Shelr
     def last_id
       File.basename(Dir[File.join(Shelr::DATA_DIR, '*')].sort.last)
     end
+
+    private
+
+    def ensure_config_dir_exist
+      FileUtils.mkdir_p(CONFIG_DIR) unless File.exist?(CONFIG_DIR)
+    end
   end
 
 end

data/shelr.1

@@ -6,12 +6,15 @@
 .SH "NAME"
 \fBshelr\fR \- screencasting for shell ninjas
 .
+.SH "DESCRIPTION"
+\fBShelr\fR records terminal output and can replay it\.
+.
+.P
+Also you can shere Your records at http://shelr\.tv/ or other services\.
+.
 .SH "SYNOPSIS"
 \fBshelr\fR command [id]
 .
-.SH "DESCRIPTION"
-\fBShelr\fR records terminal output and can replay it
-.
 .SH "COMMANDS"
 .
 .TP
@@ -99,13 +102,21 @@ $ shelr push last # will push most recent local record
 .
 .IP "" 0
 .
-.SH "BUGS"
-\fBshelr\fR is written in Ruby and depends on \fBscript\fR and \fBscriptreplay\fR, commands libraries that are non\-trivial to install on some systems\.
-.
 .P
-\fBscript\fR on BSD and Darwin does not support timings\.
+Setup recording backend:
 .
-.P
+.IP "" 4
+.
+.nf
+
+$ shelr backend script
+$ shelr backend ttyrec
+.
+.fi
+.
+.IP "" 0
+.
+.SH "BUGS"
 \fBWindows\fR heh\.
 .
 .SH "COPYRIGHT"

data/shelr.1.ronn

@@ -1,13 +1,16 @@
 shelr(1) -- screencasting for shell ninjas
 ===============================================
 
-## SYNOPSIS
+## DESCRIPTION
 
-`shelr` command [id]
+**Shelr** records terminal output and can replay it.
 
-## DESCRIPTION
+Also you can shere Your records at http://shelr.tv/
+or other services.
+
+## SYNOPSIS
 
-**Shelr** records terminal output and can replay it 
+`shelr` command [id]
 
 ## COMMANDS
 
@@ -16,7 +19,7 @@ shelr(1) -- screencasting for shell ninjas
     store it to $HOME/.local/share/shelr/
 
   * `list`:
-    lists all your shellcasts. 
+    lists all your shellcasts.
 
   * `play`:
     plays local or remote shellcast.
@@ -50,13 +53,12 @@ Publish your shellcast:
     $ shelr push 1293702847
     $ shelr push last # will push most recent local record
 
+Setup recording backend:
 
-## BUGS
+    $ shelr backend script
+    $ shelr backend ttyrec
 
-**shelr** is written in Ruby and depends on `script` and `scriptreplay`,
-commands libraries that are non-trivial to install on some systems.
-
-**script** on BSD and Darwin does not support timings.
+## BUGS
 
 **Windows** heh.
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shelr
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-26 00:00:00.000000000Z
+date: 2012-02-27 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &10652700 !ruby/object:Gem::Requirement
+  requirement: &25328280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10652700
+  version_requirements: *25328280
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &10650840 !ruby/object:Gem::Requirement
+  requirement: &25327740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10650840
+  version_requirements: *25327740
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &10649440 !ruby/object:Gem::Requirement
+  requirement: &25276640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10649440
+  version_requirements: *25276640
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &10646940 !ruby/object:Gem::Requirement
+  requirement: &25276140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10646940
+  version_requirements: *25276140
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &10632680 !ruby/object:Gem::Requirement
+  requirement: &25275660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,7 +66,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10632680
+  version_requirements: *25275660
 description: Screencast utility for unix shell junkies :)
 email: self@antono.info
 executables:
@@ -90,6 +90,7 @@ files:
 - lib/shelr/player.rb
 - lib/shelr/publisher.rb
 - lib/shelr/recorder.rb
+- lib/shelr/ttyrec.rb
 - shelr.1
 - shelr.1.ronn
 - spec/shelr/player_spec.rb
@@ -112,7 +113,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4236082943444524578
+      hash: 3627863128559079363
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: