capistrano_rsync_with_remote_cache 2.3.6 → 2.3.7

data/.document

@@ -1,4 +1,4 @@
-README.rdoc
+README.md
 lib/**/*.rb
 bin/*
 features/**/*.feature

data/VERSION

@@ -1 +1 @@
-2.3.6
+2.3.7

data/capistrano_rsync_with_remote_cache.gemspec

@@ -1,15 +1,15 @@
 # Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{capistrano_rsync_with_remote_cache}
-  s.version = "2.3.6"
+  s.version = "2.3.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mark Cornick"]
-  s.date = %q{2009-09-08}
+  s.date = %q{2010-03-12}
   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 = [
@@ -33,7 +33,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{viget}
-  s.rubygems_version = %q{1.3.4}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{rsync_with_remote_cache strategy for Capistrano}
   s.test_files = [
     "test/capistrano_rsync_with_remote_cache_test.rb",
@@ -59,3 +59,4 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<yard>, [">= 0"])
   end
 end
+

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

@@ -46,26 +46,34 @@ module Capistrano
 
         # Path to the remote cache. We use a variable name and default that are compatible with
         # the stock remote_cache strategy, for easy migration.
+        # @return [String] the path to the remote cache
         def repository_cache
           File.join(shared_path, configuration[:repository_cache] || "cached-copy")
         end
 
         # Path to the local cache. If not specified in the Capfile, we use an arbitrary default.
+        # @return [String] the path to the local cache
         def local_cache
           configuration[:local_cache] || ".rsync_cache"
         end
 
         # Options to use for rsync in step 2. If not specified in the Capfile, we use the default
         # from prior versions.
+        # @return [String] the options to be passed to rsync
         def rsync_options
           configuration[:rsync_options] || "-az --delete"
         end
 
+        # Port to use for rsync in step 2. If not specified with (ssh_options) in the Capfile, we
+        # use the default well-known port 22.
+        # @return [Fixnum] the port to connect to with rsync
         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.
+        # Get a hostname to be used in the rsync command.
+        # @param [Capistrano::ServerDefinition, #host] the host which rsync will connect to
+        # @return [String] the hostname, prefixed with user@ if necessary
         def rsync_host(server)
           if configuration[:user]
             "#{configuration[:user]}@#{server.host}"
@@ -79,7 +87,7 @@ module Capistrano
         # TODO: punt in some sensible way if local_cache exists but is a regular file.
         def remove_cache_if_repo_changed
           if INFO_COMMANDS[configuration[:scm]] && File.directory?(local_cache)
-            info_command = "cd #{local_cache} && #{INFO_COMMANDS[configuration[:scm]]}"
+            info_command = "cd #{File.expand_path(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"
@@ -91,6 +99,7 @@ module Capistrano
         # 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.
+        # @return [String] command to either checkout or update the local cache
         def command
           remove_cache_if_repo_changed
           if File.exists?(local_cache) && File.directory?(local_cache)

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: capistrano_rsync_with_remote_cache
 version: !ruby/object:Gem::Version 
-  version: 2.3.6
+  prerelease: false
+  segments: 
+  - 2
+  - 3
+  - 7
+  version: 2.3.7
 platform: ruby
 authors: 
 - Mark Cornick
@@ -9,39 +14,46 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-08 00:00:00 -04:00
+date: 2010-03-12 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: capistrano
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
         version: "2.0"
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: thoughtbot-shoulda
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: yard
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id003
 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: []
@@ -76,18 +88,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: viget
-rubygems_version: 1.3.4
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: rsync_with_remote_cache strategy for Capistrano