cap-drupal 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+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 Mathieu ELie
+
+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.mkd

@@ -0,0 +1,25 @@
+# Cap Drupal
+
+Capistrano drupal helpers
+
+## Install
+
+    # gem install cap-drupal
+
+
+## Usage
+
+	mkdir config
+	cap-drupal  .
+	cap multistage:prepare
+
+Now you have this tree
+
+	.
+	+--- config
+	|   +--- deploy
+	|   |   +--- production.rb
+	|   |   +--- development.rb
+	|   |   +--- preview.rb
+	|   +--- deploy.rb
+	+--- Capfile

data/README.rdoc

@@ -0,0 +1,17 @@
+= cap-drupal
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Mathieu ELie. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "cap-drupal"
+    gem.summary = %Q{Drupal capistrano recipes}
+    gem.description = %Q{Capistrano recipes fitted to our needs/workflow at websiteburo, could be useful elsewhere}
+    gem.email = "mathieuelie@gmail.com"
+    gem.homepage = "http://github.com/mathieue/cap-drupal"
+    gem.authors = ["Mathieu Elie"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  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 = "cap-drupal #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/bin/cap-drupal

@@ -0,0 +1,81 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename($0)} [path]"
+
+  opts.on("-h", "--help", "Displays this help info") do
+    puts opts
+    exit 0
+  end
+
+  begin
+    opts.parse!(ARGV)
+  rescue OptionParser::ParseError => e
+    warn e.message
+    puts opts
+    exit 1
+  end
+end
+
+if ARGV.empty?
+  abort "Please specify the directory to capify, e.g. `#{File.basename($0)} .'"
+elsif !File.exists?(ARGV.first)
+  abort "`#{ARGV.first}' does not exist."
+elsif !File.directory?(ARGV.first)
+  abort "`#{ARGV.first}' is not a directory."
+elsif ARGV.length > 1
+  abort "Too many arguments; please specify only the directory to capify."
+end
+
+def unindent(string)
+  indentation = string[/\A\s*/]
+  string.strip.gsub(/^#{indentation}/, "")
+end
+
+files = {
+  "Capfile" => unindent(<<-FILE),
+    require 'capistrano/ext/multistage'
+    require 'recipes/drupal'
+    load "config/deploy"
+  FILE
+
+  "config/deploy.rb" => unindent(<<-FILE),
+  # project specific settings / all staging area
+
+  set :application, "myapp"
+
+  set :default_stage, "development"
+  set :stages, %w(development preview production)
+
+  ###########################################
+  # this conf should be in staging specific conf (dev/preview/etc...)
+  # ex: config/deploy/development.rb
+  #  set :deploy_to, "/path/to/app"
+
+  # user generated content
+  #  set :ugc_path, "\#{deploy_to}/sites/default/files"
+  #  set :application_host, "mysite.net"
+
+  #  role :web, "mysite.net"
+  #  role :db,  "mysite.net", :primary => true
+  FILE
+}
+
+base = ARGV.shift
+files.each do |file, content|
+  file = File.join(base, file)
+  if File.exists?(file)
+    warn "[skip] `#{file}' already exists"
+  elsif File.exists?(file.downcase)
+    warn "[skip] `#{file.downcase}' exists, which could conflict with `#{file}'"
+  elsif !File.exists?(File.dirname(file))
+    warn "[skip] directory `#{File.dirname(file)}' does not exist"
+  else
+    puts "[add] writing `#{file}'"
+    File.open(file, "w") { |f| f.write(content) }
+  end
+end
+
+puts "[done] capified with cap drupal!"

data/lib/recipes/drupal.rb

@@ -0,0 +1,132 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  # nb of dumps to keep after a clean
+  # nb of ugc files dirs backup
+
+  unless exists?(:max_keep_dump)
+    set :max_keep_dump, 5
+  end
+
+  unless exists?(:max_keep_backup)
+    set :max_keep_backup, 3
+  end
+
+  namespace :drupal do
+
+    desc "clear all drupal caches"
+    task :clearcache, :roles => :db do
+      run "sudo drush -r \"#{deploy_to}\" cc all"
+    end
+
+    namespace :clean do
+      namespace :db do
+        desc "list db dumps to delete"
+        task :check, :roles => :db do
+          dumps_to_delete do |dump|
+            puts "will delete #{dump}"
+          end
+        end
+        desc "delete db dumps over max_keep_dump"
+        task :commit, :roles => :db do
+          dumps_to_delete do |dump|
+            run "rm #{dump}"
+          end
+        end
+      end
+      namespace :ugc do
+        desc "list ugc backups to delete"
+        task :check, :roles => :web do
+          backups_to_delete do |backup|
+            puts "will delete #{backup}"
+          end
+        end
+        desc "delete ugc backups over max_keep_backup"
+        task :commit, :roles => :web do
+          backups_to_delete do |backup|
+            run "rm -rf #{backup}"
+          end
+        end
+      end
+    end
+
+    namespace :db do
+      desc "dump the db to cap user home directory"
+      task :dump, :roles => :db do
+        filename = "#{application}-#{stage}-#{now}.sql"
+        run "sudo drush -r \"#{deploy_to}\" sql-dump > ~/#{filename}"
+      end
+
+      desc "get the latest db dump to current local dir"
+      task :latest, :roles => :db do
+        dumps = capture("ls -xt ~/#{application}-#{stage}-*sql").split.reverse
+        get(dumps.last, "#{dumps.last.split('/').last}")
+      end
+
+      desc "dump the db and download to local dir"
+      task :download, :roles => :db do
+        dump
+        latest
+      end
+    end
+
+    # user generated content
+    namespace :ugc do
+
+      desc "show the ugc files current size"
+      task :size, :role => :web do
+        run "du -sh #{ugc_path}"
+      end
+
+      desc "copy user generated content to cap user home"
+      task :backup, :role => :web do
+        size
+        dirname = "~/#{application}-#{stage}-#{now}-ugc"
+        run "sudo cp -a #{ugc_path} #{dirname}"
+        run "sudo chown -R #{user}:#{user} #{dirname}"
+        run "touch #{dirname}"
+      end
+
+      desc "get the latest ugc backup"
+      task :latest, :role => :web do
+        backups = capture("ls -dxt ~/#{application}-#{stage}-*-ugc").split.reverse
+        size
+        puts "rsync, this could take a while..."
+        system "rsync -lrp --human-readable --progress --delete #{user}@#{application_host}:#{backups.last}/ #{ugc_local_cache}"
+        puts "local rsync from local cache to final dir"
+        system "rsync -lrp #{ugc_local_cache}/ #{backups.last.split('/').last}"
+      end
+
+      desc "backup and dowload user generated content"
+      task :download, :roles => :db do
+        backup
+        latest
+      end
+    end
+  end
+
+  before "drupal:db:dump", "drupal:clearcache"
+
+  # used to name new files
+  def now
+    now = Time.now.strftime("%Y-%m-%d-%H.%M.%S")
+  end
+
+  def ugc_local_cache
+    "tmp-#{application}"
+  end
+
+  def dumps_to_delete        
+    dumps = capture("ls -xt ~/#{application}-#{stage}-*sql").split
+    dumps.slice!(0, max_keep_dump)
+    dumps.each do |dump|
+      yield dump
+    end
+  end
+
+  def backups_to_delete        
+    backups = capture("ls -dxt ~/#{application}-#{stage}-*-ugc").split
+    backups.slice!(0, max_keep_backup)
+    backups.each do |backup|
+      yield backup
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'cap-drupal'
+
+class Test::Unit::TestCase
+end

data/test/test_cap-drupal.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestCapDrupal < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: cap-drupal
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Mathieu Elie
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-13 00:00:00 +02:00
+default_executable: cap-drupal
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Capistrano recipes fitted to our needs/workflow at websiteburo, could be useful elsewhere
+email: mathieuelie@gmail.com
+executables: 
+- cap-drupal
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.mkd
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.mkd
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/cap-drupal
+- lib/cap-drupal.rb
+- lib/recipes/drupal.rb
+- test/helper.rb
+- test/test_cap-drupal.rb
+has_rdoc: true
+homepage: http://github.com/mathieue/cap-drupal
+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: Drupal capistrano recipes
+test_files: 
+- test/test_cap-drupal.rb
+- test/helper.rb