capistrano-wpcli 0.0.1

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-wpcli.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    capistrano-wpcli (0.0.1)
+      capistrano (>= 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    capistrano (3.2.1)
+      i18n
+      rake (>= 10.0.0)
+      sshkit (~> 1.3)
+    colorize (0.7.3)
+    i18n (0.6.9)
+    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-scp (>= 1.1.2)
+      net-ssh (>= 2.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  capistrano-wpcli!
+  rake

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 lavmeiker
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+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.

data/README.md

@@ -0,0 +1,65 @@
+# Capistrano::WPCLI
+
+**Note: this plugin works only with Capistrano 3.**
+
+Simple Capistrano wrapper using WP-CLI
+
+## 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
+
+The following tasks are added to Capistrano:
+
+* `wpcli:run`<br/>
+Executes the WP-CLI command passed as parameter.
+* `wpcli:db:push`<br/>
+Pushes the local WP database to the remote server and replaces the urls.
+* `wpcli:db:pull`<br/>
+Pulls the remote server WP database to local and replaces the urls.
+
+### Configuration
+
+This plugin needs some configuration to work properly. It will try to load these configuration from the env vars. To do so all you need to do is put the following in `.env` file:
+
+	WP_APP_NAME=example
+	WP_HOME=http://example.dev
+	WP_REMOTE_URL=http://example.com
+
+Alternatively, 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 :application`<br/>
+Name of the application.
+
+* `set :remote_url`<br/>
+Url of the Wordpress root installation on the remote server (used by search-replace command).
+
+* `set :local_url`<br/>
+Url of the Wordpress root installation on the local server (used by search-replace command).
+
+## 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

data/Rakefile

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

data/capistrano-wpcli.gemspec

@@ -0,0 +1,25 @@
+# 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-wpcli"
+  spec.version       = Capistrano::Wpcli::VERSION
+  spec.authors       = ["Juancito Arias"]
+  spec.email         = ["trasgofurioso@gmail.com"]
+  spec.summary       = %q{Simple Capistrano wrapper around WP-CLI}
+  spec.description   = %q{Capistrano tasks for managing Wordpress}
+  spec.homepage      = "https://github.com/lavmeiker/capistrano-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.0'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/lib/capistrano/tasks/wpcli.rake

@@ -0,0 +1,17 @@
+namespace :load do
+  task :defaults do
+    set :wp_roles, :all
+  end
+end
+
+namespace :wpcli do
+  desc "Runs a WP-CLI command"
+  task :run, :command do |t, args|
+    args.with_defaults(:command => :help)
+    on release_roles(fetch(:wp_roles)) do
+      within release_path do
+        execute :wp, args[:command], *args.extras
+      end
+    end
+  end
+end

data/lib/capistrano/tasks/wpdb.rake

@@ -0,0 +1,69 @@
+namespace :load do
+  task :defaults do
+    set :application,  ENV["WP_APP_NAME"]
+    # A temp dir which is read and writeable by the capistrano
+    # deploy user
+    set :remote_tmp_dir, ENV["WP_REMOTE_TMP"] || "/tmp"
+
+    # A local temp dir which is read and writeable
+    set :local_tmp_dir, ENV["WP_LOCAL_TMP"] || "/tmp"
+
+    # The url under which the wordpress installation is
+    # available on the remote server
+    set :remote_url, ENV["WP_REMOTE_URL"]
+
+    # The url under which the wordpress installation is
+    # available on the local server
+    set :local_url, ENV["WP_HOME"]
+    
+    # Shortcuts
+    set :remote_db_file, "#{fetch(:remote_tmp_dir)}/#{fetch(:application)}_database.sql"
+    set :local_db_file, "#{fetch(:local_tmp_dir)}/#{fetch(:application)}_database.sql"
+  end
+end
+
+namespace :wpcli do
+  namespace :db do
+    desc "Pull the remote database"
+    task :pull do
+      on roles(:web) do
+        within release_path do
+          with path: "#{fetch(:path)}:$PATH" do
+            execute :wp, "db export",  fetch(:remote_db_file)
+            download! fetch(:remote_db_file), fetch(:local_db_file)
+            execute :rm, fetch(:remote_db_file)
+          end
+        end
+
+        run_locally do
+          execute :wp, "db import", fetch(:local_db_file)
+          execute :rm, "#{fetch(:local_db_file)}"
+          execute :wp, "search-replace", "'#{fetch(:remote_url)}' '#{fetch(:local_url)}' --skip-columns=guid"
+        end
+      end
+    end
+
+    desc "Push the local database"
+    task :push do
+      on roles(:web) do
+        run_locally do
+          execute :wp, "db export", fetch(:local_db_file)
+        end
+
+        upload! fetch(:local_db_file), fetch(:remote_db_file)
+
+        run_locally do
+          execute :rm, fetch(:local_db_file)
+        end
+
+        within release_path do
+          with path: "#{fetch(:path)}:$PATH" do
+            execute :wp, "db import", fetch(:remote_db_file)
+            execute :rm, fetch(:remote_db_file)
+            execute :wp, "search-replace", "'#{fetch(:local_url)}' '#{fetch(:remote_url)}' --skip-columns=guid"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/wpcli.rb

@@ -0,0 +1,6 @@
+# Load configuration from .env
+require "dotenv"
+Dotenv.load
+
+load File.expand_path("../tasks/wpcli.rake", __FILE__)
+load File.expand_path("../tasks/wpdb.rake", __FILE__)

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-wpcli
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Juancito Arias
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-04 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Capistrano tasks for managing Wordpress
+email:
+- trasgofurioso@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-wpcli.gemspec
+- lib/capistrano-wpcli.rb
+- lib/capistrano/tasks/wpcli.rake
+- lib/capistrano/tasks/wpdb.rake
+- lib/capistrano/wpcli.rb
+- lib/capistrano/wpcli/version.rb
+homepage: https://github.com/lavmeiker/capistrano-wpcli
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2580052462737984893
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2580052462737984893
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Simple Capistrano wrapper around WP-CLI
+test_files: []