capistrano_rsync_with_remote_cache 2.3.5 → 2.3.6

data/README.md

@@ -0,0 +1,36 @@
+# Capistrano rsync_with_remote_cache
+
+This gem provides a deployment strategy for Capistrano which combines `rsync` with a remote cache, allowing fast deployments from Subversion repositories behind firewalls.
+
+## Requirements
+
+This gem requires Capistrano 2.0.0 or higher. Git support requires Capistrano 2.1.0 or higher.
+
+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 `rsync` command line utilities on the local and remote hosts. It also requires either `svn`, `git`, `hg` or `bzr` 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.
+
+## Using the strategy
+
+To use this deployment strategy, add this line to your `deploy.rb` file:
+
+    set :deploy_via, :rsync_with_remote_cache
+
+## How it works
+
+This strategy maintains two cache directories:
+
+* The local cache directory is a checkout from the SCM repository. The local cache directory is specified with the `local_cache` variable in the configuration. If not specified, it will default to `.rsync_cache` in the same directory as the Capfile.
+* The remote cache directory is an `rsync` copy of the local cache directory. The remote cache directory is specified with the `repository_cache` variable in the configuration (this name comes from the `remote_cache` strategy that ships with Capistrano, and has been maintained for compatibility.) If not specified, it will default to `shared/cached-copy` (again, for compatibility with remote_cache.)
+
+Deployment happens in three major steps. First, the local cache directory is processed. There are three possibilities:
+
+* If the local cache does not exist, it is created with a checkout of the revision to be deployed.
+* If the local cache exists and matches the `:repository` variable, it is updated to the revision to be deployed.
+* If the local cache exists and does not match the `:repository` variable, the local cache is purged and recreated with a checkout of the revision to be deployed.
+
+Second, `rsync` runs on the local side to sync the remote cache to the local cache. When the `rsync` is complete, the remote cache should be an exact replica of the local cache.
+
+Finally, a copy of the remote cache is made in the appropriate release directory. The end result is the same as if the code had been checked out directly on the remote server, as in the default strategy.

data/Rakefile

@@ -12,9 +12,11 @@ begin
     gem.authors = ["Mark Cornick"]
     gem.rubyforge_project = "viget"
     gem.add_dependency 'capistrano', '>= 2.0'
+    gem.add_development_dependency "thoughtbot-shoulda"
+    gem.add_development_dependency "yard"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
-
+  Jeweler::GemcutterTasks.new
   Jeweler::RubyforgeTasks.new do |rubyforge|
     rubyforge.doc_task = "yardoc"
   end
@@ -43,6 +45,8 @@ rescue LoadError
   end
 end
 
+task :test => :check_dependencies
+
 begin
   require 'reek/rake_task'
   Reek::RakeTask.new do |t|
@@ -72,9 +76,11 @@ task :default => :test
 
 begin
   require 'yard'
-  YARD::Rake::YardocTask.new
+  YARD::Rake::YardocTask.new do |t|
+    t.options = ['--private']
+  end
 rescue LoadError
   task :yardoc do
-    abort "Yard is not available. In order to run yardoc, you must: sudo gem install yard"
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
   end
 end

data/VERSION

@@ -1 +1 @@
-2.3.5
+2.3.6

data/capistrano_rsync_with_remote_cache.gemspec

@@ -5,22 +5,22 @@
 
 Gem::Specification.new do |s|
   s.name = %q{capistrano_rsync_with_remote_cache}
-  s.version = "2.3.5"
+  s.version = "2.3.6"
 
   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.date = %q{2009-09-08}
   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"
+     "README.md"
   ]
   s.files = [
     ".document",
      ".gitignore",
      "LICENSE",
-     "README.rdoc",
+     "README.md",
      "Rakefile",
      "VERSION",
      "capistrano_rsync_with_remote_cache.gemspec",
@@ -46,10 +46,16 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<capistrano>, [">= 2.0"])
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
     else
       s.add_dependency(%q<capistrano>, [">= 2.0"])
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
     end
   else
     s.add_dependency(%q<capistrano>, [">= 2.0"])
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
   end
 end

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

@@ -24,7 +24,7 @@ module Capistrano
           # Step 2: Update the remote cache.
           logger.trace "copying local cache to remote"
           find_servers(:except => { :no_release => true }).each do |server|
-            system("rsync #{rsync_options} #{local_cache}/ #{rsync_host(server)}:#{repository_cache}/")
+            system("rsync #{rsync_options} --rsh='ssh -p #{ssh_port}' #{local_cache}/ #{rsync_host(server)}:#{repository_cache}/")
           end
 
           # Step 3: Copy the remote cache into place.
@@ -61,6 +61,10 @@ module Capistrano
           configuration[:rsync_options] || "-az --delete"
         end
 
+        def ssh_port
+          ssh_options[:port] || 22
+        end
+
         # Returns the host used in the rsync command, prefixed with user@ if user is specified in Capfile.
         def rsync_host(server)
           if configuration[:user]

data/test/capistrano_rsync_with_remote_cache_test.rb

@@ -9,9 +9,8 @@ class CapistranoRsyncWithRemoteCacheTest < Test::Unit::TestCase
     @rwrc.expects(:configuration).at_least_once.returns(hash)
   end
 
-  def stub_detection_of_changed_local_cache(command, returned)
-    File.expects(:directory?).with('.rsync_cache').returns(true)
-    IO.expects(:popen).with(command).returns(returned)
+  def stub_ssh_options(hash)
+    @rwrc.expects(:ssh_options).at_least_once.returns(hash)
   end
 
   context 'RsyncWithRemoteCache' do
@@ -24,6 +23,7 @@ class CapistranoRsyncWithRemoteCacheTest < Test::Unit::TestCase
 
     should 'deploy!' do
       stub_configuration(:deploy_to => 'deploy_to', :release_path => 'release_path', :scm => :subversion)
+      stub_ssh_options(:port => nil)
       @rwrc.stubs(:shared_path).returns('shared')
 
       # Step 1: Update the local cache.
@@ -35,7 +35,7 @@ class CapistranoRsyncWithRemoteCacheTest < Test::Unit::TestCase
 
       # Step 2: Update the remote cache.
       server_stub = stub(:host => 'host')
-      @rwrc.expects(:system).with("rsync -az --delete .rsync_cache/ host:shared/cached-copy/")
+      @rwrc.expects(:system).with("rsync -az --delete --rsh='ssh -p 22' .rsync_cache/ host:shared/cached-copy/")
       @rwrc.expects(:find_servers).returns([server_stub])
 
       # Step 3: Copy the remote cache into place.
@@ -96,6 +96,18 @@ class CapistranoRsyncWithRemoteCacheTest < Test::Unit::TestCase
       end
     end
 
+    context 'ssh_port' do
+      should 'return specified port if present in configuration' do
+        stub_ssh_options(:port => 2222)
+        assert_equal 2222, @rwrc.send(:ssh_port)
+      end
+
+      should 'return default port if not present in configuration' do
+        stub_ssh_options(:port => nil)
+        assert_equal 22, @rwrc.send(:ssh_port)
+      end
+    end
+
     context 'rsync_host' do
       setup do
         @server_stub = stub(:host => 'host')
@@ -113,35 +125,18 @@ class CapistranoRsyncWithRemoteCacheTest < Test::Unit::TestCase
     end
 
     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("cd .rsync_cache && svn info . | sed -n 's/URL: //p'", "URL: url\n")
-        FileUtils.expects(:rm_rf).with('.rsync_cache')
-        @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_detection_of_changed_local_cache("cd .rsync_cache && git config remote.origin.url", "beep\n")
-        FileUtils.expects(:rm_rf).with('.rsync_cache')
-        @rwrc.send(:remove_cache_if_repo_changed)
-      end
-
-      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
+      [:subversion, :git, :mercurial, :bzr].each do |scm|
+        should "purge local cache if it detects #{scm} info has changed" do
+          stub_configuration(:scm => scm, :repository => 'repository')
+          info_command = Capistrano::Deploy::Strategy::RsyncWithRemoteCache::INFO_COMMANDS[scm]
+          File.expects(:directory?).with('.rsync_cache').returns(true)
+          IO.expects(:popen).with("cd .rsync_cache && #{info_command}").returns('abc')
+          FileUtils.expects(:rm_rf).with('.rsync_cache')
+          @rwrc.send(:remove_cache_if_repo_changed)
+        end
+      end
+
+      should 'not attempt to purge local cache if it does not exist' do
         stub_configuration(:scm => :subversion, :repository => 'repository')
         File.expects(:directory?).with('.rsync_cache').returns(false)
         FileUtils.expects(:rm_rf).with('.rsync_cache').never

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: capistrano_rsync_with_remote_cache
 version: !ruby/object:Gem::Version 
-  version: 2.3.5
+  version: 2.3.6
 platform: ruby
 authors: 
 - Mark Cornick
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-07 00:00:00 -04:00
+date: 2009-09-08 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,6 +22,26 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "2.0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: A deployment strategy for Capistrano 2.0 which combines rsync with a remote cache, allowing fast deployments from SCM servers behind firewalls.
 email: mark@viget.com
 executables: []
@@ -30,12 +50,12 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.md
 files: 
 - .document
 - .gitignore
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - capistrano_rsync_with_remote_cache.gemspec

data/README.rdoc

@@ -1,36 +0,0 @@
-= Capistrano rsync_with_remote_cache
-
-This gem provides a deployment strategy for Capistrano which combines rsync with a remote cache, allowing fast deployments from Subversion repositories behind firewalls.
-
-== Requirements
-
-This gem requires Capistrano 2.0.0 or higher. Git support requires Capistrano 2.1.0 or higher.
-
-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>, <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.
-
-== Using the strategy
-
-To use this deployment strategy, add this line to your <tt>deploy.rb</tt> file:
-
-    set :deploy_via, :rsync_with_remote_cache
-
-== How it works
-
-This strategy maintains two cache directories:
-
-* The local cache directory is a checkout from the SCM repository. The local cache directory is specified with the <tt>local_cache</tt> variable in the configuration. If not specified, it will default to <tt>.rsync_cache</tt> in the same directory as the Capfile.
-* The remote cache directory is an rsync copy of the local cache directory. The remote cache directory is specified with the <tt>repository_cache</tt> variable in the configuration (this name comes from the <tt>remote_cache</tt> strategy that ships with Capistrano, and has been maintained for compatibility.) If not specified, it will default to <tt>shared/cached-copy</tt> (again, for compatibility with remote_cache.)
-
-Deployment happens in three major steps. First, the local cache directory is processed. There are three possibilities:
-
-* If the local cache does not exist, it is created with a checkout of the revision to be deployed.
-* If the local cache exists and matches the <tt>:repository</tt> variable, it is updated to the revision to be deployed.
-* If the local cache exists and does not match the <tt>:repository</tt> variable, the local cache is purged and recreated with a checkout of the revision to be deployed.
-
-Second, rsync runs on the local side to sync the remote cache to the local cache. When the rsync is complete, the remote cache should be an exact replica of the local cache.
-
-Finally, a copy of the remote cache is made in the appropriate release directory. The end result is the same as if the code had been checked out directly on the remote server, as in the default strategy.