caplock 0.1.0 → 0.2.0

data/README.rdoc

@@ -2,6 +2,19 @@
 
 Adds a lock file to Capistrano deployments.
 
+== Installation
+
+   $ gem install caplock
+   
+Include in your Capfile
+    require 'rubygems'
+    require 'caplock'
+    
+== Usage
+
+Define the name of your lock file in your deploy.rb
+   set :lockfile, "my.lock" # defaults to "cap.lock"
+
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/caplock.gemspec

@@ -1,42 +1,36 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{caplock}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Dru Ibarra}]
-  s.date = %q{2012-01-10}
+  s.date = %q{2012-03-09}
   s.description = %q{Adds a lock file to Capistrano deployments to prevent concurrent deployments.}
   s.email = %q{Druwerd@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+    "README.rdoc"
   ]
   s.files = [
     ".document",
-     ".gitignore",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "caplock.gemspec",
-     "lib/caplock.rb",
-     "test/helper.rb",
-     "test/test_caplock.rb"
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "caplock.gemspec",
+    "lib/caplock.rb",
+    "test/helper.rb",
+    "test/test_caplock.rb"
   ]
   s.homepage = %q{http://github.com/Druwerd/caplock}
-  s.rdoc_options = [%q{--charset=UTF-8}]
   s.require_paths = [%q{lib}]
-  s.rubygems_version = %q{1.8.5}
+  s.rubygems_version = %q{1.8.6}
   s.summary = %q{Adds a lock file to Capistrano deployments}
-  s.test_files = [
-    "test/helper.rb",
-     "test/test_caplock.rb"
-  ]
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

data/lib/caplock.rb

@@ -1,59 +1,79 @@
-Capistrano::Configuration.instance.load do
-  
-  set :lockfile, "cap.lock"
+require 'capistrano'
+
+module Capistrano
+  module Caplock
   
-  # Returns Boolean indicating the result of +filetest+ on +full_path+ on the server, evaluated by shell on 
-  # the server (usually bash or something roughly compatible).
-  def remote_filetest_passes?(filetest, full_path)
-    'true' ==  capture("if [ #{filetest} #{full_path} ]; then echo 'true'; fi").strip
-  end
+    # Returns Boolean indicating the result of +filetest+ on +full_path+ on the server, evaluated by shell on 
+    # the server (usually bash or something roughly compatible).
+    def remote_filetest_passes?(filetest, full_path)
+      'true' ==  capture("if [ #{filetest} #{full_path} ]; then echo 'true'; fi").strip
+    end
   
-  # Checks if a symlink exists on the remote machine.
-  def remote_symlink_exists?(full_path)
-    remote_filetest_passes?('-L', full_path)
-  end
+    # Checks if a symlink exists on the remote machine.
+    def remote_symlink_exists?(full_path)
+      remote_filetest_passes?('-L', full_path)
+    end
   
-  # Returns Boolean value indicating whether file exists on server
-  def remote_file_exists?(full_path)
-    remote_filetest_passes?('-e', full_path)
-  end
+    # Returns Boolean value indicating whether file exists on server
+    def remote_file_exists?(full_path)
+      remote_filetest_passes?('-e', full_path)
+    end
 
-  # Returns Boolean value indicating whether the file at +full_path+ matches +content+.  Checks if file
-  # is equivalent to content by checking whether or not the MD5 of the remote content is the same as the
-  # MD5 of the String in +content+.
-  def remote_file_content_same_as?(full_path, content)
-    Digest::MD5.hexdigest(content) == capture("md5sum #{full_path} | awk '{ print $1 }'").strip
-  end
+    # Returns Boolean value indicating whether the file at +full_path+ matches +content+.  Checks if file
+    # is equivalent to content by checking whether or not the MD5 of the remote content is the same as the
+    # MD5 of the String in +content+.
+    def remote_file_content_same_as?(full_path, content)
+      Digest::MD5.hexdigest(content) == capture("md5sum #{full_path} | awk '{ print $1 }'").strip
+    end
 
-  # Returns Boolean indicating whether the remote file is present and has the same contents as
-  # the String in +content+.
-  def remote_file_differs?(full_path, content)
-    !remote_file_exists?(full_path) || remote_file_exists?(full_path) && !remote_file_content_same_as?(full_path, content)
-  end
-  
-  namespace :lock do
-    desc "check lock"
-    task :check, :roles => :app do
-      if remote_file_exists?("#{deploy_to}/#{lockfile}")
-        abort "\n\n\n\e[0;31m A Deployment is already in progress\n Remove #{deploy_to}/#{lockfile} to unlock  \e[0m\n\n\n"
-      end
+    # Returns Boolean indicating whether the remote file is present and has the same contents as
+    # the String in +content+.
+    def remote_file_differs?(full_path, content)
+      !remote_file_exists?(full_path) || remote_file_exists?(full_path) && !remote_file_content_same_as?(full_path, content)
     end
     
-    desc "create lock"
-    task :create, :roles => :app do
-      timestamp = Time.now.strftime("%m/%d/%Y %H:%M:%S %Z")
-      lock_message = "Deploy started at #{timestamp} in progress"
-      put lock_message, "#{deploy_to}/#{lockfile}", :mode => 0644
+    def self.load_into(configuration)
+      configuration.load do
+        set :lockfile, "cap.lock"
+        
+        namespace :lock do
+          desc "check lock"
+          task :check, :roles => :app do
+            if caplock.remote_file_exists?("#{deploy_to}/#{lockfile}")
+              abort "\n\n\n\e[0;31m A Deployment is already in progress\n Remove #{deploy_to}/#{lockfile} to unlock  \e[0m\n\n\n"
+            end
+          end
+
+          desc "create lock"
+          task :create, :roles => :app do
+            timestamp = Time.now.strftime("%m/%d/%Y %H:%M:%S %Z")
+            lock_message = "Deploy started at #{timestamp} in progress"
+            put lock_message, "#{deploy_to}/#{lockfile}", :mode => 0644
+          end
+
+          desc "release lock"
+          task :release, :roles => :app do
+             run "rm -f #{deploy_to}/#{lockfile}"
+          end
+        end
+
+        # Deployment
+        before "deploy", "lock:check"
+        after "lock:check", "lock:create"
+        after "deploy", "lock:release"
+
+        # Rollback
+        before "deploy:rollback", "lock:check"
+        after "deploy:rollback", "lock:release"
+        
+      end
     end
     
-    desc "release lock"
-    task :release, :roles => :app do
-       run "rm -f #{deploy_to}/#{lockfile}"
-    end
+    Capistrano.plugin :caplock, Caplock
+    
   end
-  
-  before "deploy", "lock:check"
-  after "lock:check", "lock:create"
-  after "deploy", "lock:release"
+end
 
+if Capistrano::Configuration.instance
+  Capistrano::Caplock.load_into(Capistrano::Configuration.instance)
 end

data/test/test_caplock.rb

@@ -1,7 +1,35 @@
 require 'helper'
 
 class TestCaplock < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
+  def setup
+    @config = Capistrano::Configuration.new
+    Capistrano::Caplock.load_into(@config)
+    @config.set :deploy_to, "/tmp"
+    @config.role :app, "localhost"
+  end
+  
+  should "use default lockfile name 'cap.lock'" do
+    assert_equal @config.lockfile, 'cap.lock'
+  end
+  
+  should "set lockfile name to 'test.lock'" do
+    @config.set :lockfile, 'test.lock'
+    assert_equal @config.lockfile, 'test.lock'
+  end
+  
+  should "create lock" do
+     assert_nil @config.lock.create
+     assert File.exists?("/tmp/cap.lock")
+  end
+  
+  should "remove lock" do
+     assert_nil @config.lock.create
+     assert_nil @config.lock.release
+     assert !File.exists?("/tmp/cap.lock")
+  end
+  
+  should "check for lock and pass" do
+     assert_nil @config.lock.release
+     assert_nil @config.lock.check
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: caplock
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Dru Ibarra
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-10 00:00:00 Z
+date: 2012-03-09 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: capistrano
@@ -58,7 +58,6 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .document
-- .gitignore
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -71,8 +70,8 @@ homepage: http://github.com/Druwerd/caplock
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -96,10 +95,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.5
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Adds a lock file to Capistrano deployments
-test_files: 
-- test/helper.rb
-- test/test_caplock.rb
+test_files: []
+

data/.gitignore

@@ -1,21 +0,0 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-
-## PROJECT::SPECIFIC