wordpress-capistrano-v2 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8648d9f6d8d10ea9cf46990f1aabec97a7d4921f26076ef6258a0b648dea578d
+  data.tar.gz: cab090340e59d5b595f9e3313fa341f11700c2e4a4865d577db23d019d594fb5
+SHA512:
+  metadata.gz: 1887a9259255ba74461bd977a28472bb18f2c003086437d590fcc903994ed9d6f163e51b8ea4efe5192a0ccf5a45cdbc7c27557f74113f1b7f94a6a8a446ef7d
+  data.tar.gz: 9a5c3d8c9ecd45ff05126baab6ffa7e71d30cbf99dba5d667ca1a43a2f2a6332fb81d1e73c85abf077c591d08d5ca623dcd15f58f296c5ff11b5db90640ddd65

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,27 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    capistrano (3.1.0)
+      i18n
+      rake (>= 10.0.0)
+      sshkit (~> 1.3)
+    capistrano-composer (0.0.3)
+      capistrano (>= 3.0.0.pre)
+    i18n (0.6.9)
+    net-scp (1.1.2)
+      net-ssh (>= 2.6.5)
+    net-ssh (2.8.0)
+    rake (10.1.1)
+    sshkit (1.3.0)
+      net-scp (>= 1.1.2)
+      net-ssh
+      term-ansicolor
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    tins (1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capistrano-composer

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Craig Morris
+
+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,151 @@
+# Capistrano::WordPress
+
+A set of recipes for working with WordPress (via WP CLI) and Capistrano 3.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano', '~> 3.0.0'
+gem 'wordpress-capistrano'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wordpress-capistrano
+
+## Usage
+
+Require the module in your `Capfile`:
+
+```ruby
+require 'capistrano/wordpress'
+```
+
+`wordpress/capistrano` comes with 4 tasks:
+
+* wordpress:db:push - Exports your local database and imports it on remote server
+* wordpress:db:pull - Exports your remote database and imports it on your local
+* wordpress:db:deploy - Uploads the <database name>.sql in your version control and imports in on remote
+* wordpress:uploads:sync - Synchronises your local and remote wp-content/uploads folder so that you have all assets
+* wordpress:uploads:push - Pushes your local wp-content/uploads folder to the remote.
+* wordpress:uploads:pull - Pulls the remote wp-content/uploads folder to your local installation.
+* wordpress:paths - Updates WordPress paths to match latest release folders
+
+You can run any of these by issuing the following commands..
+
+```bash
+$ bundle exec cap production wordpress:db:push
+$ bundle exec cap production wordpress:db:pull
+$ bundle exec cap production wordpress:db:deploy
+$ bundle exec cap production wordpress:uploads:sync
+$ bundle exec cap production wordpress:uploads:pull
+$ bundle exec cap production wordpress:uploads:push
+$ bundle exec cap production wordpress:paths
+```
+
+None of these tasks are built into the default Capistrano deploy as they are potentially damaging.
+
+To add any of them, add the following code into your deploy.rb
+
+```ruby
+after :updated, 'wordpress:db:deploy'
+after :updated, 'wordpress:uploads:sync'
+```
+
+These are useful on sites where all content is under version control
+
+### Other Recommended Settings
+
+This gem does not have libraries to perform common tasks like symlinking wp-content/uploads or symlinking database
+configuration files. Some recommended settings to go along with your deploy.rb are below.
+
+#### Use Composer for WordPress and Plugins
+
+```json
+{
+	"repositories": [
+		{
+			"type": "composer",
+			"url": "http://wpackagist.org"
+		},
+		{
+			"type": "package",
+			"package": {
+				"name": "wordpress",
+				"type": "webroot",
+				"version": "3.8.1",
+				"dist": {
+					"type": "zip",
+					"url": "http://en-au.wordpress.org/wordpress-3.8.1-en_AU.zip"
+				},
+				"require": {
+					"fancyguy/webroot-installer": "1.0.0"
+				}
+			}
+		},
+	],
+	"require": {
+		"php": ">=5.3.0",
+		"wordpress": "3.8.1",
+		"fancyguy/webroot-installer": "1.0.0",
+		"wpackagist/advanced-custom-fields": "*",
+		"wpackagist/codepress-admin-columns": "*",
+		"wpackagist/custom-post-type-ui": "*",
+		"wpackagist/wordpress-importer": "*",
+		"wpackagist/duplicate-post": "*",
+		"wpackagist/simple-page-ordering": "*",
+		"wpackagist/adminimize": "*"
+	},
+	"require-dev": {
+		"wpackagist/debug-bar": "*",
+		"wpackagist/pretty-debug": "*"
+	},
+	"extra": {
+		"webroot-dir": "wp",
+		"webroot-package": "wordpress"
+	}
+}
+```
+
+#### Use Linked Dirs and Linked Files
+
+```ruby
+set :linked_dirs, %w{wp-content/uploads}
+set :linked_files, %w{wp-config.local.php}
+```
+
+
+### Configuration
+
+Configurable options, shown here with defaults:
+
+```ruby
+set :url, 'www.wordpress.org'
+set :local_url, 'localhost'
+set :wp_path, '.'
+set :local_wp_path, '.'
+set :wp_uploads, 'wp-content/uploads'
+set :local_wp_uploads, 'wp-content/uploads'
+set :wp_themes, 'wp-content/themes'
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request
+
+Also, please ask the owner of the capistrano-wordpress gem to give up his name!
+
+## Credits
+
+* https://github.com/herrkris/wordpress-capistrano
+* https://github.com/capistrano/composer

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/capistrano/tasks/wordpress.rake

@@ -0,0 +1,189 @@
+namespace :wordpress do
+
+  namespace :db do
+    desc "Pull the remote database"
+    task :pull do
+
+      on roles(:db) do
+        within release_path do
+          with path: "#{fetch(:path)}:$PATH" do
+            execute :wp, "--path=#{fetch(:wp_path)} db export #{fetch(:tmp_dir)}/database.sql"
+            execute :gzip, "-f #{fetch(:tmp_dir)}/database.sql"
+          end
+        end
+
+        download! "#{fetch(:tmp_dir)}/database.sql.gz", "database.sql.gz"
+
+        run_locally do
+          timestamp = "#{Time.now.year}-#{Time.now.month}-#{Time.now.day}-#{Time.now.hour}-#{Time.now.min}-#{Time.now.sec}"
+
+          execute :wp, "--path=#{fetch(:local_wp_path)} db export #{fetch(:application)}.#{timestamp}.sql" # backup
+
+          execute :gunzip, "-f database.sql.gz"
+          execute :wp, "--path=#{fetch(:local_wp_path)} db import database.sql"
+          execute :wp, "--path=#{fetch(:local_wp_path)} search-replace #{fetch(:url)} #{fetch(:local_url)}"
+
+          execute :rm, "database.sql.gz", raise_on_non_zero_exit: false
+          execute :rm, "database.sql", raise_on_non_zero_exit: false
+
+          execute :wp, "--path=#{fetch(:local_wp_path)}", :option, :delete, :template_root, raise_on_non_zero_exit: false
+          execute :wp, "--path=#{fetch(:local_wp_path)}", :option, :delete, :stylesheet_root, raise_on_non_zero_exit: false
+        end
+
+        execute :rm, "#{fetch(:tmp_dir)}/database.sql", raise_on_non_zero_exit: false
+        execute :rm, "#{fetch(:tmp_dir)}/database.sql.gz", raise_on_non_zero_exit: false
+      end
+
+    end
+
+    # @todo GZIP
+    desc "Push the local database"
+    task :push do
+      on roles(:db) do
+
+        run_locally do
+          execute :wp, "--path=#{fetch(:local_wp_path)} db export database.sql"
+          execute :gzip, "-f database.sql"
+        end
+
+        upload! "database.sql.gz", "#{fetch(:tmp_dir)}/database.sql.gz"
+
+        run_locally do
+          execute :rm, "database.sql", raise_on_non_zero_exit: false
+          execute :rm, "database.sql.gz", raise_on_non_zero_exit: false
+        end
+
+        within release_path do
+          with path: "#{fetch(:path)}:$PATH" do
+            timestamp = "#{Time.now.year}-#{Time.now.month}-#{Time.now.day}-#{Time.now.hour}-#{Time.now.min}-#{Time.now.sec}"
+
+            execute :wp, "--path=#{fetch(:wp_path)} db export #{fetch(:application)}.#{timestamp}.sql" # backup
+
+            execute :gunzip, "-f #{fetch(:tmp_dir)}/database.sql.gz"
+
+            execute :wp, "--path=#{fetch(:wp_path)} db import #{fetch(:tmp_dir)}/database.sql"
+            execute :wp, "--path=#{fetch(:wp_path)} search-replace #{fetch(:local_url)} #{fetch(:url)}"
+
+            execute :rm, "#{fetch(:tmp_dir)}/database.sql", raise_on_non_zero_exit: false
+            execute :rm, "#{fetch(:tmp_dir)}/database.sql.gz", raise_on_non_zero_exit: false
+
+            invoke 'wordpress:paths'
+
+            execute :echo, %{"Database imported at #{timestamp}" >> #{revision_log}}
+          end
+        end
+
+      end
+    end
+
+    # Database name locally must match the :application variable in capistrano
+    # @todo gzip
+    desc "Push the database in version control"
+    task :deploy do
+
+      on roles(:db) do
+
+        upload! "#{fetch(:application)}.sql", "#{fetch(:tmp_dir)}/database.sql"
+
+        within release_path do
+          with path: "#{fetch(:path)}:$PATH" do
+            timestamp = "#{Time.now.year}-#{Time.now.month}-#{Time.now.day}-#{Time.now.hour}-#{Time.now.min}-#{Time.now.sec}"
+            execute :wp, "--path=#{fetch(:wp_path)} db export #{fetch(:application)}.#{timestamp}.sql"
+            execute :wp, "--path=#{fetch(:wp_path)} db import #{fetch(:tmp_dir)}/database.sql"
+            execute :wp, "--path=#{fetch(:wp_path)} search-replace #{fetch(:local_url)} #{fetch(:url)}"
+            execute :rm, "#{fetch(:tmp_dir)}/database.sql"
+            invoke 'wordpress:paths'
+            execute :echo, %{"Database imported at #{timestamp}" >> #{revision_log}}
+          end
+        end
+
+      end
+
+    end
+  end
+
+  namespace :uploads do
+
+    desc "Synchronise local and remote wp-content/uploads folders"
+    task :sync do
+      invoke 'pull'
+      invoke 'push'
+    end
+
+    desc "Pull remote wp-content/uploads folder"
+    task :pull do
+      run_locally do
+        roles(:web).each do |role|
+          puts role.netssh_options[:port]
+          port = role.netssh_options[:port] || 22
+          user = role.user + "@" if !role.user.nil?
+          execute :rsync, "-avz --rsh=ssh --progress -e 'ssh -p #{port}' #{user}#{role.hostname}:#{release_path}/#{fetch(:wp_uploads)}/ #{fetch(:local_wp_uploads)}"
+        end
+      end
+    end
+
+    desc "Push local wp-content folder to remote wp-content/uploads folder"
+    task :push do
+      run_locally do
+        roles(:web).each do |role|
+          puts role.netssh_options[:port]
+          port = role.netssh_options[:port] || 22
+          user = role.user + "@" if !role.user.nil?
+          execute :rsync, "-avz --rsh=ssh --progress -e 'ssh -p #{port}' #{fetch(:local_wp_uploads)}/ #{user}#{role.hostname}:#{release_path}/#{fetch(:wp_uploads)}"
+        end
+      end
+    end
+
+  end
+
+  namespace :content do
+    desc "Synchronise local and remote wp-content/uploads folders"
+    task :sync do
+      invoke 'uploads:sync'
+    end
+  end
+
+  desc "Update WordPress template root paths to point to the new release"
+  task :paths do
+
+    on roles(:db) do
+      within release_path do
+        with path: "#{fetch(:path)}:$PATH" do
+          if test :wp, :core, 'is-installed'
+
+            releases = capture("ls #{File.join(fetch(:deploy_to), 'releases')}")
+            last_release = File.join(releases_path, releases.split("\n").sort.last, fetch(:wp_themes))
+
+            [:stylesheet_root, :template_root].each do |option|
+              # Only change the value if it's an absolute path
+              # i.e. The relative path "/themes" must remain unchanged
+              # Also, the option might not be set, in which case we leave it like that
+              value = capture :wp, :option, :get, option, raise_on_non_zero_exit: false
+              if value != '' && value != '/themes'
+                execute :wp, "--path=#{fetch(:wp_path)}", :option, :set, option, last_release
+              end
+            end
+
+          end
+        end
+      end
+    end
+  end
+
+end
+
+def set_option_path
+
+end
+
+namespace :load do
+  task :defaults do
+    set :url, 'www.wordpress.org'
+    set :local_url, 'localhost'
+    set :wp_path, '.'
+    set :local_wp_path, '.'
+    set :wp_uploads, 'wp-content/uploads'
+    set :local_wp_uploads, 'wp-content/uploads'
+    set :wp_themes, 'wp-content/themes'
+  end
+end

data/lib/capistrano/wordpress.rb

@@ -0,0 +1 @@
+load File.expand_path('../tasks/wordpress.rake', __FILE__)

data/wordpress-capistrano.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'wordpress-capistrano-v2'
+  spec.version       = '1.0.0'
+  spec.authors       = ['Craig Morris', 'Thomas Ferney']
+  spec.email         = ['craig.michael.morris@gmail.com', 'thomas.ferney@gmail.com']
+  spec.description   = %q{Deploy your WordPress projects with Capistrano 3.x}
+  spec.summary       = %q{WordPress support for Capistrano 3.x}
+  spec.homepage      = 'https://github.com/antiseptikk/wordpress-capistrano'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  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.3'
+  spec.add_development_dependency 'rake', '~> 0'
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: wordpress-capistrano-v2
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Craig Morris
+- Thomas Ferney
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Deploy your WordPress projects with Capistrano 3.x
+email:
+- craig.michael.morris@gmail.com
+- thomas.ferney@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/capistrano/tasks/wordpress.rake
+- lib/capistrano/wordpress.rb
+- lib/wordpress-capistrano.rb
+- wordpress-capistrano.gemspec
+homepage: https://github.com/antiseptikk/wordpress-capistrano
+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: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: WordPress support for Capistrano 3.x
+test_files: []