capistrano-rsync 0.2.1 → 1.0.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MTBjYTRmOWQ1NGZhMTAyYTFiMmMwYjcwNTVmNTI2Zjg4NTI2MDU2Nw==
+    OGIzNmE1Njc0MzhkZmI5MTAzMTMyMDZkNTczMWQ0NzNiMTczMzkyZA==
   data.tar.gz: !binary |-
-    YzcxZWE4YTIxNWVkY2Y1ZDY3YzhiZGFkNmMwNzFlNzVkNmU0MTEyOA==
+    Y2FmMDdmZGMyZDkyNmM5YTcwOGQxOTliNGJkYzVmMTUwOGU3YzkyNg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    NmE5YzQwZjE0NTE5ODcyNjI4YjE1ZGQ1NDQ4ZDY4MGE1NTM4YjJjM2FlMWYz
-    ZGY5MzQ5NGMxOTQxZTRhNGNlZjY5NWZkMjQ1NDY2ZjQzZGRjOTdlODI4Nzcz
-    MTFkNjA4OGQwZTAwYjQ5Y2Y2YjEwMDkxOWRkMDdhZTVjNzc2Mzk=
+    ZjFhNmQxMjJmYjFmNDE2OWIzMDZlYTkxZTI1NzIxZjEzNDdmOGNlMjNkMDZk
+    OTg1ZGE2Y2U0NWUwZTQ4ZWNiYzBjYzdhMDRjNGRlNWU5ZjAyOWE2YzI0ZmFl
+    YWQxNDVjZmRjZWFjOGYwZTY5MTk1ZDNkOWFhOTg1MDJjNmFmY2E=
   data.tar.gz: !binary |-
-    NGVmZTJmZTUwNWNmZWRhNjk5Njc3ZWUzODk4ZGU3NWI1MmRjYTAxZTBmZDBj
-    OTlkMmI5MzI0ZDVkZTlhNjMyMGY0ODc5YzIyOWRjMDAxY2UzM2ZkYWQ5MjM3
-    OTZlNTQ1ZGMwM2Q3ZjAzZjUxNjZiZmY1MmMwMmVkMDEzZGU0Mzc=
+    ZjRhMzVjZjg3NWRhOTY2MDZmYjUwMjg5YmU1MjMyMjZkNTE0YjY1MmViODll
+    OGJiNzExMGM2OWVjOTI1ODA3NDVjM2FhMDRiY2EwNjk0MThhNTZlNzk0MWFl
+    OTkzMDQ4Yjc3YTUwNDQwYWIxMDc3MDFhNjRjZjA2MDljNjA2OWQ=

data/CHANGELOG.md

@@ -1,12 +1,17 @@
-# 0.2.1 (Sep 1, 2013)
+## 1.0.0 (Sep 2, 2013)
+- Makes the `rsync:stage` task public for extending and hooking.
+- Rename `rsync:create_release` to `rsync:release`. Old name still works.
+- Adds optional caching to `rsync_cache` directory on the server.
+
+## 0.2.1 (Sep 1, 2013)
 - Fixes starting with no previous local repository cache.  
   Note to self: Avoid writing code without integration tests.
 
-# 0.2.0 (Sep 1, 2013)
+## 0.2.0 (Sep 1, 2013)
 - Passes user given in `role :app, "user@host"` to `rsync` if set.
 
-# 0.1.338 (Sep 1, 2013)
+## 0.1.338 (Sep 1, 2013)
 - Adds gem dependency on Capistrano v3.
 
-# 0.1.337 (Sep 1, 2013)
+## 0.1.337 (Sep 1, 2013)
 - First release. Let's get syncing!

data/README.md

@@ -2,11 +2,16 @@ Capistrano::Rsync for Capistrano v3
 ===================================
 [![Gem version](https://badge.fury.io/rb/capistrano-rsync.png)](http://badge.fury.io/rb/capistrano-rsync)
 
-Deploy with Rsync to your server from any local (or remote) repository.  
-Saves you from having to install Git on your production machine and allows you to customize which files you want to deploy.
+**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 you want to deploy. Allows also you to easily precompile things on your local machine before deploying.
 
-Works with the new [**Capistrano v3**](http://www.capistranorb.com/) and is suitable for deploying any apps, be it Ruby or Node.js.  
-Currently works **only with Git** (as does Capistrano v3), so please shout out your interest in other SCMs.
+### Tour
+- Works with the new [**Capistrano v3**](http://www.capistranorb.com/) ([source code](https://github.com/capistrano/capistrano)) versions `>= 3.0.0pre14` and `< 4`.
+- Suitable for deploying any apps, be it Ruby, Rails, Node.js or others.  
+- Exclude files from being deployed with Rsync's `--exclude` options.
+- Precompile files or assets easily before deploying, like JavaScript or CSS.
+- Caches your previously deployed code to speed up deployments ~1337%.
+- Currently works only with Git (as does Capistrano v3), so please shout out your interest in other SCMs.
 
 
 Using
@@ -16,10 +21,8 @@ Install with:
 gem install capistrano-rsync
 ```
 
-Require it at the top of your `Capfile`:
+Require it at the top of your `Capfile` or `config/deploy.rb`:
 ```ruby
-require "capistrano/setup"
-require "capistrano/deploy"
 require "capistrano/rsync"
 ```
 
@@ -33,10 +36,10 @@ And after setting regular Capistrano options, deploy as usual!
 cap deploy
 ```
 
-### How does it work?
+### Implementation
 Capistrano::Rsync clones your repository to `tmp/cache` on your local machine, checks out the branch set in the `branch` variable (`master` by default) and then Rsyncs that directory to your servers.
 
-### Excluding files from being deployed
+### Exclude files from being deployed
 If you don't want to deploy everything you've committed to your repository, pass some `--exclude` options to Rsync:
 ```ruby
 set :rsync_options, %w[
@@ -47,26 +50,35 @@ set :rsync_options, %w[
 ]
 ```
 
+### Precompile assets before deploy
+Capistrano::Rsync runs `rsync:stage` before rsyncing. Hook to that like this:
+```ruby
+task :precompile do
+  Dir.chdir fetch(:rsync_stage) do
+    system "rake", "assets:precompile"
+  end
+end
 
-Configuration
--------------
-Set Capistrano variables with `set name, value`.
+after "rsync:stage", "precompile"
+```
 
-#### branch
-The Git branch to checkout.  
-Defaults to `master`.
+### Deploy release without symlinking the current directory
+```
+cap rsync:release
+```
 
-#### repo_url
-The path or URL to a Git repository to clone from.  
-Defaults to `.`.
 
-#### rsync_stage 
-Location where to clone your repository for staging, checkouting and rsyncing.  
-Defaults to `tmp/cache`.
+Configuration
+-------------
+Set Capistrano variables with `set name, value`.
 
-#### rsync_options
-Array of options to pass to `rsync`.  
-Defaults to `[]`.
+Name          | Default | Description
+--------------|---------|------------
+branch        | `master` | The Git branch to checkout.  
+repo_url      | `.` | The path or URL to a Git repository to clone from.  
+rsync_stage   | `tmp/deploy` | Path where to clone your repository for staging, checkouting and rsyncing. Can be both relative or absolute.
+rsync_cache   | `shared/deploy` | Path where to cache your repository on the server to avoid rsyncing from scratch each time. Can be both relative or absolute.<br> Set to `nil` if you want to disable the cache.
+rsync_options | `[]` | Array of options to pass to `rsync`.  
 
 
 License

data/lib/capistrano/rsync/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Rsync
-    VERSION = "0.2.1"
+    VERSION = "1.0.0"
   end
 end

data/lib/capistrano/rsync.rb

@@ -1,5 +1,89 @@
 require File.expand_path("../rsync/version", __FILE__)
-load File.expand_path("../tasks/rsync.rake", __FILE__)
 
-set :rsync_stage, "tmp/deploy"
+# NOTE: Please don't depend on tasks without a description (`desc`) remaining
+# as they are between minor or patch version releases. They make up the private
+# API and internalas of Capistrano::Rsync. If you think something should be
+# public for extending, please let me know!
+
 set :rsync_options, []
+set :rsync_copy, "rsync --archive --acls --xattrs"
+
+# Stage is used on your local machine for rsyncing from.
+set :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"
+
+rsync_cache = lambda do
+  cache = fetch(:rsync_cache)
+  cache = deploy_to + "/" + cache if cache && cache !~ /^\//
+  cache
+end
+
+Rake::Task["deploy:check"].enhance ["rsync:hook_scm"]
+Rake::Task["deploy:updating"].enhance ["rsync:hook_scm"]
+
+desc "Stage and rsync to the server (or its cache)."
+task :rsync => %w[rsync:stage] do
+  roles(:all).each do |role|
+    user = role.user + "@" if !role.user.nil?
+
+    rsync = %w[rsync]
+    rsync.concat fetch(:rsync_options)
+    rsync << fetch(:rsync_stage) + "/"
+    rsync << "#{user}#{role.hostname}:#{rsync_cache.call || release_path}"
+
+    Kernel.system *rsync
+  end
+end
+
+namespace :rsync do
+  task :hook_scm do
+    Rake::Task.define_task("#{scm}:check") do
+      invoke "rsync:check" 
+    end
+
+    Rake::Task.define_task("#{scm}:create_release") do
+      invoke "rsync:release" 
+    end
+  end
+
+  task :check do
+    # Everything's a-okay inherently!
+  end
+
+  task :create_stage do
+    next if File.directory?(fetch(:rsync_stage))
+
+    clone = %W[git clone]
+    clone << fetch(:repo_url, ".")
+    clone << fetch(:rsync_stage)
+    Kernel.system *clone
+  end
+
+  desc "Stage the repository in a local directory."
+  task :stage => %w[create_stage] do
+    Dir.chdir fetch(:rsync_stage) do
+      update = %W[git fetch --quiet --all --prune]
+      Kernel.system *update
+
+      checkout = %W[git reset --hard origin/#{fetch(:branch)}]
+      Kernel.system *checkout
+    end
+  end
+
+  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.
+    next if !fetch(:rsync_cache)
+
+    copy = %(#{fetch(:rsync_copy)} "#{rsync_cache.call}/" "#{release_path}/")
+    on roles(:all).each do execute copy end
+  end
+
+  # Matches the naming scheme of git tasks.
+  # Plus was part of the public API in Capistrano::Rsync <= v0.2.1.
+  task :create_release => %w[release]
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-rsync
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Andri Möll
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-01 00:00:00.000000000 Z
+date: 2013-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -47,7 +47,6 @@ files:
 - capistrano-rsync.gemspec
 - lib/capistrano/rsync.rb
 - lib/capistrano/rsync/version.rb
-- lib/capistrano/tasks/rsync.rake
 homepage: https://github.com/moll/capistrano-rsync
 licenses:
 - LAGPL

data/lib/capistrano/tasks/rsync.rake

@@ -1,51 +0,0 @@
-Rake::Task["deploy:check"].enhance ["rsync:hook_scm"]
-Rake::Task["deploy:updating"].enhance ["rsync:hook_scm"]
-
-namespace :rsync do
-  task :hook_scm do
-    Rake::Task.define_task("#{scm}:check") do
-      invoke "rsync:check" 
-    end
-
-    Rake::Task.define_task("#{scm}:create_release") do
-      invoke "rsync:create_release" 
-    end
-  end
-
-  task :check do
-    # Everything's a-okay inherently!
-  end
-
-  task :create_stage do
-    next if File.directory?(fetch(:rsync_stage))
-
-    clone = %W[git clone]
-    clone << fetch(:repo_url, ".")
-    clone << fetch(:rsync_stage)
-    Kernel.system *clone
-  end
-
-  task :update_stage => %w[create_stage] do
-    Dir.chdir fetch(:rsync_stage) do
-      update = %W[git fetch --quiet --all --prune]
-      Kernel.system *update
-
-      checkout = %W[git reset --hard origin/#{fetch(:branch)}]
-      Kernel.system *checkout
-    end
-  end
-
-  desc "Copy the repository to the releases directory."
-  task :create_release => %w[update_stage] do
-    roles(:all).each do |role|
-      user = role.user + "@" if !role.user.nil?
-
-      rsync = %w[rsync]
-      rsync.concat fetch(:rsync_options)
-      rsync << fetch(:rsync_stage) + "/"
-      rsync << "#{user}#{role.hostname}:#{release_path}"
-
-      Kernel.system *rsync
-    end
-  end
-end