capistrano_rsync_with_remote_cache 2.3.4 → 2.3.5

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+/pkg/
+/doc/
+/coverage/
+*.gem
+.yardoc

data/README.rdoc

@@ -6,9 +6,9 @@ This gem provides a deployment strategy for Capistrano which combines rsync with
 
 This gem requires Capistrano 2.0.0 or higher. Git support requires Capistrano 2.1.0 or higher.
 
-This gem has only been tested with Subversion and Git. It is unlikely to be supported for other SCM systems.
+This gem supports Subversion, Git, Mercurial and Bazaar. Only Subversion and Git have been extensively tested. This gem is unlikely to be supported for other SCM systems.
 
-This gem requires <tt>rsync</tt> command line utilities on the local and remote hosts. It also requires either <tt>svn</tt> or <tt>git</tt> on the local host, but not the remote host.
+This gem requires <tt>rsync</tt> command line utilities on the local and remote hosts. It also requires either <tt>svn</tt>, <tt>git</tt>, <tt>hg</tt> or <hg>bzr</hg> on the local host, but not the remote host.
 
 This gem is tested on Mac OS X and Linux. Windows is not tested or supported.
 

data/Rakefile

@@ -12,18 +12,21 @@ begin
     gem.authors = ["Mark Cornick"]
     gem.rubyforge_project = "viget"
     gem.add_dependency 'capistrano', '>= 2.0'
-
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
+
+  Jeweler::RubyforgeTasks.new do |rubyforge|
+    rubyforge.doc_task = "yardoc"
+  end
 rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
 end
 
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
   test.pattern = 'test/**/*_test.rb'
-  test.verbose = false
+  test.verbose = true
 end
 
 begin
@@ -36,50 +39,42 @@ begin
   end
 rescue LoadError
   task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install relevance-rcov"
   end
 end
 
-
-task :default => :test
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  if File.exist?('VERSION.yml')
-    config = YAML.load(File.read('VERSION.yml'))
-    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
-  else
-    version = ""
+begin
+  require 'reek/rake_task'
+  Reek::RakeTask.new do |t|
+    t.fail_on_error = true
+    t.verbose = false
+    t.source_files = 'lib/**/*.rb'
+  end
+rescue LoadError
+  task :reek do
+    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
   end
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "capistrano_rsync_with_remote_cache #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
 begin
-  require 'rake/contrib/sshpublisher'
-  namespace :rubyforge do
-    
-    desc "Release gem and RDoc documentation to RubyForge"
-    task :release => ["rubyforge:release:gem"]
-    
-    namespace :release do
-      desc "Publish RDoc to RubyForge."
-      task :docs => [:rdoc] do
-        config = YAML.load(
-            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
-        )
+  require 'roodi'
+  require 'roodi_task'
+  RoodiTask.new do |t|
+    t.verbose = false
+  end
+rescue LoadError
+  task :roodi do
+    abort "Roodi is not available. In order to run roodi, you must: sudo gem install roodi"
+  end
+end
 
-        host = "#{config['username']}@rubyforge.org"
-        remote_dir = "/var/www/gforge-projects/capistrano_rsync_with_remote_cache/"
-        local_dir = 'rdoc'
+task :default => :test
 
-        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
-      end
-    end
-  end
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
 rescue LoadError
-  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
+  task :yardoc do
+    abort "Yard is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
 end

data/VERSION

@@ -0,0 +1 @@
+2.3.5

data/capistrano_rsync_with_remote_cache.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{capistrano_rsync_with_remote_cache}
+  s.version = "2.3.5"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mark Cornick"]
+  s.date = %q{2009-08-07}
+  s.description = %q{A deployment strategy for Capistrano 2.0 which combines rsync with a remote cache, allowing fast deployments from SCM servers behind firewalls.}
+  s.email = %q{mark@viget.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "capistrano_rsync_with_remote_cache.gemspec",
+     "lib/capistrano/recipes/deploy/strategy/exceptions.reek",
+     "lib/capistrano/recipes/deploy/strategy/rsync_with_remote_cache.rb",
+     "test/capistrano_rsync_with_remote_cache_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/vigetlabs/capistrano_rsync_with_remote_cache}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{viget}
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{rsync_with_remote_cache strategy for Capistrano}
+  s.test_files = [
+    "test/capistrano_rsync_with_remote_cache_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<capistrano>, [">= 2.0"])
+    else
+      s.add_dependency(%q<capistrano>, [">= 2.0"])
+    end
+  else
+    s.add_dependency(%q<capistrano>, [">= 2.0"])
+  end
+end

data/lib/capistrano/recipes/deploy/strategy/exceptions.reek

@@ -0,0 +1,15 @@
+---
+Duplication:
+  exclude:
+  - check!
+  - command
+  - deploy!
+  - rsync_host
+  - remove_cache_if_repo_changed
+
+FeatureEnvy:
+  exclude:
+  - check!
+
+LongMethod: 
+  max_statements: 10

data/lib/capistrano/recipes/deploy/strategy/rsync_with_remote_cache.rb

@@ -6,13 +6,20 @@ module Capistrano
     module Strategy
       class RsyncWithRemoteCache < Remote
 
+        INFO_COMMANDS = {
+          :subversion => "svn info . | sed -n \'s/URL: //p\'",
+          :git        => "git config remote.origin.url",
+          :mercurial  => "hg showconfig paths.default",
+          :bzr        => "bzr info | grep parent | sed \'s/^.*parent branch: //\'"
+        }
+
         # The deployment method itself, in three major steps: update the local cache, update the remote
         # cache, and copy the remote cache into place.
         def deploy!
 
           # Step 1: Update the local cache.
           system(command)
-          File.open(File.join(local_cache, "REVISION"), "w") { |f| f.puts(revision) }
+          File.open(File.join(local_cache, "REVISION"), "w") { |file| file.puts(revision) }
 
           # Step 2: Update the remote cache.
           logger.trace "copying local cache to remote"
@@ -28,10 +35,10 @@ module Capistrano
         # on the local end, and rsync on both ends. Note that the SCM command is not needed on the
         # remote end.
         def check!
-          super.check do |d|
-            d.local.command(source.command)
-            d.local.command('rsync')
-            d.remote.command('rsync')
+          super.check do |check|
+            check.local.command(source.command)
+            check.local.command('rsync')
+            check.remote.command('rsync')
           end
         end
 
@@ -63,41 +70,34 @@ module Capistrano
           end
         end
 
-        # Command to get source from SCM on the local side. If the local_cache directory exists,
-        # we check to see if it's an SCM checkout that matches the currently configured repository.
-        # If it matches, we update it. If it doesn't match (either it's for another repository or
-        # not a checkout at all), we remove the directory and recreate it with a fresh SCM checkout.
-        # If the directory doesn't exist, we create it with a fresh SCM checkout.
+        # Remove the local cache (so it can be recreated) if the repository URL has changed
+        # since the last deployment.
         # TODO: punt in some sensible way if local_cache exists but is a regular file.
-        def command
-          case configuration[:scm].to_s
-          when 'subversion'
-            info_command = "svn info #{local_cache} | sed -n 's/URL: //p'"
-          when 'git'
-            info_command = "cd #{local_cache} && git config remote.origin.url"
-          else
-            # an effective no-op
-            info_command = "echo #{configuration[:repository]}"
-          end
-          cache_info = IO.popen(info_command)
-
-          cached_repository = cache_info.gets
-          cache_info.close
-          if cached_repository && cached_repository.chomp != configuration[:repository]
-            logger.trace "repository has changed; removing old local cache"
-            FileUtils.rm_rf local_cache
+        def remove_cache_if_repo_changed
+          if INFO_COMMANDS[configuration[:scm]] && File.directory?(local_cache)
+            info_command = "cd #{local_cache} && #{INFO_COMMANDS[configuration[:scm]]}"
+            cached_repo_url = IO.popen(info_command){|pipe| pipe.readline}.chomp
+            if cached_repo_url != configuration[:repository]
+              logger.trace "repository has changed; removing old local cache"
+              FileUtils.rm_rf(local_cache)
+            end
           end
+        end
 
+        # Command to get source from SCM on the local side. The local cache is either created,
+        # updated, or destroyed and recreated depending on whether it exists and is a cache of
+        # the right repository.
+        def command
+          remove_cache_if_repo_changed
           if File.exists?(local_cache) && File.directory?(local_cache)
             logger.trace "updating local cache to revision #{revision}"
-            cmd = source.sync(revision, local_cache)
+            return source.sync(revision, local_cache)
           else
             logger.trace "creating local cache with revision #{revision}"
             File.delete(local_cache) if File.exists?(local_cache)
             Dir.mkdir(File.dirname(local_cache)) unless File.directory?(File.dirname(local_cache))
-            cmd = source.checkout(revision, local_cache)
+            return source.checkout(revision, local_cache)
           end
-          cmd
         end
       end
     end

data/test/capistrano_rsync_with_remote_cache_test.rb

@@ -9,20 +9,9 @@ class CapistranoRsyncWithRemoteCacheTest < Test::Unit::TestCase
     @rwrc.expects(:configuration).at_least_once.returns(hash)
   end
 
-  def stub_creation_of_new_local_cache
-    File.expects(:exists?).with('.rsync_cache').times(2).returns(false)
-    File.expects(:directory?).with(File.dirname('.rsync_cache')).returns(false)
-    Dir.expects(:mkdir).with(File.dirname('.rsync_cache'))
-    source_stub = stub()
-    source_stub.expects(:checkout)
-    @rwrc.expects(:source).returns(source_stub)
-  end
-
-  def stub_detection_of_changed_local_cache(command, returns)
-    cache_info_stub = stub()
-    cache_info_stub.expects(:gets).returns(returns)
-    cache_info_stub.expects(:close)
-    IO.expects(:popen).with(command).returns(cache_info_stub)
+  def stub_detection_of_changed_local_cache(command, returned)
+    File.expects(:directory?).with('.rsync_cache').returns(true)
+    IO.expects(:popen).with(command).returns(returned)
   end
 
   context 'RsyncWithRemoteCache' do
@@ -123,56 +112,66 @@ class CapistranoRsyncWithRemoteCacheTest < Test::Unit::TestCase
       end
     end
 
-    context 'command' do
+    context 'remove_cache_if_repo_changed' do
       should 'purge local cache if it detects subversion info has changed' do
-        stub_configuration(:scm => :subversion, :repository => 'repository')        
-        stub_detection_of_changed_local_cache("svn info .rsync_cache | sed -n 's/URL: //p'", "URL: url\n")
+        stub_configuration(:scm => :subversion, :repository => 'repository')
+        stub_detection_of_changed_local_cache("cd .rsync_cache && svn info . | sed -n 's/URL: //p'", "URL: url\n")
         FileUtils.expects(:rm_rf).with('.rsync_cache')
-        stub_creation_of_new_local_cache
-
-        @rwrc.send(:command)
+        @rwrc.send(:remove_cache_if_repo_changed)
       end
 
       should 'purge local cache if it detects git info has changed' do
-        stub_configuration(:scm => :git, :repository => 'repository')        
+        stub_configuration(:scm => :git, :repository => 'repository')
         stub_detection_of_changed_local_cache("cd .rsync_cache && git config remote.origin.url", "beep\n")
         FileUtils.expects(:rm_rf).with('.rsync_cache')
-        stub_creation_of_new_local_cache
+        @rwrc.send(:remove_cache_if_repo_changed)
+      end
 
-        @rwrc.send(:command)
+      should 'purge local cache if it detects hg info has changed' do
+        stub_configuration(:scm => :mercurial, :repository => 'repository')
+        stub_detection_of_changed_local_cache("cd .rsync_cache && hg showconfig paths.default", "beep\n")
+        FileUtils.expects(:rm_rf).with('.rsync_cache')
+        @rwrc.send(:remove_cache_if_repo_changed)
+      end
+
+      should 'purge local cache if it detects bzr info has changed' do
+        stub_configuration(:scm => :bzr, :repository => 'repository')
+        stub_detection_of_changed_local_cache("cd .rsync_cache && bzr info | grep parent | sed 's/^.*parent branch: //'", "beep\n")
+        FileUtils.expects(:rm_rf).with('.rsync_cache')
+        @rwrc.send(:remove_cache_if_repo_changed)
       end
 
       should 'not attempt to purge local cache that does not exist' do
-        stub_configuration(:scm => :subversion, :repository => 'repository')        
-        stub_detection_of_changed_local_cache("svn info .rsync_cache | sed -n 's/URL: //p'", nil)
+        stub_configuration(:scm => :subversion, :repository => 'repository')
+        File.expects(:directory?).with('.rsync_cache').returns(false)
         FileUtils.expects(:rm_rf).with('.rsync_cache').never
-        stub_creation_of_new_local_cache
-
-        @rwrc.send(:command)
+        @rwrc.send(:remove_cache_if_repo_changed)
       end
 
       should 'not attempt to purge local cache if the scm is not supported by this gem' do
-        stub_configuration(:scm => :bzr, :repository => 'repository')        
-        stub_detection_of_changed_local_cache("echo repository", "repository\n")
+        stub_configuration(:scm => :cvs, :repository => 'repository')
         FileUtils.expects(:rm_rf).with('.rsync_cache').never
-        stub_creation_of_new_local_cache
-
-        @rwrc.send(:command)
+        @rwrc.send(:remove_cache_if_repo_changed)
       end
+    end
 
+    context 'command' do
       should 'update local cache if it exists' do
         File.expects(:exists?).with('.rsync_cache').returns(true)
         File.expects(:directory?).with('.rsync_cache').returns(true)
         source_stub = stub()
         source_stub.expects(:sync)
         @rwrc.expects(:source).returns(source_stub)
-
         @rwrc.send(:command)
       end
 
       should 'create local cache if it does not exist' do
-        stub_creation_of_new_local_cache
-
+        File.expects(:exists?).with('.rsync_cache').times(2).returns(false)
+        File.expects(:directory?).with(File.dirname('.rsync_cache')).returns(false)
+        Dir.expects(:mkdir).with(File.dirname('.rsync_cache'))
+        source_stub = stub()
+        source_stub.expects(:checkout)
+        @rwrc.expects(:source).returns(source_stub)
         @rwrc.send(:command)
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: capistrano_rsync_with_remote_cache
 version: !ruby/object:Gem::Version 
-  version: 2.3.4
+  version: 2.3.5
 platform: ruby
 authors: 
 - Mark Cornick
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-19 00:00:00 -04:00
+date: 2009-08-07 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,10 +32,14 @@ extra_rdoc_files:
 - LICENSE
 - README.rdoc
 files: 
+- .document
+- .gitignore
 - LICENSE
 - README.rdoc
 - Rakefile
-- VERSION.yml
+- VERSION
+- capistrano_rsync_with_remote_cache.gemspec
+- lib/capistrano/recipes/deploy/strategy/exceptions.reek
 - lib/capistrano/recipes/deploy/strategy/rsync_with_remote_cache.rb
 - test/capistrano_rsync_with_remote_cache_test.rb
 - test/test_helper.rb
@@ -63,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: viget
-rubygems_version: 1.3.2
+rubygems_version: 1.3.4
 signing_key: 
 specification_version: 3
 summary: rsync_with_remote_cache strategy for Capistrano

data/VERSION.yml

@@ -1,4 +0,0 @@
---- 
-:major: 2
-:minor: 3
-:patch: 4