capistrano-demonz 0.0.5 → 0.0.6

data/README.md

@@ -1,24 +1,116 @@
 # Capistrano::Demonz
 
-TODO: Write a gem description
+Capistrano recipes developed for use by [Demonz Media](http://demonzmedia.com).
+
+**Current version:** 0.0.5
+
+Only includes a Drupal recipe for now.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Make sure you have ruby and RubyGems installed, then run (you may need to prefix this with `sudo`):
+
+    $ gem install capistrano-demonz
+
+## Usage
 
-    gem 'capistrano-demonz'
+In your Drupal application's directory, run:
 
-And then execute:
+    $ capify .
 
-    $ bundle
+This will create two files, a `Capfile` in the root and `config/deploy.rb`.
 
-Or install it yourself as:
+Open up the `Capfile` and replace it with:
 
-    $ gem install capistrano-demonz
+```ruby
+require 'rubygems'
+require 'railsless-deploy'
+load 'deploy' if respond_to?(:namespace)
+load 'config/deploy'
+require 'capistrano/ext/multistage'
+require 'demonz/drupal'
+```
 
-## Usage
+Open up `deploy.rb` and replace with:
+
+```ruby
+set :stages, %w(production staging)
+set :default_stage, "staging"
+set :application, "mysite.com"
+
+set :repository,  "git@github.com:demonz/mydrupalproject.git"
+set :scm, :git
+set :branch, ""
+set :deploy_via, :remote_cache
+set :deploy_to, "/var/www/#{application}"
+# @see Demonz Base Stack/Configure user permissions
+set :group, 'www-pub'
+set :group_writable, true
+
+# Set to true if boost (the Drupal module) is installed
+set :uses_boost, false
+
+# For automated SASS compilation
+set :uses_sass, false
+set :themes, []
+
+set :keep_releases, 5
+set :keep_backups, 7 # only keep 3 backups (default is 10)
+
+# Set Excluded directories/files (relative to the application's root path)
+set(:backup_exclude) { [ "var/", "tmp/" ] }
+```
+
+Edit this according to your specific project. Importnant values are `:application`, `:repository`, `:branch` amongst others. It should be fairly self-explanatory.
+
+Then, create a folder at `config/deploy` in your project's root:
+
+    $ mkdir config/deploy
+
+And according to the number of application stages you defined previously in `:stages`, create applicable config files. For example, in the case above:
+
+    $ touch config/deploy/staging.rb
+    $ touch config/deploy/production.rb
+
+Then, in each of the above files, enter a variation of the following:
+
+```ruby
+server 'myserver.com', :app, :web, :primary => true
+# role :web, "mywebserver.com"
+# role :app, "mywebserver.com"
+# role :db,  "mydatabaseserver.com", :primary => true
+set :user, 'root'
+set :use_sudo, false
+
+set :ssh_options, {
+  :forward_agent => true,
+  # :keys => ["#{ENV['HOME']}/.ssh/your-ec2-key.pem"],
+  :keys => [File.join(ENV["HOME"], ".ssh", "id_rsa")],
+  :port => 2992
+}
+```
+
+Make sure to set your SSH server and user (`:user`)—if this user isn't root, set `:use_sudo` to `true`.
+
+If you have seperate web and database servers, comment out the `server` line and uncomment each of the `role` lines. Set these to their respective servers. In Drupal's case the `role :web` and `role :app` lines should be identical.
+
+Once all of that's done, run the following command (**note: this will create a folder on the remote server at /var/www/mysite.com**, make sure this doesn't conflict with anything):
+
+    $ cap deploy:setup
+
+When that finishes, log on to (each of?) the remote server(s). Copy your site's files directory to `/var/www/mysite.com/shared/default/files` and put a copy of your site's settings file at `/var/www/mysite.com/shared/settings.{stage}.php`. Replace `{stage}` with the stage that this server represents (staging, production, etc.).
+
+You can then run a deployment with:
+
+    $ cap deploy -S tag="mygittag"
+
+If you do not specify a Git tag, it will use the HEAD revision of your current repository and prompt you to create a tag.
+
+Additionally, if this is a fresh deployment, the script will prompt you for a gzipped SQL dump, try and have this ready. An easy way to do this is:
+
+    $ drush sql-dump --result-file --gzip
 
-TODO: Write usage instructions here
+And that's it!
 
 ## Contributing
 

data/lib/demonz/base.rb

@@ -14,10 +14,6 @@ configuration = Capistrano::Configuration.respond_to?(:instance) ?
 
 configuration.load do
 
-  # Set default stages
-  set :stages, %w(staging production)
-  set :default_stage, "staging"
-
   # Set shared path to be inside app directory
   set :shared_path, File.join(deploy_to, 'shared')
 
@@ -40,7 +36,6 @@ configuration.load do
   # --------------------------------------------
   # SSH
   set :user,              proc{text_prompt("SSH username: ")}
-  set :group,             :user
   set :password,          proc{Capistrano::CLI.password_prompt("SSH password for '#{user}':")}
 
   # Database
@@ -61,7 +56,7 @@ configuration.load do
   set :copy_strategy,     :checkout
   set :copy_compression,  :bz2
   set :copy_exclude,      [".svn", ".DS_Store", "*.sample", "LICENSE*", "Capfile",
-    "RELEASE*", "*.rb", "*.sql", "nbproject", "_template", "*.sublime*"]
+    "RELEASE*", "*.sql", "nbproject", "_template", "*.sublime*"]
 
   # Backups Path
   _cset(:backups_path)      { File.join(deploy_to, "backups") }
@@ -79,10 +74,8 @@ configuration.load do
   # Release tracking
   set :release_file,       File.join(shared_path, "RELEASES")
 
-  # SASS compilation support (via compass)
-  set :uses_sass,          false
-
   # Add a dependency on compass and :themes if required
+  uses_sass = fetch(:uses_sass, false)
   if uses_sass
     depend :remote, :gem, "compass", ">=0.12"
     _cset(:themes) { abort "Please specify themes on this site, set :themes, ['theme1', 'theme2']" }
@@ -120,7 +113,7 @@ configuration.load do
 
     desc "Setup backup directory for database and web files"
     task :setup_backup, :except => { :no_release => true } do
-      run "#{try_sudo} mkdir -p #{backups_path} #{tmp_backups_path} && #{try_sudo} chmod 775 #{backups_path} && #{try_sudo} chmod 775 #{tmp_backups_path}"
+      run "#{try_sudo} mkdir -p #{backups_path} #{tmp_backups_path} && #{try_sudo} chmod 775 #{backups_path} && #{try_sudo} chmod 775 #{tmp_backups_path} && #{try_sudo} chown -R #{user}:#{group} #{backups_path}"
     end
 
     desc <<-DESC
@@ -252,8 +245,8 @@ configuration.load do
         clean_tag = tag.gsub("/", "-")
 
         # Try to add tag to git
-        if ! system "git tag #{release_name}"
-          raise Capistrano::Error, "Failed to Git tag: #{release_name}"
+        if ! system "git tag #{clean_tag}"
+          raise Capistrano::Error, "Failed to Git tag: #{clean_tag}"
         end
       end
 

data/lib/demonz/common.rb

@@ -44,7 +44,7 @@ end
 
 # Get release history from server as string
 def get_release_history(release_file)
-  release_history = capture("cat #{release_file}").strip
+  release_history = remote_file_exists?(release_file) ? capture("cat #{release_file}").strip : ''
   release_history
 end
 

data/lib/demonz/drupal.rb

@@ -194,6 +194,17 @@ configuration.load do
       end
     end
 
+    desc "Compile SASS (using Compass) for this release"
+    task :compile_sass, :roles => :web, :except => { :no_release => true } do
+      themes = fetch(:themes, [])
+      themes.each do |theme|
+        theme_path = File.join(latest_release, 'sites', 'all', 'themes', theme)
+        compass_config = File.join(theme_path, 'config.rb')
+        run "/bin/bash -c 'source ~/.bash_profile; cd #{theme_path}; compass clean;'"
+        run "/bin/bash -c 'source ~/.bash_profile; cd #{theme_path}; compass compile -c #{compass_config} --force --output-style compressed;'"
+      end
+    end
+
     desc "Symlink shared directories"
     task :symlink, :roles => :web, :except => { :no_release => true } do
       uses_boost = fetch(:uses_boost, false)
@@ -230,9 +241,13 @@ configuration.load do
 
     desc "Migrate old database to new release"
     task :migrate, :roles => :web, :except => { :no_release => true } do
+      uses_sass = fetch(:uses_sass, false)
+
       create_db
       copy_old_to_new_db
       run_update_scripts
+      compile_sass if uses_sass
+
       # Run drush updb just incase
       run "#{drush_bin} -r #{latest_release} updb"
     end
@@ -242,7 +257,7 @@ configuration.load do
       set :archive_name, "files_before_#{release_name}.tar.gz"
       set :files_dir_location, File.join(shared_path, 'default')
       logger.debug "Creating a Tarball of the files directory in #{backups_path}/#{archive_name}"
-      run "cd #{files_dir_location} && tar -cvpf - files | gzip -c --best > #{backups_path}/#{archive_name}"
+      run "cd #{files_dir_location} && tar -cvpf - files | #{try_sudo} gzip -c --best > #{backups_path}/#{archive_name}"
     end
 
     desc "Clear all Drupal cache"

data/lib/demonz/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Demonz
-    VERSION = "0.0.5"
+    VERSION = "0.0.6"
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: capistrano-demonz
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Chinthaka Godawita
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-12-21 00:00:00 Z
+date: 2013-01-08 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: railsless-deploy