lad 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lad.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 James Hughes
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,68 @@
+# Strapping Young Lad (or just Lad for short)
+
+__Strapping Young Lad__ is a tokenised solution template substitution engine.  A bit of a mouthful I know but it actually much simpler than it sounds (and hopefully much more useful that you'd think).  So what does it do?  Well running
+
+    lad /path/to/git/repo MyNewProject
+
+Will do the following things,
+
+1. Clone the repo at `path/to/git/repo` into a temporary folder
+2. Remove the `.git` folder from the repo
+3. Check for the existence of a `.ladconfig` in the freshly cloned repo
+  - If one exists it loads the config setting
+  - Otherwise it falls back to the defaults
+4. Replace all instances of the configured token (eg. `__NAME__`) in all files, directories and file contents with the project name (in our case `MyNewProject`)
+5. Copy the new folder over to your current working directory (`./MyNewProject`)
+
+What this allows you to do is have a standard project template for pretty much anything (.NET, Ruby, Scala - listen I mean anything - if it a collection of folders and files in a git repo then you set) and create a new instance with a few keystrokes - saving you time and potential RSI.
+
+SYL was inspired by [WarmuP](https://github.com/chucknorris/warmup) which is itself a gem but it requires you to be running .NET which for a lot of my requirement isn't going to cut it.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'lad'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lad
+
+## Usage
+
+The example above shows you how to use the gem,
+
+    lad <PathToRepo> <ProjectName>
+
+- `PathToRepo` is the git repository url that will be cloned
+- `ProjectName` is the name of the project.  This will replace the `__NAME__` token in the repository directories, files and contents
+
+## Configuring the engine via `.ladconfig`
+
+SYL, once the repository has been cloned will check for the existence of file with the name `.ladconfig` from which it will load the settings.  If it doesn't exist the default setting will be applied.
+
+### Configuration Options
+
+- `token` - this is the token/indetifier that will be replaced in the template with the name of the project (defaults to `__NAME__`)
+- `ignore` - a list of extensions that SYL will ignore when it comes to replacing CONTENTS.  It will still RENAME the file if the file name includes the token.  This allows us to ignore binary files whose contents should not change.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Changes
+
+17 Apr 2012 - Version 0.0.1 released.
+
+## Roadmap
+
+- __accept multiple tokens via command line or via interactive shell__
+- zip support (generate project from zip file)

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/lad

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+
+require 'git'
+require 'fileutils'
+require 'colorize'
+require 'tmpdir'
+
+require 'console'
+require 'parser'
+require 'config'
+require 'files'
+require 'lad'
+
+Lad::Bootstrapper.execute

data/lad.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/lad/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["James Hughes"]
+  gem.email         = ["james@yobriefca.se"]
+  gem.description   = %q{Strapping Young Lad: Project Template Bootstrapper}
+  gem.summary       = %q{Template generator and token switcher}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "lad"
+  gem.require_paths = ["lib"]
+  gem.version       = Lad::VERSION
+
+  gem.add_dependency('git')
+  gem.add_dependency('colorize')
+
+  gem.add_development_dependency('minitest')
+end

data/lib/config.rb

@@ -0,0 +1,13 @@
+module Lad
+  require 'yaml'
+  class Config
+    def self.load(dir, default_config)
+      config_file = File.join dir, '.ladconfig'
+      if File.exists?(config_file)
+        YAML.load_file config_file
+      else
+        default_config
+      end
+    end
+  end
+end

data/lib/console.rb

@@ -0,0 +1,30 @@
+module Lad
+  class Console
+    def self.log msg
+      puts msg
+    end
+
+    def self.warn msg
+      puts msg.yellow
+    end
+
+    def self.error msg
+      puts msg.red
+    end
+
+    def self.success msg
+      puts msg.green
+    end
+
+    def self.task msg, &block
+      print "  #{msg}".ljust(40)
+      begin
+        block.call
+        puts "OK".green
+      rescue Exception => e  
+        puts "XX".red
+        raise e
+      end
+    end
+  end 
+end

data/lib/files.rb

@@ -0,0 +1,28 @@
+module Lad
+  class Files
+    def self.new_filename(item, token, name)
+      item_dir  = File.dirname item
+      item_name = File.basename(item).gsub(token, name)
+
+      File.join item_dir, item_name
+    end
+
+    def self.delete_temporary_files(dir)
+      FileUtils.rm_rf dir if Dir.exists? dir
+    end
+
+    def self.clone_and_orphan(url, dir)
+      Git.clone url, dir
+      FileUtils.rm_rf File.join(dir, '.git')
+    end
+
+    def self.replace_token_in_file(exclusions, file, token, name)
+      if !exclusions.member?(File.extname file)
+        contents = File.read(file).gsub!(token, name)
+        File.open(file, 'w') { |f| 
+          f.puts contents 
+        }
+      end
+    end
+  end
+end

data/lib/lad.rb

@@ -0,0 +1,57 @@
+module Lad
+  class Bootstrapper
+    def self.execute
+      files_processed = 0
+      dirs_processed  = 0
+      options         = Arguments.extract
+      dir             = File.join(Dir.tmpdir, options[:name])
+      config          = {}
+
+      puts '' # insert new line padding
+
+      Console.task 'Cloning git repository' do
+        Files.delete_temporary_files(dir)
+        Files.clone_and_orphan(options[:git_url], dir)
+      end
+      
+      Console.task 'Loading configuration' do
+        config = Config.load dir, {
+          token: '__NAME__', # we should support multiple tokens as well, but that appears to be more work
+          ignore: [
+            '.png', '.jpg', '.gif', '.cache', '.suo', 
+            '.dll', '.zip', '.nupkg', '.pdb', '.exe'
+          ]
+        }
+      end
+
+      Console.task 'Processing files' do
+        Dir.glob(File.join dir, '**/*').each do |item|
+          if !File.directory?(item)
+            files_processed += 1     
+            new_item = Files.new_filename item, config[:token], options[:name] 
+            File.rename(item, new_item) if item != new_item
+
+            Files.replace_token_in_file config[:ignore], new_item, config[:token], options[:name]
+          end
+        end
+      end
+
+      Console.task 'Processing directories' do
+        Dir.glob(File.join dir, '**/*').each do |item|
+          if File.directory?(item)
+            dirs_processed += 1
+            new_item = Files.new_filename item, config[:token], options[:name] 
+            File.rename(item, new_item) if item != new_item
+          end
+        end
+      end
+
+      Console.task 'Moving project files' do
+        File.rename dir, File.join(Dir.pwd, options[:name])
+      end
+
+      Console.success "\n  Done processing #{files_processed} file(s)"
+      Console.success "  Done processing #{dirs_processed} directories(s)"
+    end
+  end
+end

data/lib/lad/version.rb

@@ -0,0 +1,3 @@
+module Lad
+  VERSION = "0.0.1"
+end

data/lib/parser.rb

@@ -0,0 +1,10 @@
+module Lad
+  class Arguments
+    def self.extract
+      return {
+        git_url: ARGV.first,
+        name:    ARGV.last
+      }      
+    end
+  end
+end

data/test/test_config.rb

@@ -0,0 +1,45 @@
+require 'minitest/autorun'
+require 'tmpdir'
+require 'fileutils'
+
+require './lib/config' # SUT
+
+describe Lad::Config do
+  before do
+    @dir  = File.join Dir.tmpdir, (0..16).to_a.map{|a| rand(16).to_s(16)}.join
+    @file = File.join @dir, '.ladconfig'
+    @cfg  = {
+      'a_property' => 'property_value'
+    }
+
+    FileUtils.rm_rf @dir if Dir.exists? @dir
+    FileUtils.mkdir @dir
+  end
+
+  after do
+    FileUtils.rm_rf @dir
+  end
+
+  describe 'when loading a file that does not exist' do
+    
+    before do
+      File.delete @file if File.exists? @file
+    end
+
+    it 'returns the default values' do
+      Lad::Config.load(@dir, @cfg)['a_property'].must_equal @cfg['a_property']
+    end
+  end
+
+  describe 'when loading a file that does exist' do
+    before do
+      File.open(@file, 'w') do |f| 
+        f.puts '''a_property: file_value''' 
+      end
+    end
+
+    it 'returns the values from that file' do
+      Lad::Config.load(@dir, @cfg)['a_property'].must_equal 'file_value'
+    end
+  end
+end

data/test/test_files.rb

@@ -0,0 +1,63 @@
+require 'minitest/autorun'
+require 'tmpdir'
+
+require './lib/files' # SUT
+
+describe Lad::Files do
+  describe 'resolving the new file name' do
+    it 'replaces the token with the name in the filename only' do
+      Lad::Files.new_filename( '/var/tmp/__NAME__/__NAME__.sln', '__NAME__', 'Assertion').must_match '/var/tmp/__NAME__/Assertion.sln'
+    end
+
+    it 'will also replace tokens in the bottom most directory of a directory is passed' do
+      Lad::Files.new_filename('/var/tmp/__NAME__/__NAME__', '__NAME__', 'Assertion').must_match '/var/tmp/__NAME__/Assertion'
+    end
+
+    it 'will disregard a trailing slash on directory token replacement' do
+      Lad::Files.new_filename('/var/tmp/__NAME__/__NAME__/', '__NAME__', 'Assertion').must_match '/var/tmp/__NAME__/Assertion'
+    end
+
+    it 'will do nothing if the bottom most item hasn;t got the token' do
+      Lad::Files.new_filename('/var/tmp/__NAME__/__NAME__/Test.sln', '__NAME__', 'Assertion').must_match '/var/tmp/__NAME__/__NAME__/Test.sln'
+    end
+  end
+
+  describe 'replacing token in files' do
+
+    before do
+      @dir  = File.join Dir.tmpdir, (0..16).to_a.map{|a| rand(16).to_s(16)}.join
+      @file = File.join @dir, 'targetfile.txt'
+      @cfg  = {
+        'a_property' => 'property_value'
+      }
+
+      FileUtils.rm_rf @dir if Dir.exists? @dir
+      FileUtils.mkdir @dir
+
+      @original = '''
+        lorem lorem __NAME__ lorem lorem
+        lorem __NAME__ lorem lorem lorem
+      '''
+      @expected = '''
+        lorem lorem Assertion lorem lorem
+        lorem Assertion lorem lorem lorem
+      '''
+
+      File.open(@file, 'w') { |f| f.puts @original }
+    end
+
+    after do
+      FileUtils.rm_rf @dir
+    end
+
+    it 'will replace all instances of the token in a file' do
+      Lad::Files.replace_token_in_file [], @file, '__NAME__', 'Assertion'
+      File.open(@file).read.must_match @expected
+    end
+
+    it 'will not replace any tokens if the files extension is excluded' do
+      Lad::Files.replace_token_in_file ['.txt'], @file, '__NAME__', 'Assertion'
+      File.open(@file).read.must_match @original
+    end
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: lad
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- James Hughes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: &70226633976000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70226633976000
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: &70226633975380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70226633975380
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70226633974940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70226633974940
+description: ! 'Strapping Young Lad: Project Template Bootstrapper'
+email:
+- james@yobriefca.se
+executables:
+- lad
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/lad
+- lad.gemspec
+- lib/config.rb
+- lib/console.rb
+- lib/files.rb
+- lib/lad.rb
+- lib/lad/version.rb
+- lib/parser.rb
+- test/test_config.rb
+- test/test_files.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Template generator and token switcher
+test_files:
+- test/test_config.rb
+- test/test_files.rb