kata 1.3.0 → 1.3.1

data/README.md

@@ -1,211 +1,83 @@
-# 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 but you can't
-really test yourself. This gem provides a DSL to author the kata and administer
-it as a test providing feedback for evaluation.  It also provides basic github
-repo setup so that you can chart solution progress over time.
-
-## Authoring a Kata
+## Kata
 
-The inspiration for this gem came from my friend Nick Hengeveld 
+A kata is defined as an exercise in programming which helps hone your skills through practice and
+repetition. Authoring katas is done in blogs but you can't really test yourself. This gem provides a
+DSL to author the kata and administer it as a test providing feedback for evaluation.  It also
+provides basic github repo setup so that you can chart solution progress over time.
 
-Authoring a kata is as simple as installing this gem and creating a ruby file
-much like an RSpec test as illustrated below:
+The inspiration for this gem came from my friend [Nick Hengeveld](https://github.com/nhengeveld)
 
-    kata "String Calculator" 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 "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
-      context "sub" do
-        requirement "Create a sub method that will accept two digits as arguments" do
-          detail "Negative numbers are not allowed"
-          detail "Digits must range from 0-9"
-          example "9-6 = 3"
-        end
-        requirement "Modify the sub method to access multple digits as arguments" do
-          example "9-6-3 = 0"
-        end
-      end
-     end
+### Installation
 
-There are five methods that can be used to author a kata that have a hierarchy
-illustrated below:
+It is up on rubygems.org so add it to your project bundle:
 
-    1. kata
-      2. context
-        3. requirement
-          4. detail
-          5. example
+    gem kata
 
-1. The **kata()** method sets up the test to administer and starts the clock running.
-It takes 2 arguments:
+or do it the old fashioned way and install the gem manually:
 
-    * *string* - The name of the kata that will be displayed when taking it as well as
-    being used in creating the parent directory of the github repo during setup.
-    * *&block* - A ruby block that includes calls to *context()* or *requirement()*
-
-1. The **context()** method allows for grouping of requirements with 2 arguments:
-
-    * *string* - A description of the provided context
-    * *&block* - A ruby block consisting of a call to *requirement()*
-
-    this method call is optional and not required to define a kata.
-
-1. The **requirement()** method is the heart of a kata as it is used to provide the
-business rules that the code should provide solutions to.  It follows the same
-pattern of the other methods with 2 arguments:
-
-    * *string* - A description of the requirement that the code implementing the
-      kata should meet
-    * *&block* - A ruby block consisting of calls to *detail()* or *example()*
-
-1. The **detail()** method takes a single argument allowing for further defintion
-of a requirement.  This method can be called repeatedly in a block.
-
-    * *string* - A description of the detail of requirement
-
-1. The **example()** method takes a single argument allowing for illustration of
-examples of the requirement in practice
-
-    * *string* - An example that will help illustrate the requirement in practice
-
-## Setting up a Kata
-
-To setup a minimal github repo you must first already have a github account and
-git installed on your machine.  To build a kata repo simply use the setup
-command:
-
-    wesbailey@feynman:~/scratch-1.9.0> kata setup sample.rb
-    Creating github repo...complete
-    creating files for repo and initializing...done
-    You can now change directories to my_first-2011-03-17-225948 and take your kata
-
-Looking in that directory you can see what files have been created:
-
-    .rspec
-    README
-    lib
-    lib/my_first.rb
-    spec
-    spec/my_first_spec.rb
-    spec/spec_helper.rb
-    spec/support
-    spec/support/helpers
-    spec/support/matchers
-    spec/support/matchers/my_first.rb
-
-For the files that are generated you will see the following default contents:
-
-*.rspec*
-
-    --color --format d
-
-*README*
-
-    Leveling up my ruby awesomeness!
-
-*lib/my_first.rb*
-
-    class MyFirst
-    end
-
-*spec/my_first_spec.rb*
-
-    require 'spec_helper'
-    require 'my_first'
-
-    describe MyFirst do
-      describe "new" do
-        it "should instantiate" do
-          lambda {
-            MyFirst.new
-          }.should_not raise_exception
-        end
-      end
-    end
-
-*spec/spec_helper.rb*
-
-    $: << '.' << File.join(File.dirname(__FILE__), '..', 'lib')
-
-    require 'rspec'
-
-    Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f}
-
-*spec/support/matchers/my_first.rb*
+    gem install kata
 
-    RSpec::Matchers.define :your_method do |expected|
-      match do |your_match|
-        #your_match.method_on_object_to_execute == expected
-      end
-    end
+### Usage
 
-Following TDD the first test has been written and passes:
+    NAME
+        kata - Ruby kata management
 
-    wesbailey@feynman:~/katas/my_first-2011-03-17-225948> rspec spec/
+    SYNOPSIS
+        kata [COMMAND] [ARGS]
 
-    MyFirst
-      new
-        should instantiate
+    DESCRIPTION
+        The kata gem allows one to manage their personal development in the
+        practice of writing code through repitition.
 
-    Finished in 0.0005 seconds
-    1 example, 0 failures
+    PRIMARY COMMANDS
+        kata setup [--no-repo] [--language=option] file
+            Setup a github repo for the kata development session.
 
-With rspec configured you can also run autotest if you have it installed.
-    
-## Administering a Kata
+            --no-repo         - Add the directory tree and files to the current repo if possible
+            --language=option - Define the programming language for the directory tree that is built
+            file              - Path to the code kata source file for the practice session
 
-Running the kata from the command line yields:
+        kata take file
+            Start a kata development session
 
-    wesbailey@feynman:~/katas> kata take stringcalculator.rb
-    String Calculator Kata
-       Create an add method that will accept two digits as arguments
-          - detail: invoking with 1 and 2 returns 3
-          - detail: invoking with 1 returns 1
-          - detail: invoking with no arguments returns 0
-          - example: "1,2" sums to 3
+        kata version
+            Current installed version number
 
-    continue (Y|n): 
+        kata help
+            This usage message
 
-At this point you should go into your setup and start coding until this
-requirement is completed.  Once it is then enter and the next requirement will
-appear as illustrated below:
+### [Wiki](https://github.com/wbailey/kata/wiki)
 
-       Modify the add method to access multple digits as arguments
-          - example: "1,2,3" sums to 6
-          - example: "1,2,3,4,5" sums to 15
+The [Wiki](https://github.com/wbailey/kata/wiki) has all of the documentation necessary for getting you started.
 
-    continue (Y|n): 
+### DSL Reference
 
-The process continues until all of the requirements have been coded.  The
-kata will keep track of the ammount of time it takes for you to complete coding.
+* kata(string, &block)
+* context(string, &block)
+* requirement(string, &block)
+* detail(string)
+* example(string)
 
-## Completing the Kata
+### Contributors
 
-After completing the requirements of the kata continue and the report is
-displayed:
+Wes Bailey ([Exposing Gotchas](http://exposinggotchas.blogspot.com/ "Exposing Gotchas"))
 
-    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
-    ----------------------------------------------------------------------     --------
-    Total Time taking Calculator kata:                                         00:02:47
-    
+### License
 
-## Installing Kata
+Copyright (c) 2011-2012 Wes Bailey
 
-It is up on rubygems.org so add it to your bundle or do it the old fashioned
-way with:
+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:
 
-    gem install kata
+The above copyright notice and this permission notice shall be included in all copies or substantial
+portions of the Software.
 
-## Contributions
+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.
 
-Wes Bailey ([Exposing Gotchas](http://exposinggotchas.blogspot.com/ "Exposing Gotchas"))

data/bin/kata

@@ -16,9 +16,12 @@ DESCRIPTION
     practice of writing code through repitition.
 
 PRIMARY COMMANDS
-    kata setup file [repository]
-        Setup a github repo for the kata development session.  Use a repository
-        if it is provided and do not create a new one
+    kata setup [--no-repo] [--language=option] file
+        Setup a github repo for the kata development session.
+
+        --no-repo         - Add the directory tree and files to the current repo if possible
+        --language=option - Define the programming language for the directory tree that is built
+        file              - Path to the code kata source file for the practice session
 
     kata take file
         Start a kata development session

data/lib/kata/setup/ruby.rb

@@ -39,8 +39,8 @@ require 'spec_helper'
 require '#{use_kata_name}'
 
 describe #{class_name} do
-  describe "new" do
-    it "should instantiate" do
+  describe "#initialize" do
+    it "instantiates" do
       expect {
         #{class_name}.new
       }.should_not raise_exception

data/lib/kata/version.rb

@@ -1,3 +1,3 @@
 module Kata
-  VERSION = '1.3.0'
+  VERSION = '1.3.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kata
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-11 00:00:00.000000000 Z
+date: 2012-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2168560200 !ruby/object:Gem::Requirement
+  requirement: &2151828020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2168560200
+  version_requirements: *2151828020
 - !ruby/object:Gem::Dependency
   name: command_line_reporter
-  requirement: &2168559680 !ruby/object:Gem::Requirement
+  requirement: &2151826140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,7 +33,7 @@ dependencies:
         version: 3.2.1
   type: :runtime
   prerelease: false
-  version_requirements: *2168559680
+  version_requirements: *2151826140
 description: This DSL provides an easy way for you to write a code kata for pairing
   exercises or individual testing
 email: baywes@gmail.com
@@ -68,9 +68,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -448375996502687545
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: