kwoon 0.0.1

data/Gemfile

@@ -0,0 +1,21 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in kwoon.gemspec
+gemspec
+
+# The following gems aren't dependencies in an installed gem
+# (RubyGems puts gems in directories eg kwoon-0.0.1)
+# Hacky but it will do for now.
+dir_name = File.dirname(__FILE__).split("/").last
+unless dir_name =~ /\d$/
+  group :development do
+    gem "awesome_print"
+    gem "cucumber"
+    gem "aruba"
+    gem "rspec",             ">= 2.0.0.rc"
+    gem "autotest"
+    gem "autotest-fsevent"  
+  end
+
+  gem "awesome_print", :require => "ap", :group => [ :development, :dev_utils ]  
+end

data/README.markdown

@@ -0,0 +1,74 @@
+# Kwoon
+
+## Prerequisites
+
+You need Git installed.
+
+If you intend to publish the kata history, you need push rights to
+a remote Git repository.
+
+## Installation
+
+### RVM
+
+    bash < <( curl http://rvm.beginrescueend.com/releases/rvm-install-head )
+
+### Ruby
+
+    rvm install 1.9.2
+    rvm use 1.9.2
+    
+(Kwoon should run fine in 1.8 implementations too.)
+    
+### kwoon
+
+    gem install kwoon
+    
+## Running a kata
+
+    kwoon create <kata_name> [--ruby_version=1.9.2]
+    
+The --ruby-version flag is optional.  Kwoon defaults to creating projects
+targeting Ruby 1.9.2.  The value of --ruby-version must be a valid RVM
+ruby version.  Run `rvm list known` to see these.
+
+    cd <kata_name>
+
+Answer "y" when asked if you trust the .rvmrc file.
+
+Initialise Git:
+    
+    kwoon git <remote_git_repo>
+    
+e.g.
+
+    kwoon git git@github.com:account_name/repo_name.git
+    
+You must specify a remote repository in this version of Kwoon.
+(It doesn't have to exist at this point, though.)
+
+Next start a pairing session:
+
+    kwoon start <username1> <username2> ... <usernameN>
+    
+e.g.
+
+    kwoon start fred wilma
+    
+This will create a branch "fred-wilma-YYYYMMDDhhmm"
+
+Start autotest.
+
+    autotest
+    
+(Autotest will refuse to run if you haven't run `kwoon start`).
+
+Autotest is set up to commit all your work to Git after every change
+in red/green status.
+ 
+Hack away! Then, when done...
+
+    git push 
+    
+Git is configured to create a new branch on the remote repo from
+your current branch (e.g. "fred-wilma-201010081655").

data/bin/kwoon

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'bundler'
+
+def project_file(*path_parts)
+  File.expand_path(File.join(File.dirname(__FILE__), "..", *path_parts))
+end
+ENV['BUNDLE_GEMFILE'] = project_file("Gemfile")
+
+Bundler.require(:default, :dev_utils)
+
+require 'kwoon/cli'
+
+Kwoon::CLI.start
+

data/features/descriptions/create.feature

@@ -0,0 +1,73 @@
+Feature: Create a Kata
+  In order to get a Kata setup easily and quickly
+  As a Developer
+  I want a command line utility that sets up all I need to start a Kata
+  
+  Background:
+    Given there is no RVM gemset "kwoon_test_kata_name" for Ruby "1.9.2"
+
+  Scenario: Create a kata
+    When I successfully run "kwoon create test_kata_name" with the local gem in a clean environment
+    
+    Then the following directories should exist:
+      | test_kata_name |
+    And the following files should exist:
+      | test_kata_name/.autotest                   |
+      | test_kata_name/.rspec                      |
+      | test_kata_name/.rvmrc                      |
+      | test_kata_name/.gitignore                  |
+      | test_kata_name/autotest/discover.rb        |
+      | test_kata_name/autotest/kwoon_rspec2.rb    |
+      | test_kata_name/Gemfile                     |
+      | test_kata_name/Gemfile.lock                |
+      | test_kata_name/lib/test_kata_name.rb       |
+      | test_kata_name/spec/test_kata_name_spec.rb |
+      | test_kata_name/spec/spec_helper.rb         |
+
+    And the file "test_kata_name/.rvmrc" should contain exactly:
+      """
+      rvm use 1.9.2@kwoon_test_kata_name
+      """
+    And the file "test_kata_name/.gitignore" should contain exactly:
+      """
+      .DS_Store
+      .bundle
+      """
+    And the file "test_kata_name/.autotest" should contain exactly:
+      """
+      require "autotest/fsevent" if RUBY_PLATFORM =~ /darwin/
+      """
+    And the file "test_kata_name/spec/test_kata_name_spec.rb" should contain exactly:
+      """
+      require 'spec_helper'
+      require 'test_kata_name'
+
+      describe "test_kata_name" do
+        it "does something" do
+          fail "needs some specs"
+        end
+      end
+      """
+    And the file "test_kata_name/Gemfile" should contain exactly:
+      """
+      source :rubygems
+
+      # No gems in the default group...
+
+      group :test do
+        gem "rspec", ">= 2.0.0.rc"
+      end
+
+      group :install_only do
+        gem "autotest"
+        gem "autotest-fsevent" if RUBY_PLATFORM =~ /darwin/
+      end
+      """
+    
+    And there should be a gemset called "kwoon_test_kata_name"
+    And the gemset "kwoon_test_kata_name" should include the gems:
+      | bundler          |
+      | rspec            |
+      | autotest         |
+      | autotest-fsevent |
+      | kwoon            |

data/features/descriptions/git.feature

@@ -0,0 +1,15 @@
+Feature: Git branch creation for a new Kata
+  In order to have Git setup with a branch for each version of the Kata
+  As a Developer
+  I want to have a command line utility that configures Git
+
+  Scenario: Setup the Git repository
+    Given I have successfully run "kwoon create test_kata" with the local gem in a clean environment
+    When I cd to "test_kata"
+    # NOTE this mimics the 'real life' situation of cd'ing into the folder 
+    # as that would actually switch gemsets to kwoon_test_kata
+    And I successfully run "rvm 1.9.2@kwoon_test_kata exec kwoon git user@git.host:repo.git" in a clean environment
+    Then the Git remote "origin" should point to "user@git.host:repo.git"
+    And the Git config setting for "push.default" should be "current"
+    And all files have been committed to the Git repository
+  

data/features/descriptions/start.feature

@@ -0,0 +1,13 @@
+Feature: Start a Kata
+  In order to have a have my work recorded in a silo
+  As a Developer
+  I want to start a Kata session with a baseline to work from
+  
+  Scenario: Start
+    Given I have successfully run "kwoon create test_kata" with the local gem in a clean environment
+    And I cd to "test_kata"
+    # NOTE this mimics the 'real life' situation of cd'ing into the folder 
+    # as that would actually switch gemsets to kwoon_test_kata
+    And I have successfully run "rvm 1.9.2@kwoon_test_kata exec kwoon git user@git.host:repo.git" in a clean environment
+    And I successfully run "rvm 1.9.2@kwoon_test_kata exec kwoon start andy ashley" in a clean environment
+    Then I should be on a Git branch called "andy-ashley" with a timestamp appended

data/features/step_definitions/command_steps.rb

@@ -0,0 +1,11 @@
+Given /^I (?:have )?successfully run "([^"]*)" in a clean environment$/ do |command|
+  Bundler.with_clean_env do
+    When %'I successfully run "#{command}"'
+  end
+end
+
+Given /^I (?:have )?successfully run "([^"]*)" with the local gem in a clean environment$/ do |command|
+  Bundler.with_clean_env do
+    When %'I successfully run "#{command} --kwoon-gem #{KWOON_GEM}"'
+  end
+end

data/features/step_definitions/git_steps.rb

@@ -0,0 +1,43 @@
+module GitHelpers
+  def repo
+    Grit::Repo.new(".")
+  end
+end
+World(GitHelpers)
+
+Then /^the Git remote "([^"]*)" should point to "([^"]*)"$/ do |git_remote, point_to|
+  in_current_dir do
+    repo.config[%'remote.#{git_remote}.url'].should eq point_to
+  end
+end
+
+Then /^the Git config setting for "([^"]*)" should be "([^"]*)"$/ do |setting, value|
+  in_current_dir do
+    repo.config[setting].should eq value
+  end
+end
+
+Then /^all files have been committed to the Git repository$/ do
+  # NOTE: Current version of Grit (2.3.0) doesn't handle a repository with no commits
+
+  in_current_dir do
+    repo.status.any?.should be_true
+
+    repo.status.added.should be_empty
+    repo.status.changed.should be_empty
+    repo.status.deleted.should be_empty
+    repo.status.untracked.should be_empty
+  end
+end
+
+Then /^I should be on a Git branch called "([^"]*)" with a timestamp appended$/ do |branch_name|
+  in_current_dir do
+    repo.head.name.should =~ /#{branch_name}-(\d+)/
+
+    repo.head.name =~ /#{branch_name}-(\d+)/
+    timestamp_string = $1
+    timestamp_string =~ /(\d\d\d\d)(\d\d)(\d\d)(\d\d)(\d\d)/
+    timestamp = Time.local($1, $2, $3, $4, $5)
+    timestamp.should be_close(Time.new, 60)
+  end
+end

data/features/step_definitions/rvm_steps.rb

@@ -0,0 +1,18 @@
+Given /^there is no RVM gemset "([^"]*)" for Ruby "([^"]*)"$/ do |gemset, ruby_version|
+  RVM.environment(ruby_version) do |env|
+    env.gemset_delete(gemset)
+  end
+end
+
+Then /^there should be a gemset called "([^"]*)"$/ do |expected_gemset|
+  RVM.gemset_list.should include(expected_gemset)
+end
+
+Then /^the gemset "([^"]*)" should include the gems:$/ do |gemset, gems_table|
+  Bundler.with_clean_env do
+    installed_gems = `rvm 1.9.2@#{gemset} gem list`
+    gems_table.raw.each do |row|
+      installed_gems.should include(row.first)
+    end
+  end
+end

data/features/support/env.rb

@@ -0,0 +1,15 @@
+require "bundler"
+Bundler.require(:default, :development)
+
+rvm_lib_path = "#{`echo $rvm_path`.strip}/lib"
+$LOAD_PATH.unshift(rvm_lib_path) unless $LOAD_PATH.include?(rvm_lib_path)
+require 'rvm'
+
+def project_file(*path_parts)
+  File.expand_path(File.join(File.dirname(__FILE__), "..", "..", *path_parts))
+end
+KWOON_COMMAND = project_file("bin", "kwoon")
+KWOON_GEM = project_file("kwoon-#{Kwoon::VERSION}.gem")
+
+system "gem build kwoon.gemspec"
+system "gem install #{KWOON_GEM}"

data/kwoon.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "kwoon/version"
+
+Gem::Specification.new do |s|
+  s.name        = "kwoon"
+  s.version     = Kwoon::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ashley Moran", "Andy Shipman"]
+  s.email       = ["ashley.moran@patchspace.co.uk; andy@cllearview.com"]
+  s.homepage    = "http://patch-tag.com/r/ashleymoran/kwoon/snapshot/current/content/pretty/README.markdown"
+  s.summary     = "kwoon-#{Kwoon::VERSION}"
+  s.description = "A helper utility for running Coding Dojos"
+
+  s.rubyforge_project = "kwoon"
+  
+  s.default_executable = "kwoon"
+  
+  s.add_dependency "thor"
+  s.add_dependency "grit"
+  
+  s.files         = %w[
+                        Gemfile
+                        kwoon.gemspec
+                        README.markdown
+                    ] + Dir["lib/**/*"]
+  s.test_files    = Dir["spec/**/*"] + Dir["features/**/*"]
+  s.executables   = "kwoon"
+  s.require_paths = ["lib"]
+end

data/lib/kwoon/cli.rb

@@ -0,0 +1,87 @@
+# Useful commands for development:
+# rm -rf shopping && gem uninstall -x kwoon && gem build kwoon.gemspec && gem install /Users/andy/dev/patchspace/kwoon/kwoon-0.0.1.gem && kwoon create shopping --kwoon-gem /Users/andy/dev/patchspace/kwoon/kwoon-0.0.1.gem && cd shopping && kwoon git blah@blah.com:a/ab
+# rm -rf shopping && gem build kwoon.gemspec && gem install /Users/andy/dev/patchspace/kwoon/kwoon-0.0.1.gem && kwoon create shopping --kwoon-gem /Users/andy/dev/patchspace/kwoon/kwoon-0.0.1.gem && cd shopping && kwoon git blah@blah.com:a/ab
+
+require 'thor'
+require 'thor/base'
+
+module Kwoon
+  class CLI < Thor
+    include Thor::Actions
+
+    def self.source_root; File.expand_path(File.dirname(__FILE__)); end
+    def self.exit_on_failure?; true; end
+    
+    desc "create KATA_NAME", "Create a kata"
+    method_option :"ruby-version", :type => :string, :default => "1.9.2"
+    method_option :"kwoon-gem", :type => :string, :default => "kwoon"
+    def create(kata_name)
+      @kata_name = kata_name
+      @gemset = "kwoon_" + kata_name
+      @ruby_version = options[:"ruby-version"]
+
+      Bundler.with_clean_env do      
+        puts "*** Creating kata directory"
+        FileUtils.mkdir(kata_name)
+        template "templates/autotest.tt",                 "#{kata_name}/.autotest"
+        template "templates/gitignore.tt",                "#{kata_name}/.gitignore"
+        template "templates/rspec.tt",                    "#{kata_name}/.rspec"
+        template "templates/rvmrc.tt",                    "#{kata_name}/.rvmrc"
+        template "templates/Gemfile.tt",                  "#{kata_name}/Gemfile"
+        template "templates/autotest/discover.rb.tt",     "#{kata_name}/autotest/discover.rb"
+        template "templates/autotest/kwoon_rspec2.rb.tt", "#{kata_name}/autotest/kwoon_rspec2.rb"
+        template "templates/lib/kata_name.rb.tt",         "#{kata_name}/lib/#{kata_name}.rb"
+        template "templates/spec/kata_name_spec.rb.tt",   "#{kata_name}/spec/#{kata_name}_spec.rb"
+        template "templates/spec/spec_helper.rb.tt",      "#{kata_name}/spec/spec_helper.rb"
+        puts
+      
+        puts "*** Creating kata gemset"
+        system "rvm #{@ruby_version} gemset create #{@gemset}"
+        puts
+      
+        Dir.chdir(kata_name) do
+          puts "*** Installing & updating bundler"
+          system "rvm #{@ruby_version}@#{@gemset} exec gem install bundler"
+          system "rvm #{@ruby_version}@#{@gemset} exec gem update bundler"
+          puts
+        
+          puts "*** Bundling kata gems"
+          system "rvm #{@ruby_version}@#{@gemset} exec bundle"
+          system "rvm #{@ruby_version}@#{@gemset} gem install #{options[:"kwoon-gem"]}"
+          puts
+        end
+        
+        puts "*** Now run the following commands:"
+        puts "  cd #{kata_name}"
+        puts "  kwoon git REPO_NAME"
+        puts "  kwoon start USERNAME_1 USERNAME_2 ... USERNAME_N"
+        puts "  autotest"
+        puts
+        puts "e.g."
+        puts "  kwoon git git@github.com:account_name/repo.git"
+        puts "  kwoon start fred wilma"
+        puts
+      end
+    end
+    
+    desc "git GIT_REMOTE_REPO", 'Initialise Git and set the remote repo (e.g. "kwoon git user@git.host:repo.git")'
+    def git(remote_repo_name)
+      repo = Grit::Repo.init(".")
+
+      repo.config["push.default"] = "current"
+      repo.remote_add("origin", remote_repo_name)
+      
+      repo.add(".")
+      repo.commit_index("Initialise Kata")
+    end
+    
+    desc "start USERNAME_1 USERNAME_2 ... USERNAME_N", "Create a new branch based on the template in master"
+    def start(*usernames)
+      raise Thor::Error.new("You must supply at least one username") if usernames.empty?
+      repo = Grit::Repo.init(".")
+      new_branch_name = "#{usernames.join("-")}-#{Time.new.strftime("%Y%m%d%H%M")}"
+      repo.git.branch({}, new_branch_name, "master")
+      repo.git.checkout({}, new_branch_name)
+    end
+  end
+end

data/lib/kwoon/templates/Gemfile.tt

@@ -0,0 +1,12 @@
+source :rubygems
+
+# No gems in the default group...
+
+group :test do
+  gem "rspec", ">= 2.0.0.rc"
+end
+
+group :install_only do
+  gem "autotest"
+  gem "autotest-fsevent" if RUBY_PLATFORM =~ /darwin/
+end

data/lib/kwoon/templates/autotest/discover.rb.tt

@@ -0,0 +1,5 @@
+kata_dir = File.expand_path(File.dirname(__FILE__) + '/..')
+$LOAD_PATH.unshift(kata_dir) unless $LOAD_PATH.include?(kata_dir)
+
+Autotest.add_discovery { "rspec2" }
+Autotest.add_discovery { "kwoon" }

data/lib/kwoon/templates/autotest/kwoon_rspec2.rb.tt

@@ -0,0 +1,59 @@
+require 'autotest/rspec2'
+
+class Autotest::KwoonRspec2 < Autotest::Rspec2
+  # Fix a bug in RSpec 2.0.0.rc
+  # http://github.com/rspec/rspec-core/issues/issue/178
+  def consolidate_failures(failed)
+    filters = new_hash_of_arrays
+    failed.each do |spec, trace|
+      # if trace =~ /(.*spec\.rb)/
+      if trace =~ /(.*\.rb)/
+        filters[$1] << spec
+      end
+    end
+    return filters
+  end
+end
+
+class Git
+  def commit(message, options = { })
+    puts "*** Committing (#{message})"
+    system "git add ."
+    system "git commit -am '#{message}' #{"--allow-empty" if options[:allow_empty]}"
+    puts "*** Finished committing"
+    puts
+  end
+  
+  def on_master?
+    # On branch master
+    status_message = `git status`
+    status_message.include?("# On branch master")
+  end
+end
+
+git = Git.new
+
+if git.on_master?
+  puts 'Please run "kwoon start ..." before starting autotest'
+  exit(1)
+end
+
+Autotest.add_hook(:initialize) do
+  git.commit("Starting", :allow_empty => true)
+end
+
+Autotest.add_hook(:red) do
+  git.commit("Red", :allow_empty => true)
+end
+
+Autotest.add_hook(:green) do
+  git.commit("Green")
+end
+
+Autotest.add_hook(:all_good) do
+  git.commit("All good", :allow_empty => true)
+end
+
+Autotest.add_hook(:quit) do
+  git.commit("Stopping", :allow_empty => true)
+end

data/lib/kwoon/templates/autotest.tt

@@ -0,0 +1 @@
+require "autotest/fsevent" if RUBY_PLATFORM =~ /darwin/

data/lib/kwoon/templates/gitignore.tt

@@ -0,0 +1,2 @@
+.DS_Store
+.bundle

data/lib/kwoon/templates/rspec.tt

@@ -0,0 +1 @@
+--colour

data/lib/kwoon/templates/rvmrc.tt

@@ -0,0 +1 @@
+rvm use <%= @ruby_version %>@<%= @gemset %>

data/lib/kwoon/templates/spec/kata_name_spec.rb.tt

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require '<%= @kata_name %>'
+
+describe "<%= @kata_name %>" do
+  it "does something" do
+    fail "needs some specs"
+  end
+end

data/lib/kwoon/templates/spec/spec_helper.rb.tt

@@ -0,0 +1,4 @@
+require 'bundler'
+Bundler.require(:default, :test)
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))

data/lib/kwoon/version.rb

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

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification 
+name: kwoon
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ashley Moran
+- Andy Shipman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-08 00:00:00 +01:00
+default_executable: kwoon
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: grit
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: A helper utility for running Coding Dojos
+email: 
+- ashley.moran@patchspace.co.uk; andy@cllearview.com
+executables: 
+- kwoon
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- kwoon.gemspec
+- README.markdown
+- lib/kwoon/cli.rb
+- lib/kwoon/templates/autotest/discover.rb.tt
+- lib/kwoon/templates/autotest/kwoon_rspec2.rb.tt
+- lib/kwoon/templates/autotest.tt
+- lib/kwoon/templates/Gemfile.tt
+- lib/kwoon/templates/gitignore.tt
+- lib/kwoon/templates/lib/kata_name.rb.tt
+- lib/kwoon/templates/rspec.tt
+- lib/kwoon/templates/rvmrc.tt
+- lib/kwoon/templates/spec/kata_name_spec.rb.tt
+- lib/kwoon/templates/spec/spec_helper.rb.tt
+- lib/kwoon/version.rb
+- features/descriptions/create.feature
+- features/descriptions/git.feature
+- features/descriptions/start.feature
+- features/step_definitions/command_steps.rb
+- features/step_definitions/git_steps.rb
+- features/step_definitions/rvm_steps.rb
+- features/support/env.rb
+- bin/kwoon
+has_rdoc: true
+homepage: http://patch-tag.com/r/ashleymoran/kwoon/snapshot/current/content/pretty/README.markdown
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: kwoon
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: kwoon-0.0.1
+test_files: 
+- features/descriptions/create.feature
+- features/descriptions/git.feature
+- features/descriptions/start.feature
+- features/step_definitions/command_steps.rb
+- features/step_definitions/git_steps.rb
+- features/step_definitions/rvm_steps.rb
+- features/support/env.rb