checkcheckit 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in checkcheckit.gemspec
+gemspec
+
+group :test do
+  gem 'minitest'
+  gem 'fakefs'
+  gem 'ruby-debug19'
+  gem 'turn'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Chris Continanza
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,84 @@
+# Check, Check, It
+
+use checklists, like a boss
+
+## Installation
+
+    $ gem install checkcheckit
+
+## TODO
+
+- option parsing
+- save a run
+  - to file
+  - to service
+- resume a run
+- run commands with confirmation
+  - saves results
+- `pull` list(s) (via git)
+- `push` list(s) (via git)
+
+## Usage
+
+### `list` the checklists
+
+`checkcheckit` assumes a home directory of ~/checkcheckit
+
+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
+      todo
+    personal
+      todo
+    vault
+      deploy
+
+### `start` a checklist
+
+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.
+
+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.
+
+For example:
+
+    $ check start deploy
+    |-------| Step 1: Pull everything from git
+      > git pull origin
+    Check: <enter>
+
+    |+------| Step 2: Make sure there are no uncommitted changes
+      > `git status`
+    Check: <n>
+
+    |+------| 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>
+
+    |+-+----| Step 4: Run the test suite
+    Check: failures!
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/check

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'checkcheckit'
+
+args = ARGV.dup
+
+CheckCheckIt::Console.new.run! args

data/bin/t

@@ -0,0 +1 @@
+bundle exec turn -Itest test/*_test.rb

data/checkcheckit.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'checkcheckit/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "checkcheckit"
+  gem.version       = CheckCheckIt::VERSION
+  gem.authors       = ["Chris Continanza"]
+  gem.email         = ["christopher.continanza@gmail.com"]
+  gem.description   = %q{Checklists like a boss}
+  gem.summary       = %q{Command line tool for using checklists}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = 'check'
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/checkcheckit/console.rb

@@ -0,0 +1,106 @@
+require 'ostruct'
+
+class CheckCheckIt::Console
+  attr_accessor :list_dir
+  attr_accessor :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
+  end
+
+  def puts(text = '')
+    @stream.puts text
+  end
+
+  def print(text = '')
+    @stream.print text
+  end
+
+  def run!(args)
+    if args.length == 0
+      puts "No command given"
+    else
+      method = args.shift
+      if respond_to? method
+        send method, args
+      else
+        puts "did not understand: #{method}"
+      end
+    end
+  end
+
+  def dir
+    File.expand_path(@list_dir)
+  end
+
+  def step_through_list(list)
+    results = Array.new(list.steps.length, false)
+
+    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
+      end
+      puts
+    end
+
+    msg = results.all? { |r| r } ? "Done" : "Issues"
+    puts "#{fmt_results(results)} #{msg}"
+    save_results(list, results)
+  end
+
+  def save_results(list,results)
+    report = {
+      'list-name' => list.name,
+      '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(' ')
+    hit = Dir[dir + '/*/*'].find{ |fname| fname.include? target }
+    if hit
+      step_through_list(List.new(hit))
+    else
+      puts "Could not find checklist via: #{target}"
+    end
+  end
+
+  def list(args)
+    puts "# Checklists\n"
+    Dir[dir + '/*'].each do |dir|
+      team = File.basename dir
+      puts team
+      Dir[dir + '/*'].each do |file|
+        puts "  " + List.new(file).name
+      end
+    end
+  end
+
+  private
+  def fmt_results(results)
+    "|#{results.map { |r| r ? '+' : '-' }.join}|"
+  end
+end

data/lib/checkcheckit/list.rb

@@ -0,0 +1,37 @@
+class List
+  attr_accessor :name, :body, :steps
+
+  def initialize(file)
+    fname = File.basename(file)
+    @name = fname.sub(File.extname(fname), '')
+    @body = File.read(file)
+    @steps = parse_steps(@body)
+  end
+
+  private
+
+  def parse_steps(body)
+    steps = []
+    current_step = nil
+    body.lines.each do |line|
+      next if line.strip.empty?
+      if line =~ /^-/
+        current_name = line.sub(/^-/,'').strip
+        current_step = Step.new(current_name)
+        steps << current_step
+      elsif current_step
+        current_step.body << line
+      end
+    end
+    steps
+  end
+
+  class Step
+    attr_accessor :name, :body
+
+    def initialize(name, body = '')
+      @name = name
+      @body = body
+    end
+  end
+end

data/lib/checkcheckit/version.rb

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

data/lib/checkcheckit.rb

@@ -0,0 +1,7 @@
+require "checkcheckit/version"
+
+module CheckCheckIt
+end
+
+require "checkcheckit/console"
+require 'checkcheckit/list'

data/test/console_test.rb

@@ -0,0 +1,26 @@
+require 'helper'
+
+class ConsoleTest < CheckCheckIt::TestCase
+  def setup
+    super
+  end
+
+  def test_lists_orgs_and_lists
+    Examples.create_grocery_list(home)
+    check "list"
+    assert_match(/^# Checklists\n/, output)
+    assert_match(/^personal\n/,     output)
+    assert_match(/^  groceries\n/,  output)
+  end
+
+  def test_configurable_list_dir
+    dir = File.join('/foo', 'personal')
+    FileUtils.mkdir_p(dir)
+
+    @console = CheckCheckIt::Console.new(:dir => '/foo', out_stream: StringIO.new)
+
+    check "list"
+    assert_match(/^personal\n/,     output)
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,72 @@
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), '../lib')))
+ENV['RACK_ENV'] = 'test'
+
+require 'minitest/unit'
+require 'minitest/spec'
+require 'minitest/mock'
+require 'fakefs'
+require 'checkcheckit'
+
+module Examples
+  def self.create_grocery_list(home)
+    dir = File.join(home, 'personal')
+    FileUtils.mkdir_p(dir)
+    File.open(File.join(dir, 'groceries'), 'w') do |file|
+      file << "- pineapple "
+      file << "\n- mangoes \n enhance the flavor with \n spice "
+      file << "\n- fudge \n best from a place in sutter creek"
+    end
+  end
+end
+
+module ConsoleTestHelpers
+  # Internal: Runs command lines in tests like their command line invocation.
+  #
+  # Examples:
+  #
+  #   # check 'list'
+  #
+  #   # check 'list deploy'
+  #
+  #   # check 'start deploy'
+  def check(cmd_string)
+    console.run! cmd_string.split
+  end
+
+  def reset_console
+    ## Clear out the output
+    @console = nil
+  end
+
+  def console
+    @console ||= CheckCheckIt::Console.new(out_stream: StringIO.new)
+  end
+
+  def output
+    console.stream.string
+  end
+
+  def home
+    console.list_dir
+  end
+
+end
+
+class CheckCheckIt::TestCase < MiniTest::Unit::TestCase
+  include ConsoleTestHelpers
+
+  def setup
+    super
+    reset_console
+  end
+end
+
+class CheckCheckIt::Spec < MiniTest::Spec
+  include ConsoleTestHelpers
+
+  before do
+    reset_console
+  end
+end
+
+MiniTest::Spec.register_spec_type //, CheckCheckIt::Spec

data/test/list_test.rb

@@ -0,0 +1,17 @@
+require 'helper'
+
+class ListTest < CheckCheckIt::TestCase
+
+  def setup
+    Examples.create_grocery_list(home)
+    @list = List.new('~/checkcheckit/personal/groceries')
+  end
+
+  def test_list_parses_steps
+    @list.steps.size.must_equal 3
+  end
+
+  def test_list_parses_commands
+  end
+
+end

data/test/results_test.rb

@@ -0,0 +1,46 @@
+require 'helper'
+
+describe 'Storing Results after a run' do
+  def setup
+    super
+    Examples.create_grocery_list(home)
+  end
+
+  it "should record the pass/fail of each step" do
+    console.in_stream = MiniTest::Mock.new
+    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
+    result["results"][0][:result].must_equal "FAIL"
+    result["results"][0][:status].must_equal 0
+    result["results"][1][:result].must_equal "CHECK"
+    result["results"][1][:status].must_equal 1
+    result["results"][2][:result].must_equal "FAIL"
+    result["results"][2][:status].must_equal 0
+  end
+
+  it "should record the name of each step" do
+    console.in_stream = MiniTest::Mock.new
+    3.times { console.in_stream.expect :gets, "y" }
+    result = check "start groceries"
+    console.in_stream.verify
+    result["results"][0][:name].must_equal "pineapple"
+    result["results"][1][:name].must_equal "mangoes"
+    result["results"][2][:name].must_equal "fudge"
+  end
+
+  it "should record the body of each step" do
+    console.in_stream = MiniTest::Mock.new
+    3.times { console.in_stream.expect :gets, "y" }
+    result = check "start groceries"
+    console.in_stream.verify
+=begin
+    result["results"][0][:body].must_equal ""
+    result["results"][1][:name].must_equal "enhance the flavor with \n spice"
+    result["results"][2][:name].must_equal "best from a place in sutter creek"
+=end
+  end
+end
+

data/test/start_test.rb

@@ -0,0 +1,20 @@
+require 'helper'
+
+class StartTest < CheckCheckIt::TestCase
+
+  def setup
+    Examples.create_grocery_list(home)
+  end
+
+  def test_list_parses_steps
+    console.in_stream = MiniTest::Mock.new
+    3.times { console.in_stream.expect :gets, "y" }
+    result = check "start groceries"
+    console.in_stream.verify
+  end
+
+  def test_list_parses_commands
+  end
+
+end
+

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: checkcheckit
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Chris Continanza
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-12 00:00:00.000000000 Z
+dependencies: []
+description: Checklists like a boss
+email:
+- christopher.continanza@gmail.com
+executables:
+- check
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/check
+- bin/t
+- checkcheckit.gemspec
+- lib/checkcheckit.rb
+- lib/checkcheckit/console.rb
+- lib/checkcheckit/list.rb
+- lib/checkcheckit/version.rb
+- test/console_test.rb
+- test/helper.rb
+- test/list_test.rb
+- test/results_test.rb
+- test/start_test.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3522511683697989869
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3522511683697989869
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Command line tool for using checklists
+test_files:
+- test/console_test.rb
+- test/helper.rb
+- test/list_test.rb
+- test/results_test.rb
+- test/start_test.rb