checkcheckit 0.0.1 → 0.0.2

data/.gitignore

@@ -15,3 +15,6 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+bin/minitar
+bin/rdebug
+bin/turn

data/README.md

@@ -8,15 +8,17 @@ use checklists, like a boss
 
 ## TODO
 
-- option parsing
 - save a run
   - to file
   - to service
 - resume a run
-- run commands with confirmation
+- run to campfire
+- commands with confirmation
   - saves results
-- `pull` list(s) (via git)
-- `push` list(s) (via git)
+- run on phone
+  - kick off from cmd line
+    - send email to self
+    - click on url in email in phone
 
 ## Usage
 
@@ -45,13 +47,12 @@ Everything beneath a step is that step's body or description.
 
 You can go through a checklist by running `check start ` and then the checklist name.
 
-(NIY - Not Implemented Yet)
 If there are multiple checklists with the same name use the format `folder/checklist`.
 
-When you iterate through a checklist you can just type "enter", "y", or "+" to confirm a step.
+When you iterate through a checklist you can just type "enter", "y", or "+" to confirm a step and "no" or "-" to
+fail one.
 
-A "no", "-", or body of text (body of text NIY) is considered a failed step.
-The body of text is for describing what went wrong.
+You can always enter optional notes.
 
 For example:
 
@@ -59,19 +60,23 @@ For example:
     |-------| Step 1: Pull everything from git
       > git pull origin
     Check: <enter>
+    Notes: <enter>
 
     |+------| Step 2: Make sure there are no uncommitted changes
       > `git status`
     Check: <n>
+    Notes: <enter>
 
     |+------| 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>
 
     |+-+----| Step 4: Run the test suite
     Check: failures!
+    Notes: <enter>
 
 
 

data/bin/check

@@ -2,6 +2,4 @@
 
 require 'checkcheckit'
 
-args = ARGV.dup
-
-CheckCheckIt::Console.new.run! args
+CheckCheckIt::Console.new.run! ARGV

data/checkcheckit.gemspec

@@ -16,4 +16,6 @@ Gem::Specification.new do |gem|
   gem.executables   = 'check'
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
+
+  gem.add_dependency 'lucy-goosey', '~> 0.2.0'
 end

data/lib/checkcheckit/console.rb

@@ -2,25 +2,25 @@ require 'ostruct'
 
 class CheckCheckIt::Console
   attr_accessor :list_dir
-  attr_accessor :stream, :in_stream
+  attr_accessor :out_stream, :in_stream
 
   def initialize(opts = {})
-    ARGV.clear
-    default_dir = opts.fetch(:dir, '~/checkcheckit')
-    @list_dir = File.expand_path(default_dir)
-    @stream    = opts[:out_stream] || STDOUT
-    @in_stream = opts[:in_stream] || STDIN
+    @out_stream = opts[:out_stream] || $stdout
+    @in_stream  = opts[:in_stream]  || $stdin
   end
 
   def puts(text = '')
-    @stream.puts text
+    @out_stream.puts text
   end
 
   def print(text = '')
-    @stream.print text
+    @out_stream.print text
   end
 
-  def run!(args)
+  def run!(args = [])
+    @options  = Lucy::Goosey.parse_options(args)
+    @list_dir = File.expand_path(@options.fetch('home', '~/checkcheckit'))
+
     if args.length == 0
       puts "No command given"
     else
@@ -43,16 +43,38 @@ class CheckCheckIt::Console
     list.steps.each_with_index do |step, i|
       puts "#{fmt_results(results)} Step #{i+1}: #{step.name}"
       puts step.body unless step.body.empty?
-      print "Check: "
 
-      case input = in_stream.gets
-      when /^[y|+]$/ || ''
-        results[i] = true
-      when /^[n|-]$/
-        results[i] = false
-      else
-        results[i] = false
+      check, notes = nil
+      begin
+        print "Check: "
+        case input = in_stream.gets
+        when /^[y|+]$/ || ''
+          check = true
+        when /^[n|-]$/
+          check = false
+        else
+          check = true
+        end
+
+        if @options['notes'] || @options['n']
+          print "Notes: "
+          notes = in_stream.gets
+        end
+      rescue Interrupt => e
+        puts "\nGoodbye!"
+        exit 1
       end
+
+      results[i] = {
+        step: i + 1,
+        name: step.name,
+        body: step.body,
+        check: check,
+        result: check ? 'CHECK' : 'FAIL',
+        status: check ? 1 : 0,
+        notes: notes
+      }
+
       puts
     end
 
@@ -64,22 +86,12 @@ class CheckCheckIt::Console
   def save_results(list,results)
     report = {
       'list-name' => list.name,
-      'results' => []
+      'results' => results
     }
-    list.steps.each_with_index do |step, i|
-      report['results'] << {
-        index: i,
-        name: step.name,
-        body: step.body,
-        result: results[i] ? 'CHECK' : 'FAIL',
-        status: results[i] ? 1 : 0,
-      }
-    end
-    report
   end
 
   def start(args)
-    target = args.join(' ')
+    target = args.first
     hit = Dir[dir + '/*/*'].find{ |fname| fname.include? target }
     if hit
       step_through_list(List.new(hit))
@@ -101,6 +113,13 @@ class CheckCheckIt::Console
 
   private
   def fmt_results(results)
-    "|#{results.map { |r| r ? '+' : '-' }.join}|"
+    keys = results.map do |result|
+      if result
+        result[:check] ? '+' : '-'
+      else
+        '.'
+      end
+    end
+    "|#{keys.join}|"
   end
 end

data/lib/checkcheckit/version.rb

@@ -1,3 +1,3 @@
 module CheckCheckIt
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/checkcheckit.rb

@@ -1,3 +1,4 @@
+require 'lucy-goosey'
 require "checkcheckit/version"
 
 module CheckCheckIt

data/test/console_test.rb

@@ -17,10 +17,46 @@ class ConsoleTest < CheckCheckIt::TestCase
     dir = File.join('/foo', 'personal')
     FileUtils.mkdir_p(dir)
 
-    @console = CheckCheckIt::Console.new(:dir => '/foo', out_stream: StringIO.new)
-
-    check "list"
+    check "list --home /foo"
     assert_match(/^personal\n/,     output)
   end
-end
 
+
+  def test_default_no_notes
+    console.in_stream = MiniTest::Mock.new
+    console.out_stream = MiniTest::Mock.new
+
+    9.times do
+      console.out_stream.expect :puts, true, [String]
+    end
+    3.times do
+      console.out_stream.expect :print, true, ["Check: "]
+    end
+    console.in_stream.expect :gets, "n"
+    console.in_stream.expect :gets, "y"
+    console.in_stream.expect :gets, "n"
+    result = check "start groceries"
+  end
+
+  def test_includes_notes
+    console.in_stream  = MiniTest::Mock.new
+    console.out_stream = MiniTest::Mock.new
+
+    9.times do
+      console.out_stream.expect :puts, true, [String]
+    end
+    3.times do
+      console.out_stream.expect :print, true, ["Check: "]
+      console.out_stream.expect :print, true, ["Notes: "]
+    end
+    console.in_stream.expect :gets, "n"
+    console.in_stream.expect :gets, "Shit's fucked"
+    console.in_stream.expect :gets, "y"
+    console.in_stream.expect :gets, ""
+    console.in_stream.expect :gets, "n"
+    console.in_stream.expect :gets, "Really, bad"
+    check "start groceries --notes"
+    console.in_stream.verify
+    console.out_stream.verify
+  end
+end

data/test/helper.rb

@@ -30,7 +30,7 @@ module ConsoleTestHelpers
   #
   #   # check 'start deploy'
   def check(cmd_string)
-    console.run! cmd_string.split
+    console.run! cmd_string.split(' ')
   end
 
   def reset_console
@@ -43,11 +43,11 @@ module ConsoleTestHelpers
   end
 
   def output
-    console.stream.string
+    console.out_stream.string
   end
 
   def home
-    console.list_dir
+    console.list_dir || '~/checkcheckit'
   end
 
 end

data/test/{results_test.rb → resume_test.rb}

@@ -1,18 +1,29 @@
 require 'helper'
 
-describe 'Storing Results after a run' do
+describe 'Resuming a checklist' do
   def setup
     super
     Examples.create_grocery_list(home)
   end
 
+  #TODO: verify though the console
+
   it "should record the pass/fail of each step" do
     console.in_stream = MiniTest::Mock.new
+    console.out_stream = MiniTest::Mock.new
+
+    9.times do
+      console.out_stream.expect :puts, true, [String]
+    end
+    3.times do
+      console.out_stream.expect :print, true, ["Check: "]
+    end
     console.in_stream.expect :gets, "n"
     console.in_stream.expect :gets, "y"
     console.in_stream.expect :gets, "n"
     result = check "start groceries"
     console.in_stream.verify
+    console.out_stream.verify
     result["results"][0][:result].must_equal "FAIL"
     result["results"][0][:status].must_equal 0
     result["results"][1][:result].must_equal "CHECK"
@@ -23,7 +34,7 @@ describe 'Storing Results after a run' do
 
   it "should record the name of each step" do
     console.in_stream = MiniTest::Mock.new
-    3.times { console.in_stream.expect :gets, "y" }
+    6.times { console.in_stream.expect :gets, "y" }
     result = check "start groceries"
     console.in_stream.verify
     result["results"][0][:name].must_equal "pineapple"
@@ -33,7 +44,7 @@ describe 'Storing Results after a run' do
 
   it "should record the body of each step" do
     console.in_stream = MiniTest::Mock.new
-    3.times { console.in_stream.expect :gets, "y" }
+    6.times { console.in_stream.expect :gets, "y" }
     result = check "start groceries"
     console.in_stream.verify
 =begin
@@ -44,3 +55,4 @@ describe 'Storing Results after a run' do
   end
 end
 
+

data/test/start_test.rb

@@ -8,7 +8,7 @@ class StartTest < CheckCheckIt::TestCase
 
   def test_list_parses_steps
     console.in_stream = MiniTest::Mock.new
-    3.times { console.in_stream.expect :gets, "y" }
+    6.times { console.in_stream.expect :gets, "y" }
     result = check "start groceries"
     console.in_stream.verify
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: checkcheckit
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-12 00:00:00.000000000 Z
-dependencies: []
+date: 2012-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lucy-goosey
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 description: Checklists like a boss
 email:
 - christopher.continanza@gmail.com
@@ -34,7 +50,7 @@ files:
 - test/console_test.rb
 - test/helper.rb
 - test/list_test.rb
-- test/results_test.rb
+- test/resume_test.rb
 - test/start_test.rb
 homepage: ''
 licenses: []
@@ -50,7 +66,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3522511683697989869
+      hash: -328919571766986196
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -59,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3522511683697989869
+      hash: -328919571766986196
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -70,5 +86,5 @@ test_files:
 - test/console_test.rb
 - test/helper.rb
 - test/list_test.rb
-- test/results_test.rb
+- test/resume_test.rb
 - test/start_test.rb