capistrano-tarball_scm 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 73fd598841adbab220f20a62d3f2899ba51b23b7
+  data.tar.gz: 62a0b76251c6be18128e9404b25ed8b98255d363
+SHA512:
+  metadata.gz: 42c680d2de279d5c6aae60f55101a1ec7d4258a26d18ee3a1d2fd1526a1ebfb560d3796413a5f15c366e4611af18d785e35898fc0042ddbda33b31c1bcd724bc
+  data.tar.gz: 6f6ed21a4064ab94d227ae3757b2c98ce58ad1a14b2e4c7fa8cb720c3c51f930a84783f286ecfd30a56ed6a75a7c64c6e0d189124dda8eb25eb1a0d6bcf3c5e1

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/bundle/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Artem Chistyakov
+
+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,72 @@
+# capistrano-tarball_scm
+
+This plugin helps you deploy compiled artifacts via [Capistrano](http://capistranorb.com). It packages (locally built) artifacts as [tarballs](https://en.wikipedia.org/wiki/Tar_(computing)) and forwards them to the target server(s).
+
+## Rationale
+
+Capistrano’s defaults demand that your target servers have direct access to your VCS repository in order to pull updates to the application code. This implies that any derivative or dependent resources not stored in the source code repository (e.g. config files, dependencies, compiled resources, etc.) must be delivered via a side channel. This may easily become cumbersome (or even problematic), if any of the following is true for your project:
+
+* You don’t want to grant your application servers direct access to your VCS.
+* You’re not using a VCS for this particular project.
+* There’s an explicit compilation step involving a separate toolset that is unavailable (or unnecessary) on your application servers.
+
+Despite presented drawbacks, the default approach has been proven to work well for typical Ruby applications, where dependencies are installed on each server individually, and external tools are rarely needed to get the app running.
+
+The `capistrano-tarball_scm` gem is not a replacement, or a generally superior alternative to the defaults. Instead, it’s just a convenient option for deploying static content and compiled artifacts.
+
+The gem is similar to [capistrano-git-copy](https://github.com/ydkn/capistrano-git-copy) and [capistrano-scm-tar](https://github.com/ziguzagu/capistrano-scm-tar). Although, while sharing the goal of *pushing* updates to the server, it’s distinct in two major areas:
+
+* It builds the deployed tarball from a provided filesystem path. Conversely, `capistrano-git-copy` loads deployed artifacts directly from Git, while `capistrano-scm-tar` expects the user to provide a prepared tarball.
+* In contrast to `capistrano-scm-tar`, it relies on the modern SCM plugin API introduced in Capistrano 3.7.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-tarball_scm'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-tarball_scm
+
+Replace any existing SCM plugins in your Capfile with these two lines:
+
+```ruby
+require 'capistrano/tarball_scm'
+install_plugin Capistrano::TarballScm::Plugin
+```
+
+## Usage
+
+By default, a tarball of your working dir will be created in the Capistrano temporary directory (usually, same as your system’s). You can configure this behavior using the following configuration parameters:
+
+* `:repo_url`
+  * **default:** `.`
+  * The path to the directory containing the deployed artifact.
+* `:tarball_dir`
+  * **default:** equals Capistrano’s `:tmp_dir`
+  * The path to the directory where to store the create tarball.
+* `:tarball_exclude`
+  * **default:** `[]`
+  * A list of paths to be excluded from the created tarball.
+
+## Development
+
+After cloning the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/temochka/capistrano-tarball_scm.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'capistrano/tarball_scm'
+
+# 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-tarball_scm.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/tarball_scm/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'capistrano-tarball_scm'
+  spec.version       = Capistrano::TarballScm::VERSION
+  spec.authors       = ['Artem Chistyakov']
+  spec.email         = ['chistyakov.artem@gmail.com']
+
+  spec.summary       = %q{Create and deploy tarballs via Capistrano}
+  spec.homepage      = 'https://github.com/temochka/capistrano-tarball_scm'
+  spec.license       = 'MIT'
+
+  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 = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/capistrano/tarball_scm/plugin.rb

@@ -0,0 +1,61 @@
+require 'capistrano/scm/plugin'
+
+module Capistrano
+  module TarballScm
+    class Plugin < Capistrano::SCM::Plugin
+      def set_defaults
+        set_if_empty :repo_url, '.'
+        set_if_empty :repo_tree, '.'
+        set_if_empty :tarball_dir, fetch(:tmp_dir)
+        set_if_empty :tarball_exclude, []
+      end
+
+      def define_tasks
+        eval_rakefile File.expand_path('../tasks/tarball.rake', __FILE__)
+      end
+
+      def register_hooks
+        after 'deploy:new_release_path', 'tarball:create_release'
+        before 'deploy:set_current_revision', 'tarball:set_current_revision'
+      end
+
+      def create
+        excludes = fetch(:tarball_exclude).map { |d| "--exclude #{d}" }.join
+        backend.execute(:mkdir, '-p', tarball_dir)
+        backend.execute(:tar, '-C', tarball_root, '--exclude', tarball_dir, excludes, '-cjf', tarball_path, '.')
+      end
+
+      def release
+        backend.execute(:mkdir, '-p', release_path)
+        backend.upload!(tarball_path, release_path)
+
+        backend.within(release_path) do
+          backend.execute :tar, '-xjf', File.basename(tarball_path)
+          backend.execute :rm, '-f', File.basename(tarball_path)
+        end
+      end
+
+      def fetch_revision
+        backend.capture(:git, 'rev-parse', 'HEAD').strip
+      end
+
+      private
+
+      def tarball_dir
+        fetch(:tarball_dir)
+      end
+
+      def tarball_name
+        "#{release_timestamp}.tar.bz2"
+      end
+
+      def tarball_path
+        File.join(tarball_dir, tarball_name)
+      end
+
+      def tarball_root
+        File.join(fetch(:repo_url), fetch(:repo_tree))
+      end
+    end
+  end
+end

data/lib/capistrano/tarball_scm/tasks/tarball.rake

@@ -0,0 +1,23 @@
+tarball_scm = self
+
+namespace :tarball do
+  desc 'Create tarball'
+  task :create do
+    run_locally do
+      tarball_scm.create
+    end
+  end
+
+  desc 'Create and upload the tarball'
+  task create_release: :'tarball:create' do
+    on release_roles :all do
+      tarball_scm.release
+    end
+  end
+
+  task :set_current_revision do
+    run_locally do
+      set :current_revision, tarball_scm.fetch_revision
+    end
+  end
+end

data/lib/capistrano/tarball_scm/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module TarballScm
+    VERSION = "0.1.0"
+  end
+end

data/lib/capistrano/tarball_scm.rb

@@ -0,0 +1,7 @@
+require 'capistrano/tarball_scm/version'
+require 'capistrano/tarball_scm/plugin'
+
+module Capistrano
+  module TarballScm
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-tarball_scm
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Artem Chistyakov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- chistyakov.artem@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- capistrano-tarball_scm.gemspec
+- lib/capistrano/tarball_scm.rb
+- lib/capistrano/tarball_scm/plugin.rb
+- lib/capistrano/tarball_scm/tasks/tarball.rake
+- lib/capistrano/tarball_scm/version.rb
+homepage: https://github.com/temochka/capistrano-tarball_scm
+licenses:
+- MIT
+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.1
+signing_key: 
+specification_version: 4
+summary: Create and deploy tarballs via Capistrano
+test_files: []