capistrano-deploy-lock 1.0.1 → 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f14d67d1b1468ff40a1e2227e59daa326e39c271
+  data.tar.gz: c4e736a13150a1ca0b22b88b71fc322f267b6f26
+SHA512:
+  metadata.gz: 216fcdfbd64f8704f9e3232f09ab98ec91d3e76a2edf70e45ef71ac7143628920bb073b0890d7ade54135884f6525357ad09ce0c49e2df7d16eef067f372377d
+  data.tar.gz: 7aaf7e4a12bda298f2c75c4a8445bc2cc4393e0fb1381926d90238581ee04af54a398cbb0e53cf72969e086ed05d6080d0553a9f0b5517fae867b09e17e82a0a

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Maruf Hasan Bulbul
+
+MIT License
+
+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

@@ -1,4 +1,4 @@
-# Capistrano Deploy Lock [![Gem Version](https://badge.fury.io/rb/capistrano-deploy-lock.svg)](https://badge.fury.io/rb/capistrano-deploy-lock)
+# Capistrano Deploy Lock 1.0.2
 
 Deploy lock feature for Capistrano 3.4.x
 
@@ -27,18 +27,36 @@ Require in `Capfile` to use the default task:
 require 'capistrano/deploy-lock'
 ```
 
-Deploy with custom lock:
+Deploy with default configuration:
 
-    $ cap production deploy:with_lock
+Just run normal capistrano command, deploy lock will work automatically. 
+    
+    $ cap production deploy
+    
+You will get the following tasks
 
-Manually Lock (without deploy):
-  
-    $ cap production deploy:lock
+```ruby
+cap production deploy:with_lock         # Deploy with custom lock
+cap production deploy:lock              # Lock manually (without deploy)
+cap production deploy:unlock            # Unlock manually
+cap production deploy:unlock:force      # Unlock forcefully
+```
+    
+Configurable options (copy into deploy.rb), shown here with examples:
 
-Manually Unlock (if necessary):
+```ruby
+# Deploy Lock File
+# default value: File.join(shared_path, "deploy-lock.yml")
+set :deploy_lock_file, -> { File.join(shared_path, "deploy-lock.yml") }
 
-    $ cap production deploy:unlock
+# Deploy Lock Roles
+# default value: :app ; use array for multiple roles
+set :deploy_lock_roles, -> { :app }
 
+# Deploy lock expiry (in second)
+# Default 15 minutes
+set :default_lock_expiry, (15 * 60)
+```
 
 ## Contributing
 

data/capistrano-deploy-lock.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "capistrano-deploy-lock"
-  spec.version       = "1.0.1"
+  spec.version       = "1.0.2"
   spec.author        = "Maruf Hasan Bulbul"
   spec.email         = "mhb.cse@gmail.com"
   spec.summary       = %q{Deploy lock feature for Capistrano 3.4.x}

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

@@ -1,6 +1,5 @@
 set :deploy_lock_file, -> { File.join(shared_path, "deploy-lock.yml") }
 set :deploy_lock_roles, -> { :app }
-set :deploy_lock_rack_env, -> { fetch(:rails_env) == "development" ? "development" : "deployment" }
 set :default_lock_expiry, (15 * 60)
 set :deploy_lock, false
 set :lock_message, nil
@@ -10,139 +9,115 @@ namespace :deploy do
   
   desc "Deploy with a custom deploy lock"
   task :with_lock do
-    on roles(fetch(:deploy_lock_roles)) do
-      with rails_env: fetch(:deploy_lock_rack_env) do
-        invoke 'deploy:lock'
-        invoke 'deploy'
-      end
-    end
+    invoke 'deploy:lock'
+    invoke 'deploy'
   end
   
   desc "Set deploy lock with a custom lock message and expiry time"
   task :lock do
-    on roles(fetch(:deploy_lock_roles)) do
-      with rails_env: fetch(:deploy_lock_rack_env) do
-        set :custom_deploy_lock, true
-        set :lock_message, ask('lock message', '', echo: true)
-        puts "Lock message: #{fetch(:lock_message)}"
-
-        while fetch(:lock_expiry).nil?
-          set :expire_after, ask('minutes of expiry', 'optional', echo: true) 
-          expire_after = fetch(:expire_after)
+    set :custom_deploy_lock, true
+    set :lock_message, ask('lock message', '', echo: true)
+
+    while fetch(:lock_expiry).nil?
+      set :expire_after, ask('minutes of expiry', 'optional', echo: true) 
+      expire_after = fetch(:expire_after)
           
-          if expire_after == "optional"
-            # Never expire an explicit lock if no time given
-            set :lock_expiry, false
-            puts colorize("Lock will never expire automatically.", color: 33)
-          else
-            unless expire_after.to_i == 0
-              set :lock_expiry, (Time.now + expire_after.to_i * 60).utc
-              puts colorize("Expire after #{fetch(:expire_after)} minutes", color: 33)
-            else
-              puts colorize("'#{expire_after}' is not valid input. Please try again.")
-            end
-          end
+      if expire_after == "optional"
+        # Never expire an explicit lock if no time given
+        set :lock_expiry, false
+        puts colorize("Lock will never expire automatically.", color: 33)
+      else
+        unless expire_after.to_i == 0
+          set :lock_expiry, (Time.now + expire_after.to_i * 60).utc
+          puts colorize("Expire after #{fetch(:expire_after)} minutes", color: 33)
+        else
+          puts colorize("'#{expire_after}' is not valid input. Please try again.")
         end
-    
-        invoke 'deploy:create_lock'
       end
     end
+ 
+    invoke 'deploy:create_lock'
   end
   
   desc "Creates a lock file, so that futher deploys will be prevented"
-  task :create_lock do 
-    on roles(fetch(:deploy_lock_roles)) do
-      with rails_env: fetch(:deploy_lock_rack_env) do
-        if fetch(:deploy_lock)
-          puts colorize('Deploy lock already created.', color: 33)
-          next
-        end
+  task :create_lock do
+    if fetch(:deploy_lock)
+      puts colorize('Deploy lock already created.', color: 33)
+      next
+    end
 
-        if fetch(:lock_message).nil?
-          set :lock_message, "Deploying #{fetch(:branch)} branch in #{fetch(:rails_env)}"
-        end
+    if fetch(:lock_message).nil?
+      set :lock_message, "Deploying #{fetch(:branch)} branch in #{fetch(:rails_env)}"
+    end
         
-        if fetch(:lock_expiry).nil?
-          set :lock_expiry, (Time.now + fetch(:default_lock_expiry)).utc
-        end
+    if fetch(:lock_expiry).nil?
+      set :lock_expiry, (Time.now + fetch(:default_lock_expiry)).utc
+    end
 
-        deploy_lock_data = {
-          created_at: Time.now.utc,
-          username: ENV['USER'],
-          expire_at: fetch(:lock_expiry),
-          message: fetch(:lock_message).to_s,
-          custom: !!fetch(:custom_deploy_lock)
-        }
+    deploy_lock_data = {
+      created_at: Time.now.utc,
+      username: ENV['USER'],
+      expire_at: fetch(:lock_expiry),
+      message: fetch(:lock_message).to_s,
+      custom: !!fetch(:custom_deploy_lock)
+    }
         
-        write_deploy_lock(deploy_lock_data)
-        set :deploy_lock, deploy_lock_data
-      end
-    end
+    write_deploy_lock(deploy_lock_data)
+    
+    set :deploy_lock, deploy_lock_data
   end
   
   desc "Checks for a deploy lock. If present, deploy is aborted and message is displayed. Any expired locks are deleted."
-  task :check_lock do 
-    on roles(fetch(:deploy_lock_roles)) do
-      with rails_env: fetch(:deploy_lock_rack_env) do
-        # Don't check the lock if we just created it
-        next if fetch(:deploy_lock)
+  task :check_lock do
+    # Don't check the lock if we just created it
+    next if fetch(:deploy_lock)
 
-        fetch_deploy_lock
+    fetch_deploy_lock
         
-        # Return if no lock
-        next unless fetch(:deploy_lock)
+    # Return if no lock
+    next unless fetch(:deploy_lock)
 
-        deploy_lock = fetch(:deploy_lock)
+    deploy_lock = fetch(:deploy_lock)
         
-        if deploy_lock[:expire_at] && deploy_lock[:expire_at] < Time.now
-          remove_deploy_lock
-          next
-        end
+    if deploy_lock[:expire_at] && deploy_lock[:expire_at] < Time.now
+      remove_deploy_lock
+      next
+    end
 
-        # Check if lock is a custom lock
-        set :custom_deploy_lock, deploy_lock[:custom]
+    # Check if lock is a custom lock
+    set :custom_deploy_lock, deploy_lock[:custom]
 
-        # Unexpired lock is present, so display the lock message
-        puts message(fetch(:application), fetch(:stage), deploy_lock)
+    # Unexpired lock is present, so display the lock message
+    puts message(fetch(:application), fetch(:stage), deploy_lock)
 
-        # Don't raise exception if current user owns the lock, and lock has an expiry time.
-        # Just sleep for a few seconds so they have a chance to cancel the deploy with Ctrl-C
-        if deploy_lock[:expire_at] && deploy_lock[:username] == ENV['USER']
-          10.downto(1) do |i|
-            Kernel.print "\r\e[0;33mDeploy lock was created by you (#{ENV['USER']}). Continuing deploy in #{i}...\e[0m"
-            sleep 1
-          end
-          puts
-        else
-          exit 1
-        end
+    # Don't raise exception if current user owns the lock, and lock has an expiry time.
+    # Just sleep for a few seconds so they have a chance to cancel the deploy with Ctrl-C
+    if deploy_lock[:expire_at] && deploy_lock[:username] == ENV['USER']
+      10.downto(1) do |i|
+        Kernel.print "\r\e[0;33mDeploy lock was created by you (#{ENV['USER']}). Continuing deploy in #{i}...\e[0m"
+        sleep 1
       end
+      puts
+    else
+      exit 1
     end
   end
   
   namespace :unlock do
     desc "Unlocks the server for deployment"
     task :default do
-      on roles(fetch(:deploy_lock_roles)) do
-        with rails_env: fetch(:deploy_lock_rack_env) do
-          # Don't automatically remove custom deploy locks created by deploy:lock task
-          if fetch(:custom_deploy_lock)
-            puts colorize('Not removing custom deploy lock.', color: 33)
-          else
-            remove_deploy_lock
-            puts colorize("Deploy unlocked.", color: 32)
-          end
-        end
+      # Don't automatically remove custom deploy locks created by deploy:lock task
+      if fetch(:custom_deploy_lock)
+        puts colorize('Not removing custom deploy lock.', color: 33)
+      else
+        remove_deploy_lock
+        puts colorize("Deploy unlocked.", color: 32)
       end
     end
 
     task :force do
-      on roles(fetch(:deploy_lock_roles)) do
-        with rails_env: fetch(:deploy_lock_rack_env) do
-          remove_deploy_lock
-          puts colorize("Deploy unlocked.", color: 32)
-        end
-      end
+      remove_deploy_lock
+      puts colorize("Deploy unlocked.", color: 32)
     end
   end
   
@@ -170,26 +145,26 @@ def fetch_deploy_lock
     # Check all matching servers for a deploy lock.
     on roles(fetch(:deploy_lock_roles)).to_a, in: :parallel do |host|
       if test("[ -f #{fetch(:deploy_lock_file)} ]")
-        system "mkdir -p tmp"
-        download! fetch(:deploy_lock_file), "tmp/deploy-lock.yml"
-        output = File.read("tmp/deploy-lock.yml")
-        system "rm -f tmp/deploy-lock.yml"
-        if output && output != ""
-          set :deploy_lock, YAML.load(output)
-          next
-        end
+        output = capture "cat #{fetch(:deploy_lock_file)}"
+        set :deploy_lock, YAML.load(output)
+      else
+        # no deploy lock was found on server
+        next
       end
     end
   end
 end
 
 def write_deploy_lock(deploy_lock)
-  sudo %{touch #{fetch(:deploy_lock_file)}}
-  upload! StringIO.new(deploy_lock.to_yaml), fetch(:deploy_lock_file)
+  on roles(fetch(:deploy_lock_roles)), in: :parallel do |host|
+    upload! StringIO.new(deploy_lock.to_yaml), fetch(:deploy_lock_file)
+  end
 end
 
 def remove_deploy_lock
-  sudo %{rm -f #{fetch(:deploy_lock_file)}}
+  on roles(fetch(:deploy_lock_roles)), in: :parallel do |host|
+    execute :rm, "-f", fetch(:deploy_lock_file)
+  end
   set :deploy_lock, nil
   set :deploy_lock_removed, true
 end

metadata

@@ -1,46 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-deploy-lock
 version: !ruby/object:Gem::Version
-  version: 1.0.1
-  prerelease: 
+  version: 1.0.2
 platform: ruby
 authors:
 - Maruf Hasan Bulbul
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-18 00:00:00.000000000 Z
+date: 2016-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
 description: Lock deploy when deployment is running or custom lock to prevent further
@@ -50,8 +45,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - capistrano-deploy-lock.gemspec
@@ -60,26 +56,25 @@ files:
 - lib/capistrano/tasks/deploy-lock.rake
 homepage: https://github.com/maruf-freelancer/capistrano-deploy-lock
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.4.8
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Deploy lock feature for Capistrano 3.4.x
 test_files: []