wp-capistrano 0.2.0 → 0.3.0

data/.gitignore

@@ -0,0 +1,2 @@
+pkg/
+wp-capistrano.gemspec

data/LICENCE

@@ -0,0 +1,13 @@
+Copyright © 2010, The Dextrous Web
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

data/README.rdoc

@@ -4,58 +4,73 @@ Capistrano receipe for WordPress
 
 == Usage
 
-A sample Capfile and config.yml exist in lib/wp_generate/templates/capify.
+ gem install wp-capistrano
+ cd /path/to/wordpress/wp-content
+ wpcapify .
+ vim lib/config.yml
+ cap setup # once
+ cap deploy
 
-Those should be copied into wp-content/Capfile and wp-content/lib/config.yml respectively. Things you'll need to change in config.yml include:
+Configuration options:
 
-- application.repository -> set that to the repository that includes the contents of wp-content
-- wordpress.repository -> in the sample this is set to our mirror on GitHub, but you may prefer to mirror that locally or set up your own
-- wordpress.version -> a git tree-ish, which can be a branch name, tag, or a commit hash (e.g. v2.9.2)
-- deploy.* -> these names are used when doing cap deploy when deploying to non-default environments (i.e. cap production deploy)
-- deploy.*.ssh_user -> the user who will log into the machine, if omitted will use the default
-- deploy.*.ssh_domain -> the host to be SSHed into
-- deploy.*.path -> the path on the remote machine
-- deploy.*.vhost -> the intended host name when being viewed on the remote machine
-- deploy.*.database.*
+[application.repository] The repository that contains wp-content
+[wordpress.repository]   By default, it uses our GitHub mirror
+[wordpress.version]      A git tree-ish, which can be a branch name, tag, or a commit hash (e.g. v3.0.1)
+[deploy.*]               These names are used when doing cap deploy when deploying to non-default environments (i.e. cap production deploy)
+[deploy.*.default]       Set this to true to make this the default target
+[deploy.*.ssh_user]      The deploy user (who should have write access to +path+ on the remote machine)
+[deploy.*.ssh_domain]    The host where the site lives
+[deploy.*.path]          The path on the remote machine
+[deploy.*.vhost]         The HTTP hostname - sets WP_HOME and WP_SITEURL
+[deploy.*.database.*]    All the database settings (name, user, host, password)
+[deploy.*.modules]       A list of modules that should be enabled
 
-For the initial run, you should first create the directory specified in deploy.*.path on the server, or at least make sure it's possible for the deploy user to create it, then run:
+Before you run <tt>cap setup</tt> or <tt>cap deploy</tt>, you should ensure the path on the remote machine exists and is chmodded such that the deploy user can write to it.
 
- cap setup:wordpress
+To deploy to production rather than staging, for instance:
 
-This will create the Capistrano structure, check out the specified version of WordPress, create a shared directory full of things like wp-config.php and uploads. Now go and edit wp-config.php on the server, unless you specified the database password in config.yml. Then to deploy your wp-content, run:
+ cap production deploy
 
- cap deploy
+== Modules
 
-If you've set up Apache correctly (a .htaccess will be created, but that's all the help it will give you), you can visit the vhost you specified and everything should be working.
+These are configured in deploy.*.modules:
 
-When you update things, don't forget to push wp-content (and any submodules), and:
+[plugin-install] Makes the plugin directory writable by all, and creates the upgrade directory
+[shared-dirs]    Copies local directory to remote machine at setup time, and makes it writable by all
+[wp-super-cache] Sets up WP Super Cache, including wp-config, and setting up the appropriate cache directories
 
- cap deploy
+Note: Some modules are set with a string, others are set with a hash. For instance:
 
-And to setup/deploy to hosts other than the default, use:
+ - modules:
+   - plugin-install
+   - shared-dirs:
+     - plugins
+     - uploads
+   - wp-super-cache
 
- cap staging deploy
- cap production deploy
-
-== Additional features
+== Automagic features
 
 === SASS
 
-If there exists wp-content/themes/*/*/sass_output.php it will be executed (from that directory) and its contents will be placed in sass_output.css. Then ../style.css will be sedded to s/\.php/\.css/, and both will be uploaded to the appropriate places.
+If there exists wp-content/themes/*/*/sass_output.php it will be executed locally and its contents will be uploaded as sass_output.css. Then style.css will be sedded to s/\.php/\.css/.
+
+A sample sass_output.php can be found in wp-generate ( http://github.com/dxw/wp-generate ).
 
-sass_output.php can be found in wp-generate's theme generator. It is very handy for development, but less server load is more good, so we "cache" it in this way.
+=== htaccess
 
-== wp-generate
+Uploads ./htaccess to .htaccess if it exists.
 
-wp-capistrano can be used with wp-generate by doing the following:
+=== Fixing plugins
 
- gem install wp-generate
- cd wp-content
- wp-generate capify
+Some plugins require esoteric setups. We fix these automatically:
 
-Which creates Capfile and lib/config.yml.
+- Cforms
 
 == Credits
 
-Code originally adapted from:
-http://github.com/jestro/wordpress-capistrano
+[Main author] Tom Adams <tom@thedextrousweb.com>
+[Some code]   http://github.com/jestro/wordpress-capistrano
+
+== Copyright
+
+Copyright © 2010 The Dextrous Web. See LICENCE for details.

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/bin/wpcapify

@@ -0,0 +1,96 @@
+#!/usr/bin/env ruby
+
+require 'fileutils'
+require 'optparse'
+
+FILES = {
+  'Capfile' => <<-END,
+load 'deploy'
+require 'wp-capistrano'
+  END
+  'lib/config.yml' => <<-END
+--- 
+application:
+  repository: git@github.com:user/repo.git
+wordpress:
+  repository: git://github.com/dxw/wordpress.git
+  version: v3.0.1
+deploy:
+  base: &base
+    ssh_user: deploy
+    ssh_domain: example.org
+    modules:
+      - shared-dirs:
+        - uploads
+  staging:
+    <<: *base
+    default: true
+    path: /var/vhosts/example.org/staging/www
+    vhost: staging.example.org
+    database:
+      name: example_staging
+      user: root
+  production:
+    <<: *base
+    path: /var/vhosts/example.org/www
+    vhost: example.org
+    database:
+      name: example_production
+      user: root
+  END
+}
+
+opt = OptionParser.new do |opts|
+  opts.banner = "Usage: wpcapify PATH"
+end
+
+argv = opt.parse(ARGV)
+
+if argv.empty?
+  warn "Please specify the directory to wpcapify, e.g. `wpcapify .'"
+  exit 1
+elsif argv.length > 1
+  warn "Too many arguments; please specify only the directory to wpcapify."
+  exit 1
+else
+  dir = argv.first
+
+  # Do something really clever (set application/repository automagically)
+
+  app_repo = nil
+  Dir.chdir(dir) do
+    f = `git remote -v 2>/dev/null`
+    f.each do |l|
+      if m = l.match(/^origin\s+(.+)\s+\(fetch\)$/)
+        app_repo = m[1]
+      end
+    end
+  end
+  FILES['lib/config.yml'].sub!('git@github.com:user/repo.git', app_repo) if app_repo
+
+  # Write files
+
+  FILES.each do |path,content|
+    reported_path = File.join(dir, path)
+    exact_path = File.expand_path(reported_path)
+
+    if File.exist? exact_path
+      warn "[skip] '#{reported_path}' already exists"
+    else
+      d = File.dirname(exact_path)
+
+      unless File.exist? d
+        FileUtils.mkdir_p(d)
+        warn "[add] making directory '#{File.dirname(reported_path)}'"
+      end
+
+      open(exact_path,'w') do |f|
+        f.write(content)
+      end
+      warn "[add] writing '#{reported_path}'"
+    end
+  end
+
+  warn "[done] wpcapified!"
+
+end

data/lib/wp-capistrano/deploy.rb

@@ -0,0 +1,122 @@
+Capistrano::Configuration.instance.load do
+  namespace :deploy do
+
+    desc "Override deploy restart to not do anything"
+    task :restart do
+    end
+
+    task :finalize_update, :except => { :no_release => true } do
+      run "chmod -R g+w #{latest_release}"
+
+      # I've got submodules in my submodules
+      #run "cd #{latest_release} && git submodule foreach --recursive git submodule update --init"
+      # Git 1.5-compatability:
+      run "cd #{latest_release} && DIR=`pwd` && for D in `grep '^\\[submodule' .git/config | cut -d\\\" -f2`; do cd $DIR/$D && git submodule init && git submodule update; done"
+
+      run <<-CMD
+        mkdir -p #{latest_release}/finalized &&
+        cp -rv   #{shared_path}/wordpress/*     #{latest_release}/finalized/ &&
+        rm -rf   #{latest_release}/finalized/wp-content &&
+        mkdir    #{latest_release}/finalized/wp-content &&
+        rm -rf #{latest_release}/**/.git &&
+        mkdir -p #{latest_release}/finalized/wp-content/cache/ ;
+        chmod -R 777 #{latest_release}/finalized/wp-content/cache/ ;
+        true
+      CMD
+
+      set :content_dirs, {'themes' => :copy,
+                          'uploads' => :copy,
+                          'plugins' => :copy}
+
+      deploy.content_dirs_configure
+
+      content_dirs.each_pair do |dir,action|
+        dest = "#{latest_release}/finalized/wp-content/"
+        case action
+        when :copy
+          run "cp -rv #{latest_release}/#{dir} #{dest}"
+        when :link then 'ln -s'
+          run "ln -s #{shared_path}/#{dir} #{dest}"
+        end
+      end
+
+      deploy.wp_config
+
+    end
+
+    # A dummy task to collect content_dirs
+    task :content_dirs_configure do
+    end
+
+    # A dummy task to collect wp-config.php constants
+    task :wp_config_configure do
+    end
+
+    desc "Copy shared wp-config into place, adding per-deploy constants"
+    task :wp_config do
+      ## Generate a couple of PHP fragments
+
+      # nb:
+      # - in a string=>string pair, the value represents a PHP literal (i.e. it includes the quotes)
+      #   the key, however, is a string
+      # - the convention is to put things into preconfig unless there's a reason not to
+      set :preconfig, {}
+      set :postconfig, {}
+      # For certain cases we may allow the user write access (i.e. module plugin-install)
+      # it should always be direct filesystem access (and WordPress' autodetection is pants)
+      preconfig['FS_METHOD'] = "'direct'"
+
+      # Allow modules a chance to interfere
+      deploy.wp_config_configure
+
+      def phpize(h)
+        s = []
+        h.each_pair do |k,v|
+          s << "define('#{k}', #{v});"
+        end
+        s.join("\n")
+      end
+
+      prestring = phpize(preconfig)
+      poststring = phpize(postconfig)
+
+      ## Upload fragments
+
+      run "mkdir -p #{latest_release}/build"
+      put prestring, "#{latest_release}/build/pre-config"
+      put poststring, "#{latest_release}/build/post-config"
+
+      ## sed them into wp-config (using perl)
+      r = "cp -rv #{shared_path}/wp-config.php #{latest_release}/wp-config.php &&"
+
+      %w[pre post].each do |pp|
+        f = "#{latest_release}/build/#{pp}-config"
+        r += %Q`perl -i -pe 'BEGIN{undef $/;open(F,"<#{f}");@f=<F>;$f=join("",@f);}s/## #{pp.upcase}CONFIG BEGIN.*## #{pp.upcase}CONFIG END./$f/ms' #{latest_release}/wp-config.php &&`
+      end
+
+      r += "cp -rv #{latest_release}/wp-config.php #{latest_release}/finalized/wp-config.php"
+
+      run r
+
+    end
+
+    task :symlink, :except => { :no_release => true } do
+      on_rollback do
+        if previous_release
+          run "rm -f #{current_path}; ln -s #{previous_release}/finalized #{current_path}; true"
+        else
+          logger.important "no previous release to rollback to, rollback of symlink skipped"
+        end
+      end
+
+      run "rm -f #{current_path} && ln -s #{latest_release}/finalized #{current_path}"
+    end
+
+    namespace :revision do
+      task :revision do
+        puts 'hhh'
+      end
+    end
+
+  end
+end

data/lib/wp-capistrano/feature/cforms.rb

@@ -0,0 +1,8 @@
+# Make the cforms plugin work
+
+Capistrano::Configuration.instance.load do
+  after 'deploy:finalize_update' do
+    cforms_dir = "#{latest_release}/finalized/wp-content/plugins/cforms"
+    run(%Q%[ -e #{cforms_dir} ] && echo '<?php $abspath="#{latest_release}/finalized/" ?>' > #{cforms_dir}/abspath.php ; true%)
+  end
+end

data/lib/wp-capistrano/feature/htaccess.rb

@@ -0,0 +1,9 @@
+# Custom htaccess
+
+Capistrano::Configuration.instance.load do
+  after 'deploy:finalize_update' do
+    if File.exist? 'htaccess'
+      top.upload("htaccess", "#{latest_release}/finalized/.htaccess" , :via => :scp)
+    end
+  end
+end

data/lib/wp-capistrano/feature/plugin-install.rb

@@ -0,0 +1,14 @@
+# Allow plugin installation by end-users
+
+Capistrano::Configuration.instance.load do
+  after 'deploy:finalize_update' do
+
+    if deploy_profile.modules.include? 'plugin-install'
+
+      run("mkdir -p #{latest_release}/finalized/wp-content/upgrade &&
+          chmod -R 777 #{latest_release}/finalized/wp-content/upgrade &&
+          chmod -R 777 #{latest_release}/finalized/wp-content/plugins ; true")
+    end
+
+  end
+end

data/lib/wp-capistrano/feature/sass.rb

@@ -0,0 +1,22 @@
+# Assumes you're using DXW's sass_output.php convention
+# A sample can be found in dxw/wp-generate:
+# http://github.com/dxw/wp-generate/blob/master/lib/wp_generate/templates/theme/sass/sass_output.php
+
+Capistrano::Configuration.instance.load do
+  after 'deploy:finalize_update' do
+    Dir.glob("themes/*/*/sass_output.php").map {|d| d.match(%r&/([^/]+)/([^/]+)/sass_output.php$&)[1,2]}[0..0].each do |theme_dir,sass_dir|
+
+      # Run sass_output.php
+      f = IO.popen("cd themes/#{theme_dir}/#{sass_dir} && php sass_output.php 2>/dev/null")
+      sass_output = f.readlines.join
+      remote_sass = "#{latest_release}/finalized/wp-content/themes/#{theme_dir}/#{sass_dir}/sass_output.css"
+
+      # Upload it
+      put(sass_output, remote_sass, :via => :scp)
+
+      # sed style.css to point to it
+      run("sed -i 's/\.php/\.css/' #{latest_release}/finalized/wp-content/themes/#{theme_dir}/style.css &&
+            chmod a+r #{remote_sass}")
+    end
+  end
+end

data/lib/wp-capistrano/feature/shared-dirs.rb

@@ -0,0 +1,70 @@
+# Shared directories get uploaded at setup-time and don't change
+
+Capistrano::Configuration.instance.load do
+  after 'set_target_' do
+
+    # Parse config
+    set :shared_dirs, []
+    deploy_profile.modules.select{|m|m.is_a?(Hash) && m['shared-dirs']}.each do |m|
+      m['shared-dirs'].each do |mm|
+        shared_dirs << mm
+      end
+    end
+
+  end
+
+  after 'setup:checkout' do
+
+    # Upload dirs
+    shared_dirs.each do |dir|
+      stop = false
+
+      # If it already exists, stop
+      run("ls -d #{shared_path}/#{dir} ; true") do |channel,stream,data|
+        if data.strip=="#{shared_path}/#{dir}"
+          STDERR.puts "*** #{dir} dir already exists. Not re-uploading."
+          stop = true
+        end
+      end
+
+      unless stop
+        # If we have it, upload it
+        if File.exist?(dir)
+          begin
+            upload(dir, shared_path, :recursive => true, :via => :scp)
+          rescue
+            STDERR.puts "*** #{dir} dir already exists and does not belong to us. Can't re-upload."
+            stop = true
+          end
+        else
+          run "mkdir -p #{shared_path}/#{dir}"
+        end
+
+        unless stop
+          # Let our Web server write to it
+          run "chmod -R 777 #{shared_path}/#{dir}"
+        end
+      end
+    end
+
+  end
+
+  before 'deploy:wp_config_configure' do
+
+    if shared_dirs.include? 'plugins'
+      preconfig['WP_PLUGIN_DIR'] = "'#{shared_path}/plugins'"
+    end
+
+  end
+
+  before 'deploy:content_dirs_configure' do
+    p 'hihi'
+
+    p shared_dirs
+
+    shared_dirs.each do |dir|
+      content_dirs[dir] = :link
+    end
+
+  end
+end

data/lib/wp-capistrano/feature/wp-super-cache.rb

@@ -0,0 +1,39 @@
+# WP Super Cache
+
+Capistrano::Configuration.instance.load do
+
+  before 'deploy:wp_config_configure' do
+    if deploy_profile.modules.include? 'wp-super-cache'
+      preconfig['WP_CACHE'] = "'true'"
+    end
+  end
+
+  after 'deploy:finalize_update' do
+
+    if File.exist? 'plugins/wp-super-cache/advanced-cache.php'
+      top.upload("plugins/wp-super-cache/advanced-cache.php", "#{latest_release}/finalized/wp-content/" , :via => :scp)
+      sedable_path = "#{latest_release}/finalized/wp-content/plugins/wp-super-cache/".gsub(/\//,'\/')
+      run("sed -i 's/CACHEHOME/#{sedable_path}/g' #{latest_release}/finalized/wp-content/advanced-cache.php")
+    else
+      raise IOError, 'Are you sure you have the WP Super Cache plugin?'
+    end
+
+    if File.exist? 'wp-cache-config.php'
+      top.upload("wp-cache-config.php", "#{latest_release}/finalized/wp-content/" , :via => :scp)
+    elsif File.exist? 'plugins/wp-super-cache/wp-cache-config-sample.php'
+      top.upload("plugins/wp-super-cache/wp-cache-config-sample.php", "#{latest_release}/finalized/wp-content/wp-cache-config.php" , :via => :scp)
+    else
+      raise IOError, 'Are you sure you have the WP Super Cache plugin?'
+    end
+
+    run("mkdir -p #{latest_release}/finalized/wp-content/cache/blogs &&
+         mkdir -p #{latest_release}/finalized/wp-content/cache/meta")
+
+    # Keep writables to a bare minimum
+    if deploy_profile.modules.include? 'wp-super-cache'
+      run("chmod -R 777 #{latest_release}/finalized/wp-content/cache &&
+           chmod -R 777 #{latest_release}/finalized/wp-content/wp-cache-config.php")
+    end
+  end
+
+end

data/lib/{wp_capistrano/namespace/wp.rb → wp-capistrano/setup.rb}

@@ -1,5 +1,15 @@
 Capistrano::Configuration.instance.load do
-  namespace :wp do
+  namespace :setup do
+
+    desc "Setup this server for a new wordpress site."
+    task :default do
+      # Capistrano's setup script
+      deploy.setup
+
+      # Our setup scripts
+      setup.config
+      setup.checkout
+    end
 
     desc "Checks out a copy of wordpress to a shared location"
     task :checkout do
@@ -9,20 +19,16 @@ Capistrano::Configuration.instance.load do
       run "cd #{shared_path}/wordpress && git fetch --tags && git checkout #{wordpress_version}"
     end
 
-    desc "Sets up wp-config.php"
+    desc "Sets up shared wp-config.php"
     task :config do
-      file = File.join(File.dirname(__FILE__), "../wp-config.php.erb")
+      file = File.join(File.dirname(__FILE__), "wp-config.php.erb")
       template = File.read(file)
+
       buffer = ERB.new(template).result(binding)
 
       put buffer, "#{shared_path}/wp-config.php"
       puts "New wp-config.php uploaded! Please run cap:deploy to activate these changes."
     end
 
-    desc "Sets up .htaccess"
-    task :htaccess do
-      run 'env echo -e \'<IfModule mod_rewrite.c>\nRewriteEngine On\nRewriteBase /\nRewriteCond %{REQUEST_FILENAME} !-f\nRewriteCond %{REQUEST_FILENAME} !-d\nRewriteRule . /index.php [L]\n</IfModule>\' > '"#{shared_path}/htaccess"
-    end
-
   end
 end

data/lib/{wp_capistrano → wp-capistrano}/wp-config.php.erb

@@ -21,6 +21,10 @@
  * @package WordPress
  */
 
+## PRECONFIG BEGIN
+# Anything between these tags will be removed.
+## PRECONFIG END
+
 // ** MySQL settings - You can get this info from your web host ** //
 /** The name of the database for WordPress */
 define('DB_NAME', '<%= wordpress_db_name %>');
@@ -84,6 +88,10 @@ define ('WPLANG', '');
 if ( !defined('ABSPATH') )
 	define('ABSPATH', dirname(__FILE__) . '/');
 
+## POSTCONFIG BEGIN
+# Anything between these tags will be removed.
+## POSTCONFIG END
+
 /** Sets up WordPress vars and included files. */
 require_once(ABSPATH . 'wp-settings.php');
 ?>

data/lib/wp-capistrano.rb

@@ -0,0 +1,100 @@
+require 'erb'
+require 'digest'
+require 'digest/sha1'
+
+require 'wp-config'
+require 'wp-capistrano/deploy'
+require 'wp-capistrano/setup'
+
+# Features
+require 'wp-capistrano/feature/cforms'
+require 'wp-capistrano/feature/htaccess'
+require 'wp-capistrano/feature/plugin-install'
+require 'wp-capistrano/feature/sass'
+require 'wp-capistrano/feature/shared-dirs'
+require 'wp-capistrano/feature/wp-super-cache'
+
+Capistrano::Configuration.instance.load do
+  default_run_options[:pty] = true
+
+  # Dummy task
+  task :set_target_ do
+  end
+
+  def set_target target
+    tt = WPConfig.instance.h['deploy'][target]
+    if tt
+      t = OpenStruct.new(tt)
+      set :domain, t.ssh_domain
+      set :user, t.ssh_user
+      set :deploy_to, t.path
+      set :wordpress_domain, t.vhost
+      set :wordpress_domain, 'localhost' if wordpress_domain.nil?
+      set :wordpress_db_name, t.database.name
+      set :wordpress_db_user, t.database.user
+      set :wordpress_db_user, 'root' if wordpress_db_user.nil?
+      set :wordpress_db_password, t.database.password
+      set :wordpress_db_host, t.database.host
+      set :wordpress_db_host, 'localhost' if wordpress_db_host.nil?
+      set :use_sudo, t.use_sudo
+      set :deploy_profile, t
+      deploy_profile.modules = [] unless deploy_profile.modules
+
+      @roles = {}
+      role :app, domain
+      role :web, domain
+      role :db,  domain, :primary => true
+    end
+
+    # Allow features to plug in here
+    set_target_
+  end
+
+  WPConfig.instance.h['deploy'].each_pair do |k,v|
+    task k do
+      set_target k
+    end
+    set_target k if v['default']
+  end
+
+  # Load from config
+  set :wordpress_version, WPConfig.wordpress.version
+  set :wordpress_git_url, WPConfig.wordpress.repository
+  set :repository, WPConfig.application.repository
+
+  # Everything else
+  set :scm, "git"
+  set :deploy_via, :remote_cache
+  set :branch, "master"
+  set :git_shallow_clone, 1
+  set :git_enable_submodules, 1
+  set :wordpress_db_host, "localhost"
+  set :wordpress_auth_key, Digest::SHA1.hexdigest(rand.to_s)
+  set :wordpress_secure_auth_key, Digest::SHA1.hexdigest(rand.to_s)
+  set :wordpress_logged_in_key, Digest::SHA1.hexdigest(rand.to_s)
+  set :wordpress_nonce_key, Digest::SHA1.hexdigest(rand.to_s)
+
+  #allow deploys w/o having git installed locally
+  set(:real_revision) do
+    output = ""
+    invoke_command("git ls-remote #{repository} #{branch} | cut -f 1", :once => true) do |ch, stream, data|
+      case stream
+      when :out
+        if data =~ /\(yes\/no\)\?/ # first time connecting via ssh, add to known_hosts?
+          ch.send_data "yes\n"
+        elsif data =~ /Warning/
+        elsif data =~ /yes/
+          #
+        else
+          output << data
+        end
+      when :err then warn "[err :: #{ch[:server]}] #{data}"
+      end
+    end
+    output.gsub(/\\/, '').chomp
+  end
+
+  #no need for log and pids directory
+  set :shared_children, %w(system)
+
+end

data/lib/wp_capistrano/deploy.rb

@@ -1,92 +1,2 @@
-require 'wp_config'
-require 'erb'
-require 'digest'
-require 'digest/sha1'
-
-require 'wp_capistrano/namespace/deploy'
-require 'wp_capistrano/namespace/setup'
-require 'wp_capistrano/namespace/wp'
-
-Capistrano::Configuration.instance.load do
-  default_run_options[:pty] = true
-
-  def set_target target
-    tt = WPConfig.instance.h['deploy'][target]
-    if tt
-      t = OpenStruct.new(tt)
-      set :domain, t.ssh_domain
-      set :user, t.ssh_user
-      set :deploy_to, t.path
-      set :wordpress_domain, t.vhost
-      set :wordpress_domain, 'localhost' if wordpress_domain.nil?
-      set :wordpress_db_name, t.database.name
-      set :wordpress_db_user, t.database.user
-      set :wordpress_db_user, 'root' if wordpress_db_user.nil?
-      set :wordpress_db_password, t.database.password
-      set :wordpress_db_host, t.database.host
-      set :wordpress_db_host, 'localhost' if wordpress_db_host.nil?
-      set :use_sudo, t.use_sudo
-      set :deploy_profile, t
-
-      @roles = {}
-      role :app, domain
-      role :web, domain
-      role :db,  domain, :primary => true
-    end
-  end
-
-  WPConfig.instance.h['deploy'].each_pair do |k,v|
-    set_target k if v['default']
-  end
-
-  task :testing do
-    set_target 'testing'
-  end
-  task :staging do
-    set_target 'staging'
-  end
-  task :production do
-    set_target 'production'
-  end
-
-  # Load from config
-  set :wordpress_version, WPConfig.wordpress.version
-  set :wordpress_git_url, WPConfig.wordpress.repository
-  set :repository, WPConfig.application.repository
-
-  # Everything else
-  set :scm, "git"
-  set :deploy_via, :remote_cache
-  set :branch, "master"
-  set :git_shallow_clone, 1
-  set :git_enable_submodules, 1
-  set :wordpress_db_host, "localhost"
-  set :wordpress_auth_key, Digest::SHA1.hexdigest(rand.to_s)
-  set :wordpress_secure_auth_key, Digest::SHA1.hexdigest(rand.to_s)
-  set :wordpress_logged_in_key, Digest::SHA1.hexdigest(rand.to_s)
-  set :wordpress_nonce_key, Digest::SHA1.hexdigest(rand.to_s)
-
-  #allow deploys w/o having git installed locally
-  set(:real_revision) do
-    output = ""
-    invoke_command("git ls-remote #{repository} #{branch} | cut -f 1", :once => true) do |ch, stream, data|
-      case stream
-      when :out
-        if data =~ /\(yes\/no\)\?/ # first time connecting via ssh, add to known_hosts?
-          ch.send_data "yes\n"
-        elsif data =~ /Warning/
-        elsif data =~ /yes/
-          #
-        else
-          output << data
-        end
-      when :err then warn "[err :: #{ch[:server]}] #{data}"
-      end
-    end
-    output.gsub(/\\/, '').chomp
-  end
-
-  #no need for log and pids directory
-  set :shared_children, %w(system)
-
-end
+warn "[DeprecationWarning] Capfile should not require 'wp_capistrano/deploy' - require 'wp-capistrano instead'"
+require 'wp-capistrano' # Compatability

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - The Dextrous Web
@@ -14,31 +14,37 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-10 00:00:00 +01:00
-default_executable: 
+date: 2010-09-02 00:00:00 +01:00
+default_executable: wpcapify
 dependencies: []
 
 description: ""
 email: tom@thedextrousweb.com
-executables: []
-
+executables: 
+- wpcapify
 extensions: []
 
 extra_rdoc_files: 
 - README.rdoc
 files: 
+- .gitignore
+- LICENCE
 - README.rdoc
 - Rakefile
 - VERSION
+- bin/wpcapify
+- lib/wp-capistrano.rb
+- lib/wp-capistrano/deploy.rb
+- lib/wp-capistrano/feature/cforms.rb
+- lib/wp-capistrano/feature/htaccess.rb
+- lib/wp-capistrano/feature/plugin-install.rb
+- lib/wp-capistrano/feature/sass.rb
+- lib/wp-capistrano/feature/shared-dirs.rb
+- lib/wp-capistrano/feature/wp-super-cache.rb
+- lib/wp-capistrano/setup.rb
+- lib/wp-capistrano/wp-config.php.erb
+- lib/wp-config.rb
 - lib/wp_capistrano/deploy.rb
-- lib/wp_capistrano/namespace/deploy.rb
-- lib/wp_capistrano/namespace/setup.rb
-- lib/wp_capistrano/namespace/wp.rb
-- lib/wp_capistrano/wp-config.php.erb
-- lib/wp_config.rb
-- lib/wp_generate/generator/capify.rb
-- lib/wp_generate/templates/capify/Capfile
-- lib/wp_generate/templates/capify/config.yml
 has_rdoc: true
 homepage: http://github.com/dxw/wp-capistrano
 licenses: []

data/lib/wp_capistrano/namespace/deploy.rb

@@ -1,97 +0,0 @@
-Capistrano::Configuration.instance.load do
-  namespace :deploy do
-
-    desc "Override deploy restart to not do anything"
-    task :restart do
-      #
-    end
-
-    task :finalize_update, :except => { :no_release => true } do
-      run "chmod -R g+w #{latest_release}"
-
-      # I've got submodules in my submodules
-      #run "cd #{latest_release} && git submodule foreach --recursive git submodule update --init"
-      # Git 1.5-compatability:
-      run "cd #{latest_release} && DIR=`pwd` && for D in `grep '^\\[submodule' .git/config | cut -d\\\" -f2`; do cd $DIR/$D && git submodule init && git submodule update; done"
-
-      deploy.sass
-
-      run <<-CMD
-        mkdir -p #{latest_release}/finalized &&
-        cp -rv   #{shared_path}/wordpress/*     #{latest_release}/finalized/ &&
-        cp -rv   #{shared_path}/wp-config.php   #{latest_release}/finalized/wp-config.php &&
-        cp -rv   #{shared_path}/htaccess        #{latest_release}/finalized/.htaccess &&
-        rm -rf   #{latest_release}/finalized/wp-content &&
-        mkdir    #{latest_release}/finalized/wp-content &&
-        rm -rf #{latest_release}/**/.git &&
-        cp -rv #{latest_release}/themes  #{latest_release}/finalized/wp-content/ &&
-        cp -rv #{latest_release}/plugins #{latest_release}/finalized/wp-content/ &&
-        ln -s #{shared_path}/uploads   #{latest_release}/finalized/wp-content/ &&
-        mkdir -p #{latest_release}/finalized/wp-content/cache/ ;
-        chmod -R 777 #{latest_release}/finalized/wp-content/cache/ ;
-        true
-      CMD
-
-      ## WP Super Cache
-
-      if deploy_profile.modules and deploy_profile.modules.include? 'wp-super-cache'
-
-        if File.exist? 'plugins/wp-super-cache/advanced-cache.php'
-          top.upload("plugins/wp-super-cache/advanced-cache.php", "#{latest_release}/finalized/wp-content/" , :via => :scp)
-          sedable_path = "#{latest_release}/finalized/wp-content/plugins/wp-super-cache/".gsub(/\//,'\/')
-          run("sed -i 's/CACHEHOME/#{sedable_path}/g' #{latest_release}/finalized/wp-content/advanced-cache.php")
-        else
-          raise IOError, 'Are you sure you have the WP Super Cache plugin?'
-        end
-
-        if File.exist? 'wp-cache-config.php'
-          top.upload("wp-cache-config.php", "#{latest_release}/finalized/wp-content/" , :via => :scp)
-        elsif File.exist? 'plugins/wp-super-cache/wp-cache-config-sample.php'
-          top.upload("plugins/wp-super-cache/wp-cache-config-sample.php", "#{latest_release}/finalized/wp-content/wp-cache-config.php" , :via => :scp)
-        else
-          raise IOError, 'Are you sure you have the WP Super Cache plugin?'
-        end
-
-        #TODO
-        if File.exist? 'htaccess'
-          top.upload("htaccess", "#{latest_release}/finalized/.htaccess" , :via => :scp)
-        end
-
-        run("mkdir -p #{latest_release}/finalized/wp-content/cache/blogs &&
-         mkdir -p #{latest_release}/finalized/wp-content/cache/meta &&
-         chmod -R 777 #{latest_release}/finalized/wp-content/cache &&
-         chmod -R 777 #{latest_release}/finalized/wp-content/wp-cache-config.php")
-
-      end
-    end
-
-    desc "Compile SASS locally and upload it"
-    task :sass do
-      Dir.glob("themes/*/*/sass_output.php").map {|d| d.match(%r&/([^/]+)/([^/]+)/sass_output.php$&)[1,2]}[0..0].each do |theme_dir,sass_dir|
-        p theme_dir
-        p sass_dir
-        system("cd themes/#{theme_dir}/#{sass_dir} && php sass_output.php > sass_output.css")
-        top.upload("themes/#{theme_dir}/#{sass_dir}/sass_output.css", "#{latest_release}/themes/#{theme_dir}/#{sass_dir}/" , :via => :scp)
-        run("sed -i 's/\.php/\.css/' #{latest_release}/themes/#{theme_dir}/style.css")
-      end
-    end
-
-    task :symlink, :except => { :no_release => true } do
-      on_rollback do
-        if previous_release
-          run "rm -f #{current_path}; ln -s #{previous_release}/finalized #{current_path}; true"
-        else
-          logger.important "no previous release to rollback to, rollback of symlink skipped"
-        end
-      end
-
-      run "rm -f #{current_path} && ln -s #{latest_release}/finalized #{current_path}"
-    end
-
-    namespace :revision do
-      task :revision do
-        puts 'hhh'
-      end
-    end
-  end
-end

data/lib/wp_capistrano/namespace/setup.rb

@@ -1,66 +0,0 @@
-Capistrano::Configuration.instance.load do
-  namespace :setup do
-
-    desc "Alias for wordpress"
-    task :default do
-      setup.wordpress
-    end
-
-    desc "Setup this server for a new wordpress site."
-    task :wordpress do
-      "mkdir -p #{deploy_to}"
-      deploy.setup
-      wp.config
-      wp.htaccess
-      wp.checkout
-      setup.uploads
-      setup.mysql
-    end
-
-    desc "Creates uploads dir"
-    task :uploads do
-
-      stop = false
-
-      # If it already exists, stop
-      run("ls -d #{shared_path}/uploads") do |channel,stream,data|
-        if data.strip=="#{shared_path}/uploads"
-          STDERR.puts '*** uploads dir already exists. Not re-uploading.'
-          stop = true
-        end
-      end
-
-      unless stop
-        # If we have it, upload it
-        if File.exist?('uploads')
-          begin
-            upload("uploads", shared_path, :recursive => true, :via => :scp)
-          rescue
-            STDERR.puts '*** uploads dir already exists and does not belong to us. Can\'t re-upload.'
-            stop = true
-          end
-        else
-          run "mkdir -p #{shared_path}/uploads"
-        end
-
-        unless stop
-          # Let our Web server write to it
-          run "chmod -R 777 #{shared_path}/uploads"
-        end
-      end
-    end
-
-    desc "Creates the DB, and loads the dump"
-    task :mysql do
-      if File.exist? 'data/dump.sql.gz'
-        upload("data/dump.sql.gz", shared_path, :via => :scp)
-        run <<-CMD
-        test #{wordpress_db_name}X != `echo 'show databases' | mysql | grep '^#{wordpress_db_name}$'`X &&
-        echo 'create database if not exists `#{wordpress_db_name}`' | mysql &&
-        zcat #{shared_path}/dump.sql.gz | sed 's/localhost/#{wordpress_domain}/g' | mysql #{wordpress_db_name} || true
-        CMD
-      end
-    end
-
-  end
-end

data/lib/wp_generate/generator/capify.rb

@@ -1,10 +0,0 @@
-class WpGenerate::Generator::Capify < WpGenerate::Generator
-  def initialize args, options
-    @options = options
-    @templates = {"Capfile" => "Capfile", "config.yml" => "lib/config.yml"}
-    @vars = {}
-  end
-  def templates_dir
-    File.join(File.dirname(__FILE__), '../templates')
-  end
-end

data/lib/wp_generate/templates/capify/Capfile

@@ -1,2 +0,0 @@
-load 'deploy'
-require 'wp_capistrano/deploy'

data/lib/wp_generate/templates/capify/config.yml

@@ -1,38 +0,0 @@
---- 
-application:
-  repository: "git@github.com:user/repo.git"
-wordpress:
-  repository: "git://github.com/dxw/wordpress.git"
-  version: "v2.9.2"
-deploy:
-  testing:
-    default: true
-    ssh_user: deploy
-    ssh_domain: "example.com"
-    path: "/var/vhosts/example.com/testing/app"
-    vhost: "app.testing.example.com"
-    database:
-      name: "app_testing"
-      user: "app_testing"
-      password: ""
-      host: "localhost"
-  staging:
-    ssh_user: deploy
-    ssh_domain: "example.com"
-    path: "/var/vhosts/example.com/staging/app"
-    vhost: "app.staging.example.com"
-    database:
-      name: "app_staging"
-      user: "app_staging"
-      password: ""
-      host: "localhost"
-  production:
-    ssh_user: deploy
-    ssh_domain: "example.com"
-    path: "/var/vhosts/example.com/production/app"
-    vhost: "app.com"
-    database:
-      name: "app_production"
-      user: "app_production"
-      password: ""
-      host: "localhost"