capistrano-scm-rsync 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fc812c38bbc6dafa63a18dddf31bbf6219393f3b
+  data.tar.gz: 398f5faaee863dd56bc4b1274fc90fe00871ef0d
+SHA512:
+  metadata.gz: 8e95aca1feb28c0af635409dc178e38aff374598af0d84e860c089334c1e7be9f6596785fb827dafb616166ef75dbabd7f0f96376092bc37cef0a4422a5d2cd7
+  data.tar.gz: 46df3f733da3483e681f9ff3227e61bb75a77b09e6cf1c12ab31ee00cbacfd726883cb239388ffe60ad52101519f4ec688224bc011092a6012fe8a188e08464d

data/.editorconfig

@@ -0,0 +1,13 @@
+# This file is for unifying the coding style for different editors and IDEs.
+# More information at http://EditorConfig.org
+
+# No .editorconfig files above the root directory
+root = true
+
+[*]
+indent_style = space
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = space
+indent_size = 2

data/.gitattributes

@@ -0,0 +1,6 @@
+# Set the default behavior, in case people don't have core.autocrlf set.
+* text=auto
+
+# Ruby.
+*.rb diff=ruby
+*.rake diff=ruby

data/.gitignore

@@ -0,0 +1,4 @@
+build/
+coverage/
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format progress
+--color

data/.rubocop.yml

@@ -0,0 +1,19 @@
+AllCops:
+  DisplayCopNames: true
+
+require: rubocop-rspec
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Max: 10
+
+RSpec/NestedGroups:
+  MaxNesting: 4

data/.simplecov

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require 'pathname'
+require 'coveralls'
+
+SimpleCov.start do
+  track_files('lib/**/*.rb')
+
+  add_filter do |file|
+    relative_path = Pathname.new(file.filename)
+                            .relative_path_from(Pathname.new(SimpleCov.root))
+    relative_path.to_s =~ %r{^spec/}
+  end
+
+  coverage_dir('coverage')
+
+  format = [::SimpleCov::Formatter::HTMLFormatter]
+  format << Coveralls::SimpleCov::Formatter if Coveralls.will_run?
+
+  formatter(::SimpleCov::Formatter::MultiFormatter.new(format))
+end

data/.travis.yml

@@ -0,0 +1,14 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1
+  - 2.2
+  - 2.3.3
+
+before_install: gem install bundler
+after_success:
+  - bundle exec codeclimate-test-reporter
+
+addons:
+  code_climate:
+    repo_token: 22322d923b03d8476d20a367aac12ade706f39686d4fc08b9a19978276cb68f1

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capistrano-scm-rsync.gemspec
+gemspec
+
+group :development do
+  gem 'bundler', '~> 1.13'
+  gem 'rake', '~> 10.0'
+  gem 'rspec', '~> 3.0'
+
+  gem 'rubocop', '~> 0.46'
+  gem 'rubocop-rspec'
+
+  gem 'codeclimate-test-reporter'
+  gem 'coveralls'
+  gem 'simplecov'
+end

data/README.md

@@ -0,0 +1,74 @@
+# Capistrano::Scm::Rsync
+
+[![Gem Version](https://badge.fury.io/rb/capistrano-scm-rsync.svg)](http://badge.fury.io/rb/capistrano-scm-rsync)
+[![Build Status](https://travis-ci.org/agross/capistrano-scm-rsync.png?branch=master)](https://travis-ci.org/agross/capistrano-scm-rsync)
+[![Dependency Status](https://gemnasium.com/agross/capistrano-scm-rsync.svg)](https://gemnasium.com/agross/capistrano-scm-rsync)
+[![Code Climate](https://codeclimate.com/github/agross/capistrano-scm-rsync.png)](https://codeclimate.com/github/agross/capistrano-scm-rsync)
+[![Coverage Status](https://coveralls.io/repos/agross/capistrano-scm-rsync/badge.svg)](https://coveralls.io/r/agross/capistrano-scm-rsync)
+
+`capistrano-scm-rsync` allows you to use rsync to deploy your application to your servers.
+
+* Tested against Ruby 2.x
+* Ruby < 2.0 is not supported
+
+## Installation
+
+Add it to your `Gemfile`:
+
+```ruby
+gem 'capistrano-scm-rsync'
+```
+
+```sh
+$ bundle install
+```
+
+Use the plugin with capistrano by adding it to your `Capfile`:
+
+```ruby
+require 'capistrano/scm/rsync'
+install_plugin Capistrano::SCM::Rsync
+```
+
+## Configuration
+
+In your `config/deploy.rb`:
+
+```ruby
+set :rsync_options,
+    # The local directory to be copied to the server.
+    source: 'app',
+    # The cache directory on the server that receives files
+    # from the source directory. Relative to shared_path or
+    # an absolute path.
+    # Saves you rsyncing your whole app folder each time. If
+    # set to nil Capistrano::SCM::Rsync will sync directly to
+    # the release_path.
+    cache: 'cache',
+    # Arguments passed to rsync when...
+    args: {
+      # ...copying the local directory to the server.
+      local_to_remote: [],
+      # ...copying the cache directory to the release_path.
+      cache_to_release: %w(--archive --acls --xattrs)
+    }
+```
+
+## Example
+
+See https://github.com/dnugleipzig/deploy.
+
+## Development
+
+* Source hosted at [GitHub](https://github.com/agross/capistrano-scm-rsync)
+* Report issues/Questions/Feature requests on [GitHub Issues](https://github.com/agross/capistrano-scm-rsync/issues)
+
+Pull requests are very welcome! Make sure your patches are well tested. Please create a topic branch for every separate change you make.
+
+## Contributing
+
+1. Fork it http://github.com/agross/capistrano-scm-rsync/fork
+1. Create your feature branch (`git checkout -b my-new-feature`)
+1. Commit your changes (`git commit -am 'Add some feature'`)
+1. Push to the branch (`git push origin my-new-feature`)
+1. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+Dir['lib/tasks/*.rake'].each { |file| load(file) }

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'capistrano/scm/rsync'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/capistrano-scm-rsync.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'capistrano-scm-rsync'
+  spec.version       = '0.1.0'
+  spec.authors       = ['Alexander Groß']
+  spec.email         = %w(agross@therightstuff.de)
+
+  spec.summary       = 'capistrano deployments using rsync as the SCM'
+  spec.description   = 'Uses rsync to copy a local directory to your deployment servers'
+  spec.homepage      = 'https://github.com/agross/capistrano-scm-rsync'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = %w(lib)
+
+  spec.add_dependency 'capistrano', '~> 3.7'
+end

data/lib/capistrano/scm/rsync.rb

@@ -0,0 +1,89 @@
+require 'capistrano/scm/plugin'
+
+module Capistrano
+  class SCM
+    class Rsync < ::Capistrano::SCM::Plugin
+      def set_defaults
+        set_if_empty :rsync_options,
+                     # The local directory to be copied to the server.
+                     source: 'app',
+                     # The cache directory on the server that receives files
+                     # from the source directory. Relative to shared_path or
+                     # an absolute path.
+                     # Saves you rsyncing your whole app folder each time. If
+                     # set to nil Capistrano::SCM::Rsync will sync directly to
+                     # the release_path.
+                     cache: 'cache',
+                     # Arguments passed to rsync when...
+                     args: {
+                       # ...copying the local directory to the server.
+                       local_to_remote: [],
+                       # ...copying the cache directory to the release_path.
+                       cache_to_release: %w(--archive --acls --xattrs)
+                     }
+      end
+
+      def define_tasks
+        eval_rakefile(File.expand_path('../tasks/rsync.rake', __FILE__))
+      end
+
+      def register_hooks
+        after 'deploy:new_release_path', 'rsync:create_release'
+        before 'deploy:set_current_revision', 'rsync:set_current_revision'
+      end
+
+      def copy_local_to_remote(role)
+        if dry_run?
+          puts "Would execute: #{rsync_command(role).inspect}"
+          return
+        end
+
+        RakeFileUtils.sh(*rsync_command(role))
+      end
+
+      def create_release
+        # Skip copying if we've already synced straight to the release directory.
+        return unless remote_cache
+
+        copy = [
+          'rsync',
+          fetch(:rsync_options)[:args][:cache_to_release],
+          File.join(remote_directory, '/').shellescape,
+          '.'
+        ].flatten
+
+        backend.execute(*copy)
+      end
+
+      private
+
+      def rsync_command(role)
+        rsync = %w(rsync) + fetch(:rsync_options)[:args][:local_to_remote]
+        rsync << File.join(fetch(:rsync_options)[:source], '/')
+        rsync << "#{remote_user(role)}#{role.hostname}:#{remote_directory}"
+      end
+
+      def remote_user(role)
+        user = if role.user
+                 role.user
+               elsif fetch(:ssh_options)[:user]
+                 fetch(:ssh_options)[:user]
+               end
+
+        "#{user}@" unless user.nil?
+      end
+
+      def remote_cache
+        fetch(:rsync_options)[:cache]
+      end
+
+      def remote_directory
+        return release_path unless remote_cache
+
+        cache = remote_cache
+        cache = File.join(shared_path, cache) if cache && cache !~ %r{^/}
+        cache
+      end
+    end
+  end
+end

data/lib/capistrano/scm/tasks/rsync.rake

@@ -0,0 +1,26 @@
+# This trick lets us access the Rsync plugin within `on` blocks.
+rsync_plugin = self
+
+namespace :rsync do
+  desc 'Copy the local source directory to the remote cache or release directory'
+  task :copy_local_to_remote do
+    on release_roles(:all) do |role|
+      rsync_plugin.copy_local_to_remote(role)
+    end
+  end
+
+  desc 'Create new release'
+  task create_release: [:copy_local_to_remote] do
+    on release_roles(:all) do
+      execute :mkdir, '-p', release_path
+
+      within release_path do
+        rsync_plugin.create_release
+      end
+    end
+  end
+
+  task :set_current_revision do
+    set_if_empty :current_revision, now
+  end
+end

data/lib/tasks/bundler.rake

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

data/lib/tasks/default.rake

@@ -0,0 +1 @@
+task default: [:lint, :spec]

data/lib/tasks/lint.rake

@@ -0,0 +1,2 @@
+desc 'Run lints'
+task lint: [:rubocop]

data/lib/tasks/rubocop.rake

@@ -0,0 +1,7 @@
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.options = %w(--format html --out build/lint/rubocop/rubocop.html
+                 --format progress)
+  t.verbose = true
+end

data/lib/tasks/spec.rake

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = "--order random --format progress --format html --out build/spec/rspec.html #{ENV['RSPEC_OPTS']}"
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-scm-rsync
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexander Groß
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+description: Uses rsync to copy a local directory to your deployment servers
+email:
+- agross@therightstuff.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitattributes"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".simplecov"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- capistrano-scm-rsync.gemspec
+- lib/capistrano/scm/rsync.rb
+- lib/capistrano/scm/tasks/rsync.rake
+- lib/tasks/bundler.rake
+- lib/tasks/default.rake
+- lib/tasks/lint.rake
+- lib/tasks/rubocop.rake
+- lib/tasks/spec.rake
+homepage: https://github.com/agross/capistrano-scm-rsync
+licenses: []
+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.5.2
+signing_key: 
+specification_version: 4
+summary: capistrano deployments using rsync as the SCM
+test_files: []