capistrano-wearerequired 0.4.0.pre.alpha.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: adb958823033cdad89185e1e4f792d1394cc20ac
+  data.tar.gz: 98d296cd260b8fcaa481c601e10121585bd8a4b4
+SHA512:
+  metadata.gz: f8204a6e9ca09e113d190facd6c4284b110216b6c774ef1de1adffb590a977e53c45b857103b1ad1d85abaad1d9d909784cf658b8537596a3c89df3f88cbfdb7
+  data.tar.gz: 29c09d97ac04c65d59f27a41fd41355eb14491200044f5dd7d7914c25da5c6992f1ac174672216ba0fa6a4198584dbfafc7d34880f6dc2e5093b3ab26b051d65

data/.editorconfig

@@ -0,0 +1,11 @@
+# This file is for unifying the coding style for different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+Gemfile.lock

data/Gemfile

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

data/README.md

@@ -0,0 +1,119 @@
+# Capistrano::RequiredTools
+
+A collection of tools for Capistrano.
+
+
+## Installation
+
+1. Add this line to your application's Gemfile to install the latest stable version:
+
+   ```ruby
+   gem 'capistrano-required_tools', :git => 'git@github.com:wearerequired/capistrano-required_tools.git', :branch => 'stable'
+   ```
+
+   Use `:tag => 'v0.3.0'` for a specific version.
+
+2. Execute:
+
+   ```
+   $ bundle
+   ```
+
+3. Require the library in your application's Capfile:
+
+   ```ruby
+   require 'capistrano/required_tools'
+   ```
+   
+   
+## Usage
+
+### Colors for Slackistrano
+
+The class `SlackistranoMessagingColors` adds colors to the deploy messages posted to Slack.
+
+Example:
+```ruby
+set :slackistrano, {
+    klass: Capistrano::RequiredTools::SlackistranoMessagingColors,
+    channel: '#your-channel',
+    webhook: 'your-incoming-webhook-url'
+}
+```
+
+### Extended Messaging for Slackistrano
+
+The class `SlackistranoMessagingExtended` adds colors, a link to the current diff, the current revision and branch, the name of the deployer and suppresses updating messages.
+
+Example:
+```ruby
+set :slackistrano, {
+    klass: Capistrano::RequiredTools::SlackistranoMessagingExtended,
+    channel: '#your-channel',
+    webhook: 'your-incoming-webhook-url',
+    icon_emoji: ':ship:',
+    username: 'deploybot'
+}
+```
+
+See [Customizing the Messaging](https://github.com/phallstrom/slackistrano/tree/v3.1.0#customizing-the-messaging) for more information.
+
+### Additonal tasks
+
+To **delete all content from Composer's cache directories** run:
+
+```
+cap staging composer:clear_cache
+```
+
+To **clean up all old releases** but the last run:
+
+```
+cap staging deploy:cleanup_all
+```
+
+To **install WordPress translations** set `:wp_language` and run:
+
+```
+set :wp_languages, [
+	'de_DE',
+	'it_IT
+]
+
+cap staging wordpress:install_translations
+```
+
+To **update WordPress translations** run:
+
+```
+cap staging wordpress: update_translations
+```
+
+To **clear OPcache** of your site set `:wp_clear_opcache, true` and run:
+
+```
+cap staging wordpress:clear_opcache
+```
+
+(Requires the [WP-CLI Clear OPcache](https://packagist.org/packages/wearerequired/wp-cli-clear-opcache) plugin.)
+
+## Changelog
+
+### 0.4.0
+
+* Added `wordpress:clear_opcache` task.
+* Added new messaging class for Slackistrano for more informative notifications.
+* Updated both messaging classes to support a custom icon (via `icon_url` or `icon_emoji`) and bot name (via `username`).
+ 
+### 0.3.0
+
+* Added `deploy:cleanup_all` task.
+* Added `wordpress:install_translations` and `wordpress:update_translations` tasks.
+
+### 0.2.0
+
+* Added `composer:clear_cache` task.
+
+### 0.1.0
+
+* Initial version.

data/Rakefile

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

data/capistrano-wearerequired.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'capistrano/wearerequired/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = "capistrano-wearerequired"
+  spec.version     = Capistrano::Wearerequired::VERSION
+  spec.description = "Capistrano::Wearerequired is a collection of recipes and tasks specialized on WordPress deployment."
+  spec.summary     = "Recipes for Capistrano used by required gmbh"
+  spec.authors     = ["wearerequired", "Pascal Birchler", "Ulrich Pogson", "Dominik Schilling"]
+  spec.email       = "info@required.ch"
+  spec.homepage    = "https://github.com/wearerequired/capistrano-wearerequired"
+  spec.license     = "GPL-2.0+"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.0"
+  spec.add_dependency "capistrano", "~> 3.6"
+  spec.add_dependency "slackistrano", "~> 3.1"
+  spec.add_dependency "capistrano-composer", "~> 0.0.6"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 11.0"
+end

data/lib/capistrano/wearerequired/capistrano.rb

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

data/lib/capistrano/wearerequired/composer.rb

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

data/lib/capistrano/wearerequired/slackistrano_messaging_colors.rb

@@ -0,0 +1,63 @@
+require 'slackistrano/capistrano'
+
+module Capistrano
+  module Wearerequired
+    class SlackistranoMessagingColors < Slackistrano::Messaging::Base
+
+      def initialize(env: nil, team: nil, channel: nil, token: nil, webhook: nil, icon_url: nil, icon_emoji: nil, username: nil)
+        super(env: env, team: team, channel: channel, token: token, webhook: webhook)
+        @icon_url = icon_url
+        @icon_emoji = icon_emoji
+        @username = username
+      end
+
+      def payload_for_updating
+        make_message(super.merge(color: '#E7E7E7'))
+      end
+
+      def payload_for_reverting
+        make_message(super.merge(color: '#E7E7E7'))
+      end
+
+      def payload_for_updated
+        make_message(super.merge(color: 'good'))
+      end
+
+      def payload_for_reverted
+        make_message(super.merge(color: 'good'))
+      end
+
+      def payload_for_failed
+        make_message(super.merge(color: 'danger'))
+      end
+
+      def icon_url
+        if @icon_url.nil?
+          super
+        else
+          @icon_url
+        end
+      end
+
+      def icon_emoji
+        @icon_emoji
+      end
+
+      def username
+       if @username.nil?
+         super
+       else
+         @username
+       end
+      end
+
+      private ##################################################
+
+      def make_message(options={})
+        attachment = options.reject{|k, v| v.nil? }
+        {attachments: [attachment]}
+      end
+
+    end
+  end
+end

data/lib/capistrano/wearerequired/slackistrano_messaging_extended.rb

@@ -0,0 +1,164 @@
+require 'slackistrano/capistrano'
+
+module Capistrano
+  module Wearerequired
+    class SlackistranoMessagingExtended < Slackistrano::Messaging::Base
+
+      def initialize(env: nil, team: nil, channel: nil, token: nil, webhook: nil, icon_url: nil, icon_emoji: nil, username: nil)
+        super(env: env, team: team, channel: channel, token: token, webhook: webhook)
+        @icon_url = icon_url
+        @icon_emoji = icon_emoji
+        @username = username
+      end
+
+      # Suppress updating message.
+      def payload_for_updating
+        nil
+      end
+
+      # Suppress reverting message.
+      def payload_for_reverting
+        nil
+      end
+
+      def payload_for_reverted
+        make_message(super.merge(color: 'good'))
+      end
+
+      def payload_for_failed
+        make_message(super.merge(color: 'danger'))
+      end
+
+      def icon_url
+        if @icon_url.nil?
+          super
+        else
+          @icon_url
+        end
+      end
+
+      def icon_emoji
+        @icon_emoji
+      end
+
+      def username
+       if @username.nil?
+         super
+       else
+         @username
+       end
+      end
+
+      # Get current revision
+      def current_revision
+        fetch(:current_revision)
+      end
+
+      # Get previous revision
+      def previous_revision
+        fetch(:previous_revision)
+      end
+
+      # Get individual parts of the repo_url
+      def repo
+        repo_url.match(/(git@|https:\/\/)(?<host>([\w\.@]+))(\/|:)(?<owner>[\w,\-,\_]+)\/(?<repo>[\w,\-,\_]+)(.git){0,1}((\/){0,1})/)
+      end
+
+      # Get information about the revision being deployed
+      def revision
+        if repo.nil? || current_revision.nil?
+          'Unknown'
+        else
+          current_revision_url
+        end
+      end
+
+      # Get current revision URL
+      def current_revision_url
+        "<https://%{host}/%{owner}/%{repo}/%{commit}/%{revision}|%{revision_short}@%{branch}>" % {
+          :host => repo[:host],
+          :owner => repo[:owner],
+          :repo => repo[:repo],
+          :commit => 'bitbucket.org' == repo[:host] ? 'commits' : 'commit',
+          :revision => current_revision,
+          :revision_short => current_revision[0..10],
+          :branch => branch
+        }
+      end
+
+      # Get revision comparison
+      def revision_compare_url
+        "<https://%{host}/%{owner}/%{repo}/%{compare}/%{previous_revision}...%{current_revision}|%{revision_short}>" % {
+          :host => repo[:host],
+          :owner => repo[:owner],
+          :repo => repo[:repo],
+          :compare => 'bitbucket.org' == repo[:host] ? 'branches/compare' : 'compare',
+          :current_revision => current_revision,
+          :previous_revision => previous_revision,
+          :revision_short => previous_revision[0..7] + '...' + current_revision[0..7]
+        }
+      end
+
+      def author_icon
+        "https://required.com/content/themes/required-valencia/img/character-%{name}-300x300.png" % { name: deployer.downcase }
+      end
+
+      def author_link
+        "https://required.com/team/%{name}/" % { name: deployer.downcase }
+      end
+
+      def footer_icon
+        if repo.nil?
+         ''
+        elsif 'bitbucket.org' == repo[:host]
+          'https://bitbucket.org/site/master/avatar/64/'
+        elsif 'gitlab.com' == repo[:host]
+          'https://gitlab.com/uploads/system/project/avatar/13083/logo-extra-whitespace.png'
+        elsif 'github.com' == repo[:host]
+          'https://assets-cdn.github.com/images/modules/logos_page/GitHub-Mark.png'
+        end
+      end
+
+      def footer
+        if repo.nil? || current_revision.nil? || previous_revision.nil?
+          ''
+        else
+          'Diff: ' + revision_compare_url
+        end
+      end
+
+      # More detailed updated message.
+      def payload_for_updated
+      {
+        attachments: [{
+          color: 'good',
+          pretext: application + ' was successfully deployed :white_check_mark:',
+          author_name: deployer.capitalize,
+          author_icon: author_icon,
+          author_link: author_link,
+          footer: footer,
+          footer_icon: footer_icon,
+          fields: [{
+            title: 'Environment',
+            value: stage.capitalize,
+            short: true
+          }, {
+            title: 'Revision',
+            value: revision,
+            short: true
+          }],
+          fallback: super[:text]
+        }]
+      }
+      end
+
+      private ##################################################
+
+      def make_message(options={})
+        attachment = options.reject{|k, v| v.nil? }
+        {attachments: [attachment]}
+      end
+
+    end
+  end
+end

data/lib/capistrano/wearerequired/tasks/capistrano.rake

@@ -0,0 +1,10 @@
+namespace :deploy do
+
+  desc <<-DESC
+    Clean up all old releases but the last.
+  DESC
+  task :cleanup_all do
+    set :keep_releases, 1
+    invoke "deploy:cleanup"
+  end
+end

data/lib/capistrano/wearerequired/tasks/composer.rake

@@ -0,0 +1,9 @@
+namespace :composer do
+
+  desc <<-DESC
+    Deletes all content from Composer's cache directories.
+  DESC
+  task :clear_cache do
+    invoke "composer:run", "clear-cache"
+  end
+end

data/lib/capistrano/wearerequired/tasks/wordpress.rake

@@ -0,0 +1,55 @@
+namespace :wordpress do
+
+  desc <<-DESC
+    Install WordPress translations.
+  DESC
+  task :install_translations do
+    next unless fetch(:wp_languages).any?
+
+    on roles(:app) do
+      within release_path do
+        fetch(:wp_languages).each do |language|
+          execute :wp, "core language install #{language}"
+        end
+      end
+    end
+  end
+
+  desc <<-DESC
+    Update WordPress translations.
+  DESC
+  task :update_translations do
+    next unless fetch(:wp_languages).any?
+
+    on roles(:app) do
+      within release_path do
+        execute :wp, "core language update"
+      end
+    end
+  end
+
+  desc <<-DESC
+    Clear OPcache.
+  DESC
+  task :clear_opcache do
+    next unless fetch(:wp_clear_opcache)
+
+    on roles(:app) do
+      within release_path do
+        execute :wp, "plugin activate wp-cli-clear-opcache --quiet"
+        execute :wp, "opcache clear"
+      end
+    end
+  end
+
+  after 'deploy:finishing', 'wordpress:install_translations'
+  after 'deploy:finishing', 'wordpress:update_translations'
+  after 'deploy:finishing', 'wordpress:clear_opcache'
+end
+
+namespace :load do
+  task :defaults do
+    set :wp_languages, []
+    set :wp_clear_opcache, false
+  end
+end

data/lib/capistrano/wearerequired/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Wearerequired
+    VERSION = "0.4.0-alpha.1"
+  end
+end

data/lib/capistrano/wearerequired/wordpress.rb

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

data/lib/capistrano/wearerequired.rb

@@ -0,0 +1,12 @@
+require "capistrano/wearerequired/version"
+
+module Capistrano
+  module Wearerequired
+  end
+end
+
+require "capistrano/wearerequired/slackistrano_messaging_colors"
+require "capistrano/wearerequired/slackistrano_messaging_extended"
+require "capistrano/wearerequired/composer.rb"
+require "capistrano/wearerequired/capistrano.rb"
+require "capistrano/wearerequired/wordpress.rb"

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-wearerequired
+version: !ruby/object:Gem::Version
+  version: 0.4.0.pre.alpha.1
+platform: ruby
+authors:
+- wearerequired
+- Pascal Birchler
+- Ulrich Pogson
+- Dominik Schilling
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-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.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: slackistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: capistrano-composer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+description: Capistrano::Wearerequired is a collection of recipes and tasks specialized
+  on WordPress deployment.
+email: info@required.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- capistrano-wearerequired.gemspec
+- lib/capistrano/wearerequired.rb
+- lib/capistrano/wearerequired/capistrano.rb
+- lib/capistrano/wearerequired/composer.rb
+- lib/capistrano/wearerequired/slackistrano_messaging_colors.rb
+- lib/capistrano/wearerequired/slackistrano_messaging_extended.rb
+- lib/capistrano/wearerequired/tasks/capistrano.rake
+- lib/capistrano/wearerequired/tasks/composer.rake
+- lib/capistrano/wearerequired/tasks/wordpress.rake
+- lib/capistrano/wearerequired/version.rb
+- lib/capistrano/wearerequired/wordpress.rb
+homepage: https://github.com/wearerequired/capistrano-wearerequired
+licenses:
+- GPL-2.0+
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Recipes for Capistrano used by required gmbh
+test_files: []