kata 0.1.1 → 0.2.0

data/README.md

@@ -1,41 +1,61 @@
 ## Kata ##
 
+A kata is defined as an exercise in programming which helps hone your skills
+through practice and repetition.  Authoring katas is done in blogs with no
+real way of testing yourself for improvement.  This gem provides a DSL to 
+author the kata and administer it as a test providing feedback for evaluation.
+
+### Writing a Kata ###
+
+It is as simple as installing this gem and creating a ruby file much like
+an RSpec test as illustrated below:
+
     require 'kata'
 
-    kata "String Calculator Kata" do
-      requirement "Create a simple string calculator with a method add that takes a string" do
-        example %q{The string can contain 0, 1 or 2 numbers for example "", "1", "1,2"}
-        example "The method will return the sum of the digits"
-        example "Then empty string will return 0"
+    kata "My First Kata" do
+      requirement "Create an add method that will accept two digits as arguments" do
+        example "invoking with 1 and 2 returns 3"
+        example "invoking with 5 only returns 5"
+        example "invoking with no arguments returns 0"
       end
-
-      requirement "Allow the string to contain an unknown amount of numbers" do
-        example %q{"1,2,3" sums to 6}
-        example %q{"1,2,5,8" sums to 16}
+      requirement "Modify the add method to access multple digits as arguments" do
+        example "invoking with 1 and 2 and 3 returns 6"
+        example "invoking with 1 and 2 and 3 and 4 and 5 returns 15"
       end
+    end
 
-      requirement "Allow the add method to handle new lines between numbers (instead of commas)" do
-        example %q{"1\n2\n3" sums to 6}
-        example %q{"2,3\n4" sums to 9}
-        example %q{Consecutive use of delimeters ("1,\n2") should raise an exception}
-      end
+### Taking a Kata ###
 
-      requirement %q{Calling add with a negative number will throw an exception "negatives not allowed"} do
-        example "The exception will list the negative number that was in the string"
-        example "The exception should list all negatives if there is more than one"
-      end
+Running the kata from the command line yields:
 
-      requirement "Allow the add method to handle a different delimiter" do
-        example %q{To change a delimiter, the beginning of the string will contain a separate line "//[delimeter]\n...}
-        example "This line is optional and all previous tests should pass"
-        example %q{"//[;]\n1;2" sums to 3}
-        example %q{"1;2" should raise an exception}
-      end
+    wesbailey@feynman:~/kata> ruby sample.rb
+    My First Kata
+       Create an add method that will accept two digits as arguments
+          - invoking with 1 and 2 returns 3
+          - invoking with 1 returns 1
+          - invoking with no arguments returns 0
 
-      requirement "Allow the add method to handle multiple different delimeters" do
-        example %q{multiple delimeters can be specified in the separate line "//[delimeter][delimeter]...[delimeter]\n...}
-        example %q{"//[*][;]\n1*2;3" sums to 6}
-        example %q{"//[*][;][#]\n1*2;3#4" sums to 10}
-        example %q{"//[#][;][*]\n1*2#3;4,5\n6" sums to 21}
-      end
-    end
+    continue (Y|n): 
+
+       Modify the add method to access multple digits as arguments
+          - invoking with 1 and 2 and 3 returns 6
+          - invoking with 1 and 2 and 3 and 4 and 5 returns 15
+
+    continue (Y|n): 
+
+
+### Completing the Kata ###
+
+After completing the requirements of the kata continue and the report is
+displayed:
+
+    Congratulations!
+    - Create an add method that will accept two digits as arguments            00:02:02
+    - Modify the add method to access multple digits as arguments              00:00:45
+
+### Installing Kata ###
+
+It is up on rubygems.org so add it to your bundle or do it the old fashioned
+way with:
+
+    gem install kata

data/lib/kata.rb

@@ -1,19 +1,14 @@
 module Kata
-  # Allow rspec access
-  class << Kata
-    @@input = $stdin
-    @@output = $stdout
-    @@times = []
-  end
+  @@times = []
 
-  def kata txt
-    @@output.puts txt
+  def kata txt, lib = nil
+    puts txt
     yield if block_given?
     complete
   end
 
   def requirement txt
-    @@output.puts indent + txt
+    puts indent + txt
 
     start = Time.now
 
@@ -21,7 +16,7 @@ module Kata
 
     rsp = ask "\ncontinue (Y|n): ", 'y'
 
-    @@output.puts
+    puts
 
     elapsed = Time.now - start
     @@times << {:title => txt, :time => elapsed}
@@ -30,14 +25,14 @@ module Kata
   end
 
   def example txt
-    @@output.puts indent + '- ' + txt
+    puts indent + '- ' + txt
   end
 
   private
 
   def ask prompt, default
-    @@output.print prompt
-    @@input.gets.chomp || default
+    print prompt
+    $stdin.gets.chomp || default
   end
 
   def complete status = true
@@ -49,8 +44,10 @@ module Kata
         [use/3600, use/60 % 60, use % 60].map {|v| v.to_s.rjust(2,'0')}.join(':')
       end
 
-      @@output.puts "\n\n#{title}"
-      @@output.puts @@times.inject('') {|s,p| s << "- #{p[:title][0,70].ljust(70, ' ')} #{formatter.call(p[:time]).rjust(10,' ')}\n"}
+      puts "\n\n#{title}"
+      puts @@times.inject('') {|s,p| s << "- #{p[:title][0,70].ljust(70, ' ')} #{formatter.call(p[:time]).rjust(10,' ')}\n"}
+      puts '-' * 70 + ' ' * 5 + '-' * 8
+      puts 'Total Time taking Kata'.ljust(70, ' ') + ' ' * 5 + formatter.call(@@times.inject(0) {|s,h| s += h[:time]})
     end
 
     exit 1 unless status

data/spec/kata_spec.rb

@@ -1,8 +1,6 @@
 require 'spec_helper'
 require 'kata'
 
-include Kata
-
 describe "Kata DSL" do
   before :each do
     @summary = 'sample summary'

data/spec/support/helpers/stdout_helper.rb

@@ -1,11 +1,11 @@
 require 'stringio'
 
 def capture_stdout
-  @@output = StringIO.new
-  @@input = StringIO.new("y\n")
+  $stdout = StringIO.new
+  $stdin = StringIO.new("y\n")
   yield
-  @@output.string.strip
+  $stdout.string.strip
 ensure
-  @@output = $stdout
-  @@input = $stdin
+  $stdout = STDOUT
+  $stdin = STDIN
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Wes
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-15 00:00:00 -08:00
+date: 2010-12-18 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,8 +33,8 @@ dependencies:
         version: 1.0.0
   type: :development
   version_requirements: *id001
-description: extended description
-email: wes.bailey@insiderpages.com
+description: This DSL provides an easy way for you to write a code kata or pairing exercise
+email: baywes@gmail.com
 executables: []
 
 extensions: []