checkcheckit 0.3.0 → 0.3.1

data/README.md

@@ -16,14 +16,6 @@ Everything beneath a step is that step's body or description.
 
 ## Usage
 
-    # list your checklists
-    $ check list
-    # Checklists
-    personal
-      groceries
-    work
-      deploy
-
     # it's all text
     $ cat ~/checkcheckit/personal/groceries.md
     - bacon
@@ -33,7 +25,7 @@ Everything beneath a step is that step's body or description.
     - avocados
 
     # start a list at the command line and keep it there
-    $ check start groceries
+    $ check start ~/checkcheckit/personal/groceries.md
     |.......| Step 1: bacon
     Check: <enter>
 
@@ -46,57 +38,47 @@ Everything beneath a step is that step's body or description.
     $ check start groceries --live --no-cli -O
     Live at URL: http://checkcheckit.herokuapp.com/4f24b9d933d5467ec913461b8da3f952dbe724cb
 
-### `list` the checklists
-
-`checkcheckit` assumes a home directory of ~/checkcheckit
+    # Use it with any text file
+    $ check start /Users/csquared/checkcheckit/groceries.md
 
-In that directory are folders for your organizations, groups, etc.
-
-In those folders are your checklists.
+    # When files are in `~/checkcheckit`
 
+    # list your checklists
     $ check list
     # Checklists
-    heroku
-      todo
     personal
-      todo
-    vault
+      groceries
+    work
       deploy
 
-### `start` a checklist
+    # Start with shortcut names
+    $ check start groceries
 
-You can go through a checklist by running `check start ` and then the checklist name.
+    # Run commands from the checklist
+    $ cat ./hello.txt
+    - say hello
+        `echo hello`
 
-If there are multiple checklists with the same name use the format `folder/checklist`.
+    $ check start ./hello.txt
+    |.| Step 1: say hello
+        `echo hello`
 
-When you iterate through a checklist you can just type "enter", "y", or "+" to confirm a step and "no" or "-" to
-fail one.
-
-You can use the `--notes` flag to enter optional notes.
+    Run command `echo hello`?
+    <enter>,y,n:
+    running `echo hello`
+    hello
+    Check:
 
-For example:
+    |+| Done
 
-    $ check start deploy --notes
-    |.......| Step 1: Pull everything from git
-      > git pull origin
-    Check: <enter>
-    Notes: <enter>
+### `start` a checklist
 
-    |+......| Step 2: Make sure there are no uncommitted changes
-      > `git status`
-    Check: <n>
-    Notes: <enter>
+You can go through a checklist by running `check start ` and then the checklist name.
 
-    |+-.....| Step 3: Diff master with heroku/master
-      Make sure the change you want to push are what you're pushing
-      > git fetch heroku
-      > git diff heroku/master | $EDITOR
-    Check: <y>
-    Notes: <enter>
+If there are multiple checklists with the same name use the format `folder/checklist`.
 
-    |+-+....| Step 4: Run the test suite
-    Check: failures!
-    Notes: <enter>
+When you iterate through a checklist you can just type "enter", "y", or "+" to confirm a step and "no" or "-" to
+fail one.
 
 ### `--live` mode
 
@@ -123,7 +105,38 @@ disconnect the command line and continue finishing it (with others).
 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
+### shell out to commands
+
+This is useful.
+
+`check` will recognize any text that is surrouned with backticks: \`command with args\` as a command to potentially run.
+It will prompt you if you'd like it to run the command.  You will then have the option to check it off.
+
+For example:
+
+    $ cat ./hello.txt
+    - say hello
+        `echo hello`
+
+    $ check start ./hello.txt
+    |.| Step 1: say hello
+        `echo hello`
+
+    Run command `echo hello`?
+    <enter>,y,n:
+    running `echo hello`
+    hello
+    Check:
+
+    |+| Done
+
+
+
+#### `--open/-O`
+
+`check start <listname> --live -O/--open` will open the url in your browser by shelling out to `open`
+
+#### `--email <address(es)>`
 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.
 
@@ -136,6 +149,27 @@ the address(es) will receive an email with a link to a web version of the checkl
     Check: ^C
     bye
 
+### `list` the checklists
+
+`checkcheckit` works with a normal filename.
+
+However, it also assumes a home directory of ~/checkcheckit
+
+In that directory are folders for your organizations, groups, etc so you can start
+them by name.
+
+In those folders are your checklists.
+
+    $ check list
+    # Checklists
+    heroku
+      todo
+    personal
+      todo
+    vault
+      deploy
+
+
 ## TODO
 
 - resume a run locally from URL

data/examples/hello.txt

@@ -0,0 +1,2 @@
+- say hello
+  `echo hello`

data/lib/checkcheckit/console.rb

@@ -116,7 +116,7 @@ class CheckCheckIt::Console
           puts input.inspect if debug?
           case input
           when /^(y|)$/
-            puts  "running `#{command}`"
+            puts  "running..."
             system(command)
           else
             puts "skipping"

data/lib/checkcheckit/version.rb

@@ -1,3 +1,3 @@
 module CheckCheckIt
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/test/console_test.rb

@@ -55,7 +55,7 @@ class ConsoleTest < CheckCheckIt::TestCase
     console.out_stream.expect :puts, true, ["\nRun command `git pull`?"]
     console.out_stream.expect :print, true, ["<enter>,y,n: "]
     console.in_stream.expect  :gets, ""
-    console.out_stream.expect :puts, true, ["running `git pull`"]
+    console.out_stream.expect :puts, true, ["running..."]
     mock(console).system("git pull") { true }
     console.out_stream.expect :print, true, ["Check: "]
     console.in_stream.expect  :gets, ""

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: checkcheckit
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-12 00:00:00.000000000 Z
+date: 2013-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lucy-goosey
@@ -92,6 +92,7 @@ files:
 - bin/check
 - bin/t
 - checkcheckit.gemspec
+- examples/hello.txt
 - lib/checkcheckit.rb
 - lib/checkcheckit/console.rb
 - lib/checkcheckit/list.rb
@@ -116,7 +117,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1655738984959365236
+      hash: 3147570249937767500
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -125,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1655738984959365236
+      hash: 3147570249937767500
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23