sensei 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+coverage
+pkg
+.DS_Store

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/bin/sensei

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# Add '.rb' to work around a bug in IronRuby's File#dirname
+$:.unshift(File.dirname(__FILE__ + '.rb') + '/../lib') unless $:.include?(File.dirname(__FILE__ + '.rb') + '/../lib')
+
+require 'sensei'
+begin
+  failure = run_dojo(RealGit.new)
+  Kernel.exit(failure ? 1 : 0)
+rescue SystemExit => e
+  Kernel.exit(e.status)
+rescue Exception => e
+  STDERR.puts("#{e.message} (#{e.class})")
+  STDERR.puts(e.backtrace.join("\n"))
+  Kernel.exit 1
+end

data/lib/sensei.rb

@@ -0,0 +1,16 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'sensei/iteration_list'
+require 'sensei/git_tag_lister'
+require 'sensei/repository'
+require 'sensei/dojo'
+
+def get_name
+  print "Enter your name: "
+  STDIN.gets
+end
+
+def run_dojo(git)
+  Dojo.new(get_name, git).run
+end

data/lib/sensei/dojo.rb

@@ -0,0 +1,128 @@
+class Dojo
+  
+  def initialize(name, git)
+    @git = git
+    @name = name
+    @iteration = 1
+    @git.do("checkout iteration-1")
+    @git.do("branch -D #{name}")
+    @git.do("checkout -b #{name}")
+  end 
+  
+  def suggest_write_specs
+    puts
+    puts "FAIL: how about writing some specs in ./spec ?"
+    puts "FAIL! Hit [ENTER] to run them when you're ready..."
+    STDIN.gets
+  end
+  
+  def cukes_failed
+    puts 
+    puts "FAIL: Your cukes failed!"
+  end
+  
+  def specs_failed
+    puts
+    puts "FAIL: Better fix those specs!"
+    puts "FAIL! Hit [ENTER] to run them when you're ready..."
+    STDIN.gets
+  end
+  
+  def specs_passed
+    puts
+    puts "Your specs passed :-). Hit [ENTER] to try the cukes again"
+    STDIN.gets
+  end
+  
+  def run
+    @max_iterations = IterationList.new(Dir.pwd).iterations
+    until @iteration > @max_iterations
+
+      run_cukes
+      unless @cukes_passed 
+        cukes_failed
+        suggest_write_specs
+        run_specs
+        until @specs_passed
+          specs_failed
+          run_specs
+        end
+        specs_passed
+        run_cukes
+      end
+
+      if success?
+        if @iteration < @max_iterations
+          commit("iteration #{@iteration} tests passing.")
+
+          puts
+          puts
+          puts "WIN!"
+          puts "Perhaps you would care for a spot of refactoring at this point?"
+
+          refactoring_loop
+          next_iteration
+        else
+          puts "EPIC WIN! Now to play the refactoring game..."
+          until false
+            system("rake spec features")
+            if success?
+              flog
+              commit "refactoring"
+            end
+            puts "Not bad. Can you do any better? (Hit a key to re-run the flog)"
+            STDIN.gets
+          end
+        end
+      end
+    end
+  end 
+  
+  def success?
+    $?.exitstatus == 0
+  end
+  
+  def run_cukes
+    system("cucumber features")
+    @cukes_passed = success?
+  end
+
+  def run_specs
+    system("rake spec")
+    @specs_passed = success?
+  end
+
+  def next_iteration
+    commit("iteration #{@iteration} refactored.")
+    @iteration = @iteration+1
+    @git.do("merge iteration-#{@iteration}")
+  end
+
+  def commit message
+    @git.do("add .")
+    @git.do(%Q{commit -m "#{message}"})
+  end
+  
+  def flog
+    system("flog lib/*.rb")
+  end
+
+  def refactoring_loop
+    go_next = false
+    until go_next
+      message = "Press [ENTER] to run the tests again (with refactoring tips)"
+      message << ", [SPACE ENTER] to move to the next iteration" if success?
+      puts message
+
+      go_next = (STDIN.gets == " \n")
+      
+      unless go_next && success?
+        system("rake spec features")
+        if success?
+          flog
+        end
+        go_next = false
+      end
+    end
+  end
+end

data/lib/sensei/git_tag_lister.rb

@@ -0,0 +1,11 @@
+class GitTagLister
+  def initialize(path)
+    @path = path
+  end
+  
+  def tags
+    Dir.chdir(@path) do
+      `git tag`.split "\n"
+    end
+  end
+end

data/lib/sensei/iteration_list.rb

@@ -0,0 +1,11 @@
+class IterationList
+  def initialize(path)
+    @path = path
+  end
+  
+  def iterations
+    GitTagLister.new(@path).tags.select do |tag|
+      /iteration-\d*/.match(tag)
+    end.size
+  end 
+end

data/lib/sensei/repository.rb

@@ -0,0 +1,10 @@
+class RealGit
+  def do command
+    system("git #{command}")
+  end
+end
+
+class FakeGit
+  def do command
+  end
+end

data/rakefile

@@ -0,0 +1,33 @@
+require "spec/rake/spectask"
+
+task :default => :spec do
+end
+
+desc "Run all specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList["spec/**/*.rb"]
+  t.spec_opts = ['--format specdoc --color']
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "sensei"
+    gemspec.summary = "Sensei runs your coding dojo for you."
+    gemspec.description = "Sensei runs your dojo for you. You start with a single failing cucumber feature. As you make each feature pass, the next feature is brought into play. While you have failing features, you have the opportunity to write rspec specifications. Sensei will encourage you to refactor at appropriate moments, showing you your flog score as encouragement."
+    gemspec.email = "alex.scordellis@gmail.com"
+    gemspec.homepage = "http://github.com/alexscordellis/sensei"
+    gemspec.authors = ["Alex Scordellis"]
+    
+    # gemspec.test_files = Dir['spec/**/*'] + Dir['spec/*']
+
+    gemspec.add_dependency('rake', '>= 0.8.7')
+    gemspec.add_dependency('rspec', '>= 1.2.6')
+    gemspec.add_dependency('cucumber', '>= 0.3.3')
+    gemspec.add_dependency('flog', '>= 2.1.0')
+    
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end

data/readme.markdown

@@ -0,0 +1,63 @@
+# Sensei
+
+Sensei runs your dojo for you. You start with a single failing cucumber feature. As you make each feature pass, the next feature is brought into play. While you have failing features, you have the opportunity to write rspec specifications. Sensei will encourage you to refactor at appropriate moments, showing you your [flog](http://blog.zenspider.com/rubysadism/flog/) score as encouragement.
+
+This should replicate an outside-in development style, where the cucumber features represent acceptance/integration tests and the specs are lower level unit tests that help you develop the individual methods and classes.
+
+# Running a dojo
+
+    gem install sensei
+    git clone git://github.com/alexscordellis/kata-minesweeper.git (or other dojo repository)
+    cd kata-minesweeper
+    sensei
+
+Then follow the instructions. Each time you get to green, sensei will make a commit to git. This way you'll have a history of all your implementation and refactorings. You could then push those changes to a github fork of the dojo repository and compare your solution to others'.
+
+## Tips
+
+* Try to write the simplest code that will make the next cucumber scenario pass. Try not to anticipate future requirements.
+* If the jump from one scenario to the next is too big, or affects more than one behaviour of your program, consider writing rspec specifications that make smaller steps.
+* If the cucumber scenario requires a significant change in the implementation, consider refactoring before implementing the new scenario. Make sure that all the previous scenarios are still passing after your refactoring and before you add support for the new scenario.
+* Make sure you refactor each time you get to green, to make sure that you're in a good state for the net scenario. Use the flog score to guide your refactoring - a lower flog score is better.
+
+
+# Prepared dojos
+
+## Minesweeper
+
+Source is [on github](http://github.com/alexscordellis/kata-minesweeper "Minesweeper source"). This is a simple implementation of the classic Windows minesweeper game. The features currently available specify how the completed board should appear given the size and the mine locations. This is the original dojo from Matt's session.
+
+## Bowling Game
+
+Source is [on github](http://github.com/alexscordellis/sensei-bowling-game "Bowling Game source"). This is an interpretation of Uncle Bob's classic Bowling Game kata.
+
+# Prerequisites
+
+You will need the following gems
+
+* rake
+* rspec
+* cucumber
+* flog
+
+# Preparing your own dojo
+
+Your project must respond to the commands `rake spec` and `cucumber features`, issued from the command line in the root directory. Only code matching `./lib/*.rb` will be included in the flog score.
+
+# Credits
+
+The original idea came from [Matt Wynne](http://blog.mattwynne.net/)'s session at the [September 2009 London Ruby Users Group](http://lrug.org/meetings/2009/09/18/october-2009-meeting/). I've added the rspec part of the workflow and I'm working on the packaging. The features for the minesweeper kata are his.
+
+# Future plans
+
+* Get gem published somewhere
+* Provide online repository of known katas
+* Add reset functionality (reset current iteration, or reset whole kata, cleaning up branches).
+* Autodetect number of iterations (currently assumes 5).
+
+Ultimately the user should be able to do something like:
+
+    gem install sensei
+    sensei init minesweeper (downloads dojo code for minesweeper)
+    cd minesweeper
+    sensei start

data/spec/sensei/git_tag_lister_spec.rb

@@ -0,0 +1,34 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+describe GitTagLister, "when listing tags in a git repo containing tags" do
+  
+  before do
+    Dir.mkdir '/tmp/foo'
+    Dir.chdir '/tmp/foo' do
+      `git init`
+      `touch first.txt`
+      `git add .`
+      `git commit -am "Initial commit"`
+      `git tag tag-1`
+      `touch test.txt`
+      `git add test.txt`
+      `git commit -m "Added test file"`
+      `git tag otherOne`
+    end
+    @current_dir = Dir.pwd
+    @tags = GitTagLister.new("/tmp/foo").tags
+  end
+  
+  after do
+    `rm -rf /tmp/foo`
+  end
+  
+  it "should list the available tags" do
+    @tags.should == ["otherOne", "tag-1"]
+  end
+  
+  it "should put the pwd back when it's done" do
+    Dir.pwd.should == @current_dir
+  end
+  
+end

data/spec/sensei/iteration_list_spec.rb

@@ -0,0 +1,32 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+describe IterationList, "when listing sensei iterations in a git repo containing appropriate tags" do
+  
+  before do
+    Dir.mkdir '/tmp/foo'
+    Dir.chdir '/tmp/foo' do
+      `git init`
+      `touch first.txt`
+      `git add .`
+      `git commit -am "Initial commit"`
+      `git tag iteration-1`
+      `touch test.txt`
+      `git add test.txt`
+      `git commit -m "Added test file"`
+      `git tag not-an-iteration`
+      `touch test2.txt`
+      `git add test2.txt`
+      `git commit -m "Added test2 file"`
+      `git tag iteration-2`
+    end
+  end
+  
+  after do
+    `rm -rf /tmp/foo`
+  end
+  
+  it "should count the number of iterations, ignoring tags that are not iterations" do
+    IterationList.new("/tmp/foo").iterations.should == 2
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$:.unshift(File.dirname(__FILE__)+"/../lib")
+Dir.glob(File.join(File.dirname(__FILE__), '../lib/*.rb')).each {|f| require f }

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: sensei
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Alex Scordellis
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-22 00:00:00 +01:00
+default_executable: sensei
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.8.7
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.6
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: flog
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.0
+    version: 
+description: Sensei runs your dojo for you. You start with a single failing cucumber feature. As you make each feature pass, the next feature is brought into play. While you have failing features, you have the opportunity to write rspec specifications. Sensei will encourage you to refactor at appropriate moments, showing you your flog score as encouragement.
+email: alex.scordellis@gmail.com
+executables: 
+- sensei
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- VERSION
+- bin/sensei
+- lib/sensei.rb
+- lib/sensei/dojo.rb
+- lib/sensei/git_tag_lister.rb
+- lib/sensei/iteration_list.rb
+- lib/sensei/repository.rb
+- rakefile
+- readme.markdown
+- spec/sensei/git_tag_lister_spec.rb
+- spec/sensei/iteration_list_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/alexscordellis/sensei
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Sensei runs your coding dojo for you.
+test_files: 
+- spec/sensei/git_tag_lister_spec.rb
+- spec/sensei/iteration_list_spec.rb
+- spec/spec_helper.rb