capistrano-recipes 0.4.1 → 0.5.0

data/README.rdoc

@@ -7,18 +7,34 @@ Useful Capistrano recipes including:
 * Log rotation and tailing commands
 * Restart and profile Phusion Passenger application server
 
+==Included Tasks
+
+* cap db:create_yaml
+* cap db:mysql:setup
+* cap log:rotate
+* cap log:tail
+* cap passenger:bounce
+* cap passenger:memory
+* cap passenger:status
+* cap symlink:create_shared_dirs
+* cap symlink:shared_config_files
+* cap symlink:shared_directories
+
 ==Installation
 
 Easy as pie...
 
-Ensure you have the Capistrano and Capistrano extensions gems installed:
+Ensure you have the Capistrano gem installed:
 
   sudo gem install capistrano
+
+Optionally install the Capistrano extensions gem to give you multistage support:
+  
   sudo gem install capistrano-ext
 
 Install this gem:
 
-  sudo gem install webficient-capistrano-recipes --source=http://gems.github.com
+  sudo gem install capistrano-recipes --source=http://gemcutter.com
 
 To setup the initial Capistrano deploy file, go to your Rails app folder via command line and enter:
 
@@ -27,6 +43,7 @@ To setup the initial Capistrano deploy file, go to your Rails app folder via com
 Inside the newly created config/deploy.rb, add:
 
   require 'capistrano_recipes'
+  require 'capistrano/ext/multistage' # only require if you've installed Cap ext gem
 
 If you're running Phusion Passenger (http://www.modrails.com) be sure you add this line to config/deploy.rb:
 

data/Rakefile

@@ -11,7 +11,6 @@ begin
     gem.homepage = "http://github.com/webficient/capistrano-recipes"
     gem.authors = ["Phil Misiowiec"]
     gem.add_dependency('capistrano', ['>= 2.5.9'])
-    gem.add_dependency('capistrano-ext', ['>= 1.2.1'])
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
 rescue LoadError

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 1
+:patch: 0
 :major: 0
-:minor: 4
+:minor: 5

data/capistrano-recipes.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{capistrano-recipes}
-  s.version = "0.4.1"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Phil Misiowiec"]
-  s.date = %q{2009-09-29}
+  s.date = %q{2009-10-01}
   s.description = %q{Extend the Capistrano gem with these useful recipes}
   s.email = %q{phil@webficient.com}
   s.extra_rdoc_files = [
@@ -43,13 +43,10 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<capistrano>, [">= 2.5.9"])
-      s.add_runtime_dependency(%q<capistrano-ext>, [">= 1.2.1"])
     else
       s.add_dependency(%q<capistrano>, [">= 2.5.9"])
-      s.add_dependency(%q<capistrano-ext>, [">= 1.2.1"])
     end
   else
     s.add_dependency(%q<capistrano>, [">= 2.5.9"])
-    s.add_dependency(%q<capistrano-ext>, [">= 1.2.1"])
   end
 end

data/lib/capistrano_recipes.rb

@@ -1,6 +1,5 @@
 require 'capistrano'
 require 'capistrano/cli'
-require 'capistrano/ext/multistage'
 require 'helpers'
 
 Dir.glob(File.join(File.dirname(__FILE__), '/recipes/*.rb')).each { |f| load f }

data/lib/helpers.rb

@@ -2,8 +2,22 @@
 # These are helper methods that will be available to your recipes.
 # =========================================================================
 
+# automatically sets the environment based on presence of 
+# :stage (multistage gem), :rails_env, or RAILS_ENV variable; otherwise defaults to 'production'
+def environment  
+  if exists?(:stage)
+    stage
+  elsif exists?(:rails_env)
+    rails_env  
+  elsif(ENV['RAILS_ENV'])
+    ENV['RAILS_ENV']
+  else
+    "production"  
+  end
+end
+
 # Execute a rake task, example:
 #   run_rake log:clear
 def run_rake(task)
-  run "cd #{current_path} && rake #{task} RAILS_ENV=#{stage}"
+  run "cd #{current_path} && rake #{task} RAILS_ENV=#{environment}"
 end

data/lib/recipes/db.rb

@@ -23,8 +23,8 @@ Capistrano::Configuration.instance(:must_exist).load do
     
     desc "Create database.yml in shared path with settings for current stage and test env"
     task :create_yaml do      
-      set(:db_user) { Capistrano::CLI.ui.ask "Enter #{stage} database username:" }
-      set(:db_pass) { Capistrano::CLI.password_prompt "Enter #{stage} database password:" }
+      set(:db_user) { Capistrano::CLI.ui.ask "Enter #{environment} database username:" }
+      set(:db_pass) { Capistrano::CLI.password_prompt "Enter #{environment} database password:" }
       
       db_config = ERB.new <<-EOF
       base: &base
@@ -32,8 +32,8 @@ Capistrano::Configuration.instance(:must_exist).load do
         username: #{db_user}
         password: #{db_pass}
 
-      #{stage}:
-        database: #{application}_#{stage}
+      #{environment}:
+        database: #{application}_#{environment}
         <<: *base
 
       test:
@@ -43,17 +43,12 @@ Capistrano::Configuration.instance(:must_exist).load do
 
       put db_config.result, "#{shared_path}/config/database.yml"
     end
-      
-    desc "Create symlink for database yaml stored in shared path" 
-    task :symlink do
-      run "#{sudo} ln -nfs #{shared_path}/config/database.yml #{current_release}/config/database.yml" 
-    end
   end
     
   def prepare_for_db_command
-    set :db_name, "#{application}_#{stage}"
+    set :db_name, "#{application}_#{environment}"
     set(:db_admin_user) { Capistrano::CLI.ui.ask "Username with priviledged database access (to create db):" }
-    set(:db_user) { Capistrano::CLI.ui.ask "Enter #{stage} database username:" }
-    set(:db_pass) { Capistrano::CLI.password_prompt "Enter #{stage} database password:" }
+    set(:db_user) { Capistrano::CLI.ui.ask "Enter #{environment} database username:" }
+    set(:db_pass) { Capistrano::CLI.password_prompt "Enter #{environment} database password:" }
   end
 end

data/lib/recipes/deploy.rb

@@ -5,10 +5,9 @@ Capistrano::Configuration.instance(:must_exist).load do
     db.create_yaml if Capistrano::CLI.ui.agree("Create database.yml in app's shared path?")  
   end
   
-  after "deploy:update_code", "db:symlink"
+  after "deploy:update_code", "symlink:shared_config_files"
   
   namespace :deploy do
-    
     desc <<-DESC
       Restarts your application. If you are running Phusion Passenger, you can \
       explicitly set the server type:
@@ -33,6 +32,5 @@ Capistrano::Configuration.instance(:must_exist).load do
         try_runner "#{current_path}/script/process/reaper"
       end
     end
-    
   end
 end

data/lib/recipes/log.rb

@@ -1,9 +1,8 @@
 Capistrano::Configuration.instance(:must_exist).load do
   namespace :log do
-    
     desc "Tail application log file for the specified environment, e.g. cap staging log:tail"
     task :tail, :roles => :app do
-      run "tail -f #{shared_path}/log/#{stage}.log" do |channel, stream, data|
+      run "tail -f #{shared_path}/log/#{environment}.log" do |channel, stream, data|
         puts "#{channel[:host]}: #{data}"
         break if stream == :err
       end
@@ -13,7 +12,7 @@ Capistrano::Configuration.instance(:must_exist).load do
     Install log rotation script; optional args: days=7, size=5M, group (defaults to same value as :user)
     DESC
     task :rotate, :roles => :app do
-      rotate_script = %Q{#{shared_path}/log/#{stage}.log {
+      rotate_script = %Q{#{shared_path}/log/#{environment}.log {
         daily
         rotate #{ENV['days'] || 7}
         size #{ENV['size'] || "5M"}
@@ -25,6 +24,5 @@ Capistrano::Configuration.instance(:must_exist).load do
       "#{sudo} cp #{shared_path}/logrotate_script /etc/logrotate.d/#{application}"
       run "rm #{shared_path}/logrotate_script"
     end
-
   end
 end

data/lib/recipes/passenger.rb

@@ -1,6 +1,5 @@
 Capistrano::Configuration.instance(:must_exist).load do
   namespace :passenger do
-    
     desc "Restart Rails app running under Phusion Passenger by touching restart.txt"
     task :bounce, :roles => :app do
       run "#{sudo} touch #{current_path}/tmp/restart.txt"
@@ -15,6 +14,5 @@ Capistrano::Configuration.instance(:must_exist).load do
     task :status, :roles => :app do
       run "#{sudo} /opt/ruby-enterprise/bin/passenger-status"
     end
-    
   end
 end

data/lib/recipes/symlink.rb

@@ -1,22 +1,51 @@
 Capistrano::Configuration.instance(:must_exist).load do
+  unless exists?(:config_files)
+    set :config_files, 'database.yml'
+  end
+  
   namespace :symlink do
-    
     desc <<-DESC
-    Create shared directories
+    Create shared directories. Specify which directories are shared via:
+      set :shared_dirs, %w(avatars videos)
     DESC
     task :create_shared_dirs, :roles => :app do
-      symlinks.each { |link| run "mkdir -p #{shared_path}/#{link}" } if symlinks
+      shared_dirs.each { |link| run "mkdir -p #{shared_path}/#{link}" } if shared_dirs
     end
     
     desc <<-DESC
-    Create links to shared directories from current deployment's public directory
+    Create links to shared directories from current deployment's public directory.
+    Specify which directories are shared via:
+      set :shared_dirs, %w(avatars videos)
     DESC
-    task :create_links, :roles => :app do
-      symlinks.each { |link| 
+    task :shared_directories, :roles => :app do
+      shared_dirs.each do |link| 
         run "rm -rf #{release_path}/public/#{link}"
         run "ln -nfs #{shared_path}/#{link} #{release_path}/public/#{link}" 
-      } if symlinks
+      end if shared_dirs
     end
     
+    desc <<-DESC
+    Create links to config files stored in shared config directory.
+    Specify which config files to link using the following:
+      set :config_files, 'database.yml'
+    DESC
+    task :shared_config_files, :roles => :app do
+      config_files.each do |file_path|
+        begin
+          run "#{sudo} rm #{config_path}#{file_path}"         
+          run "#{sudo} ln -nfs #{shared_config_path}#{file_path} #{config_path}#{file_path}"
+        rescue
+          puts "Problem linking to #{file_path}. Be sure file already exists in #{shared_config_path}."
+        end
+      end if config_files
+    end
+  end
+  
+  def config_path
+    "#{current_release}/config/"
+  end
+  
+  def shared_config_path
+    "#{shared_path}/config/"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: capistrano-recipes
 version: !ruby/object:Gem::Version 
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors: 
 - Phil Misiowiec
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-29 00:00:00 -07:00
+date: 2009-10-01 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,16 +22,6 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 2.5.9
     version: 
-- !ruby/object:Gem::Dependency 
-  name: capistrano-ext
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.2.1
-    version: 
 description: Extend the Capistrano gem with these useful recipes
 email: phil@webficient.com
 executables: []