shelr 0.11.2 → 0.11.3

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3

data/Gemfile

@@ -1,9 +1,10 @@
 source "http://rubygems.org"
 
-group :development do
+group :development, :test do
   gem "rspec"
+  gem "aruba", :git => 'git://github.com/cucumber/aruba.git'
   gem "mocha"
   gem "bundler"
   gem "jeweler"
-  gem "rcov"
+  gem "simplecov"
 end

data/Gemfile.lock

@@ -1,31 +1,64 @@
+GIT
+  remote: git://github.com/cucumber/aruba.git
+  revision: fabc92edc45bf42b5747a0937dd31511d4ab774a
+  specs:
+    aruba (0.4.11)
+      childprocess (>= 0.2.3)
+      cucumber (>= 1.1.1)
+      ffi (>= 1.0.11)
+      rspec (>= 2.7.0)
+
 GEM
   remote: http://rubygems.org/
   specs:
-    diff-lcs (1.1.2)
+    builder (3.0.0)
+    childprocess (0.3.1)
+      ffi (~> 1.0.6)
+    cucumber (1.1.9)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.2)
+      gherkin (~> 2.9.0)
+      json (>= 1.4.6)
+      term-ansicolor (>= 1.0.6)
+    diff-lcs (1.1.3)
+    ffi (1.0.11)
+    gherkin (2.9.0)
+      json (>= 1.4.6)
     git (1.2.5)
-    jeweler (1.6.4)
+    jeweler (1.8.3)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
-    mocha (0.9.9)
-      rake
-    rake (0.9.2)
-    rcov (0.9.9)
-    rspec (2.1.0)
-      rspec-core (~> 2.1.0)
-      rspec-expectations (~> 2.1.0)
-      rspec-mocks (~> 2.1.0)
-    rspec-core (2.1.0)
-    rspec-expectations (2.1.0)
+      rdoc
+    json (1.6.5)
+    metaclass (0.0.1)
+    mocha (0.10.5)
+      metaclass (~> 0.0.1)
+    multi_json (1.1.0)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.1.0)
+    rspec-mocks (2.8.0)
+    simplecov (0.6.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    term-ansicolor (1.0.7)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  aruba!
   bundler
   jeweler
   mocha
-  rcov
   rspec
+  simplecov

data/README.md

@@ -22,7 +22,7 @@ PKGBUILD: https://aur.archlinux.org/packages.php?ID=56945
 
 ## Watching other's records
 
-   shelr play http://shelr.tv/records/4d1c5458905ba77eb7000002
+    shelr play http://shelr.tv/records/4f4ca2a43cd1090001000002.json
 
 You can watch them online at [http://shelr.tv/][TV]
 
@@ -42,12 +42,22 @@ You can watch them online at [http://shelr.tv/][TV]
 
 ## Dependencies
 
+### Linux/BSD/Hurd/etc...
+
 You need `script` and `scriptreplay` tools from BSD Utils.
 Tey are already installed if You use Debian/Ubuntu/BSD variants.
-Not sure about other OSes.
+
+### OSX
+
+If You use OS X - install `ttyrec` via homebrew and setup it as recording backend.
+
+     brew install ttyrec
+     shelr backend ttyrec
 
 ## Copyright
 
 Copyright (c) 2010, 2011, 2012 Antono Vasiljev. See LICENSE.txt for details.
 
+[![endorse](http://api.coderwall.com/antono/endorsecount.png)](http://coderwall.com/antono)
+
 [TV]: http://shelr.tv/ "Shellcasts from shell ninjas"

data/Rakefile

@@ -15,8 +15,8 @@ Jeweler::Tasks.new do |gem|
   gem.name = "shelr"
   gem.homepage = "http://shelr.tv/"
   gem.license = "GPLv3"
-  gem.summary = %Q{Screencasts for Shell Ninjas}
-  gem.description = %Q{Screencast utility for unix shell junkies :)}
+  gem.summary = "Screencasts for Shell Ninjas"
+  gem.description = "Screencast utility for unix shell junkies"
   gem.email = "self@antono.info"
   gem.authors = ["Antono Vasiljev", "Pete Clark"]
 end

data/TODO.org

@@ -1,13 +1,13 @@
 * DONE Remove dependencies for easier packaging
-* TODO Port to termrec or ttyrec
+* DONE Port to termrec or ttyrec
   git clone http://angband.pl/git/termrec
   http://angband.pl/termrec.html
-* TODO Port Figlet from artii gem to ruby 1.9.2
-  and use it instead hardcoded headers and footers
-* TODO Think about terminal setup before shellcasting
+* DONE Think about terminal setup before shellcasting
 * TODO Take in account suggestions from playterm
   be sure to set your terminal width/height to 80x24 or 120x35
   to get rid of your prompt type 'export PS1="playterm $ "'
   if you want to turn off wordwrap in your terminal type: echo -e "\e[?7l\c"
   sometimes it helps to type 'export TERM=vt100' again before you start the real deal
   use CTRL-C to prevent commentary text (for instructing the user) being processed
+* TODO Port Figlet from artii gem to ruby 1.9.2
+  and use it instead hardcoded headers and footers

data/VERSION

@@ -1 +1 @@
-0.11.2
+0.11.3

data/bin/shelr

@@ -39,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'

data/features/recording.feature

@@ -0,0 +1,20 @@
+Feature: Recording shell
+
+  In order to impress the world
+  As a `shelr` user
+  I would like to record my terminal
+
+  Background:
+    Given shelr backend is script
+
+  Scenario: Basic recording
+    When I run `shelr record` interactively
+    And I type "test screencast"
+    And I type "ls"
+    # FIXME: wtf with nested processes?
+    And I type "exit"
+    Then the stdout should contain "Provide HUMAN NAME for Your record: "
+    And the stdout should contain "Press Ctrl+D or 'exit' to finish recording"
+    And the stdout should contain "Replay  : shelr play last"
+    And the stdout should contain "Publish : shelr push last"
+    And the stdout should contain "Your session started"

data/features/step_definitions/shelr_steps.rb

@@ -0,0 +1,38 @@
+When /^I do shelr (.*)$/ do |shelr_step|
+  begin
+    step(shelr_step)
+  rescue => e
+    @shelr_exception = e
+  end
+end
+
+# Useful for debugging timing problems
+When /^sleep (\d+)$/ do |time|
+  sleep time.to_i
+end
+
+Given /^shelr backend is (\w+)$/ do |backend|
+  step "I run `shelr backend #{backend}`"
+end
+
+When /^I set env variable "(\w+)" to "([^"]*)"$/ do |var, value|
+  ENV[var] = value
+end
+
+Then /^aruba should fail with "([^"]*)"$/ do |error_message|
+  @shelr_exception.message.should include(unescape(error_message))
+end
+
+Then /^the following step should fail with Spec::Expectations::ExpectationNotMetError:$/ do |multiline_step|
+  proc { steps multiline_step }.should raise_error(RSpec::Expectations::ExpectationNotMetError)
+end
+
+Then /^the output should be (\d+) bytes long$/ do |length|
+  all_output.chomp.length.should == length.to_i
+end
+
+When /^show me the output$/ do
+
+  require 'pp'
+  pp all_output
+end

data/features/support/env.rb

@@ -0,0 +1,12 @@
+ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+
+require "rubygems"
+require "bundler/setup"
+require 'aruba/cucumber'
+require File.expand_path(File.dirname(__FILE__) + '/../../spec/spec_helper.rb')
+
+# Aruba.configure do |config|
+#   config.before_cmd do |cmd|
+#     puts "About to run `#{cmd}`"
+#   end
+# end

data/lib/shelr/recorder.rb

@@ -33,7 +33,7 @@ module Shelr
       request_metadata
       puts HEADER
       puts "Your session started"
-      puts "Type Ctrl+D or exit to finish recording"
+      puts "Press Ctrl+D or 'exit' to finish recording"
       system(recorder_cmd)
       restore_terminal
       save_as_typescript if Shelr.backend == 'ttyrec'

data/lib/shelr.rb

@@ -3,12 +3,14 @@ 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'
-  BACKEND_CFG = File.join(CONFIG_DIR, 'backend')
+  APP_NAME       = 'shelr'
+  API_URL        = ENV['SHELR_LOCAL'] ? 'http://localhost:3000' : 'http://shelr.tv'
+  XDG_DATA_DIR   = ENV['XDG_DATA_HOME']   || File.join(ENV['HOME'], '.local', 'share')
+  XDG_CONFIG_DIR = ENV['XDG_CONFIG_HOME'] || File.join(ENV['HOME'], '.config')
+  DATA_DIR       = File.join(XDG_DATA_DIR,   APP_NAME)
+  CONFIG_DIR     = File.join(XDG_CONFIG_DIR, APP_NAME)
+  API_KEY_CFG    = File.join(CONFIG_DIR, 'api_key')
+  BACKEND_CFG    = File.join(CONFIG_DIR, 'backend')
 
   autoload :Recorder,  'shelr/recorder.rb'
   autoload :Player,    'shelr/player.rb'
@@ -17,13 +19,13 @@ module Shelr
 
   class << self
     def api_key
-      return false unless File.exist?(API_KEY)
-      @api_key ||= File.read(API_KEY).strip
+      return false unless File.exist?(API_KEY_CFG)
+      @api_key ||= File.read(API_KEY_CFG).strip
     end
 
     def api_key=(key)
       ensure_config_dir_exist
-      File.open(API_KEY, 'w+') { |f| f.puts(key.strip) }
+      File.open(API_KEY_CFG, 'w+') { |f| f.puts(key.strip) }
     end
 
     def backend
@@ -31,17 +33,21 @@ module Shelr
     end
 
     def backend=(bin)
+      unless ['script', 'ttyrec'].include?(bin)
+        puts "Backend should be either `script` or `ttyrec`"
+        exit 1
+      end
       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)
+      File.join(DATA_DIR, id)
     end
 
     def last_id
-      File.basename(Dir[File.join(Shelr::DATA_DIR, '*')].sort.last)
+      File.basename(Dir[File.join(DATA_DIR, '*')].sort.last)
     end
 
     private

data/spec/shelr/publisher_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Shelr::Publisher do
   describe "#publish(id)" do
-    it "should publish shellcast with oauth" do
+    it "should publish shellcast with API_KEY" do
       pending
     end
   end

data/spec/shelr/recorder_spec.rb

@@ -4,38 +4,17 @@ describe Shelr::Recorder do
 
   before(:each) do
     STDIN.stubs(:gets).returns('my shellcast')
+    Shelr.backend = 'script'
   end
 
   describe "#record!" do
-
     before(:each) do
       subject.stubs(:system).with(anything).returns(true)
     end
 
-    it "should set tty to 80x24" do
-      subject.expects("system").with(regexp_matches(/stty columns 80 rows 24/))
-      subject.record!
-    end
-
-    it "should restore tty to user defined values" do
-      subject.expects(:restore_terminal)
-      subject.record!
-    end
-
     it "should start script session" do
-      subject.expects("system").with(regexp_matches Regexp.compile("script -c 'bash'"))
+      subject.expects("system").with(regexp_matches Regexp.compile("script"))
       subject.record!
     end
   end
-
-  describe "#restore_terminal" do
-    it "should call tty with saved dimensions" do
-      subject.expects(:system).with(
-        all_of(regexp_matches(/stty/),
-               regexp_matches(/columns/),
-               regexp_matches(/rows/))
-      )
-      subject.send :restore_terminal
-    end
-  end
 end

data/spec/shelr_spec.rb

@@ -2,14 +2,14 @@ require 'spec_helper'
 
 describe Shelr do
   it "should have ::APP_NAME defined" do
-    Shelr::APP_NAME.should == 'shelr'
+    Shelr::APP_NAME.should_not be_nil
   end
 
   it "should provide XDG and APP_NAME based ::DATA_DIR" do
-    Shelr::DATA_DIR.should == File.join(XDG['DATA_HOME'].to_s, Shelr::APP_NAME)
+    Shelr::DATA_DIR.should == File.join(ENV['XDG_DATA_HOME'], Shelr::APP_NAME)
   end
 
   it "should provide XDG config path" do
-    Shelr::CONFIG_DIR.should == File.join(XDG['CONFIG_HOME'].to_s, Shelr::APP_NAME)
+    Shelr::CONFIG_DIR.should == File.join(ENV['XDG_CONFIG_HOME'], Shelr::APP_NAME)
   end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,24 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'fileutils'
+require 'pathname'
+require 'tmpdir'
+
+# XDG directories
+shelr_dir = File.join(Dir.tmpdir, 'shelr')
+FileUtils.mkdir_p(shelr_dir)
+
+TEMPDIR = Pathname.new Dir.mktmpdir('test', shelr_dir)
+XDG_DATA_DIR = TEMPDIR.join('.local', 'share')
+XDG_CONFIG_DIR = TEMPDIR.join('.config')
+
+FileUtils.mkdir_p(XDG_DATA_DIR)
+FileUtils.mkdir_p(XDG_CONFIG_DIR)
+
+ENV['XDG_DATA_HOME'] = XDG_DATA_DIR.to_s
+ENV['XDG_CONFIG_HOME'] = XDG_CONFIG_DIR.to_s
+
 require 'rspec'
 require 'shelr'
 require "rubygems"
@@ -9,6 +28,7 @@ require "bundler/setup"
 # in ./support/ and its subdirectories.
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
+
 RSpec.configure do |config|
   config.mock_with :mocha
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shelr
 version: !ruby/object:Gem::Version
-  version: 0.11.2
+  version: 0.11.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-27 00:00:00.000000000Z
+date: 2012-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &30598720 !ruby/object:Gem::Requirement
+  requirement: &25799440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *30598720
+  version_requirements: *25799440
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: &25797600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *25797600
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &30598240 !ruby/object:Gem::Requirement
+  requirement: &25796280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *30598240
+  version_requirements: *25796280
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &30597760 !ruby/object:Gem::Requirement
+  requirement: &25795080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *30597760
+  version_requirements: *25795080
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &30597280 !ruby/object:Gem::Requirement
+  requirement: &25793260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +66,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *30597280
+  version_requirements: *25793260
 - !ruby/object:Gem::Dependency
-  name: rcov
-  requirement: &30596780 !ruby/object:Gem::Requirement
+  name: simplecov
+  requirement: &25808000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,8 +77,8 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *30596780
-description: Screencast utility for unix shell junkies :)
+  version_requirements: *25808000
+description: Screencast utility for unix shell junkies
 email: self@antono.info
 executables:
 - shelr
@@ -78,6 +89,7 @@ extra_rdoc_files:
 files:
 - .document
 - .rspec
+- .rvmrc
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -86,6 +98,9 @@ files:
 - TODO.org
 - VERSION
 - bin/shelr
+- features/recording.feature
+- features/step_definitions/shelr_steps.rb
+- features/support/env.rb
 - lib/shelr.rb
 - lib/shelr/player.rb
 - lib/shelr/publisher.rb
@@ -113,7 +128,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3369964607201174593
+      hash: -1402734329441089779
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: