shellplay 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a990510c54011a42c073d7b5c2455480e2d124d1
-  data.tar.gz: 663418918a9eed30b279545a2fccc317c28b3194
+  metadata.gz: 1a755f6552006186547d635756ba577cb2fadec3
+  data.tar.gz: bc83ab0769908a487e6750361c980116f65ce2dc
 SHA512:
-  metadata.gz: 7e79caf702fdb83c988bb0e24bb54b4cebbadad9e20bbd88caac00569df28a1285aa4733b7c84e1ea8feb6af530c0abde75df773c1523ac6347b0eb364d73dd1
-  data.tar.gz: cc2f77de04fe717ba488e7fcb01f96d7d84a53b208453b792a2e646644b66b382c1955f8d9a68ba11c46ab10abdd9d006f68de1ef2e3fb822beba7c004fdc72d
+  metadata.gz: e8dd6658f4a887d91164a6664368dd73df83d12a6734faebf51e7e158c629ffa208ac8f8bb935c1d7daefb103a3813a5e7d585f43c6abd3673f591efc0415d98
+  data.tar.gz: bedada485c7bf906584fe67c201c43c7b67aeb58d5ec7c01a68ad95b7552effe79203b10a1732a95f54a85f98efb67ba0bb3691e4662eeb4f1918cf85258bc31

data/.ruby-version

@@ -1 +1 @@
-2.1.2
+2.2.3

data/.travis.yml

@@ -3,4 +3,4 @@ bundler_args: --path vendor
 cache: bundler
 rvm:
   - 1.9.3
-  - 2.1.1
+  - 2.2.3

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 Shellplay Changelog
 =========================
 
+v0.1.7 - 2015-11-23
+-------------------
+- create config dir if it does not exist (first time launch)
+- add more code documentation
+- update dependencies
+
 v0.1.6 - 2014-08-19
 -------------------
 - fix display of session prompt

data/README.md

@@ -7,7 +7,7 @@ Shellplay
 [![Coverage Status](https://img.shields.io/coveralls/mose/shellplay.svg)](https://coveralls.io/r/mose/shellplay?branch=master)
 [![Dependency Status](https://img.shields.io/gemnasium/mose/shellplay.svg)](https://gemnasium.com/mose/shellplay)
 [![Code Climate](https://img.shields.io/codeclimate/github/mose/shellplay.svg)](https://codeclimate.com/github/mose/shellplay)
-
+[![Inch CI](https://inch-ci.org/github/mose/shellplay.svg)](https://inch-ci.org/github/mose/shellplay)
 ----
 
 This is a CLI tool for recording and presenting step by step operations from the console. It is targeted at presentations that would simulate live coding, without the random murphy factor of it.
@@ -22,6 +22,16 @@ It can record a session and playback from it, so if internet fails in your confe
 
 The first time you run it, some configuration variables will be asked, and stored in `$HOME/.shellplay/config.yml`. All the recorded sessions will be stored in that same directory.
 
+### Development install
+
+    git clone git@github.com:mose/shellplay.git
+    cd shellplay
+    bundle install --path vendor
+
+To launch shellrecord or shellplay from local repo:
+
+    bundle exec ./bin/shellrecord
+
 ## Recording a session
 
 For recording a session

data/bin/shellplay

@@ -30,6 +30,8 @@ def usage
   puts
 end
 
+# generic display method
+# 
 def display(screen)
   if screen.clearscreen
     if ENV['TERM_PROGRAM'] = 'iTerm.app'
@@ -59,6 +61,7 @@ def display(screen)
   end
 end
 
+# move to the next screen
 def shownext
   if @session.current_screen and @session.current_screen.stdin
     display @session.current_screen
@@ -70,6 +73,7 @@ def shownext
   end
 end
 
+# move to the previous screen
 def showprevious
   if @session.pointer > 0
     @session.previous
@@ -81,6 +85,7 @@ def showprevious
   end
 end
 
+# jump to an arbitrary screen
 def show(index)
   if @session.show(index) && @session.show(index).stdin
     display @session.show(index)
@@ -93,6 +98,7 @@ end
 
 print "\n\e[33m>\e[0m Type <enter> to begin."
 
+# main loop
 while continue do
   command = STDIN.gets.strip
   case command

data/lib/shellplay/config.rb

@@ -2,6 +2,8 @@ require 'cliprompt'
 require 'configstruct'
 require 'fileutils'
 
+# config struct class
+# refer to https://github.com/mose/configstruct for documentation
 module Shellplay
   class Config < ConfigStruct
 
@@ -11,12 +13,16 @@ module Shellplay
       super(options, input = STDIN, output = STDOUT, true)
     end
 
+    # override default config values
     def set_defaults
       default :basedir, File.join(ENV['HOME'], '.shellplay')
       default :basefile, File.join(self.basedir, 'config.yml')
       super
     end
 
+    # interactive configuration creation process
+    # uses cliprompt for console interaction
+    # refer to https://github.com/mose/cliprompt for documentation
     def setup
       unless self.prompt && self.timeformat
         values = {}

data/lib/shellplay/screen.rb

@@ -1,3 +1,4 @@
+# class for the screen object
 module Shellplay
   class Screen
 
@@ -14,6 +15,7 @@ module Shellplay
       @timespent = 0
     end
 
+    # transforms a hash into a screen object
     def import(hash)
       @displaycommand = !!hash['displaycommand']
       @playprompt = !!hash['playprompt']
@@ -25,6 +27,7 @@ module Shellplay
       @timespent = hash['timespent']
     end
 
+    # transfroms a screen object into a hash
     def export
       {
         displaycommand: @displaycommand,

data/lib/shellplay/session.rb

@@ -5,6 +5,7 @@ require "open-uri"
 require "shellplay/config"
 require "shellplay/screen"
 
+# session class, controlling the interaction during the presentation
 module Shellplay
   class Session
 
@@ -20,11 +21,13 @@ module Shellplay
       @timeformat = false
       @pointer = 0
       @basedir = basedir || File.join(ENV['HOME'], '.shellplay')
+      FileUtils.mkdir_p(@basedir) unless Dir.exist? @basedir
       @basefile = basefile || 'config.yml'
       @input = input
       @output = output
     end
 
+    # import a json file from local drive or http location
     def import(name)
       unless name
         sessions = Dir.glob(File.join(@basedir, '*.json'))
@@ -58,38 +61,46 @@ module Shellplay
       end
     end
 
+    # appends a screen to the main sequence
     def add_screen(screenhash)
       s = Shellplay::Screen.new
       s.import(screenhash)
       @sequence << s
     end
 
+    # appends an array of screens to the sequence
     def add_screens(screenarray)
       @sequence += screenarray
     end
 
+    # used for cancelling a screen while recording
     def drop_last_screen
       @sequence.pop
       previous
     end
 
+    # jump to next screen
     def next
       @pointer += 1
     end
 
+    # jump to previous screen
     def previous
       @pointer -= 1
     end
 
+    # jump to an arbitrary screen
     def show(index)
       @pointer = index.to_i
       current_screen
     end
 
+    # returns the screen object at the current point in the sequence
     def current_screen
       @sequence[@pointer]
     end
 
+    # saves the json file for the sequence
     def save
       prepare
       h = {}
@@ -101,6 +112,7 @@ module Shellplay
       end
     end
 
+    # initialize the sequence meta-data
     def prepare
       set_title
       set_name
@@ -108,10 +120,13 @@ module Shellplay
 
   private
 
+    # uses cliprompt to ask for a title if not set already
     def set_title
       @title ||= ask("What is the title of this session?", "No Title")
     end
 
+    # uses cliprompt to ask for a name if not set already
+    # name is the name of the file on the disk
     def set_name
       @name ||= ask("What is the name of the session file?", "untitled")
     end

data/lib/shellplay.rb

@@ -1,4 +1 @@
 require 'shellplay/session'
-
-module Shellplay
-end

data/shellplay.gemspec

@@ -18,13 +18,14 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^spec/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'paint'
-  spec.add_dependency 'cliprompt'
-  spec.add_dependency 'configstruct', "~> 0.0.4"
-  spec.add_dependency 'shell2html'
+  spec.add_dependency 'paint', '~> 1.0.0'
+  spec.add_dependency 'cliprompt', '~> 0.1.2'
+  spec.add_dependency 'configstruct', '~> 0.1.0'
+  spec.add_dependency 'shell2html', '~> 0.0.5'
 
-  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "bundler", '~> 1.6'
   spec.add_development_dependency "rake"
-  spec.add_development_dependency 'rspec', "~> 3.0"
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'coveralls'
 end

data/spec/lib/shellplay/session_spec.rb

@@ -26,7 +26,7 @@ describe Shellplay::Session, "A shellplay session" do
 
     context "when we import an invalid file, " do
       it "should break and throw exception" do
-        expect { subject.import('/file/notfound') }.to raise_error
+        expect { subject.import('/file/notfound') }.to raise_error(Errno::ENOENT)
       end
     end
 

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: shellplay
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - mose
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-19 00:00:00.000000000 Z
+date: 2015-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paint
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: cliprompt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: configstruct
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 0.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: shell2html
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.5
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -181,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: CLI tool for shell-based presentations.