capistrano-rsync-local 1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d8e113f8f3985d6de97d1781c7846e94a873334a
+  data.tar.gz: 5146c44c34e11c3d5430267b503d34efc591a545
+SHA512:
+  metadata.gz: 7af134741ddc04303887c0699fda9ab809059a5749b3a7ed5390b175299979081b418652d219ffaedcd5ba5a10590bb43f0b08eb3a5c2365b250690b93892893
+  data.tar.gz: 51d02b90070b9ae18dd76d9b79af7f89cd725521d271f52dc3c695ac71a7e1a847e42cb24ed8292f8778e90a88efe5496d8f7f77bebded33587eaa0c5745dd19

data/.gitignore

@@ -0,0 +1,2 @@
+/*.gem
+.vagrant/

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+## 1.0.2 (Oct 13, 2013)
+- Updates README and code comments.
+
+## 1.0.1 (Sep 2, 2013)
+- Updates README and adds implementation details to it.
+
+## 1.0.0 (Sep 2, 2013)
+- Makes the `rsync:stage` task public for extending and hooking.
+- Renames `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)
+- Passes user given in `role :app, "user@host"` to `rsync` if set.
+
+## 0.1.338 (Sep 1, 2013)
+- Adds gem dependency on Capistrano v3.
+
+## 0.1.337 (Sep 1, 2013)
+- First release. Let's get syncing!

data/LICENSE

@@ -0,0 +1,20 @@
+Capistrano::Rsync
+Copyright (C) 2013 Andri Möll
+
+This program is free software: you can redistribute it and/or modify it under
+the terms of the GNU Affero General Public License as published by the Free
+Software Foundation, either version 3 of the License, or any later version.
+
+Additional permission under the GNU Affero GPL version 3 section 7:
+If you modify this Program, or any covered work, by linking or
+combining it with other code, such other code is not for that reason
+alone subject to any of the requirements of the GNU Affero GPL version 3.
+
+In summary:
+- You can use this program for no cost.
+- You can use this program for both personal and commercial reasons.
+- You do not have to share your own program's code which uses this program.
+- You have to share modifications (e.g bug-fixes) you've made to this program.
+
+For the full copy of the GNU Affero General Public License see:
+http://www.gnu.org/licenses.

data/Makefile

@@ -0,0 +1,16 @@
+NAME = capistrano-rsync-local
+
+love:
+	@echo "Feel like makin' love."
+
+pack:
+	gem build $(NAME).gemspec
+
+publish:
+	gem push $(NAME)-*.gem
+
+clean:
+	rm -f *.gem
+
+.PHONY: love pack publish
+.PHONY: clean

data/README.md

@@ -0,0 +1,129 @@
+Capistrano::Rsync for Capistrano v3
+===================================
+[![Gem version][gem-badge]](http://badge.fury.io/rb/capistrano-rsync)
+[gem-badge]: https://badge.fury.io/rb/capistrano-rsync.png
+
+**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. Also allows you to easily precompile things on your local
+machine before deploying.
+
+### 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 [Mina](http://nadarei.co/mina/) instead of Capistrano? I've built
+[Mina::Rsync](https://github.com/moll/mina-rsync) as well.
+
+
+Using
+-----
+Install with:
+```
+gem install capistrano-rsync
+```
+
+Require it at the top of your `Capfile` (or `config/deploy.rb`):
+```ruby
+require "capistrano/rsync"
+```
+
+Set some `rsync_options` to your liking:
+```ruby
+set :rsync_options, %w[--recursive --delete --delete-excluded --exclude .git*]
+```
+
+And after setting regular Capistrano options, deploy as usual!
+```
+cap deploy
+```
+
+### Implementation
+1. Clones and updates your repository to `rsync_stage` (defaults to
+   `tmp/deploy`) on your local machine.
+2. Checks out the branch set in the `branch` variable (defaults to `master`).
+3. If `rsync_cache` set (defaults to `shared/deploy`), rsyncs to that directory
+   on the server.
+4. If `rsync_cache` set, copies the content of that directory to a new release
+   directory.
+5. If `rsync_cache` is `nil`, rsyncs straight 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, pass
+some `--exclude` options to Rsync:
+```ruby
+set :rsync_options, %w[
+  --recursive --delete --delete-excluded
+  --exclude .git*
+  --exclude .svn*
+  --exclude /config/database.yml
+  --exclude /test/***
+]
+```
+
+### 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
+
+after "rsync:stage", "precompile"
+```
+
+### Deploy release without symlinking the current directory
+```
+cap rsync:release
+```
+
+
+Configuration
+-------------
+Set Capistrano variables with `set name, value`.
+
+Name          | Default | Description
+--------------|---------|------------
+rsync_scm     | `git`   | Available options: `git`, `svn`.
+rsync_scm_username | nil | Used for Svn (Optional).
+rsync_scm_password | nil | Used for Svn (Optional).
+repo_url      | `.` | The path or URL to a SCM repository to clone from.
+branch        | `master` | The Git branch to checkout. This is ignored for Svn.
+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
+-------
+Capistrano::Rsync is released under a *Lesser GNU Affero General Public
+License*, which in summary means:
+
+- You **can** use this program for **no cost**.
+- You **can** use this program for **both personal and commercial reasons**.
+- You **do not have to share your own program's code** which uses this program.
+- You **have to share modifications** (e.g bug-fixes) you've made to this
+  program.
+
+For more convoluted language, see the `LICENSE` file.
+
+
+About
+-----
+**[Andri Möll](http://themoll.com)** made this happen.  
+[Monday Calendar](https://mondayapp.com) was the reason I needed this.
+
+If you find Capistrano::Rsync needs improving, please don't hesitate to type to
+me now at [andri@dot.ee](mailto:andri@dot.ee) or [create an issue
+online](https://github.com/moll/capistrano-rsync/issues).

data/Vagrantfile

@@ -0,0 +1,13 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure(2) do |config|
+  config.ssh.insert_key = false
+  config.vm.box = 'box-cutter/ubuntu1504'
+
+  config.vm.provider 'virtualbox' do |vb|
+    vb.name = 'gem-capistrano-rsync'
+  end
+
+  config.vm.provision :shell, path: 'provision.sh', privileged: false
+end

data/capistrano-rsync-local.gemspec

@@ -0,0 +1,34 @@
+require File.expand_path('../lib/capistrano/rsync/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name = 'capistrano-rsync-local'
+  gem.version = Capistrano::Rsync::VERSION
+  gem.homepage = 'https://github.com/tonkonogov/capistrano-rsync'
+  gem.summary = <<-end.strip.gsub(/\s*\n\s*/, " ")
+    Deploy with Rsync from any local (or remote) repository.
+    Capistrano v3 ready!
+  end
+
+  gem.description = <<-end.strip.gsub(/\s*?\n(\n?)\s*/, " \\1\\1")
+    Deploy with Rsync to your server from any local (or remote) repository.
+
+    Saves you the need to install Git on your production machine and deploy all
+    of your development files each time!
+
+    Works with the new Capistrano v3!
+    Suitable for deploying any apps, be it Ruby or Node.js.
+    Initially gem has been developed by Moll (https://github.com/moll/capistrano-rsync).
+    Scm support is introduced by Seantan (https://github.com/seantan/capistrano-rsync).
+  end
+
+  gem.author = 'Dmitry Tonkonogov'
+  gem.email = 'omun.spambox@gmail.com'
+  gem.license = "LAGPL"
+
+  gem.files = `git ls-files`.split($/)
+  gem.executables = gem.files.grep(/^bin\//).map(&File.method(:basename))
+  gem.test_files = gem.files.grep(/^spec\//)
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'capistrano', '>= 3.0.0.pre14', '< 4'
+end

data/lib/capistrano/rsync.rb

@@ -0,0 +1,115 @@
+require File.expand_path("../rsync/version", __FILE__)
+require File.expand_path("../rsync/scm/base", __FILE__)
+require File.expand_path("../rsync/scm/git", __FILE__)
+require File.expand_path("../rsync/scm/svn", __FILE__)
+
+# 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
+# private API and internals of Capistrano::Rsync. If you think something should
+# be public for extending and hooking, please let me know!
+
+rsync_cache = lambda do
+  cache = fetch(:rsync_cache)
+  cache = deploy_to + "/" + cache if cache && cache !~ /^\//
+  cache
+end
+
+scm_instance = lambda do
+  scm_class = Capistrano::Rsync::Scm.const_get(:"#{fetch(:rsync_scm).capitalize}")
+  scm_class.new(self)
+end
+
+Rake::Task["load:defaults"].enhance ["rsync:defaults"]
+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
+  desc "Load rsync default options."
+  task :defaults do
+    set :rsync_options, []
+    set :rsync_copy, "rsync --archive --acls --xattrs"
+
+    # Scm to use.
+    set :rsync_scm, "git"
+
+    # 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"
+    set :rsync_local_repo, false
+  end
+
+  # internally needed by capistrano's "deploy.rake"
+  task :set_current_revision do
+    Dir.chdir fetch(:rsync_stage) do
+      cmd = scm_instance.call.get_current_revision_cmd
+      rev = `#{cmd}`
+      set :current_revision, rev
+    end
+  end
+
+  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
+
+  desc "Create the stage repository in a local directory."
+  task :create_stage do
+    next if File.directory?(fetch(:rsync_stage)) || fetch(:rsync_local_repo)
+    scm_instance.call.create_stage_cmds.each do |cmd|
+      Kernel.system *cmd
+    end
+  end
+
+  desc "Update and freshen the stage repository."
+  task :stage => %w[create_stage] do
+    next if fetch(:rsync_local_repo)
+    Dir.chdir fetch(:rsync_stage) do
+      scm_instance.call.update_stage_cmds.each do |cmd|
+        Kernel.system *cmd
+      end
+    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) do |host|
+      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

data/lib/capistrano/rsync/scm/base.rb

@@ -0,0 +1,37 @@
+module Capistrano
+  module Rsync
+    module Scm
+
+      # Abstract class to be inherited with the abstract methods to be implemented.
+      # Provides the capistrano context.
+      class Base
+        attr_reader :context
+
+        def initialize(context)
+          @context = context
+        end
+
+        # Returns command to obtain the current revision
+        def get_current_revision_cmd
+          throw NotImplementedError
+        end
+
+        # Returns array of commands required to create the stage respository.
+        # Skipped if rsync_stage directory already exists.
+        def create_stage_cmds
+          throw NotImplementedError
+        end
+
+        # Returns array of commands required to update the stage repository
+        # and prepare it to be ready to be rsynced to rsync_cache.
+        #
+        # Commands will be executed in the rsync_stage directory.
+        def update_stage_cmds
+          throw NotImplementedError
+        end
+      end
+
+    end
+  end
+end
+

data/lib/capistrano/rsync/scm/git.rb

@@ -0,0 +1,33 @@
+module Capistrano
+  module Rsync
+    module Scm
+
+      class Git < Capistrano::Rsync::Scm::Base
+        attr_reader :context
+
+        def get_current_revision_cmd
+          "git rev-parse HEAD"
+        end
+
+        def create_stage_cmds
+          cmd = []
+          clone = %W[git clone]
+          clone << context.fetch(:repo_url, ".")
+          clone << context.fetch(:rsync_stage)
+          cmd << clone
+          cmd
+        end
+
+        def update_stage_cmds
+          cmd = []
+          update = %W[git fetch --quiet --all --prune]
+          cmd << update
+          checkout = %W[git reset --hard origin/#{fetch(:branch)}]
+          cmd << checkout
+          cmd
+        end
+      end
+
+    end
+  end
+end

data/lib/capistrano/rsync/scm/svn.rb

@@ -0,0 +1,45 @@
+module Capistrano
+  module Rsync
+    module Scm
+
+      class Svn < Capistrano::Rsync::Scm::Base
+        attr_reader :context
+
+        def get_current_revision_cmd
+          "svn info | grep '^Revision:' | sed -e 's/^Revision: //'"
+        end
+
+        def create_stage_cmds
+          cmd = []
+
+          clone = %W[svn checkout]
+          clone << context.fetch(:repo_url, ".")
+          clone << context.fetch(:rsync_stage)
+
+          clone << %W[--username #{context.fetch(:rsync_scm_username)}] if context.fetch(:rsync_scm_username)
+          clone << %W[--password #{context.fetch(:rsync_scm_password)}] if context.fetch(:rsync_scm_password)
+
+          cmd << clone.flatten
+
+          cmd
+        end
+
+        def update_stage_cmds
+          cmd = []
+
+          update = %W[svn update]
+          update << %W[--username #{context.fetch(:rsync_scm_username)}] if context.fetch(:rsync_scm_username)
+          update << %W[--password #{context.fetch(:rsync_scm_password)}] if context.fetch(:rsync_scm_password)
+
+          cmd << update.flatten
+
+          checkout = %W[svn revert --recursive .]
+          cmd << checkout
+
+          cmd
+        end
+      end
+
+    end
+  end
+end

data/lib/capistrano/rsync/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Rsync
+    VERSION = '1.1'
+  end
+end

data/provision.sh

@@ -0,0 +1,40 @@
+#!/bin/bash
+export LANGUAGE=en_US.UTF-8
+export LANG=en_US.UTF-8
+export LC_ALL=en_US.UTF-8
+sudo locale-gen en_US.UTF-8
+sudo dpkg-reconfigure locales
+
+sudo update-rc.d -f apparmor remove
+sudo apt-get remove -y apparmor apparmor-utils
+
+sudo apt-get -y update
+sudo /bin/bash -c "DEBIAN_FRONTEND=noninteractive apt-get -o Dpkg::Options::=\"--force-confnew\" --force-yes -fuy upgrade"
+sudo apt-get install -y software-properties-common python-software-properties
+sudo apt-get install ntp ntpdate -y
+sudo apt-get install curl git-core g++ libssl-dev apache2-utils screen vim libsqlite3-dev -y
+sudo apt-get install automake autoconf -y
+
+curl https://gist.githubusercontent.com/turadg/840663/raw/46cceea5bc1f73098fcf5e099d91744b24dabdc7/rake.sh > ~/.rake_complete
+
+cat >> ~/.bash_profile <<ENDOFFILE
+source ~/.bashrc
+
+export LANGUAGE=en_US.UTF-8
+export LANG=en_US.UTF-8
+export LC_ALL=en_US.UTF-8
+export RUBY_VERSION=2.2.2
+ENDOFFILE
+
+git clone https://github.com/sstephenson/rbenv.git ~/.rbenv
+echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.bash_profile
+echo 'eval "$(rbenv init -)"' >> ~/.bash_profile
+git clone https://github.com/sstephenson/ruby-build.git ~/.rbenv/plugins/ruby-build
+
+source ~/.bash_profile
+
+rbenv install ${RUBY_VERSION}
+rbenv local ${RUBY_VERSION}
+gem update --system
+gem install bundler -N
+rbenv local --unset

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-rsync-local
+version: !ruby/object:Gem::Version
+  version: '1.1'
+platform: ruby
+authors:
+- Dmitry Tonkonogov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-08 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.pre14
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0.pre14
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+description: "Deploy with Rsync to your server from any local (or remote) repository.
+  \n\nSaves you the need to install Git on your production machine and deploy all
+  of your development files each time! \n\nWorks with the new Capistrano v3! Suitable
+  for deploying any apps, be it Ruby or Node.js. Initially gem has been developed
+  by Moll (https://github.com/moll/capistrano-rsync). Scm support is introduced by
+  Seantan (https://github.com/seantan/capistrano-rsync)."
+email: omun.spambox@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- CHANGELOG.md
+- LICENSE
+- Makefile
+- README.md
+- Vagrantfile
+- capistrano-rsync-local.gemspec
+- lib/capistrano/rsync.rb
+- lib/capistrano/rsync/scm/base.rb
+- lib/capistrano/rsync/scm/git.rb
+- lib/capistrano/rsync/scm/svn.rb
+- lib/capistrano/rsync/version.rb
+- provision.sh
+homepage: https://github.com/tonkonogov/capistrano-rsync
+licenses:
+- LAGPL
+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.4.7
+signing_key: 
+specification_version: 4
+summary: Deploy with Rsync from any local (or remote) repository. Capistrano v3 ready!
+test_files: []