capistrano-deploy-scm-passthrough 0.1.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Simo Kinnunen
+
+MIT License
+
+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,80 @@
+# capistrano-deploy-scm-passthrough
+
+## Overview
+
+**capistrano-deploy-scm-passthrough** provides a simple passthrough SCM implementation for [Capistrano](https://github.com/capistrano/capistrano). This differs from the built-in `:none` SCM in the following ways:
+
+* It uses your local files directly (i.e. a checkout is essentially a no-op). The `:none` SCM recursively copies the current folder to a temp directory.
+* It can be used with remote strategies, such as [capistrano_rsync_with_remote_cache](https://github.com/vigetlabs/capistrano_rsync_with_remote_cache).
+* **CAUTION:** the `:passthrough` SCM cannot be used with the `:copy` strategy, or any other strategy that relies on files being actually copied around.
+
+You'll see the most benefit if you happen to be working with a large and/or binary-heavy repository deployed by a CI server. In fact it's a bad idea to use this gem if you are running the deploy command locally.
+
+## Installation
+
+Simply install the gem and you're done:
+
+    gem install capistrano-deploy-scm-passthrough
+
+No other setup is needed.
+
+## Usage
+
+Set your `:scm` as follows:
+
+    set :scm, :passthrough
+    set :repository, '.'
+
+For a sligtly more complicated example (and perhaps to understand why this gem was made), consider a case where Capistrano is run by a CI server such as [Jenkins](http://jenkins-ci.org/). Jenkins will deal with the SCM, so there is no need for Capistrano to complicate things:
+
+**deploy.rb**
+
+    # Jenkins manages the SCM.
+    set :scm, :passthrough
+    set :repository, '.'
+    set :revision, ENV['GIT_COMMIT'] || ENV['SVN_REVISION'] || Time.now
+
+We are also using Jenkins' environment variables to set the `:revision` property, which will be written into Capistrano's REVISION file. This is not 100% necessary, but is good to have so that you can check what you have deployed if necessary.
+
+The `:passthrough` strategy works especially well with [capistrano_rsync_with_remote_cache](https://github.com/vigetlabs/capistrano_rsync_with_remote_cache), allowing for quick deploys even with binary-heavy repositories. An example configuration might be:
+
+**deploy.rb**
+
+    # Deploy configuration for the rsync_with_remote_cache strategy.
+    set :deploy_via, :rsync_with_remote_cache
+    set :rsync_options, '-azF --delete --delete-excluded'
+    set :local_cache, '.'
+
+Note that we have set the `-F` option, which looks for include/exclude patterns in an `.rsync-filter` file. The following example works for a case where you'd only like to deploy the contents of a single folder (say, `public`) with the REVISION file, with everything else (including nested `.svn` folders) ignored.
+
+**.rsync-filter**
+
+    - .svn
+    + public/***
+    + REVISION
+    - *
+
+## License
+
+Copyright (c) 2013 Simo Kinnunen
+
+MIT License
+
+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/Rakefile

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

data/capistrano-deploy-scm-passthrough.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.name          = "capistrano-deploy-scm-passthrough"
+  gem.version       = "0.1.1"
+  gem.authors       = ["Simo Kinnunen"]
+  gem.email         = ["simo@shoqolate.com"]
+  gem.homepage      = "https://github.com/sorccu/capistrano-deploy-scm-passthrough"
+  gem.summary       = %q{Passthrough SCM for Capistrano.}
+  gem.description   = %q{Provides a simple :passthrough SCM implementation for Capistrano. Like :none, but more compatible and never copies or modifies any files.}
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency('capistrano', '>=2.1.0')
+end

data/lib/capistrano/recipes/deploy/scm/passthrough.rb

@@ -0,0 +1,45 @@
+require 'capistrano/recipes/deploy/scm/base'
+
+module Capistrano
+  module Deploy
+    module SCM
+
+      # An SCM even more trivial than :none. The basic idea is that everything
+      # is simply passed through. In general it's a bad idea to use it unless
+      # you've got something else such as Jenkins managing the real SCM.
+      #
+      # Note that strategies that expect files being copied don't work with
+      # the :passthrough SCM. Namely, :copy does not work.
+      class Passthrough < Base
+        # Satisfy dependency checks.
+        default_command 'true'
+
+        # No versioning, thus, no head. Returns the empty string.
+        def head
+          ''
+        end
+
+        # Return a command that always succeeds and has no side effects.
+        # Whatever we are given we're just going to pass through.
+        def sync(revision, destination)
+          'true'
+        end
+
+        alias_method :checkout, :sync
+        alias_method :export, :checkout
+
+        # No versioning, so this just returns the argument, with no
+        # modification.
+        def query_revision(revision)
+          revision
+        end
+
+        def log(from="", to="")
+          "#{self.class.name}: #{from} - #{to}"
+        end
+
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-deploy-scm-passthrough
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Simo Kinnunen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+description: Provides a simple :passthrough SCM implementation for Capistrano. Like
+  :none, but more compatible and never copies or modifies any files.
+email:
+- simo@shoqolate.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-deploy-scm-passthrough.gemspec
+- lib/capistrano/recipes/deploy/scm/passthrough.rb
+homepage: https://github.com/sorccu/capistrano-deploy-scm-passthrough
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Passthrough SCM for Capistrano.
+test_files: []