jumpstart 0.1.17 → 0.1.19

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Ian Alexander Wood (i0n)
+Copyright (c) 2010 Ian Alexander Wood (i0n)
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -0,0 +1,161 @@
+=JumpStart
+
+Jumpstart is a gem for quickly creating projects.
+It does this by running options from a YAML file that you can create, or you can let the gem do it for you.
+It's dead easy to do.
+
+==Features
+With jumpstart you can:
+
+* Run many terminal commands in a specific order
+* Create new projects of any type quickly from templates
+* Create files from three different kinds of templates:
+  * Whole templates. A like for like copy from the template to the new project.
+  * Append templates. The template is appended to a file generated by a terminal command (e.g. rails)
+  * Line templates. The template is inserted into a file generated by a terminal command at a specific line number.
+* Replace strings in the newly generated project with specified tags (like the project name)
+* Automatically configure local Nginx and hosts entries for a new project. (I'm using OS X so this is tailored for the Mac.)
+* Remove unwanted files that may have been created by a terminal command (e.g. rails)
+
+== Installation
+  gem install jumpstart
+
+Or you can clone this git repo:               
+  git://github.com/i0n/jumpstart.git
+Build jumpstart from the git repo's gemspec:  
+  gem build jumpstart.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.
+
+== Getting Started
+There are a couple of ways to use jumpstart.
+
+If you have already created a template and set it as your default, you can create a new project with a single command from the terminal. e.g. 
+  jumpstart my_new_project_name
+
+If you haven't created any templates yet, or you want to change one of the configuration options (which I'll get to), just call:
+  jumpstart 
+This will launch the jumpstart menu.
+
+==Example YAML files.
+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  
+  :install_command: rails  
+  :install_command_args: -d mysql -J -T  
+  :run_after_install_command:  
+    - rails g controller home  
+  :remove_files:  
+    - /app/views/layouts/application.html.erb  
+    - /public/index.html  
+    - /public/favicon.ico  
+    - /public/images/rails.png  
+  :run_after_jumpstart:  
+    - rake db:create  
+    - capify .  
+    - git init  
+    - git add .  
+    - git commit -q -v -a -m "Initial commit"  
+  :replace_strings:  
+    - :target_path: /config/deploy.rb  
+      :symbols:  
+        :project_name: name_of_my_app  
+        :remote_server: thoughtplant  
+    - :target_path: /config/environments/development.rb  
+      :symbols:  
+        :project_name: name_of_my_app  
+    - :target_path: /config/environments/test.rb  
+      :symbols:  
+        :project_name: name_of_my_app  
+    - :target_path: /config/environments/production.rb  
+      :symbols:  
+        :project_name: name_of_my_app  
+  :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.
+  
+  # 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.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+Copyright
+
+Copyright (c) 2010 i0n. See LICENSE for details.

data/config/jumpstart_setup.yml

@@ -1,3 +1,3 @@
 --- 
 :jumpstart_templates_path:
-:jumpstart_default_template_name: 
+:jumpstart_default_template_name:

data/config/jumpstart_version.yml

@@ -1,4 +1,4 @@
 --- 
-:jumpstart_version_patch: 17
 :jumpstart_version_major: 0
 :jumpstart_version_minor: 1
+:jumpstart_version_patch: 19

data/lib/jumpstart/base.rb

@@ -21,11 +21,14 @@ module JumpStart
       # setup for testing output
       @output = $stdout
       # set the name of the project from the first argument passed, or from the module instance variable JumpStart::Setup.default_template_name if no argument passed.
-      @project_name = args.shift.dup if args[0] != nil
-      if args[0] != nil
-        @template_name = args.shift.dup
-      elsif JumpStart::Setup.default_template_name != nil
-        @template_name = JumpStart::Setup.default_template_name
+      @project_name = args[0].dup unless args[0].nil?
+      @template_name = args[1].dup unless args[1].nil?
+      case
+      when args.nil?
+        @template_name = JumpStart::Setup.default_template_name unless JumpStart::Setup.default_template_name.nil?
+        jumpstart_menu
+      when args[0] != nil && args[1].nil?
+        @template_name = JumpStart::Setup.default_template_name unless JumpStart::Setup.default_template_name.nil?
       end
       # set instance variable @template_path as the directory to read templates from.
       @template_path = FileUtils.join_paths(JumpStart::Setup.templates_path, @template_name)
@@ -141,7 +144,6 @@ module JumpStart
       end
     end
 
-    # TODO FileUtils.pwd is not behaving as expected. find a way to set this.
     # Sets the install path to executing directory if @install_path varibale is nil or empty. This should result in projects being created in directory from which the jumpstart command was called, if the template specified does not set this option.
     # Checks the install path set in @install_path.
     # Checks that a directory with the same name as the project does not already exist in the install path.
@@ -151,7 +153,7 @@ module JumpStart
         puts "\nThe directory #{FileUtils.join_paths(@install_path, @project_name).red} already exists.\nAs this is the location you have specified for creating your new project jumpstart will now exit to avoid overwriting anything."
         exit_normal
       end
-      true
+      return true
     end
     
     # Creates a new blank template in whichever directory the default templates directory has been set to.
@@ -482,7 +484,6 @@ module JumpStart
       end
     end
     
-    # TODO needs more tests as nil values were slipping through
     # Removes files specified in templates YAML
     def remove_unwanted_files
       file_array = []
@@ -509,17 +510,16 @@ module JumpStart
         end
       end
     end
-    
-    # TODO Needs more tests as nil values slipped through before refactoring.
+
     # Looks for strings IN_CAPS that are specified for replacement in the templates YAML
     def check_for_strings_to_replace
       if @replace_strings.nil? || @replace_strings.empty?
-        false
+        return false
       else
         puts "\nChecking for strings to replace inside files...\n\n"
         @replace_strings.each do |file|
           if file[:target_path].nil? || file[:symbols].nil?
-            false
+            return false
           else
             puts "Target file: #{file[:target_path].green}\n"
             puts "Strings to replace:\n\n"
@@ -562,7 +562,7 @@ module JumpStart
           number = file_name.match(/_(\d+)\._\w*/)[1]
           number.to_i
         else
-          false
+          return false
         end
       end
 
@@ -570,9 +570,9 @@ module JumpStart
       # Append templates with the _l._ or _L._ prefix will return true.
       def remove_last_line?(file_name)
         if file_name.match(/_([lL]{1})\._{1}\w*/)
-          true
+          return true
         else
-          false
+          return false
         end
       end
       

data/test/jumpstart/test_base.rb

@@ -93,11 +93,11 @@ class TestJumpstartBase < Test::Unit::TestCase
         @input = input
         @output = output
         @template_name = "test_template_1"
-        set_config_file_options
         @install_path = "#{JumpStart::ROOT_PATH}/test/destination_dir"
       end
       @test_project_6.stubs(:exit_normal)
       @test_project_6.stubs(:exit_with_success)
+      @test_project_6.stubs(:jumpstart_menu)
     end
             
     teardown do
@@ -107,7 +107,7 @@ class TestJumpstartBase < Test::Unit::TestCase
     context "Tests for the JumpStart::Base#intialize instance method. \n" do
             
       should "set @jumpstart_template_path" do
-        assert_equal "#{JumpStart::ROOT_PATH}/test/test_jumpstart_templates", @test_project.instance_eval {JumpStart::Setup.templates_path}
+        assert_equal "#{JumpStart::ROOT_PATH}/test/test_jumpstart_templates", JumpStart::Setup.templates_path
       end
       
       should "set JumpStart::Setup.default_template_name" do
@@ -965,13 +965,17 @@ class TestJumpstartBase < Test::Unit::TestCase
       end
       
       should "run remove_unwanted_files method, remove files and return true." do
-        
         ["/file_with_extension.txt", "/file_without_extension"].each do |x| 
           FileUtils.touch("#{JumpStart::ROOT_PATH}/test/destination_dir/test_remove/test_remove_files#{x}")
         end
         assert @test_project.instance_eval {remove_unwanted_files}
       end
-            
+      
+      should "do nothing if passed nil" do
+        @test_project.instance_eval {@config_files = {:remove_files => nil}}
+        assert @test_project.instance_eval {remove_unwanted_files}
+      end
+      
     end
             
     context "Tests for the JumpStart::Base#run_scripts_from_yaml instance method.\n" do
@@ -1032,6 +1036,11 @@ class TestJumpstartBase < Test::Unit::TestCase
         assert !@test_project.instance_eval {check_for_strings_to_replace}
       end
       
+      should "return false if @replace_strings is populated with an empty entry." do
+        @test_project.instance_eval {@replace_strings = [{:target_path => nil, :symbols => nil}]}
+        assert !@test_project.instance_eval {check_for_strings_to_replace}
+      end
+      
     end
         
     context "Tests for the JumpStart::Base#exit_with_success instance method." do
@@ -1145,6 +1154,6 @@ class TestJumpstartBase < Test::Unit::TestCase
       end
       
     end
-                         
+                             
   end
 end

data/test/test_jumpstart.rb

@@ -19,6 +19,7 @@ class TestJumpstart < Test::Unit::TestCase
     end
   end
   
+  # TODO not sure why but shoulda/test-unit/mocha is loading things in a strange order which is messing up class_eval. Look to split tests for this area into seperate files to try and solve this problem.
   context "Tests for launching JumpStart with various configurations set" do
     
     context "JumpStart::Setup.templates_path and JumpStart::Setup.default_template_name are both set to nil as @jumpstart_setup_yaml is not loaded" do
@@ -119,7 +120,6 @@ class TestJumpstart < Test::Unit::TestCase
 
       should "set @install_path to executing directory when it is not set in the template and when passed a valid first and second argument. JumpStart::Setup.templates_path should be set to default." do
         @project = JumpStart::Base.new(["hello", "test_template_1"])
-        # FileUtils.stubs(:pwd)
         @project.stubs(:jumpstart_menu)
         @project.expects(:set_config_file_options)
         @project.expects(:lookup_existing_templates)
@@ -128,13 +128,10 @@ class TestJumpstart < Test::Unit::TestCase
         @project.expects(:check_template_path)
         @project.expects(:check_install_path)
         @project.expects(:jumpstart_menu).never
-        # FileUtils.expects(:pwd)
         @project.check_setup
-        # assert_equal "hello", @project.instance_variable_get(:@install_path)
       end      
       
     end
-    
+        
   end 
-  
 end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: jumpstart
 version: !ruby/object:Gem::Version 
-  hash: 57
   prerelease: false
   segments: 
   - 0
   - 1
-  - 17
-  version: 0.1.17
+  - 19
+  version: 0.1.19
 platform: ruby
 authors: 
 - Ian Alexander Wood (i0n)
@@ -19,33 +18,31 @@ date: 2010-05-29 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  name: shoulda
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
-  requirement: *id001
-  name: shoulda
-  prerelease: false
   type: :development
+  prerelease: false
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  name: mocha
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
-  requirement: *id002
-  name: mocha
-  prerelease: false
   type: :development
+  prerelease: false
+  version_requirements: *id002
 description: |-
   JumpStart is a script runner and template parser written in Ruby with Ruby projects in mind.
   That said it should function equally well for any project in any language where many actions need to be performed to setup a new project.
@@ -140,7 +137,7 @@ files:
 - test/test_jumpstart_templates/test_template_3/jumpstart_config/test_template_3.yml
 - LICENSE
 - Rakefile
-- README.md
+- README.rdoc
 has_rdoc: true
 homepage: http://github.com/i0n/jumpstart
 licenses: []
@@ -155,7 +152,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -164,7 +160,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 23
       segments: 
       - 1
       - 3

data/README.md

@@ -1,47 +0,0 @@
-#JumpStart
-
-Jumpstart is a gem for quickly creating projects.
-It does this by running options from a YAML file that you can create, or you can let the gem do it for you.
-It's dead easy to do.
-
-## Features
-With jumpstart you can:
-
-* Run many terminal commands in a specific order
-* Create new projects of any type quickly from templates
-* Create files from three different kinds of templates:
-  * **Whole templates**. A like for like copy from the template to the new project.
-  * **Append templates**. The template is appended to a file generated by a terminal command (e.g. rails)
-  * **Line templates**. The template is inserted into a file generated by a terminal command at a specific line number.
-* Replace strings in the newly generated project with specified tags (like the project name)
-* Automatically configure local Nginx and hosts entries for a new project. (I'm using OS X so this is tailored for the Mac.)
-* Remove unwanted files that may have been created by a terminal command (e.g. rails)
-
-# Installation
-`gem install jumpstart` should do it.
-- - - - -
-Or you can clone this git repo:               `git://github.com/i0n/jumpstart.git`  
-Build jumpstart from the git repo's gemspec:  `gem build jumpstart.gemspec`  
-Install the newly created gem:                `gem install jumpstart-WHATEVER_THE_CURRENT_VERSION_IS.gem`  
-
-## Getting Started
-There are a couple of ways to use jumpstart.
-
-If you have already created a template, you can create a new project with a single command from the terminal.  
-e.g. **`jumpstart my_new_project_name`**  
-
-If you haven't created any templates yet, or you want to change one of the configuration options (which I'll get to), just call **`jumpstart`** without any arguments. This will launch the jumpstart menu.
-
-###Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-**Copyright**
-
-Copyright (c) 2010 i0n. See LICENSE for details.