jumpstart 0.5.4 → 0.6.0

data/README.rdoc

@@ -1,15 +1,27 @@
 =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.
+==Quick! No time! Dinner burning! Tell me everything in three sentences!
+* JumpStart is a gem for quickly creating projects just the way you want them.
+* It uses YAML and your custom template files to automate all of that new project creation and configuration hoo-ha.
+* It's dead easy to do.    
+
+==Spiel
+Are you:
+* Tired of customising newly created framework projects to get them just the way you want them?
+* On a holy quest for the almighty power to create any kind of project with a single command?    
+* Dancing like MC Hammer in anticipation of a solution to starting framework-less projects with ease?    
+* Offering to sell your granny for the opportunity to store all of your project templates in one handy git-able directory structure?    
+* Frothing at the mouth for an easy command line way to create, copy, move or duplicate these templates?    
+* If so you are in luck my friend. Have some Jumpstart!    
+
+==Why?
+Despite the many cool generators for a typical framework based project, there are always things that I want to set up differently. I figure that generated code will constantly change. With that in mind, the best way to control the creation of genuinely unique project configurations is to manipulate the files that the generators create. This is what JumpStart does, as well as some other cool stuff to avoid doing the same tedious setup dance over and over again.
+I also wanted one place to keep my setup templates for all kinds of different projects. I might want to create a Ruby Gem in a certain way, or a Sinatra app. I also like the idea of all of my templates residing in one source controlled space.
 
 ==Use Case
-Despite the many cool generators etc for a typical framework based project, there are always things that I wanted set up differently when starting a new Rails/Sinatra/(other cool framework) project. I figured that the way that these tools create code, and what that code is, will constantly change. With that in mind, the only way to be able to control the creation of genuinely unique project configurations would be to manipulate the files that these processes create. This is what JumpStart does. As well as some other cool stuff to avoid doing the same tedious setup dance over and over again.
+My main use case is Rails. Application templates weren't adjustable or broad enough in scope for me. I wanted a way of automatically configuring my local Nginx setup to include the new project, make a collection of changes to the files generated by Rails (for example changing the path of the Production MySQL database) as well as running a bunch of other stuff that needs to happen at a projects inception (Like running Capistrano and creating a custom deploy.rb file or checking the project in to source control.) 
 
-My main use case is Rails. Application templates weren't adjustable or broad enough in scope for me, and I wanted a way of automatically configuring my local Nginx setup to include the new project, make a collection of changes to the files generated by Rails (for example changing the path of the Production MySQL database) as well as running a bunch of other stuff that needs to happen at a projects inception (Like running Capistrano and creating a custom deploy.rb file or checking the project in to source control. Git in my case.) I also wanted one place to keep my setup templates for all kinds of different projects. I might want to create a Ruby Gem in a certain way, or a Sinatra app. So that's why I wrote this gem. That, and it being fun :-) Give it a try, I think you'll like it.
-
-Finally, if you think that anything isn't clear in this README or you have other ideas about improving JumpStart, give me a shout!
+Ideas on improving JumpStart are welcome, give me a shout!
 
 ==Features
 With jumpstart you can:
@@ -43,7 +55,7 @@ You'll need the win32console gem to use JumpStart
   gem install win32console
 I can't figure a good way to get this dependancy to install automatically for Windows users without disturbing their Unix bashing friends. If anyone knows how I might achieve this (with Bundler or otherwise) just let me know and I'll implement it.
 
-====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 sudo as well to grant writes to the YAML files in the gem.
 
 == Getting Started
 There are a few ways to use jumpstart.
@@ -63,7 +75,7 @@ JumpStart has a handy menu interface which will start up if you don't pass the j
 From the menu you can:
 * Create a new project from a list of existing templates
 * Create a new template from scratch (the config file and directory structure will be created for you.)
-* Create a new template by duplicating an existing one. (Everything the except the name.)
+* Create a new template by duplicating an existing one. (Everything the same except the name.)
 * Set the default template. (The template that will be used if you invoke the jumpstart command with only a project name)
 * Set the directory that JumpStart looks in for templates. This means you can have your own folder anywhere on your dev machine for templates. By default templates get created inside the JumpStart gems directory structure.
 * Easily reset the default template directory back to the original default (All of the templates in your current default templates directory will be copied back inside the gem.)
@@ -139,7 +151,7 @@ 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.
-As of version 0.5 it is now possible to append _CLASS to the capitalized key name in your templates. This will capitalise the replacement value, which is very handy for files where you need a lowercase and capitalized version of the same string, like class or module definitions.
+As of version 0.5 it is now possible to append _CLASS to the capitalised key name in your templates. This will capitalise the replacement value, which is very handy for files where you need a lowercase and capitalised version of the same string, like class or module definitions.
 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:
@@ -208,8 +220,4 @@ Example 1: Sets up a new Rails project, creating MySQL Dbs and other options. Cr
   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.
+* Send me a pull request. Bonus points for topic branches.

data/config/jumpstart_version.yml

@@ -1,4 +1,4 @@
 --- 
 :jumpstart_version_major: 0
-:jumpstart_version_minor: 5
-:jumpstart_version_patch: 4
+:jumpstart_version_minor: 6
+:jumpstart_version_patch: 0

data/jumpstart_templates/empty_template/jumpstart_config/empty_template.yml

@@ -63,6 +63,13 @@
   - :target_path:
     :symbols:
   
+## Can be omitted or left blank.
+# Add extra commands that you want to run after templates have been parsed for string replacement.
+# e.g.
+# :run_after_string_replace:
+#   - rake db:create
+:run_after_string_replace:
+  
 ## 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.

data/lib/jumpstart/base.rb

@@ -73,6 +73,7 @@ module JumpStart
       remove_unwanted_files
       run_scripts_from_yaml(:run_after_jumpstart)
       check_for_strings_to_replace
+      run_scripts_from_yaml(:run_after_string_replace)
       check_local_nginx_configuration
       exit_with_success
     end
@@ -560,7 +561,7 @@ module JumpStart
         end
       end
 
-      # Runs additional scripts specified in YAML. Runs one set after the install command has executed, and another after the templates have been generated.
+      # Runs additional scripts specified in YAML. Runs one set after the install command has executed, another after the templates have been generated, and a final time after string replacement
       def run_scripts_from_yaml(script_name)
         unless @config_file[script_name].nil? || @config_file[script_name].empty?
           begin

data/test/jumpstart/test_base.rb

@@ -197,6 +197,7 @@ class TestJumpstartBase < Test::Unit::TestCase
         @test_project.expects(:remove_unwanted_files).once
         @test_project.expects(:run_scripts_from_yaml).with(:run_after_jumpstart).once
         @test_project.expects(:check_for_strings_to_replace).once
+        @test_project.expects(:run_scripts_from_yaml).with(:run_after_string_replace).once
         @test_project.expects(:check_local_nginx_configuration).once
         @test_project.expects(:exit_with_success).once
         @test_project.start

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 5
-  - 4
-  version: 0.5.4
+  - 6
+  - 0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Ian Alexander Wood (i0n)
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-08 00:00:00 +01:00
+date: 2010-08-13 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency