capistrano-cul 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93214bb1fa3f153183f924a74216fc89974c091b
-  data.tar.gz: 914740fa3ffadf58b9127f1ed085a70cbab364d0
+  metadata.gz: dca3bc890ad9faa20306aaed7454ad9d2ddb1db6
+  data.tar.gz: 5963b8b24d7f7c4b50dd62f96ba2f3d6d9e7a0a3
 SHA512:
-  metadata.gz: 0da3180a64afe3b5344d6e439ccee76133a75b0223c4d3d41dd91f15e7878184453654b95ce3c3057390929bd8d8ea355140f005d5f6f5a539bef069abbaf87f
-  data.tar.gz: e3a159f3db8871fc1aeef9720bc03b38211eb92362c7f87e48e77f3125cd97fdd16a91bdc1ed2d0988753593fd5dd0070daa39f6bf0d4cfaead559267903f2b4
+  metadata.gz: f3bd0ddad0c8c40937d698fdd1f9083de018653b1774626f72980d565269dd988799f751da06655987cff80ecaeab64044e4d1fc9cbc7eb60c09652488464dad
+  data.tar.gz: b5ec2011f7e9551442968a852e78949a36f8c6a9309cebec824ed8052eea445cb590af7e54858b28d259044f01a8217ed114c3d8eaf83fd02b8713f290cb1f4b

data/CHANGELOG.md

@@ -4,9 +4,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+
+
 ## [Unreleased]
+### Added
+
+## [0.0.2] - 2017-08-08
+### Added
+- Adding Wordpress deployment capabilities
 
 ## [0.0.1] - 2017-08-05
 ### Added
-- Added cul:downtime task
-- Added cul:auto_tag task
+- Added `cul:downtime` task
+- Added `cul:auto_tag` task

data/README.md

@@ -2,15 +2,18 @@
 
 Capistrano v3 tasks shared across CUL projects.
 
+This gem provides common cap tasks that are used in almost every cul project. It also includes a set of cap tasks and hooks that are specific for Wordpress deployments. Do not include the Wordpress library if you are not deploying a Wordpress site.
+
 ## Installation
 
+### Install gem
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'capistrano-cul', git: 'https://github.com/cul/capistrano-cul'
+gem 'capistrano-cul'
 ```
 
-_Note:_ If installing in a rails application, should only be in `:development` and `:test` groups.
+_Note:_ If installing in a rails application, gem should only be installed in `:development` and `:test` groups.
 
 
 And then execute:
@@ -21,14 +24,21 @@ Or install it yourself as:
 
     $ gem install capistrano-cul
 
+### Add Capistrano::Cul tasks to `Capfile`
 In your application's `Capfile` include:
 
+```ruby
+require 'capistrano/cul'
 ```
+
+For Wordpress deployments, in your application's `Capfile` include:
+```ruby
 require 'capistrano/cul'
+require 'capistrano/cul/wp'
 ```
 
 ## Usage
-Two tasks are provided as part of this gem:
+### Shared cap tasks (`capistrano/cul`)
 1. `cap {env} cul:auto_tag`
 
    Tags the current commit as the version number provided in `VERSION`.
@@ -36,6 +46,59 @@ Two tasks are provided as part of this gem:
 
    Pulls down the downtime branch of the repository to a `/downtime` directory and symlinks `current` to `downtime`. To undo this action, redeploy your application.
 
+### Wordpress deployment (`capistrano/cul/wp`)
+#### Tasks
+1. `cap {env} cul:wp:setup`
+
+   Sets up a WordPress docroot and runs deployment; does not install WordPress and does not create any users.
+2. `cap {env} cul:wp:install`
+
+   Runs a WordPress installation for a newly set up instance and creates a new admin user.
+3. `cap {env} cul:wp:symlink_custom_plugins_and_themes`
+
+   Creates symlinks for custom plugins and themes as part of a WordPress deployment. Generally run as an `after :deploy` hook.
+4. `cap {env} cul:wp:update:core`
+
+   Updates WordPress core to the latest version.
+5. `cap {env} cul:wp:update:plugins`
+
+   Updates non-repo-managed plugins to the latest version.
+6. `cap {env} cul:wp:update:themes`
+
+   Updates non-repo-managed themes to the latest version.
+7. `cap {env} cul:wp:update:all`
+
+   Updates WordPress core, plugins, and themes (in that order) by calling update:core, update:plugins and update:themes tasks.
+
+#### Configurable variables
+The Wordpress tasks listed above require the following variables .
+```ruby
+set :wp_docroot # (string) Path to webserver document root for site
+set :wp_data_path # (string) Path to data directory (outside of wp_docroot) that contains wp-content
+set :url # (string) Public website URL
+set :title # (string) Website title
+set :multisite # (boolean) Whether or not this is a multisite wordpress installation
+set :wp_custom_plugins # (hash) Map of custom plugin file/directory names to repo-relative paths
+set :wp_custom_themes # (hash) Map of custom theme file/directory names to repo-relative paths
+```
+
+Here's a sample configuration:
+
+```ruby
+set :wp_docroot, "#{fetch(:deploy_to)}/wp_docroot"
+set :wp_data_path, "/path/to/data/directory/#{fetch(:application)}_#{fetch(:stage)}"
+set :multisite, false
+set :title, 'Amazing WordPress Site'
+
+set :wp_custom_plugins, {
+  'custom-plugin-file.php' => 'plugins/custom-plugin-file.php',
+  'custom-plugin-directory' => 'plugins/custom-plugin-directory'
+}
+set :wp_custom_themes, {
+  'mytheme' => 'themes/mytheme'
+}
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -1,5 +1,4 @@
 require "bundler/gem_tasks"
-require "rspec/core/rake_task"
 
 # Do nothing by default
 task :default

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/capistrano/cul/wp.rb

@@ -0,0 +1,2 @@
+load File.expand_path('../../tasks/wp.cap', __FILE__)
+load File.expand_path('../../tasks/wp/update.cap', __FILE__)

data/lib/capistrano/cul.rb

@@ -1,2 +1 @@
 require_relative 'cul/tasks'
-require_relative 'cul/hooks'

data/lib/capistrano/tasks/wp/update.cap

@@ -0,0 +1,39 @@
+namespace :cul do
+  namespace :wp do
+    namespace :update do
+      desc "Updates WordPress core to the latest version."
+      task :core do
+        on roles(:web) do
+          within fetch(:wp_docroot) do
+            execute :wp, 'core', 'update'
+          end
+        end
+      end
+
+      desc "Updates non-repo-managed plugins to the latest version."
+      task :plugins do
+        on roles(:web) do
+          within fetch(:wp_docroot) do
+            execute :wp, 'plugin', 'update', '--all'
+          end
+        end
+      end
+
+      desc "Updates non-repo-managed themes to the latest version."
+      task :themes do
+        on roles(:web) do
+          within fetch(:wp_docroot) do
+            execute :wp, 'theme', 'update', '--all'
+          end
+        end
+      end
+
+      desc "Updates WordPress core, plugins, and themes (in that order)."
+      task :all do
+        invoke 'cul:wp:update:core'
+        invoke 'cul:wp:update:plugins'
+        invoke 'cul:wp:update:themes'
+      end
+    end
+  end
+end

data/lib/capistrano/tasks/wp.cap

@@ -0,0 +1,137 @@
+namespace :cul do
+  namespace :wp do
+    after :deploy, 'cul:wp:symlink_custom_plugins_and_themes'
+
+    desc "Creates symlinks for custom plugins and themes as part of a WordPress deployment. Generally run as an `after :deploy` hook."
+    task :symlink_custom_plugins_and_themes do
+      symlink_custom_plugins_and_themes
+    end
+
+    # Runs normal deploy task, downloads new copy of WP, sets up docroot, runs
+    # deploy command, sets up symlinks. Does not run WP install and does not
+    # create any wp users.
+    desc "Sets up a WordPress docroot and runs deployment; does not install wordpress and does not create any users"
+    task :setup do
+      puts "Deploying repo branch: #{fetch(:branch)}"
+
+      set :wp_version, ask('WordPress version to download:', 'latest')
+      # Printing out wp_version here because the `set` command above only runs
+      # the first time its associated symbol is referenced, and we want to
+      # capture version before running any other commands.
+      puts "Setting up wp_version: #{fetch(:wp_version)}"
+
+      require_cap_params!([:branch, :wp_version, :wp_docroot, :wp_data_path])
+
+      on roles(:web) do
+        wp_docroot_wp_config_file_path = File.join(fetch(:wp_docroot), 'wp-config.php')
+        wp_docroot_robots_txt_file_path = File.join(fetch(:wp_docroot), 'robots.txt')
+        wp_docroot_wp_content_path = File.join(fetch(:wp_docroot), 'wp-content')
+
+        shared_wp_config_file_path = shared_path.join('wp-config.php')
+        shared_robots_txt_file_path = shared_path.join('robots.txt')
+
+        wp_data_wp_content_path = File.join(fetch(:wp_data_path), 'wp-content')
+
+        invoke 'deploy' # Deploy before doing setup
+
+        # Create nginx logs directory if it doesn't already exist
+        execute :mkdir, '-p', deploy_path.join('logs')
+
+        # Make full path to wp_docroot directory if not exist
+        execute :mkdir, '-p', fetch(:wp_docroot)
+
+        # Make full path to wp_data_path if not exist
+        execute :mkdir, '-p', fetch(:wp_data_path)
+
+        # If wp_docroot/wp-includes does not exist, do wordpress download
+        unless test("[ -d #{File.join(fetch(:wp_docroot), 'wp-includes')} ]")
+          # Download and unpack new WP instance to wp_docroot
+          execute :wp, 'core', ['download', "--version=#{fetch(:wp_version)}", "--path=#{fetch(:wp_docroot)}"]
+        end
+
+        # Check for wp-config.php file in shared. Create if it doesn't exist.
+        unless test("[ -f #{shared_wp_config_file_path} ]")
+          # If no wp-config.php file is found in the 'shared' directory, copy WordPress built-in wp-config-sample.php to there
+          execute :cp, File.join(fetch(:wp_docroot), 'wp-config-sample.php'), shared_wp_config_file_path
+        end
+
+        # Delete original wp-sample-config.php
+        execute :rm, '-f', File.join(fetch(:wp_docroot), 'wp-config-sample.php')
+        # Create symlink for wp_document_root wp-config.php to 'shared' version.
+        execute :ln, '-sf', shared_wp_config_file_path, wp_docroot_wp_config_file_path
+
+        # Check for robots.txt file in shared. Create if it doesn't exist.
+        unless test("[ -f #{shared_robots_txt_file_path} ]")
+          execute "echo -e \"User-agent: *\nDisallow: /\" > #{shared_robots_txt_file_path}"
+        end
+        # Create symlink for wp_document_root robots.txt to 'shared' version.
+        execute :ln, '-sf', shared_robots_txt_file_path, wp_docroot_robots_txt_file_path
+
+        # Check for wp-content directory at wp_data_wp_content_path. Create if it doesn't exist.
+        unless test("[ -d #{wp_data_wp_content_path} ]")
+          # If no wp-config.php file is found in the 'shared' directory, copy WordPress built-in wp-config-sample.php to there
+          execute :cp, '-r', wp_docroot_wp_content_path, wp_data_wp_content_path
+        end
+        # Delete original wp-content directory
+        execute :rm, '-rf', wp_docroot_wp_content_path
+        # Create symlink for wp_document_root wp-content to wp_data_wp_content_path
+        execute :ln, '-sf', wp_data_wp_content_path, wp_docroot_wp_content_path
+      end
+
+      symlink_custom_plugins_and_themes
+    end
+
+    desc "Runs a WordPress installation for a newly set up instance and creates a new admin user"
+    task :install do
+      puts "Please provide administrative credentials:"
+      ask(:admin_user, "Admin username:")
+      ask(:admin_password, "Admin password:")
+      ask(:admin_email, "Admin email:")
+
+      require_cap_params!([:url, :title, :admin_user, :admin_password, :admin_email])
+
+      on roles(:web) do
+        within fetch(:wp_docroot) do
+          execute :wp, 'core', fetch(:multisite) ? 'multisite-install' : 'install',
+            "--url='#{fetch(:url)}'",
+            "--title='#{fetch(:title)}'",
+            "--admin_user='#{fetch(:admin_user)}'",
+            "--admin_password='#{fetch(:admin_password)}'",
+            "--admin_email='#{fetch(:admin_email)}'"
+        end
+      end
+    end
+
+    def self.require_cap_params!(vars)
+      validate vars do |key, value|
+        if value.nil? || value.empty?
+          raise Capistrano::ValidationError, "Missing required parameter #{key}"
+        end
+      end
+    end
+
+    def self.symlink_custom_plugins_and_themes
+      on roles(:web) do
+        wp_data_wp_content_path = File.join(fetch(:wp_data_path), 'wp-content')
+        wp_data_plugin_path = File.join(wp_data_wp_content_path, 'plugins')
+        wp_data_themes_path = File.join(wp_data_wp_content_path, 'themes')
+
+        if test("[ -d #{wp_data_wp_content_path} ]")
+          # Remove old symlinks
+          [wp_data_plugin_path, wp_data_themes_path].each do |dir|
+            execute :find, dir, '-maxdepth 1', '-type l', '-exec rm {} \;'
+          end
+
+          # Add latest symlinks
+          fetch(:wp_custom_plugins, {}).each do |plugin, repo_relative_path|
+            execute :ln, '-sf', File.join(current_path, repo_relative_path), File.join(wp_data_plugin_path, plugin)
+          end
+
+          fetch(:wp_custom_themes, {}).each do |theme, repo_relative_path|
+            execute :ln, '-sf', File.join(current_path, repo_relative_path), File.join(wp_data_themes_path, theme)
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-cul
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Carla Galarza
@@ -55,10 +55,11 @@ files:
 - VERSION
 - capistrano-cul.gemspec
 - lib/capistrano/cul.rb
-- lib/capistrano/cul/hooks.rb
 - lib/capistrano/cul/tasks.rb
+- lib/capistrano/cul/wp.rb
 - lib/capistrano/tasks/cul.cap
-- lib/capistrano/tasks/hooks.cap
+- lib/capistrano/tasks/wp.cap
+- lib/capistrano/tasks/wp/update.cap
 homepage: https://github.com/cul/capistrano-cul
 licenses:
 - MIT
@@ -79,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Common capistrano tasks shared across projects at CUL

data/lib/capistrano/cul/hooks.rb

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