blazing 0.2.7 → 0.2.9

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format nested

data/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - ree

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 ## master
 
+## 0.2.9 - February 7, 2012
+
+* Fixes concerning recipe loading in blazing core and recipe gems.
+
+## 0.2.8 - February 7, 2012
+
+* no default target unless there is only one in config
+* ability to run seutp and update on all targets by specifiying all as target on command line
+* rewrite CLI interface, uses Thor
+* basic integration specs
+* update and improve readme and sample configuration
+* deprecate `repository` DSL method
+* allow environment variables to be defined in config when setting the
+  rake task (#58)
+* allow the RAILS_ENV to be specified for a target (will be used when
+  calling rake) (#58)
+
 ## 0.2.7 - November 24, 2011
 
 * fix hook rake call, run it with bundle exec like the rest

data/Guardfile

@@ -1,7 +1,5 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
-guard 'rspec', :version => 2, :cli => "--colour --fail-fast --format nested" do
+guard :rspectacle, :version => 2, :cli => "--colour --fail-fast --format nested" do
+  watch('spec/spec_helper.rb')                        { %w(spec/spec_helper spec) }
   watch(%r{^spec/.+_spec\.rb})
   watch(%r{^lib/(.+)\.rb})     { |m| "spec/#{m[1]}_spec.rb" }
   watch(%r{^lib/blazing/(.+)\.rb})     { |m| "spec/blazing/#{m[1]}_spec.rb" }

data/README.md

@@ -1,24 +1,39 @@
-[![Build Status](https://secure.travis-ci.org/effkay/blazing.png)](http://travis-ci.org/effkay/blazing)
+[![Build Status](https://secure.travis-ci.org/effkay/blazing.png?branch=master)](http://travis-ci.org/effkay/blazing)
 
-# Blazing fast and painless git push deploys
+Blazing fast and painless git push deploys
+==========================================
 
 *Oh no, yet another deployer!*
 
-Not everyone can or wants to deploy on heroku. But now you can have the same (well, almost the same, since we're not gonna patch SSH) awesomely smooth git push deploys on whatever server you have SSH access to.
+Not everyone can or wants to deploy on heroku. But now you can have the same (well, almost the same, since we're not gonna patch SSH) awesomely smooth git push deploys on whatever server you have SSH access to. In short, blazing helps you create nice git post-receive hooks and is extendable by plugins.
 
-## Quickstart
+Quickstart
+----------
 
-`blazing init`, edit the configuration, run `blazing setup [target]` and you're set. Deploy with `git push <target> <branch>` or setup git to always push your current branch.
+`blazing init`, edit your blaing config, run `blazing setup [target]` to deploy your post-receive hook and you're set. Deploy with `git push <target> <branch>`.
 
-## Overview & Background
+Features
+--------
+
+Out of the box, blazing can do the following:
+
+* set up a repository you can push to for deployment
+* set up a git post-receive hook, configurable by a simple DSL
+* works with rvm
+* uses bundler for dependency management
+* allows you to run custom rake tasks after deployment
+* is extendable by blazing recipes
+
+Overview & Background
+---------------------
 
 Blazing is a deployment tool written in Ruby. It provides helpers to setup your project with a git post-receive hook, which is triggered every time you push to your production repository.
 
 I initially started working on an extension to capistrano which would cover most of my needs and the nees of my team. After a short while I noticed that bolting more functionality on top of capistrano was just going to be messy (and a PTA to maintain). We were alerady using tons of own recipes and customizations, capistrano multistage, capistrano-ext, etc.
- 
+
 I had a look at what others were doing and after a round of trying around and not getting what I wanted, I started this.
- 
-## Design Goals
+
+#### Design Goals
 
 When I started working on blazing, I had some design goals in mind which I think should stay relevant for this project:
 
@@ -27,71 +42,129 @@ When I started working on blazing, I had some design goals in mind which I think
 - no messy rake scripts: Define the desired behavior trough a DSL, and extensions add to this DSL in a clean and modular way
 - Deployments should be fast
 
-### Inspiration & Alternatives
- 
+#### Inspiration & Alternatives
+
 I looked at [Inploy](https://github.com/dcrec1/inploy) and [Vlad](https://github.com/seattlerb/vlad) after having used [Capistrano](https://github.com/capistrano/capistrano) for several
 years. Then got inspired by defunkt's
 [blog post](https://github.com/blog/470-deployment-script-spring-cleaning) about deployment script spring cleaning. Other's doing a similar thing with git push deployments are Mislav's [git-deploy](https://github.com/mislav/git-deploy) (which was a great inspiration and resource) and [pushand](https://github.com/remi/pushand.git) by remi. If you don't like blazing, you might give them a try.
 
-## Installation
+Usage
+-----
 
-Your machine should be setup with ruby, rubygems, bundler and git. Install blazing by adding it to your `Gemfile` or run `gem install blazing`. The basic assumption from now on will be that you are working on a project with bundler and a Gemfile. Support for other ways to handle dependencies might be added in the future, but for now bundler is required.
+#### Installation
 
-## Usage
+Your machine should be setup with ruby, rubygems, bundler and git. Install blazing by adding it to your `Gemfile` or run `gem install blazing`. The basic assumption from now on will be that you are working on a project with bundler and a Gemfile. Support for other ways to handle dependencies might be added in the future but **at the moment bundler is required**.
 
-### Init
+#### blazing Commands
 
-Run `blazing init` in your project root to create a sample config file. 
+##### `blazing init`
 
-### Configuration
+Generate a blazing config file
 
-See the generated configuration file or [the template file](https://github.com/effkay/blazing/blob/master/lib/blazing/templates/config.erb) for available configuration options.
+##### `blazing setup <target>`
 
-### Setup
+Setup target repository for deployment and add git remote localy. Use 'all' as target name to update all configured targets at once.
 
-`blazing setup` will:
+##### `blazing update <target>`
 
-* setup your local repository for deployment with blazing/git push. Basically, it will add a remote for each target you defined in the configuration file.
-* clone the repository to the specified location
-* setup the repository to allow a currently checked out branch to be pushed to it
+Update post-receive hook according to current config. Run it after changing the blazing config. Use 'all' as target name to update all configured targets at once.
 
-Whenever you change something in your blazing config file you can run the `update` command so your git post-receive hook and your git remotess get updated.
+##### `blazing list`
 
-### Deploying
+List available recipes
 
-Just push to your remote… so if you set up a target named `:production`, use `git push production master` to deploy your master branch there.
+##### `blazing recipes`
 
-### Recipes
+Run the configured recipes (used on deployment target, can be used to test recipes localy)
 
-Right now blazing does the following things out of the box:
+The `setup` and `update` commands also take 'all' as an option. This .
 
-* use rvm if you specify it in your config (by passing an rvm string or just `:rvmrc`, which will load the rvmrc)
-* checkout the pushed ref… so if you do git push production master, the last commit of the master branch will be checked out. Before doing a checkout blazing will reset to HEAD so no errors happen due to changed files. **This means that you will loose any uncommited changes on the production repository. Having changes there is a bad idea anyway!**
-* run bundle --deployment so the dependencies are installed
-* run all recipes, in the order that they are defined
-* run the rake task if one was specified
+#### Configuration (blazing DSL)
+
+```ruby
+# Sample target definition:
+#
+#   target <target_name>, <target_location>, [options]
+#
+# The options provided in the target definition will override any
+# options provided in the recipe call.
+#
+# Options recognized by blazing core:
+#   rails_env: used when calling the rake task after deployment
+
+target :staging, 'screenconcept@ruby:/var/www/vischer.ruby.screenconcept.ch',
+       :recipe_specific_option => 'foo', :rails_env => 'production'
+
+
+# Sample rvm setup:
+#
+#    rvm <rvm-string>
+#
+# Setting the rvm string will make sure that the correct rvm ruby and
+# gemset is used before the post-receive hook does anything at all.
+# Use :rvmrc as rvm string if you want blazing to use the rvm
+# environment specified in your project's .rvmrc file.
+
+rvm 'ruby-1.9.3@some-gemset'
+
+
+# Sample config for custom rvm location:
+#
+#    rvm_scripts <path_to_rvm_scripts>
+#
+# If you have installed rvm to a custom location, use this method to
+# specify where the rvm scripts are located.
+
+rvm_scripts '/opt/rvm/scripts/rvm'
+
+
+# Sample recipe setup:
+#
+#     recipe <recipe_name>, [options]
+#
+# The given recipe will be called with the provided options. Refer to each
+# recipe's documentation for available options. Options provided here
+# may be overridden by target specific options.
+# Recipes will be executed in the order they are defined!yy
+
+recipe :precompile_assets, :recipe_specific_option => 'bar'
+
+
+# Sample rake file config:
+#
+#     rake <task>, [environment variables]
+#
+# The provided rake task will be run after all recipes have run.
+# Note: you can only call a single rake task. If you need to run several
+# tasks just create one task that wrapps all the others.
+
+rake :post_deploy, 'RAILS_ENV=production'
+```
 
-Run all recipes? Well yes, blazing can be extended by recipes. So far, these are available:
+#### Deploying
 
-* [blazing-passenger](https://github.com/effkay/blazing-passenger)
-* [blazing-rails](https://github.com/effkay/blazing-rails)
+Just push to your remote… so if you set up a target named `production`, use `git push production master` to deploy your master branch there.
 
-Feel free to roll your own recipes!
+Recipes
+-------
 
-## Development & Contribution
+Blazing only offers a small set of core features. However, it is extendable by recipes.
 
-### Improving Blazing itself
+#### Available Recipes
 
-If you like blazing and want to improve/fix something, feel free, I'm glad for every pull request. Maybe contact me beforehand so we don't fix the same bugs twice and make sure you stick with a similar code style and have tests in your pull request. 
+* [blazing-passenger](https://github.com/effkay/blazing-passenger)
+* [blazing-rails](https://github.com/effkay/blazing-rails)
 
-### Creating custom Blazing Recipes
+#### Creating a blazing Recipe
 
-I would like to add recipes that encapuslate common deployment strategies to blazing. If you have an idea for that, you are welcome to contribute. Right now I am still working on a clever API for this. At the moment the recipe API works as follows:
+Creating a blazing recipe is very easy. There are some ground rules:
 
 * recipes should live in gems called `blazing-<somename>`
 * blazing converts the symbol given in the config to the class name and calls run on it. So if you have `recipe :passenger_restart` blazing will try to run `Blazing::Recipe::PassengerRestart.run` with the options provided.
 * Recipes should live in the `Blazing::Recipe` namespace and inherit from `Blazing::Recipe` as well
 * Recipes are run in the order they are specified in the config, so there is no way to handle inter-recipe dependencies yet.
+* Make sure your recipe classes are loaded when the recipe gem itself is
+  loaded
 * A minimal recipe implementation might look like this:
 
 ```ruby
@@ -103,12 +176,26 @@ class Blazing::Recipe::Example < Blazing::Recipe
   end
 end
 ```
+Please have a look at [blazing-passenger](https://github.com/effkay/blazing-passenger) to get an idea of how to implement your recipe.
+
+Development
+-----------
+
+Pull requests are very welcome! Please try to follow these simple rules if applicable:
+
+* Please create a topic branch for every separate change you make.
+* Make sure your patches are well tested.
+* Update the README.
+* Update the CHANGELOG for noteworthy changes.
+* Please **do not change** the version number.
 
-## Authors
+Authors
+-------
 
 Felipe Kaufmann ([@effkay][])
 
-## License
+License
+-------
 
 See the [MIT-LICENSE file](https://github.com/effkay/blazing/blob/master/MIT-LICENCE)
 

data/bin/blazing

@@ -1,38 +1,6 @@
 #!/usr/bin/env ruby
 
-require 'bundler'
-Bundler.setup
-
 require 'blazing'
-require 'blazing/config'
-require 'blazing/runner'
-require 'optparse'
-
-options = {}
-
-optparse = OptionParser.new do|opts|
-  opts.banner = "Usage: blazing <command> [options]"
-
-  opts.on( '-h', '--help', 'Display this screen' ) do
-    puts opts
-    exit
-  end
-
-  opts.on( '-f config', '--file config', 'specify config file location (defaults to config/blazing.rb)' ) do |file|
-    options[:file] = file
-  end
-end
-
-optparse.parse!(ARGV)
-
-command = ARGV[0]
-target = ARGV[1]
-
-if command == 'init'
-  config = nil
-else
-  config = Blazing::Config.parse(options[:file])
-end
+require 'blazing/cli'
 
-runner = Blazing::Runner.new(config, target)
-runner.exec(command)
+Blazing::CLI.start

data/blazing.gemspec

@@ -25,12 +25,14 @@ Gem::Specification.new do |s|
   s.add_development_dependency('rake','~> 0.9.2')
   s.add_development_dependency('rspec')
   s.add_development_dependency('guard')
-  s.add_development_dependency('guard-rspec')
-  s.add_development_dependency('growl')
+  s.add_development_dependency('guard-rspectacle')
+  s.add_development_dependency('ruby_gntp')
   s.add_development_dependency('rb-fsevent')
+  s.add_development_dependency('pry')
 
   s.add_dependency('grit')
   s.add_dependency('logging')
+  s.add_dependency('thor')
 
   # TODO: Get rid of those, just used for guessing recipe names etc in lib/recipes.rb
   s.add_dependency "activesupport"

data/lib/blazing.rb

@@ -1,8 +1,16 @@
-require "blazing/version"
 require "blazing/logger"
 
 module Blazing
 
+  autoload :CLI, 'blazing/cli'
+  autoload :Config, 'blazing/config'
+  autoload :Version, 'blazing/version'
+  autoload :DSLSetter, 'blazing/dsl_setter'
+  autoload :Recipe, 'blazing/recipe'
+  autoload :Runner, 'blazing/runner'
+  autoload :Shell, 'blazing/shell'
+  autoload :Target, 'blazing/target'
+
   TEMPLATE_ROOT = File.expand_path(File.dirname(__FILE__) + File.join('/', 'blazing', 'templates'))
   DEFAULT_CONFIG_LOCATION = 'config/blazing.rb'
   TMP_HOOK = '/tmp/post-receive'

data/lib/blazing/cli.rb

@@ -0,0 +1,65 @@
+require 'thor'
+require 'blazing/runner'
+
+module Blazing
+  class CLI < Thor
+
+    default_task :help
+
+    desc 'init', 'Generate a blazing config file'
+
+    #
+    # Bootstrap blazing by creating a sample config file
+    #
+    def init
+      Blazing::Runner.init
+    end
+
+    desc 'setup [TARGET]', 'Setup local and remote repository/repositories for deployment'
+
+    method_option :file,
+      :type    => :string,
+      :aliases => '-f',
+      :banner  => 'Specify a configuration file'
+
+    #
+    # Setup a target to be deployed with blazing
+    #
+    def setup(target_name = nil)
+      Blazing::Runner.new(target_name, options).setup
+    end
+
+    desc 'update [TARGET]', 'Re-Generate and uplaod hook based on current configuration'
+
+    method_option :file,
+      :type    => :string,
+      :aliases => '-f',
+      :banner  => 'Specify a configuration file'
+
+    #
+    # Update the target hook so it matches the settings in the config
+    #
+    def update(target_name = nil)
+      Blazing::Runner.new(target_name, options).update
+    end
+
+    desc 'recipes', 'Run the recipes'
+
+    #
+    # Run the configured blazing recipes (used on remote machien)
+    #
+    def recipes(target_name)
+      Blazing::Runner.new(target_name, options).recipes
+    end
+
+    desc 'list', 'List available recipes'
+
+    #
+    # List the available blazing recipes
+    #
+    def list
+      Blazing::Runner.list
+    end
+
+  end
+end

data/lib/blazing/config.rb

@@ -5,21 +5,20 @@ require 'blazing/dsl_setter'
 class Blazing::Config
 
   extend Blazing::DSLSetter
+  include Blazing::Logger
 
   attr_reader :file
   attr_accessor :targets, :recipes
-  dsl_setter :repository, :rvm, :rvm_scripts, :rake
+  dsl_setter :rvm, :rvm_scripts
 
   class << self
-
     def parse(configuration_file = nil)
-      Blazing::Recipe.load_recipes
+      Blazing::Recipe.load_recipes!
       config = self.new(configuration_file)
       config.instance_eval(File.read(config.file))
 
       config
     end
-
   end
 
   def initialize(configuration_file = nil)
@@ -37,12 +36,17 @@ class Blazing::Config
     @recipes << Blazing::Recipe.init_by_name(name, options)
   end
 
+  def rake(task_name, env = nil)
+    @rake = { :task => task_name }
+    @rake[:env] = env if env
+  end
+
+  def repository(*args)
+    warn 'Ther repository DSL method has been deprecated and is no longer used. This method will be removed in Version 0.3'
+  end
+
   def default_target
-    if @targets.size > 1
-      default = @targets.find { |t| t.options[:default] == true }
-      raise 'could not find default target' unless default
-      default
-    else
+    if @targets.size == 1
       @targets.first
     end
   end