codersdojo 1.2.08 → 1.2.09

data/app/argument_parser.rb

@@ -1,42 +1,41 @@
 require 'session_id_generator'
 require 'runner'
 require 'shell_argument_exception'
+require 'shell_wrapper'
+require 'console_view'
+require 'help_command'
+require 'generate_command'
+require 'upload_command'
+require 'upload_no_open_command'
+require 'start_command'
 
 class ArgumentParser
 	
-	def initialize controller
-		@controller = controller
+	def initialize shell, view, scaffolder, hostname
+		@help_command = HelpCommand.new view
+		@upload_command = UploadCommand.new shell, view, hostname
+		@upload_no_open_command = UploadNoOpenCommand.new @upload_command
+		@generate_command = GenerateCommand.new shell, view, scaffolder
+		@start_command = StartCommand.new shell, view, @upload_command
+		@commands = [@help_command, @generate_command, @start_command, @upload_command, @upload_no_open_command]
 	end
 	
-	def parse params		
-		command = params[0] ? params[0].downcase : ""
-		if command == "help" then
-			@controller.help params[1]
-		elsif command == "setup" then
-			@controller.generate params[1], params[2]
-		elsif command == "upload" then
-			@controller.upload params[1]
-		elsif command == "upload-no-open" then
-			@controller.upload params[1], false
-		elsif command == "upload-with-framework" then
-			@controller.upload_with_framework params[1], params[2]
-		elsif command == "start" then
-			run_command = expand_run_command params[1]
-			@controller.start run_command, params[2]
-		elsif command == "spec" then
+	def parse params
+		params[0] = params[0] ? params[0].downcase : 'help'
+		command_name = params[0]
+		command_executed = false
+		@commands.each do |command|
+			if command.accepts_shell_command?(command_name) 
+				command.execute_from_shell params
+				command_executed = true
+			end
+		end
+		if not command_executed and command_name == "spec"
 			# 'spec" is for testing purpose only: do nothing special
-		else
-			raise ShellArgumentException.new command
+		elsif not command_executed
+			raise ShellArgumentException.new command_name
 		end
 	end
 
-	def expand_run_command command
-		if command.end_with?(".sh") then
-			"bash #{command}"
-		else
-			command
-		end
-	end
-	
 end
 

data/app/codersdojo.rb

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
 
 require 'console_view'
-require 'controller'
 require 'argument_parser'
 require 'scaffolder'
 
@@ -17,10 +16,9 @@ class CodersDojo
 		shell = ShellWrapper.new
 		scaffolder = Scaffolder.new shell
 		view = ConsoleView.new scaffolder
-		controller = Controller.new shell, view, scaffolder, @hostname
 
 		begin
-			arg_parser = ArgumentParser.new controller
+			arg_parser = ArgumentParser.new shell, view, scaffolder, @hostname
 			command = arg_parser.parse @params
 		rescue ShellArgumentException => e
 			view.show_unknwon_command_message e.command

data/app/console_view.rb

@@ -3,6 +3,8 @@ require 'text_template_machine'
 require 'property_file_missing_exception'
 
 class ConsoleView
+
+	FRAMEWORK_LIST_INDENTATION = 6
 	
 	def initialize scaffolder
 		@scaffolder = scaffolder
@@ -27,12 +29,6 @@ Commands:
   setup <framework> <kata_file>        Setup the environment for running the kata.
   upload [<session_dir>]               Upload the kata to http://www.codersdojo.org and open the kata in a browser.
   upload-no-open [<session_dir>]       Upload the kata to http://www.codersdojo.org
-  upload-with-framework <framework> [<session_dir>]   
-                                       Upload the kata to http://www.codersdojo.org
-                                       !!! This command exists for compatibility reasons only.
-                                       !!! It will be removed in the near future. 
-                                       !!! Please run 'setup' again to generate the .meta file
-                                       !!! and use 'upload' without the 'framework' parameter.
 
 Report bugs to <codersdojo@it-agile.de>
 helptext
@@ -47,45 +43,51 @@ helptext
 			show_help_upload
 		elsif command == 'upload-no-open' then
 			show_help_upload_no_open
-		elsif command == 'upload-with-framework' then
-			show_help_upload_with_framework
 		else
 			show_help_unknown command
 		end
 	end
 
 	def show_help_setup
-			templates = @scaffolder.list_templates
+			templates = @scaffolder.list_templates_as_dotted_list FRAMEWORK_LIST_INDENTATION
 			show <<-helptext
 			
-setup <framework> <kata_file>  Setup the environment for the kata for the given framework and kata file.
-                               By now <framework> is one of #{templates}.
-                               Use ??? as framework if your framework isn't in the list.
+setup <framework> <kata_file>  
+    Setup the environment for the kata for the given framework and kata file.
+    The <kata_file> is the one file that will contain the source code of the code kata.
+    If <kata_file> does not have an extension it will be added automatically 
+    - except if <framework> is ??? (see below).
+    By now <framework> is one of these:
+#{templates}.
+    Use ??? as framework if your framework isn't in the list.
 
 Example:
     :%/%dojo%/%my_kata$ #{current_command_path} setup ruby.test-unit prime
-        Show the instructions how to setup the environment for kata execution with Ruby and test/unit.
+        Setup the the environment for executing a code kata in kata file 'prime' with Ruby and test/unit.
 helptext
 	end
 
 	def show_help_start
 		show <<-helptext
 		
-start <shell_command> <kata_file>  Start the continuous test runner, that runs <shell-command> whenever <kata_file>
-                                   changes. The <kata_file> has to include the whole source code of the kata.
-                                   Whenever the test runner is started, it creates a new session directory in the 
-                                   directory .codersdojo where it logs the steps of the kata.
+start <shell_command> <kata_file>  
+    Start the continuous test runner, that runs <shell-command> whenever <kata_file>
+    changes. The <kata_file> has to include the whole source code of the kata.
+    Whenever the test runner is started, it creates a new session directory in the 
+    directory .codersdojo where it logs the steps of the kata.
 helptext
 	end
 
 	def show_help_upload
 		show <<-helptext
 		
-upload                      Upload the newest kata session in .codersdojo to codersdojo.com.
-                            After the kata is uploaded the browser is started with the URL of the uploaded kata.
+upload                      
+    Upload the newest kata session in .codersdojo to codersdojo.com.
+    After the kata is uploaded the browser is started with the URL of the uploaded kata.
 
-upload <session_directory>  Upload the kata <session_directory> to codersdojo.com. 
-                            <session_directory> is relative to the working directory.
+upload <session_directory>  
+    Upload the kata <session_directory> to codersdojo.com. 
+    <session_directory> is relative to the working directory.
 
 Examples:
     :%/%dojo%/%my_kata$ #{current_command_path} upload
@@ -98,10 +100,12 @@ helptext
 	def show_help_upload_no_open
 		show <<-helptext
 
-upload-no-open                      Upload the newest kata session in .codersdojo to codersdojo.com.
+upload-no-open                      
+    Upload the newest kata session in .codersdojo to codersdojo.com.
 
-upload-no-opem <session_directory>  Upload the kata <session_directory> to codersdojo.com. 
-                                    <session_directory> is relative to the working directory.
+upload-no-opem <session_directory>  
+    Upload the kata <session_directory> to codersdojo.com. 
+    <session_directory> is relative to the working directory.
 
 Examples:
     :%/%dojo%/%my_kata$ #{current_command_path} upload-no-open
@@ -111,24 +115,6 @@ Examples:
 helptext
 	end
 
-	def show_help_upload_with_framework
-		templates = @scaffolder.list_templates
-		show <<-helptext
-
-upload-with-framework <framework> [<session_directory>]
-                                          Upload the kata written with <framework> in <session_directory> to codersdojo.com. 
-                                          <session_directory> is relative to the working directory.
-                                          If you don't specify a <session_directory> the newest session in .codersdojo is uploaded.
-                                          By now <framework> is one of #{templates}.
-                                          If you used another framework, use ??? and send an email to codersdojo@it-agile.de
-																					After the kata is uploaded the browser is started with the URL of the uploaded kata.
-
-Example:
-    :%/%dojo%/%my_kata$ #{current_command_path} upload-with-framework ruby.test-unit .codersdojo%/%2010-11-02_16-21-53
-        Upload the kata (written in Ruby with the test/unit framework) located in directory ".codersdojo%/%2010-11-02_16-21-53" to codersdojo.com.
-helptext
-	end
-
 	def show_help_unknown command
 		show <<-helptext
 Command #{command} not known. Try '#{current_command_path} help' to list the supported commands.

data/app/generate_command.rb

@@ -0,0 +1,30 @@
+class GenerateCommand
+	
+	def initialize shell, view, scaffolder
+		@shell = shell
+		@view = view
+		@scaffolder = scaffolder
+	end
+	
+	def execute_from_shell params
+		generate params[1], params[2]
+	end
+	
+	def generate framework, kata_file
+		if not kata_file then
+			@view.show_missing_command_argument_error "setup", "kata_file"
+			return
+		end
+		begin
+			@scaffolder.scaffold framework, kata_file
+			@view.show "\n" + @shell.read_file("README")
+		rescue
+			@view.show_unknown_framework_error framework, @scaffolder.list_templates
+		end		
+	end
+	
+	def accepts_shell_command? command
+		command == 'setup'
+	end
+
+end

data/app/help_command.rb

@@ -0,0 +1,23 @@
+class HelpCommand
+
+	def initialize view
+		@view = view
+	end
+	
+	def execute_from_shell params
+		help params[1]
+	end
+	
+	def help command=nil
+		if command then
+			@view.show_detailed_help command.downcase
+		else
+			@view.show_help
+		end
+	end
+	
+	def accepts_shell_command? command
+		['help', '-h', '--help'].member? command
+	end
+
+end

data/app/scaffolder.rb

@@ -16,6 +16,13 @@ class Scaffolder
 		templates.join(', ')
 	end
 
+	def list_templates_as_dotted_list indentation
+		templates = @shell.real_dir_entries template_path
+		templates.delete ANY_TEMPLATE
+		indent_string = ' '*indentation
+		"#{indent_string}* " + templates.join("\n#{indent_string}* ")
+	end
+
 	def scaffold template, kata_file
 		@template_machine.placeholder_values['kata_file.ext'] = kata_file
 		@template_machine.placeholder_values['kata_file'] = @filename_formatter.without_extension kata_file

data/app/scheduler.rb

@@ -1,9 +1,10 @@
 class Scheduler
 
-  def initialize runner, view
+  def initialize runner, view, commands
     @runner = runner
 		@view = view
 		@last_action = ""
+		@commands = commands
   end
 
   def start
@@ -25,6 +26,11 @@ class Scheduler
 	def interrupt_kata
 		@view.show_kata_exit_message 
 		@last_action = @view.read_user_input.downcase
+		@commands.each do |command|
+			if @last_action == command.command_key
+				command.execute
+			end
+		end
 		if last_action_was_exit? then
 			@view.show_kata_upload_hint
 		end
@@ -42,8 +48,4 @@ class Scheduler
 		@last_action.start_with? 'e'
 	end
 
-	def last_action_was_upload?
-		@last_action.start_with? 'u'
-	end
-
 end

data/app/shell_wrapper.rb

@@ -73,7 +73,7 @@ class ShellWrapper
 	end
 		
 	def newest_dir_entry dir
-		Dir.new(dir).sort_by do |entry| 
+		real_dir_entries(dir).sort_by do |entry| 
 			complete_path = File.join dir, entry
 			File.mtime(complete_path)
 		end.last

data/app/start_command.rb

@@ -0,0 +1,37 @@
+class StartCommand
+	
+	def initialize shell, view, upload_command
+		@shell = shell
+		@view = view
+		@upload_command = upload_command
+	end
+	
+	def execute_from_shell params
+		start params[1], params[2]
+	end
+
+	def start command, file
+		unless command then @view.show_missing_command_argument_error "start", "shell_command"; return end
+		unless file then @view.show_missing_command_argument_error "start", "kata_file"; return end
+		command = expand_run_command command
+	  @view.show_start_kata command, file, framework_property
+	  dojo = Runner.new @shell, SessionIdGenerator.new
+	  dojo.file = file
+	  dojo.run_command = command
+	  scheduler = Scheduler.new dojo, @view, [@upload_command]
+	  scheduler.start
+	end
+	
+	def accepts_shell_command? command
+		command == 'start'
+	end
+	
+	def expand_run_command command
+		if command.end_with?(".sh") then
+			"bash #{command}"
+		else
+			command
+		end
+	end
+
+end

data/app/state_reader.rb

@@ -22,8 +22,7 @@ class StateReader
 	end
 
   def state_count
-	  dummy_dirs_current_and_parent = 2
-    Dir.new(@filename_formatter.session_dir @session_id).count - dummy_dirs_current_and_parent
+	  @shell.real_dir_entries(@filename_formatter.session_dir @session_id).count
   end
 
   def enough_states?

data/app/upload_command.rb

@@ -0,0 +1,57 @@
+require 'uploader'
+
+class UploadCommand
+
+	PROPERTY_FILENAME = '.meta'
+
+	attr_accessor :uploader
+
+	def initialize shell, view, hostname
+		@shell = shell
+		@view = view
+		@hostname = hostname
+		@uploader = Uploader.new(hostname, '', '')
+	end
+
+	def execute
+		upload nil, nil
+	end
+
+	def execute_from_shell params
+		upload params[1]
+	end
+
+	def upload session_directory, open_browser=true
+		formatter = FilenameFormatter.new
+		framework = framework_property
+		if not session_directory then
+			session_directory = formatter.session_dir @shell.newest_dir_entry(FilenameFormatter.codersdojo_workspace) 
+		end
+		@view.show_upload_start session_directory, @hostname, framework
+		@uploader.framework = framework
+		@uploader.session_dir = session_directory
+		upload_result = @uploader.upload
+		 @view.show_upload_result upload_result
+		url = upload_result.split.last
+		if open_browser then 
+			@shell.open_with_default_app url
+		end
+	end
+	
+	def command_key
+		'u'
+	end
+	
+	def accepts_shell_command? command
+		command == 'upload'
+	end
+	
+	def framework_property
+		properties['framework']
+	end
+
+	def properties
+	  @shell.read_properties PROPERTY_FILENAME
+	end
+	
+end

data/app/upload_no_open_command.rb

@@ -0,0 +1,19 @@
+class UploadNoOpenCommand
+	
+	def initialize upload_command
+		@upload_command = upload_command
+	end
+
+	def execute_from_shell params
+		upload params[1]
+	end
+
+	def upload session_directory
+		@upload_command.upload session_directory, false
+	end
+	
+	def accepts_shell_command? command
+		command == 'upload-no-open'
+	end
+	
+end

data/app/uploader.rb

@@ -4,11 +4,13 @@ require 'progress'
 require 'filename_formatter'
 require 'xml_element_extractor'
 require 'rest_client'
+require 'shell_wrapper'
 
 class Uploader
 
 	attr_reader :states
-
+	attr_accessor :framework
+	
   def initialize hostname, framework, session_dir, state_reader = StateReader.new(ShellWrapper.new)
 	  @states = []
 		@hostname = hostname
@@ -17,6 +19,10 @@ class Uploader
     @state_reader.session_dir = session_dir
   end
 
+	def session_dir= dir
+		@state_reader.session_dir = dir
+	end
+
   def upload
     return upload_kata_and_states if @state_reader.enough_states?
     return "You need at least two states"

data/templates/javascript.jspec/README

@@ -6,4 +6,4 @@ These files were created:
 Run run-endless.%sh% and start your kata. (On Mac/Linux you have to call ./run-endless.%sh%.)
 
 Assumptions:
-  - The whole kata source code is in the one %kata_file%.js.
+  - The whole kata source code is in the one spec.js.

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: codersdojo
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: false
   segments: 
   - 1
   - 2
-  - 8
-  version: 1.2.08
+  - 9
+  version: 1.2.09
 platform: ruby
 authors: 
 - CodersDojo-Team
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-28 00:00:00 +02:00
+date: 2011-05-05 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -62,8 +62,9 @@ files:
 - app/argument_parser.rb
 - app/codersdojo.rb
 - app/console_view.rb
-- app/controller.rb
 - app/filename_formatter.rb
+- app/generate_command.rb
+- app/help_command.rb
 - app/info_property_file.rb
 - app/progress.rb
 - app/property_file_missing_exception.rb
@@ -74,10 +75,13 @@ files:
 - app/shell_argument_exception.rb
 - app/shell_process.rb
 - app/shell_wrapper.rb
+- app/start_command.rb
 - app/state.rb
 - app/state_reader.rb
 - app/text_converter.rb
 - app/text_template_machine.rb
+- app/upload_command.rb
+- app/upload_no_open_command.rb
 - app/uploader.rb
 - app/xml_element_extractor.rb
 - templates/any/README

data/app/controller.rb

@@ -1,84 +0,0 @@
-require 'scheduler'
-require 'uploader'
-require 'filename_formatter'
-
-class Controller
-
-	def initialize shell, view, scaffolder, hostname
-		@property_filename = '.meta'
-		@shell = shell
-		@view = view
-		@scaffolder = scaffolder
-		@hostname = hostname
-		@filename_formatter = FilenameFormatter.new
-	end
-
-	def help command=nil
-		if command then
-			@view.show_detailed_help command.downcase
-		else
-			@view.show_help
-		end
-	end
-
-	def generate framework, kata_file
-		if not kata_file then
-			@view.show_missing_command_argument_error "setup", "kata_file"
-			return
-		end
-		begin
-			@scaffolder.scaffold framework, kata_file
-			@view.show "\n" + @shell.read_file("README")
-		rescue
-			@view.show_unknown_framework_error framework, @scaffolder.list_templates
-		end		
-	end
-
-	def start command, file
-		if not command or not file then
-			@view.show_missing_command_argument_error "start"
-			return
-		end
-	  @view.show_start_kata command, file, framework_property
-	  dojo = Runner.new @shell, SessionIdGenerator.new
-	  dojo.file = file
-	  dojo.run_command = command
-	  scheduler = Scheduler.new dojo, @view
-	  scheduler.start
-		if scheduler.last_action_was_upload? then
-			upload nil
-		end
-	end
-
-	# merge with 'upload_with_framework' when the framework parameter is removed
-	def upload session_directory, open_browser=true
-		upload_with_framework framework_property, session_directory, open_browser
-	end
-
-	# framework parameter is obsolete since client version 1.1.08 (08-feb-2011)
-	# it stays here for compatibility reasons and will be removed in the near future
-	def upload_with_framework framework, session_directory , open_browser=true
-		formatter = FilenameFormatter.new
-		if not session_directory then
-			session_directory = formatter.session_dir @shell.newest_dir_entry(FilenameFormatter.codersdojo_workspace) 
-		end
-		@view.show_upload_start session_directory, @hostname, framework
-	  uploader = Uploader.new @hostname, framework, session_directory
-		upload_result = uploader.upload
-	  @view.show_upload_result upload_result
-		url = upload_result.split.last
-		if open_browser then 
-			@shell.open_with_default_app url
-		end
-	end
-
-	def framework_property
-		properties['framework']
-	end
-
-	def properties
-	  @shell.read_properties @property_filename
-	end
-
-end
-