capdrupal 0.10.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2473c00739299636685fdf30bb850053de863be0
-  data.tar.gz: c610c19cc38b01f01814bd485527d7c636c02554
+SHA256:
+  metadata.gz: c44d744004a0b49a0e7034222558aba3899026837f5b1dfcf6e994f9262e08eb
+  data.tar.gz: 95957676e7e161041ed66fd5f56af9ce7aa071077f289e3a7864273996e5e4d7
 SHA512:
-  metadata.gz: 32df96a6ee3ebedf0c577a4dd5bbfef7173c117129ded83932e4f4f91cfc01f21c70387fbea6976525316edaa33ad86df600f03a4984fa132369d1019e32529f
-  data.tar.gz: 8008cf06155af8497cf402d6589a1c0c65aa82446f4b416581ff2fe617bbb3625e9536728d6bcfb62de719bd2a37c76aed4e6105031096f25d24146932fa9566
+  metadata.gz: 73243af2f5674c4f7b9b9a4421e3f377222d00630f43586c6f4d9690e9175d645821af8caa9c94d9512fd2a7aa9fc318bf9b00c629046290a4cd1457b6d0d45c
+  data.tar.gz: '08f3121798682e048c27a75cb6f0242ebcd4d4516aeed292ccaa5f1a2612a636c501bd757984d82b18c7073c2af8c726d2712fbdf38003bfbaf61bf579db95a3'

data/.gitignore

@@ -0,0 +1,22 @@
+## JetBrains template
+.idea/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+## macOS template
+.DS_Store
+.AppleDouble
+.LSOverride
+
+## Generated gem by gem build capdrupal.gemspec
+capdrupal-*.gem

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Capdrupal Changelog
+
+## 3.0.1 (2020-08-07)
+ - Update the command `drupal:cache:clear` to be re-runnable after invoke
+
+## 3.0.0 (2020-08-07)
+ - Support for Drupal 8 & Drupal 9
+ - Complete code refactoring
+
+## 0.11.0 (2016-01-21)
+ - Support for Drupal 8 & Drupal 9
+
+## 0.10.0 (2015-04-24)
+ - Task `deploy` do not clear cache, revert features, updatedb, etc. For this use `deploy:full` task
+
+## 0.9.6 (2014-06-14)
+  * Fix capistrano deps

data/CONTRIBUTING.md

@@ -0,0 +1,44 @@
+# Developing on Capdrupal
+
+* Issues should be filed at
+https://github.com/antistatique/capdrupal/issues
+* Pull requests can be made against
+https://github.com/antistatique/capdrupal/pulls
+
+## 📦 Repositories
+
+Github repo
+
+  ```bash
+  git remote add github https://github.com/antistatique/capdrupal.git
+  ```
+
+## 🔧 Prerequisites
+
+First of all, you will need to have the following tools installed
+globally on your environment:
+
+  * ruby
+  * bundle
+  * capistrano
+  * gem
+
+## 💎 Specify local.capdrupal Ruby gems in your Gemfile
+
+For local development, you will need to use on your local checkout of `capdrupal`.
+To achieve this goal, you may update your project `Gemfile` and use `gem "capdrupal", path: "/path/to/capdrupal"`.
+
+Please **don't do that** as explain here https://rossta.net/blog/how-to-specify-local-ruby-gems-in-your-gemfile.html
+
+Instead, use the `bundle config local` and declare a new `local.capdrupal` gem:
+
+    ```bash
+    bundle config local.capdrupal /path/to/capdrupal
+    ```
+
+Though convenient, using the `:path` option in our Gemfile to point to a local gem elsewhere on our machine sets us
+up for three potential problems without automated prevention:
+
+  * Committing a nonexistent lookup path on other machines
+  * Failing to point to the correct repository branch
+  * Failing to point to an existing git reference

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Antistatique SA
+
+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,253 @@
+# Capdrupal
+
+This gem provides a number of tasks which are useful for deploying & managing Drupal projects with [Capistrano](https://github.com/capistrano/capistrano).
+
+[![Gem Version](https://badge.fury.io/rb/capdrupal.svg)](https://badge.fury.io/rb/capdrupal)
+[![Maintainability](https://api.codeclimate.com/v1/badges/e5db5a7f49d86ce5e418/maintainability)](https://codeclimate.com/github/antistatique/capdrupal/maintainability)
+
+# Capdrupal version
+
+Capdrupal Gem Version | Branch | Capistrano Version | Drupal Version
+--------------------- | ------ | ------------------ | --------------
+0.11.0                | d7     | 2                  | 7.x
+3.x                   | main   | 3.x                | 8.x
+3.x                   | main   | 3.x                | 9.x
+
+## Prerequisites
+
+By default, Capdrupal will use **Drush** to run every Drupal commands. Therefore, your Drupal project **must** to require 
+`drush/drush`.
+
+You may add Drush as a dependency using `composer require drush/drush` in your Drupal project. Read more at [drush/drush](https://github.com/drush-ops/drush).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capdrupal', '~>3.0'
+```
+
+And then execute:
+
+```shell
+bundle
+```
+
+Or install it yourself if [gems](http://rubygems.org) is installed on your system:
+
+```shell
+gem install capdrupal
+```
+
+## Configuration
+
+First, go to your project directory and launch Capistrano.
+
+```shell
+cd path/to/your/drupal/project/
+cap install
+```
+
+Capistrano will create the following skeleton
+
+```
+.
+├── Capfile
+├── config
+│   └── deploy.rb
+│   └── deploy
+│       └── production.rb
+│       └── staging.rb
+├── lib
+│   └── capistrano
+│        └── tasks
+
+```
+
+Create two files `Capfile` and `config/deploy.rb`. Open `Capfile` and set the dependencies.
+
+```ruby
+# Load DSL and set up stages.
+require 'capistrano/setup'
+
+# Include default deployment tasks.
+require 'capistrano/deploy'
+
+# Composer is needed to install drush on the server.
+require 'capistrano/composer'
+
+# Drupal Tasks.
+require 'capdrupal'
+
+# Load custom tasks from `lib/capistrano/tasks` if you have any defined.
+Dir.glob('config/capistrano/tasks/*.rake').each { |r| import r }
+```
+
+Then, go to `config/deploy.rb` to set the parameters of your project. First you have to define the general information about the user, server and the app himself.
+
+```ruby
+set :application, 'application-name'
+set :repo_url, 'git@github.com:company/application.git'
+
+server 'ssh.example.org', user: 'username', roles: %w{app db web}
+```
+
+The specific Drupal information
+
+```ruby
+set :install_composer, true
+set :install_drush, true
+
+set :app_path, 'web'
+set :config_path, 'config/sync'
+
+# Setup the backup before/after failed strategy.
+set :backup_path, 'backups'
+set :keep_backups, 5
+
+# Link file settings.php
+set :linked_files, fetch(:linked_files, []).push("#{fetch(:app_path)}/sites/default/settings.php", "drush/drush.yml")
+
+# Link dirs files and private-files
+set :linked_dirs, fetch(:linked_dirs, []).push("#{fetch(:app_path)}/sites/default/files")
+```
+
+Then, all the others information related to your Git repository or debug level
+
+```ruby
+# Default value for :scm is :git
+set :scm, :git
+
+# Default value for :log_level is :debug
+set :log_level, :debug
+```
+
+Finally, set the deployment to use the proper Drupal 8 strategy
+
+```ruby
+namespace :deploy do
+  # Ensure everything is ready to deploy.
+  after "deploy:check:directories", "drupal:db:backup:check"
+
+  # Backup the database before starting a deployment and rollback on fail.
+  # after :updated, "drupal:db:backup"
+  # before :failed, "drupal:db:rollback"
+  # before :cleanup, "drupal:db:backup:cleanup"
+
+  # Set the maintenance Mode on your Drupal online project when deploying.
+  after :updated, "drupal:maintenance:on"
+
+  # Must updatedb before import configurations, E.g. when composer install new
+  # version of Drupal and need updatedb scheme before importing new config.
+  # This is executed without raise on error, because sometimes we need to do drush config-import before updatedb.
+  after :updated, "drupal:updatedb:silence"
+
+  # Remove the cache after the database update
+  after :updated, "drupal:cache:clear"
+  after :updated, "drupal:config:import"
+
+  # Update the database after configurations has been imported.
+  after :updated, "drupal:updatedb"
+
+  # Clear your Drupal 8 cache.
+  after :updated, "drupal:cache:clear"
+
+  # Disable the maintence on the Drupal project.
+  after :updated, "drupal:maintenance:off"
+
+  # Ensure permissions are properly set.
+  after :updated, "drupal:permissions:recommended"
+  after :updated, "drupal:permissions:writable_shared"
+
+  # Fix the release permissions (due to Drupal restrictive permissions)
+  # before deletting old release.
+  before :cleanup, "drupal:permissions:cleanup"
+end
+```
+
+You may now can configure your `staging.rb` and `production.rb` strategy, has you will certainly deploy on different environment
+
+```shell
+vi config/deploy/staging.rb
+```
+
+```ruby
+# staging.example.org
+set :deploy_to, '/var/www/staging.example.org'
+
+# set a branch for this release
+set :branch, 'dev'
+
+# Map composer and drush commands
+# NOTE: If stage have different deploy_to
+# you have to copy those line for each <stage_name>.rb
+# See https://github.com/capistrano/composer/issues/22
+SSHKit.config.command_map[:composer] = -> { shared_path.join('composer.phar') }
+SSHKit.config.command_map[:drush] = -> { release_path.join('vendor/bin/drush') }
+```
+
+```shell
+vi config/deploy/production.rb
+```
+
+```ruby
+# www.example.org
+set :deploy_to, '/var/www/example.org'
+
+# set a branch for this release
+set :branch, 'master'
+
+# Map composer and drush commands
+# NOTE: If stage have different deploy_to
+# you have to copy those line for each <stage_name>.rb
+# See https://github.com/capistrano/composer/issues/22
+SSHKit.config.command_map[:composer] = -> { shared_path.join('composer.phar') }
+SSHKit.config.command_map[:drush] = -> { release_path.join('vendor/bin/drush') }
+```
+
+Awesome, your configuration is complete !
+
+## Usage
+
+So, after configuration come action ! The first time, you have to run this command with the choosing stage.
+
+```shell
+cap [staging|production] deploy:setup
+```
+
+In fact, Capistrano create directories and symlink to the targeted server. The `shared` directory contains all shared files of your app who don't need to be change. `Releases` contains the different releases of your app with a number define in `deploy.rb` and finally `current` is the symlink who target the right release.
+
+```
+example.org
+├── current -> /home/example.org/releases/20130527070530
+├── releases
+│   ├── 20130527065508
+│   ├── 20130527065907
+│   └── 20130527070530
+└── shared
+```
+
+Now, every time you want to deploy your app !
+
+```
+cap [staging|production] deploy
+```
+
+And if some troubles occur, just launch the rollback command to return to the previous release.
+
+```
+cap [staging|production] deploy:rollback
+```
+
+You should then be able to proceed as you would usually, you may want to familiarise yourself with the truncated list of tasks, you can get a full list with:
+
+```
+cap -T
+```
+
+## Credits
+
+Inspired by [capistrano-drupal](https://github.com/previousnext/capistrano-drupal).
+
+Made by [Antistatique](https://antistatique.net) who's always looking for new talented developers ! Just mail us on [job@antistatique.net](mailto:job@antistatique.net).

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler/gem_tasks'
+
+# Do nothing by default
+task :default

data/capdrupal.gemspec

@@ -1,30 +1,29 @@
-# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-Gem::Specification.new do |s|
-  s.name         = 'capdrupal'
-  s.version      = '0.10.0'
-  s.license      = 'MIT'
-  s.platform     = Gem::Platform::RUBY
-  s.description  = <<-DESC
-    A set of tasks for deploying Drupal projects with Capistrano and the help of Drush.
+Gem::Specification.new do |spec|
+  spec.name          = 'capdrupal'
+  spec.version       = '3.0.1'
+  spec.authors       = ['Kevin Wenger', 'Yann Lugrin', 'Gilles Doge', 'Toni Fisler', 'Simon Perdrisat', 'Robert Wohleb', 'Kim Pepper']
+  spec.email         = ['hello@antistatique.net']
+
+  spec.description   = <<-DESC
+    A set of tasks for deploying Drupal 9, Drupal 8 and Drupal 7 projects with Capistrano and the help of Drush.
   DESC
-  s.summary      = 'A set of tasks for deploying Drupal projects with Capistrano'
+  spec.summary       = 'A set of tasks for deploying and managing Drupal projects with Capistrano'
+  spec.homepage      = %q{http://github.com/antistatique/capdrupal/}
+  spec.license       = 'MIT'
 
-  s.extra_rdoc_files = [
-    "README.markdown"
-  ]
-  s.files = [
-    "README.markdown",
-    "VERSION",
-    "capdrupal.gemspec",
-    "lib/capdrupal.rb"
-  ]
-  s.require_path = 'lib'
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ['lib']
 
-  s.add_dependency 'capistrano', '~> 2.13', '>= 2.13.4'
-  s.add_dependency 'railsless-deploy', '~> 1.1', '>= 1.1.2'
+  spec.add_dependency 'capistrano', '~> 3.5'
+  spec.add_dependency 'capistrano-composer', '~> 0.0.6'
 
-  s.authors  = [ "Simon Perdrisat", "Gilles Doge", "Robert Wohleb", "Kim Pepper" ]
-  s.email    = 'gilles.doge@gmail.com'
-  s.homepage = %q{http://github.com/antistatique/capdrupal/}
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0.0'
 end

data/docs/maintainers.md

@@ -0,0 +1,17 @@
+# Documentation for maintainers
+
+Since this is a Ruby tool used by PHP programmers it might be a good idea to document
+some things. 
+
+## Making a release
+
+Checklist for making a release: 
+
+- Write changelog 
+- Update version number in `capdrupal.gemspec`
+- Commit those 2 changes and create a new tag with the version number
+- Make a [new release with GitHub](https://github.com/antistatique/capdrupal/releases/new)
+- Build the gem with `gem build capdrupal.gemspec`
+- Push the gem to rubygems.org: `gem push capdrupal-X.X.X.gem` 
+- Add the `capdrupal-X.X.X.gem` to the GitHub release 
+

data/lib/capdrupal.rb

@@ -1,270 +1,287 @@
-Capistrano::Configuration.instance(:must_exist).load do
-
-  require 'capistrano/recipes/deploy/scm'
-  require 'capistrano/recipes/deploy/strategy'
-  require 'railsless-deploy'
-
-  # =========================================================================
-  # These variables may be set in the client capfile if their default values
-  # are not sufficient.
-  # =========================================================================
-
-  _cset :scm, :git
-  _cset :deploy_via, :remote_cache
-  _cset :branch, "master"
-  _cset :git_enable_submodules, true
-
-  _cset :download_drush, false
-  _cset(:drush_cmd) { download_drush ? "#{shared_path}/drush/drush" : "drush" }
-
-  _cset :runner_group, "www-data"
-  _cset :group_writable, false
-
-  _cset(:deploy_to) { "/var/www/#{application}" }
-  _cset(:app_path) { "drupal" }
-  _cset :shared_children, false
-
-  _cset :backup_path, "backups"
-  _cset :remote_tmp_dir, "/tmp"
-
-  if download_drush
-    depend :remote, :command, "curl"
-  end
-
-  # This is an optional step that can be defined.
-  #after "deploy", "git:push_deploy_tag"
-
-  after "deploy:finalize_update" do
-    drupal.symlink_shared
+namespace :load do
+  task :defaults do
+    set :app_path, 'web'
+    set :config_path, 'config/sync'
+    set :backup_path, 'backups'
+    set :keep_backups, 5
+    set :enable_modules, []
+    set :disable_modules, []
   end
+end
 
-  namespace :deploy do
-    desc <<-DESC
-      Prepares one or more servers for deployment. Before you can use any \
-      of the Capistrano deployment tasks with your project, you will need to \
-      make sure all of your servers have been prepared with `cap deploy:setup'. When \
-      you add a new server to your cluster, you can easily run the setup task \
-      on just that server by specifying the HOSTS environment variable:
-
-        $ cap HOSTS=new.server.com deploy:setup
-
-      It is safe to run this task on servers that have already been set up; it \
-      will not destroy any deployed revisions or data.
-    DESC
-    task :setup, :except => { :no_release => true } do
-      dirs = [deploy_to, releases_path, shared_path].join(' ')
-      run "#{try_sudo} mkdir -p #{releases_path} #{shared_path}"
-      run "#{try_sudo} chown -R #{user}:#{runner_group} #{deploy_to}"
-      if shared_children.size > 0
-        sub_dirs = shared_children.map { |d| File.join(shared_path, d) }
-        run "#{try_sudo} mkdir -p #{sub_dirs.join(' ')}"
-        run "#{try_sudo} chmod 2775 #{sub_dirs.join(' ')}"
+namespace :drush do
+  desc "Install Drush - only once for bootstraping"
+  task :install do
+    on roles(:app) do
+      within shared_path do
+        execute :composer, 'require drush/drush'
       end
     end
+  end
+end
 
-    desc <<-DESC
-      Deploy your project and do an updatedb, feature revert, cache clear...
-    DESC
-    task :full do
-      deploy
+namespace :drupal do
 
-      if download_drush
-        drush.get
+  desc 'Run any drush command'
+  task :drush do
+    ask(:drush_command, "Drush command you want to run (eg. 'cache-clear css-js'). Type 'help' to have a list of avaible drush commands.")
+    on roles(:app) do
+      within release_path.join(fetch(:app_path)) do
+        execute :drush, fetch(:drush_command)
       end
-
-      drupal.site_offline
-      drupal.updatedb
-      drupal.cache_clear
-      drupal.feature_revert
-      drupal.site_online
-      drupal.cache_clear
     end
   end
 
+  namespace :db do
+    desc "Revert the current release drupal site database backup"
+    task :rollback do
+      on roles(:app) do
+        within release_path.join(fetch(:app_path)) do
+          backup = "#{shared_path}/#{fetch(:backup_path)}/#{fetch(:stage)}_#{release_timestamp}"
 
-  namespace :drupal do
-    desc "Symlinks static directories and static files that need to remain between deployments"
-    task :symlink_shared, :roles => :app, :except => { :no_release => true } do
-      if shared_children
-        # Creating symlinks for shared directories
-        shared_children.each do |link|
-          run "#{try_sudo} mkdir -p #{shared_path}/#{link}"
-          run "#{try_sudo} sh -c 'if [ -d #{release_path}/#{link} ] ; then rm -rf #{release_path}/#{link}; fi'"
-          run "#{try_sudo} ln -nfs #{shared_path}/#{link} #{release_path}/#{link}"
+          # Unzip the file for rollback.
+          execute "gunzip #{backup}.gz"
+
+          unless test "[ -f #{backup} ]"
+            warn "backup file #{backup} does not exist."
+            next
+          end
+
+          # Revert from backup.
+          execute :drush, 'sql:drop --yes'
+          execute :drush, "sql:cli < #{backup}"
+
+          # Delete the unziped backup.
+          execute :rm, backup
         end
       end
+    end
 
-      if shared_files
-        # Creating symlinks for shared files
-        shared_files.each do |link|
-          link_dir = File.dirname("#{shared_path}/#{link}")
-          run "#{try_sudo} mkdir -p #{link_dir}"
-          run "#{try_sudo} touch #{shared_path}/#{link}"
-          run "#{try_sudo} ln -nfs #{shared_path}/#{link} #{release_path}/#{link}"
+    desc "Backup drupal site database"
+    task :backup do
+      on roles(:app) do
+        within release_path.join(fetch(:app_path)) do
+          backup_destination = "#{shared_path}/#{fetch(:backup_path)}/#{fetch(:stage)}_#{release_timestamp}"
+          execute :drush, "sql:dump --result-file=#{backup_destination} --gzip"
         end
       end
     end
 
-    desc 'Run any drush command'
-    task :drush do
-      drush_command = Capistrano::CLI.ui.ask "Drush command you want to run (eg. 'cache-rebuild'). Type 'help' to have a list of avaible command."
-        run "#{drush_cmd} -r #{latest_release}/#{app_path} #{drush_command}"
-    end
+    namespace :backup do
+      desc "Check required files and directories exist"
+      task :check do
+        on release_roles :all do
+          execute :mkdir, "-p", "#{shared_path}/#{fetch(:backup_path)}"
+        end
+      end
 
-    desc "Set the site offline"
-    task :site_offline do
-      run "#{drush_cmd} -r #{latest_release}/#{app_path} vset site_offline 1 -y"
-      run "#{drush_cmd} -r #{latest_release}/#{app_path} vset maintenance_mode 1 -y"
-    end
+      desc "Clean up old drupal site database backup"
+      task :cleanup do
+        on roles(:app) do
+          within release_path.join(fetch(:app_path)) do
+            backup_path = "#{shared_path}/#{fetch(:backup_path)}"
+            keep_backups = fetch(:keep_backups, 5)
 
-    desc "Backup the database using backup and migrate"
-    task :backupdb, :on_error => :continue do
-      run "#{drush_cmd} -r #{latest_release}/#{app_path} bam-backup"
-    end
+            # Fetch every file from the backup directory, oldest on top.
+            backups = capture(:ls, "-ltrx", backup_path).split
+            info "Keeping #{keep_backups} of #{backups.count} backup dump on #{backup_path}."
 
-    desc "Run Drupal database migrations if required"
-    task :updatedb, :on_error => :continue do
-      run "#{drush_cmd} -r #{latest_release}/#{app_path} updatedb -y"
-    end
+            # If we found less file than the keep number finish the task here
+            next "" unless backups.count > keep_backups.to_i
 
-    desc "Clear All the cache"
-    task :cache_clear do
-      run "#{drush_cmd} -r #{latest_release}/#{app_path} cache-clear all"
-    end
+            # Calculate number of file to delete.
+            to_delete = backups.count - keep_backups.to_i
 
-    desc "Revert feature"
-    task :feature_revert do
-      run "#{drush_cmd} -r #{latest_release}/#{app_path} features-revert-all -y"
+            # Loop throught file to delete (oldest files on top).
+            backups[0, to_delete].map do |backup|
+              execute :rm, "#{backup_path}/#{backup}"
+            end
+          end
+        end
+      end
     end
+  end
 
-    desc "Set the site online"
-    task :site_online do
-      run "#{drush_cmd} -r #{latest_release}/#{app_path} vset site_offline 0 -y"
-      run "#{drush_cmd} -r #{latest_release}/#{app_path} vset maintenance_mode 0 -y"
+  namespace :cache do
+    desc 'Clear all caches'
+    task :clear do
+      on roles(:app) do
+        within release_path.join(fetch(:app_path)) do
+          execute :drush, 'cr'
+        end
+      end
+      Rake::Task['drupal:cache:clear'].reenable
     end
   end
 
-  namespace :files do
-    desc "Pull drupal sites files (from remote to local)"
-    task :pull, :roles => :app, :except => { :no_release => true } do
-      remote_files_dir = "#{current_path}/#{app_path}/sites/default/files/"
-      local_files_dir = "#{app_path}/sites/default/files/"
-
-      run_locally("rsync --recursive --times --rsh=ssh --compress --human-readable --progress #{user}@#{domain}:#{remote_files_dir} #{local_files_dir}")
+  namespace :module do
+    desc 'Enable module(s)'
+    task :enable do
+      on roles(:app) do
+        within release_path.join(fetch(:app_path)) do
+          for mod in fetch(:enable_modules)
+            execute :drush, "en '#{mod}' -y"
+          end
+        end
+      end
     end
 
-    desc "Push drupal sites files (from local to remote)"
-    task :push, :roles => :app, :except => { :no_release => true } do
-      if Capistrano::CLI.ui.agree("Do you really want to push your local files to the server? This can ovewrite files. (y/N)") then
-        remote_files_dir = "#{current_path}/#{app_path}/sites/default/files/"
-        local_files_dir = "#{app_path}/sites/default/files/"
-
-        run_locally("rsync --recursive --times --rsh=ssh --compress --human-readable --progress #{local_files_dir} #{user}@#{domain}:#{remote_files_dir}")
+    desc 'Disable module(s)'
+    task :disable do
+      on roles(:app) do
+        within release_path.join(fetch(:app_path)) do
+          for mod in fetch(:disable_modules)
+            execute :drush, "pmu '#{mod}' -y"
+          end
+        end
       end
     end
   end
 
-  namespace :git do
-
-    desc "Place release tag into Git and push it to origin server."
-    task :push_deploy_tag do
-      user = `git config --get user.name`
-      email = `git config --get user.email`
-      tag = "release_#{release_name}"
-      if exists?(:stage)
-        tag = "#{stage}_#{tag}"
+  namespace :maintenance do
+    desc "Set maintenance mode"
+    task :on do
+      on roles(:app) do
+        within release_path.join(fetch(:app_path)) do
+          execute :drush, "state:set system.maintenance_mode 1 -y"
+          execute :drush, 'cr', raise_on_non_zero_exit: false
+        end
       end
-      puts `git tag #{tag} #{revision} -m "Deployed by #{user} <#{email}>"`
-      puts `git push origin tag #{tag}`
     end
 
-   end
-
-  namespace :drush do
-    desc "Gets drush and installs it"
-    task :get, :roles => :app, :except => { :no_release => true } do
-      run "#{try_sudo} cd #{shared_path} && curl -O -s http://ftp.drupal.org/files/projects/drush-7.x-5.8.tar.gz && tar -xf drush-7.x-5.8.tar.gz && rm drush-7.x-5.8.tar.gz"
-      run "#{try_sudo} cd #{shared_path} && chmod u+x drush/drush"
+    desc "Remove maintenance mode"
+    task :off do
+      on roles(:app) do
+        within release_path.join(fetch(:app_path)) do
+          execute :drush, "state:set system.maintenance_mode 0 -y"
+          execute :drush, 'cr'
+        end
+      end
     end
-
   end
 
-  # Inspired by Capifony project
-  namespace :database do
-    namespace :dump do
-      task :remote do
-        filename  = "#{application}_dump.#{Time.now.utc.strftime("%Y%m%d%H%M%S")}.sql.gz"
-        sqlfile = "#{remote_tmp_dir}/#{filename}"
-
-        run "#{drush_cmd} -r #{latest_release}/#{app_path} sql-dump | gzip -9 > #{sqlfile}"
-
-        FileUtils::mkdir_p("#{backup_path}")
-
-        download(sqlfile, "#{backup_path}/#{filename}")
+  desc 'Update database with migrations scripts'
+  task :updatedb do
+    on roles(:app) do
+      within release_path.join(fetch(:app_path)) do
+        execute :drush, 'updatedb -y'
+      end
+    end
+  end
 
-        begin
-          FileUtils.ln_sf(filename, "#{backup_path}/#{application}_dump.latest.sql.gz")
-        rescue Exception # fallback for file systems that don't support symlinks
-          FileUtils.cp_r("#{backup_path}/#{filename}", "#{backup_path}/#{application}_dump.latest.sql.gz")
+  namespace :updatedb do
+    desc 'Update database with migrations scripts'
+    task :silence do
+      on roles(:app) do
+        within release_path.join(fetch(:app_path)) do
+          execute :drush, 'updatedb -y', raise_on_non_zero_exit: false
         end
-
-        run "rm #{sqlfile}"
       end
+    end
+  end
 
-      task :local do
-        filename  = "#{application}.local_dump.#{Time.now.utc.strftime("%Y%m%d%H%M%S")}.sql.gz"
-        sqlfile = "#{backup_path}/#{filename}"
-
-        FileUtils::mkdir_p("#{backup_path}")
-
-        run_locally "cd #{app_path} &&  drush sql-dump | gzip -9 > ../#{sqlfile}"
+  desc 'Apply pending entity schema updates'
+  task :entup do
+    on roles(:app) do
+      within release_path.join(fetch(:app_path)) do
+        execute :drush, 'entup -y'
+      end
+    end
+  end
 
-        begin
-          FileUtils.ln_sf(sqlfile, "#{backup_path}/#{application}.local_dump.latest.sql.gz")
-        rescue Exception # fallback for file systems that don't support symlinks
-          FileUtils.cp_r(sqlfile, "#{backup_path}/#{application}.local_dump.latest.sql.gz")
+  namespace :config do
+    desc 'Import configuration to active stage'
+    task :import do
+      on roles(:app) do
+        try = 0
+        full_config_path = release_path.join(fetch(:config_path))
+        within release_path.join(fetch(:app_path)) do
+          execute :drush, "config-import -y"
+        rescue
+          try += 1
+          try < 5 ? retry : raise
         end
-
-        sqlfile
       end
     end
+  end
 
-    namespace :copy do
-      desc "Copy remote database into your local database"
-      task :to_local do
-        gzfile  = "#{backup_path}/#{application}_dump.latest.sql.gz"
-        sqlfile = "#{backup_path}/#{application}_dump.sql"
-
-        database.dump.remote
+  namespace :permissions do
+    desc 'Set recommended Drupal permissions'
+    task :recommended do
+      on roles(:app) do
+        within release_path.join(fetch(:app_path)) do
+          execute :chmod, '-R', '555', '.'
 
-        # be sure the file not already exist before un-gziping it
-        if File.exist?(sqlfile)
-          FileUtils.rm(sqlfile)
+          # Remove execution for files, keep execution on folder.
+          execute 'find', './ -type f -executable -exec chmod -x {} \;'
+          execute 'find', './ -type d -exec chmod +x {} \;'
         end
-
-        f = File.new(sqlfile, "a+")
-        gz = Zlib::GzipReader.new(File.open(gzfile, "r"))
-        f << gz.read
-        f.close
-
-        run_locally "cd #{app_path} && drush sql-connect < ../#{sqlfile}"
-
-        FileUtils.rm(sqlfile)
       end
+    end
 
-      desc "Copy local database to the remote database"
-      task :to_remote do
-        filename = "#{application}.local_dump.#{Time.now.utc.strftime("%Y%m%d%H%M%S")}.sql.gz"
+    desc 'Set cleanup permissions to allow deletion of releases'
+    task :cleanup do
+      on roles(:app) do
+        releases = capture(:ls, '-x', releases_path).split
+        valid, invalid = releases.partition { |e| /^\d{14}$/ =~ e }
+
+        if valid.count >= fetch(:keep_releases)
+          directories = (valid - valid.last(fetch(:keep_releases))).map do |release|
+            releases_path.join(release)
+          end
+          if test("[ -d #{current_path} ]")
+            current_release = capture(:readlink, current_path).to_s
+            if directories.include?(current_release)
+              directories.delete(current_release)
+            end
+          end
+          if directories.any?
+            directories.each_slice(100) do |directories_batch|
+              execute :chmod, '-R' ,'ug+w', *directories_batch
+            end
+          end
+        end
+      end
+    end
 
-        if Capistrano::CLI.ui.agree("Do you really want to replace remote database by your local one? (y/N)") then
-          gzfile = database.dump.local
+    desc 'Initalize shared path permissions'
+    task :writable_shared do
+      on roles(:app) do
+        within shared_path do
+          # "web/sites/default/files" is a shared dir and should be writable.
+          execute :chmod, '-R', '775', "#{fetch(:app_path)}/sites/default/files"
 
-          upload(gzfile, "#{remote_tmp_dir}/#{filename}")
+          # Remove execution for files, keep execution on folder.
+          execute 'find', "#{fetch(:app_path)}/sites/default/files", '-type f -executable -exec chmod -x {} \;'
+          execute 'find', "#{fetch(:app_path)}/sites/default/files", '-type d -exec chmod +sx {} \;'
+        end
+      end
+    end
+  end
 
-          mysqlcommand = capture("#{drush_cmd} -r #{latest_release}/#{app_path} sql-connect")
-          run "zcat #{remote_tmp_dir}/#{filename} | #{mysqlcommand}"
+  namespace :files do
+    desc "Download drupal sites files (from remote to local)"
+    task :download do
+      run_locally do
+        on release_roles :app do |server|
+          ask(:answer, "Do you really want to download the files on the server to your local files? Nothings will be deleted but files can be ovewrite. (y/N)");
+          if fetch(:answer) == 'y' then
+            remote_files_dir = "#{shared_path}/#{(fetch(:app_path))}/sites/default/files/"
+            local_files_dir = "#{(fetch(:app_path))}/sites/default/files/"
+            system("rsync --recursive --times --rsh=ssh --human-readable --progress --exclude='.*' --exclude='css' --exclude='js' #{server.user}@#{server.hostname}:#{remote_files_dir} #{local_files_dir}")
+          end
+        end
+      end
+    end
 
-          run "rm #{remote_tmp_dir}/#{filename}"
+    desc "Upload drupal sites files (from local to remote)"
+    task :upload do
+      on release_roles :app do |server|
+        ask(:answer, "Do you really want to upload your local files to the server? Nothings will be deleted but files can be ovewrite. (y/N)");
+        if fetch(:answer) == 'y' then
+          remote_files_dir = "#{shared_path}/#{(fetch(:app_path))}/sites/default/files/"
+          local_files_dir = "#{(fetch(:app_path))}/sites/default/files/"
+          system("rsync --recursive --times --rsh=ssh --human-readable --progress --exclude='.*' --exclude='css' --exclude='js' #{local_files_dir} #{server.user}@#{server.hostname}:#{remote_files_dir}")
         end
       end
     end

metadata

@@ -1,17 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: capdrupal
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 3.0.1
 platform: ruby
 authors:
-- Simon Perdrisat
+- Kevin Wenger
+- Yann Lugrin
 - Gilles Doge
+- Toni Fisler
+- Simon Perdrisat
 - Robert Wohleb
 - Kim Pepper
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-24 00:00:00.000000000 Z
+date: 2021-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -19,51 +22,74 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.13'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.13.4
+        version: '3.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.13'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.13.4
+        version: '3.5'
 - !ruby/object:Gem::Dependency
-  name: railsless-deploy
+  name: capistrano-composer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: 0.0.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
-    - - ">="
+        version: 0.0.6
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.2
-description: |2
-      A set of tasks for deploying Drupal projects with Capistrano and the help of Drush.
-email: gilles.doge@gmail.com
+        version: 10.0.0
+description: "    A set of tasks for deploying Drupal 9, Drupal 8 and Drupal 7 projects
+  with Capistrano and the help of Drush.\n"
+email:
+- hello@antistatique.net
 executables: []
 extensions: []
-extra_rdoc_files:
-- README.markdown
+extra_rdoc_files: []
 files:
-- README.markdown
-- VERSION
+- ".gitignore"
+- ".gitkeep"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
 - capdrupal.gemspec
+- docs/maintainers.md
 - lib/capdrupal.rb
 homepage: http://github.com/antistatique/capdrupal/
 licenses:
@@ -84,9 +110,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: A set of tasks for deploying Drupal projects with Capistrano
+summary: A set of tasks for deploying and managing Drupal projects with Capistrano
 test_files: []

data/README.markdown

@@ -1,184 +0,0 @@
-# Capdrupal
-
-This gem provides a number of tasks which are useful for deploying Drupal projects with [Capistrano](https://github.com/capistrano/capistrano). 
-
-# Capdrupal version
-
-
-Capdrupal Gem Version | Branch | Capistrano Version | Drupal Version 
---------------------- | ------ | ------------------ | --------------
-0.x                   |  d7    |   2                |    7.x
-2.x                   | master |   3                |    8.x
-
-
-## Installation
-[gems](http://rubygems.org) must be installed on your system first.
-
-### With Bundler (highly recommanded)
-
-This version use capistrano 2. Installation with [bundler](http://bundler.io/) let you use both version and avoid conflict.
-
-Create a 'Gemfile' on the root of your project
-
-
-	group :development do
-	  gem 'capistrano', '~> 2.15.5'
-	  gem 'railsless-deploy'
-	  gem 'capdrupal'
-	  #other development gems...
-	end
-	
-Install the depencies
-
-	$ bundle install
-	
-Use capistrano throw bundle
-
-	$ bundle exec cap deploy
-
-### From RubyGems.org 
-
-    $ gem install capdrupal
-
-### From Github
-
-	$ git clone git://github.com/antistatique/capdrupal.git
-	$ cd capdrupal
-	$ gem build capdrupal.gemspec
-	$ gem install capdrupal-{version}.gem
-
-	
-## Configuration
-
-This was tested with Git, but you can also use Subversion or your favorite versionning software. This tutorial his made for multistage deployment, but you can easily use it just for one target. 
-
-First, go to your project directory and launch Capistrano.
-
-	$ cd path/to/your/directory/
-	$ capify .
-	
-Capistrano create two files `capfile` and `config/deploy.rb`. Open `capfile` and set the depencies.
-
-	require 'rubygems'
-	require 'capdrupal'
-	load    'config/deploy'
-	
-Then, go to `config/deploy.rb` to set the parameters of your project. First you have to define the general informations about the user, server and the app himself.
-
-	# USER
-	set :user,            "name"
-	set :group,           "name"
-	set :runner_group,    "name"
-	
-	# APP
-	set :application,     "appName"
-	
-	# The domain and the path to your app directory
-	set :domain,    "staging.domain.com"
-	set :deploy_to, "/home/path/to/my/app/"
-
-The specific Drupal informations and if you have already or not [Drush](https://drupal.org/project/drush) installed on your server (if your not sure, keep it TRUE).
-
-	# DRUPAL
-	set :app_path,        "drupal"
-	set :shared_children, ['drupal/sites/default/files']
-	set :shared_files,    ['drupal/sites/default/settings.php'] 
-	set :download_drush,  true
-
-Then, all the informations related to your Git repository
-
-	set :scm,            "git"
-	set :repository,     "git@github.com:user/repo-name.git"
-	set :branch,         "dev"
-	
-Finally, set the other Capistrano related options, the number of realeases you want and the cleanup at the end of the deployment.
-
-	set :use_sudo,       false
-	default_run_options[:pty] = true
-	ssh_options[:forward_agent] = true	
-	role :app,           domain
-	role :db,            domain
-	
-	set  :keep_releases,   5
-	after "deploy:update", "deploy:cleanup" 
-	
-Awesome, your configuration file is complete ! You can also use Capdrupal for [multistage](https://github.com/capistrano/capistrano/wiki/2.x-Multistage-Extension).
-
-
-## Usage
-
-So, after configuration come action ! The first time, you have to run this command with the choosing stage.
-
-	$ cap deploy:setup
-	
-In fact, Capistrano create directories and symlink to the targeted server. The `shared` directory contains all shared files of your app who don't need to be change. `Releases` contains the different releases of your app with a number define in `deploy.rb` and finally `current` is the symlink who target the right release.
-
-	myApp
-	├── current -> /home/myApp/releases/20130527070530
-	├── releases
-	│   ├── 20130527065508
-	│   ├── 20130527065907
-	│   └── 20130527070530
-	└── shared
-
-Now, every time you want to deploy your app !
-
-	$ cap deploy
-
-If you want to deploy your app and also revert features, clear cache
-
-	$ cap deploy:full
-	
-And if some troubles occur, juste launch the rollback command to return to the previous release.
-
-	$ cap deploy:rollback
-
-
-You should then be able to proceed as you would usually, you may want to familiarise yourself with the truncated list of tasks, you can get a full list with:
-
-    $ cap -T
-    
-This show a list of all avaible commands:
-
-    
-	cap database:copy:to_local  # Copy remote database into your local database
-	cap database:copy:to_remote # Copy local database to the remote database
-	cap deploy                  # Deploys your project.
-	cap deploy:check            # Test deployment dependencies.
-	cap deploy:cleanup          # Clean up old releases.
-	cap deploy:cold             # Deploys and starts a `cold' application.
-	cap deploy:create_symlink   # Updates the symlink to the most recently deployed version.
-	cap deploy:full             # Deploy your project and do an updatedb, feature revert, cache clear...
-	cap deploy:pending          # Displays the commits since your last deploy.
-	cap deploy:pending:diff     # Displays the `diff' since your last deploy.
-	cap deploy:rollback         # Rolls back to a previous version and restarts.
-	cap deploy:rollback:code    # Rolls back to the previously deployed version.
-	cap deploy:setup            # Prepares one or more servers for deployment.
-	cap deploy:symlink          # Deprecated API.
-	cap deploy:update           # Copies your project and updates the symlink.
-	cap deploy:update_code      # Copies your project to the remote servers.
-	cap deploy:upload           # Copy files to the currently deployed version.
-	cap dev                     # Set the target stage to `dev'.
-	cap drupal:backupdb         # Backup the database using backup and migrate
-	cap drupal:cache_clear      # Clear All the cache
-	cap drupal:drush            # Run any drush command
-	cap drupal:feature_revert   # Revert feature
-	cap drupal:site_offline     # Set the site offline
-	cap drupal:site_online      # Set the site online
-	cap drupal:symlink_shared   # Symlinks static directories and static files that need to remain between deployments
-	cap drupal:updatedb         # Run Drupal database migrations if required
-	cap drush:get               # Gets drush and installs it
-	cap files:pull              # Pull drupal sites files (from remote to local)
-	cap files:push              # Push drupal sites files (from local to remote)
-	cap git:push_deploy_tag     # Place release tag into Git and push it to origin server.
-	cap invoke                  # Invoke a single command on the remote servers.
-	cap multistage:prepare      # Stub out the staging config files.
-	cap production              # Set the target stage to `production'.
-	cap shell                   # Begin an interactive Capistrano session.
-
-
-## Credits
-
-Inspired by [capistrano-drupal](https://github.com/previousnext/capistrano-drupal).
-
-Made by [Antistatique](http://www.antistatique.net) who's always looking for new talented developpers ! Just mail us on [job@antistatique.net](mailto:hello@antistatique.net).

data/VERSION

@@ -1 +0,0 @@
-0.10.0