capistrano_deploy_lock 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Include rake in Gemfile so that `bundle exec rake` doesn't raise an error
+gem 'rake', :group => :test
+
+# Specify your gem's dependencies in capistrano_deploy_lock.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Nathan Broadbent
+
+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

@@ -0,0 +1,82 @@
+# Capistrano Deploy Lock
+
+Lock a server during deploy, to prevent people from deploying at the same time.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capistrano_deploy_lock'
+
+And then execute:
+
+    $ bundle
+
+Add this line to your `config/deploy.rb`:
+
+    require 'capistrano/deploy_lock'
+
+## Usage
+
+Your deploys will now be protected by a lock. Simply run `cap deploy` as usual.
+However, if someone else trys to deploy at the same time, their deploy will abort
+with an error like this:
+
+```
+*** Deploy locked 3 minutes ago by 'ndbroadbent'
+*** Message: Deploying master branch
+*** Expires in 12 minutes
+.../capistrano/deploy_lock.rb:132:in `block (3 levels) in <top (required)>': Capistrano::DeployLockedError (Capistrano::DeployLockedError)
+```
+
+The default 'deploy' lock will expire after 15 minutes, assuming that your deploys will not take more time than this.
+This is so that crashed or interrupted deploys don't leave a stale lock for the next developer to deal with.
+This default expiry time can be configured with:
+
+    set :default_lock_expiry, (20 * 60)   # Sets the default expiry to 20 minutes
+
+Anyone can remove a lock by running:
+
+    cap deploy:unlock
+
+The lock file will be created at `#{shared_path}/capistrano.lock.yml` by default. You can configure this with:
+
+    set :deploy_lockfile, "path/to/deploy/lock/file"
+
+
+## Manual locks
+
+You can explicitly set a deploy lock by running:
+
+    cap deploy:lock
+
+You will receive two prompts:
+
+* Lock Message:
+
+Type the reason for the lock. This message will be displayed to any developers who attempt to deploy.
+
+* Expire lock at? (optional):
+
+Set an expiry time for the lock. Leave this blank to make the lock last until someone removes it with `cap deploy:unlock`.
+
+If the [chronic](https://github.com/mojombo/chronic) gem is available, you can type
+natural language times like `2 hours`, or `tomorrow at 6am`. If not, you must type times in a format that `DateTime.parse()` can handle,
+such as `06:30:00` or `2012-12-12 00:00:00`.
+
+The `cap deploy:check_lock` task will automatically delete any expired locks.
+
+## Thanks
+
+Special thanks to [David Bock](https://github.com/bokmann), who wrote the [deploy_lock.rb](https://github.com/bokmann/dunce-cap/blob/master/recipes/deploy_lock.rb)
+script that this is based on.
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/capistrano_deploy_lock.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano_deploy_lock/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "capistrano_deploy_lock"
+  gem.version       = CapistranoDeployLock::VERSION
+  gem.authors       = ["Nathan Broadbent"]
+  gem.email         = ["nathan.f77@gmail.com"]
+  gem.description   = %q{Lock a server during deploy, to prevent people from deploying at the same time.}
+  gem.summary       = %q{Capistrano Deploy Lock}
+  gem.homepage      = "https://github.com/ndbroadbent/capistrano_deploy_lock"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/capistrano/deploy_lock.rb

@@ -0,0 +1,138 @@
+# Capistrano Deploy Lock
+#
+# Add "require 'capistrano/deploy_lock'" in your Capistrano deploy.rb.
+# Based on deploy_lock.rb from https://github.com/bokmann/dunce-cap
+
+require 'time'
+# Provide advanced expiry time parsing via Chronic, if available
+begin; require 'chronic'; rescue LoadError; end
+begin
+  # Use Rails distance_of_time_in_words_to_now helper if available
+  require 'action_view'
+  module Capistrano
+    class DateHelper
+      class << self
+        include ActionView::Helpers::DateHelper
+      end
+    end
+  end
+rescue LoadError
+end
+
+Capistrano::DeployLockedError = Class.new(StandardError)
+
+Capistrano::Configuration.instance(:must_exist).load do
+  before "deploy", "deploy:check_lock"
+  before "deploy", "deploy:create_lock"
+  after  "deploy", "deploy:unlock"
+
+  # Default lock expiry of 15 minutes (in case deploy crashes or is interrupted)
+  _cset :default_lock_expiry, (15 * 60)
+  _cset(:deploy_lockfile) { "#{shared_path}/capistrano.lock.yml" }
+
+  # Show lock message as bright red
+  log_formatter(:match => /Deploy locked/, :color => :red, :style => :bright, :priority => 20)
+
+  namespace :deploy do
+    # Set deploy lock with a custom lock message and expiry time
+    task :lock do
+      set :lock_message, Capistrano::CLI.ui.ask("Lock Message: ")
+
+      while self[:lock_expiry].nil?
+        expiry_str = Capistrano::CLI.ui.ask("Expire lock at? (optional): ")
+        if expiry_str == ""
+          # Never expire an explicit lock if no time given
+          set :lock_expiry, false
+        else
+          parsed_expiry = nil
+          if defined?(Chronic)
+            parsed_expiry = (Chronic.parse(expiry_str) || Chronic.parse("#{expiry_str} from now"))
+          else
+            if dt = (DateTime.parse(expiry_str) rescue nil)
+              parsed_expiry = dt.to_time
+            end
+          end
+
+          if parsed_expiry
+            set :lock_expiry, parsed_expiry.utc
+          else
+            logger.info "'#{expiry_str}' could not be parsed. Please try again."
+          end
+        end
+      end
+
+      create_lock
+    end
+
+    desc "Creates a lock file, so that futher deploys will be prevented."
+    task :create_lock do
+      if self[:lock_message].nil?
+        set :lock_message, "Deploying #{branch} branch"
+      end
+      if self[:lock_expiry].nil?
+        set :lock_expiry, (Time.now + default_lock_expiry).utc
+      end
+
+      lock = {
+        :created_at => Time.now.utc,
+        :username   => ENV['USER'],
+        :expire_at  => self[:lock_expiry],
+        :message    => self[:lock_message]
+      }
+      put lock.to_yaml, deploy_lockfile, :mode => 0777
+    end
+
+    desc "Unlocks the server for deployment."
+    task :unlock do
+      run "rm -f #{deploy_lockfile}"
+    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
+      lock_file = capture("[ -e #{deploy_lockfile} ] && cat #{deploy_lockfile} || true").strip
+
+      if lock_file != ""
+        lock = YAML.load(lock_file)
+
+        if lock[:expire_at] && lock[:expire_at] < Time.now
+          logger.info "Deleting expired deploy lock..."
+          unlock
+        else
+          if defined?(Capistrano::DateHelper)
+            locked_ago = Capistrano::DateHelper.distance_of_time_in_words_to_now lock[:created_at].localtime
+            message = "Deploy locked #{locked_ago} ago"
+          else
+            message = "Deploy locked at #{lock[:created_at].localtime}"
+          end
+
+          message << " by '#{lock[:username]}'\nMessage: #{lock[:message]}"
+
+          if lock[:expire_at]
+            if defined?(Capistrano::DateHelper)
+              expires_in = Capistrano::DateHelper.distance_of_time_in_words_to_now lock[:expire_at].localtime
+              message << "\nExpires in #{expires_in}"
+            else
+              message << "\nExpires at #{lock[:expire_at].localtime.strftime("%H:%M:%S")}"
+            end
+          else
+            message << "\nLock must be manually removed with: cap #{stage} deploy:unlock"
+          end
+
+          logger.important message
+
+          # Don't raise exception if current user owns the lock.
+          # Just sleep so they have a chance to Ctrl-C
+          if lock[:username] == ENV['USER']
+            4.downto(1) do |i|
+              Kernel.print "\rDeploy lock was created by you (#{ENV['USER']}). Continuing deploy in #{i}..."
+              sleep 1
+            end
+            puts
+          else
+            raise Capistrano::DeployLockedError
+          end
+        end
+      end
+    end
+  end
+end

data/lib/capistrano_deploy_lock/version.rb

@@ -0,0 +1,3 @@
+module CapistranoDeployLock
+  VERSION = "1.0.0"
+end

data/lib/capistrano_deploy_lock.rb

@@ -0,0 +1 @@
+require "capistrano_deploy_lock/version"

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: capistrano_deploy_lock
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Nathan Broadbent
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-15 00:00:00.000000000 Z
+dependencies: []
+description: Lock a server during deploy, to prevent people from deploying at the
+  same time.
+email:
+- nathan.f77@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano_deploy_lock.gemspec
+- lib/capistrano/deploy_lock.rb
+- lib/capistrano_deploy_lock.rb
+- lib/capistrano_deploy_lock/version.rb
+homepage: https://github.com/ndbroadbent/capistrano_deploy_lock
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1879672784853574210
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1879672784853574210
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Capistrano Deploy Lock
+test_files: []