capistrano-deploy-strategy-archive 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,68 @@
+# capistrano-deploy-strategy-archive
+
+## Overview
+
+**capistrano-deploy-strategy-archive** provides a simple archive strategy for [Capistrano](https://github.com/capistrano/capistrano). The strategy takes an existing, pre-built package, copies it as-is to each target host and uncompresses it to the release directory.
+
+While normally discouraged, you'll usually want to use the :none SCM with this strategy (or for even less overhead, the :passthrough SCM from [capistrano-deploy-scm-passthrough](https://rubygems.org/gems/capistrano-deploy-scm-passthrough)).
+
+You'll see the most benefit if you've got a build server cranking out builds for you, which you then later deploy. You'll often want to separate the build phase from the deploy phase in production. If necessary, you can of course use `capistrano/ext/multistage` to do `:archive` deploys for, say, production only.
+
+## Installation
+
+Simply install the gem and you're done:
+
+    gem install capistrano-deploy-strategy-archive
+
+No other setup is needed.
+
+## Usage
+
+Set your options as follows:
+
+**deploy.rb**
+
+    set :scm, :none
+    set :deploy_via, :archive
+    set :repository, "target/#{application}.tar.gz"
+
+Note that we've set the `:repository` option to match the target archive.
+
+If you'd like to have as little overhead as possible, consider using the [:passthrough](https://rubygems.org/gems/capistrano-deploy-scm-passthrough) SCM:
+
+**deploy.rb**
+
+    set :scm, :passthrough
+    set :deploy_via, :archive
+    set :repository, "target/#{application}.tar.gz"
+
+This will transfer the archive directly, without any local copies being made. The `:none` strategy actually creates a local copy, which is usually not what you want if you've already got a package made.
+
+Note: if your archive is not a gzipped tar archive, you must set the `:copy_compression` option. The currently available options are `:gzip` (default), `:bz2`, and `:zip`. Please use `cap deploy:check` to check if your servers have the necessary decompressors installed.
+
+You can also set the `:copy_remote_dir` option to control where the package is initially transferred to on each host.
+
+## 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-strategy-archive.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.name          = "capistrano-deploy-strategy-archive"
+  gem.version       = "0.1.1"
+  gem.authors       = ["Simo Kinnunen"]
+  gem.email         = ["simo@shoqolate.com"]
+  gem.homepage      = "https://github.com/sorccu/capistrano-deploy-strategy-archive"
+  gem.summary       = %q{Archive deploy strategy for Capistrano.}
+  gem.description   = %q{Provides an :archive deploy strategy for Capistrano. It takes an existing, pre-built archive and deploys it as-is. Useful when you've got a server making builds for you, which you then later deploy.}
+
+  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/strategy/archive.rb

@@ -0,0 +1,101 @@
+require 'capistrano/recipes/deploy/strategy/base'
+
+module Capistrano
+  module Deploy
+    module Strategy
+
+      # This class implements a strategy for deployments with prebuilt
+      # packages. It copies the package to each target host and uncompresses
+      # it to the release directory. While normally discouraged, you
+      # usually want to use the :none SCM with this strategy (or for even less
+      # overhead, the :passthrough SCM from capistrano-deploy-scm-passthrough).
+      # You'll also need to set :repository to the target archive.
+      #
+      #   set :scm, :none
+      #   set :deploy_via, :archive
+      #   set :repository, "target/#{application}.tar.gz"
+      #
+      # This strategy is meant to be a drop-in replacement for the :copy
+      # strategy, and supports all the same configuration variables EXCEPT
+      # those that deal with creating the package. For example,
+      # :build_script and :copy_exclude are not supported.
+      #
+      # This deployment strategy also supports a special variable,
+      # :copy_compression, which must be one of :gzip, :bz2, or
+      # :zip, and which specifies how the package should be decompressed on
+      # each host.
+      class Archive < Base
+        # Copies the package to all target servers, and uncompresses it on
+        # each of them into the deployment directory.
+        def deploy!
+          distribute!
+        end
+
+        # Check dependencies.
+        def check!
+          super.check do |d|
+            d.remote.command(decompress(nil).first)
+          end
+        end
+
+        private
+
+          # Returns the name of the file that the source code will be
+          # compressed to.
+          def filename
+            @filename ||= File.expand_path(configuration[:repository], Dir.pwd)
+          end
+
+          # The directory on the remote server to which the archive should be
+          # copied
+          def remote_dir
+            @remote_dir ||= configuration[:copy_remote_dir] || "/tmp"
+          end
+
+          # The location on the remote server where the file should be
+          # temporarily stored.
+          def remote_filename
+            @remote_filename ||= File.join(remote_dir, "#{File.basename(configuration[:release_name])}.#{compression.extension}")
+          end
+
+          # A struct for representing the specifics of a compression type.
+          # Commands are arrays, where the first element is the utility to be
+          # used to perform the compression or decompression.
+          Compression = Struct.new(:extension, :decompress_command)
+
+          # The compression method to use, defaults to :gzip.
+          def compression
+            remote_tar = configuration[:copy_remote_tar] || 'tar'
+            remote_unzip = configuration[:copy_remote_unzip] || 'unzip'
+
+            type = configuration[:copy_compression] || :gzip
+            case type
+            when :gzip, :gz   then Compression.new("tar.gz",  [remote_tar, 'xzf'])
+            when :bzip2, :bz2 then Compression.new("tar.bz2", [remote_tar, 'xjf'])
+            when :zip         then Compression.new("zip",     [remote_unzip, '-q'])
+            else raise ArgumentError, "invalid compression type #{type.inspect}"
+            end
+          end
+
+          # Returns the command necessary to decompress the given file,
+          # relative to the current working directory. It must also
+          # preserve the directory structure in the file.
+          def decompress(file)
+            compression.decompress_command + [file]
+          end
+
+          # Decompress the package on the remote host.
+          def decompress_remote_file
+            run "mkdir #{configuration[:release_path]} && cd #{configuration[:release_path]} && #{decompress(remote_filename).join(" ")} && rm #{remote_filename}"
+          end
+
+          # Distributes the file to the remote hosts.
+          def distribute!
+            upload(filename, remote_filename)
+            decompress_remote_file
+          end
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-deploy-strategy-archive
+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 an :archive deploy strategy for Capistrano. It takes an existing,
+  pre-built archive and deploys it as-is. Useful when you've got a server making builds
+  for you, which you then later deploy.
+email:
+- simo@shoqolate.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-deploy-strategy-archive.gemspec
+- lib/capistrano/recipes/deploy/strategy/archive.rb
+homepage: https://github.com/sorccu/capistrano-deploy-strategy-archive
+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: Archive deploy strategy for Capistrano.
+test_files: []