puppet-retrospec 0.7.3 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eaace655a4e5f360e93ef3ee07ed003dfeecdf61
-  data.tar.gz: 20f0b75846a20d22b35db36bfee6b8768503ca30
+  metadata.gz: 07921b5d09c92738440e643b20afbfee2aeaabbc
+  data.tar.gz: 9ff24e7a36e206e02cc7408cd5a21ce3e3838af3
 SHA512:
-  metadata.gz: 46c667b57c0d670e2ccde78f388b4d3a881b423679a6e438905e2f7bbf1667b760a8a973652a73ed6803068e6a5ba7e73a73c6f7892077b9da0bfc7a7a65685f
-  data.tar.gz: 667274f680050e06ef26e63d6804a46cc09a2ce9c5bf4831337070f8a16c2250978fa8e9573c6da634e4b28310e4036a68824561289327ac642f5fb96417468b
+  metadata.gz: ad162892e3d4cf46c505bcd99878ece7e9a49dd3933fc4ea5fc75dddc1d21797e69d1b36f34ca292cac92c442c8dec198ca67835c7d644da58920e91d999f961
+  data.tar.gz: e405d614efa59d18dc2b90408c9ade1ad30861b35e48c0754765a196fcd85742aa42ec16078cf1cfb0e65531626dbf06ba89704c879c5172be6b15a2416dbcc4

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+## 0.8.0
+ * enable broader support for future parser
+ * remove hiera and facter dependencies
+ * added support for running pre and post hooks gh-27
+ * added support for running a hook to clone external templates
+ * externalized the templates into their own repo gh-26
+ * handle symlinks in the templates directory correctly gh-28
+ 
+## 0.7.3
+ * added hiera data helper to fill in all the auto bindable class params in shared_contexts
+ * updated hiera data gem to newer fork that works with puppet 3.5+
+ * minor fixes in templates
+ * added vagrantfile for easier manual integration testing
+
+## 0.7.2
+ * vendor the puppet gem
+    
 ## 0.7.0
  * gh-18 puppet 4 code syntax does not work
  * gh-10 safe file creation should use colors

data/Gemfile

@@ -2,16 +2,16 @@ source "http://rubygems.org"
 
 # while retrospec does not use facter or hiera,
 # we vendor the puppet gem 3.7.3 which also requires facter and hiera
-gem 'facter', '< 3', '> 1.6'
-gem 'hiera', '~> 1.0'
+#gem 'facter', '< 3', '> 1.6'
+#gem 'hiera', '~> 1.0'
 
 gem 'trollop'
 # Include everything needed to run rake, tests, features, etc.
 group :development do
   gem "rspec", "~> 2.14"
   gem 'puppet', '3.7.3',  :path => 'vendor/gems/puppet-3.7.3'
-  gem 'facter', '< 3', '> 1.6'
-  gem 'hiera', '~> 1.0'
+  #gem 'facter', '< 3', '> 1.6'
+  #gem 'hiera', '~> 1.0'
   gem "yard", "~> 0.7"
   gem "rdoc", "~> 3.12"
   gem "bundler", "~> 1.0"

data/README.md

@@ -1,11 +1,13 @@
 Puppet-Retrospec
 ================
 
-Generates puppet rspec test code based on the classes and defines inside the manifests directory.  Aims to reduce some of the boilerplate coding with default test patterns.
+Generates puppet rspec test code based on the classes and defines inside the manifests directory.  
+Aims to reduce most of the boilerplate coding with default test patterns and module setup.
 
-Retrospec makes it dead simple to get started with puppet unit testing.  When you run retrospec, retrospec will scan you puppet manifests
-and actually write some very basic rspec-puppet test code.  Thus this gem will retrofit your existing puppet module
-with everything needed to get going with puppet unit testing.
+Retrospec makes it dead simple to get started with puppet module development and puppet unit testing.  
+When you run retrospec, retrospec will scan you puppet manifests and actually write some very basic rspec-puppet test code.
+Thus this gem will retrofit your existing puppet module with everything needed to get going with puppet unit testing.  
+Additionally, retrospec will outfit your module with any file you can think of.  Say goodbye to repetitive module setup.
 
 The project was named retrospec because there are many times when you need to retrofit your module with spec tests.
 
@@ -29,7 +31,7 @@ Table of Contents
   * [Future Parser Support](#future-parser-support)
   * [Support](#support)
 
-Created by [gh-md-toc](https://github.com/ekalinin/github-markdown-toc)
+TOC Created by [gh-md-toc](https://github.com/ekalinin/github-markdown-toc)
 
 Build Status
 ============
@@ -38,9 +40,8 @@ Build Status
 
 Dependency
 ============
-Retrospec relies heavily on the puppet 3.7.x codebase.  Because of this hard dependency the puppet gem is vendored into the library so there should
-not be conflicts with your existing puppet gem.  We also require facter and hiera as a result of some indirect puppet dependencies. If there are issues around
-loading facter or hiera then we may need to also vendor the facter and hiera gems as well.
+Retrospec relies heavily on the puppet 3.7.x codebase.  Because of this hard dependency the puppet gem is vendored into
+the library so there should not be conflicts with your existing puppet gem.
   
 Install
 =============
@@ -52,12 +53,16 @@ How to use
 Run from the command line
 ```
 $ retrospec -h
-  Options:
-          --module-path, -m <s>: The path (relative or absolute) to the module directory
-         --template-dir, -t <s>: Path to templates directory (only for overriding Retrospec templates)
-    --enable-user-templates, -e: Use Retrospec templates from ~/.puppet_retrospec_templates
-      --enable-beaker-tests, -n: Enable the creation of beaker tests
-                     --help, -h: Show this message
+Generates puppet rspec test code based on the classes and defines inside the manifests directory.
+   -m, --module-path=<s>         The path (relative or absolute) to the module directory (Defaults to current directory) 
+   -t, --template-dir=<s>        Path to templates directory (only for overriding Retrospec templates) (default: /Users/user1/.retrospec_templates)
+   -s, --scm-url=<s>             SCM url for retrospec templates
+   -b, --branch=<s>              Branch you want to use for the retrospec template repo
+   -e, --enable-beaker-tests     Enable the creation of beaker tests
+   -n, --enable-future-parser    Enables the future parser only during validation
+   -v, --version                 Print version and exit
+   -h, --help                    Show this message
+
                      
 retrospec -m ~/projects/puppet_modules/apache
 ```
@@ -68,7 +73,8 @@ Example
 Below you can see that it creates files for every resource in the tomcat module in addition to other files
 that you need for unit testing puppet code. Rspec-puppet best practices says to put definitions in a defines folder
 and classes in a classes folder since it infers what kind of resource it is based on this convention.  Retrospec sets up
-this scaffolding for you.
+this scaffolding for you.  Don't like the files that came with your module?  Simply delete the files and re-generate them
+with retrospec.
 
 ```shell
 $ pwd
@@ -85,21 +91,6 @@ $ retrospec
   + /Users/cosman/github/puppetlabs-apache/spec/classes/
   + /Users/cosman/github/puppetlabs-apache/spec/classes/default_mods_spec.rb
   + /Users/cosman/github/puppetlabs-apache/spec/classes/dev_spec.rb
-  + /Users/cosman/github/puppetlabs-apache/spec/classes/apache_spec.rb
-  + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/
-  + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/alias_spec.rb
-  + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/auth_basic_spec.rb
-  + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/auth_kerb_spec.rb
-  + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/autoindex_spec.rb
-  + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/cache_spec.rb
-  + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/cgi_spec.rb
-  + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/cgid_spec.rb
-  + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/dav_spec.rb
-  + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/dav_fs_spec.rb
-  + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/dav_svn_spec.rb
-  + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/deflate_spec.rb
-  + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/dev_spec.rb
-  + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/dir_spec.rb
   + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/disk_cache_spec.rb
   + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/fcgid_spec.rb
   + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/headers_spec.rb
@@ -107,30 +98,6 @@ $ retrospec
   + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/itk_spec.rb
   + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/ldap_spec.rb
   + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/mime_spec.rb
-  + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/mime_magic_spec.rb
-  + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/mpm_event_spec.rb
-  + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/negotiation_spec.rb
-  + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/passenger_spec.rb
-  + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/perl_spec.rb
-  + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/php_spec.rb
-  + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/prefork_spec.rb
-  + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/proxy_spec.rb
-  + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/proxy_balancer_spec.rb
-  + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/proxy_html_spec.rb
-  + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/proxy_http_spec.rb
-  + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/python_spec.rb
-  + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/reqtimeout_spec.rb
-  + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/rewrite_spec.rb
-  + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/setenvif_spec.rb
-  + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/ssl_spec.rb
-  + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/status_spec.rb
-  + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/suphp_spec.rb
-  + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/userdir_spec.rb
-  + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/vhost_alias_spec.rb
-  + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/worker_spec.rb
-  + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/wsgi_spec.rb
-  + /Users/cosman/github/puppetlabs-apache/spec/classes/mod/xsendfile_spec.rb
-  + /Users/cosman/github/puppetlabs-apache/spec/classes/params_spec.rb
   + /Users/cosman/github/puppetlabs-apache/spec/classes/php_spec.rb
   + /Users/cosman/github/puppetlabs-apache/spec/classes/proxy_spec.rb
   + /Users/cosman/github/puppetlabs-apache/spec/classes/python_spec.rb
@@ -148,11 +115,12 @@ $ retrospec
  
 ```
 
-Looking at the file we can see that it did a lot of work for us.  Retrospec generate many tests automatically.
+Looking at the file we can see that it did a lot of work for us.  Retrospec generated many tests automatically.
 However the variable resolution isn't perfect so you will need to manually resolve some variables.  This doesn't produce
 100% coverage but all you did was pressed enter to produce all this anyways.
 Below is the classes/apache_spec.rb file.  Notice that while Retrospec created all these files, you still need to do more work.
 Retrospec is only here to setup your module for testing, which might save you several hours each time you create a module.
+Below I'll go through the different parts of automation that you can use in your testing.
 
    
 ```ruby
@@ -356,34 +324,37 @@ For now you will probably want to read up on the following documentation:
 How Does it do this
 =======================
 Basically Retrospec uses the puppet lexer and parser to scan your code in order to fill out some basic templates that will retrofit
-your puppet module with unit tests.  Currently I rely on the old AST parser to generate all this.  This is why
+your puppet module with unit tests.  Currently I rely on the old AST parser to generate all this.  This is why puppet 3.7
+is vendored into the gem.
 
-Overriding the templates
+Overriding the Templates
 =======================
 There may be a time when you want to override the default templates used to generate the rspec related files.
-To override these templates just set **one** of the following cli options.
+By default retrospec will clone these [templates](https://github.com/nwops/retrospec-templates)
+and place inside the default or specified template directory.  Previously the templates were kept inside the gem
+and cloning was not required. However, after using retrospec for a few months it makes more sense to keep these templates
+versioned controlled in their own repo and update them before each retrospec use.  This also makes it easy for team
+contributions to be spread to other team members quickly.
   
 ```shell
-      --template-dir, -t <s>:   Path to templates directory (only for overriding Retrospec templates)
-    --enable-user-templates, -e:   Use Retrospec templates from ~/.puppet_retrospec_templates
+    -t, --template-dir=<s>  Path to templates directory (only for overriding Retrospec templates) (default: /Users/user1/.retrospec_templates)
+    -s, --scm-url=<s>       SCM url for retrospec templates
+    -b, --branch=<s>        Branch you want to use for the retrospec template repo
 
 ```
 
-Once one of the options is set, retrospec will copy over all the templates from the default gem location to the default
-or specified templates path.  
-If you have already created the erb file in the templates location, then puppet-retrospec will not overwrite the file.
-You can set multiple template paths if you use them for different projects so just be sure the set the correct
-template option when running retrospec.
-
-Setting the `--enable-user-templates` option will tell retrospec to use the default user template location and will
-copy over all the default templates that came with the gem.
+### Environment variables to set template defaults
 
-The default user location for the templates when using this variable is ~/.puppet_retrospec_templates
+RETROSPEC_SCM_URL  # set this to auto set your scm url to the templates
+RETROSPEC_SCM_BRANCH # set this to auto checkout a particular branch (only works upon initial checkout)
 
-If you wish to override ~/.puppet_retrospec_templates location you can use the following option
-`--template-dir`
+After running retrospec, retrospec will clone the templates from the default template url or from whatever you set to the templates path.  
+If you have already created the erb file in the templates location, then retrospec will not overwrite the file as there will
+be a SCM conflict.
+You can use multiple template paths if you use them for different projects so just be sure the set the correct
+template option when running retrospec.  `retrospec -t`
 
-If you set the `--template-dir` option you are not required to set the set `--enable-user-templates` option
+The default user location for the templates when not using `retrospec -t` variable is ~/.retrospec_templates
 
 Example:
 `--template-dir=~/my_templates`
@@ -417,9 +388,10 @@ Adding New Templates
 Should you ever need to add new templates or normal files of any kind retrospec will automatically render and copy the template file
 to the module path if you place a file inside the `template_path/module_files` directory.  The cool thing about this feature
 is that retrospec will recursively create the same directory structure you make inside the `module_files` directory inside your
-module.  Files do not need to end in .erb will still be rendered as a erb template.
+module.  Files do not need to end in .erb will still be rendered as a erb template.  Symlinks will be preserved and not 
+dereferenced. 
 
-This follow the convention over configuration pattern so no directory name or filename is required when running retrospec.
+This follows the convention over configuration pattern so no directory name or filename is required when running retrospec.
 Just put the template file in the directory where you want it (under module_files) and name it exactly how you want it to appear in the module and retrospec
 will take care of the rest.  Please note that any file ending in .erb will have this extension automatically removed.
 
@@ -427,10 +399,10 @@ Example:
 So lets say you want to add a .gitlab-ci.yaml file to all of your modules in your modules directory.  
 
 ```shell
-   touch ~/.puppet_retrospec_templates/module_files/.gitlab-ci.yaml
+   touch ~/.retrospec_templates/module_files/.gitlab-ci.yaml
    
-   tree ~/.puppet_retrospec_templates -a
-   ./.puppet_retrospec_templates
+   tree ~/.retrospec_templates -a
+   ./.retrospec_templates
    ├── acceptance_spec_test.erb
    ├── module_files
    │   ├── .fixtures.yml
@@ -489,7 +461,7 @@ See [fixtures doc](https://github.com/puppetlabs/puppetlabs_spec_helper#using-fi
 ```
 
 If you see something like the following, this means your current module is using a much older version of Rspec.  Retrospec
-using Rspec 3 syntax so you need to update your rspec version.  If you have tests that using older rspec syntax, take a look
+uses Rspec 3 syntax so you need to update your rspec version.  If you have tests that using older rspec syntax, take a look
 at [transpec](https://github.com/yujinakayama/transpec)
 
 ```shell
@@ -500,7 +472,12 @@ at [transpec](https://github.com/yujinakayama/transpec)
         # ./spec/defines/vhost_spec.rb:103:in `block (2 levels) in <top (required)>'
 
 ```
-Running Tests
+
+If your tests will not run after running retrospec. Your spec_helper, Rakefile and Gemfile may not be compatible 
+with the pre-defined templates.  Just delete these files and re-run retrospec to recreate them.  Add back any modifications
+you might have had.
+
+Running Retrospec Tests
 =============
 Puppet-retrospec tests its code against real modules downloaded directly from puppet forge. 
 We also do a little mocking as well but for the majority of the tests we download are 'fixtures'.
@@ -531,7 +508,7 @@ Future Parser Support
 ==============
 Currently Retrospec uses the old/current AST parser for code parsing.  If your code contains future parser syntax
 the current parser will fail to render some resource definitions but will still render the spec file template without parameters
-and resource tests that are contained in your manifest.
+and resource tests that are contained in your manifest. Retrospec is still extremely useful with Puppet 4.
 Since Puppet 4 introduces many new things and breaks many other things  I am not sure
 which side of the grass is greener at this time.  What I do know is that most people are using Puppet 3 and it may take
 time to move to Puppet 4.  I would suspect Retrospec would be more valuable for those moving to Puppet 4
@@ -553,6 +530,11 @@ Todo
 - Auto add dependencies to fixtures file
 - Show a diff of the test file when retrospec is run multiple times and the test file is already created.
 
-Support
+Ruby Support
 ============
 Currently this library only supports ruby >= 1.9.3.  It might work on 1.8.7 but I won't support if it fails.
+
+Paid Support
+============
+Want to see new features developed much faster?  Contact me about a support contract so I can develop this tool during
+the day instead of after work.  contact: sales@logicminds.biz

data/VERSION

@@ -1 +1 @@
-0.7.3
+0.8.0

data/bin/retrospec

@@ -4,7 +4,7 @@ require 'trollop'
 require 'retrospec'
 
 opts = Trollop::options do
-  version "0.7.3 (c) Corey Osman"
+  version "0.8.0 (c) Corey Osman"
   banner <<-EOS
 Generates puppet rspec test code based on the classes and defines inside the manifests directory.
 
@@ -13,13 +13,17 @@ Generates puppet rspec test code based on the classes and defines inside the man
   opt :module_path, "The path (relative or absolute) to the module directory (Defaults to current directory) " ,
       :type => :string, :required => false, :default => nil
   opt :template_dir, "Path to templates directory (only for overriding Retrospec templates)", :type => :string,
-      :required => false, :default => nil
-  opt :enable_user_templates, "Use Retrospec templates from #{File.expand_path('~/.puppet_retrospec_templates')}",
-      :require => false, :type => :boolean
+      :required => false, :default => File.expand_path('~/.retrospec_templates')
+  opt :scm_url, "SCM url for retrospec templates", :type => :string, :required => false,
+      :default => ENV['RETROSPEC_SCM_URL']
+  opt :branch, "Branch you want to use for the retrospec template repo", :type => :string, :required => false,
+      :default => ENV['RETROSPEC_SCM_BRANCH']
   opt :enable_beaker_tests, "Enable the creation of beaker tests", :require => false, :type => :boolean
   opt :enable_future_parser, "Enables the future parser only during validation", :require => false, :type => :boolean
 end
 include Puppet_Retrospec
 
 retro = Retrospec.new(opts[:module_path], opts)
+retro.run_pre_hook
 retro.create_files
+retro.run_post_hook

data/lib/retrospec.rb

@@ -10,6 +10,7 @@ require 'retrospec/puppet_module'
 require 'retrospec/spec_object'
 require 'retrospec/exceptions'
 require 'retrospec/version'
+require 'find'
 
 class Retrospec
 
@@ -25,12 +26,7 @@ class Retrospec
   def initialize(supplied_module_path=nil,opts={})
     Utilities::PuppetModule.instance.future_parser = opts[:enable_future_parser]
     # user supplied a template path or user wants to use local templates
-    if opts[:template_dir] or opts[:enable_user_templates]
-      @template_dir = Helpers.setup_user_template_dir(opts[:template_dir])
-    else
-      # if user doesn't supply template directory we assume we should use the templates in this gem
-      @template_dir = Helpers.gem_template_dir
-    end
+    @template_dir = Helpers.setup_user_template_dir(opts[:template_dir], opts[:scm_url], opts[:branch])
     begin
       Utilities::PuppetModule.instance.module_path = supplied_module_path
       Utilities::PuppetModule.create_tmp_module_path # this is required to finish initialization
@@ -40,6 +36,37 @@ class Retrospec
     end
   end
 
+  # runs a user defined hook called pre-hook
+  def run_pre_hook
+    hook_file = File.join(template_dir,'pre-hook')
+    if File.exists?(hook_file)
+      output = `#{hook_file} #{module_path}`
+      if $?.success?
+        puts "Successfully ran hook: #{hook_file}".info
+        puts output.info
+      else
+        puts "Error running hook: #{hook_file}".fatal
+        puts output.fatal
+      end
+    end
+ end
+
+  # runs a user defined hook called post-hook
+  def run_post_hook
+    hook_file = File.join(template_dir,'post-hook')
+    if File.exists?(hook_file)
+      output = `#{hook_file} #{module_path}`
+      if $?.success?
+        puts "Successfully ran hook: #{hook_file}".info
+        puts output.info
+      else
+        puts "Error running hook: #{hook_file}".fatal
+        puts output.fatal
+      end
+    end
+  end
+
+  # this is the method that performs all the magic and creates all the files
   def create_files
     types = spec_object.types
     safe_create_module_files
@@ -57,19 +84,23 @@ class Retrospec
   end
 
   # creates any file that is contained in the templates/modules_files directory structure
-  # loops through the directory looking for erb files, all other files are ignored.
+  # loops through the directory looking for erb files or other files.
   # strips the erb extension and renders the template to the current module path
   # filenames must named how they would appear in the normal module path.  The directory
   # structure where the file is contained
   def safe_create_module_files
-    templates = Dir.glob(File.join(template_dir,'module_files', '**', '{*,.*}')).find_all {|t| File.file?(t)}
+    templates = Find.find(File.join(template_dir,'module_files')).find_all {|f| !File.directory?(f)}.sort
     templates.each do |template|
       # need to remove the erb extension and rework the destination path
       if template =~ /nodesets|spec_helper_acceptance/ and !spec_object.enable_beaker_tests?
         next
       else
         dest = template.gsub(File.join(template_dir,'module_files'), module_path).gsub('.erb', '')
-        safe_create_template_file(dest, template)
+        if File.symlink?(template)
+          Helpers.safe_create_symlink(template, dest)
+        else
+          safe_create_template_file(dest, template)
+        end
       end
     end
   end

data/lib/retrospec/helpers.rb

@@ -65,11 +65,36 @@ class Helpers
 
   # creates and syncs the specifed user template diretory
   # returns: user_template_dir
-  def self.setup_user_template_dir(user_template_directory=nil)
+  def self.setup_user_template_dir(user_template_directory=nil, git_url=nil, branch=nil)
     if user_template_directory.nil?
       user_template_directory = default_user_template_dir
     end
-    sync_user_template_dir(create_user_template_dir(user_template_directory))
+    template_dir = create_user_template_dir(user_template_directory)
+    run_clone_hook(user_template_directory, git_url, branch)
+    template_dir
+  end
+
+  # runs the clone hook file
+  # the intention of this method and hook is to download the templates
+  # from an external repo. Because templates are updated frequently
+  # and users will sometimes have client specific templates I wanted to
+  # externalize them for easier management.
+  def self.run_clone_hook(template_dir, git_url=nil, branch=nil)
+    if File.exists?(File.join(template_dir,'clone-hook'))
+      hook_file = File.join(template_dir,'clone-hook')
+    else
+      hook_file = File.join(gem_template_dir, 'clone-hook')
+    end
+    if File.exists?(hook_file)
+      output = `#{hook_file} #{template_dir} #{git_url} #{branch}`
+      if $?.success?
+        puts "Successfully ran hook: #{hook_file}".info
+        puts output.info
+      else
+        puts "Error running hook: #{hook_file}".fatal
+        puts output.fatal
+      end
+    end
   end
 
   def self.default_user_template_dir
@@ -80,6 +105,15 @@ class Helpers
     File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
   end
 
+  def self.safe_create_symlink(src,dest)
+    if File.exists? dest
+      $stderr.puts "!! #{dest} already exists and differs from template".warning
+    else
+      FileUtils.copy_entry(src,dest)
+      puts " + #{dest}".info
+    end
+  end
+
   def self.safe_copy_file(src, dest)
     if File.exists?(dest) and not File.zero?(dest)
       $stderr.puts "!! #{dest} already exists".warning