capistrano-trellis-bedrock-wpcli 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d70cce220f8b7147408ed6b1736da6d079f184c3
-  data.tar.gz: e49c475596e26202735be2452e9f8b97a6b70734
+  metadata.gz: fcdb7ccc8f3ccd720a11f8360ef21661f24462a1
+  data.tar.gz: 7470e55cd535edb87230b4f933c9a0d06a84fa7c
 SHA512:
-  metadata.gz: 8cdc94d9844ad45ca2f01ac718e4dea2b03def36cc1c467e09d40f369d4cfb30e9050918af72279993f4ea90aa940aef9dccda5672410542081055501b62cd18
-  data.tar.gz: 031fe3ebcfd7c1d497badb9431684ac068d1d8f60a4e3370fbd50dae9fc8588f0daa6586eebdccf8aaf77e360f3ff979518b08c659bc3a29e637ceb6fc1b3999
+  metadata.gz: 054d30b026b05cf5cefbb478fcbf4f324705689ead397ffeed5de23078c46ec462edf943470f27760beda1da7ff8150fc914fcea5702565d261c53beaafc2c65
+  data.tar.gz: 7ba518d82ab20725301b53dc0e893c2e6a866937b8ec1742ae9192d99b748369dfe718fd06a04299e4ccc90aac28be22425e3483f886b2d9d859cbc31ce635d2

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+### 0.0.2: August 11th, 2016
+* Add CHANGELOG.md
+* Rewrite README.md
+* Improve search and replace removing http:// in favor of only //
+* Add delete transient option after each push and pull on the imported database
+
+### 0.0.1: August 1st, 2016
+* Rename gem from capistrano-wpcli to capistrano-trellis-bedrock-wpcli
+* Update LICENSE.md
+* Add support only for Trellis and Bedrock
+* Remove support for WP-CLI custom commands and WP-CLI rewrite commands
+* Update all dependencies

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    capistrano-trellis-bedrock-wpcli (1.0.0)
+    capistrano-trellis-bedrock-wpcli (0.0.1)
       capistrano (~> 3.6.0)
       sshkit (~> 1.11.1)
 

data/{LICENSE → LICENSE.md}

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

data/README.md

@@ -1,155 +1,97 @@
-# Capistrano::WPCLI
+# Capistrano::WPCLI for Trellis and Bedrock
 
-[![Dependency Status](https://www.versioneye.com/user/projects/561c9bfda193340f2f001728/badge.svg?style=flat)](https://www.versioneye.com/user/projects/561c9bfda193340f2f001728)
+[![Dependency Status](https://www.versioneye.com/user/projects/579f823e72d75c0039f7a28b/badge.svg?style=flat)](https://www.versioneye.com/user/projects/579f823e72d75c0039f7a28b)
 
-**Note: this plugin works only with Capistrano 3.**
+**This project is based on [capistrano-wpcli](https://github.com/lavmeiker/capistrano-wpcli) and works only with Trellis and Bedrock.**
 
-Provides command line tools to facilitate Wordpress database and uploads deploy.
+Provides command line tools to facilitate WordPress database and uploads deploy with Trellis and Bedrock.
 
-## 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)
+## Requirements
 
-    cap staging wpcli:db:push
+* Ruby >= 2.0
 
-Pushes the local WP database to the remote server and replaces the urls.
+Required gems:
 
-Optionally backs up the remote database before pushing (if `wpcli_backup_db` is set to true, see Configuration).
+* `capistrano` (~> 3.6)
+* `sshkit` (~> 1.11)
+* `bundler` (~> 1.12)
+* `rake` (~> 11.2)
 
-- - -
+These can be installed manually with `gem install <gem name>` but it's highly suggested you use [Bundler](http://bundler.io/) to manage them. Bundler is basically the Ruby equivalent to PHP's Composer. Just as Composer manages your PHP packages/dependencies, Bundler manages your Ruby gems/dependencies. Bundler itself is a Gem and can be installed via `gem install bundler` (sudo may be required).
 
-    cap staging wpcli:db:pull
+The `Gemfile` in the root of this repo specifies the required Gems (just like `composer.json`). Once you have Bundler installed, run `bundle install` to install the Gems in the `Gemfile`. When using Bundler, you'll need to prefix the `cap` command with `bundle exec` as seen below (this ensures you're not using system Gems which can cause conflicts).
 
-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.
-
-- - -
+## Installation
 
-    cap staging wpcli:uploads:rsync:pull
+1. Download the latest release of [capistrano-bedrock](https://github.com/itsensoul/capistrano-bedrock/releases/latest).
+2. Copy the following `capistrano-bedrock` files into the root of your Bedrock project:
+  * `Capfile`
+  * `Gemfile`
+  * `Gemfile.lock`
+  * `database.sh`
+  * `uploads.sh`
+3. Copy the content of `capistrano-bedrock .gitignore` file into the `.gitignore` file of your Bedrock project.
+4. Copy the following `capistrano-bedrock` files/folders into your `config` directory:
+  * `config/deploy/*`
+  * `config/deploy.rb`
+5. Run `gem install bundler -v "~>1.12.0" && bundle` into the root of your Bedrock project.
+6. Edit your `config/deploy.rb` configs to set the roles/servers and connection options.
+7. Edit your `config/deploy/*` stage/environment configs to set the specific roles/servers and connection options for each stage/environment.
+8. Enjoy `capistrano-trellis-bedrock-wpcli` [Tasks](#tasksanchor).
 
-Pull remote uploads delta to local machine using rsync.
+## Usage
 
+<a name="configurationanchor"></a>
 ### 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`.
+This plugin needs some configuration to work properly.
 
-Here's the list of options and the defaults for each option:
+Here's the list of available options and the defaults for each option to put in your `config/deploy.rb` file:
 
-- - -
+|Option|Default|Usage|
+|---|---|---|
+|`set :wpcli_local_url`|`//example.dev`|Url of the WordPress root installation on the local server (used by search-replace command).|
+|`set :local_tmp_dir`|`/tmp`|Absolute path to local directory temporary directory which is read and writeable.|
+|`set :wpcli_backup_db`|`false`|Set to true if you would like to create remote database backup on each push and local database backup on each pull.|
+|`set :wpcli_delete_transients`|`true`|Set to false if you wouldn't like to delete transients on each push and pull. Transients will be removed only on the imported database.|
+|`set :wpcli_local_db_backup_dir`|`config/backup`|Absolute or relative path to local directory for storing database backups which is read and writeable. **IMPORTANT: Make sure to add the folder to .gitignore to prevent db backups from being in version control.**|
+|`set :wpcli_local_uploads_dir`|`web/app/uploads/`|Absolute or relative path to local WordPress uploads directory. **IMPORTANT: Add trailing slash!**|
+|`set :wpcli_args`|`ENV['WPCLI_ARGS']`|You can pass arguments directly to WP-CLI using this var.|
+|`set :format_options, log_file:`|`log/capistrano.log`|Capistrano's verbose output is saved to this file to facilitate debugging. Set to `nil` to disable completely. **IMPORTANT: Make sure to add the folder to .gitignore to prevent Capistrano logs from being in version control.**|
 
-    set :wpcli_remote_url
+<br/>
+Here's the list of available options and the defaults for each option to put in your `config/deploy/staging.rb` or `config/deploy/production.rb` file:
 
-Url of the WP root installation on the remote server (used by search-replace command).
+|Option|Default|Usage|
+|---|---|---|
+|`set :wpcli_remote_url`|`//example.com`|Url of the WordPress root installation on the remote server (used by search-replace command).|
+|`set :wpcli_remote_uploads_dir`|`#{shared_path.to_s}/uploads/`|Absolute path to remote WordPress uploads directory. If this option is the same for staging and production, you can put this option in your `config/deploy.rb` file **IMPORTANT: Add trailing slash!**|
 
-- - -
+**Note: if you are using Trellis with staging and production on same server you probably need to modify this standard configuration.**
 
-    set :wpcli_local_url
+<a name="tasksanchor"></a>
+### Tasks
 
-Url of the WP root installation on the local server (used by search-replace command).
+####1. Manage database
 
-- - -
+* `bundle exec cap staging/production wpcli:db:push` - Pushes the local WordPress database to the remote server and replaces the urls (Optionally backs up the remote database before pushing, only if `wpcli_backup_db` is set to true, see [Configuration](#configurationanchor))
 
-    set :local_tmp_dir
+* `bundle exec cap staging/production wpcli:db:pull` - Pulls the remote server WordPress database to local and replaces the urls (Optionally backs up the local database before pulling, only if `wpcli_backup_db` is set to true, see [Configuration](#configurationanchor))
 
-Absolute path to local directory temporary directory which is read and writeable.
+* `bundle exec cap staging/production wpcli:db:backup:remote` - Backs up remote staging/production database (uses `wpcli_local_db_backup_dir` to define the location of the export)
 
-Defaults to `/tmp`
+* `bundle exec cap development wpcli:db:backup:local` - Backs up local vagrant database (uses `wpcli_local_db_backup_dir` to define the location of the export)
 
-- - -
+####2. Manage updates
 
-    set :wpcli_backup_db
+* `bundle exec cap staging wpcli:uploads:rsync:push` - Pushes the local uploads delta to remote machine using rsync.
 
-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'
+* `bundle exec cap staging wpcli:uploads:rsync:pull` - Pulls the remote uploads delta to local machine using rsync.
 
 ## Contributing
 
-1. Fork it ( https://github.com/lavmeiker/capistrano-wpcli/fork )
+1. Fork it (https://github.com/itsensoul/capistrano-trellis-bedrock-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/capistrano-trellis-bedrock-wpcli.gemspec

@@ -18,10 +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.6.0'
-  spec.add_dependency 'sshkit', '~> 1.11.1'
+  spec.add_dependency 'capistrano', '~> 3.6'
+  spec.add_dependency 'sshkit', '~> 1.11'
 
-  spec.add_development_dependency "bundler", "~> 1.12.5"
-  spec.add_development_dependency "rake", "~> 11.2.2"
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 11.2"
 
 end

data/lib/capistrano/tasks/wpdb.rake

@@ -4,11 +4,11 @@ namespace :load do
 
     # The url under which the wordpress installation is
     # available on the remote server
-    set :wpcli_remote_url, "http://example.com"
+    set :wpcli_remote_url, "//example.com"
 
     # The url under which the wordpress installation is
     # available on the local server
-    set :wpcli_local_url, "http://example.dev"
+    set :wpcli_local_url, "//example.dev"
 
     # A local temp dir which is read and writeable
     set :local_tmp_dir, "/tmp"
@@ -16,9 +16,12 @@ namespace :load do
     # 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
+    # Boolean to determine whether the database should be backed up or not
     set :wpcli_backup_db, false
 
+    # Boolean to determine whether the transients should be deleted
+    set :wpcli_delete_transients, true
+
     # 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"
 
@@ -54,7 +57,8 @@ namespace :wpcli do
           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)
+          execute :wp, "search-replace", fetch(:wpcli_remote_url), fetch(:wpcli_local_url), fetch(:wpcli_args) || "--all-tables", "--url=" + fetch(:wpcli_remote_url)
+          if fetch(:wpcli_delete_transients) then execute :wp, "transient", "delete-all" end
         end
       end
       run_locally do
@@ -77,7 +81,8 @@ namespace :wpcli do
           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)
+          execute :wp, "search-replace", fetch(:wpcli_local_url), fetch(:wpcli_remote_url), fetch(:wpcli_args) || "--all-tables", "--url=" + fetch(:wpcli_local_url)
+          if fetch(:wpcli_delete_transients) then execute :wp, "transient", "delete-all" end
         end
       end
       on roles(:dev) do

data/lib/capistrano/wpcli/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-trellis-bedrock-wpcli
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ensoul
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-01 00:00:00.000000000 Z
+date: 2016-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -16,56 +16,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: '3.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: sshkit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.11.1
+        version: '1.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.11.1
+        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.5
+        version: '1.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.5
+        version: '1.12'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 11.2.2
+        version: '11.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 11.2.2
+        version: '11.2'
 description: Provides command line tools to facilitate WordPress uploads and database
   deploy with Trellis and Bedrock.
 email:
@@ -75,9 +75,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
-- LICENSE
+- LICENSE.md
 - README.md
 - Rakefile
 - capistrano-trellis-bedrock-wpcli.gemspec