kata 1.3.3 → 1.4.0

data/README.md

@@ -1,16 +1,22 @@
-## Kata
+## Kata [![Build Status](https://travis-ci.org/wbailey/kata.png?branch=master)](https://travis-ci.org/wbailey/kata)  [![Code Climate](https://codeclimate.com/github/wbailey/kata.png)](https://codeclimate.com/github/wbailey/kata) [![Gem Version](https://badge.fury.io/rb/kata.png)](http://badge.fury.io/rb/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. 
-[coderdojo](http://www.coderdojo.com) is a fine website and provides a great way to get involved
-with katas.  The purpose of this gem is to provide a work environment based way of interacting.
-It provides several facilities for authoring and taking katas that allow you to work in your own
-environment. The inspiration for this gem came from my friend [Nick
-Hengeveld](https://github.com/nickh) who first introduced me to the concept of a kata several years
-ago.
+repetition. Authoring katas is done in blogs but you can't really test yourself.  Dave Thomas
+[@pragdave](https://twitter.com/pragdave), started this movement for programming.  He recently
+created [codekata.com](http://www.codekata.com), which is a comprehensive archives of all of the
+katas he has written.  Another fine site is [coderdojo](http://www.coderdojo.com). It provides a
+great way to get involved with katas. 
+
+The purpose of this gem is to provide a work environment based way of interacting.  It provides
+several facilities for authoring and taking katas that allow you to work in your own environment.
+The inspiration for this gem came from my friend [Nick Hengeveld](https://github.com/nickh) who
+first introduced me to the concept of a kata several years ago and provided feedback during it's
+development.
 
 ### Installation
 
+NOTE: Requires version 1.9.3 and higher
+
 It is up on rubygems.org so add it to your project bundle:
 
     gem kata
@@ -59,6 +65,8 @@ The [Wiki](https://github.com/wbailey/kata/wiki) has all of the documentation ne
 * requirement(string, &block)
 * detail(string)
 * example(string)
+* questions(&block)
+* question(string)
 
 ### Contributors
 

data/lib/kata/base.rb

@@ -45,6 +45,17 @@ module Kata
       puts indent + '- ' + "detail: #{txt}"
     end
 
+    def questions
+      if block_given?
+        puts "\nQuestions:"
+        yield
+      end
+    end
+
+    def question(txt)
+      puts indent + "- #{txt.sub(/\?$/, '')}?"
+    end
+
     private
 
     def ask(prompt, default)

data/lib/kata/setup/ruby.rb

@@ -4,27 +4,62 @@ module Kata
   module Setup
     class Ruby < Kata::Setup::Base
       def build_tree
-        %W{#{repo_name}/lib #{repo_name}/spec/support/helpers #{repo_name}/spec/support/matchers}.each {|path| FileUtils.mkdir_p path}
+        %w{lib spec helpers matchers}.each { |path| tree(path) }
+        readme
+        base_class
+        dot_rspec
+        spec_helper
+        kata_spec
+        spec_matcher
+      end
+
+      private
+
+      def use_kata_name
+        kata_name.gsub(/( |-)\1?/, '_').downcase
+      end
 
-        use_kata_name = kata_name.gsub(/( |-)\1?/, '_').downcase
-        class_name = kata_name.split(/ |-|_/).map(&:capitalize).join
+      def class_name
+        kata_name.split(/ |-|_/).map(&:capitalize).join
+      end
+
+      def tree(path)
+        full_path = case path
+          when "lib"
+            File.join(repo_name, 'lib')
+          when "spec"
+            File.join(repo_name, "spec")
+          when "matchers"
+            File.join(repo_name, "spec", "support", "matchers")
+          when "helpers"
+            File.join(repo_name, "spec", "support", "helpers")
+          end
+
+        FileUtils.mkdir_p(full_path)
+      end
 
-        # create the README file so github is happy
-        File.open(File.join(repo_name, 'README'), 'w') {|f| f.write <<EOF}
+      # Using here docs for a cheap templating system
+      def readme
+        File.open(File.join(repo_name, 'README'), 'w') { |f| f.write(<<EOF) }
 Leveling up my ruby awesomeness!
 EOF
+      end
 
+      def base_class
         # create the base class file
         File.open(File.join(repo_name, 'lib', "#{use_kata_name}.rb"), 'w') {|f| f.write <<EOF}
 class #{class_name}
 end
 EOF
-        # create the .rspec file
+      end
+
+      def dot_rspec
         File.open(File.join(repo_name, '.rspec'), 'w') {|f| f.write <<EOF}
 --color --format d
 EOF
+      end
 
-        # create the spec_helper.rb file
+      def spec_helper
         File.open(File.join(repo_name, 'spec', 'spec_helper.rb'), 'w') {|f| f.write <<EOF}
 $: << '.' << File.join(File.dirname(__FILE__), '..', 'lib')
 
@@ -32,8 +67,9 @@ require 'rspec'
 
 Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f}
 EOF
+      end
 
-        # create a working spec file for the kata
+      def kata_spec
         File.open(File.join(repo_name, 'spec', "#{use_kata_name}_spec.rb"), 'w') {|f| f.write <<EOF}
 require 'spec_helper'
 require '#{use_kata_name}'
@@ -48,7 +84,9 @@ describe #{class_name} do
   end
 end
 EOF
-        # stub out a custom matchers file
+      end
+
+      def spec_matcher
         File.open(File.join(repo_name, 'spec', 'support', 'matchers', "#{use_kata_name}.rb"), 'w') {|f| f.write <<EOF}
 RSpec::Matchers.define :your_method do |expected|
   match do |your_match|

data/lib/kata/version.rb

@@ -1,3 +1,3 @@
 module Kata
-  VERSION = '1.3.3'
+  VERSION = '1.4.0'
 end

data/spec/kata_base_spec.rb

@@ -14,9 +14,39 @@ module Kata
 
       let(:system_call) {"git add . && git commit -m 'test req' > /dev/null"}
 
+      describe "#questions" do
+        it "individually displays question" do
+          expect(subject).to receive(:puts).with("\nQuestions:")
+          expect(subject).to receive(:puts).with("   - test question 1?")
+          expect(subject).to receive(:puts).with("   - test question 2?")
+
+          subject.questions do
+            subject.question "test question 1"
+            subject.question "test question 2"
+          end
+        end
+
+        it "ignores trailing question mark" do
+          expect(subject).to receive(:puts).with("\nQuestions:")
+          expect(subject).to receive(:puts).with("   - test question 1?")
+          expect(subject).to receive(:puts).with("   - test question 2?")
+
+          subject.questions do
+            subject.question "test question 1?"
+            subject.question "test question 2?"
+          end
+        end
+
+        it "ignores questions when none provided" do
+          expect(subject).to_not receive(:puts)
+
+          subject.questions
+        end
+      end
+
       describe "#kata" do
         it 'displays summary' do
-          subject.should_receive(:puts).with('test Kata')
+          expect(subject).to receive(:puts).with('test Kata')
 
           subject.kata 'test'
         end
@@ -24,8 +54,8 @@ module Kata
 
       describe '#context' do
         it 'displays' do
-          subject.should_receive(:puts).with('test Kata')
-          subject.should_receive(:puts).with('   test context')
+          expect(subject).to receive(:puts).with('test Kata')
+          expect(subject).to receive(:puts).with('   test context')
 
           subject.kata 'test' do
             subject.context 'test context'
@@ -33,13 +63,13 @@ module Kata
         end
 
         it 'accepts requirement' do
-          subject.should_receive(:puts).with('   test context')
-          subject.should_receive(:puts).with('      test req')
-          subject.should_receive(:print)
-          $stdin.should_receive(:gets).and_return('y')
-          subject.should_receive(:puts).exactly(2).times
-          subject.should_receive(:system).with(system_call).and_return(0)
-          subject.should_receive(:puts)
+          expect(subject).to receive(:puts).with('   test context')
+          expect(subject).to receive(:puts).with('      test req')
+          expect(subject).to receive(:print)
+          expect($stdin).to receive(:gets).and_return('y')
+          expect(subject).to receive(:puts).exactly(2).times
+          expect(subject).to receive(:system).with(system_call).and_return(0)
+          expect(subject).to receive(:puts)
 
           subject.kata 'test' do
             subject.context 'test context' do
@@ -51,12 +81,12 @@ module Kata
 
       describe '#requirement' do
         it 'displays' do
-          subject.should_receive(:puts).with('   test req')
-          subject.should_receive(:print)
-          $stdin.should_receive(:gets).and_return('y')
-          subject.should_receive(:puts).exactly(2).times
-          subject.should_receive(:system).with(system_call).and_return(0)
-          subject.should_receive(:puts)
+          expect(subject).to receive(:puts).with('   test req')
+          expect(subject).to receive(:print)
+          expect($stdin).to receive(:gets).and_return('y')
+          expect(subject).to receive(:puts).exactly(2).times
+          expect(subject).to receive(:system).with(system_call).and_return(0)
+          expect(subject).to receive(:puts)
 
           subject.kata 'test' do
             subject.requirement 'test req'
@@ -64,13 +94,13 @@ module Kata
         end
 
         it 'accepts example' do
-          subject.should_receive(:puts).with('   test req')
-          subject.should_receive(:print)
-          $stdin.should_receive(:gets).and_return('y')
-          subject.should_receive(:puts).exactly(2).times
-          subject.should_receive(:system).with(system_call).and_return(0)
-          subject.should_receive(:puts).exactly(3).times
-          subject.should_receive(:puts)
+          expect(subject).to receive(:puts).with('   test req')
+          expect(subject).to receive(:print)
+          expect($stdin).to receive(:gets).and_return('y')
+          expect(subject).to receive(:puts).exactly(2).times
+          expect(subject).to receive(:system).with(system_call).and_return(0)
+          expect(subject).to receive(:puts).exactly(3).times
+          expect(subject).to receive(:puts)
 
           subject.kata 'test' do
             subject.requirement 'test req' do
@@ -82,13 +112,13 @@ module Kata
         end
 
         it 'accepts detail' do
-          subject.should_receive(:puts).with('   test req')
-          subject.should_receive(:print)
-          $stdin.should_receive(:gets).and_return('y')
-          subject.should_receive(:puts).exactly(2).times
-          subject.should_receive(:system).with(system_call).and_return(0)
-          subject.should_receive(:puts).exactly(3).times
-          subject.should_receive(:puts)
+          expect(subject).to receive(:puts).with('   test req')
+          expect(subject).to receive(:print)
+          expect($stdin).to receive(:gets).and_return('y')
+          expect(subject).to receive(:puts).exactly(2).times
+          expect(subject).to receive(:system).with(system_call).and_return(0)
+          expect(subject).to receive(:puts).exactly(3).times
+          expect(subject).to receive(:puts)
 
           subject.kata 'test' do
             subject.requirement 'test req' do

data/spec/kata_spec.rb

@@ -4,11 +4,11 @@ require 'kata/version'
 describe 'kata shell' do
   it "should exit with status 1" do
     system "ruby -I lib bin/kata 1> /dev/null"
-    $?.exitstatus.should == 1
+    expect($?.exitstatus).to eq(1)
   end
 
   it "should display the version" do
-    %x{ruby -I lib bin/kata version}.chomp.should == "kata #{Kata::VERSION}"
+    expect(%x{ruby -I lib bin/kata version}.chomp).to eq("kata #{Kata::VERSION}")
   end
 
   it "should run the kata" do
@@ -19,12 +19,12 @@ describe 'kata shell' do
       EOF
     end
 
-    %x{ruby -I lib bin/kata take test_sample.rb}.chomp.should == 'My Test Kata'
+    expect(%x{ruby -I lib bin/kata take test_sample.rb}.chomp).to eq('My Test Kata')
 
     File.unlink 'test_sample.rb'
   end
 
   it "should display the usage message" do
-    %x{ruby -I lib bin/kata help}.should =~ /NAME\n.*kata - Ruby kata management/
+    expect(%x{ruby -I lib bin/kata help}).to match(/NAME\n.*kata - Ruby kata management/)
   end
 end

data/spec/setup/base_spec.rb

@@ -1,35 +1,17 @@
 require 'spec_helper'
 require 'kata/setup/base'
-require 'kata/setup/ruby'
-require 'fileutils'
 
 module Kata
   module Setup
     describe Base do
-      #subject {Kata::Setup::Base.new}
-
-      describe "new" do
-        it "define a repo name" do
-          subject.repo_name.should match /kata-#{Time.now.strftime('%Y-%m-%d')}-\d{6}/
+      describe "#new" do
+        it "defines a repo name" do
+          expect(subject.repo_name).to match(/kata-#{Time.now.strftime('%Y-%m-%d')}-\d{6}/)
         end
 
         it "defines the kata name" do
           s = Kata::Setup::Base.new 'my-kata'
-          s.kata_name.should == 'my-kata'
-        end
-      end
-
-      describe "build_tree" do
-        it "creates files" do
-          expect {
-            subject.build_tree
-          }.to_not raise_exception
-
-          Dir[File.join(subject.repo_name, '**', '*.rb')].size.should == 4
-          Dir[File.join(subject.repo_name, 'README')].size.should == 1
-          Dir[File.join(subject.repo_name, '.rspec')].size.should == 1
-
-          FileUtils.remove_entry_secure subject.repo_name
+          expect(s.kata_name).to eq('my-kata')
         end
       end
     end

data/spec/setup/ruby_spec.rb

@@ -0,0 +1,58 @@
+require "spec_helper"
+require "kata/setup/ruby"
+require "fakefs/spec_helpers"
+
+module Kata
+  module Setup
+    describe Ruby do
+      describe "#build_tree" do
+        include FakeFS::SpecHelpers
+
+        before :each do
+          subject.build_tree
+          @use_dir = File.join("/", subject.repo_name)
+        end
+
+        it "creates lib dir" do
+          expect(File.directory?(File.join(@use_dir, "lib"))).to be true
+        end
+
+        it "creates spect dir" do
+          expect(File.directory?(File.join(@use_dir, "spec"))).to be true
+        end
+
+        it "creates matchers dir" do
+          expect(File.directory?(File.join(@use_dir, "spec", "support", "matchers"))).to be true
+        end
+
+        it "creates helpers dir" do
+          expect(File.directory?(File.join(@use_dir, "spec", "support", "helpers"))).to be true
+        end
+
+        it "creates README file" do
+          expect(File.exists?(File.join(@use_dir, "README"))).to be true
+        end
+
+        it "create base class file" do
+          expect(File.exists?(File.join(@use_dir, "lib", "#{subject.kata_name}.rb"))).to be true
+        end
+
+        it "creates dot rspec file" do
+          expect(File.exists?(File.join(@use_dir, ".rspec"))).to be true
+        end
+
+        it "creates spec helper file" do
+          expect(File.exists?(File.join(@use_dir, "spec", "spec_helper.rb"))).to be true
+        end
+
+        it "creates base spec file" do
+          expect(File.exists?(File.join(@use_dir, "spec", "#{subject.kata_name}_spec.rb"))).to be true
+        end
+
+        it "creates spec matcher file" do
+          expect(File.exists?(File.join(@use_dir, "spec", "support", "matchers", "#{subject.kata_name}.rb"))).to be true
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,12 +1,15 @@
-$: << '.' << File.join(File.dirname(__FILE__), '..', 'lib')
+$: << "." << File.join(File.dirname(__FILE__), "..", "lib")
 
-require 'rspec'
+require "rspec"
+require "kata/base"
+require "simplecov"
 
 Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f}
 
 RSpec.configure do |config|
   config.before(:each) do
-    Kata::Base.stub(:system)
+    allow(Kata::Base).to receive(:system)
   end
 end
 
+SimpleCov.start

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kata
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-05 00:00:00.000000000 Z
+date: 2014-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -61,6 +61,7 @@ files:
 - spec/kata_base_spec.rb
 - spec/kata_spec.rb
 - spec/setup/base_spec.rb
+- spec/setup/ruby_spec.rb
 - spec/spec_helper.rb
 - spec/support/helpers/stdout_helper.rb
 - spec/support/matchers/kata.rb
@@ -79,7 +80,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2352903460502696782
+      hash: 1742789635939136821
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -96,6 +97,7 @@ test_files:
 - spec/kata_base_spec.rb
 - spec/kata_spec.rb
 - spec/setup/base_spec.rb
+- spec/setup/ruby_spec.rb
 - spec/spec_helper.rb
 - spec/support/helpers/stdout_helper.rb
 - spec/support/matchers/kata.rb