caplets 1.0.0 → 1.0.2

data/CHANGELOG

@@ -1,2 +1,7 @@
+== 1.0.1
+  * bundle:install now uses `bundle check` to short-circuit if possible
+  * Add deploy:passenger:reload
+  * Add ssh, ssh:app, and ssh:web
+
 == 1.0.0
   * Initial public release

data/MODULES.md

@@ -1,10 +1,9 @@
 Caplets Modules
 ===============
 
-caplets/deploy
---------------
+## caplets/deploy
 
-#### Variables
+### Variables
 
 `:bin_cmd` - Command used to execute binaries within the context of the app.
   For instance, `caplets/bundle` sets this to `gem exec`. (default: `nil`)
@@ -24,12 +23,12 @@ caplets/deploy
 
 `:user` - UNIX user as which to login and run deploys. (default: `deploy`)
 
-### caplets/bundle
+## caplets/bundle
 
 Bundler 0.9+ support. By default, run after every code update, this `bundle
 install`s gems into the project (not into system gems to avoid using `sudo`).
 
-#### Variables
+### Variables
 
 `:bundle_exclude` - Bundler groups to exclude from installation. Passed to
   bundler's `--without` switch. (default: `%w[development test]`)
@@ -39,16 +38,16 @@ install`s gems into the project (not into system gems to avoid using `sudo`).
 `:bundle_to` - Subdirectory of the application in which to put installed gems.
   Passed as an argument to `bundle install`. (default: `vendor/bundled_gems`)
 
-#### Tasks
+### Tasks
 
 `deploy:bundle:install` - Runs a `bundle install` to install needed gems from
   the application's Gemfile.
 
-#### Hooks
+### Hooks
 
 `deploy:bundle:install` after `deploy:update_code`
 
-### caplets/db
+## caplets/db
 
 Tasks to support using ActiveRecord within your applications. This module
 adds functionality to write out your `database.yml` file and provides a
@@ -59,7 +58,7 @@ deployed to your DB server. This means you don't even have to list it in your
 deploy file. Instead, it expects to run your migrations from your `:primary
 :app` server.
 
-#### Variables
+### Variables
 
 `:db_host` - default: `localhost`
 `:db_adapter` - default: `mysql`
@@ -77,7 +76,7 @@ for your current `:environment`. If you'd rather, you can specify the entire
   environment key. Useful for adding access to slaves or other DBs.
   (default: {})
 
-#### Tasks
+### Tasks
 
 `deploy:db:config` - Write a generated `database.yml` to your project's config
   directory.
@@ -87,26 +86,26 @@ for your current `:environment`. If you'd rather, you can specify the entire
 `deploy:migrations` - Do a deploy with migrations, including doing a
   `web:disable` first and restarting (not reloading) the backends
 
-#### Hooks
+### Hooks
 
 `deploy:db:config` after `deploy:setup`
 
-### caplets/git-tag
+## caplets/git-tag
 
 Automatically tag a revision on deploy.
 
-#### Tasks
+### Tasks
 
 `git:tag_current_release` - Tag the `:current_revision` with a tag like
 `deploy-<environment>-<timestamp>` and push it to the origin.
 
-#### Hooks
+### Hooks
 
 `git:tag_current_release` after `deploy:migrations`
 `git:tag_current_release` after `deploy:quick`
 `git:tag_current_release` after `deploy:rebuild`
 
-### caplets/memcached
+## caplets/memcached
 
 Support for keeping track of memcached nodes and writing a `memcached.yml`
 config file based on the `:memcached` role.
@@ -121,18 +120,30 @@ dynamically based on those servers' `:private_ip`s. Otherwise:
 ### Tasks
 
 `deploy:memcached:config` - Write a generated `memcached.yml` to your
-  projet's config directory.
+  project's config directory.
 
 ### Hooks
 
 `deploy:memcached:config` after `deploy:setup`
 
-### caplets/mongrel
+## caplets/mongrel
 
-### caplets/networkfs
+## caplets/networkfs
 
 ## caplets/passenger
 
+## caplets/ssh
+
+Tasks that present a list of your configured servers, and provide quick SSH
+access to any of them. The server list can optionally be narrowed down by
+role.
+
+### Tasks
+
+`ssh` - Connects to any configured server. (Usage: `cap <environment> ssh`)
+`ssh:app` - Connects to any configured app server.
+`ssh:web` - Connects to any configured web server.
+
 ## caplets/thinking-sphinx
 
 ## caplets/unicorn

data/lib/caplets/basic.rb

@@ -9,3 +9,4 @@ config.instance_eval do
 end
 
 config.load 'caplets/deploy'
+config.load 'caplets/ssh'

data/lib/caplets/bundle.rb

@@ -10,7 +10,7 @@ namespace :deploy do
     task :install, :roles => lambda { fetch(:bundle_roles) },
                    :except => {:no_release => true} do
       without = fetch(:bundle_exclude).map{|g| "--without #{g}"}.join(' ')
-      run_current "bundle install #{fetch(:bundle_to)} #{without}"
+      run_current "bundle check || bundle install #{fetch(:bundle_to)} #{without}"
     end
   end
 end

data/lib/caplets/deploy.rb

@@ -56,16 +56,13 @@ namespace :deploy do
 
   desc "Setup a Git-based deploy"
   task :setup, :except => {:no_release => true} do
-    run_multi(
-      "if [ -d #{fetch(:current_path)}/.git ]",
-      "then cd #{fetch(:current_path)}",
-      "#{try_sudo} git fetch",
-      "else #{try_sudo} git clone #{fetch(:repository)} #{fetch(:current_path)}",
-      "fi",
-      "mkdir -p " + fetch(:required_children,[]).
-                      map {|dir| "#{fetch(:current_path)}/#{dir}" }.
-                      join(' ')
-    )
+    run "if [ -d #{fetch(:current_path)}/.git ] ; "+
+        "then cd #{fetch(:current_path)} && #{try_sudo} git fetch ; "+
+        "else #{try_sudo} git clone #{fetch(:repository)} #{fetch(:current_path)} ; "+
+        "fi && "+
+        "mkdir -p " + fetch(:required_children,[]).
+                        map {|dir| "#{fetch(:current_path)}/#{dir}" }.
+                        join(' ')
   end
 
   desc <<-DESC
@@ -95,15 +92,15 @@ namespace :deploy do
 
   # Just timestamps, please
   task :finalize_update, :except => { :no_release => true } do
-  if fetch(:normalize_asset_timestamps, false)
-    stamp = Time.now.utc.strftime("%Y%m%d%H%M.%S")
-    asset_paths = %w(images stylesheets javascripts).map {|p|
-      "#{latest_release}/public/#{p}"
-    }.join(" ")
-    run "find #{asset_paths} -exec touch -t #{stamp} {} ';'; true",
-      :env => { "TZ" => "UTC" }
+    if fetch(:normalize_asset_timestamps, false)
+      stamp = Time.now.utc.strftime("%Y%m%d%H%M.%S")
+      asset_paths = %w(images stylesheets javascripts).map {|p|
+        "#{latest_release}/public/#{p}"
+      }.join(" ")
+      run "find #{asset_paths} -exec touch -t #{stamp} {} ';'; true",
+        :env => { "TZ" => "UTC" }
+    end
   end
-end
 
   %w[start stop restart reload].each do |taskname|
     desc "#{taskname.capitalize} the application server(s)"

data/lib/caplets/mongrel.rb

@@ -20,19 +20,22 @@ namespace :deploy do
     desc "Start the mongrel_cluster"
     task :start, :roles => :app do
       run "cd #{current_path} && " +
-        "mongrel_rails cluster::start -C #{shared_path}/config/cluster.yml --clean"
+        fetch(:bin_cmd,'') +
+        " mongrel_rails cluster::start -C #{shared_path}/config/cluster.yml --clean"
     end
 
     desc "Stop the mongrel_cluster"
     task :stop, :roles => :app do
       run "cd #{current_path} && " +
-        "mongrel_rails cluster::stop -C #{shared_path}/config/cluster.yml --clean"
+        fetch(:bin_cmd,'') +
+        " mongrel_rails cluster::stop -C #{shared_path}/config/cluster.yml --clean"
     end
 
     desc "Restart the mongrel_cluster"
     task :restart, :roles => :app do
       run "cd #{current_path} && " +
-        "mongrel_rails cluster::restart -C #{shared_path}/config/cluster.yml --clean"
+        fetch(:bin_cmd,'') +
+        " mongrel_rails cluster::restart -C #{shared_path}/config/cluster.yml --clean"
     end
 
     desc "Restart the mongrel_cluster, as mongrel does not support reloading"

data/lib/caplets/passenger.rb

@@ -6,14 +6,11 @@ namespace :deploy do
     task :start, :roles => :app, :except => {:no_release => true} do; end
     task :stop, :roles => :app, :except => {:no_release => true} do; end
 
-    desc 'Restart the Passenger processes by touching tmp/restart.txt'
-    task :restart, :roles => :app, :except => {:no_release => true} do
-      run "touch #{current_path}/tmp/restart.txt"
-    end
-
-    desc 'Restart the Passenger process by touching tmp/restart.txt'
-    task :restart, :roles => :app, :except => {:no_release => true} do
-      run "touch #{current_path}/tmp/restart.txt"
+    [:restart, :reload].each do |action|
+      desc 'Restart the Passenger processes by touching tmp/restart.txt'
+      task action, :roles => :app, :except => {:no_release => true} do
+        run "touch #{current_path}/tmp/restart.txt"
+      end
     end
   end # namespace :passenger
 end # namespace :deploy

data/lib/caplets/ssh.rb

@@ -0,0 +1,54 @@
+module Caplets::SSH
+  def ssh_to_server(opts={})
+    servers = []
+    selected_role = opts[:role] ? opts[:role].to_sym : nil
+    task_roles = selected_role ? {selected_role => roles[selected_role]} :
+                                 roles.sort_by(&:to_s)
+
+    # Convert from an array of roles (i.e., servers grouped by role) to an
+    # array of server data hashes (i.e., roles grouped by server)
+    task_roles.each do |role_name, role|
+      role.servers.each do |role_server|
+        role_server_data = servers.detect { |s| s[:host] == role_server.host }
+        if role_server_data
+          role_server_data[:role_names] << role_name
+        else
+          servers << {:host => role_server.host, :role_names => [role_name]}
+        end
+      end
+    end
+
+    # Prompt for a server if needed
+    if servers.size > 1
+      env_desc = "#{fetch(:environment)} #{selected_role}".strip
+      puts "\nWhich #{env_desc} server?"
+      servers.each_with_index do |server, i|
+        server_desc = server[:host].dup
+        unless selected_role
+          server_desc << " (#{server[:role_names].join(', ')})"
+        end
+        puts "  #{(i+1).to_s.rjust(2)}. #{server_desc}"
+      end
+      input = Capistrano::CLI.ui.
+        ask('>  ', Integer) { |q| q.in = 1..servers.size }
+      host = servers[input - 1][:host]
+    else
+      host = servers.first[:host]
+    end
+
+    cmd = %|ssh -t #{fetch(:user)}@#{host} "cd #{fetch(:current_path)}; bash"|
+    puts "Connecting to #{host}..."
+    exec(cmd)
+  end
+end
+Capistrano::Configuration.send :include, Caplets::SSH
+
+namespace :ssh do
+  desc 'SSH into any configured server'
+  task(:default) { ssh_to_server } # Usage: `cap production ssh`, etc.
+
+  [:app, :web].each do |role|
+    desc "SSH into any configured #{role} server"
+    task(role.to_sym) { ssh_to_server(:role => role) }
+  end
+end

data/lib/caplets/unicorn.rb

@@ -4,7 +4,8 @@ namespace :deploy do
   namespace :unicorn do
 
     def start_cmd
-      "#{fetch(:_unicorn_cmd,'unicorn')} -D" +
+      fetch(:bin_cmd,'') +
+      " #{fetch(:_unicorn_cmd,'unicorn')} -D" +
       " -c config/unicorn.rb" +
       " -E #{fetch(:environment)}"
     end

data/lib/caplets/utils.rb

@@ -1,7 +1,12 @@
 # This is just a collection of handy methods to use while writing tasks
 module Caplets::Utils
   def rake(cmd)
-    run_current "RAILS_ENV=#{fetch(:environment)} rake #{cmd}"
+    run_current [
+      "RAILS_ENV=#{fetch(:environment)}",
+      fetch(:bin_cmd,''),
+      fetch(:rake, 'rake'),
+      cmd
+    ].join(' ')
   end
 
   def run_current(*cmds)

data/lib/caplets/version.rb

@@ -2,7 +2,7 @@ module Caplets
   module Version
     MAJOR = 1
     MINOR = 0
-    TINY  = 0
+    TINY  = 2
     BUILD = nil
     STRING = [MAJOR,MINOR,TINY,BUILD].compact.join('.')
   end

data/lib/caplets/whenever.rb

@@ -9,7 +9,7 @@ namespace :deploy do
       load_file = "config/whenever/#{fetch(:environment)}.#{role}.rb"
       [ "cd #{fetch(:current_path)} &&",
         "if [ -f #{load_file} ] ; then",
-          "#{fetch(:bin_cmd)} whenever",
+          "#{fetch(:bin_cmd,'')} whenever",
           "--update-crontab #{fetch(:application)}.#{fetch(:environment)}.#{role}",
           "--load-file #{load_file}",
           "--set environment=#{fetch(:environment)}",

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: caplets
 version: !ruby/object:Gem::Version 
+  hash: 19
   prerelease: false
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 2
+  version: 1.0.2
 platform: ruby
 authors: 
 - Dean Strelau
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-08 00:00:00 -04:00
+date: 2010-10-27 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: capistrano
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 27
         segments: 
         - 2
         - 5
@@ -51,6 +54,7 @@ files:
 - lib/caplets/mongrel.rb
 - lib/caplets/networkfs.rb
 - lib/caplets/passenger.rb
+- lib/caplets/ssh.rb
 - lib/caplets/thinking-sphinx.rb
 - lib/caplets/unicorn.rb
 - lib/caplets/unicorn_rails.rb
@@ -74,23 +78,27 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Capistrano super powers