jumpstart 0.2.2 → 0.2.3

data/Rakefile

@@ -55,6 +55,11 @@ task :version do
   puts "\nJumpStart Version: #{JumpStart::VERSION}"
 end
 
+task :existing_templates do
+  puts "\n Existing JumpStart templates:"
+  puts JumpStart.existing_templates
+end
+
 def git_actions
   Dir.chdir("#{JumpStart::ROOT_PATH}")
   system "git add ."

data/config/jumpstart_version.yml

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

data/lib/jumpstart.rb

@@ -4,6 +4,17 @@ require 'find'
 require 'fileutils'
 require 'yaml'
 require 'rbconfig'
+require 'jumpstart/base'
+require 'jumpstart/filetools'
+require 'jumpstart/stringtools'
+
+# Included as a module so that extension methods will be better defined in class/module chain.
+FileUtils.extend JumpStart::FileTools
+
+# Included as a module so that extension methods will be better defined in class/module chain.
+class String
+  include JumpStart::StringTools
+end
 
 # Sets up coloured terminal output in windows
 if RbConfig::CONFIG['host_os'] =~ /mswin|windows|cygwin|mingw32/
@@ -23,10 +34,6 @@ module JumpStart
   IGNORE_DIRS = ['.','..']
   LAUNCH_PATH = FileUtils.pwd
   
-  require 'jumpstart/base'
-  require 'jumpstart/filetools'
-  require 'jumpstart/stringtools'
-  
   @jumpstart_setup_yaml = YAML.load_file("#{JumpStart::CONFIG_PATH}/jumpstart_setup.yml")
   @jumpstart_version_yaml = YAML.load_file("#{JumpStart::CONFIG_PATH}/jumpstart_version.yml")
 
@@ -34,18 +41,10 @@ module JumpStart
   @version_minor = @jumpstart_version_yaml[:jumpstart_version_minor]
   @version_patch = @jumpstart_version_yaml[:jumpstart_version_patch]
 
-  # sets the default template to use if it has not been passed as an argument.
-  # Set as a module instance variable.
-  @default_template_name = @jumpstart_setup_yaml[:jumpstart_default_template_name]
-
-  # The path to the jumpstart templates directory. 
-  # Set as a module instance variable.  
-  @templates_path = @jumpstart_setup_yaml[:jumpstart_templates_path]
-  
   class << self
   
     attr_accessor :default_template_name, :version_major, :version_minor, :version_patch
-  
+    
     # Set the jumpstart templates path back to default if it has not been set
     def templates_path
       if @templates_path.nil? || @templates_path.empty?
@@ -59,6 +58,22 @@ module JumpStart
       @templates_path = value
     end
       
+    # TODO JumpStart#lookup_existing_templates class instance method needs tests
+    def existing_templates
+      templates = []
+      template_dirs = Dir.entries(templates_path) - IGNORE_DIRS
+      template_dirs.each do |x|
+        if File.directory?(FileUtils.join_paths(templates_path, x))
+          if Dir.entries(FileUtils.join_paths(templates_path, x)).include? "jumpstart_config"
+            if File.exists?(FileUtils.join_paths(templates_path, x, '/jumpstart_config/', "#{x}.yml"))
+              templates << x
+            end
+          end
+        end
+      end
+      templates
+    end
+      
     # Method for writing to config/jumpstart_setup.yml
     def dump_jumpstart_setup_yaml
       File.open( "#{JumpStart::CONFIG_PATH}/jumpstart_setup.yml", 'w' ) do |out|
@@ -113,13 +128,17 @@ module JumpStart
     
   end
   
-end
-
-# Included as a module so that extension methods will be better defined in class/module chain.
-FileUtils.extend JumpStart::FileTools
-
-# Included as a module so that extension methods will be better defined in class/module chain.
-class String
-  include JumpStart::StringTools
+  # sets the default template to use if it has not been passed as an argument.
+  # Set as a module instance variable.
+  if !@jumpstart_setup_yaml[:jumpstart_default_template_name].nil?
+    @default_template_name = @jumpstart_setup_yaml[:jumpstart_default_template_name] if existing_templates.include?(@jumpstart_setup_yaml[:jumpstart_default_template_name])
+  end
+  
+  # The path to the jumpstart templates directory. 
+  # Set as a module instance variable.  
+  if !@jumpstart_setup_yaml[:jumpstart_templates_path].nil?
+    @templates_path = @jumpstart_setup_yaml[:jumpstart_templates_path] if Dir.exists?(@jumpstart_setup_yaml[:jumpstart_templates_path]) 
+  end
+  
 end
 

data/lib/jumpstart/base.rb

@@ -52,28 +52,12 @@ module JumpStart
     # Pre-install project configuration checking.
     def check_setup
       set_config_file_options
-      lookup_existing_templates
       check_project_name
       check_template_name
       check_template_path
       check_install_path
     end
     
-    # set up instance variable containing an array that will be populated with existing jumpstart templates
-    def lookup_existing_templates
-      @existing_templates = []
-      template_dirs = Dir.entries(JumpStart.templates_path) - IGNORE_DIRS
-      template_dirs.each do |x|
-        if File.directory?(FileUtils.join_paths(JumpStart.templates_path, x))
-          if Dir.entries(FileUtils.join_paths(JumpStart.templates_path, x)).include? "jumpstart_config"
-            if File.exists?(FileUtils.join_paths(JumpStart.templates_path, x, '/jumpstart_config/', "#{x}.yml"))
-              @existing_templates << x
-            end
-          end
-        end
-      end
-    end
-    
     # Runs the configuration, generating the new project from the chosen template.
     def start
       puts "\n******************************************************************************************************************************************\n\n"
@@ -193,7 +177,6 @@ module JumpStart
     
     # Captures user input for the main jumpstart menu and calls the appropriate method
     def jumpstart_menu_options
-      lookup_existing_templates
       input = gets.chomp.strip
       case
       when input == "1"
@@ -218,8 +201,8 @@ module JumpStart
       puts "  CREATE A NEW JUMPSTART PROJECT FROM AN EXISTING TEMPLATE\n\n".purple
       puts "  Type a number for the template that you want.\n\n"
       count = 0
-      unless @existing_templates.nil? || @existing_templates.empty?
-        @existing_templates.each do |t|
+      unless JumpStart.existing_templates.empty?
+        JumpStart.existing_templates.each do |t|
           count += 1
           puts "  #{count.to_s.yellow} #{t.green}"
         end
@@ -235,8 +218,8 @@ module JumpStart
     def new_project_from_template_options
       input = gets.chomp.strip
       case
-      when input.to_i <= @existing_templates.count && input.to_i > 0
-        @template_name = @existing_templates[(input.to_i - 1)]
+      when input.to_i <= JumpStart.existing_templates.count && input.to_i > 0
+        @template_name = JumpStart.existing_templates[(input.to_i - 1)]
         check_project_name
         project = JumpStart::Base.new([@project_name, @template_name])
         project.check_setup
@@ -256,9 +239,10 @@ module JumpStart
       puts "\n\n******************************************************************************************************************************************\n\n"
       puts "  CREATE A NEW JUMPSTART TEMPLATE\n".purple
       puts "  Existing templates:\n"
-      lookup_existing_templates
-      @existing_templates.each do |x|
-        puts "  #{x.green}\n"
+      unless JumpStart.existing_templates.nil?
+        JumpStart.existing_templates.each do |x|
+          puts "  #{x.green}\n"
+        end
       end
       puts "\n  b".yellow + " Back to main menu."
       puts "\n  x".yellow + " Exit jumpstart\n\n"
@@ -275,7 +259,7 @@ module JumpStart
         jumpstart_menu
       when input == "x"
         exit_normal        
-      when @existing_templates.include?(input)
+      when JumpStart.existing_templates.include?(input)
         puts "  A template of the name ".red + input.red_bold + " already exists.".red
         new_template_options
       when input.length < 3
@@ -297,9 +281,11 @@ module JumpStart
       puts "\n\n******************************************************************************************************************************************\n\n"
       puts "  SELECT A DEFAULT JUMPSTART TEMPLATE\n\n".purple
       count = 0
-      @existing_templates.each do |t|
-        count += 1
-        puts "  #{count.to_s.yellow} #{t.green}"
+      unless JumpStart.existing_templates.nil?
+        JumpStart.existing_templates.each do |t|
+          count += 1
+          puts "  #{count.to_s.yellow} #{t.green}"
+        end
       end
       puts "\n  b".yellow + " Back to main menu.\n\n"
       puts "  x".yellow + " Exit jumpstart\n\n"
@@ -311,8 +297,8 @@ module JumpStart
     def set_default_template_options
       input = gets.chomp.strip
       case
-      when input.to_i <= @existing_templates.count && input.to_i > 0
-        JumpStart.default_template_name = @existing_templates[(input.to_i - 1)]
+      when input.to_i <= JumpStart.existing_templates.count && input.to_i > 0
+        JumpStart.default_template_name = JumpStart.existing_templates[(input.to_i - 1)]
         JumpStart.dump_jumpstart_setup_yaml
         puts "  The default jumpstart template has been set to: ".green + JumpStart.default_template_name.green_bold
         jumpstart_menu

data/test/jumpstart/test_base.rb

@@ -161,13 +161,11 @@ class TestJumpstartBase < Test::Unit::TestCase
       
       should "run contained methods" do
         @test_project_4.stubs(:set_config_file_options).returns("set_config_file_options")
-        @test_project_4.stubs(:lookup_existing_templates).returns("lookup_existing_templates")
         @test_project_4.stubs(:check_project_name).returns("check_project_name")
         @test_project_4.stubs(:check_template_name).returns("check_template_name")
         @test_project_4.stubs(:check_template_path).returns("check_template_path")
         @test_project_4.stubs(:check_install_path).returns("check_install_path")
         @test_project_4.expects(:set_config_file_options).once
-        @test_project_4.expects(:lookup_existing_templates).once
         @test_project_4.expects(:check_project_name).once
         @test_project_4.expects(:check_template_name).once
         @test_project_4.expects(:check_template_path).once
@@ -176,16 +174,7 @@ class TestJumpstartBase < Test::Unit::TestCase
       end
       
     end
-    
-    context "Tests for the JumpStart::Base#lookup_existing_projects instance method. \n" do
-      
-      should "run lookup_existing_projects method and return an array of existing templates" do
-        @test_project.lookup_existing_templates
-        assert_equal %w[test_template_1 test_template_2 test_template_3], @test_project.instance_eval {@existing_templates}
-      end
-            
-    end
-    
+        
     context "Tests for the JumpStart::Base#start instance method. \n" do
             
       should "run the contained methods" do
@@ -398,7 +387,6 @@ class TestJumpstartBase < Test::Unit::TestCase
     context "Tests for the JumpStart::Base#jumpstart_menu_options instance method. \n" do
       
       setup do
-        @test_project.stubs(:lookup_existing_templates)
         @test_project.stubs(:new_project_from_template_menu)
         @test_project.stubs(:new_template_menu)
         @test_project.stubs(:set_default_template_menu)
@@ -454,10 +442,8 @@ class TestJumpstartBase < Test::Unit::TestCase
       should "display options and run new_project_from_template_options" do
         @test_project.stubs(:new_project_from_template_options)
         @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 \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)
+        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[32mtest_template_1\e[0m\n  \e[1m\e[33m2\e[0m \e[32mtest_template_2\e[0m\n  \e[1m\e[33m3\e[0m \e[32mtest_template_3\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
       end
       
     end
@@ -466,7 +452,6 @@ class TestJumpstartBase < Test::Unit::TestCase
       
       setup do
         @test_project.stubs(:jumpstart_menu)
-        @test_project.instance_eval {lookup_existing_templates}
       end
       
       # TODO Look into testing this method in a different way. The fact that a new class object is instantiated makes it difficult to test with mocha.
@@ -504,14 +489,11 @@ class TestJumpstartBase < Test::Unit::TestCase
     context "Tests for the JumpStart::Base#new_template_menu instance method." do
       
       should "display output and call new_template_options" do
-        @test_project.stubs(:lookup_existing_templates)
         @test_project.stubs(:new_template_options)
-        @test_project.instance_variable_set(:@existing_templates, %w[project1 project2 project3])
-        @test_project.expects(:lookup_existing_templates).once
+        JumpStart.expects(: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\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)
+        assert_equal "\n\n******************************************************************************************************************************************\n\n\e[1m\e[35m  CREATE A NEW JUMPSTART TEMPLATE\n\e[0m\n  Existing templates:\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
       end
       
     end
@@ -519,14 +501,13 @@ class TestJumpstartBase < Test::Unit::TestCase
     context "Tests for the JumpStart::Base#new_template_options instance method." do
       
       setup do
-        JumpStart.templates_path = "#{JumpStart::ROOT_PATH}/test/destination_dir"
+        # JumpStart.templates_path = "#{JumpStart::ROOT_PATH}/test/destination_dir"
         @test_project.stubs(:jumpstart_menu).returns("jumpstart_menu")
-        @test_project.instance_variable_set(:@existing_templates, %w[one two three])
       end
       
       # Due to the recursive nature of this code, the only successful way to test is to check for the NoMethodError that is raised when the method is called for a second time, this time with @input as nil. I'd be interested to find another way to test this.
       should "ask for another template name if the name given is already taken " do
-        @test_project.instance_variable_set(:@input, StringIO.new("one\n"))
+        @test_project.instance_variable_set(:@input, StringIO.new("test_template_1\n"))
         assert_raises(NoMethodError) {@test_project.instance_eval {new_template_options}}
       end
       
@@ -545,22 +526,22 @@ class TestJumpstartBase < Test::Unit::TestCase
       should "create a new template in the jumpstart templates directory if the name given is valid." do
         @test_project.instance_variable_set(:@input, StringIO.new("four\n"))
         @test_project.instance_eval {new_template_options}
-        assert File.exists?("#{JumpStart::ROOT_PATH}/test/destination_dir/four/jumpstart_config/four.yml")
+        assert File.exists?("#{JumpStart::ROOT_PATH}/test/test_jumpstart_templates/four/jumpstart_config/four.yml")
         original_file_contents = IO.read("#{JumpStart::ROOT_PATH}/source_templates/template_config.yml")
-        created_file_contents = IO.read("#{JumpStart::ROOT_PATH}/test/destination_dir/four/jumpstart_config/four.yml")
+        created_file_contents = IO.read("#{JumpStart::ROOT_PATH}/test/test_jumpstart_templates/four/jumpstart_config/four.yml")
         assert_equal original_file_contents, created_file_contents
+        FileUtils.remove_dir("#{JumpStart::ROOT_PATH}/test/test_jumpstart_templates/four")
       end
       
     end
     
     context "Tests for the JumpStart::Base#set_default_template_menu instance method." do
             
-      should "display menu containing contents of @existing_templates" do
-        @test_project.instance_variable_set(:@existing_templates, %w[one two three])
+      should "display menu containing contents of JumpStart.existing_templates" do
         @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  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
+        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[32mtest_template_1\e[0m\n  \e[1m\e[33m2\e[0m \e[32mtest_template_2\e[0m\n  \e[1m\e[33m3\e[0m \e[32mtest_template_3\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
@@ -570,7 +551,7 @@ class TestJumpstartBase < Test::Unit::TestCase
       setup do
         @test_project.stubs(:jumpstart_menu)
         JumpStart.stubs(:dump_jumpstart_setup_yaml)
-        @test_project.instance_variable_set(:@existing_templates, %w[template1 template2 template3])
+        JumpStart.templates_path = "#{JumpStart::ROOT_PATH}/test/test_jumpstart_templates"
         JumpStart.default_template_name = "temp_default"
       end
       
@@ -579,7 +560,7 @@ class TestJumpstartBase < Test::Unit::TestCase
         @test_project.expects(:jumpstart_menu).once
         JumpStart.expects(:dump_jumpstart_setup_yaml).once
         @test_project.instance_eval {set_default_template_options}
-        assert_equal "template1", JumpStart.default_template_name
+        assert_equal "test_template_1", JumpStart.default_template_name
       end
       
       should "go back to the main jumpstart menu if 'b' is entered." do

data/test/test_jumpstart.rb

@@ -38,6 +38,22 @@ class TestJumpstart < Test::Unit::TestCase
     
   end
   
+  context "Tests for the JumpStart#existing_projects class method. \n" do
+    
+    setup do
+      JumpStart.templates_path = "#{JumpStart::ROOT_PATH}/test/test_jumpstart_templates"
+    end
+    
+    teardown do
+      JumpStart.templates_path = nil
+    end
+    
+    should "run existing_projects method and return an array of existing templates" do
+      assert_equal %w[test_template_1 test_template_2 test_template_3], JumpStart.existing_templates
+    end
+          
+  end
+  
   context "Tests for the JumpStart#dump_jumpstart_setup_yaml class method." do      
     should "call File.open and Yaml.dump for jumpstart_setup.yml" do
       YAML.stubs(:dump)

data/test/test_jumpstart_with_default_template_set.rb

@@ -55,7 +55,6 @@ class TestJumpStartWithDefaultTemplateSet < Test::Unit::TestCase
       @project = JumpStart::Base.new(["hello", "test_template_1"])
       @project.stubs(:jumpstart_menu)
       @project.expects(:set_config_file_options)
-      @project.expects(:lookup_existing_templates)
       @project.expects(:check_project_name)
       @project.expects(:check_template_name)
       @project.expects(:check_template_path)

metadata

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