blazing 0.2.10 → 0.2.11

data/.rvmrc

@@ -4,22 +4,35 @@
 # development environment upon cd'ing into the directory
 
 # First we specify our desired <ruby>[@<gemset>], the @gemset name is optional.
-environment_id="ruby-1.9.2@blazing-rework"
+environment_id="ruby-1.9.3-p0@blazing"
+
+#
+# Uncomment following line if you want options to be set only for given project.
+#
+# PROJECT_JRUBY_OPTS=( --1.9 )
 
 #
 # First we attempt to load the desired environment directly from the environment
-# file. This is very fast and efficicent compared to running through the entire
+# file. This is very fast and efficient compared to running through the entire
 # CLI and selector. If you want feedback on which environment was used then
 # insert the word 'use' after --create as this triggers verbose mode.
 #
 if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
-  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]] ; then
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
   \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
 
-  [[ -s ".rvm/hooks/after_use" ]] && . ".rvm/hooks/after_use"
+  if [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]]
+  then
+    . "${rvm_path:-$HOME/.rvm}/hooks/after_use"
+  fi
 else
   # If the environment file has not yet been created, use the RVM CLI to select.
-  rvm --create  "$environment_id"
+  if ! rvm --create  "$environment_id"
+  then
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  fi
 fi
 
 #
@@ -28,22 +41,15 @@ fi
 # necessary.
 #
 # filename=".gems"
-# if [[ -s "$filename" ]] ; then
+# if [[ -s "$filename" ]]
+# then
 #   rvm gemset import "$filename" | grep -v already | grep -v listed | grep -v complete | sed '/^$/d'
 # fi
 
-#
-# If you use bundler and would like to run bundle each time you enter the
-# directory, you can uncomment the following code.
-#
-#   # Ensure that Bundler is installed. Install it if it is not.
-#   if ! command -v bundle >/dev/null; then
-#      printf "The rubygem 'bundler' is not installed. Installing it now.\n"
-#      gem install bundler
-#   fi
-#
-#   # Bundle while reducing excess noise.
-#   printf "Bundling your gems. This may take a few minutes on a fresh clone.\n"
-#   bundle | grep -v '^Using ' | grep -v ' is complete' | sed '/^$/d'
-#
+# If you use bundler, this might be useful to you:
+# if command -v bundle && [[ -s Gemfile ]]
+# then
+#   bundle install
+# fi
+
 

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## master
 
+## 0.2.11 - July 11, 2012 
+
+* add pimpmychangelog and pimp changelog
+* fix git/bundler related issue ([#60][])
+* deprecate `:default` option for target
+* pull hook out of target
+* refactor and improve specs
+* use `Blazing::Commands` in favor of `Blazing::Runner`
+* other misc refactorings
+
 ## 0.2.10 - February 7, 2012
 
 * Fix post-receive hook (use new syntax)
@@ -17,9 +27,9 @@
 * 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)
+  rake task ([#58][])
 * allow the RAILS_ENV to be specified for a target (will be used when
-  calling rake) (#58)
+  calling rake) ([#58][])
 
 ## 0.2.7 - November 24, 2011
 
@@ -37,7 +47,7 @@
 ## 0.2.4 - November 9, 2011
 
 * Fix logger, so the formatting does not get carried over to apps using
-  blazing. (#55)
+  blazing. ([#55][])
 
 ## 0.2.3 - November 1, 2011
 
@@ -65,20 +75,30 @@
 
 ## 0.1.2 - October 25, 2011
 
-* setup initializes an empty repository, so first push will work (#47)
+* setup initializes an empty repository, so first push will work ([#47][])
 
-* simplified cli workflow (#45):
+* simplified cli workflow ([#45][]):
   * update runs update and setup:local
   * setup:remote renamed to setup
   * setup:remote also runs update
 
 ## 0.1.1 - October 25, 2011
 
-* [BUG]: fix #48: dont bundle test and dev gems, do it quietly
-* [BUG]: fix #44: accept target as argument
-* [BUG]: fix #41: recipe gem loading issues resolved
+* [BUG]: fix [#48][]: dont bundle test and dev gems, do it quietly
+* [BUG]: fix [#44][]: accept target as argument
+* [BUG]: fix [#41][]: recipe gem loading issues resolved
 * remove documentation of external recipes
 
 ## 0.1.0 - October 24, 2011
 
 [@effkay]: https://github.com/effkay
+<!--- The following link definition list is generated by PimpMyChangelog --->
+[#41]: https://github.com/effkay/blazing/issues/41
+[#44]: https://github.com/effkay/blazing/issues/44
+[#45]: https://github.com/effkay/blazing/issues/45
+[#47]: https://github.com/effkay/blazing/issues/47
+[#48]: https://github.com/effkay/blazing/issues/48
+[#55]: https://github.com/effkay/blazing/issues/55
+[#58]: https://github.com/effkay/blazing/issues/58
+[#60]: https://github.com/effkay/blazing/issues/60
+[@effkay]: https://github.com/effkay

data/Gemfile

@@ -1,4 +1,3 @@
 source "http://rubygems.org"
 
-# Specify your gem's dependencies in blazing.gemspec
 gemspec

data/Guardfile

@@ -1,9 +1,17 @@
-guard :rspectacle, :version => 2, :cli => "--colour --fail-fast --format nested" do
+guard :rspec, :version => 2, :cli => "--colour --fail-fast --format nested" do
+
+  # Generated: by guard-rspec
+  watch(%r{^spec/.+_spec\.rb})
+  watch(%r{^lib/(.+)\.rb})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { "spec" }
+
+  # Not Generated
   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" }
   watch('spec/spec_helper.rb') { "spec" }
   watch(%r{^lib/blazing/templates/(.+)}) { "spec" }
-  watch('lib/blazing/runner.rb') { "spec/blazing/integration/*" }
+  watch('lib/blazing/cli.rb') { "spec/blazing/integration/*" }
+  watch('lib/blazing/commands.rb') { "spec/blazing/integration/*" }
 end

data/README.md

@@ -10,7 +10,7 @@ Not everyone can or wants to deploy on heroku. But now you can have the same (we
 Quickstart
 ----------
 
-`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>`.
+`blazing init`, edit your blazing config, run `blazing setup [target]` to deploy your post-receive hook and you're set. Deploy with `git push <target> <branch>`.
 
 Features
 --------
@@ -77,7 +77,7 @@ List available recipes
 
 Run the configured recipes (used on deployment target, can be used to test recipes localy)
 
-The `setup` and `update` commands also take 'all' as an option. This .
+The `setup` and `update` commands also take 'all' as an option. This will perform the action on all your defined targets.
 
 #### Configuration (blazing DSL)
 
@@ -92,7 +92,7 @@ The `setup` and `update` commands also take 'all' as an option. This .
 # 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',
+target :staging, 'user@server:/var/www/someproject.com',
        :recipe_specific_option => 'foo', :rails_env => 'production'
 
 

data/blazing.gemspec

@@ -1,18 +1,20 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "blazing/version"
 
 Gem::Specification.new do |s|
   s.name        = "blazing"
-  s.version     = Blazing::VERSION
+
+  #
+  # TODO: Remove Config.repository in 0.3
+  #
+  s.version     = '0.2.11'
+
   s.authors     = ["Felipe Kaufmann"]
   s.email       = ["felipekaufmann@gmail.com"]
   s.homepage    = "https://github.com/effkay/blazing"
   s.summary     = %q{git push deployment helper}
   s.description = %q{painless git push deployments for everyone}
-
   s.rubyforge_project = "blazing"
-
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
@@ -25,10 +27,11 @@ 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-rspectacle')
+  s.add_development_dependency('guard-rspec')
   s.add_development_dependency('ruby_gntp')
   s.add_development_dependency('rb-fsevent')
   s.add_development_dependency('pry')
+  s.add_development_dependency('pimpmychangelog')
 
   s.add_dependency('grit')
   s.add_dependency('logging')

data/lib/blazing/cli.rb

@@ -1,5 +1,5 @@
 require 'thor'
-require 'blazing/runner'
+require 'blazing/commands'
 
 module Blazing
   class CLI < Thor
@@ -12,7 +12,7 @@ module Blazing
     # Bootstrap blazing by creating a sample config file
     #
     def init
-      Blazing::Runner.init
+      Blazing::Commands.run(:init)
     end
 
     desc 'setup [TARGET]', 'Setup local and remote repository/repositories for deployment'
@@ -26,7 +26,7 @@ module Blazing
     # Setup a target to be deployed with blazing
     #
     def setup(target_name = nil)
-      Blazing::Runner.new(target_name, options).setup
+      Blazing::Commands.run(:setup, :target_name => target_name, :options => options)
     end
 
     desc 'update [TARGET]', 'Re-Generate and uplaod hook based on current configuration'
@@ -40,7 +40,7 @@ module Blazing
     # Update the target hook so it matches the settings in the config
     #
     def update(target_name = nil)
-      Blazing::Runner.new(target_name, options).update
+      Blazing::Commands.run(:update, :target_name => target_name, :options => options)
     end
 
     desc 'recipes [TARGET]', 'Run the recipes for the given target'
@@ -49,7 +49,7 @@ module Blazing
     # Run the configured blazing recipes (used on remote machien)
     #
     def recipes(target_name)
-      Blazing::Runner.new(target_name, options).recipes
+      Blazing::Commands.run(:recipes, :target_name => target_name, :options => options)
     end
 
     desc 'list', 'List available recipes'
@@ -58,8 +58,7 @@ module Blazing
     # List the available blazing recipes
     #
     def list
-      Blazing::Runner.list
+      Blazing::Commands.run(:list)
     end
-
   end
 end

data/lib/blazing/commands.rb

@@ -0,0 +1,72 @@
+module Blazing
+  class Commands
+
+    include Logger
+
+    class << self
+      def run(command, options = {})
+        self.new(options).send(command)
+      end
+    end
+
+    def initialize(options = {})
+      warn 'The :default Target option has been deprecated and will be ignored' if options.has_key?(:default)
+
+      @target_name = options[:target_name]
+      @config_file = options[:file]
+
+      @config ||= Config.parse(@config_file)
+      @targets = determine_targets
+
+      error 'no target given or found' if @targets.empty?
+
+      # TODO: better exception handling, like this?
+      #raise RuntimeError if @targets.empty?
+    end
+
+    def init
+      info "Creating an example config file in #{Blazing::DEFAULT_CONFIG_LOCATION}"
+      info "Customize it to your needs"
+      create_config_directory
+      write_config_file
+    end
+
+    def setup
+      @targets.each { |target| target.setup }
+      update
+    end
+
+    def update
+      @targets.each { |target| target.update }
+    end
+
+    def recipes
+      @config.recipes.each { |recipe| recipe.run }
+    end
+
+    def list
+      Blazing::Recipe.pretty_list
+    end
+
+    private
+
+    def create_config_directory
+      Dir.mkdir 'config' unless File.exists? 'config'
+    end
+
+    def write_config_file
+      config = ERB.new(File.read("#{Blazing::TEMPLATE_ROOT}/config.erb")).result
+      File.open(Blazing::DEFAULT_CONFIG_LOCATION,"wb") { |f| f.puts config }
+    end
+
+    def determine_targets
+      if @target_name == 'all'
+        @config.targets
+      else
+        targets = []
+        targets << @config.find_target(@target_name)
+        targets.compact
+      end
+    end
+  end
+end

data/lib/blazing/config.rb

@@ -51,4 +51,9 @@ class Blazing::Config
     end
   end
 
+  # TODO: Spec it!
+  def find_target(target_name)
+    targets.find { |t| t.name.to_s == target_name.to_s }
+  end
+
 end

data/lib/blazing/hook.rb

@@ -0,0 +1,85 @@
+module Blazing
+  class Hook
+
+    include Blazing::Logger
+
+    attr_accessor :target
+
+    def initialize(target)
+      @target = target
+      @config = target.config
+      @options = target.options
+      @shell = Blazing::Shell.new
+    end
+
+    def setup
+      prepare_hook
+      deploy_hook
+    end
+
+    def rake_command
+      rake_config = @config.instance_variable_get("@rake") || {}
+      rails_env = "RAILS_ENV=#{@options[:rails_env]}" if @options[:rails_env]
+
+      if rake_config[:task]
+        "#{rake_config[:env]} #{rails_env} bundle exec rake #{rake_config[:task]}"
+      end
+    end
+
+    private
+
+    def load_template(template_name)
+      ERB.new(File.read(find_template(template_name))).result(binding)
+    end
+
+    def find_template(template_name)
+      "#{Blazing::TEMPLATE_ROOT}/#{template_name}.erb"
+    end
+
+    def prepare_hook
+      info "Generating and uploading post-receive hook for #{@target.name}"
+      hook = generate_hook
+      write hook
+    end
+
+    def deploy_hook
+      debug "Copying hook for #{@target.name} to #{@target.location}"
+      copy_hook
+      set_hook_permissions
+    end
+
+    def generate_hook
+      load_template 'hook/base'
+    end
+
+    def write(hook)
+      File.open(Blazing::TMP_HOOK, "wb") do |f|
+        f.puts hook
+      end
+    end
+
+    def set_hook_permissions
+      if @target.host
+        @shell.run "ssh #{@target.user}@#{@target.host} #{make_hook_executable}"
+      else
+        @shell.run "#{make_hook_executable}"
+      end
+    end
+
+    def copy_hook
+      debug "Making hook executable"
+      # TODO: handle missing user?
+      if @target.host
+        @shell.run "scp #{Blazing::TMP_HOOK} #{@target.user}@#{@target.host}:#{@target.path}/.git/hooks/post-receive"
+      else
+        @shell.run "cp #{Blazing::TMP_HOOK} #{@target.path}/.git/hooks/post-receive"
+      end
+    end
+
+    def make_hook_executable
+      debug "Making hook executable"
+      "chmod +x #{@target.path}/.git/hooks/post-receive"
+    end
+  end
+end
+

data/lib/blazing/logger.rb

@@ -36,3 +36,4 @@ module Blazing
 
   end
 end
+

data/lib/blazing/recipe.rb

@@ -1,3 +1,4 @@
+require 'blazing/logger'
 require 'active_support/inflector'
 
 class Blazing::Recipe
@@ -34,5 +35,9 @@ class Blazing::Recipe
       gems.each { |gem| require gem }
     end
 
+    def pretty_list
+      list.each { |r| puts r.to_s.demodulize.underscore }
+    end
+
   end
 end

data/lib/blazing/repository.rb

@@ -0,0 +1,53 @@
+require 'grit'
+
+module Blazing
+  class Repository
+
+    include Blazing::Logger
+
+    def initialize(target)
+      @target = target
+      @shell = Blazing::Shell.new
+    end
+
+    def setup
+      # TODO: Handle case where user is empty
+      if @target.host
+        @shell.run "ssh #{@target.user}@#{@target.host} '#{init_repository} && #{setup_repository}'"
+      else
+        @shell.run "#{init_repository} && #{setup_repository}"
+      end
+    end
+
+    def add_git_remote
+      info "Adding new remote #{@target.name} pointing to #{@target.location}"
+      set_git_remote!
+    end
+
+    private
+
+    #
+    # Initialize an empty repository
+    #
+    def init_repository
+      # Instead of git init with a path, so it does not fail on older
+      # git versions (https://github.com/effkay/blazing/issues/53)
+      "mkdir #{@target.path}; cd #{@target.path} && git init"
+    end
+
+    #
+    # Allow pushing to currently checked out branch
+    #
+    def setup_repository
+      "cd #{@target.path} && git config receive.denyCurrentBranch ignore"
+    end
+
+    def grit_repository_object
+      @grit_object ||= Grit::Repo.new(Dir.pwd)
+    end
+
+    def set_git_remote!
+      grit_repository_object.config["remote.#{@target.name}.url"] = @target.location
+    end
+  end
+end

data/lib/blazing/target.rb

@@ -1,108 +1,52 @@
-require 'blazing/shell'
-require 'grit'
+module Blazing
 
-class Blazing::Target
+  class Target
 
-  include Blazing::Logger
+    include Blazing::Logger
 
-  attr_accessor :name, :location, :options
+    attr_accessor :name, :location, :options, :config
 
-  def initialize(name, location, config, options = {})
-    @name = name
-    @location = location
-    @config = config
-    @options = options
-    @shell = Blazing::Shell.new
-    @target = self
-  end
-
-  def setup
-    info "Setting up repository for #{name} in #{location}"
-
-    # TODO: Handle case where user is empty
-    if host
-      @shell.run "ssh #{user}@#{host} '#{init_repository} && #{setup_repository}'"
-    else
-      @shell.run "#{init_repository} && #{setup_repository}"
+    def initialize(name, location, config, options = {})
+      @name = name
+      @location = location
+      @config = config
+      @options = options
+      @target = self
     end
-  end
-
-  def apply_hook
-    info "Generating and uploading post-receive hook for #{name}"
-    hook = ERB.new(File.read("#{Blazing::TEMPLATE_ROOT}/hook.erb")).result(binding)
 
-    File.open(Blazing::TMP_HOOK, "wb") do |f|
-      f.puts hook
+    #
+    # Set up Repositories and Hook
+    #
+    def setup
+      info "Setting up repository for #{name} in #{location}"
+      Repository.new(self).setup
     end
 
-    debug "Copying hook for #{name} to #{location}"
-    copy_hook
-    if host
-      @shell.run "ssh #{user}@#{host} #{make_hook_executable}"
-    else
-      @shell.run "#{make_hook_executable}"
+    #
+    # Update git remote and hook
+    #
+    def update
+      Repository.new(self).add_git_remote
+      Hook.new(self).setup
     end
-  end
 
-  def setup_git_remote
-    repository = Grit::Repo.new(Dir.pwd)
-    info "Adding new remote #{name} pointing to #{location}"
-    repository.config["remote.#{name}.url"] = location
-  end
-
-  def path
-    if host
-      @location.match(/:(.*)$/)[1]
-    else
-      @location
+    def path
+      if host
+        @location.match(/:(.*)$/)[1]
+      else
+        @location
+      end
     end
-  end
 
-  def host
-    host = @location.match(/@(.*):/)
-    host[1] unless host.nil?
-  end
-
-  def user
-    user = @location.match(/(.*)@/)
-    user[1] unless user.nil?
-  end
-
-  #
-  # Initialize an empty repository, so we can push to it
-  #
-  def init_repository
-    # Instead of git init with a path, so it does not fail on older
-    # git versions (https://github.com/effkay/blazing/issues/53)
-    "mkdir #{path}; cd #{path} && git init"
-  end
-
-  def copy_hook
-    debug "Making hook executable"
-    # TODO: handle missing user?
-    if host
-      @shell.run "scp #{Blazing::TMP_HOOK} #{user}@#{host}:#{path}/.git/hooks/post-receive"
-    else
-      @shell.run "cp #{Blazing::TMP_HOOK} #{path}/.git/hooks/post-receive"
+    def host
+      host = @location.match(/@(.*):/)
+      host[1] unless host.nil?
     end
-  end
-
-  def make_hook_executable
-    debug "Making hook executable"
-    "chmod +x #{path}/.git/hooks/post-receive"
-  end
 
-  def setup_repository
-    "cd #{path} && git config receive.denyCurrentBranch ignore"
-  end
-
-  def rake_command
-    rake_config = @config.instance_variable_get("@rake") || {}
-    rails_env = "RAILS_ENV=#{@options[:rails_env]}" if @options[:rails_env]
-
-    if rake_config[:task]
-      "#{rake_config[:env]} #{rails_env} bundle exec rake #{rake_config[:task]}"
+    def user
+      user = @location.match(/(.*)@/)
+      user[1] unless user.nil?
     end
   end
-
 end
+

data/lib/blazing/templates/config.erb

@@ -11,7 +11,7 @@
 # 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',
+target :staging, 'user@server:/var/www/someproject.com',
        :recipe_specific_option => 'foo', :rails_env => 'production'