capistrano-trellis-bedrock-wpcli 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d70cce220f8b7147408ed6b1736da6d079f184c3
+  data.tar.gz: e49c475596e26202735be2452e9f8b97a6b70734
+SHA512:
+  metadata.gz: 8cdc94d9844ad45ca2f01ac718e4dea2b03def36cc1c467e09d40f369d4cfb30e9050918af72279993f4ea90aa940aef9dccda5672410542081055501b62cd18
+  data.tar.gz: 031fe3ebcfd7c1d497badb9431684ac068d1d8f60a4e3370fbd50dae9fc8588f0daa6586eebdccf8aaf77e360f3ff979518b08c659bc3a29e637ceb6fc1b3999

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capistrano-trellis-bedrock-wpcli.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    capistrano-trellis-bedrock-wpcli (1.0.0)
+      capistrano (~> 3.6.0)
+      sshkit (~> 1.11.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    airbrussh (1.1.0)
+      sshkit (>= 1.6.1, != 1.7.0)
+    capistrano (3.6.0)
+      airbrussh (>= 1.0.0)
+      capistrano-harrow
+      i18n
+      rake (>= 10.0.0)
+      sshkit (>= 1.9.0)
+    capistrano-harrow (0.5.3)
+    i18n (0.7.0)
+    net-scp (1.2.1)
+      net-ssh (>= 2.6.5)
+    net-ssh (3.2.0)
+    rake (11.2.2)
+    sshkit (1.11.2)
+      net-scp (>= 1.1.2)
+      net-ssh (>= 2.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.12.5)
+  capistrano-trellis-bedrock-wpcli!
+  rake (~> 11.2.2)
+
+BUNDLED WITH
+   1.12.5

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ensoul
+
+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.md

@@ -0,0 +1,155 @@
+# 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 database and uploads deploy.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capistrano-wpcli'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-wpcli
+
+## Usage
+
+All you need to do is put the following in `Capfile` file:
+
+    require 'capistrano/wpcli'
+
+### How it works (Tasks)
+
+    cap staging wpcli:db:push
+
+Pushes the local WP database to the remote server and replaces the urls.
+
+Optionally backs up the remote database before pushing (if `wpcli_backup_db` is set to true, see Configuration).
+
+- - -
+
+    cap staging wpcli:db:pull
+
+Pulls the remote server WP database to local and replaces the urls.
+
+- - -
+
+    cap staging 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.
+
+- - -
+
+    cap development 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.
+
+- - -
+
+    cap staging wpcli:uploads:rsync:push
+
+Push local uploads delta to remote machine using rsync.
+
+- - -
+
+    cap staging wpcli:uploads:rsync:pull
+
+Pull remote uploads delta to local machine using rsync.
+
+### Configuration
+
+This plugin needs some configuration to work properly. You can put all your configs in Capistrano stage files i.e. `config/deploy/production.rb`.
+
+Here's the list of options and the defaults for each option:
+
+- - -
+
+    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_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
+
+Absolute path to remote wordpress uploads directory.
+
+Defaults to `#{shared_path.to_s}/web/app/uploads/`
+
+**IMPORTANT: Add trailing slash!**
+
+### FAQ
+
+- 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 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}
+
+    set :dev_path, '/srv/www/example.dev/current'
+
+## Contributing
+
+1. Fork it ( https://github.com/lavmeiker/capistrano-wpcli/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+
+# READ AND APPLY THE ISTRUCTIONS BELOW ONLY IF STAGING AND PRODUCTION ARE ON THE SAME SERVER
+# These parameters need first to be moved into production.rb and staging.rb and then replace #{fetch(:bedrock_folder)} with the name of production and staging bedrock folder
+set :deploy_to, -> { "/srv/www/#{fetch(:bedrock_folder)}" }
+set :wpcli_remote_uploads_dir, -> { "/srv/www/#{fetch(:bedrock_folder)}/current/web/app/uploads/" }

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/capistrano-trellis-bedrock-wpcli.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/wpcli/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-trellis-bedrock-wpcli"
+  spec.version       = Capistrano::Wpcli::VERSION
+  spec.authors       = ["Ensoul"]
+  spec.email         = ["hello@ensoul.it"]
+  spec.summary       = %q{Simple Capistrano wrapper around WP-CLI for Trellis and Bedrock}
+  spec.description   = %q{Provides command line tools to facilitate WordPress uploads and database deploy with Trellis and Bedrock.}
+  spec.homepage      = "https://github.com/itsensoul/capistrano-trellis-bedrock-wpcli"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'capistrano', '~> 3.6.0'
+  spec.add_dependency 'sshkit', '~> 1.11.1'
+
+  spec.add_development_dependency "bundler", "~> 1.12.5"
+  spec.add_development_dependency "rake", "~> 11.2.2"
+
+end

data/lib/capistrano/tasks/wpdb.rake

@@ -0,0 +1,132 @@
+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"
+
+    # The url under which the wordpress installation is
+    # available on the local server
+    set :wpcli_local_url, "http://example.dev"
+
+    # A local temp dir which is read and writeable
+    set :local_tmp_dir, "/tmp"
+
+    # 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 filenames
+    set :wpcli_remote_db_backup_filename, -> {"db_#{fetch(:bedrock_folder)}_#{fetch(:stage)}_#{fetch(:current_time)}.sql.gz"}
+    set :wpcli_local_db_backup_filename, -> {"db_#{fetch(:bedrock_folder)}_development_#{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
+        within current_path do
+          execute :wp, :db, :export, "- |", :gzip, ">", fetch(:wpcli_remote_db_file)
+          download! fetch(:wpcli_remote_db_file), fetch(:wpcli_local_db_file)
+          execute :rm, fetch(:wpcli_remote_db_file)
+        end
+      end
+      on roles(:dev) do
+        within fetch(:dev_path) do
+          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
+      run_locally do
+        execute :rm, fetch(:wpcli_local_db_file)
+      end
+    end
+
+    desc "Push the local database"
+    task :push 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
+      on roles(:web) do
+        upload! fetch(:wpcli_local_db_file), fetch(:wpcli_remote_db_file)
+        within current_path do
+          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
+      on roles(:dev) do
+        within fetch(:dev_path) do
+          execute :rm, fetch(:wpcli_local_db_file)
+        end
+      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
+          unless test("[ -d #{fetch(:wpcli_local_db_backup_dir)} ]")
+            execute :mkdir, Pathname.new(fetch(:wpcli_local_db_backup_dir)).to_s
+          end
+        end
+      end
+
+      desc "Backup the remote database"
+      task :remote do
+        on roles(:web) do
+          within current_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_remote_db_backup_filename)).to_s
+            execute :rm, fetch(:wpcli_remote_db_file)
+          end
+        end
+      end
+
+      desc "Backup the local database"
+      task :local 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), Pathname.new(fetch(:wpcli_local_db_backup_dir)).join(fetch(:wpcli_local_db_backup_filename)).to_s
+          end
+        end
+      end
+
+      before :push, 'backup:remote' if :wpcli_backup_db
+      before :pull, 'backup:local' if :wpcli_backup_db
+      before :local, :create_backup_dir
+      before :remote, :create_backup_dir
+
+    end
+  end
+end

data/lib/capistrano/tasks/wpuploads.rake

@@ -0,0 +1,46 @@
+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, "-aivz --rsh=ssh --progress --stats --delete --exclude=.DS_Store"
+
+    # Local dir where WP stores the uploads
+    # IMPORTANT: Add trailing slash!
+    set :wpcli_local_uploads_dir, "web/app/uploads/"
+
+    # Remote dir where WP stores the uploads
+    # IMPORTANT: Add trailing slash!
+    set :wpcli_remote_uploads_dir, -> {"#{shared_path.to_s}/uploads/"}
+
+  end
+end
+
+namespace :wpcli do
+  namespace :uploads do
+    namespace :rsync do
+
+      desc "Push local uploads delta to remote machine"
+      task :push do
+        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
+        end
+      end
+
+      desc "Pull remote uploads delta to local machine"
+      task :pull do
+        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
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/wpcli.rb

@@ -0,0 +1,5 @@
+# Load all tasks
+files = Dir[File.join(File.dirname(__FILE__), 'tasks', '*.rake')] 
+files.each do |file| 
+  load file
+end

data/lib/capistrano/wpcli/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Wpcli
+    VERSION = "0.0.1"
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-trellis-bedrock-wpcli
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ensoul
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: sshkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.12.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.12.5
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.2.2
+description: Provides command line tools to facilitate WordPress uploads and database
+  deploy with Trellis and Bedrock.
+email:
+- hello@ensoul.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- capistrano-trellis-bedrock-wpcli.gemspec
+- lib/capistrano-trellis-bedrock-wpcli.rb
+- lib/capistrano/tasks/wpdb.rake
+- lib/capistrano/tasks/wpuploads.rake
+- lib/capistrano/wpcli.rb
+- lib/capistrano/wpcli/version.rb
+homepage: https://github.com/itsensoul/capistrano-trellis-bedrock-wpcli
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Simple Capistrano wrapper around WP-CLI for Trellis and Bedrock
+test_files: []