capistrano-rsync-bladrak 1.2.5 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c292534b215c3e190ddc2cf0d1679349778a1bb
-  data.tar.gz: fca9478f8f74d08aecd1bdf47f8a116ad3829b08
+  metadata.gz: 807a60625c48a8eba047ac449acf315706156f32
+  data.tar.gz: 5959c263fb5d10d885f9d428ea6311a23e37a669
 SHA512:
-  metadata.gz: cbde298a345a19d5866f21a3caa35c21fd8040e3cf543d8c6823468b95fe055432e0f9f95a9648de51ddf30ca4dd93268ab3625de447aa1152f11b9219870e79
-  data.tar.gz: 0652255fa8aafd1ec57d96b5869f8ad6c0527023255a1b6ecc6a2707ca71e38519d4dbda267390673dca6d0d55b4c209ba8c14c601dcab8c34432a206638b26b
+  metadata.gz: 463245fbcbdf42fbac964dc248cb86f438fd55de05b2758c8619051df4f4703299fe20258e318c25646c4e61080c46f203820e64da78416c558b313b6abd31ef
+  data.tar.gz: 1cc5a61fb949f298f275272fc5e78f184bcf70e54009c4bf63797142ae3c7ab89b971bef3422ed9fbd20546b0f73d916642c6cd4dc7dde8731ae266a8d427d66

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 1.3.0 (Jul 2, 2015)
+- Refactored library to use run_locally and execute from Capistrano, so the output is uniformized & we exit on failed commands
+- Added some options as well (see README.md for complete list)
+- [BC BREAK] Execution context may have changed, if you've overridden some options taking into account execution path for instance.
+
 ## 1.1.0 (Jan 17, 2015)
 - Added ``:rsync_sparse_checkout`` option
 

data/README.md

@@ -1,13 +1,15 @@
 Capistrano::Rsync for Capistrano v3
 ===================================
 
-This repository is a fork of https://github.com/moll/capistrano-rsync which doesn't seem to be maintained anymore.
-
-It has all the capabilities of the original repo, and some other features. Moreover, I will try to maintain it.  
+[![Join the chat at https://gitter.im/Bladrak/capistrano-rsync](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/Bladrak/capistrano-rsync?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 [![Gem Version](https://badge.fury.io/rb/capistrano-rsync-bladrak.svg)](http://badge.fury.io/rb/capistrano-rsync-bladrak)
 [gem-badge]: https://badge.fury.io/rb/capistrano-rsync-bladrak.svg
 
+This repository is a fork of https://github.com/moll/capistrano-rsync which doesn't seem to be maintained anymore.
+
+It has all the capabilities of the original repo, and some other features. Moreover, I will try to maintain it.  
+
 **Deploy with Rsync** to your server from any local (or remote) repository when
 using [**Capistrano**](http://www.capistranorb.com/).  Saves you from having to
 install Git on your production machine and allows you to customize which files
@@ -42,9 +44,9 @@ Install with:
 gem install capistrano-rsync-bladrak
 ```
 
-Require it at the top of your `Capfile` (or `config/deploy.rb`):
-```ruby
-require "capistrano/rsync"
+Set rsync as the SCM to use
+```
+set :scm, :rsync
 ```
 
 Set some `rsync_options` to your liking:
@@ -82,7 +84,7 @@ set :rsync_options, %w[
 ```
 
 ### Precompile assets before deploy
-Capistrano::Rsync runs `rsync:stage` before rsyncing. Hook to that like this:
+Capistrano::Rsync runs `rsync:stage_done` before rsyncing. Hook to that like this:
 ```ruby
 task :precompile do
   Dir.chdir fetch(:rsync_stage) do
@@ -90,7 +92,7 @@ task :precompile do
   end
 end
 
-after "rsync:stage", "precompile"
+after "rsync:stage_done", "precompile"
 ```
 
 ### Deploy release without symlinking the current directory
@@ -98,6 +100,23 @@ after "rsync:stage", "precompile"
 cap rsync:release
 ```
 
+Troubleshooting
+---------------
+If you need to hook after rsync:stage_done in your deploy.rb, the rsync namespace is not loaded yet.
+
+So do it like this in your deploy.rb:
+```
+namespace :rsync do
+    # Create an empty task to hook with. Implementation will be come next
+    task :stage_done
+
+    # Then add your hook
+    after :stage_done, :my_task do
+      # Do some stuff.
+    end
+end
+```
+
 
 Configuration
 -------------
@@ -112,6 +131,10 @@ rsync_cache   | `shared/deploy` | Path where to cache your repository on the ser
 rsync_options | `[]` | Array of options to pass to `rsync`.
 rsync_sparse_checkout | `[]` | Array of directories to checkout (checks out all if empty)
 rsync_depth   | `1` | Sets the --depth argument value for the git operations; this is set to 1 by default as you won't need the git history
+rsync_checkout_tag  | `false` | Is the ``:branch`` symbol containing a branch or a tag?
+rsync_copy    | `rsync --archive --acls --xattrs` | The command used to copy from remote cache to remote release
+rsync_target_dir | `.` | The local directory within ``:rsync_stage`` to clone to & deploy (useful if you want to keep cache of several branches/tags for instance)
+enable_git_submodules | `false` | Should we fetch submodules as well?
 
 
 License

data/lib/capistrano/rsync/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Rsync
-    VERSION = "1.2.5"
+    VERSION = "1.3.0"
   end
 end

data/lib/capistrano/rsync.rb

@@ -1,29 +1,30 @@
 require File.expand_path("../rsync/version", __FILE__)
 
-namespace :load do
-  task :defaults do
+set_if_empty :rsync_options, [
+  '--archive'
+]
+set_if_empty :rsync_copy, "rsync --archive --acls --xattrs"
 
-    set :rsync_options, []
-    set :rsync_copy, "rsync --archive --acls --xattrs"
+# Sparse checkout allows to checkout only part of the repository
+set_if_empty :rsync_sparse_checkout, []
 
-    # Sparse checkout allows to checkout only part of the repository
-    set :rsync_sparse_checkout, []
+# Sparse checkout allows to checkout only part of the repository
+set_if_empty :rsync_checkout_tag, false
 
-    # You may not need the whole history, put to false to get it whole
-    set :rsync_depth, 1
+# You may not need the whole history, put to false to get it whole
+set_if_empty :rsync_depth, 1
 
-    # Stage is used on your local machine for rsyncing from.
-    set :rsync_stage, "tmp/deploy"
+# Stage is used on your local machine for rsyncing from.
+set_if_empty :rsync_stage, "tmp/deploy"
 
-    # Cache is used on the server to copy files to from to the release directory.
-    # Saves you rsyncing your whole app folder each time.  If you nil rsync_cache,
-    # Capistrano::Rsync will sync straight to the release path.
-    set :rsync_cache, "shared/deploy"
+# Cache is used on the server to copy files to from to the release directory.
+# Saves you rsyncing your whole app folder each time.  If you nil rsync_cache,
+# Capistrano::Rsync will sync straight to the release path.
+set_if_empty :rsync_cache, "shared/deploy"
 
-    set :rsync_target_dir, ""
-  end
-end
+set_if_empty :rsync_target_dir, "."
 
+set_if_empty :enable_git_submodules, false
 
 # NOTE: Please don't depend on tasks without a description (`desc`) as they
 # might change between minor or patch version releases. They make up the
@@ -41,19 +42,37 @@ rsync_target = lambda do
   target
 end
 
+rsync_branch = lambda do
+  branch = !!fetch(:rsync_checkout_tag, false) ? "tags/#{fetch(:branch)}" : fetch(:branch)
+  branch
+end
+
+git_depth = lambda do
+  depth = !!fetch(:rsync_depth, false) ? "--depth=#{fetch(:rsync_depth)}" : ""
+  depth
+end
+
+git_depth_clone = lambda do
+  depth = !!fetch(:rsync_depth, false) ? "--depth=#{fetch(:rsync_depth)} --no-single-branch" : ""
+  depth
+end
+
 Rake::Task["deploy:check"].enhance ["rsync:hook_scm"]
 
+# Local -> Remote cache
 desc "Stage and rsync to the server (or its cache)."
-task :rsync => %w[rsync:stage] do
+task :rsync => %w[rsync:stage_done] do
   on release_roles(:all) do |role|
     user = role.user + "@" if !role.user.nil?
 
-    rsync = %w[rsync]
-    rsync.concat fetch(:rsync_options)
-    rsync << File.join(fetch(:rsync_stage), File.join(fetch(:rsync_target_dir), ""))
-    rsync << "#{user}#{role.hostname}:#{rsync_cache.call || release_path}"
-
-    Kernel.system *rsync
+    run_locally do
+      within fetch(:rsync_stage) do
+        execute :rsync,
+            fetch(:rsync_options),
+            fetch(:rsync_target_dir),
+            "#{user}#{role.hostname}:#{rsync_cache.call || release_path}"
+      end
+    end
   end
 end
 
@@ -94,74 +113,66 @@ namespace :rsync do
     end
   end
 
+  # Git first time -> Local
   task :create_stage do
     next if File.directory?(fetch(:rsync_stage))
     next if !has_roles?
 
     if fetch(:rsync_sparse_checkout, []).any?
-      init = %W[git init --quiet]
-      init << fetch(:rsync_stage)
-
-      Kernel.system *init
-
-      Dir.chdir fetch(:rsync_stage) do
-        remote = %W[git remote add origin]
-        remote << fetch(:repo_url)
-        Kernel.system *remote
-
-        fetch = %W[git fetch --quiet --prune --all -t]
-        if !!fetch(:rsync_depth, false)
-          fetch << "--depth=#{fetch(:rsync_depth)}"
-        end
-        Kernel.system *fetch
-
-        sparse = %W[git config core.sparsecheckout true]
-        Kernel.system *sparse
-
-        sparse_dir = %W[mkdir .git/info]
-        Kernel.system *sparse_dir
-
-        open('.git/info/sparse-checkout', 'a') { |f|
-          fetch(:rsync_sparse_checkout).each do |sparse_dir|
-            f.puts sparse_dir
-          end
-        }
-
-        pull = %W[git pull --quiet]
-        if !!fetch(:rsync_depth, false)
-          pull << "--depth=#{fetch(:rsync_depth)}"
+      run_locally do
+        execute :git, :init, '--quiet', fetch(:rsync_stage)
+        within fetch(:rsync_stage) do
+          execute :git, :remote, :add, :origin, fetch(:repo_url)
+
+          execute :git, :fetch, '--quiet --prune --all -t', "#{git_depth.call}"
+
+          execute :git, :config, 'core.sparsecheckout true'
+          execute :mkdir, '.git/info'
+          open(File.join(fetch(:rsync_stage), '.git/info/sparse-checkout'), 'a') { |f|
+            fetch(:rsync_sparse_checkout).each do |sparse_dir|
+              f.puts sparse_dir
+            end
+          }
+
+          execute :git, :pull, '--quiet', "#{git_depth.call}", :origin, "#{rsync_branch.call}"
         end
-        pull << "origin"
-        pull << rsync_target.call
-        Kernel.system *pull
       end
     else
-      clone = %W[git clone --quiet]
-      clone << fetch(:repo_url, ".")
-      clone << fetch(:rsync_stage)
-      if !!fetch(:rsync_depth, false)
-        clone << "--depth=#{fetch(:rsync_depth)}"
+      submodules = !!fetch(:enable_git_submodules) ? "--recursive" : ""
+      run_locally do
+        execute :git,
+          :clone,
+          '--quiet',
+          fetch(:repo_url),
+          fetch(:rsync_stage),
+          "#{git_depth_clone.call}",
+          "#{submodules}"
       end
-      Kernel.system *clone
     end
   end
 
+  # Git update -> Local
   desc "Stage the repository in a local directory."
   task :stage => %w[create_stage] do
     next if !has_roles?
 
-    Dir.chdir fetch(:rsync_stage) do
-      update = %W[git fetch --quiet --all --prune]
-      if !!fetch(:rsync_depth, false)
-        update << "--depth=#{fetch(:rsync_depth)}"
-      end
-      Kernel.system *update
+    run_locally do
+      within fetch(:rsync_stage) do
+        tags = !!fetch(:rsync_checkout_tag, false) ? '--tags' : ''
+        execute :git, :fetch, '--quiet --all --prune', "#{tags}", "#{git_depth.call}"
+
+        execute :git, :reset, '--quiet', '--hard', "#{rsync_target.call}"
 
-      checkout = %W[git reset --quiet --hard #{rsync_target.call}]
-      Kernel.system *checkout
+        if fetch(:enable_git_submodules)
+          execute :git, :submodule, :update
+        end
+      end
     end
   end
 
+  task :stage_done => %w[stage]
+
+  # Remote Cache -> Remote Release
   desc "Copy the code to the releases directory."
   task :release => %w[rsync] do
     # Skip copying if we've already synced straight to the release directory.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-rsync-bladrak
 version: !ruby/object:Gem::Version
-  version: 1.2.5
+  version: 1.3.0
 platform: ruby
 authors:
 - Hugo Briand, Andri Möll
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-05 00:00:00.000000000 Z
+date: 2015-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano