capistrano-rsync-hg 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 98116d4c3164f9c06c1c0170d0a4039f17558cc9
+  data.tar.gz: e25783909362254ecdee268508318947647b3333
+SHA512:
+  metadata.gz: 9b28685f0b81bbf5255e4828e060dcea25c66c16cbfd3e3b691969ef66db043ecdc789174391cc11be3bf4fc53878e687facd3bdc87e5b10a5f83e78a0be197e
+  data.tar.gz: a25da7440a5f45ce185b6ca83401209581708ef0c6f37431113ce17bb44224e90e3197ad2feb09565e1039f61468a8a2e4feb4e34eaf1425038898eabb40024c

data/.gitignore

@@ -0,0 +1,4 @@
+*~
+*.swp
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: .
+  specs:
+    capistrano-rsync-hg (0.1.0)
+      capistrano (>= 3.4, < 4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    capistrano (3.4.0)
+      i18n
+      rake (>= 10.0.0)
+      sshkit (~> 1.3)
+    colorize (0.7.5)
+    i18n (0.7.0)
+    net-scp (1.2.1)
+      net-ssh (>= 2.6.5)
+    net-ssh (2.9.2)
+    rake (10.4.2)
+    sshkit (1.7.1)
+      colorize (>= 0.7.0)
+      net-scp (>= 1.1.2)
+      net-ssh (>= 2.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capistrano-rsync-hg!

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011, 2012, 2013, 2014, 2015, Jake Gordon and contributors
+
+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,69 @@
+# Capistrano 3 deploy with Rsync & Hg
+
+Deploy with Rsync to your server from a local Mercurial repository when using Capistrano. Saves
+you from having to install Mercurial on your production machine and allows you to customize which
+files you want to deploy.
+
+>> **NOTE**: This library is a derivation of a Git flavored original [moll/capistrano-rsync](https://github.com/moll/capistrano-rsync)
+
+## Using
+
+Install with:
+
+    gem install capistrano-rsync-hg           # or add to your Gemfile
+
+Require it at the top of your Capfile
+
+    require "capistrano/rsync"
+
+Tell capistrano to use our Rsync SCM strategy within `deploy.rb`
+
+    set :scm, :rsync
+
+And add other related options to your liking:
+
+    set :user,           "deploy"
+    set :repo_url,       "ssh://hg@bitbucket.org/myusername/myrepository"
+    set :branch,         "default"
+    set :rsync_exclude,  %w[ .hg* ]
+    set :rsync_options,  %w[ --archive --recursive --delete --delete-excluded ]
+    set :local_cache,    ".cache_#{fetch(:stage)}"
+    set :remote_cache,   "shared/cache"
+
+ * `:user` - the user used in the rsync connection (optional).
+ * `:repo_url` - the repository to clone.
+ * `:branch` - the branch to checkout.
+ * `:rsync_exclude` - array of files/paths to exclude from rsync (optional).
+ * `:rsync_options` - additional rsync options (optional).
+ * `:local_cache` - the local cache folder (where the repo will be checked out) - either absolute or relative to the local project root.
+ * `:remote_cache` - the remote cache folder (where the files will be rsynced to) - either absolute or relative to capistrano `deploy_to` variable.
+
+And after setting regular Capistrano options, deploy as usual:
+
+    cap production deploy
+
+## Implementation
+
+ 1. Clones and updates your repository to `local_cache` on your local machine.
+ 2. Checks out the branch set in the branch variable.
+ 3. Rsyncs to the `remote_cache` directory on the server.
+ 4. Copies the content of the `remote_cache` directory to a new release directory.
+
+After that, Capistrano takes over and runs its usual tasks and symlinking.
+
+## Exclude files from being deployed
+
+If you don't want to deploy everything you've committed to your repository, specify `:rsync_exclude`
+
+    set :rsync_exclude, %w[
+      .hg*
+      /config/database.yml
+      /test/***
+    ]
+
+## Other tasks
+
+    cap rsync:stage      # checkout the repo/branch into the :local_cache
+    cap rsync:sync       # ... and sync to the server(s)
+    cap rsync:release    # ... and copy to a release folder (but WITHOUT symlinking the current directory)
+

data/capistrano-rsync-hg.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+require_relative 'lib/capistrano/rsync/version'
+
+Gem::Specification.new do |s|
+
+  s.name        = Capistrano::Rsync::NAME
+  s.version     = Capistrano::Rsync::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = Capistrano::Rsync::AUTHORS
+  s.email       = Capistrano::Rsync::EMAIL
+  s.homepage    = Capistrano::Rsync::HOMEPAGE
+  s.summary     = Capistrano::Rsync::SUMMARY
+  s.description = Capistrano::Rsync::DESCRIPTION
+  s.license     = Capistrano::Rsync::LICENSE
+
+  s.has_rdoc         = false
+  s.extra_rdoc_files = ["README.md"]
+  s.rdoc_options     = ["--charset=UTF-8"]
+  s.files            = `git ls-files `.split("\n")
+  s.test_files       = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables      = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths    = ["lib"]
+
+  s.required_ruby_version = '~> 2.1'
+
+  s.add_runtime_dependency 'capistrano', '>= 3.4', '< 4'
+
+end
+

data/lib/capistrano/rsync/version.rb

@@ -0,0 +1,13 @@
+module Capistrano
+  module Rsync
+    NAME        = "capistrano-rsync-hg"
+    VERSION     = "0.1.0"
+    AUTHORS     = [ "Jake Gordon" ]
+    EMAIL       = "jake@codeincomplete.com"
+    HOMEPAGE    = "http://codeincomplete.com/"
+    SUMMARY     = "Capistrano v3 deploy with rsync from a local Hg repository"
+    DESCRIPTION = "Deploy your application using Capistrano v3 without requiring SCM access on the server - checkout the repository locally (using Hg) and deploy with Rsync"
+    LICENSE     = "MIT"
+  end
+end
+

data/lib/capistrano/rsync.rb

@@ -0,0 +1,80 @@
+
+remote_cache = lambda do
+  cache = fetch(:remote_cache)
+  cache = deploy_to + "/" + cache if cache && cache !~ /^\//
+  cache
+end
+
+namespace :load do
+  task :defaults do
+    set :rsync_exclude, %w[.hg*]
+    set :rsync_options, %w[--archive --recursive --delete --delete-excluded]
+    set :copy_command,  "rsync --archive --acls --xattrs"
+    set :local_cache,   ".rsync_#{fetch(:stage)}"
+    set :remote_cache,  "shared/rsync"
+    set :repo_url,      File.expand_path(".")
+  end
+end
+
+namespace "rsync" do
+
+  task :check do
+    # nothing to check, but expected by framework
+  end
+
+  task :create_cache do
+    next if File.directory?(File.expand_path(fetch(:local_cache)))  # TODO: check if it's actually our repo instead of assuming
+    run_locally do
+      execute :hg, 'clone', fetch(:repo_url), fetch(:local_cache)
+    end
+  end
+
+  desc "stage the repository in a local directory"
+  task :stage => [ :create_cache ] do
+    run_locally do
+      within fetch(:local_cache) do
+        execute :hg, "pull"
+        execute :hg, "checkout #{fetch(:branch)}"
+      end
+    end
+  end
+
+  desc "stage and rsync to the server"
+  task :sync => [ :stage ] do
+    release_roles(:all).each do |role|
+
+      user = role.user || fetch(:user)
+      user = user + "@" unless user.nil?
+
+      rsync_args = []
+      rsync_args.concat fetch(:rsync_options)
+      rsync_args.concat fetch(:rsync_exclude, []).map{|e| "--exclude #{e}"}
+      rsync_args << fetch(:local_cache) + "/"
+      rsync_args << "#{user}#{role.hostname}:#{remote_cache.call}"
+
+      run_locally do
+        execute :rsync, *rsync_args
+      end
+    end
+  end
+
+  desc "stage, rsync to the server, and copy the code to the releases directory"
+  task :release => [ :sync ] do
+    copy = %(#{fetch(:copy_command)} "#{remote_cache.call}/" "#{release_path}/")
+    on release_roles(:all) do
+      execute copy
+    end
+  end
+
+  task :create_release => [ :release ] do
+    # expected by the framework, delegate to better named task
+  end
+
+  task :set_current_revision do
+    run_locally do
+      set :current_revision, capture(:hg, 'log', "--rev #{fetch(:branch)}", "--template \"{node|short}\"")
+    end
+  end
+
+end
+

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-rsync-hg
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jake Gordon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+description: Deploy your application using Capistrano v3 without requiring SCM access
+  on the server - checkout the repository locally (using Hg) and deploy with Rsync
+email: jake@codeincomplete.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- capistrano-rsync-hg.gemspec
+- lib/capistrano/rsync.rb
+- lib/capistrano/rsync/version.rb
+homepage: http://codeincomplete.com/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Capistrano v3 deploy with rsync from a local Hg repository
+test_files: []