capistrano-olympus 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 52be08cd696c54e3994b29010f39cda0c1b21345
-  data.tar.gz: 77376b0a802a5ef89819d2401c36c22af271024d
+  metadata.gz: f093dae2e6d03e1a095e09ce92ba2a379e7e3358
+  data.tar.gz: 52f18e839fe0dbdbe8090f9f0b7d4a827a3eb336
 SHA512:
-  metadata.gz: c0bf9ee13d133aaef373cadb3813d8b01f9e1298c9b69c002d7596faf30fd23b4bc034881b6ca4cb44f6b269ca1fe061e6edb65e1fcaed39a953e275d6d6a1c3
-  data.tar.gz: 15d5f2e4345f477d11d55558f020f69623e18f186ce0eb81e473624e2fb5a449b0ce0f445de9a47f0ead12f292ac72c3e141a813a91065eda380b6fc8210ed17
+  metadata.gz: c10cb591964cc732f2ba1013c4e42d5847ec0c2894eb4022536865d6c61ef75411abcc029574cd2f4d2ce324bd6e686a4778121b24452d2f05146df81f169669
+  data.tar.gz: 9f6737c7e12fdd434d35a3f7ce6ba46ab8618d8e8bed777602e7d690606618623171cb9f752f4b0cb9e24142f1d03b2ca54ac1cd172d77c14519a53a568ce9c9

data/README.md

@@ -1,54 +1,56 @@
 # Capistrano Olympus [![RubyGem version](https://img.shields.io/gem/v/capistrano-olympus.svg?style=flat-square)](https://rubygems.org/gems/capistrano-olympus)  
 
 _**Capistrano Olympus** is a Ruby gem which provides a complete solution for deploying **WordPress** website easily.  
-Build with ♥ for **WordPress developers**._  
+An awesome gem build with ♥ for **WordPress developers**._  
+![Capistrano 3](https://img.shields.io/badge/Capistrano-3-52C1DB.svg?style=flat-square)  
 
 ---
 
-[![Total Downloads](https://img.shields.io/packagist/dt/crewstyle/capistrano-olympus.svg?style=flat-square)](https://packagist.org/packages/crewstyle/capistrano-olympus) 
-[![GitHub version](https://img.shields.io/github/tag/crewstyle/capistrano-olympus.svg?style=flat-square)](https://github.com/crewstyle/capistrano-olympus) 
-![For Olympus](https://img.shields.io/badge/for-Olympus-75cd45.svg?style=flat-square) 
-![For WordPress](https://img.shields.io/badge/for-WordPress-00aadc.svg?style=flat-square) - 
-![Capistrano 3](https://img.shields.io/badge/Capistrano-3-52C1DB.svg?style=flat-square)  
+## Features
+
++ Remote server automation tool with [**Capistrano**](http://capistranorb.com/)
++ Best gem dependencies with `capistrano-file-permissions` and `colorize`
++ Database update and [**wp-cli**](https://wp-cli.org/) integration
++ Tasks ready for **pagespeed**, **web servers** and **varnish**
 
 ---
 
-**Capistrano Olympus** works especially with the [**Olympus framework**](https://github.com/crewstyle/Olympus) and [**Capistrano 3**](http://capistranorb.com/).  
-It depends on the following Capistrano tasks to deploy a WordPress application:
+## Requirements
 
-+ capistrano-composer: https://github.com/capistrano/composer
-+ composer: https://github.com/fazibear/colorize
-+ sshkit-sudo: https://github.com/kentaroi/sshkit-sudo
++ [**composer**](https://github.com/capistrano/composer)
++ [**colorize**](https://github.com/fazibear/colorize)
++ [**file-permissions**](https://github.com/capistrano/file-permissions)
 
 ---
 
-### Installation
+## Installation
 
-Require `capistrano-olympus` in your gem file:
+You can easily install the **Capistrano Olympus** gem simply:
 
 ```
-# Gemfile
+# In your Gemfile
 gem 'capistrano',  '~> 3.4'
-gem 'capistrano-olympus', '~> 0.0.6'
+gem 'capistrano-olympus', '~> 0.0.8'
 ```
 
-### Usage
-
-Require `capistrano-olympus` in your cap file:
-
 ```
-# Capfile
+# In your Capfile
 require 'capistrano/olympus'
 ```
 
 ---
 
-### Settings
+## Settings
 
 All default settings are defined in the `lib/capistrano/vars/defaults.rb` file. Please, refer to it to see exactly how the defaults are set up.  
 If you want to override any setting, just set it on your `app/deploy/config.rb` file.
 
 ```ruby
+# [optional] Setup files and dirs to symlink, setup web user to chown
+set :files, fetch(:files, ['app/config/env.php', 'app/config/salt.php', 'web/.htaccess', 'web/robots.txt'])
+set :dirs, fetch(:dirs, ['web/statics/languages', 'web/statics/plugins', 'web/statics/uploads'])
+set :stage_user, fetch(:stage_user, 'www-data')
+
 # Setup Capistrano
 set :log_level, fetch(:log_level, :debug)
 set :keep_releases, fetch(:keep_releases, 3)
@@ -60,7 +62,7 @@ set :localurl, fetch(:localurl, 'http://www.domain.tld')
 
 ---
 
-### Deployment
+## Deployment process
 
 Depending on your stage files, you can deploy simply thanks to the following command line:
 
@@ -70,14 +72,21 @@ bundle exec cap production deploy
 
 ---
 
-### All we need is looooooooooooove :)
+## Documentation
+
+[To learn more about the **Olympus WordPress framework**, read the docs](https://olympus.readme.io/).  
+The **Olympus WordPress framework** uses [ReadMe.io](https://readme.io) which was built entirely on Open Source projects.
+
+---
+
+## All we need is looooooooooooove :)
 
 [![Salt Bountysource page](https://img.shields.io/badge/Salt%20Bountysource-♥-brightgreen.svg?style=flat-square)](https://salt.bountysource.com/teams/olympus) [![Bountysource page](https://img.shields.io/badge/Bountysource-♥-brightgreen.svg?style=flat-square)](https://www.bountysource.com/teams/olympus)  
 Guys, do **not** hesitate to spread your love about the **Olympus WordPress framework** and **all its packages** ;)
 
 ---
 
-### Authors and Copyright
+## Authors and Copyright
 
 **Achraf Chouk**
 
@@ -85,7 +94,7 @@ Guys, do **not** hesitate to spread your love about the **Olympus WordPress fram
 + http://twitter.com/crewstyle
 + http://github.com/crewstyle
 
-Please, read [LICENSE](https://github.com/crewstyle/capistrano-olympus/blob/master/LICENSE "LICENSE") for more details.  
+Please, read [LICENSE](https://github.com/GetOlympus/capistrano-olympus/blob/master/LICENSE "LICENSE") for more details.  
 [![MIT](https://img.shields.io/badge/license-MIT_License-blue.svg?style=flat-square)](http://opensource.org/licenses/MIT "MIT")  
 
 ---

data/capistrano-olympus.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |gem|
   gem.name          = 'capistrano-olympus'
-  gem.version       = '0.0.7'
+  gem.version       = '0.0.8'
   gem.date          = Time.now.strftime("%Y-%m-%d")
   gem.authors       = ['Achraf Chouk']
   gem.email         = ['achrafchouk@gmail.com']
@@ -14,7 +14,7 @@ Gem::Specification.new do |gem|
   gem.license       = 'MIT'
 
   gem.files         = [
-    'CHANGELOG',
+    'CHANGELOG.md',
     'LICENSE',
     'README.md',
     'capistrano-olympus.gemspec',
@@ -24,11 +24,6 @@ Gem::Specification.new do |gem|
     'lib/capistrano/tasks/database.rake',
     'lib/capistrano/tasks/directories.rake',
     'lib/capistrano/tasks/files.rake',
-    'lib/capistrano/tasks/pagespeed.rake',
-    'lib/capistrano/tasks/php.rake',
-    'lib/capistrano/tasks/redis.rake',
-    'lib/capistrano/tasks/server.rake',
-    'lib/capistrano/tasks/varnish.rake',
     'lib/capistrano/vars/defaults.rb',
   ]
   gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
@@ -41,4 +36,5 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'capistrano', '~> 3.4'
   gem.add_dependency 'capistrano-composer', '~> 0.0.3'
   gem.add_dependency 'colorize', '~> 0.7.7'
+  gem.add_runtime_dependency 'capistrano-file-permissions', '~> 1.0', '>= 1.0.0'
 end

data/lib/capistrano/olympus.rb

@@ -1,4 +1,5 @@
-require "capistrano/composer"
+require 'capistrano/composer'
+require 'capistrano/file-permissions'
 require 'colorize'
 
 # Core tasks for deploying Olympus framework with WordPress and composer
@@ -6,11 +7,6 @@ load File.expand_path("../tasks/capistrano-deploy.rake", __FILE__)
 load File.expand_path("../tasks/database.rake", __FILE__)
 load File.expand_path("../tasks/directories.rake", __FILE__)
 load File.expand_path("../tasks/files.rake", __FILE__)
-#load File.expand_path("../tasks/pagespeed.rake", __FILE__)
-#load File.expand_path("../tasks/php.rake", __FILE__)
-#load File.expand_path("../tasks/redis.rake", __FILE__)
-#load File.expand_path("../tasks/server.rake", __FILE__)
-#load File.expand_path("../tasks/varnish.rake", __FILE__)
 
 # Load defaults variables
 namespace :load do

data/lib/capistrano/tasks/capistrano-deploy.rake

@@ -8,12 +8,12 @@ namespace :deploy do
 
   task :message_start do
     puts " "
-    puts " Start deploy ".colorize(:color => :black, :background => :green)
+    puts "   Start deploy   ".colorize(:color => :black, :background => :green)
     puts " "
   end
   task :message_finish do
     puts " "
-    puts " Finish deploy ".colorize(:color => :black, :background => :green)
+    puts "   Finish deploy   ".colorize(:color => :black, :background => :green)
     puts " "
   end
 
@@ -103,6 +103,7 @@ namespace :deploy do
   after 'deploy:updating', 'deploy:init_all'
 
   # Restart services and clear caches
+  before 'deploy:updated', 'deploy:set_permissions:acl'
   after 'deploy:publishing', 'deploy:clear_caches'
 
 end

data/lib/capistrano/tasks/database.rake

@@ -30,14 +30,14 @@ namespace :database do
       puts " "
       puts "> Execute wp-cli commands to install WordPress SQL requests".colorize(:light_blue)
 
-      execute :mkdir, '-p', "#{shared_path}/tmp/wpcli"
-      execute "wp core download --path=#{shared_path}/tmp/wpcli --force"
+      execute "#{fetch(:sudo)} mkdir -p #{shared_path}/tmp/wpcli"
+      execute "#{fetch(:sudo)} wp core download --path=#{shared_path}/tmp/wpcli --force"
 
       puts "Execute wp-cli command to generate wp-config.php file".colorize(:light_blue)
-      execute "wp core config --path=#{shared_path}/tmp/wpcli --dbname=#{fetch(:database_name)} --dbuser=#{fetch(:database_user)} --dbpass=#{fetch(:database_pass)}"
+      execute "#{fetch(:sudo)} wp core config --path=#{shared_path}/tmp/wpcli --dbname=#{fetch(:database_name)} --dbuser=#{fetch(:database_user)} --dbpass=#{fetch(:database_pass)}"
 
-      execute "wp core install --path=#{shared_path}/tmp/wpcli --url=#{fetch(:localurl)} --title=#{fetch(:application)} --admin_user=#{fetch(:wordpress_name)} --admin_password=#{fetch(:wordpress_pass)} --admin_email=#{fetch(:wordpress_mail)}"
-      execute :rm, '-rf', "#{shared_path}/tmp"
+      execute "#{fetch(:sudo)} wp core install --path=#{shared_path}/tmp/wpcli --url=#{fetch(:localurl)} --title=#{fetch(:application)} --admin_user=#{fetch(:wordpress_name)} --admin_password=#{fetch(:wordpress_pass)} --admin_email=#{fetch(:wordpress_mail)}"
+      execute "#{fetch(:sudo)} rm -rf #{shared_path}/tmp"
 
       puts "end :database:wp_cli".colorize(:light_blue)
       puts " "

data/lib/capistrano/tasks/directories.rake

@@ -9,7 +9,7 @@ namespace :directories do
       if test "[ ! -d \"#{shared_path}/app/config\" ]"
         puts " "
         puts "> Create app/config folder".colorize(:light_blue)
-        execute :mkdir, '-p', "#{shared_path}/app/config"
+        execute "#{fetch(:sudo)} mkdir -p #{shared_path}/app/config"
       end
 
       # Create all linked dirs
@@ -17,10 +17,10 @@ namespace :directories do
         if test "[ ! -d \"#{shared_path}/#{folder}\" ]"
           puts " "
           puts "> Create #{folder} folder".colorize(:light_blue)
-          execute :mkdir, '-p', "#{shared_path}/#{folder}"
+          execute "#{fetch(:sudo)} mkdir -p #{shared_path}/#{folder}"
 
           if test "[ -d \"#{release_path}/#{folder}\" ]"
-            execute :rm, '-rf', "#{release_path}/#{folder}"
+            execute "#{fetch(:sudo)} rm -rf #{release_path}/#{folder}"
           end
         end
       end

data/lib/capistrano/vars/defaults.rb

@@ -1,13 +1,20 @@
 # ~~~~
 
+set :files, fetch(:files, ['app/config/env.php', 'app/config/salt.php', 'web/.htaccess', 'web/robots.txt'])
+set :dirs, fetch(:dirs, ['web/statics/languages', 'web/statics/plugins', 'web/statics/uploads'])
+set :stage_user, fetch(:stage_user, 'www-data')
+
+# ~~~~
+
 # Setup Git
-set :repo_url, 'git@github.com:crewstyle/Olympus.git'
+set :repo_url, 'git@github.com:GetOlympus/Olympus.git'
 set :scm, :git
 set :git_enable_submodules, true
 
 # Setup SSH
 set :copy_exclude, ['.git', '.DS_Store', '.gitignore', '.gitmodules']
 set :use_sudo, false
+set :sudo, "sudo -u #{fetch(:stage_user)} -i --"
 set :ssh_options, {
   forward_agent: true
 }
@@ -16,13 +23,19 @@ set :ssh_options, {
 
 # Setup Composer
 set :composer_flags, '--no-dev --prefer-dist --optimize-autoloader'
-set :composer_install_flags, fetch(:composer_flags)
+set :composer_install_flags, :composer_flags
+
+# ~~~~
+
+# Setup File permissions
+set :file_permissions_paths, :files + :dirs
+set :file_permissions_users, [:stage_user]
 
 # ~~~~
 
 # Setup Symlinks
-set :linked_files, ["app/config/env.php", "app/config/salt.php", "web/.htaccess", "web/robots.txt"]
-set :linked_dirs, ["web/statics/languages", "web/statics/plugins", "web/statics/uploads"]
+set :linked_files, :files
+set :linked_dirs, :dirs
 
 # ~~~~
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-olympus
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Achraf Chouk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-11 00:00:00.000000000 Z
+date: 2016-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -52,6 +52,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.7
+- !ruby/object:Gem::Dependency
+  name: capistrano-file-permissions
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 description: Capistrano 3.x deployment processes for WordPress and Olympus framework
 email:
 - achrafchouk@gmail.com
@@ -59,7 +79,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG
+- CHANGELOG.md
 - LICENSE
 - README.md
 - capistrano-olympus.gemspec
@@ -69,11 +89,6 @@ files:
 - lib/capistrano/tasks/database.rake
 - lib/capistrano/tasks/directories.rake
 - lib/capistrano/tasks/files.rake
-- lib/capistrano/tasks/pagespeed.rake
-- lib/capistrano/tasks/php.rake
-- lib/capistrano/tasks/redis.rake
-- lib/capistrano/tasks/server.rake
-- lib/capistrano/tasks/varnish.rake
 - lib/capistrano/vars/defaults.rb
 homepage: http://github.com/crewstyle/capistrano-olympus
 licenses:

data/lib/capistrano/tasks/pagespeed.rake

@@ -1,11 +0,0 @@
-# PageSpeed
-namespace :pagespeed do
-
-  desc "PageSpeed data flush"
-  task :flushall do
-    on roles(:app) do
-      sudo :touch, '/var/cache/mod_pagespeed/cache.flush'
-    end
-  end
-
-end

data/lib/capistrano/tasks/php.rake

@@ -1,37 +0,0 @@
-# PHP
-namespace :php do
-
-  desc "PHP restart"
-  task :restart do
-    on roles(:app) do
-      if test("[ -f /etc/init.d/php7.0-fpm ]")
-        sudo :service, 'php7.0-fpm', :restart
-      elsif test("[ -f /etc/init.d/php5-fpm ]")
-        sudo :service, 'php5-fpm', :restart
-      end
-    end
-  end
-
-  desc "PHP start"
-  task :start do
-    on roles(:app) do
-      if test("[ -f /etc/init.d/php7.0-fpm ]")
-        sudo :service, 'php7.0-fpm', :start
-      elsif test("[ -f /etc/init.d/php5-fpm ]")
-        sudo :service, 'php5-fpm', :start
-      end
-    end
-  end
-
-  desc "PHP stop"
-  task :stop do
-    on roles(:app) do
-      if test("[ -f /etc/init.d/php7.0-fpm ]")
-        sudo :service, 'php7.0-fpm', :stop
-      elsif test("[ -f /etc/init.d/php5-fpm ]")
-        sudo :service, 'php5-fpm', :stop
-      end
-    end
-  end
-
-end

data/lib/capistrano/tasks/redis.rake

@@ -1,19 +0,0 @@
-# Redis
-namespace :redis do
-
-  desc "Redis data flush"
-  task :flushall do
-    on roles(:app) do
-      sudo 'redis-cli', 'flushall'
-    end
-  end
-
-  desc "Redis restart"
-  task :restart do
-    on roles(:app) do
-      sudo '/etc/init.d/redis-server', 'stop'
-      sudo '/etc/init.d/redis-server', 'start'
-    end
-  end
-
-end

data/lib/capistrano/tasks/server.rake

@@ -1,37 +0,0 @@
-# Server Nginx or Apache
-namespace :server do
-
-  desc "Server restart"
-  task :restart do
-    on roles(:app) do
-      if test("[ -f /etc/init.d/nginx ]")
-        sudo :service, :nginx, :restart
-      elsif test("[ -f /etc/init.d/apache2 ]")
-        sudo :service, :apache2, :restart
-      end
-    end
-  end
-
-  desc "Server start"
-  task :start do
-    on roles(:app) do
-      if test("[ -f /etc/init.d/nginx ]")
-        sudo :service, :nginx, :start
-      elsif test("[ -f /etc/init.d/apache2 ]")
-        sudo :service, :apache2, :start
-      end
-    end
-  end
-
-  desc "Server stop"
-  task :stop do
-    on roles(:app) do
-      if test("[ -f /etc/init.d/nginx ]")
-        sudo :service, :nginx, :stop
-      elsif test("[ -f /etc/init.d/apache2 ]")
-        sudo :service, :apache2, :stop
-      end
-    end
-  end
-
-end

data/lib/capistrano/tasks/varnish.rake

@@ -1,11 +0,0 @@
-# Varnish
-namespace :varnish do
-
-  desc "Varnish restart"
-  task :restart do
-    on roles(:app) do
-      sudo :service, :varnish, :restart
-    end
-  end
-
-end