capistrano-wpcli 0.0.9 → 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 98c4ce05bb1c3f5ff4e97fb15cdacb6df4162596
+  data.tar.gz: 84f98ecbb15215b44ab6752f977980ae6221de05
+SHA512:
+  metadata.gz: f3df99c527a8996ce46d8b262abfd1d70fdf43b626f00b56b9c502741d538d25f0b676ca5ed1a176b86351a7edf87fa65e8db8236cce462b68a95bcbce769303
+  data.tar.gz: 18c150f7cf6cdcf2324557e705850375cc2cc5419b0f73a40cada1202ef0df8d8b3229dc9d5c8e6d0d332b40cdf0c498accb7093b0b6d9b332abfda9b79b45ab

data/Gemfile.lock

@@ -1,24 +1,25 @@
 PATH
   remote: .
   specs:
-    capistrano-wpcli (0.0.5)
-      capistrano (>= 3.0)
+    capistrano-wpcli (0.1.1)
+      capistrano (~> 3.4.0)
+      sshkit (~> 1.7.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    capistrano (3.2.1)
+    capistrano (3.4.0)
       i18n
       rake (>= 10.0.0)
       sshkit (~> 1.3)
-    colorize (0.7.3)
-    i18n (0.6.9)
+    colorize (0.7.7)
+    i18n (0.7.0)
     net-scp (1.2.1)
       net-ssh (>= 2.6.5)
-    net-ssh (2.9.1)
-    rake (10.3.2)
-    sshkit (1.5.1)
-      colorize
+    net-ssh (3.0.1)
+    rake (10.4.2)
+    sshkit (1.7.1)
+      colorize (>= 0.7.0)
       net-scp (>= 1.1.2)
       net-ssh (>= 2.8.0)
 
@@ -26,6 +27,6 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.6)
+  bundler (~> 1.7.0)
   capistrano-wpcli!
-  rake
+  rake (~> 10.4.0)

data/README.md

@@ -1,5 +1,7 @@
 # Capistrano::WPCLI
 
+[![Dependency Status](https://www.versioneye.com/user/projects/561c9bfda193340f2f001728/badge.svg?style=flat)](https://www.versioneye.com/user/projects/561c9bfda193340f2f001728)
+
 **Note: this plugin works only with Capistrano 3.**
 
 Provides command line tools to facilitate Wordpress deploy.
@@ -24,23 +26,66 @@ All you need to do is put the following in `Capfile` file:
 
     require 'capistrano/wpcli'
 
-### How it works
+### How it works (Tasks)
 
-The following tasks are added to Capistrano:
+    wpcli:run
 
-* `wpcli:run`<br/>
 Executes the WP-CLI command passed as parameter.
-* `wpcli:db:push`<br/>
+
+    cap production wpcli:run["core language install fr_FR"]
+
+- - -
+
+    wpcli:db:push
+
 Pushes the local WP database to the remote server and replaces the urls.
-* `wpcli:db:pull`<br/>
+
+Optionally backs up the remote database before pushing (if `wpcli_backup_db` is set to true, see Configuration).
+
+    cap production wpcli:db:push
+
+- - -
+
+    wpcli:db:pull
+
 Pulls the remote server WP database to local and replaces the urls.
-* `wpcli:rewrite:flush`<br/>
+
+    cap production wpcli:db:pull
+
+- - -
+
+    wpcli:db:backup:remote
+
+Pulls the remote server WP database to localhost, uses `wpcli_local_db_backup_dir` to define the location of the export.
+
+- - -
+
+    wpcli:db:backup:local
+
+Backs up the local WP database to localhost, uses `wpcli_local_db_backup_dir` to define the location of the export.
+
+- - -
+
+    wpcli:rewrite:flush
+
 Flush rewrite rules.
-* `wpcli:rewrite:hard_flush`<br/>
-Perform a hard flush - update `.htaccess` rules as well as rewrite rules in database.
-* `wpcli:uploads:rsync:push`<br/>
+
+- - -
+
+    wpcli:rewrite:hard_flush
+
+Perform a hard flush - updates `.htaccess` rules as well as rewrite rules in database.
+
+- - -
+
+    wpcli:uploads:rsync:push
+
 Push local uploads delta to remote machine using rsync.
-* `wpcli:uploads:rsync:pull`<br/>
+
+- - -
+
+    wpcli:uploads:rsync:pull
+
 Pull remote uploads delta to local machine using rsync.
 
 ### Configuration
@@ -49,31 +94,83 @@ This plugin needs some configuration to work properly. You can put all your conf
 
 Here's the list of options and the defaults for each option:
 
-* `set :wpcli_remote_url`<br/>
-Url of the Wordpress root installation on the remote server (used by search-replace command).
+- - -
+
+    set :wpcli_remote_url
+
+Url of the WP root installation on the remote server (used by search-replace command).
+
+- - -
+
+    set :wpcli_local_url
+
+Url of the WP root installation on the local server (used by search-replace command).
+
+- - -
+
+    set :local_tmp_dir
+
+Absolute path to local directory temporary directory which is read and writeable.
+
+Defaults to `/tmp`
+
+- - -
+
+    set :wpcli_backup_db
+
+Set to true if you would like to create backups of databases on each push. Defaults to false.
+
+- - -
+
+    set :wpcli_local_db_backup_dir
+
+Absolute or relative path to local directory for storing database backups which is read and writeable.
+
+Defaults to `config/backup`
+
+**IMPORTANT: Make sure to add the folder to .gitignore to prevent db backups from being in version control.**
+
+- - -
+
+    set :wpcli_args
+
+You can pass arguments directly to WPCLI using this var.
+
+Defaults to `ENV['WPCLI_ARGS']`
+
+- - -
+
+    set :wpcli_local_uploads_dir
+
+Absolute or relative path to local WP uploads directory.
+
+Defaults to `web/app/uploads/`.
+
+**IMPORTANT: Add trailing slash!**
+
+- - -
+
+    set :wpcli_remote_uploads_dir
 
-* `set :wpcli_local_url`<br/>
-Url of the Wordpress root installation on the local server (used by search-replace command).
+Absolute path to remote wordpress uploads directory.
 
-* `set :local_tmp_dir`<br/>
-A local temp dir which is read and writeable. Defaults to `/tmp`.
+Defaults to `#{shared_path.to_s}/web/app/uploads/`
 
-* `set :wpcli_args`<br/>
-You can pass arguments directly to WPCLI using this var. By default it will try to load values from `ENV['WPCLI_ARGS']`.
+**IMPORTANT: Add trailing slash!**
 
-* `set :wpcli_local_uploads_dir`<br/>
-Local dir where WP stores the uploads. IMPORTANT: Add trailing slash! Optional if using [Bedrock Wordpress Stack](http://roots.io/wordpress-stack/)
+### FAQ
 
-* `set :wpcli_remote_uploads_dir`<br/>
-Remote dir where WP stores the uploads. IMPORTANT: Add trailing slash! Optional if using [Bedrock Wordpress Stack](http://roots.io/wordpress-stack/)
+- What if i want to use a custom port for rsync?
+  You can by setting your port somewhere inside the :ssh_options precedence.
+  See here: http://capistranorb.com/documentation/advanced-features/properties/#precedence
 
 ### Vagrant
 
-If you are using another machine as a development server (Vagrant for example), you should define a `dev` role and indicate the path were the project lives on that server. This normally goes on `deploy.rb` file. Here's an example:
+If you are using another machine as a development server (Vagrant for example), you should define a `dev` role and indicate the path where the project lives on that server. This normally goes on `deploy.rb` file. Here's an example:
 
-`server "example.dev", user: 'vagrant', password: 'vagrant', roles: %w{dev}`
+    server "example.dev", user: 'vagrant', password: 'vagrant', roles: %w{dev}
 
-`set :dev_path, '/srv/www/example.dev/current'`
+    set :dev_path, '/srv/www/example.dev/current'
 
 ## Contributing
 

data/capistrano-wpcli.gemspec

@@ -6,7 +6,7 @@ require 'capistrano/wpcli/version'
 Gem::Specification.new do |spec|
   spec.name          = "capistrano-wpcli"
   spec.version       = Capistrano::Wpcli::VERSION
-  spec.authors       = ["Juancito Arias"]
+  spec.authors       = ["Juancito Arias", "Jeremy Zahner"]
   spec.email         = ["trasgofurioso@gmail.com"]
   spec.summary       = %q{Simple Capistrano wrapper around WP-CLI}
   spec.description   = %q{Capistrano tasks for managing Wordpress}
@@ -18,8 +18,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'capistrano', '>= 3.0'
+  spec.add_dependency 'capistrano', '~> 3.4.0'
+  spec.add_dependency 'sshkit', '~> 1.7.0'
+
+  spec.add_development_dependency "bundler", "~> 1.7.0"
+  spec.add_development_dependency "rake", "~> 10.4.0"
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"
 end

data/lib/capistrano/tasks/wpdb.rake

@@ -1,5 +1,7 @@
 namespace :load do
+
   task :defaults do
+
     # The url under which the wordpress installation is
     # available on the remote server
     set :wpcli_remote_url, "http://example.com"
@@ -11,14 +13,30 @@ namespace :load do
     # A local temp dir which is read and writeable
     set :local_tmp_dir, "/tmp"
 
-    # Temporal db dumps path
+    # Use current time for annotating the backup file
+    set :current_time, -> { Time.now.strftime("%Y%m%d%H%M") }
+
+    # Boolean to determine wether the database should be backed up or not
+    set :wpcli_backup_db, false
+
+    # Set the location of the db backup files. This is relative to the local project root path.
+    set :wpcli_local_db_backup_dir, "config/backup"
+
+    # Temporary db dumps path
     set :wpcli_remote_db_file, -> {"#{fetch(:tmp_dir)}/wpcli_database.sql.gz"}
     set :wpcli_local_db_file, -> {"#{fetch(:local_tmp_dir)}/wpcli_database.sql.gz"}
+
+    # Backup file filename
+    set :wpcli_local_db_backup_filename, -> {"db_#{fetch(:stage)}_#{fetch(:current_time)}.sql.gz"}
+
   end
+
 end
 
 namespace :wpcli do
+
   namespace :db do
+
     desc "Pull the remote database"
     task :pull do
       on roles(:web) do
@@ -32,16 +50,24 @@ namespace :wpcli do
       unless roles(:dev).empty?
         on roles(:dev) do
           within fetch(:dev_path) do
-            execute :gunzip, "<", fetch(:wpcli_local_db_file), "|", :wp, :db, :import, "-"
-            execute :rm, fetch(:wpcli_local_db_file)
-            execute :wp, "search-replace", fetch(:wpcli_remote_url), fetch(:wpcli_local_url), fetch(:wpcli_args) || "--skip-columns=guid"
+            local_tmp_file = fetch(:wpcli_local_db_file).gsub(/\.gz$/, "")
+            upload! fetch(:wpcli_local_db_file), fetch(:wpcli_local_db_file)
+            execute :gunzip, "-c", fetch(:wpcli_local_db_file), ">", local_tmp_file
+            execute :wp, :db, :import, local_tmp_file
+            execute :rm, fetch(:wpcli_local_db_file), local_tmp_file
+            execute :wp, "search-replace", fetch(:wpcli_remote_url), fetch(:wpcli_local_url), fetch(:wpcli_args) || "--skip-columns=guid", "--url=" + fetch(:wpcli_remote_url)
           end
         end
-      else
         run_locally do
-          execute :gunzip, "<", fetch(:wpcli_local_db_file), "|", :wp, :db, :import, "-"
           execute :rm, fetch(:wpcli_local_db_file)
-          execute :wp, "search-replace", fetch(:wpcli_remote_url), fetch(:wpcli_local_url), fetch(:wpcli_args) || "--skip-columns=guid"
+        end
+      else
+        run_locally do
+          local_tmp_file = fetch(:wpcli_local_db_file).gsub(/\.gz$/, "")
+          execute :gunzip, "-c", fetch(:wpcli_local_db_file), ">", local_tmp_file
+          execute :wp, :db, :import, local_tmp_file
+          execute :rm, fetch(:wpcli_local_db_file), local_tmp_file
+          execute :wp, "search-replace", fetch(:wpcli_remote_url), fetch(:wpcli_local_url), fetch(:wpcli_args) || "--skip-columns=guid", "--url=" + fetch(:wpcli_remote_url)
         end
       end
     end
@@ -52,6 +78,7 @@ namespace :wpcli do
         on roles(:dev) do
           within fetch(:dev_path) do
             execute :wp, :db, :export, "- |", :gzip, ">", fetch(:wpcli_local_db_file)
+            download! fetch(:wpcli_local_db_file), fetch(:wpcli_local_db_file)
           end
         end
       else
@@ -62,9 +89,11 @@ namespace :wpcli do
       on roles(:web) do
         upload! fetch(:wpcli_local_db_file), fetch(:wpcli_remote_db_file)
         within release_path do
-          execute :gunzip, "<", fetch(:wpcli_remote_db_file), "|", :wp, :db, :import, "-"
-          execute :rm, fetch(:wpcli_remote_db_file)
-          execute :wp, "search-replace", fetch(:wpcli_local_url), fetch(:wpcli_remote_url), fetch(:wpcli_args) || "--skip-columns=guid"
+          remote_tmp_file = fetch(:wpcli_remote_db_file).gsub(/\.gz$/, "")
+          execute :gunzip, "-c", fetch(:wpcli_remote_db_file), ">", remote_tmp_file
+          execute :wp, :db, :import, remote_tmp_file
+          execute :rm, fetch(:wpcli_remote_db_file), remote_tmp_file
+          execute :wp, "search-replace", fetch(:wpcli_local_url), fetch(:wpcli_remote_url), fetch(:wpcli_args) || "--skip-columns=guid", "--url=" + fetch(:wpcli_local_url)
         end
       end
       unless roles(:dev).empty?
@@ -73,11 +102,46 @@ namespace :wpcli do
             execute :rm, fetch(:wpcli_local_db_file)
           end
         end
-      else
+      end
+      run_locally do
+        execute :rm, fetch(:wpcli_local_db_file)
+      end
+    end
+
+    namespace :backup do
+
+      desc "Checking / Creating backup directory"
+      task :create_backup_dir do
         run_locally do
-          execute :rm, fetch(:wpcli_local_db_file)
+          unless test("[ -d #{fetch(:wpcli_local_db_backup_dir)} ]")
+            execute :mkdir, Pathname.new(fetch(:wpcli_local_db_backup_dir))
+          end
         end
       end
+
+      desc "Backup the remote database"
+      task :remote do
+        on roles(:web) do
+          within release_path do
+            execute :wp, :db, :export, "- |", :gzip, ">", fetch(:wpcli_remote_db_file)
+            download! fetch(:wpcli_remote_db_file), Pathname.new(fetch(:wpcli_local_db_backup_dir)).join(fetch(:wpcli_local_db_backup_filename))
+            execute :rm, fetch(:wpcli_remote_db_file)
+          end
+        end
+      end
+
+      desc "Backup the local database"
+      task :local do
+        run_locally do
+          set :stage, :local
+          execute :wp, :db, :export, "- |", :gzip, ">", Pathname.new(fetch(:wpcli_local_db_backup_dir)).join(fetch(:wpcli_local_db_backup_filename))
+        end
+      end
+
+      before :push, 'backup:remote' if :wpcli_backup_db
+      before :local, :create_backup_dir
+      before :remote, :create_backup_dir
+
     end
   end
-end
+end

data/lib/capistrano/tasks/wpuploads.rake

@@ -1,9 +1,10 @@
 namespace :load do
   task :defaults do
+
     # These options are passed directly to rsync
     # Append your options, overwriting the defaults may result in malfunction
     # Ex: --recursive --delete --exclude .git*
-    set :wpcli_rsync_options, %w[-avz --rsh=ssh]
+    set :wpcli_rsync_options, "-avz --rsh=ssh --progress"
 
     # Local dir where WP stores the uploads
     # IMPORTANT: Add trailing slash!
@@ -12,15 +13,20 @@ namespace :load do
     # Remote dir where WP stores the uploads
     # IMPORTANT: Add trailing slash!
     set :wpcli_remote_uploads_dir, -> {"#{shared_path.to_s}/web/app/uploads/"}
+
   end
 end
 
 namespace :wpcli do
   namespace :uploads do
     namespace :rsync do
+
       desc "Push local uploads delta to remote machine"
       task :push do
-        roles(:all).each do |role|
+        roles(:web).each do |role|
+          puts role.netssh_options[:port]
+          port = role.netssh_options[:port] || 22
+          set :wpcli_rsync_options, fetch(:wpcli_rsync_options) + (" -e 'ssh -p #{port}'")
           run_locally do
             execute :rsync, fetch(:wpcli_rsync_options), fetch(:wpcli_local_uploads_dir), "#{role.user}@#{role.hostname}:#{fetch(:wpcli_remote_uploads_dir)}"
           end
@@ -29,7 +35,7 @@ namespace :wpcli do
 
       desc "Pull remote uploads delta to local machine"
       task :pull do
-        roles(:all).each do |role|
+        roles(:web).each do |role|
           run_locally do
             execute :rsync, fetch(:wpcli_rsync_options), "#{role.user}@#{role.hostname}:#{fetch(:wpcli_remote_uploads_dir)}", fetch(:wpcli_local_uploads_dir)
           end

data/lib/capistrano/wpcli/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Wpcli
-    VERSION = "0.0.9"
+    VERSION = "0.1.2"
   end
 end

metadata

@@ -1,64 +1,72 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-wpcli
 version: !ruby/object:Gem::Version
-  version: 0.0.9
-  prerelease: 
+  version: 0.1.2
 platform: ruby
 authors:
 - Juancito Arias
+- Jeremy Zahner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-15 00:00:00.000000000 Z
+date: 2015-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: sshkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 1.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 1.7.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.4.0
 description: Capistrano tasks for managing Wordpress
 email:
 - trasgofurioso@gmail.com
@@ -70,7 +78,6 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE
-- LICENSE.txt
 - README.md
 - Rakefile
 - capistrano-wpcli.gemspec
@@ -84,26 +91,25 @@ files:
 homepage: https://github.com/lavmeiker/capistrano-wpcli
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Simple Capistrano wrapper around WP-CLI
 test_files: []

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2014 Juancito Arias
-
-MIT License
-
-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.