codersdojo 0.9.10 → 0.9.11

data/app/argument_parser.rb

@@ -1,3 +1,7 @@
+require 'session_id_generator'
+require 'runner'
+require 'shell_argument_exception'
+
 class ArgumentParser
 	
 	def initialize controller
@@ -18,7 +22,7 @@ class ArgumentParser
 		elsif command.downcase == "spec" then
 			# 'spec" is for testing purpose only: do nothing special
 		else
-			raise ArgumentError
+			raise ShellArgumentException
 		end
 	end
 

data/app/codersdojo.rb

@@ -3,6 +3,7 @@
 require 'console_view'
 require 'controller'
 require 'argument_parser'
+require 'scaffolder'
 
 def called_from_spec args
   args[0] == "spec"
@@ -10,14 +11,18 @@ end
 
 # entry from shell
 if not called_from_spec(ARGV) then
-	view = ConsoleView.new
 	hostname = "http://www.codersdojo.com"
 #	hostname = "http://localhost:3000"
-	controller = Controller.new view, hostname
+
+	shell = ShellWrapper.new
+	scaffolder = Scaffolder.new shell
+	view = ConsoleView.new scaffolder
+	controller = Controller.new shell, view, scaffolder, hostname
+	
 	begin
 		arg_parser = ArgumentParser.new controller
 		command = arg_parser.parse ARGV
-	rescue ArgumentError
+	rescue ShellArgumentException
 		controller.help
 	end
 end

data/app/console_view.rb

@@ -4,6 +4,10 @@ class ConsoleView
 	
 	@@VERSION = '0.9'
 	
+	def initialize scaffolder
+		@scaffolder = scaffolder
+	end
+	
 	def show_help
 		puts <<-helptext
 Personal CodersDojo, Version #{@@VERSION}, http://www.codersdojo.com, Copyright by it-agile GmbH (http://www.it-agile.de)
@@ -39,7 +43,7 @@ helptext
 	end
 
 	def show_help_setup
-			templates = ShellWrapper.new.list_templates
+			templates = @scaffolder.list_templates
 			puts <<-helptext
 			
 setup <framework> <kata_file_no_ext>  Setup the environment for the kata for the given framework and kata file.
@@ -64,7 +68,7 @@ helptext
 	end
 
 	def show_help_upload
-		templates = ShellWrapper.new.list_templates
+		templates = @scaffolder.list_templates
 		puts <<-helptext
 		
 upload <framework> <session_directory>  Upload the kata written with <framework> in <session_directory> to codersdojo.com. 

data/app/controller.rb

@@ -1,7 +1,11 @@
+require 'scheduler'
+
 class Controller
 
-	def initialize view, hostname
+	def initialize shell, view, scaffolder, hostname
+		@shell = shell
 		@view = view
+		@scaffolder = scaffolder
 		@hostname = hostname
 	end
 
@@ -14,13 +18,8 @@ class Controller
 	end
 
 	def generate framework, kata_file
-		shell = ShellWrapper.new
-		shell.scaffold framework
-		generator_text = IO.readlines("README").to_s;
-		generator_text = generator_text.gsub('#{kata_file}', kata_file)
-		generator_text = generator_text.gsub('#{$0}', $0)
-		generator_text = shell.make_os_specific generator_text
-		puts "\n" + generator_text
+		@scaffolder.scaffold framework, kata_file
+		puts "\n" + @shell.read_file("README")
 	end
 
 	def start command, file

data/app/scaffolder.rb

@@ -0,0 +1,59 @@
+require 'text_template_machine'
+
+class Scaffolder
+
+  ANY_TEMPLATE = "any"
+
+	def initialize shell
+		@shell = shell
+		@template_machine = create_template_machine
+	end
+
+	def create_template_machine
+		template_machine = TextTemplateMachine.new @shell
+		template_machine.placeholder_values = {
+			'sh' => @shell.shell_extension,
+			':' => @shell.path_separator,
+			'rm' => @shell.remove_command_name
+		}
+		template_machine
+	end
+
+	def list_templates
+		templates = @shell.real_dir_entries template_path
+		templates.delete ANY_TEMPLATE
+		templates.join(', ')
+	end
+
+	def scaffold template, kata_file
+		@template_machine.placeholder_values['kata_file'] = kata_file
+		begin
+			dir_path = "#{template_path}/#{template}"
+			to_copy = @shell.real_dir_entries dir_path
+		rescue
+			dir_path = "#{template_path}/#{ANY_TEMPLATE}"
+			to_copy = @shell.real_dir_entries dir_path
+		end
+		to_copy.each do |item|
+			file_path = "#{dir_path}/#{item}"
+			@shell.cp_r file_path, "."
+			transform_file item
+		end
+	end
+	
+	def transform_file file
+		if file == "README" or file.end_with?(".sh")
+			content = @shell.read_file file
+			content = @template_machine.render content
+			@shell.write_file file, content
+		end
+	end
+		
+	def template_path
+		file_path_elements = @shell.current_file.split '/' 
+		file_path_elements[-2..-1] = nil
+		(file_path_elements << 'templates').join '/'
+	end
+
+end
+

data/app/shell_argument_exception.rb

@@ -0,0 +1,3 @@
+class ShellArgumentException < Exception
+	
+end

data/app/shell_wrapper.rb

@@ -3,12 +3,15 @@ require 'tempfile'
 class ShellWrapper
 
   MAX_STDOUT_LENGTH = 100000
-  ANY_TEMPLATE = "any"
 
   def cp source, destination
     FileUtils.cp source, destination
   end
 
+  def cp_r source, destination
+    FileUtils.cp_r source, destination
+  end
+
   def mkdir dir
     FileUtils.mkdir dir
   end
@@ -17,6 +20,10 @@ class ShellWrapper
     FileUtils.mkdir_p dirs
   end
 
+	def current_file
+		__FILE__
+	end
+
   def execute command
     spec_pipe = IO.popen(command, "r")
     result = spec_pipe.read MAX_STDOUT_LENGTH
@@ -42,38 +49,19 @@ class ShellWrapper
     File.new(filename).ctime
   end
 
-	def list_templates
-		templates = real_dir_entries template_path
-		templates.delete ANY_TEMPLATE
-		templates.join(', ')
-	end
-
-	def scaffold template
-		begin
-			dir_path = "#{template_path}/#{template}"
-			to_copy = real_dir_entries dir_path
-		rescue
-			dir_path = "#{template_path}/#{ANY_TEMPLATE}"
-			to_copy = real_dir_entries dir_path
-		end
-		to_copy.each do |item|
-			FileUtils.cp_r "#{dir_path}/#{item}", "."
-		end
-	end
-	
-	def template_path
-		file_path_elements = __FILE__.split '/' 
-		file_path_elements[-2..-1] = nil
-		(file_path_elements << 'templates').join '/'
-	end
-
 	def real_dir_entries dir
 		current_and_parent = 2
 		Dir.new(dir).entries.drop current_and_parent
 	end
 
-	def make_os_specific text
-		text.gsub('%sh%', shell_extension).gsub('%:%', path_separator).gsub('%rm%', remove_command_name)
+	def read_file filename
+		generator_text = IO.readlines(filename).to_s;
+	end
+
+	def write_file filename, content
+		File.open(filename, 'w') do |f|  
+		  f.puts content 
+		end
 	end
 
 	def remove_command_name

data/app/text_template_machine.rb

@@ -0,0 +1,26 @@
+class TextTemplateMachine
+	
+	attr_accessor :placeholder_values
+	
+	def initialize shell
+		@shell =  shell
+		@placeholder_values = []
+	end
+	
+	def render text
+		@placeholder_values.each do |placeholder_value|
+			placeholder = placeholder_value.first
+			value = placeholder_value.last
+			text = replace_placeholder text, placeholder, value
+		end
+		text
+	end
+	
+	def replace_placeholder text, placeholder, value
+		text = text.gsub "%#{placeholder}%", value
+		placeholder_cap = placeholder.capitalize
+		value_cap = value.capitalize
+		text.gsub "%#{placeholder_cap}%", value_cap
+	end
+	
+end

data/spec/scaffolder_spec.rb

@@ -0,0 +1,54 @@
+require "scaffolder"
+
+describe Scaffolder do
+
+	before (:each) do
+		@shell_mock = mock
+		@shell_mock.should_receive(:shell_extension).any_number_of_times.and_return "cmd"
+		@shell_mock.should_receive(:remove_command_name).any_number_of_times.and_return "del"
+		@shell_mock.should_receive(:path_separator).any_number_of_times.and_return ";"
+		@shell_mock.should_receive(:current_file).any_number_of_times.and_return("aDir/app/aFile.rb")
+		@scaffolder = Scaffolder.new @shell_mock
+	end
+	
+  it "should compute template path from location of ruby source file" do
+		@scaffolder.template_path.should == "aDir/templates"
+  end
+
+	it "should retrieve templates from directories within the template directory" do
+		@shell_mock.should_receive(:real_dir_entries).with("aDir/templates").and_return ['any', 't1', 't2', 't3']
+		@scaffolder.list_templates.should == 't1, t2, t3'
+	end
+	
+	it "should scaffold the files and directories for a given template" do
+		@shell_mock.should_receive(:real_dir_entries).with("aDir/templates/a.template").and_return ["a", "b"]
+		@shell_mock.should_receive(:cp_r).with "aDir/templates/a.template/a", "."
+		@shell_mock.should_receive(:cp_r).with "aDir/templates/a.template/b", "."
+		@scaffolder.scaffold "a.template", 'myKata'
+	end
+	
+	it "should use 'any' when the given template doesn't exist" do
+		@shell_mock.should_receive(:real_dir_entries).with("aDir/templates/unknown.template").and_throw Exception
+		@shell_mock.should_receive(:real_dir_entries).with("aDir/templates/any").and_return ["a"]
+		@shell_mock.should_receive(:cp_r).with "aDir/templates/any/a", "."
+		@scaffolder.scaffold "unknown.template", 'myKata'
+	end
+	
+	it "should replace placeholder in template file README and shell scripts" do
+		@shell_mock.should_receive(:real_dir_entries).with("aDir/templates/a.template").
+			and_return ["a", "README", "run-once.sh", "run-endless.sh"]
+		@shell_mock.should_receive(:cp_r).with "aDir/templates/a.template/a", "."
+		@shell_mock.should_receive(:cp_r).with "aDir/templates/a.template/README", "."
+		@shell_mock.should_receive(:cp_r).with "aDir/templates/a.template/run-once.sh", "."
+		@shell_mock.should_receive(:cp_r).with "aDir/templates/a.template/run-endless.sh", "."
+		@shell_mock.should_receive(:read_file).with("README").and_return '%rm% %kata_file%\nb.%sh%\nc%:%d'
+		@shell_mock.should_receive(:write_file).with "README", 'del myKata\nb.cmd\nc;d'
+		@shell_mock.should_receive(:read_file).with("run-once.sh").and_return "%rm% a\nb.%sh%\nc%:%d"
+		@shell_mock.should_receive(:write_file).with "run-once.sh", "del a\nb.cmd\nc;d"
+		@shell_mock.should_receive(:read_file).with("run-endless.sh").and_return "%rm% a\nb.%sh%\nc%:%d"
+		@shell_mock.should_receive(:write_file).with "run-endless.sh", "del a\nb.cmd\nc;d"
+		@scaffolder.scaffold "a.template", 'myKata'
+	end
+
+end
+

data/spec/state_reader_spec.rb

@@ -12,10 +12,10 @@ describe StateReader do
   end
 
   it "should read a stored kata state" do
-    @shell_mock.should_receive(:ctime).with("#{@state_dir_prefix}0").and_return @a_time
-    Dir.should_receive(:entries).with("#{@state_dir_prefix}0").and_return(['.','..','file.rb', 'result.txt'])
-    @shell_mock.should_receive(:read_file).with("#{@state_dir_prefix}0/file.rb").and_return "source code"
-    @shell_mock.should_receive(:read_file).with("#{@state_dir_prefix}0/result.txt").and_return "result"
+    @shell_mock.should_receive(:ctime).with(".codersdojo/id0815/#{@state_dir_prefix}0").and_return @a_time
+    Dir.should_receive(:entries).with(".codersdojo/id0815/#{@state_dir_prefix}0").and_return(['.','..','file.rb', 'result.txt'])
+    @shell_mock.should_receive(:read_file).with(".codersdojo/id0815/#{@state_dir_prefix}0/result.txt").and_return "result"
+    @shell_mock.should_receive(:read_file).with(".codersdojo/id0815/#{@state_dir_prefix}0/file.rb").and_return "source code"
     state = @state_reader.read_next_state
     state.time.should == @a_time
     state.code.should == "source code"

data/spec/text_template_machine_spec.rb

@@ -0,0 +1,40 @@
+require 'text_template_machine'
+
+describe TextTemplateMachine do
+	
+	before (:each) do
+		shell_mock = mock
+		@machine = TextTemplateMachine.new shell_mock
+		@placeholder_values = {'a' => 'A', 'wo' => 'world', 'm' => 'my'}
+		@machine.placeholder_values = @placeholder_values
+	end
+	
+	it "should not modifiy text without placeholders" do
+		@machine.render('Some text without placeholders.').should == 'Some text without placeholders.'
+	end
+	
+	it "should not modifiy unknown placeholders" do
+		@machine.render('Hello %unknown%').should == 'Hello %unknown%'
+	end
+
+	it "should resolve placeholders" do
+		@machine.render('Hello %wo%, %m% %wo%').should == 'Hello world, my world'
+	end
+
+	it "should not modify case of first letter" do
+		@machine.render('Hello %wo%').should == 'Hello world'
+		@machine.render('Hello %Wo%').should == 'Hello World'
+	end
+	
+	it "should use added placeholder" do
+		@machine.placeholder_values['xxx'] = 'xxx-value'
+		@machine.render('%xxx%').should == 'xxx-value'
+	end
+	
+	it "should use newest placeholder value" do
+		@machine.placeholder_values['a'] = 'b'
+		@machine.render('%a%').should == 'b'
+	end
+	
+end
+

data/templates/any/README

@@ -1,10 +1,10 @@
-You have to create two shell scripts manually:
-  Create a shell script run-once.%sh% that runs the tests of your kata once.
+Two shell scripts were created:
+  run-once.%sh% runs your tests once
+  run-endless.%sh% runs your tests endlessly via run-once.%sh%
 
-  Create a second shell script run-endless.sh with this content:
-    #{$0} start run-once.%sh% #{kata_file}.<extension>
+run-once.%sh% is not implemented by now. You have to implement it appropriately.
 
 Run run-endless.%sh% and start your kata.
 
 Assumptions:
-  - The whole kata source code is in the one #{kata_file}.<extension>.
+  - The whole kata source code is in the one %kata_file%.

data/templates/any/run-endless.sh

@@ -1,2 +1 @@
-echo "Modify run-endless.sh so that it uses your actual kata file."
-#codersdojo start run-once.sh #{kata_file}
+codersdojo start run-once.sh %kata_file%

data/templates/any/run-once.sh

@@ -1 +1 @@
-echo "Modify shell script run-once.sh so that it runs your tests once."
+echo "Modify shell script run-once.%sh% so that it runs your tests once."

data/templates/clojure.is-test/README

@@ -1,12 +1,10 @@
-You have to create two shell scripts manually:
-  Create a shell script run-once.%sh% with this content:
-    java -cp clojure-contrib.jar%:%clojure.jar clojure.main #{kata_file}.clj
+Two shell scripts were created:
+  run-once.%sh% runs your tests once
+  run-endless.%sh% runs your tests endlessly via run-once.%sh%
 
-  Create a second shell script run-endless.sh with this content:
-    #{$0} start run-once.%sh% #{kata_file}.clj
-
-Run run-endless.%sh% and start your kata.
+Run run-endless.sh and start your kata.
 
 Assumptions:
+  - The whole kata source code is in the one %kata_file%.clj.
   - Java is installed on your system and 'java' is in the path.
-  - clojure.jar and clojure-contrib.jar are placed in your work directory.
+  - clojure.jar and clojure-contrib.jar are placed in the 'lib' directory.

data/templates/clojure.is-test/run-endless.sh

@@ -1 +1,2 @@
-codersdojo start run-once.sh prime.clj
+codersdojo start run-once.sh %kata_file%.clj
+

data/templates/clojure.is-test/run-once.sh

@@ -1,2 +1 @@
-echo "Modify shell script run-once.sh so that it runs your tests once."
-# java -cp lib/clojure-contrib.jar:/System/Library/Frameworks/Clojure/clojure.jar clojure.main #{kata_file}
+java -cp lib/clojure-contrib.jar%:%lib/clojure.jar clojure.main %kata_file%.clj

data/templates/java.junit/README

@@ -1,19 +1,15 @@
-You have to create two shell scripts manually:
-  Create a shell script run-once.%sh% with this content:
-    %rm% bin/#{kata_file}.class
-    javac -cp lib/junit.jar -d bin #{kata_file}.java
-    java -cp lib/junit.jar%:%bin #{kata_file}
+Two shell scripts were created:
+  run-once.%sh% runs your tests once
+  run-endless.%sh% runs your tests endlessly via run-once.%sh%
 
-  Create a second shell script run-endless.sh with this content:
-    #{$0} start run-once.%sh% src/#{kata_file}.java
-
-Run run-endless.%sh% and start your kata.
+Run run-endless.sh and start your kata.
 
 Assumptions:
   - A Java JDK is installed on your system and 'java' and 'javac' are in the path.
-  - junit.jar is placed in a directory named 'lib'.
+  - junit.jar is placed in the 'lib' directory.
+  - The whole kata source code is in the one %Kata_file%Test.java.
   - The kata source file is placed in the 'src' directory.
-  - The kata class file is generated into the 'class' directory.
+  - The kata class file is generated into the 'bin' directory.
   - In the source file the classes are placed in the default package.
   - The kata source file has a main method that starts the tests.
   - If your IDE (like Eclipse) compiles the source file, you should remove the first two lines

data/templates/java.junit/run-endless.sh

@@ -1 +1 @@
-ruby ../../app/personal_codersdojo.rb start run-once.sh src/PrimeTest.java
+codersdojo start run-once.sh src/%Kata_file%Test.java

data/templates/java.junit/run-once.sh

@@ -1,3 +1,3 @@
-rm bin/PrimeTest.class
-javac -cp lib/junit.jar -d bin src/PrimeTest.java
-java -cp lib/junit.jar:bin PrimeTest
+rm bin/%Kata_file%Test.class
+javac -cp lib/junit.jar -d bin src/%Kata_file%Test.java
+java -cp lib/junit.jar:bin org.junit.runner.JUnitCore %Kata_file%Test

data/templates/python.unittest/README

@@ -1,8 +1,8 @@
-You have to create two shell scripts manually:
-  Create a shell script run-once.%sh% with this content:
-    python #{kata_file}.py
+Two shell scripts were created:
+  run-once.%sh% runs your tests once
+  run-endless.%sh% runs your tests endlessly via run-once.%sh%
 
-  Create a second shell script run-endless.sh with this content:
-    #{$0} start run-once.%sh% #{kata_file}.py
+Run run-endless.%sh% and start your kata.
 
-Run run-endless.%sh% and start your kata.
+Assumptions:
+  - The whole kata source code is in the one %kata_file%.py.

data/templates/python.unittest/run-endless.sh

@@ -0,0 +1 @@
+codersdojo start run-once.sh %kata_file%.py

data/templates/python.unittest/run-once.sh

@@ -0,0 +1 @@
+python %kata_file%.py

data/templates/ruby.test-unit/README

@@ -1,5 +1,8 @@
-You have to create one shell script manually:
-  Create a shell script run-endless.%sh% with this content:
-    #{$0} start ruby #{kata_file}.rb
+Two shell scripts were created:
+  run-once.%sh% runs your tests once
+  run-endless.%sh% runs your tests endlessly via run-once.%sh%
 
-Run run-endless.%sh% and start your kata.
+Run run-endless.%sh% and start your kata.
+
+Assumptions:
+  - The whole kata source code is in the one %kata_file%.rb.

data/templates/ruby.test-unit/run-endless.sh

@@ -0,0 +1 @@
+codersdojo start run-once.sh %kata_file%.rb

data/templates/ruby.test-unit/run-once.sh

@@ -0,0 +1 @@
+ruby %kata_file%.rb

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: codersdojo
 version: !ruby/object:Gem::Version 
-  hash: 47
+  hash: 45
   prerelease: false
   segments: 
   - 0
   - 9
-  - 10
-  version: 0.9.10
+  - 11
+  version: 0.9.11
 platform: ruby
 authors: 
 - CodersDojo-Team
@@ -48,16 +48,19 @@ files:
 - app/filename_formatter.rb
 - app/progress.rb
 - app/runner.rb
+- app/scaffolder.rb
 - app/scheduler.rb
 - app/session_id_generator.rb
+- app/shell_argument_exception.rb
 - app/shell_wrapper.rb
 - app/state_reader.rb
+- app/text_template_machine.rb
 - app/uploader.rb
 - app/xml_element_extractor.rb
 - templates/any/README
 - templates/any/run-endless.sh
 - templates/any/run-once.sh
-- templates/clojure.is-test/lib/clojure-contrib.jar
+- templates/clojure.is-test/lib/place_your_libs_here
 - templates/clojure.is-test/README
 - templates/clojure.is-test/run-endless.sh
 - templates/clojure.is-test/run-once.sh
@@ -67,14 +70,19 @@ files:
 - templates/java.junit/run-endless.sh
 - templates/java.junit/run-once.sh
 - templates/java.junit/src/place_your_source_files_here
-- templates/javascript.jspec/README
 - templates/python.unittest/README
+- templates/python.unittest/run-endless.sh
+- templates/python.unittest/run-once.sh
 - templates/ruby.test-unit/README
+- templates/ruby.test-unit/run-endless.sh
+- templates/ruby.test-unit/run-once.sh
 - spec/argument_parser_spec.rb
 - spec/progress_spec.rb
 - spec/runner_spec.rb
+- spec/scaffolder_spec.rb
 - spec/session_id_generator_spec.rb
 - spec/state_reader_spec.rb
+- spec/text_template_machine_spec.rb
 - spec/uploader_spec.rb
 - spec/xml_element_extractor_spec.rb
 - bin/codersdojo
@@ -116,7 +124,9 @@ test_files:
 - spec/argument_parser_spec.rb
 - spec/progress_spec.rb
 - spec/runner_spec.rb
+- spec/scaffolder_spec.rb
 - spec/session_id_generator_spec.rb
 - spec/state_reader_spec.rb
+- spec/text_template_machine_spec.rb
 - spec/uploader_spec.rb
 - spec/xml_element_extractor_spec.rb

data/templates/javascript.jspec/README

@@ -1,8 +0,0 @@
-You have to create two shell scripts manually:
-  Create a shell script run-once.%sh% with this content:
-    jspec --rhino run
-
-  Create a second shell script run-endless.sh with this content:
-    #{$0} start run-once.%sh% #{kata_file}.js
-
-Run run-endless.%sh% and start your kata.