capistrano-magento2 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 481fdaea28179deaba14faf4fc32faf31c242dd3
-  data.tar.gz: 3e1652dabf3cf81c1129a135dc1bff02ecb6ba66
+  metadata.gz: ccafa2eeb272e5124e13f302daca97acdf41e9ad
+  data.tar.gz: 69888babe9fa29f97400350dc877f5897db6fe0d
 SHA512:
-  metadata.gz: 767336b3783b537c4698cd458bb58222f727cd35c9228cfbc3d1722bc5caecdc083742946a4c3d545dd7998daa2f374d83832cdb4ddc52aaa78062e0953b9a0d
-  data.tar.gz: 52794a258d96c8c79c13f1245fe747d75dd18826fe3ff43a9d8d2d2ffd06c9e98385725a6777508bcff06ad72d913bbd37729a89a971425d8d96a2b14a7cc90d
+  metadata.gz: 49a423449c33c366b55aefc12157495a9efaadf82321b5237435710fa2f5f1dc399e0d05932f8b0b3cb27819994d852f30b61eb88428f600b525c85f7137f7f2
+  data.tar.gz: 091d8d13cc69479a2a2965e83dda6389e6011453e3405cb6c561b2ec5dc741fe5fb1d917bbcfc61b16b4e59582f1105949861ca7c03561bd62fa1faae5c7c4e0

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Capistrano::Magento2 Change Log
 
+0.4.0
+==========
+
+* Added optional support for capistrano-pending gem.
+* Added `:magento_deploy_composer` flag. See README for details.
+* Added `:magento_deploy_maintenance` flag. See README for details.
+* Updated `:magento_deploy_languages` definition to explicitly declare default value.
+
 0.3.0
 ==========
 

data/README.md

@@ -107,6 +107,27 @@ Before you can use Capistrano to deploy, you must configure the `config/deploy.r
         
         Refer to the "role-based syntax" comments in the `config/deploy/*.rb` files or to the [Capistrano documentation](http://capistranorb.com/documentation/getting-started/preparing-your-application/#configure-your-server-addresses-in-the-generated-files) for details on how to configure multiple application servers.
 
+### Magento Deploy Settings
+
+| setting                       | default | what it does
+| ----------------------------- | ------- | ---
+| `:magento_deploy_languages`   | `['en_US']` | Array of languages passed to static content deploy routine          |
+| `:magento_deploy_composer`    | `true` | Enables composer install behaviour in the built-in deploy routine        |
+| `:magento_deploy_production`  | `true` | Enables production specific DI compilation and static content generation |
+| `:magento_deploy_maintenance` | `true` | Enables use of maintenance mode while magento:setup:upgrade runs.        |
+
+#### Example Usage
+
+Add a line similar to the following in `config/deploy.rb` to set a custom value on one of the above settings:
+
+```ruby
+set :magento_deploy_languages, ['en_US', 'en_CA']
+```
+
+```ruby
+set :magento_deploy_composer, false
+```
+
 ### Capistrano Built-Ins
 
 For the sake of simplicity in new project setups `:linked_dirs` and `:linked_files` are pre-configured per the following.
@@ -179,6 +200,16 @@ This gem specifies [terminal-notifier](https://rubygems.org/gems/terminal-notifi
 require 'capistrano/magento2/notifier'
 ```
 
+## Pending Changes
+
+This gem specifies [capistrano-pending](https://rubygems.org/gems/capistrano-pending) as a dependency and adds some (optional) custom functionality on top of that gem: Any time the `deploy` command is run, a one line summary of git commits that will be deployed will be displayed. If the server(s) you are deploying to already have the latest changes, you will be warned of this and a prompt will appear confirming that you want to continue deploying.
+
+To add the `capistrano-pending` gem and additional functionality to you project, add the following line to your `Capfile`:
+
+```ruby
+require 'capistrano/magento2/pending'
+```
+
 ## Development
 
 After checking out the repo, run `bundle install` to install dependencies. Make the necessary changes, then run `bundle exec rake install` to install a modified version of the gem on your local system.

data/capistrano-magento2.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'capistrano', '~> 3.1'
   spec.add_dependency 'terminal-notifier', '~> 1.6'
+  spec.add_dependency 'capistrano-pending', '~> 0.1'
 
   spec.add_development_dependency 'bundler', '~> 1.11'
   spec.add_development_dependency 'rake', '~> 10.0'

data/lib/capistrano/magento2/pending.rb

@@ -0,0 +1,57 @@
+##
+ # Copyright © 2016 by David Alger. All rights reserved
+ # 
+ # Licensed under the Open Software License 3.0 (OSL-3.0)
+ # See included LICENSE file for full text of OSL-3.0
+ # 
+ # http://davidalger.com/contact/
+ ##
+
+require 'capistrano/deploy'
+require 'capistrano/pending/scm/base'
+
+module Capistrano
+  module Pending
+    module SCM
+      class Git < Base
+
+        # Enhance capistrano-pending gem's native deploy:pending:log command by updating repository and then
+        # showing the actual changes that will be deployed. Also changes log output to oneline for easy reading
+        #
+        # Params:
+        # +from+            - commit-ish to compare from
+        # +to+              - commit-ish to compare to
+        # +returnOutput+    - whether to return or print the output
+        #
+        def log(from, to, returnOutput=false)
+          run_locally do
+            execute :git, :fetch, :origin   # update repository to ensure accuracy of pending changes report
+
+            # Since the :branch to deploy from may be behind the upstream branch, get name of upstream branch
+            # and use it for comparison. We are using the test command in case the :branch is set to a specific
+            # commit hash, in which case there is no upstream branch.
+
+            if test(:git, 'rev-parse', '--abbrev-ref', '--symbolic-full-name', to + '@{u}')
+              to = capture(:git, 'rev-parse', '--abbrev-ref', '--symbolic-full-name',  to + '@{u}')
+            end
+
+            output = capture(
+              :git,
+              :log,
+              "#{from}..#{to}",
+              '--pretty="format:%C(yellow)%h %Cblue%>(12)%ad %Cgreen%<(7)%aN%Cred%d %Creset%s"'
+            )
+
+            if returnOutput
+              return output
+            else
+              puts output
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+load File.expand_path('../../tasks/pending.rake', __FILE__)

data/lib/capistrano/magento2/version.rb

@@ -9,6 +9,6 @@
 
 module Capistrano
   module Magento2
-    VERSION = '0.3.0'
+    VERSION = '0.4.0'
   end
 end

data/lib/capistrano/tasks/deploy.rake

@@ -13,7 +13,7 @@ namespace :deploy do
   task :updated do
     on release_roles :all do
       invoke 'magento:deploy:verify'
-      invoke 'magento:composer:install'
+      invoke 'magento:composer:install' if fetch(:magento_deploy_composer)
       invoke 'magento:setup:permissions'
       if fetch(:magento_deploy_production)
         invoke 'magento:setup:static-content:deploy'
@@ -25,7 +25,7 @@ namespace :deploy do
           execute :magento, 'maintenance:enable'
         end
       end
-      invoke 'magento:maintenance:enable'
+      invoke 'magento:maintenance:enable' if fetch(:magento_deploy_maintenance)
       invoke 'magento:setup:upgrade'
     end
   end
@@ -34,15 +34,23 @@ namespace :deploy do
     on release_roles :all do
       invoke 'magento:cache:flush'
       invoke 'magento:cache:varnish:ban'
-      invoke 'magento:maintenance:disable'
+      invoke 'magento:maintenance:disable' if fetch(:magento_deploy_maintenance)
     end
   end
 
   task :reverted do
     on release_roles :all do
-      invoke 'magento:maintenance:disable'
+      invoke 'magento:maintenance:disable' if fetch(:magento_deploy_maintenance)
       invoke 'magento:cache:flush'
       invoke 'magento:cache:varnish:ban'
     end
   end
 end
+
+namespace :load do
+  task :defaults do
+    set :magento_deploy_composer, fetch(:magento_deploy_composer, true)
+    set :magento_deploy_production, fetch(:magento_deploy_production, true)
+    set :magento_deploy_maintenance, fetch(:magento_deploy_maintenance, true)
+  end
+end

data/lib/capistrano/tasks/magento.rake

@@ -304,7 +304,6 @@ namespace :load do
       'var/tmp'
     )
 
-    set :magento_deploy_production, fetch(:magento_deploy_production, true)   # TODO: Document deploy mode setting
-    set :magento_deploy_languages, fetch(:magento_deploy_languages, [])       # TODO: Document deploy lang setting
+    set :magento_deploy_languages, fetch(:magento_deploy_languages, ['en_US'])
   end
 end

data/lib/capistrano/tasks/pending.rake

@@ -0,0 +1,40 @@
+##
+ # Copyright © 2016 by David Alger. All rights reserved
+ # 
+ # Licensed under the Open Software License 3.0 (OSL-3.0)
+ # See included LICENSE file for full text of OSL-3.0
+ # 
+ # http://davidalger.com/contact/
+ ##
+
+require 'capistrano-pending'
+
+namespace :deploy do
+  before :starting, 'deploy:pending:check_changes'
+
+  namespace :pending do
+    # Check for pending changes and notify user of incoming changes or warn them that there are no changes
+    task :check_changes => :setup do
+      on roles fetch(:capistrano_pending_role, :app) do |host|
+        # check for pending changes only if REVISION file exists to prevent error
+        if test "[ -f #{current_path}/REVISION ]"
+          from = fetch(:revision)
+          to = fetch(:branch)
+
+          output = _scm.log(from, to, true)
+          if output.to_s.strip.empty?
+            puts "\e[0;31m"
+            puts "    No changes to deploy (from and to are the same: #{from}..#{to})"
+            print "    Are you sure you want to continue deploying? [y/n] \e[0m"
+
+            proceed = STDIN.gets[0..0] rescue nil
+            exit unless proceed == 'y' || proceed == 'Y'
+          else
+            puts "Deploying changes between #{from}..#{to}"
+            puts output
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-magento2
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - David Alger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-22 00:00:00.000000000 Z
+date: 2016-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: capistrano-pending
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -85,10 +99,12 @@ files:
 - lib/capistrano/magento2.rb
 - lib/capistrano/magento2/deploy.rb
 - lib/capistrano/magento2/notifier.rb
+- lib/capistrano/magento2/pending.rb
 - lib/capistrano/magento2/version.rb
 - lib/capistrano/tasks/deploy.rake
 - lib/capistrano/tasks/magento.rake
 - lib/capistrano/tasks/notifier.rake
+- lib/capistrano/tasks/pending.rake
 homepage: https://github.com/davidalger/capistrano-magento2
 licenses:
 - OSL-3.0