capistrano-rsync-plugin 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 342fb3c066b99bd9f46b17b27c71e0bb2c9804992cb765380001a366bde9f7d8
+  data.tar.gz: 91f7a818d5eb5f762049e71cf22c789069d0b21356ffa9264ec62b5f0e92d308
+SHA512:
+  metadata.gz: bc8e521a52ce6f340208a8669be0f0605fab52718682fcbb0a72e38d6e05db89eed1f3a51db849b9d65f03b6e4c9cd595a6ebc522c46b693fba15f5279778eb0
+  data.tar.gz: 7a75810c5d2a8ac7a433433544c890c48e8d0ac3fd60df5fd30061830904e954305f95228ab46c751ee39ad7e86280797317f5f25c45277e8e122fd62521b133

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in capistrano-rsync.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Tom Armitage, Stefan Daschek
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,125 @@
+# Capistrano 3.7.1+ rsync plugin
+
+A plugin for Capistrano 3.7.1+ to enable deployment with RSync. Entirely adapted from [a gist by Stefan Daschek](https://gist.github.com/noniq/f73e7eb199a4c2ad519c6b5e2ba5b0df).
+
+This emerged after [capistrano-rsync-bladrak](https://github.com/Bladrak/capistrano-rsync) appeared to [no longer support Capistrano 3.7.1](https://github.com/Bladrak/capistrano-rsync/issues/26)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-rsync-plugin'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-rsync-plugin
+
+Then, add this to your `Capfile` after loading `capistrano/deploy`
+
+```ruby
+require "capistrano/rsync"
+install_plugin Capistrano::SCM::Rsync
+```
+
+## Usage
+
+Deploying via rsync works in three steps:
+
+1. A git checkout of the specified branched is performed into a local cache directory (`:rsync_local_cache`). Per default, this directory is persisted so that the next deploy only needs to do a “git pull” instead of a fresh clone. But you can delete this directory anytime, if you need/want do. (It will be recreated during the next deploy.)
+
+2. The local cache directory is synced to the remote cache directory (`:rsync_remote_cache`) using rsync. Think of the remote cache directory as equivalent to the `repo` directory when deploying via git. It is there to avoid having to transfer all the files on each deploy. This, too, can be deleted (and will be recreated during the next deploy).
+
+Per default, `:rsync_options` is set to exclude any git related files, thus none of these files will be transferred to the server.
+
+3. The current state of the remote cache directory is copied to the release directory (also using rsync, but as the release directory is freshly created for each deploy, this is in fact just a full recursive copy)
+
+
+
+## Configuration
+
+Configuration option `:rsync_options` lets you specify options for the RSync command. The default is equivalent to:
+
+```ruby
+set :rsync_options, %w[--archive --delete --exclude=.git*]
+```
+
+The local cache directory relative to current is set by `:rsync_local_cache`. The default is equivalent to 
+
+```ruby
+set :rsync_local_cache, 'tmp/.capistrano-rsync-deploy'
+```
+
+The remote cache directory, relative to the deploy root, is set via `:rsync_remote_cache`, and is equivalent to:
+
+```ruby
+set :rsync_remote_cache, 'rsync-deploy'
+```
+
+The option `:rsync_deploy_build_path` makes it possible to deploy a subdirectory of the local cache. For instance, to only deploy the `public` directory, containing a compiled static site:
+
+```ruby
+set :rsync_deploy_build_path, 'public/'
+```
+
+Note the trailing slash. By default this is blank.
+
+### New Capistrano Tasks
+
+The `rsync` plugin introduces the following new tasks, which can be hooked onto using capistrano's before/after hooks:
+
+* `set_current_revision` - calculate the current repository revision to check out
+* `update_local_cache` - check out that revision to the local cache directory
+* `update_remote_cache` - rsync local cache to the remote cache directory
+* `create_release` - copy cache directory to the latest release directory
+
+After `create_release`, the traditional Capistrano flow is resumed, and the latest release is symlinekd to current.
+
+## Hooking build tasks on to capistrano-rsync-plugin
+
+A primary use case for `capistrano-rsync-plugin` is the deployment of sites made with static site generators. Rather than storing compiled static sites in the repo along with sourcecode, it is recommended to build the site as part of the deployment process, and then deploy only the compiled site. This requires no dependencies on the server as a result.
+
+As an example, let's deploy a repository made with the static site generator [Hugo](https://gohugo.io). We'll first add a task in our `deploy.rb` to build the site by installing necessary Javascript plugins, and then running Hugo:
+
+```ruby
+namespace :mysite do
+  desc 'Locally build the hugo site'
+  task :build_hugo do
+    run_locally do
+      within fetch(:rsync_local_cache) do
+        execute :yarn
+        execute :hugo, '--gc'
+      end
+    end
+  end
+end
+```
+
+This will change directory to the local cache, run `yarn`, and then run `hugo`. Now, we should add a hook to the `deploy.rb` to ensure this runs at the appropriate point in the build - after we've checked out the local cache:
+
+```ruby
+after 'rsync:update_local_cache', "mysite:build_hugo"
+```
+
+This will run `hugo`, and output the compiled site to `{LOCAL_CACHE_PATH}/public`.
+
+Finally, we don't want to deploy all our source data - only the `public` directory, so we make sure we've set a configuration variable to do that in our `config/deploy.rb` file:
+
+```ruby
+set :rsync_deploy_build_path, "public/"
+```
+
+Of course, you can always override these variables and tasks in per-environment configuration files.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/infovore/capistrano-rsync-plugin .
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/capistrano-rsync.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-rsync-plugin"
+  spec.version       = "0.2.0"
+  spec.authors       = ["Tom Armitage", "Stefan Daschek"]
+  spec.email         = ["tom@infovore.org"]
+
+  spec.summary       = %q{Plugin for Capitsrano 3.7+ to deploy with rsync}
+  spec.description   = %q{Plugin for Capistrano 3.7+ to deploy with rsync, based on a Gist by Stefan Daschek.
+
+  Ideally suited to deploying static sites made with static-site-generators.}
+  spec.homepage      = "https://github.com/infovore/capistrano-rsync-plugin"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'capistrano', '>= 3.0.0.pre'
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/capistrano/rsync.rb

@@ -0,0 +1,86 @@
+require 'capistrano/scm/plugin'
+
+class Capistrano::SCM
+  class Rsync < ::Capistrano::SCM::Plugin
+    def set_defaults
+       # command-line options for rsync
+      set_if_empty :rsync_options, %w[--archive --delete --exclude=.git*]
+
+      # Local cache (Git checkout will be happen here, resulting files then get rsynced to the remote server)
+      set_if_empty :rsync_local_cache, 'tmp/.capistrano-rsync-deploy'
+
+      # Remote cache on the server. Will be synced with the local cache before each release, and then used as
+      # source for the release. Saves needing to transfer all the source files for each release.
+      set_if_empty :rsync_remote_cache, 'rsync-deploy'
+    end
+
+    def define_tasks
+      namespace :rsync do
+        desc <<-DESC
+            Copy application source code from (remote) cache to release path.
+
+            If a :rsync_deploy_build_path is set, only that relative path will \
+            be copied to the release path.
+        DESC
+        task create_release: :update_remote_cache do
+          on release_roles :all do
+            execute :rsync, '--archive', "#{fetch(:deploy_to)}/#{fetch(:rsync_remote_cache)}/#{fetch(:rsync_deploy_build_path)}", "#{release_path}/"
+          end
+        end
+
+        desc <<-DESC
+            Update remote cache of application source code.
+
+            This will be rsynced to :rsync_remote_cache, using rsync options set in \
+            :rsync_options
+        DESC
+        task update_remote_cache: :update_local_cache do
+          on release_roles :all do |role|
+            host_spec = role.hostname
+            host_spec = "#{role.user}@#{host_spec}" if role.user
+            run_locally do
+              execute :rsync, *fetch(:rsync_options), "#{fetch(:rsync_local_cache)}/", "#{host_spec}:#{fetch(:deploy_to)}/#{fetch(:rsync_remote_cache)}/"
+            end
+          end
+        end
+
+        desc <<-DESC
+            Update local cache of application source code.
+
+            This will be checked out to :rsync_local_cache.
+        DESC
+        task :update_local_cache do
+          run_locally do
+            unless File.exist?("#{fetch(:rsync_local_cache)}/.git")
+              FileUtils.mkdir_p(fetch(:rsync_local_cache))
+              execute :git, :clone, '--quiet', repo_url, fetch(:rsync_local_cache)
+            end
+            within fetch(:rsync_local_cache) do
+              execute :git, :fetch, '--quiet', '--all', '--prune'
+              execute :git, :checkout, fetch(:branch)
+              execute :git, :reset, '--quiet', '--hard', "origin/#{fetch(:branch)}"
+            end
+          end
+        end
+
+        desc <<-DESC
+            Determine version of code that rsync will deploy.
+
+            By default, this is the latest version of the code on branch :branch.
+        DESC
+        task :set_current_revision do
+          run_locally do
+            within fetch(:rsync_local_cache) do
+              set :current_revision, capture(:git, "rev-list --max-count=1 #{fetch(:branch)}")
+            end
+          end
+        end
+      end
+    end
+
+    def register_hooks
+      after 'deploy:new_release_path', 'rsync:create_release'
+      before 'deploy:set_current_revision', 'rsync:set_current_revision'
+    end
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-rsync-plugin
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Tom Armitage
+- Stefan Daschek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0.pre
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0.pre
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: |-
+  Plugin for Capistrano 3.7+ to deploy with rsync, based on a Gist by Stefan Daschek.
+
+    Ideally suited to deploying static sites made with static-site-generators.
+email:
+- tom@infovore.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-rsync.gemspec
+- lib/capistrano-rsync.rb
+- lib/capistrano/rsync.rb
+homepage: https://github.com/infovore/capistrano-rsync-plugin
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: Plugin for Capitsrano 3.7+ to deploy with rsync
+test_files: []