jumpstart 0.2.1 → 0.2.2

data/README.rdoc

@@ -27,7 +27,7 @@ Build jumpstart from the git repo's gemspec:
 Install the newly created gem:                
   gem install jumpstart-WHATEVER_THE_CURRENT_VERSION_IS.gem
 
-NOTE! If you install jumpstart using sudo then you will probably need to run jumpstart with it as well to grant writes to the YAML files in the gem.
+====NOTE! If you install jumpstart using sudo then you will probably need to run jumpstart with it as well to grant writes to the YAML files in the gem.
 
 == Getting Started
 There are a few ways to use jumpstart.
@@ -61,11 +61,81 @@ If the file you specify doesn't have as many lines as you said it would, whitesp
 
 == The JumpStart Menu
 
-== YAML Options
-
 == Task Execution Order
+Jumpstart tasks are executed in the order that the YAML options below are displayed.
+
+== YAML Options
+===:install_path:
+Can be omitted or left blank. 
+If :install_path: is omitted, the new project will be created in whatever directory you are in when you run the command. It is the path where the project directory will be created
+e.g. 
+  :install_path: /Users/i0n/Sites
+  
+===:install_command: 
+Can be omitted or left blank.
+The command that this template will run. The main shell command to create the project.
+e.g. 
+  :install_command: rails
+  
+===:install_command_args:
+Can be omitted or left blank.
+The arguments for :install_command. Broken into it's own value to allow the project name to be inserted between the two values.
+e.g. :install_command_args: -d mysql -J -T
+
+===:run_after_install_command:
+Can be omitted or left blank.
+Add extra commands that you want to run after the main install command, but before template generation has started.
+e.g. 
+  :run_after_install_command:
+    - rails g controller home
+    - rails g model home
+
+===:remove_files:
+Can be omitted or left blank.
+List files that you would like removed from the newly generated project.
+Paths use the newly created project folder as root.
+e.g.
+  :remove_files:
+    - /public/index.html
+    - /public/favicon.ico
+    - /public/images/rails.png
+
+===:run_after_jumpstart:
+Can be omitted or left blank.
+Add extra commands that you want to run after template generation has completed.
+e.g.
+  :run_after_jumpstart:
+    - rake db:create
+    - capify!
+    - git init
+    - git add .
+    - git commit -q -v -a -m "Initial commit"
+
+===:replace_strings:
+Can be omitted or left blank.
+List files that you would like to perform string substitution on. This can be useful for populating files such as a capistrano deploy.rb file.
+Paths use the newly created project folder as root.
+Any key:value pair can be used for substitution, simply add the key name in CAPS to the template file then specify the symbol key and value as in the example.
+
+Note! The value of :project_name is hard coded to be the same as the projects name, no matter the value entered in this config file. This helps with capistrano.
+e.g.
+  :replace_strings:
+    - :target_path: /config/deploy.rb
+      :symbols:
+        :project_name: name_of_my_app
+        :remote_server: thoughtplant
+    - :target_path: /another/config/file.rb
+      :symbols:
+        :project_name: name_of_my_app
+        :womble: uncle_bulgaria
+  
+===:local_nginx_conf:
+Can be omitted or left blank.
+If you would like jumpstart to configure your local nginx setup specify a path. Handy for rails.
+e.g.
+  :local_nginx_conf: /usr/local/nginx/conf/nginx.conf
 
-==Example YAML files
+==Example YAML
 Example 1: Sets up a new Rails project, creating MySQL Dbs and other options. Creates a home controller. Removes superfluous files created by Rails generator. Capifys the project. Creates a git repo and checks everything in to it. Replaces PROJECT_NAME string in capistrano deploy.rb with the name of the new project. Creates and appends to files generated by Rails to get everything ready to go straight away. Configures local Nginx environment. Not bad for one YAML!
   ---  
   :install_path: /Users/i0n/Sites  
@@ -107,79 +177,6 @@ Example 1: Sets up a new Rails project, creating MySQL Dbs and other options. Cr
         
   :local_nginx_conf: /usr/local/nginx/conf/nginx.conf  
   
-Example 2: A blank YAML with commenting to make it easy to see your options when creating templates.
-  ---
-  # The commands in a jumpstart config file are executed in the order displayed in this file.
-  
-  ## Can be omitted or left blank. If :install_path: is omitted, the new project will be created in whatever directory you are in when you run the command.
-  # The path to where the project directory will be created
-  # e.g. :install_path: /Users/i0n/Sites
-  :install_path:
-
-  ## Can be omitted or left blank.
-  # The command that this template will run. The main shell command to create the project.
-  # e.g. :install_command: rails
-  :install_command: 
-
-  ## Can be omitted or left blank.
-  # The arguments for :install_command. Broken into it's own value to allow the project name to be inserted between the two values.
-  # e.g. :install_command_args: -d mysql -J -T
-  :install_command_args:
-
-  ## Can be omitted or left blank.
-  # Add extra commands that you want to run after the main install command, but before template generation has started.
-  # e.g. 
-  # :run_after_install_command:
-  #   - rails g controller home
-  #   - rails g model home
-  :run_after_install_command:
-
-  ## Can be omitted or left blank.
-  # List files that you would like removed from the newly generated project.
-  # Paths use the newly created project folder as root.
-  # e.g.
-  # :remove_files:
-  #   - /public/index.html
-  #   - /public/favicon.ico
-  #   - /public/images/rails.png
-  :remove_files:
-
-  ## Can be omitted or left blank.
-  # Add extra commands that you want to run after template generation has completed.
-  # e.g.
-  # :run_after_jumpstart:
-  #   - rake db:create
-  #   - capify!
-  #   - git init
-  #   - git add .
-  #   - git commit -q -v -a -m "Initial commit"
-  :run_after_jumpstart:
-
-  ## Can be omitted or left blank.
-  # List files that you would like to perform string substitution on. This can be useful for populating files such as a capistrano deploy.rb file.
-  # Paths use the newly created project folder as root.
-  # Any key:value pair can be used for substitution, simply add the key name in CAPS to the template file then specify the symbol key and value as in the example.
-  # Note! The value of :project_name is hard coded to be the same as the projects name, no matter the value entered in this config file. This helps with capistrano.
-  # e.g.
-  # :replace_strings:
-  #   - :target_path: /config/deploy.rb
-  #     :symbols:
-  #       :project_name: name_of_my_app
-  #       :remote_server: thoughtplant
-  #   - :target_path: /another/config/file.rb
-  #     :symbols:
-  #       :project_name: name_of_my_app
-  #       :womble: uncle_bulgaria
-  :replace_strings:
-    - :target_path:
-      :symbols:
-  
-  ## Can be omitted or left blank.
-  # If you would like jumpstart to configure your local nginx setup specify a path. Handy for rails.
-  # e.g.
-  # :local_nginx_conf: /usr/local/nginx/conf/nginx.conf
-  :local_nginx_conf:
-  
 ==Note on Patches/Pull Requests
  
 * Fork the project.

data/config/jumpstart_version.yml

@@ -1,4 +1,4 @@
 --- 
 :jumpstart_version_major: 0
 :jumpstart_version_minor: 2
-:jumpstart_version_patch: 1
+:jumpstart_version_patch: 2

data/lib/jumpstart/base.rb

@@ -110,7 +110,13 @@ module JumpStart
     # Makes sure that the chosen project name is suitable. (Not nil or empty, at least 3 characters long, and starts with a letter or a number.) 
     # Returns with the value of @project_name
     def check_project_name
-      if @project_name.nil? || @project_name.empty?
+      if @project_name == "b"
+        @project_name = nil
+        jumpstart_menu
+      elsif @project_name == "x"
+        @project_name = nil
+        exit_normal
+      elsif @project_name.nil? || @project_name.empty?
         puts "\n  Enter a name for your project.".yellow
         @project_name = gets.chomp.strip
         check_project_name
@@ -215,7 +221,7 @@ module JumpStart
       unless @existing_templates.nil? || @existing_templates.empty?
         @existing_templates.each do |t|
           count += 1
-          puts "  #{count.to_s.yellow} #{t}"
+          puts "  #{count.to_s.yellow} #{t.green}"
         end
       end
       puts "\n  b".yellow + " Back to main menu."
@@ -241,6 +247,7 @@ module JumpStart
         exit_normal
       else
         puts "That command hasn't been understood. Try again!".red
+        new_project_from_template_options
       end
     end
     
@@ -253,6 +260,8 @@ module JumpStart
       @existing_templates.each do |x|
         puts "  #{x.green}\n"
       end
+      puts "\n  b".yellow + " Back to main menu."
+      puts "\n  x".yellow + " Exit jumpstart\n\n"
       new_template_options
     end
 
@@ -262,6 +271,10 @@ module JumpStart
       puts "\n  Enter a unique name for the new template.\n".yellow
       input = gets.chomp.strip
       case
+      when input == "b"
+        jumpstart_menu
+      when input == "x"
+        exit_normal        
       when @existing_templates.include?(input)
         puts "  A template of the name ".red + input.red_bold + " already exists.".red
         new_template_options
@@ -282,11 +295,11 @@ module JumpStart
     # Displays output for the "jumpstart default template options menu"
     def set_default_template_menu
       puts "\n\n******************************************************************************************************************************************\n\n"
-      puts "  JUMPSTART DEFAULT TEMPLATE OPTIONS\n\n".purple
+      puts "  SELECT A DEFAULT JUMPSTART TEMPLATE\n\n".purple
       count = 0
       @existing_templates.each do |t|
         count += 1
-        puts "  #{count.to_s.yellow} #{t}"
+        puts "  #{count.to_s.yellow} #{t.green}"
       end
       puts "\n  b".yellow + " Back to main menu.\n\n"
       puts "  x".yellow + " Exit jumpstart\n\n"
@@ -301,7 +314,7 @@ module JumpStart
       when input.to_i <= @existing_templates.count && input.to_i > 0
         JumpStart.default_template_name = @existing_templates[(input.to_i - 1)]
         JumpStart.dump_jumpstart_setup_yaml
-        puts "  The default jumpstart template has been set to: #{JumpStart.default_template_name.green}"
+        puts "  The default jumpstart template has been set to: ".green + JumpStart.default_template_name.green_bold
         jumpstart_menu
       when input == "b"
         jumpstart_menu
@@ -330,6 +343,7 @@ module JumpStart
       input = gets.chomp.strip
       case
       when input == "1"
+        puts "Please enter the absolute path for the directory that you would like to contain your jumpstart templates.\n".yellow
         set_templates_dir
       when input == "2"
         reset_templates_dir_to_default_check
@@ -347,12 +361,15 @@ module JumpStart
     # Copies templates in the existing template dir to the new location.
     # The folder specified must not exist yet, but it's parent should.
     def set_templates_dir
-      puts "Please enter the absolute path for the directory that you would like to contain your jumpstart templates."
       input = gets.chomp.strip
       root_path = input.sub(/\/\w*\/*$/, '')
       case
+      when input == "b"
+        jumpstart_menu
+      when input == "x"
+        exit_normal
       when File.directory?(input)
-        puts "A directory of that name already exists, please choose a directory that does not exist."
+        puts "A directory of that name already exists, please choose a directory that does not exist.".red
         set_templates_dir
       when File.directory?(root_path)
         begin
@@ -369,13 +386,16 @@ module JumpStart
         rescue
           puts "It looks like you do not have the correct permissions to create a directory in #{root_path.red}"
         end
+      else
+        puts "Couldn't find a directory of that name. Try again.".red
+        set_templates_dir
       end
     end
     
     # Checks to see if the JumpStart template directory should be reset to the default location. (within the gem.)
     def reset_templates_dir_to_default_check
       if JumpStart.templates_path == "#{ROOT_PATH}/jumpstart_templates"
-        puts "  You do not need to reset the jumpstart templates directory, it is already set to: #{ROOT_PATH}/jumpstart_templates\n\n".red
+        puts "  You do not need to reset the jumpstart templates directory, it is already set to: #{ROOT_PATH}/jumpstart_templates".red
         templates_dir_menu
       else  
         puts "  Resetting the jumpstart templates directory to the default: #{ROOT_PATH}/jumpstart_templates\n\n"

data/test/jumpstart/test_base.rb

@@ -456,7 +456,7 @@ class TestJumpstartBase < Test::Unit::TestCase
         @test_project.expects(:new_project_from_template_options).once
         @test_project.instance_variable_set(:@existing_templates, %w[project1 project2 project3])
         @test_project.instance_eval {new_project_from_template_menu}
-        assert_equal "\n\n******************************************************************************************************************************************\n\n\e[1m\e[35m  CREATE A NEW JUMPSTART PROJECT FROM AN EXISTING TEMPLATE\n\n\e[0m\n  Type a number for the template that you want.\n\n  \e[1m\e[33m1\e[0m project1\n  \e[1m\e[33m2\e[0m project2\n  \e[1m\e[33m3\e[0m project3\n\e[1m\e[33m\n  b\e[0m Back to main menu.\n\e[1m\e[33m\n  x\e[0m Exit jumpstart\n\n******************************************************************************************************************************************\n\n", @test_project.output.string
+        assert_equal "\n\n******************************************************************************************************************************************\n\n\e[1m\e[35m  CREATE A NEW JUMPSTART PROJECT FROM AN EXISTING TEMPLATE\n\n\e[0m\n  Type a number for the template that you want.\n\n  \e[1m\e[33m1\e[0m \e[32mproject1\e[0m\n  \e[1m\e[33m2\e[0m \e[32mproject2\e[0m\n  \e[1m\e[33m3\e[0m \e[32mproject3\e[0m\n\e[1m\e[33m\n  b\e[0m Back to main menu.\n\e[1m\e[33m\n  x\e[0m Exit jumpstart\n\n******************************************************************************************************************************************\n\n", @test_project.output.string
         assert_equal ['project1', 'project2', 'project3'], @test_project.instance_variable_get(:@existing_templates)
       end
       
@@ -492,10 +492,11 @@ class TestJumpstartBase < Test::Unit::TestCase
         @test_project.instance_eval {new_project_from_template_options}        
       end
       
+      # Raises a NoMethodError in the test as loop is not stopped by user input and cannot perform chomp on nil.
       should "output a message saying that the input has not been understood for any other input" do
         @test_project.instance_variable_set(:@input, StringIO.new("blarg\n"))
-        @test_project.instance_eval {new_project_from_template_options}        
-        assert_equal "\e[31mThat command hasn't been understood. Try again!\e[0m\n", @test_project.output.string
+        assert_raises(NoMethodError) {@test_project.instance_eval {new_project_from_template_options}}
+        # assert_equal "\e[31mThat command hasn't been understood. Try again!\e[0m\n", @test_project.output.string
       end
       
     end
@@ -509,7 +510,7 @@ class TestJumpstartBase < Test::Unit::TestCase
         @test_project.expects(:lookup_existing_templates).once
         @test_project.expects(:new_template_options).once
         @test_project.instance_eval {new_template_menu}
-        assert_equal "\n\n******************************************************************************************************************************************\n\n\e[1m\e[35m  CREATE A NEW JUMPSTART TEMPLATE\n\e[0m\n  Existing templates:\n  \e[32mproject1\e[0m\n  \e[32mproject2\e[0m\n  \e[32mproject3\e[0m\n", @test_project.output.string
+        assert_equal "\n\n******************************************************************************************************************************************\n\n\e[1m\e[35m  CREATE A NEW JUMPSTART TEMPLATE\n\e[0m\n  Existing templates:\n  \e[32mproject1\e[0m\n  \e[32mproject2\e[0m\n  \e[32mproject3\e[0m\n\e[1m\e[33m\n  b\e[0m Back to main menu.\n\e[1m\e[33m\n  x\e[0m Exit jumpstart\n\n", @test_project.output.string
         assert_equal %w[project1 project2 project3], @test_project.instance_variable_get(:@existing_templates)
       end
       
@@ -559,7 +560,7 @@ class TestJumpstartBase < Test::Unit::TestCase
         @test_project.stubs(:set_default_template_options)
         @test_project.expects(:set_default_template_options).once
         @test_project.instance_eval {set_default_template_menu}
-        assert_equal "\n\n******************************************************************************************************************************************\n\n\e[1m\e[35m  JUMPSTART DEFAULT TEMPLATE OPTIONS\n\n\e[0m\n  \e[1m\e[33m1\e[0m one\n  \e[1m\e[33m2\e[0m two\n  \e[1m\e[33m3\e[0m three\n\e[1m\e[33m\n  b\e[0m Back to main menu.\n\n\e[1m\e[33m  x\e[0m Exit jumpstart\n\n******************************************************************************************************************************************\n\n", @test_project.output.string
+        assert_equal "\n\n******************************************************************************************************************************************\n\n\e[1m\e[35m  SELECT A DEFAULT JUMPSTART TEMPLATE\n\n\e[0m\n  \e[1m\e[33m1\e[0m \e[32mone\e[0m\n  \e[1m\e[33m2\e[0m \e[32mtwo\e[0m\n  \e[1m\e[33m3\e[0m \e[32mthree\e[0m\n\e[1m\e[33m\n  b\e[0m Back to main menu.\n\n\e[1m\e[33m  x\e[0m Exit jumpstart\n\n******************************************************************************************************************************************\n\n", @test_project.output.string
       end
       
     end
@@ -672,7 +673,7 @@ class TestJumpstartBase < Test::Unit::TestCase
         JumpStart.expects(:dump_jumpstart_setup_yaml).once
         @test_project.expects(:jumpstart_menu).once
         @test_project.instance_eval {set_templates_dir}
-        assert_equal "Please enter the absolute path for the directory that you would like to contain your jumpstart templates.\n\nCopying existing templates to /Users/i0n/Sites/jumpstart/test/destination_dir/a_name_that_does_not_exist\n\e[32m\nTransfer complete!\e[0m\n", @test_project.output.string
+        assert_equal "\nCopying existing templates to /Users/i0n/Sites/jumpstart/test/destination_dir/a_name_that_does_not_exist\n\e[32m\nTransfer complete!\e[0m\n", @test_project.output.string
         assert File.exists?("#{JumpStart::ROOT_PATH}/test/destination_dir/a_name_that_does_not_exist/test_template_1/jumpstart_config/test_template_1.yml")
       end
       
@@ -689,7 +690,7 @@ class TestJumpstartBase < Test::Unit::TestCase
         JumpStart.templates_path = "#{JumpStart::ROOT_PATH}/jumpstart_templates"
         @test_project.expects(:templates_dir_menu).once
         @test_project.instance_eval {reset_templates_dir_to_default_check}
-        assert_equal "\e[31m  You do not need to reset the jumpstart templates directory, it is already set to: /Users/i0n/Sites/jumpstart/jumpstart_templates\n\n\e[0m\n", @test_project.output.string
+        assert_equal "\e[31m  You do not need to reset the jumpstart templates directory, it is already set to: /Users/i0n/Sites/jumpstart/jumpstart_templates\e[0m\n", @test_project.output.string
       end
       
       should "run reset_templates_dir_to_default_set if the current JumpStart.templates_path is not the default." do

data/test/test_jumpstart_with_no_global_defaults.rb

@@ -5,7 +5,10 @@ class TestJumpStartWithNoGlobalDefaults < Test::Unit::TestCase
   context "JumpStart::Setup.templates_path and JumpStart::Setup.default_template_name are both set to nil as @jumpstart_setup_yaml is not loaded" do
   
     setup do
-      JumpStart.module_eval {@jumpstart_setup_yaml = nil}
+      JumpStart.module_eval do 
+        @jumpstart_setup_yaml = nil
+        @default_template_name = nil
+      end
       @project.stubs(:jumpstart_menu)
     end
   

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Ian Alexander Wood (i0n)