deployer 0.1.0

data/.document

@@ -0,0 +1,4 @@
+README.textile
+lib/**/*.rb
+bin/*
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Michael van Rooijen
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,290 @@
+h1. Deployer
+
+p. Deployer is a deployment engine (Ruby Gem) that enhances Capistrano with a set of useful automated deployment tasks and a base structure. It favors convention over configuration, and it simplifies Rails Application Deployment with Capistrano.
+
+p. It assumes you are using Passenger to serve your Rails applications.
+
+h2. Why?
+
+p. I wanted a tool that'd enhance Capistrano's default setup, and I wanted it to cause me a minimal amount of hassle and time consumption to set up as well for every time I want to deploy a new application.
+
+
+h2. Getting Started
+
+p. install the gem
+
+bc. sudo gem install deployer
+
+p. create a new Rails app
+
+bc. rails my_application
+
+p. move into the Rails app and execute the "capify" and "enhancify" commands
+
+bc. cd my_application
+capify .
+enhancify .
+
+p. enhancify is a command, provided by deployer that will inject some code into the Capfile and replace the config/deploy.rb with the one used for *Deployer*.
+If the deploy.rb file already exists, it will simply rename it to "deploy.old.1.rb", and if that also exists it will rename it to deploy.old.2.rb, etc. etc. So you will never accidentally overwrite your initial deploy.rb file.
+
+p. This is what the deploy.rb looks like: "config/deploy.rb":http://github.com/meskyanichi/deployer/blob/master/setup/deploy.rb
+
+p. *Next, open the config/deploy.rb file and edit the following variables.*
+
+bc. set :ip,          "123.45.678.90" # the ip address that points to your production server
+set :user,        "root"          # the user that will connect to the production server
+set :remote,      "origin"        # the remote that should be deployed
+set :branch,      "master"        # the branch that should be deployed
+set :domain,      "example.com"   # (or   set :domain,    "subdomain.example.com"
+set :subdomain,   false           # and   set :subdomain, true)
+
+p. For the sake of *testing*, be sure to *NOT* test this out on your main domain, unless you don't have an application running there that is. In the above example you can see how you set this up for a subdomain for your application to deploy a sample Rails Application to try out *Deployer*.
+
+bc. set :domain, "test.mydomain.com"
+set :subdomain, true
+
+p. _This is what you must do if you wish to try it out on a subdomain. In this case: test.mydomain.com_
+
+p. And *that's it!* You are now ready to do the following through *Deployer*:
+
+* Create a remote git repository
+* Push your initial commit to the remote repository
+* Create the production environment to where you will deploy your application to
+* Let *Deployer* create a simple Apache2 or NginX virtual-host file, transfer it to your remote server and restart the web-server
+* And, of course, deploy and run your Rails application!
+
+p. Here is are the quick-reference comments of the config/deploy.rb file
+
+bc. # Quick Reference
+# Configure the essential configurations below and do the following:
+# 
+#   Create Local and Remote Repository:
+#     git init
+#     cap deploy:repository:create
+# 
+#   Initial Deployment:
+#     git add .
+#     git commit -am "Initial commit for deployment"
+#     git push origin master
+#     cap deploy:initial
+#     
+#   Then For Every Update Just Do:
+#     git add .
+#     git commit -am "some other commit"
+#     git push origin master
+#     cap deploy
+#
+#   For Apache2 Users
+#     cap deploy:apache:create
+#     cap deploy:apache:destroy
+#     cap deploy:apache:restart
+#     cap deploy:apache:destroy_all
+#
+#   For NginX Users
+#     cap deploy:nginx:create
+#     cap deploy:nginx:destroy
+#     cap deploy:nginx:restart
+#     cap deploy:nginx:destroy_all
+#
+#   For a Full List of Commands
+#     cap -T
+
+p. *NOTE*
+
+p. The Apache2 and NginX tasks are totally OPTIONAL. Before you use these, please scroll down this page and see what it's all about. It essentially parses an initial *apache* or *nginx* virtual host file. Once parsed, it will transfer this inside the sites-available / sites-enabled folders. Afterwards *Apache* or *Nginx* will automatically get restarted. So basically you COULD deploy a web application without ever manually *SSH*'ing into the production box. I use this, but again, please read more about this before attempting it just so you know whats going on if it doesn't work for you. It depends on various things. It's optional so you don't have to use these methods since we're talking about *deployment* and not *server management*, it's just a simple little extra that *Deployer* provides, nothing really fancy.
+
+p. There are more tasks, but these will be your main commands. It's pretty straightforward.
+
+p. To list all commands:
+
+bc. cap -T
+
+
+h3. Automated Tasks
+
+p. *Deployer* will invoke various built-in tasks to try and deploy your application successfully.
+
+p. On the initial deployment *cap deploy:initial*. This procedure only has to be performed once.
+
+* It will setup the production environment, releases and shared folder
+* It will populate the shared folder with the folders you specified in the deploy.rb file
+* It will sync your applications *database.yml* file to the shared/db folder
+* It will sync the *deployer.rake* task from the to the shared/lib/tasks folder
+* It will deploy your application
+
+p. And the deployment procedure that follows (*cap deploy*), does the following:
+
+* It will create a new folder in the releases folder and deploy your application to it
+* It will ensure that the shared folder has all the folders you specified in the *deploy.rb*
+* It will setup built-in symlink setups for your database.yml, production log and deployer.rake
+* It will also setup any additional symlinks you may have specified inside the *deploy.rb* from the release folder to the shared folder
+* It will ensure all gems that are specified inside the *config/environment.rb* are installed. Will attempt to ignore exceptions
+* It will ensure the database is present and migrated to the latest version
+* It will then perform any *custom* tasks you might have specified inside the *deploy.rb* file within the *after_deploy* method definition
+* It will then set the correct passenger permissions
+* It will then restart passenger
+
+p. The *cap deploy:initial* will call *cap deploy* at the end. So an initial version will be released. After that, just do the following to released a new version as you normally would:
+
+bc. git add .
+git commit -am "next version commit"
+git push origin master
+cap deploy
+
+
+h2. Additional Configuration
+
+*Shared Folders and Symlinks*
+
+p. I wanted to keep this as simple as possible as well. By default, *Deployer* will create folders for storing the production.log in and other necessary stuff.
+It will properly symlink it from the shared folder to the Rails application. However! You will most likely have some other things you must keep in a shared folder, such as assets
+or other files. This can be done easily with *Deployer*.
+
+p. Again, inside of config/deploy.rb
+
+bc. set :additional_shared_folders,
+  %w(public/assets db)
+
+p. In this example two paths will be created.
+
+* /var/rails/:domain/shared/public/assets
+* /var/rails/:domain/shared/db
+
+p. *Deployer* will ensure these are available after every deployment. And will append any folders if you change the values here and re-deploy.
+
+p. Now, what use are these folders if you do not have the ability to add symlinks from these folders to the application.
+
+bc. set :additional_shared_symlinks,
+  %w(public/assets db/production.sqlite3)
+  
+p. In this example two symlinks will be created from the shared_path to the current Rails application release.
+As you can see the first symlink is a "path" symlink, which does not point to a direct file, but rather a folder.
+
+p. The second symlink will be a link from the shared/db/production.sqlite3 to the current rails applications' db/production.sqlite3 file.
+
+*NOTE*
+
+p. One important thing to note here is that notice how the symlinks are mirrored to the Rails applications folder structure. This will always be the case. If you have some crazy architecture inside your Rails application: *rails_root/my/awesome/folder/structure/is/very/long* then you MUST create the following folder structure for the shared path: *shared/my/awesome/folder/structure/is/very/long*. This is a convention and it saves a lot of overhead in your configuration file by just defining a path once and using that same path for both the current and shared path.
+
+p. *Additional (Optional) (Server) Configuration*
+
+p. Here you can specify that you want to pull/push from/to a git repository that's located on a DIFFERENT server. Leave this commented out or remove it if your git repository resides on the same server as your Rails application. If you choose to store your git repository on a separate server by uncommenting the following line, then you lose the ability to create/reset/destroy/reinitialize it through *Deployer*. This is no big deal though. All you have to do is create the git repository manually on that specific server and then issue the *git remote add origin repository_url* and it will work fine with the rest of *Deployer*.
+
+bc. set :repository_url,  "root@example.com:/path/to/repository.git"
+
+p. And then here is the last bit of server configuration you can specify.
+
+bc. # Default Configuration (Git/Repository Apache/NginX)
+# The settings below are default, you do not need to set these, unless you want to specify other parameters.
+# If you find that the settings below are fine, then you can leave them commented out or just remove them.
+# 
+# set :apache_initialize_utility_path,  '/etc/init.d/apache2'             # Only applies if running Apache and using the Apache Tasks
+# set :apache_sites_available_path,     '/etc/apache2/sites-available'    # Only applies if running Apache and using the Apache Tasks
+# set :nginx_initialize_utility_path,   '/etc/init.d/nginx'               # Only applies if running NginX and using the NginX Tasks
+# set :nginx_sites_enabled_path,        '/opt/nginx/conf/sites-enabled'   # Only applies if running NginX and using the NginX Tasks
+
+p. Again, very straightforward. I even added comments. One thing to note here is that these are commented out by default and you don't have to "uncomment" them to get the defaults. If you like the default settings you can leave it commented out, or just remove the lines. Or of course, uncomment them and leave them unchanged. Whatever you want.
+
+
+h3. *Adding Application Specific Deployment Tasks*
+
+p. Inside the *namespace :deploy do* block you can define your own deployment tasks that are specific to your application.
+
+bc.. # Application Specific Deployment Tasks
+namespace :deploy do
+  
+  desc "This is my custom task."
+  task :my_custom_task do
+    run "ls #{shared_path}"
+  end
+  
+  namespace :nested do
+    desc "This is my nested custom task."
+    task :my_custom_task do
+      puts "ls #{shared_path}"
+    end
+  end
+
+end
+
+
+
+p. Again, very straightforward. Just define your tasks as you normally would with Capistrano.
+Then, to invoke them during each deployment you must add them inside the *after_deploy*, method like so:
+
+bc. def after_deploy
+  run_custom_task "my_custom_task"
+  run_custom_task "nested:my_custom_task"
+end
+
+p. This method will be invoked right before *Deployer* sets permissions on, and restarts the your Rails application. 
+
+
+h3. Built-in Additional Tasks
+
+p. *Deployer* has some built-in tasks that are often used by developers.
+
+p. *Whenever*, To update the crontab on deployment:
+
+bc. def after_deploy
+  run_custom_task "whenever:update_crontab"
+end
+
+p. *Delayed Job*, To start/stop daemons
+
+bc. def after_deploy
+  run_custom_task "delayed_job:start"
+  run_custom_task "delayed_job:start n=3" # "n" specifies the amount of daemons that should run
+  run_custom_task "delayed_job:stop"
+end
+
+
+h2. Assumptions / Conventions
+
+p. Deployer favors Convention of Configuration. There are a few things you need to be aware of before you start using it. Just so it doesn't confuse you.
+
+p. By filling in the 4 variables (ip, domain, subdomain, user) you are practically set to create a remote git repository, push your local repository to it, create your production environment, deploy to your production environment from your remote repository and even let *Deployer* parse the simple apache2 and nginx configuration vhost files and transfer them to the server. Of course, you can also just choose to do setup your virtual hosts manually, it is totally optional. The availability of this option depends on your OS architecture/webserver installation path.
+
+p. Now, just to clear some things up with some facts about the conventions:
+
+*Rails Application Deployment Path*
+
+bc. /var/rails/:domain
+
+*Git Repository Path* unless specified otherwise in the configuration file.
+
+bc. /var/git/:domain.git
+
+*If using the Apache2 create/destroy/restart/destroy_all features, Apache2's sites-available path must be the following*, unless specified otherwise in the configuration file.
+
+bc. /etc/apache2/sites-available/
+
+*If using the NginX create/destroy/restart/destroy_all features, NginX's sites-enabled path must be the following*, unless specified otherwise in the configuration file.
+
+bc. /opt/nginx/conf/sites-enabled/
+
+p. Additionally, you must be able to start/stop the NginX webserver through these commands: "/etc/init.d/nginx start" and "/etc/init.d/nginx stop"
+If you don't have this functionality, but want it, check out: "http://github.com/meskyanichi/rails-nginx-passenger-ubuntu":http://github.com/meskyanichi/rails-nginx-passenger-ubuntu
+For NginX you must also add this: *include sites-enabled/** inside the nginx configuration file, inside the *server{}* block to include all settings that *Deployer* transfers into the sites-enabled
+
+* Assumes you are using Phusion Passenger for deployment
+* Assumes Git Repository will be located on the same server as where the actual application will be deployed. Unless specified otherwise in the configuration file.
+* The config/database.yml will be transferred to the shared/config/database.yml and symlinked to on the initial deployment. You can re-sync it later with *cap deploy:db:sync_yaml*.
+* I have overwritten/adjusted the "rake gems:install" command in production mode to try and force a successful gem installation process.
+There are occasions where there are unexpected exceptions raised when trying to issue the rake task. For example when you have an "Uninitialized Constant" inside the environment.rb which "is" initialized in development mode because you have the gem installed locally, but fails in the production environment because it does not have the gem. *Deployer* shall try to install any gem specified inside the config/environment.rb regardless of what exception is being raised to ensure all gem dependencies are installed on deployment.
+
+
+*NOTE*
+
+p. This is a _very early_ release. A lot may be subject to change, for the good!
+
+
+h2. Suggestions, Requests, Idea's?
+
+Tell, Ask, Fork and Help!
+
+
+h2. Copyright
+
+Copyright (c) 2010 Michael van Rooijen. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "deployer"
+    gem.summary = %Q{Deployer is a deployment engine (Ruby Gem) that enhances Capistrano with a set of useful automated deployment tasks. It favors convention over configuration, and it simplifies Rails Application Deployment with Capistrano.}
+    gem.description = %Q{Deployer is a deployment engine (Ruby Gem) that enhances Capistrano with a set of useful automated deployment tasks. It favors convention over configuration, and it simplifies Rails Application Deployment with Capistrano.}
+    gem.email = "meskyanichi@gmail.com"
+    gem.homepage = "http://github.com/meskyanichi/deployer"
+    gem.authors = ["Michael van Rooijen"]
+    gem.add_dependency "capistrano", ">= 2.5.13"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "deployer #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/enhancify

@@ -0,0 +1,74 @@
+#!/usr/bin/env ruby
+
+options = {}
+
+optparse = OptionParser.new do |opts|
+  opts.banner = "\nUsage: enhancify [path]\n "
+end
+
+begin
+  optparse.parse!
+rescue OptionParser::InvalidOption
+  puts "\nInvalid Option. See the list of available options below.\n"
+  puts optparse
+  puts "\n "
+  exit
+end
+
+if ARGV.empty?
+  puts "Please specify the path to the Capfile."
+  puts "example: enhancify /path/to/rails_root"
+  exit
+end
+
+if Dir.entries(ARGV[0]).include?("Capfile")
+  puts "[Deployer] => Found Capfile!"
+  PATH    = File.expand_path(ARGV[0])
+  CAPFILE = File.expand_path(File.join(ARGV[0], "Capfile"))
+else
+  puts "[Deployer] => Could not find Capfile in #{File.expand_path(ARGV[0])}!"
+  exit
+end
+
+if File.directory?(File.join(PATH, "config"))
+  puts "[Deployer] => Found config folder!"
+else
+  puts "[Deployer] => Could not find the \"config\" folder. Creating it now!"
+  %x(mkdir #{File.join(PATH, 'config')})
+end
+
+if File.exist?(File.join(PATH, "config", "deploy.rb"))
+  old_versions = Dir.entries(File.join(PATH, 'config')).map {|entree| entree if entree =~ /deploy\.old\.(\d+)\.rb$/}.compact!
+  if old_versions.empty?
+    puts "[Deployer] => Found only the original version of deploy.rb. Renaming it to deploy.old.1.rb."
+    %x(mv #{File.join(PATH, 'config', 'deploy.rb')} #{File.join(PATH, 'config', 'deploy.old.1.rb')})
+  else  
+    puts "[Deployer] => Found old versions of deploy.rb file."
+    version = old_versions.last.match('^deploy\.old\.(\d+)\.rb$')[1].to_i + 1
+    puts "[Deployer] => Renaming deploy.rb to deploy.old.#{version}.rb"
+    %x(mv #{File.join(PATH, 'config', 'deploy.rb')} #{File.join(PATH, 'config', "deploy.old.#{version}.rb")})
+  end
+else
+  puts "[Deployer] => Could not find deploy.rb. Creating a new one!"
+end
+
+puts "[Deployer] => Writing new deploy.rb."
+File.open(File.join(File.dirname(__FILE__), '..', 'setup', 'deploy.rb'), "r") do |template|
+  File.open(File.join(PATH, 'config', 'deploy.rb'), 'w') do |file|
+    file.write(template.read)
+  end
+end
+
+unless File.open(File.join('Capfile'), 'r').read.include?('require "deployer/initializer"')
+  puts "[Deployer] => Adding Deployer Loader inside #{PATH}/Capfile."
+  File.open(File.join(PATH, 'Capfile'), "a") do |capfile|
+capfile << <<-CAPFILE
+\n
+require "deployer/initializer"
+load deployer
+CAPFILE
+  end
+end
+
+puts "[Deployer] => Finished Enhancing Capistrano!"
+exit

data/deployer.gemspec

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{deployer}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael van Rooijen"]
+  s.date = %q{2010-01-11}
+  s.default_executable = %q{enhancify}
+  s.description = %q{Deployer is a deployment engine (Ruby Gem) that enhances Capistrano with a set of useful automated deployment tasks. It favors convention over configuration, and it simplifies Rails Application Deployment with Capistrano.}
+  s.email = %q{meskyanichi@gmail.com}
+  s.executables = ["enhancify"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.textile"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.textile",
+     "Rakefile",
+     "VERSION",
+     "bin/enhancify",
+     "deployer.gemspec",
+     "lib/deployer.rb",
+     "lib/deployer/helpers.rb",
+     "lib/deployer/initializer.rb",
+     "lib/deployer/tasks/deployer.rake",
+     "lib/tasks/apache.rb",
+     "lib/tasks/commands.rb",
+     "lib/tasks/db.rb",
+     "lib/tasks/environment.rb",
+     "lib/tasks/gems.rb",
+     "lib/tasks/global.rb",
+     "lib/tasks/nginx.rb",
+     "lib/tasks/passenger.rb",
+     "lib/tasks/plugin.rb",
+     "lib/tasks/repository.rb",
+     "setup/deploy.rb"
+  ]
+  s.homepage = %q{http://github.com/meskyanichi/deployer}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Deployer is a deployment engine (Ruby Gem) that enhances Capistrano with a set of useful automated deployment tasks. It favors convention over configuration, and it simplifies Rails Application Deployment with Capistrano.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<capistrano>, [">= 2.5.13"])
+    else
+      s.add_dependency(%q<capistrano>, [">= 2.5.13"])
+    end
+  else
+    s.add_dependency(%q<capistrano>, [">= 2.5.13"])
+  end
+end
+

data/lib/deployer.rb

@@ -0,0 +1,36 @@
+# Load Deployer Helpers
+require File.join(File.dirname(__FILE__), 'deployer', 'helpers')
+
+# This configuration is *conventional*
+set   :application,         ip
+set   :deploy_to,           "/var/rails/#{domain}"
+set   :repository_path,     "/var/git/#{domain}.git"
+set   :repository,          "#{user}@#{application}:#{repository_path}"
+set   :repository,          repository_url if respond_to?(:repository_url)
+
+set   :scm,                 "git"
+set   :use_sudo,            true
+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)
+set :apache_initialize_utility_path,  "/etc/init.d/apache2"             unless respond_to?(:apache_initialize_utility_path)
+set :apache_sites_available_path,     "/etc/apache2/sites-available"    unless respond_to?(:apache_sites_available_path)
+set :nginx_initialize_utility_path,   "/etc/init.d/nginx"               unless respond_to?(:nginx_initialize_utility_path)
+set :nginx_sites_enabled_path,        "/opt/nginx/conf/sites-enabled"   unless respond_to?(:nginx_sites_enabled_path)
+
+# Load Deployment Tasks
+load_tasks("global")
+load_tasks("passenger")
+load_tasks("apache")
+load_tasks("nginx")
+load_tasks("plugin")
+load_tasks("db")
+load_tasks("gems")
+load_tasks("repository")
+load_tasks("environment")
+load_tasks("commands")

data/lib/deployer/helpers.rb

@@ -0,0 +1,27 @@
+# Creates a tmp directory and writes Apache and NginX configuration files to it
+def create_tmp_file(contents)
+  system 'mkdir tmp'
+  file = File.new("tmp/#{domain}", "w")
+  file << contents
+  file.close
+end
+
+# Alias for initializing custom deployment tasks
+def run_custom_task(task)
+  system "cap deploy:#{task}"
+end
+
+# A 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")
+end
+
+# A Method that logs a message
+def log(message)
+  puts "\n\n[Deployer] => #{message}.. \n\n"
+end
+
+# Returns the RAILS_ENV=production string to reduce overhead
+def env
+  "RAILS_ENV=production"
+end

data/lib/deployer/initializer.rb

@@ -0,0 +1,5 @@
+# Returns a path that can be loaded by the "load" method
+# inside the Capfile
+def deployer
+  File.join(File.dirname(__FILE__), '..', 'deployer.rb')
+end

data/lib/deployer/tasks/deployer.rake

@@ -0,0 +1,18 @@
+namespace :deployer_gems do
+  
+  task :base do
+    begin
+      $gems_rake_task = true
+      require 'rubygems'
+      require 'rubygems/gem_runner'
+      Rake::Task[:environment].invoke
+    rescue
+    end
+  end
+  
+  desc "Installs all required gems."
+  task :install => :base do
+    current_gems.each { |gem| gem.install }
+  end
+  
+end

data/lib/tasks/apache.rb

@@ -0,0 +1,49 @@
+# apache_initialize_utility_path
+# apache_sites_available_path
+
+namespace :deploy do
+  namespace :apache do
+    
+    desc "Adds Apache2 configuration and enables it."
+    task :create do
+      log "Adding Apache2 Virtual Host for #{domain}"
+      config = <<-CONFIG
+      <VirtualHost *:80>
+        ServerName #{domain}
+        #{unless subdomain then "ServerAlias www.#{domain}" end}
+        DocumentRoot #{File.join(deploy_to, 'current', 'public')}
+      </VirtualHost>
+      CONFIG
+      
+      system 'mkdir tmp'
+      file = File.new("tmp/#{domain}", "w")
+      file << config
+      file.close 
+      system "rsync -vr tmp/#{domain} #{user}@#{application}:#{File.join(apache_sites_available_path, domain)}"
+      File.delete("tmp/#{domain}")
+      run "sudo a2ensite #{domain}"
+      run "sudo #{apache_initialize_utility_path} restart"
+    end
+    
+    desc "Restarts Apache2."
+    task :restart do
+      run "sudo #{apache_initialize_utility_path} restart"
+    end
+    
+    desc "Removes Apache2 configuration and disables it."
+    task :destroy do
+      log "Removing Apache2 Virtual Host for #{domain}"
+      begin run("a2dissite #{domain}"); rescue; end
+      begin run("sudo rm #{File.join(apache_sites_available_path, domain)}"); rescue; end
+      run("sudo #{apache_initialize_utility_path} restart")
+    end
+
+    desc "Destroys Git Repository, Rails Environment and Apache2 Configuration."
+    task :destroy_all do
+      system "cap deploy:repository:destroy"
+      run "rm -rf #{deploy_to}"
+      system "cap deploy:apache:destroy"
+    end
+
+  end
+end

data/lib/tasks/commands.rb

@@ -0,0 +1,17 @@
+namespace :deploy do
+  namespace :remote_command do
+  
+    desc "Run a command from the Rails Root on the remote server. Specify command='my_command'."
+    task :rails_root do
+      log "Executing \"#{ENV['command']}\" from the Rails Root on the server."
+      run "cd #{current_path}; #{ENV['command']}"
+    end
+   
+    desc "Run a command on the remote server. Specify command='my_command'."
+    task :default do
+      log "Executing \"#{ENV['command']}\" on the server."
+      run "#{ENV['command']}"
+    end
+     
+  end
+end

data/lib/tasks/db.rb

@@ -0,0 +1,49 @@
+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 database yaml to the production server"
+     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 Production Database"
+    task :create do
+     log "Creating the Production Database"
+     run "cd #{current_path}; rake db:create #{env}"
+    end
+    
+    namespace :migrate do
+      
+      desc "Migrate Production Database"
+      task :default do
+       log "Migrating the Production Database"
+       run "cd #{current_path}; rake db:migrate #{env}"
+      end
+
+      desc "Resets the Production Database"
+      task :reset do
+       log "Resetting the Production Database"
+       run "cd #{current_path}; rake db:migrate:reset #{env}"
+      end
+
+    end
+      
+    desc "Destroys Production Database"
+    task :drop do
+     log "Destroying the Production Database"
+     run "cd #{current_path}; rake db:drop #{env}"
+    end
+
+    desc "Populates the Production Database"
+    task :seed do
+     log "Populating the Production Database"
+     run "cd #{current_path}; rake db:seed #{env}"
+    end
+    
+  end
+end

data/lib/tasks/environment.rb

@@ -0,0 +1,21 @@
+namespace :deploy do
+  namespace :environment do
+
+    desc "Creates the production environment"
+    task :create do
+      system "cap deploy:setup"
+    end
+
+    desc "Destroys the production environment"
+    task :destroy do
+      run "rm -rf #{deploy_to}"
+    end
+  
+    desc "Resets the production environment"
+    task :reset do
+      run "rm -rf #{deploy_to}"
+      system "cap deploy:setup"
+    end
+
+  end
+end

data/lib/tasks/gems.rb

@@ -0,0 +1,16 @@
+namespace :deploy do
+  namespace :gems do
+    
+    desc "Installs any 'not-yet-installed' gems on the production server or a single gem when the gem= is specified."
+    task :install do
+      if ENV['gem']
+        log "Installing #{ENV['gem']}"
+        run "gem install #{ENV['gem']}"
+      else
+        log "Installing gem dependencies"
+        run "cd #{current_path}; rake deployer_gems:install #{env}"
+      end
+    end
+    
+  end
+end

data/lib/tasks/global.rb

@@ -0,0 +1,57 @@
+namespace :deploy do
+  
+  desc "Initializes a bunch of tasks in order after the last deployment process."
+  task :restart 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"
+    after_deploy if respond_to?(:after_deploy)    
+    system "cap deploy:set_permissions"
+    system "cap deploy:passenger:restart"
+  end
+
+  desc "Executes the initial procedures for deploying a Ruby on Rails Application."
+  task :initial do
+    system "cap deploy:setup"
+    system "cap deploy:setup_shared_path"
+    system "cap deploy:db:sync_yaml"
+    system "cap deploy:sync_tasks"
+    system "cap deploy"
+  end
+  
+  desc "Sets permissions for Rails Application"
+  task :set_permissions do
+    log "Setting Permissions"
+    run "chown -R www-data:www-data #{deploy_to}"
+  end
+  
+  desc "Creates symbolic links from shared folder"
+  task :setup_symlinks do
+    log "Setting up Symbolic Links"
+    run "mkdir -p #{File.join(current_path, 'lib', 'tasks')}"
+    shared_symlinks = %w(config/database.yml lib/tasks/deployer.rake)
+    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)}"
+    end
+  end
+  
+  desc "Sets up the shared path"
+  task :setup_shared_path do
+    log "Setting up the shared path"
+    shared_folders = %w(config lib/tasks)
+    shared_folders += additional_shared_folders if respond_to?(:additional_shared_folders)
+    shared_folders.each do |folder|
+      run "mkdir -p #{shared_path}/#{folder}"
+    end
+  end
+
+  desc "Syncs the rake tasks for installing gems."
+  task :sync_tasks do
+    log "Adding Deployer Rake tasks to shared path."
+    system "rsync -vr --exclude='.DS_Store' #{File.join(File.dirname(__FILE__), '..', 'deployer', 'tasks', 'deployer.rake')} #{user}@#{application}:#{File.join(shared_path, 'lib', 'tasks')}"
+  end
+
+end

data/lib/tasks/nginx.rb

@@ -0,0 +1,47 @@
+namespace :deploy do
+  namespace :nginx do
+    
+    desc "Adds NginX configuration and enables it."
+    task :create do
+      log "Adding NginX Virtual Host for #{domain}"
+      config = <<-CONFIG
+      server {
+        listen 80;
+        server_name #{unless subdomain then "www.#{domain} #{domain}" else domain end};
+        root #{File.join(deploy_to, 'current', 'public')};
+        passenger_enabled on;
+      }
+      CONFIG
+      
+      create_tmp_file(config)
+      run "mkdir -p #{nginx_sites_enabled_path}"
+      system "rsync -vr tmp/#{domain} #{user}@#{application}:#{File.join(nginx_sites_enabled_path, domain)}"
+      File.delete("tmp/#{domain}")
+      system 'cap deploy:nginx:restart'
+    end
+    
+    desc "Restarts NginX."
+    task :restart do
+      Net::SSH.start(application, user) {|ssh| ssh.exec "#{nginx_initialize_utility_path} stop"}
+      Net::SSH.start(application, user) {|ssh| ssh.exec "#{nginx_initialize_utility_path} start"}
+    end
+    
+    desc "Removes NginX configuration and disables it."
+    task :destroy do
+      log "Removing NginX Virtual Host for #{domain}"
+      begin
+        run("rm #{File.join(nginx_sites_enabled_path, domain)}")
+      ensure
+        system 'cap deploy:nginx:restart'
+      end
+    end
+    
+    desc "Destroys Git Repository, Rails Environment and Nginx Configuration."
+    task :destroy_all do
+      system "cap deploy:repository:destroy"
+      run "rm -rf #{deploy_to}"
+      system "cap deploy:nginx:destroy"
+    end
+
+  end
+end

data/lib/tasks/passenger.rb

@@ -0,0 +1,11 @@
+namespace :deploy do
+  namespace :passenger do
+    
+    desc "Restarts Passenger"
+    task :restart do
+      log "Restarting Passenger"
+      run "touch #{current_path}/tmp/restart.txt"
+    end
+
+  end
+end

data/lib/tasks/plugin.rb

@@ -0,0 +1,24 @@
+namespace :deploy do
+  namespace :whenever do
+    
+    desc "Update the crontab file for the Whenever Gem."
+    task :update_crontab, :roles => :db do
+      log "Updating the Crontab"
+      run "cd #{release_path} && whenever --update-crontab #{domain}"
+    end    
+  end
+
+  namespace :delayed_job do
+    desc "Starts the Delayed Job Daemon(s)."
+    task :start do
+      log "Starting #{(ENV['n'] + ' ') if ENV['n']}Delayed Job Daemon(s)"
+      run "#{env} #{current_path}/script/delayed_job #{"-n #{ENV['n']} " if ENV['n']}start"
+    end
+    
+    desc "Stops the Delayed Job Daemon(s)."
+    task :stop do
+      log "Stopping Delayed Job Daemon(s)"
+      run "#{env} #{current_path}/script/delayed_job stop"
+    end
+  end
+end

data/lib/tasks/repository.rb

@@ -0,0 +1,51 @@
+namespace :deploy do
+  namespace :repository do
+    
+    task :base do
+      if respond_to?(:repository_url)
+        log "You cannot interact with your repository through Deployer Tasks as long as you have the \"repository_url\" defined."
+        log "Deployer only handles repositories that are located on the same server location as to where the actual Rails Application will be deployed."
+        log "If you wish to have this functionality, please comment out the \"repository_url\" inside the config/deploy.rb."
+        log "If you wish to use the git repository from a different server, then manually add it to git: git remote add origin repository_url"
+        exit
+      end
+    end
+
+    desc "Creates the remote Git repository."
+    task :create do
+      base
+      log "Creating remote Git repository"
+      run "mkdir -p #{repository_path}"
+      run "cd #{repository_path} && git --bare init"
+      system "git remote rm #{remote}"
+      system "git remote add #{remote} #{repository[:repository]}"
+      p "#{repository[:repository]} was added to your git repository as #{remote}/master."
+    end
+
+    desc "Creates the remote Git repository."
+    task :destroy do
+      base
+      log "destroying remote Git repository"
+      run "rm -rf #{repository_path}"
+      system "git remote rm #{remote}"
+      p "#{repository[:repository]} (#{remote}/master) was removed from your git repository."
+    end
+
+    desc "Resets the remote Git repository."
+    task :reset do
+      base
+      log "Resetting remove Git repository"
+      system "cap deploy:repository:destroy"
+      system "cap deploy:repository:create"
+    end
+    
+    desc "Reinitializes #{remote}/master."
+    task :reinitialize do
+      base
+      system "git remote rm #{remote}"
+      system "git remote add #{remote} #{repository[:repository]}"
+      p "#{repository[:repository]} (#{remote}/master) was added to your git repository."
+    end
+    
+  end
+end

data/setup/deploy.rb

@@ -0,0 +1,102 @@
+# Quick Reference
+# Configure the essential configurations below and do the following:
+#
+#   For more information:
+#   http://github.com/meskyanichi/deployer 
+#
+#   Create Local and Remote Repository:
+#     git init
+#     cap deploy:repository:create
+# 
+#   Initial Deployment:
+#     git add .
+#     git commit -am "Initial commit for deployment"
+#     git push origin master
+#     cap deploy:initial
+#     
+#   Then For Every Update Just Do:
+#     git add .
+#     git commit -am "some other commit"
+#     git push origin master
+#     cap deploy
+#
+#   For Apache2 Users
+#     cap deploy:apache:create
+#     cap deploy:apache:destroy
+#     cap deploy:apache:restart
+#     cap deploy:apache:destroy_all
+#
+#   For NginX Users
+#     cap deploy:nginx:create
+#     cap deploy:nginx:destroy
+#     cap deploy:nginx:restart
+#     cap deploy:nginx:destroy_all
+#
+#   For a Full List of Commands
+#     cap -T
+
+
+# Essential Configuration
+# Assumes Application and Git Repository are located on the same server
+set :ip,          "123.45.678.90" # the ip address that points to your production server
+set :user,        "root"          # the user that will connect to the production server
+set :remote,      "origin"        # the remote that should be deployed
+set :branch,      "master"        # the branch that should be deployed
+set :domain,      "example.com"   # (or   set :domain,    "subdomain.example.com"
+set :subdomain,   false           # and   set :subdomain, true)
+
+# Optional
+# If the Git Repository resides/should reside on a different server than where the application deploys,
+# then uncomment the following line and specify the repository_url/user
+# NOTE: The Tasks "cap deploy:repository:create/destroy/reset" won't work if you use this!
+# You will have to manually create the repository yourself on the specified server.
+#
+# set :repository_url,  "root@example.com:/path/to/repository.git"
+
+
+# Set up additional shared folders
+set :additional_shared_folders,
+  %w(public/assets db)
+
+# Set up additional shared symlinks
+# These are mirrored to the Rails Applications' structure
+# 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/assets db/production.sqlite3)
+
+
+# Additional Application Specific Tasks and Callbacks
+# In here you can specify which Application Specific tasks you would like to run right before the application
+# re-sets permissions and restarts passenger. You invoke the by simply calling "run_custom_task".
+#
+def after_deploy
+  run_custom_task "my_custom_task"
+  run_custom_task "nested:my_custom_task"
+end
+
+# Application Specific Deployment Tasks
+# In here you may specify any application specific and/or other tasks that are not handled by Deployer
+namespace :deploy do  
+  desc "This is my custom task."
+  task :my_custom_task do
+    run "ls -la #{shared_path}"
+  end
+  
+  namespace :nested do
+    desc "This is my nested custom task."
+    task :my_custom_task do
+      system "ls -la"
+    end
+  end
+end
+
+
+# Default Configuration Apache/NginX
+# The settings below are default, you do not need to set these, unless you want to specify other parameters.
+# If you find that the settings below are fine, then you can leave them commented out or just remove them.
+# 
+# set :apache_initialize_utility_path,  '/etc/init.d/apache2'             # Only applies if running Apache and using the Apache Tasks
+# set :apache_sites_available_path,     '/etc/apache2/sites-available'    # Only applies if running Apache and using the Apache Tasks
+# set :nginx_initialize_utility_path,   '/etc/init.d/nginx'               # Only applies if running NginX and using the NginX Tasks
+# set :nginx_sites_enabled_path,        '/opt/nginx/conf/sites-enabled'   # Only applies if running NginX and using the NginX Tasks

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: deployer
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Michael van Rooijen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-11 00:00:00 +01:00
+default_executable: enhancify
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: capistrano
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.5.13
+    version: 
+description: Deployer is a deployment engine (Ruby Gem) that enhances Capistrano with a set of useful automated deployment tasks. It favors convention over configuration, and it simplifies Rails Application Deployment with Capistrano.
+email: meskyanichi@gmail.com
+executables: 
+- enhancify
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- bin/enhancify
+- deployer.gemspec
+- lib/deployer.rb
+- lib/deployer/helpers.rb
+- lib/deployer/initializer.rb
+- lib/deployer/tasks/deployer.rake
+- lib/tasks/apache.rb
+- lib/tasks/commands.rb
+- lib/tasks/db.rb
+- lib/tasks/environment.rb
+- lib/tasks/gems.rb
+- lib/tasks/global.rb
+- lib/tasks/nginx.rb
+- lib/tasks/passenger.rb
+- lib/tasks/plugin.rb
+- lib/tasks/repository.rb
+- setup/deploy.rb
+has_rdoc: true
+homepage: http://github.com/meskyanichi/deployer
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Deployer is a deployment engine (Ruby Gem) that enhances Capistrano with a set of useful automated deployment tasks. It favors convention over configuration, and it simplifies Rails Application Deployment with Capistrano.
+test_files: []
+