deployer 0.1.3 → 0.1.4

data/README.md

@@ -2,7 +2,11 @@
 
 Deployer is gem that enhances Capistrano to simplify the deployment of Ruby on Rails applications.
 
-It assumes you are using Passenger to serve your Ruby on Rails applications.
+It assumes you are using Passenger to serve your Ruby on Rails applications, and Bundler to manage gem dependencies.
+
+It works with **Ruby on Rails 3** and **Ruby on Rails 2** applications as long as you are using **Bundler**.
+
+*If you are currently using the old config.gem method in a Ruby on Rails 2 application, you can easily change this to make it use Bundler instead. [Check out my gist on how to achieve Rails 2 Bundler compatibility.](http://gist.github.com/400609)*
 
 
 ## Getting Started
@@ -146,7 +150,7 @@ Here you can specify that you want to pull/push from/to a git repository that's
 
 And then here is the last bit of server configuration you can specify.
 
-### *Adding Application Specific Deployment Tasks*
+### Adding Application Specific Deployment Tasks
 
 Inside the *namespace :deploy do* block you can define your own deployment tasks that are specific to your application.
 

data/bin/enhancify

@@ -1,5 +1,15 @@
 #!/usr/bin/env ruby
 
+require 'rubygems'
+
+begin
+  require 'optparse'
+rescue LoadError
+  puts '[Deployer] => Tried load load OptionParser but could not find it.'
+  puts '[Deployer] => Install Option Parser ( gem install OptionParser ) and try again.'
+  exit
+end
+
 options = {}
 
 optparse = OptionParser.new do |opts|
@@ -59,12 +69,13 @@ File.open(File.join(File.dirname(__FILE__), '..', 'setup', 'deploy.rb'), "r") do
   end
 end
 
-unless File.open(File.join('Capfile'), 'r').read.include?('require "deployer/initializer"')
+# checks for both require "deployer" and require "deployer/initializer"
+unless File.open(File.join('Capfile'), 'r').read.include?('require "deployer"')
   puts "[Deployer] => Adding Deployer Loader inside #{PATH}/Capfile."
   File.open(File.join(PATH, 'Capfile'), "a") do |capfile|
 capfile << <<-CAPFILE
 \n
-require "deployer/initializer"
+require "deployer"
 load deployer
 CAPFILE
   end

data/lib/deployer.rb

@@ -1,34 +1,5 @@
 ##
-# Load Deployer Helpers
-require File.join(File.dirname(__FILE__), 'deployer', 'helpers')
-
-##
-# This Configuration Is *Conventional*
-set   :application,         ip
-set   :deploy_to,           "/var/apps/#{appname}"    unless respond_to?(:deploy_to)
-set   :repository_path,     "/var/git/#{appname}.git" unless respond_to?(:repository_path)
-set   :repository,          "#{user}@#{application}:#{repository_path}"   
-set   :repository,          repository_url if respond_to?(:repository_url)
-
-set   :scm,                 'git'
-set   :use_sudo,            false
-role  :web,                 application
-role  :app,                 application
-role  :db,                  application
-default_run_options[:pty] = true
-
-##
-# Default Configuration
-set :remote, 'origin' unless respond_to?(:remote)
-set :branch, 'master' unless respond_to?(:branch)
-
-##
-# Load Deployment Tasks
-load_tasks('global')
-load_tasks('passenger')
-load_tasks('plugin')
-load_tasks('db')
-load_tasks('gems')
-load_tasks('repository')
-load_tasks('environment')
-load_tasks('commands')
+# Returns a path that can be loaded by the "load" method inside the Capfile
+def deployer
+  File.join(File.dirname(__FILE__), 'deployer', 'deploy.rb')
+end

data/lib/deployer/deploy.rb

@@ -0,0 +1,35 @@
+##
+# Load Deployer Helpers
+require File.join(File.dirname(__FILE__), 'helpers')
+
+##
+# This Configuration Is *Conventional*
+set   :application,         ip
+set   :deploy_to,           respond_to?(:deploy_path) ? deploy_path : "/var/apps/#{appname}"
+set   :repository_path,     "/var/git/#{appname}.git" unless respond_to?(:repository_path)
+set   :repository,          "#{user}@#{application}:#{repository_path}"   
+set   :repository,          repository_url if respond_to?(:repository_url)
+
+set   :scm,                 'git'
+set   :use_sudo,            false
+role  :web,                 application
+role  :app,                 application
+role  :db,                  application
+default_run_options[:pty] = true
+
+##
+# Default Configuration
+set :remote, 'origin' unless respond_to?(:remote)
+set :branch, 'master' unless respond_to?(:branch)
+
+##
+# Load Deployment Tasks
+load_tasks('global')
+load_tasks('sync')
+load_tasks('passenger')
+load_tasks('plugin')
+load_tasks('db')
+load_tasks('gems')
+load_tasks('repository')
+load_tasks('environment')
+load_tasks('commands')

data/lib/deployer/helpers.rb

@@ -7,7 +7,7 @@ end
 ##
 # Helper Method that assists in loading in tasks from the tasks folder
 def load_tasks(tasks)
-  load File.join(File.dirname(__FILE__), '..', 'tasks', "#{tasks}.rb")
+  load File.join(File.dirname(__FILE__), 'tasks', "#{tasks}.rb")
 end
 
 ##
@@ -37,7 +37,7 @@ end
 def bundle_path
   return @bundle_path if @bundle_path
   Net::SSH.start(ip, user) do |ssh|
-    @bundle_path = ssh.exec!("which bundle").chomp || "bundle"
+    @bundle_path = ssh.exec!("which bundle") || "bundle"
   end
   @bundle_path  
 end

data/lib/deployer/initializer.rb

@@ -1,5 +1,3 @@
 ##
-# Returns a path that can be loaded by the "load" method inside the Capfile
-def deployer
-  File.join(File.dirname(__FILE__), '..', 'deployer.rb')
-end
+# For backwards compatibility from previous deployer versions
+require File.join(File.dirname(__FILE__), '..', 'deployer')

data/lib/{tasks → deployer/tasks}/db.rb

@@ -1,15 +1,5 @@
 namespace :deploy do
   namespace :db do
-    
-    desc "Syncs the database.yml file from the local machine to the remote machine"
-    task :sync_yaml do
-     log "Syncing local database.yml (config/database.yml) to the shared folder (#{appname}/shared/config/database.yml)"
-     unless File.exist?("config/database.yml")
-       puts "There is no config/database.yml.\n "
-       exit
-     end
-     system "rsync -vr --exclude='.DS_Store' config/database.yml #{user}@#{application}:#{shared_path}/config/"
-    end
 
     desc "Create the database"
     task :create do

data/lib/{tasks → deployer/tasks}/global.rb

@@ -5,8 +5,10 @@ namespace :deploy do
     system "cap deploy:setup_shared_path"
     system "cap deploy:setup_symlinks"
     system "cap deploy:gems:install"
-    system "cap deploy:db:create"
-    system "cap deploy:db:migrate"
+    unless respond_to?(:skip_database) and skip_database
+      system "cap deploy:db:create"
+      system "cap deploy:db:migrate"
+    end
     after_deploy if respond_to?(:after_deploy)
     system "cap deploy:passenger:restart"
   end
@@ -15,7 +17,7 @@ namespace :deploy do
   task :initial do
     system "cap deploy:setup"
     system "cap deploy:setup_shared_path"
-    system "cap deploy:db:sync_yaml"
+    system "cap deploy:sync:files"
   end
   
   desc "Sets up the shared path"
@@ -31,7 +33,10 @@ namespace :deploy do
   desc "Creates symbolic links from the application to the shared folders"
   task :setup_symlinks do
     log "Creating symbolic links from the application to the shared folders"
-    shared_symlinks = %w(config/database.yml)
+    shared_symlinks = %w()
+    unless respond_to?(:skip_database) and skip_database
+      shared_symlinks << "config/database.yml"
+    end
     shared_symlinks += additional_shared_symlinks if respond_to?(:additional_shared_symlinks)
     shared_symlinks.each do |symlink|
       run "ln -nfs #{File.join(shared_path, symlink)} #{File.join(current_path, symlink)}"

data/lib/deployer/tasks/sync.rb

@@ -0,0 +1,31 @@
+namespace :deploy do
+  namespace :sync do
+    desc "Syncs the configured files from the local machine to the remote machine"
+    task :files do
+      files = []
+      
+      unless respond_to?(:skip_database) and skip_database
+        files << "config/database.yml"
+      end
+
+      if respond_to?(:sync_files)
+        files += sync_files
+      end
+
+      files.each do |file|
+        if File.exist?(file)
+          path_parts = file.split('/')
+          file = path_parts.pop
+          if path_parts.empty?
+            path = ''
+          else
+            path = path_parts.join('/') + '/'
+          end
+          
+          log "Syncing local file \"#{path + file}\" to the shared folder (#{appname}/shared/#{path + file})"
+          system "rsync -vr --exclude='.DS_Store' #{path + file} #{user}@#{application}:#{shared_path}/#{path}"
+        end
+      end
+    end
+  end
+end

data/setup/deploy.rb

@@ -36,29 +36,62 @@ set :remote,    "origin"          # the remote that should be deployed
 set :branch,    "production"      # the branch that should be deployed
 
 
+##
+# Optional
+# Specify custom deployment path
+
+# set :deploy_path, "/var/apps/#{appname}"
+
+
 ##
 # Optional
 # If you want to use a repository from a different location (github.com, trunksapp.com, etc)
 # Then you can specify the URL here. When using this, the "cap deploy:repository" tasks won't work.
+
 # set :repository_url, "deployer@example.com:/path/to/repository.git"
 
 
 ##
-# Set up additional shared folders
-set :additional_shared_folders,
-  %w(public/system db)
+# Optional
+# Use this to define a list of files you want to upload for the deploy:initial task
+
+# set :sync_files,
+#   %w(config/mongoid.yml)
 
 
 ##
+# Optional
+# Use this to skip database deployment tasks (db:create, db:migrate)
+# Useful when, for example, not using ActiveRecord, but MongoDB with Mongoid instead
+
+# set :skip_database, true
+
+
+##
+# Optional
+# Set up additional shared folders. The example below will create:
+# SHARED_PATH/public/system
+# SHARED_PATH/public/assets
+# SHARED_PATH/db
+
+# set :additional_shared_folders,
+#   %w(public/system public/assets db)
+
+
+##
+# Optional
 # Set up additional shared symlinks
 # These are mirrored to the Rails Applications' structure
 # public/system         = RAILS_ROOT/public/system          => SHARED_PATH/public/system
+# public/assets         = RAILS_ROOT/public/assets          => SHARED_PATH/public/assets
 # db/production.sqlite3 = RAILS_ROOT/db/production.sqlite3  => SHARED_PATH/db/production.sqlite3
-set :additional_shared_symlinks,
-  %w(public/system db/production.sqlite3)
+
+# set :additional_shared_symlinks,
+#   %w(public/system public/assets db/production.sqlite3)
 
 
 ##
+# Optional
 # Additional Application Specific Tasks and Callbacks
 # In here you can specify which Application Specific tasks you would like to run right before
 # Passenger restarts the application. You invoke the by simply calling "run_custom_task"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: deployer
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 19
   prerelease: false
   segments: 
   - 0
   - 1
-  - 3
-  version: 0.1.3
+  - 4
+  version: 0.1.4
 platform: ruby
 authors: 
 - Michael van Rooijen
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-14 00:00:00 +02:00
+date: 2010-07-12 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -60,17 +60,19 @@ extra_rdoc_files: []
 
 files: 
 - bin/enhancify
+- lib/deployer/deploy.rb
 - lib/deployer/helpers.rb
 - lib/deployer/initializer.rb
+- lib/deployer/tasks/commands.rb
+- lib/deployer/tasks/db.rb
+- lib/deployer/tasks/environment.rb
+- lib/deployer/tasks/gems.rb
+- lib/deployer/tasks/global.rb
+- lib/deployer/tasks/passenger.rb
+- lib/deployer/tasks/plugin.rb
+- lib/deployer/tasks/repository.rb
+- lib/deployer/tasks/sync.rb
 - lib/deployer.rb
-- lib/tasks/commands.rb
-- lib/tasks/db.rb
-- lib/tasks/environment.rb
-- lib/tasks/gems.rb
-- lib/tasks/global.rb
-- lib/tasks/passenger.rb
-- lib/tasks/plugin.rb
-- lib/tasks/repository.rb
 - setup/deploy.rb
 - README.md
 - LICENSE