checkcheckit 0.1.2 → 0.1.3

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-19mode

data/Gemfile

@@ -4,7 +4,8 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
+  gem 'rake'
   gem 'fakefs'
   gem 'ruby-debug19'
-  gem 'vault-test-tools'
+  gem 'vault-test-tools', '~> 0.2.2'
 end

data/README.md

@@ -2,18 +2,39 @@
 
 use checklists, like a boss
 
+CheckCheckIt is a ruby library that exposes the command line program `check` and companion web service that makes the process of going through a checklist easy to sync across multiple people.
+
+Right now everything begins at the command line and a directory of checklists.
+
+A "checklist" is just a text file.
+Every line that starts with a dash '-' is a step.
+Everything beneath a step is that step's body or description.
+
 ## Installation
 
     $ gem install checkcheckit
 
-## TODO
+## Usage
 
-- resume a run
-  - locally
+    # list your checklists
+    $ check list
+    # Checklists
+    personal
+      groceries
+    work
+      deploy
 
-- post to campfire
+    # start a list at the command line and keep it there
+    $ check start deploy
+    |-------| Step 1: Pull everything from git
+      > git pull origin
+    Check: ^C
+    Goodbye!
 
-## Usage
+    # start a list, open it in your browser, and skip the CLI interaction
+    $ check start groceries --live --web --open
+    $ check start groceries --live --no-cli -O
+    Live at URL: http://checkcheckit.herokuapp.com/4f24b9d933d5467ec913461b8da3f952dbe724cb
 
 ### `list` the checklists
 
@@ -23,10 +44,6 @@ In that directory are folders for your organizations, groups, etc.
 
 In those folders are your checklists.
 
-A "checklist" is just a text file.
-Every line that starts with a dash '-' is a step.
-Everything beneath a step is that step's body or description.
-
     $ check list
     # Checklists
     heroku
@@ -73,18 +90,46 @@ For example:
 
 ### Live mode
 
-This is fun.  Specify an email (or a comma-separated list) on the command line and
-that address will receive a message with a link to a web version of the checklist.
+This is fun.
 
-Right now the cmd line client and web don't interact.  For now.
+`check start <listname> --live` will create an _interactive_ companion URL on the web.
 
-    $ check start deploy --email me@me.com,another.guy@gmail.com
-    |-------| Step 1: Pull everything from git
-      > git pull origin
+This URL is websockets-enabled and communicates with the command line.
+This means command line 'checks' get pushed to the web.  Once a list is on the web you can
+disconnect the command line and continue finishing it (with others).
+
+    $ check start deploy --live
+    Live at URL: http://checkcheckit.herokuapp.com/4f24b9d933d5467ec913461b8da3f952dbe724cb
+    Websocket refused connection - using POST
+    |........| Step 1: Make sure there are no uncommitted changes
+      > `git status`
+    Check:
 
-    You'll get an email with a link:
+    |+.......| Step 2: Pull everything from git
+      > `git pull`
+    Check: ^C
+    bye
 
-    http://checkcheckit.herokuapp.com/1
+During that console session the web UI would be interactively crossing items off the list:
+<img height="400px" src="http://f.cl.ly/items/1h3V0L1a1p1a062I2X3f/Screen%20Shot%202012-12-16%20at%209.37.56%20PM.png" />
+
+### Email
+Specify an email (or a comma-separated list) on the command line via the `--email` flag and
+the address(es) will receive an email with a link to a web version of the checklist.
+
+
+    $ check start deploy --email bob@work.com,steve@work.com
+    Live at URL: http://checkcheckit.herokuapp.com/4f24b9d933d5467ec913461b8da3f952dbe724cb
+    Websocket refused connection - using POST
+    |........| Step 1: Make sure there are no uncommitted changes
+      > `git status`
+    Check: ^C
+    bye
+
+## TODO
+
+- resume a run locally from URL
+- post to campfire
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,4 @@
 require "bundler/gem_tasks"
+require 'vault-test-tools/rake_task'
+
+task(default: :test)

data/lib/checkcheckit/console.rb

@@ -1,6 +1,7 @@
 require 'ostruct'
 require 'uri'
 
+# Uses the "big bowl of pudding' architecture
 class CheckCheckIt::Console
   attr_accessor :list_dir
   attr_accessor :out_stream, :in_stream, :web_socket
@@ -51,6 +52,8 @@ class CheckCheckIt::Console
           Process.detach fork{ exec("open #{url}") }
         end
 
+        return if @options['no-cli'] || @options['web-only']
+
         begin
           @client = web_socket.connect(web_service_url, sync: true) do
             after_start { emit('register', {list_id: list_id}) }
@@ -61,7 +64,6 @@ class CheckCheckIt::Console
         end
       end
 
-      return if @options['no-cli'] || @options['web']
       step_through_list(list)
     else
       puts "Could not find checklist via: #{target}"

data/lib/checkcheckit/version.rb

@@ -1,3 +1,3 @@
 module CheckCheckIt
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: checkcheckit
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -84,6 +84,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -114,7 +115,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2207512465125543391
+      hash: -36693563050523198
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -123,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2207512465125543391
+      hash: -36693563050523198
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23