capistrano-fanfare 0.0.8 → 0.0.9

data/README.md

@@ -20,6 +20,54 @@ Or install it yourself as:
 
 TODO: Write usage instructions here
 
+Create a `Capfile` that looks like:
+
+    load 'deploy'
+
+    require 'capistrano/fanfare'
+
+    fanfare_recipe 'defaults'
+    fanfare_recipe 'multistage'
+    fanfare_recipe 'git_style'
+    fanfare_recipe 'bundler'
+    fanfare_recipe 'assets'
+    fanfare_recipe 'db_seed'
+
+    fanfare_recipe 'foreman'
+    fanfare_recipe 'database_yaml'
+
+    fanfare_recipe 'colors'
+    fanfare_recipe 'ssh'
+    fanfare_recipe 'console'
+    fanfare_recipe 'campfire'
+
+    Dir['vendor/gems/*/recipes/*.rb','vendor/plugins/*/recipes/*.rb'].each { |plugin| load(plugin) }
+
+    load 'config/deploy'
+
+Pick and choose your fanfare recipes in `Capfile`--they are designed to work
+independently but also build off each other.
+
+Create a `config/deploy.rb` that looks like:
+
+    set :application, "myappname"
+    set :repository,  "git@mygitserver.com:myappname.git"
+
+    set :campfire_options,  :account => 'cfireaccount',
+                            :room => 'Dev room',
+                            :token => '010010010100101',
+                            :ssl => true
+
+Create a `config/deploy/staging.rb` (assuming the *multistage* recipe) that
+looks like:
+
+    deploy_server = "myserver.example.com"
+
+    role :web, deploy_server
+    role :app, deploy_server
+    role :db,  deploy_server, :primary => true
+    role :db,  deploy_server
+
 ## Contributing
 
 1. Fork it

data/lib/capistrano/fanfare/campfire.rb

@@ -69,11 +69,18 @@ module Capistrano::Fanfare::Campfire
       # ========================================================================
 
       namespace :campfire do
+        desc <<-DESC
+          [internal] Posts a message in Campfire before a deploy has started.
+        DESC
         task :pre_deploy do
           @deploy_start_time = Time.now
           speak fetch(:campfire_pre_msg)
         end
 
+        desc <<-DESC
+          [internal] Posts a message and plays a clip after a successful
+          deployment.
+        DESC
         task :successful_deploy do
           elapsed = @deploy_start_time ? Time.now - @deploy_start_time : 0
 
@@ -81,6 +88,10 @@ module Capistrano::Fanfare::Campfire
           play fetch(:campfire_success_play)
         end
 
+        desc <<-DESC
+          [internal] Posts a message and plays a clip after a failed
+          deployment.
+        DESC
         task :rollback_deploy do
           speak fetch(:campfire_fail_msg)
           play fetch(:campfire_fail_play)

data/lib/capistrano/fanfare/console.rb

@@ -0,0 +1,73 @@
+require 'capistrano'
+
+module Capistrano::Fanfare::Console
+  def self.load_into(configuration)
+    configuration.load do
+      def _cset(name, *args, &block)
+        unless exists?(name)
+          set(name, *args, &block)
+        end
+      end
+
+      on :load do
+        if find_task("foreman:start")
+          _cset :console_env_cmd, "foreman run"
+        elsif find_task("bundle:install")
+          _cset :console_env_cmd, "bundle exec"
+        end
+      end
+
+
+      # =========================================================================
+      # These are the tasks that are available to help with deploying web apps.
+      # You can have cap give you a summary of them with `cap -T'.
+      # =========================================================================
+
+      ##
+      # Gratiously found in the moonshine codebase and iterated on:
+      # https://github.com/railsmachine/moonshine
+
+      desc <<-DESC
+        Runs a rails/rack console on the first application server.
+      DESC
+      task :console, :roles => :app, :except => {:no_symlink => true} do
+        rack_env = fetch(:rails_env, nil) || fetch(:rack_env, nil) || "production"
+        env_cmd = fetch(:console_env_cmd, "")
+        input = ''
+
+        console_test = [
+          "if [ -f #{current_path}/script/console ] ; then echo rails2",
+          "; elif [ -f #{current_path}/script/rails ] ; then echo rails3",
+          "; elif [ -f #{current_path}/config.ru -a -f #{current_path}/Gemfile ]",
+            "&& grep 'gem.*racksh' #{current_path}/Gemfile >/dev/null",
+            "; then echo racksh",
+          "; else echo unknown ; fi"
+        ].join(' ')
+
+        case capture(console_test).strip
+        when "rails2"
+          command = "cd #{current_path} && #{env_cmd} ./script/console #{rack_env}"
+          prompt = /^(>|\?)>/
+        when "rails3"
+          command = "cd #{current_path} && #{env_cmd} rails console #{rack_env}"
+          prompt = /:\d{3}:\d+(\*|>)/
+        when "racksh"
+          command = "cd #{current_path} && #{env_cmd} racksh #{rack_env}"
+          prompt = /:\d{3}:\d+(\*|>)/
+        else
+          raise "A suitable rails/rack console could not be found."
+        end
+
+        run command do |channel, stream, data|
+          next if data.chomp == input.chomp || data.chomp == ''
+          print data
+          channel.send_data(input = $stdin.gets) if data =~ prompt
+        end
+      end
+    end
+  end
+end
+
+if Capistrano::Configuration.instance
+  Capistrano::Fanfare::Console.load_into(Capistrano::Configuration.instance)
+end

data/lib/capistrano/fanfare/db_seed.rb

@@ -0,0 +1,37 @@
+require 'capistrano'
+
+module Capistrano::Fanfare::DbSeed
+  def self.load_into(configuration)
+    configuration.load do
+
+      # =========================================================================
+      # These are the tasks that are available to help with deploying web apps.
+      # You can have cap give you a summary of them with `cap -T'.
+      # =========================================================================
+
+      namespace :db do
+
+        desc <<-DESC
+          Runs the rake db:seed task.
+
+          You can set the rails environment and full path to rake by setting some \
+          overriding variables. The defaults are:
+
+            set :rake,      "rake"
+            set :rails_env, "production"
+
+          [WARNING] This command is probably not safe to run multiple times.
+        DESC
+        task :seed, :roles => :db, :only => { :primary => true } do
+          rails_env = fetch(:rails_env, nil) || fetch(:rack_env, nil) || "production"
+
+          run %{cd #{current_path} && #{rake} RAILS_ENV=#{rails_env} db:seed}
+        end
+      end
+    end
+  end
+end
+
+if Capistrano::Configuration.instance
+  Capistrano::Fanfare::DbSeed.load_into(Capistrano::Configuration.instance)
+end

data/lib/capistrano/fanfare/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Fanfare
-    VERSION = "0.0.8"
+    VERSION = "0.0.9"
   end
 end

data/spec/console_spec.rb

@@ -0,0 +1,136 @@
+require 'minitest/autorun'
+require 'minitest/capistrano'
+require 'capistrano/fanfare'
+require 'capistrano/fanfare/console'
+require 'capistrano/fanfare/bundler'
+require 'capistrano/fanfare/foreman'
+
+describe Capistrano::Fanfare::Console do
+  before do
+    @config = Capistrano::Configuration.new
+    Capistrano::Fanfare::Console.load_into(@config)
+    @config.extend(MiniTest::Capistrano::ConfigurationExtension)
+  end
+
+  describe "for variables" do
+    it "sets :console_env_cmd to 'foreman run' if foreman recipe is loaded" do
+      Capistrano::Fanfare::Foreman.load_into(@config)
+      @config.trigger(:load)
+
+      @config.fetch(:console_env_cmd).must_equal "foreman run"
+    end
+
+    it "sets :console_env_cmd to 'bundle exec' if foreman recipe is loaded" do
+      Capistrano::Fanfare::Bundler.load_into(@config)
+      @config.trigger(:load)
+
+      @config.fetch(:console_env_cmd).must_equal "bundle exec"
+    end
+  end
+
+  describe "for :console task" do
+    before do
+      @config.set :current_path, "/app/current"
+    end
+
+    let(:console_test) do
+      [ "if [ -f /app/current/script/console ] ; then echo rails2",
+        "; elif [ -f /app/current/script/rails ] ; then echo rails3",
+        "; elif [ -f /app/current/config.ru -a -f /app/current/Gemfile ]",
+          "&& grep 'gem.*racksh' /app/current/Gemfile >/dev/null",
+          "; then echo racksh",
+        "; else echo unknown ; fi"
+      ].join(' ')
+    end
+
+    it "runs a rails 2.x console if script/console is detected" do
+      @config.captures_responses[console_test] = "rails2\n"
+      @config.find_and_execute_task("console")
+
+      @config.must_have_run "cd /app/current &&  ./script/console production"
+    end
+
+    it "runs a rails 2.x console with 'forman run'" do
+      Capistrano::Fanfare::Bundler.load_into(@config)
+      Capistrano::Fanfare::Foreman.load_into(@config)
+      @config.trigger(:load)
+      @config.captures_responses[console_test] = "rails2\n"
+      @config.find_and_execute_task("console")
+
+      @config.must_have_run(
+        "cd /app/current && foreman run ./script/console production")
+    end
+
+    it "runs a rails 2.x console with 'bundle exec'" do
+      Capistrano::Fanfare::Bundler.load_into(@config)
+      @config.trigger(:load)
+      @config.captures_responses[console_test] = "rails2\n"
+      @config.find_and_execute_task("console")
+
+      @config.must_have_run(
+        "cd /app/current && bundle exec ./script/console production")
+    end
+
+    it "runs a rails 3.x console if script/rails is detected" do
+      @config.captures_responses[console_test] = "rails3\n"
+      @config.find_and_execute_task("console")
+
+      @config.must_have_run "cd /app/current &&  rails console production"
+    end
+
+    it "runs a rails 3.x console with 'foreman run'" do
+      Capistrano::Fanfare::Bundler.load_into(@config)
+      Capistrano::Fanfare::Foreman.load_into(@config)
+      @config.trigger(:load)
+      @config.captures_responses[console_test] = "rails3\n"
+      @config.find_and_execute_task("console")
+
+      @config.must_have_run(
+        "cd /app/current && foreman run rails console production")
+    end
+
+    it "runs a rails 3.x console with 'bundle exec'" do
+      Capistrano::Fanfare::Bundler.load_into(@config)
+      @config.trigger(:load)
+      @config.captures_responses[console_test] = "rails3\n"
+      @config.find_and_execute_task("console")
+
+      @config.must_have_run(
+        "cd /app/current && bundle exec rails console production")
+    end
+
+    it "runs racksh if the racksh gem is detected in the Gemfile" do
+      @config.captures_responses[console_test] = "racksh\n"
+      @config.find_and_execute_task("console")
+
+      @config.must_have_run "cd /app/current &&  racksh production"
+    end
+
+    it "runs racksh with 'foreman run'" do
+      Capistrano::Fanfare::Bundler.load_into(@config)
+      Capistrano::Fanfare::Foreman.load_into(@config)
+      @config.trigger(:load)
+      @config.captures_responses[console_test] = "racksh\n"
+      @config.find_and_execute_task("console")
+
+      @config.must_have_run(
+        "cd /app/current && foreman run racksh production")
+    end
+
+    it "runs racksh with 'bundle exec'" do
+      Capistrano::Fanfare::Bundler.load_into(@config)
+      @config.trigger(:load)
+      @config.captures_responses[console_test] = "racksh\n"
+      @config.find_and_execute_task("console")
+
+      @config.must_have_run(
+        "cd /app/current && bundle exec racksh production")
+    end
+
+    it "raises an exception if no suitable console if found" do
+      @config.captures_responses[console_test] = "unknown\n"
+
+      proc { @config.find_and_execute_task("console") }.must_raise RuntimeError
+    end
+  end
+end

data/spec/db_seed_spec.rb

@@ -0,0 +1,25 @@
+require 'minitest/autorun'
+require 'minitest/capistrano'
+require 'capistrano/fanfare'
+require 'capistrano/fanfare/db_seed'
+
+describe Capistrano::Fanfare::DbSeed do
+  before do
+    @config = Capistrano::Configuration.new
+    Capistrano::Fanfare::DbSeed.load_into(@config)
+    @config.extend(MiniTest::Capistrano::ConfigurationExtension)
+  end
+
+  describe "for namespace :db" do
+    describe "for :seed task" do
+      it "runs the db:seed rake task" do
+        @config.set :current_path, "/a/current"
+        @config.set :rake, "bin/rake"
+        @config.find_and_execute_task("db:seed")
+
+        @config.must_have_run(
+          "cd /a/current && bin/rake RAILS_ENV=production db:seed")
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-fanfare
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-25 00:00:00.000000000 Z
+date: 2012-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
-  requirement: &70106299506720 !ruby/object:Gem::Requirement
+  requirement: &70156962133920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -21,10 +21,10 @@ dependencies:
         version: 2.10.0.pre
   type: :runtime
   prerelease: false
-  version_requirements: *70106299506720
+  version_requirements: *70156962133920
 - !ruby/object:Gem::Dependency
   name: capistrano_colors
-  requirement: &70106299506160 !ruby/object:Gem::Requirement
+  requirement: &70156962133340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '0.5'
   type: :runtime
   prerelease: false
-  version_requirements: *70106299506160
+  version_requirements: *70156962133340
 - !ruby/object:Gem::Dependency
   name: sushi
-  requirement: &70106299505620 !ruby/object:Gem::Requirement
+  requirement: &70156962132820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 0.0.2
   type: :runtime
   prerelease: false
-  version_requirements: *70106299505620
+  version_requirements: *70156962132820
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70106299505060 !ruby/object:Gem::Requirement
+  requirement: &70156962132240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 2.10.0
   type: :development
   prerelease: false
-  version_requirements: *70106299505060
+  version_requirements: *70156962132240
 - !ruby/object:Gem::Dependency
   name: minitest-capistrano
-  requirement: &70106299504560 !ruby/object:Gem::Requirement
+  requirement: &70156962131740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '0.0'
   type: :development
   prerelease: false
-  version_requirements: *70106299504560
+  version_requirements: *70156962131740
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: &70106299503980 !ruby/object:Gem::Requirement
+  requirement: &70156962131180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,7 +76,7 @@ dependencies:
         version: '0.3'
   type: :development
   prerelease: false
-  version_requirements: *70106299503980
+  version_requirements: *70156962131180
 description: Capistrano recipes (with full test suite) for fanfare application deployment
   framework
 email:
@@ -97,7 +97,9 @@ files:
 - lib/capistrano/fanfare/bundler.rb
 - lib/capistrano/fanfare/campfire.rb
 - lib/capistrano/fanfare/colors.rb
+- lib/capistrano/fanfare/console.rb
 - lib/capistrano/fanfare/database_yaml.rb
+- lib/capistrano/fanfare/db_seed.rb
 - lib/capistrano/fanfare/defaults.rb
 - lib/capistrano/fanfare/foreman.rb
 - lib/capistrano/fanfare/foreman/strategy.rb
@@ -112,7 +114,9 @@ files:
 - spec/bundler_spec.rb
 - spec/campfire_spec.rb
 - spec/colors_spec.rb
+- spec/console_spec.rb
 - spec/database_yaml_spec.rb
+- spec/db_seed_spec.rb
 - spec/defaults_spec.rb
 - spec/fixtures/Procfile
 - spec/fixtures/fanfare/bark.rb
@@ -138,7 +142,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1649157397655448049
+      hash: -2785244211495022277
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -147,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1649157397655448049
+      hash: -2785244211495022277
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10
@@ -160,7 +164,9 @@ test_files:
 - spec/bundler_spec.rb
 - spec/campfire_spec.rb
 - spec/colors_spec.rb
+- spec/console_spec.rb
 - spec/database_yaml_spec.rb
+- spec/db_seed_spec.rb
 - spec/defaults_spec.rb
 - spec/fixtures/Procfile
 - spec/fixtures/fanfare/bark.rb