capistrano-bundle_rsync 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 947571b6493b5ee9d817038173d85843861ee994
-  data.tar.gz: 81ad9af1b67a3fe55548e179bca2db5f12ea61aa
+  metadata.gz: 57fd444228ffd2aaa2b08ae8a3aa48d641709f98
+  data.tar.gz: 04086f39219dc6ff6922e4a09596907b105a8a61
 SHA512:
-  metadata.gz: 15002e2ae62bd357856bedb2e9baba480a65457fc26765f11ebb40a26d8d8c0f20071a2c184ef298b04b606ec2424dbf20a35785b42ed231b043f604d52b6746
-  data.tar.gz: 2472e6d00b1da760721fa0ebd7122cb97df1c2319ea8b0e48f35ae9e3401dc580a5485246500b3a3477ac4f9b59f581de57941970ad472911fa0e1e327693d07
+  metadata.gz: 76e50e567ac213341bafb10e0dc0060a6fe6aba2bb4c5ed46e4c8fd3e9b5f50b34227083d245abcb59f673f1788c4330f21d0c3c01000703b3100a2970c93641
+  data.tar.gz: d4ffdd544a4d85f5b558940bef818000e3edb1cdc98106976340c9003eb099f59f1ae5428b911357472a636598c560853da5d47e3727eac50e184e98ab8baa9e

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+example/.local_repo

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+# 0.2.0 (2014/07/11)
+
+Enhancements:
+
+* Support `bundle_rsync_keep_releases` configuration
+* Newly add `set :bundle_rsync_scm 'local_git'` configuration
+
+Changes:
+
+* Rename `bundle_rsync_local_repo_path` to `bundle_rsync_local_mirror_path`
+
 # 0.1.1 (2014/07/09)
 
 Enhancements:

data/README.md

@@ -12,7 +12,7 @@ Also saves you from having to install Git and Build Tools on your production mac
 
 Capistrano::BundleRsync works as followings:
 
-1. Do `git clone --mirror URL .local_repo/repo` on a deploy (local) machine.
+1. Do `git clone --mirror URL .local_repo/mirror` on a deploy (local) machine.
 2. Extract a branch by `git archive {branch}` to `.local_repo/release_{time}`
 4. Deploy the `release` directory to remote machines by `rsync`. 
 3. Do `bundle --without development,test --path .local_repo/bundle` on a deploy (local) machine.
@@ -48,16 +48,21 @@ Name          | Default | Description
 repo_url      | `.` | The path or URL to a Git repository to clone from.  
 branch        | `master` | The Git branch to checkout.  
 ssh_options   | `{}`  | Configuration of ssh :user and :keys.
-bundle_rsync_local_base_path   | `$(pwd)/.local_repo` | The working base directory
-bundle_rsync_local_repo_path | `#{base_path}/repo"` | Path where to mirror your repository
-bundle_rsync_local_release_path | `"#{base_path}/relase_#{Time.now.to_i}"` | Path where to checkout your repository
+keep\_releases | 5 | The number of releases to keep.
+scm | nil | Must be `bundle_rsync` to use capistrano-bundle_rsync.
+bundle_rsync_local_base_path   | `$(pwd)/.local_repo` | The base directory to clone repository
+bundle_rsync_local_mirror_path | `#{base_path}/mirror"` | Path where to mirror your repository
+bundle_rsync_local_releases_path | `"#{base_path}/releases"` | Path of the directory to checkout your repository
+bundle_rsync_local_release_path | `"#{release_dir}/#{time}"` | Path to checkout your repository (releases_path + release_name)
 bundle_rsync_local_bundle_path | `"#{base_path}/bundle"` | Path where to bundle install gems.
 bundle_rsync_local_bin_path | `"#{base_path}/bin"` | Path where to bundle install bin scripts.
 bundle_rsync_config_files | `nil` | Additional files to rsync. Specified files are copied into `config` directory.
 bundle_rsync_ssh_options | `ssh_options` | Configuration of ssh for rsync. Default uses the value of `ssh_options`
+bundle_rsync_keep_releases | `keep_releases` | The number of releases to keep on .local_repo
 bundle_rsync_max_parallels | number of hosts | Number of concurrency. The default is the number of hosts to deploy.
 bundle_rsync_rsync_bwlimit | nil | Configuration of rsync --bwlimit (KBPS) option. Not Avabile if `bundle_rsync_rsync_options` is specified.
 bundle_rsync_rsync_options | `-az --delete` | Configuration of rsync options.
+bundle_rsync_scm | 'git' or 'local_git' | SCM Strategy inside `bundle_rsync`. `git` uses git. `local_git` also uses git, but it enables to rsync the git repository located on local path directly without git clone. `repo_url` must be the local directory path to use `local_git`.
 
 ## Installation
 
@@ -162,7 +167,7 @@ A. capistrano-bundle\_rsync does `bundle install` at the deploy machine, not on
 
 ## ToDo
 
-2. Support other SCMs than `git`. 
+1. Support other SCMs than `git`. 
 
 ## ChangeLog
 

data/capistrano-bundle_rsync.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "capistrano-bundle_rsync"
-  spec.version       = "0.1.1"
+  spec.version       = "0.2.0"
   spec.authors       = ["sonots", "tohae"]
   spec.email         = ["sonots@gmail.com", "tohaechan@gmail.com"]
   spec.description   = %q{Deploy an application and bundled gems via rsync}

data/example/Capfile

@@ -0,0 +1,12 @@
+# Load DSL and Setup Up Stages
+require 'capistrano/setup'
+
+# Includes default deployment tasks
+require 'capistrano/deploy'
+
+# Includes tasks from other gems included in your Gemfile
+require 'capistrano/rbenv'
+require 'capistrano/bundle_rsync'
+
+# Loads custom tasks from `lib/capistrano/tasks' if you have any defined.
+Dir.glob('lib/capistrano/tasks/*.rake').each { |r| import r }

data/example/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+gem 'capistrano'
+gem 'capistrano-rbenv'
+gem 'capistrano-bundle_rsync', path: '../'
+gem 'pry'
+gem 'pry-nav'

data/example/config/deploy/local_git.rb

@@ -0,0 +1,4 @@
+set :bundle_rsync_scm, 'local_git'
+set :repo_url, "#{ENV['HOME']}/src/github.com/sonots/try_rails4"
+
+role :app, ['127.0.0.1']

data/example/config/deploy/sample.rb

@@ -0,0 +1,5 @@
+set :bundle_rsync_scm, 'git'
+set :repo_url, 'https://github.com/sonots/try_rails4'
+set :branch, 'master'
+
+role :app, ['127.0.0.1']

data/example/config/deploy.rb

@@ -0,0 +1,28 @@
+# config valid only for Capistrano 3.2.1
+lock '3.2.1'
+
+set :user, 'game'
+set :ssh_options, user: ENV['USER'], keys: [File.expand_path('~/.ssh/id_rsa')]
+# set :default_env, { path: "/opt/ruby/bin:$PATH" }
+
+set :linked_dirs, %w(bin log tmp/pids tmp/cache tmp/sockets vendor/bundle public/system tmp/run)
+set :keep_releases, 5
+set :rbenv_type, :user
+set :rbenv_ruby, '2.1.2'
+set :deploy_to, "#{ENV['HOME']}/sample"
+
+set :scm, :bundle_rsync
+set :bundle_rsync_max_parallels, ENV['PARA']
+set :bundle_rsync_rsync_bwlimit, ENV['BWLIMIT'] # like 20000
+
+namespace :deploy do
+  desc 'Restart web application'
+  task :restart do
+    on roles(:web), in: :sequence, wait: 5 do
+      # execute some restart code
+    end
+  end
+
+  after :finishing, 'deploy:cleanup'
+  # after :publishing, :restart
+end

data/lib/capistrano/bundle_rsync/base.rb

@@ -0,0 +1,14 @@
+require 'delegate'
+require 'capistrano/bundle_rsync/config'
+
+module Capistrano::BundleRsync
+  class Base < SimpleDelegator
+    def initialize(delegator)
+      super(delegator)
+    end
+
+    def config
+      Capistrano::BundleRsync::Config
+    end
+  end
+end

data/lib/capistrano/bundle_rsync/bundler.rb

@@ -0,0 +1,59 @@
+require 'capistrano/bundle_rsync/base'
+
+class Capistrano::BundleRsync::Bundler < Capistrano::BundleRsync::Base
+  def prepare
+    hosts = release_roles(:all)
+    on hosts, in: :groups, limit: config.max_parallels(hosts) do
+      within release_path do
+        execute :mkdir, '-p', '.bundle'
+      end
+    end
+  end
+
+  def install
+    hosts = release_roles(:all)
+    Bundler.with_clean_env do
+      execute :bundle, "--gemfile #{config.local_release_path}/Gemfile --deployment --quiet --path #{config.local_bundle_path} --without development test --binstubs=#{config.local_bin_path}"
+    end
+
+    lines = <<-EOS
+---
+BUNDLE_FROZEN: '1'
+BUNDLE_PATH: #{shared_path.join('bundle')}
+BUNDLE_WITHOUT: development:test
+BUNDLE_DISABLE_SHARED_GEMS: '1'
+BUNDLE_BIN: #{shared_path.join('bin')}
+    EOS
+    bundle_config_path = "#{config.local_base_path}/bundle_config"
+    File.open(bundle_config_path, "w") {|file| file.print(lines) }
+
+    rsync_options = config.rsync_options
+    Parallel.each(hosts, in_processes: config.max_parallels(hosts)) do |host|
+      ssh = config.build_ssh_command(host)
+      if config_files = config.config_files
+        config_files.each do |config_file|
+          basename = File.basename(config_file)
+          execute :rsync, "#{rsync_options} --rsh='#{ssh}' #{config_file} #{host}:#{release_path}/config/#{basename}"
+        end
+      end
+
+      execute :rsync, "#{rsync_options} --rsh='#{ssh}' #{config.local_bundle_path}/ #{host}:#{shared_path}/bundle/"
+      execute :rsync, "#{rsync_options} --rsh='#{ssh}' #{config.local_bin_path}/ #{host}:#{shared_path}/bin/"
+      execute :rsync, "#{rsync_options} --rsh='#{ssh}' #{bundle_config_path} #{host}:#{release_path}/.bundle/config"
+    end
+
+    # Do not remove if :bundle_rsync_local_release_path is directly specified.
+    unless fetch(:bundle_rsync_local_release_path)
+      releases = capture(:ls, '-x', config.local_releases_path).split
+      if releases.count >= config.keep_releases
+        directories = (releases - releases.last(config.keep_releases))
+        if directories.any?
+          directories_str = directories.map do |release|
+            releases_path.join(release)
+          end.join(" ")
+          execute :rm, '-rf', directories_str
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/bundle_rsync/config.rb

@@ -4,12 +4,16 @@ module Capistrano::BundleRsync
       @local_base_path ||= fetch(:bundle_rsync_local_base_path) || "#{Dir::pwd}/.local_repo"
     end
 
-    def self.local_repo_path
-      @local_repo_path ||= fetch(:bundle_rsync_local_repo_path) || "#{local_base_path}/repo"
+    def self.local_mirror_path
+      @local_mirror_path ||= fetch(:bundle_rsync_local_mirror_path) || "#{local_base_path}/mirror"
+    end
+
+    def self.local_releases_path
+      @local_releases_path ||= fetch(:bundle_rsync_local_releases_path) || "#{local_base_path}/releases"
     end
 
     def self.local_release_path
-      @local_release_path ||= fetch(:bundle_rsync_local_release_path) || "#{local_base_path}/release_#{Time.now.to_i}"
+      @local_release_path ||= fetch(:bundle_rsync_local_release_path) || "#{local_releases_path}/#{Time.new.strftime('%Y%m%d%H%M%S')}"
     end
 
     def self.local_bundle_path
@@ -69,6 +73,10 @@ module Capistrano::BundleRsync
       "ssh#{user_opt}#{key_opt}#{port_opt}"
     end
 
+    def self.keep_releases
+      @keep_releases = fetch(:bundle_rsync_keep_releases) || fetch(:keep_releases)
+    end
+
     # Fetch the :bundle_rsync_max_parallels,
     # where the default is the number of hosts
     def self.max_parallels(hosts)

data/lib/capistrano/bundle_rsync/git.rb

@@ -0,0 +1,43 @@
+require 'capistrano/bundle_rsync/scm'
+
+class Capistrano::BundleRsync::Git < Capistrano::BundleRsync::SCM
+  def check
+    exit 1 unless execute("git ls-remote #{repo_url}")
+    execute("mkdir -p #{config.local_base_path}")
+  end
+
+  def clone
+    if File.exist?("#{config.local_mirror_path}/HEAD")
+      info t(:mirror_exists, at: config.local_mirror_path)
+    else
+      execute :git, :clone, '--mirror', repo_url, config.local_mirror_path
+    end
+  end
+
+  def update
+    within config.local_mirror_path do
+      execute :git, :remote, :update
+    end
+  end
+
+  def create_release
+    hosts = release_roles(:all)
+    execute "mkdir -p #{config.local_release_path}"
+
+    within config.local_mirror_path do
+      execute :git, :archive, fetch(:branch), '| tar -x -C', "#{config.local_release_path}"
+    end
+
+    rsync_options = config.rsync_options
+    Parallel.each(hosts, in_processes: config.max_parallels(hosts)) do |host|
+      ssh = config.build_ssh_command(host)
+      execute :rsync, "#{rsync_options} --rsh='#{ssh}' #{config.local_release_path}/ #{host}:#{release_path}/"
+    end
+  end
+
+  def set_current_revision
+    within config.local_mirror_path do
+      set :current_revision, capture(:git, "rev-parse --short #{fetch(:branch)}")
+    end
+  end
+end

data/lib/capistrano/bundle_rsync/local_git.rb

@@ -0,0 +1,42 @@
+require 'capistrano/bundle_rsync/scm'
+
+class Capistrano::BundleRsync::LocalGit < Capistrano::BundleRsync::SCM
+  def check
+    raise ArgumentError.new('`repo_url` must be local path to use `local_git` scm') unless local_path?(repo_url)
+    exit 1 unless execute("git ls-remote #{repo_url}")
+    execute("mkdir -p #{config.local_base_path}")
+  end
+
+  def clone
+  end
+
+  def update
+  end
+
+  def create_release
+    hosts = release_roles(:all)
+    rsync_options = config.rsync_options
+    Parallel.each(hosts, in_processes: config.max_parallels(hosts)) do |host|
+      ssh = config.build_ssh_command(host)
+      execute :rsync, "#{rsync_options} --rsh='#{ssh}' #{repo_url}/ #{host}:#{release_path}/"
+    end
+  end
+
+  def set_current_revision
+    within repo_url do
+      set :current_revision, capture(:git, "rev-parse --short HEAD")
+    end
+  end
+
+  private
+
+  def local_path?(repo_url)
+    return !(
+      repo_url.start_with?('http://') or
+      repo_url.start_with?('https://') or
+      repo_url.start_with?('git://') or
+      repo_url.start_with?('git@') or
+      repo_url.start_with?('ssh://')
+    )
+  end
+end

data/lib/capistrano/bundle_rsync/scm.rb

@@ -0,0 +1,80 @@
+require 'capistrano/bundle_rsync/base'
+
+# Base class for SCM strategy providers.
+#
+# @abstract
+class Capistrano::BundleRsync::SCM < Capistrano::BundleRsync::Base
+  # @abstract
+  #
+  # Your implementation should check the existence of a cache repository on
+  # the deployment target
+  #
+  # @return [Boolean]
+  #
+  def test
+    raise NotImplementedError.new(
+      "Your SCM strategy module should provide a #test method"
+    )
+  end
+
+  # @abstract
+  #
+  # Your implementation should check if the specified remote-repository is
+  # available.
+  #
+  # @return [Boolean]
+  #
+  def check
+    raise NotImplementedError.new(
+      "Your SCM strategy module should provide a #check method"
+    )
+  end
+
+  # @abstract
+  #
+  # Create a (new) clone of the remote-repository on the deployment target
+  #
+  # @return void
+  #
+  def clone
+    raise NotImplementedError.new(
+      "Your SCM strategy module should provide a #clone method"
+    )
+  end
+
+  # @abstract
+  #
+  # Update the clone on the deployment target
+  #
+  # @return void
+  #
+  def update
+    raise NotImplementedError.new(
+      "Your SCM strategy module should provide a #update method"
+    )
+  end
+
+  # @abstract
+  #
+  # Copy the contents of the cache-repository onto the release path
+  #
+  # @return void
+  #
+  def create_release
+    raise NotImplementedError.new(
+      "Your SCM strategy module should provide a #create_release method"
+    )
+  end
+
+  # @abstract
+  #
+  # Identify the SHA of the commit that will be deployed.  This will most likely involve SshKit's capture method.
+  #
+  # @return void
+  #
+  def set_current_revision
+    raise NotImplementedError.new(
+      "Your SCM strategy module should provide a #set_current_revision method"
+    )
+  end
+end

data/lib/capistrano/bundle_rsync.rb

@@ -3,5 +3,4 @@ module Capistrano
   end
 end
 
-require 'capistrano/bundle_rsync/config'
 load File.expand_path('../tasks/bundle_rsync.rake', __FILE__)

data/lib/capistrano/tasks/bundle_rsync.rake

@@ -2,126 +2,69 @@ unless defined?(Capistrano::BundleRsync::TASK_LOADED) # protect multiple loads
 Capistrano::BundleRsync::TASK_LOADED = true
 require 'fileutils'
 require 'parallel'
+require 'capistrano/bundle_rsync/bundler'
 
 namespace :bundle_rsync do
-  def config
-    Capistrano::BundleRsync::Config
+  def bundler
+    @bundler ||= Capistrano::BundleRsync::Bundler.new(self)
   end
 
-  namespace :bundler do
-    task :install do
-      hosts = roles(:all)
-      on hosts, in: :groups, limit: config.max_parallels(hosts) do
-        within release_path do
-          execute :mkdir, '-p', '.bundle'
-        end
+  def scm
+    @scm ||=
+      if fetch(:bundle_rsync_scm) == 'local_git'
+        require 'capistrano/bundle_rsync/local_git'
+        set :bundle_rsync_local_release_path, repo_url
+        Capistrano::BundleRsync::LocalGit.new(self)
+      else
+        require 'capistrano/bundle_rsync/git'
+        Capistrano::BundleRsync::Git.new(self)
       end
+  end
 
+  namespace :bundler do
+    task :install do
+      bundler.prepare
       run_locally do
-        Bundler.with_clean_env do
-          execute :bundle, "--gemfile #{config.local_release_path}/Gemfile --deployment --quiet --path #{config.local_bundle_path} --without development test --binstubs=#{config.local_bin_path}"
-        end
-
-        lines = <<-EOS
----
-BUNDLE_FROZEN: '1'
-BUNDLE_PATH: #{shared_path.join('bundle')}
-BUNDLE_WITHOUT: development:test
-BUNDLE_DISABLE_SHARED_GEMS: '1'
-BUNDLE_BIN: #{shared_path.join('bin')}
-        EOS
-        bundle_config_path = "#{config.local_base_path}/bundle_config"
-        File.open(bundle_config_path, "w") {|file| file.print(lines) }
-
-        rsync_options = config.rsync_options
-        Parallel.each(hosts, in_processes: config.max_parallels(hosts)) do |host|
-          ssh = config.build_ssh_command(host)
-          if config_files = config.config_files
-            config_files.each do |config_file|
-              basename = File.basename(config_file)
-              execute :rsync, "#{rsync_options} --rsh='#{ssh}' #{config_file} #{host}:#{release_path}/config/#{basename}"
-            end
-          end
-
-          execute :rsync, "#{rsync_options} --rsh='#{ssh}' #{config.local_bundle_path}/ #{host}:#{shared_path}/bundle/"
-          execute :rsync, "#{rsync_options} --rsh='#{ssh}' #{config.local_bin_path}/ #{host}:#{shared_path}/bin/"
-          execute :rsync, "#{rsync_options} --rsh='#{ssh}' #{bundle_config_path} #{host}:#{release_path}/.bundle/config"
-        end
-
-        FileUtils.rm_rf(config.local_release_path)
+        bundler.install
       end
     end
   end
 
   desc 'Check that the repository is reachable'
   task :check do
-    fetch(:branch)
     run_locally do
-      exit 1 unless execute("git ls-remote #{repo_url}")
-      execute("mkdir -p #{config.local_base_path}")
+      scm.check
     end
   end
 
   desc 'Clone the repo to the cache'
   task :clone do
     run_locally do
-      if File.exist?("#{config.local_repo_path}/HEAD")
-        info t(:mirror_exists, at: config.local_repo_path)
-      else
-        execute :git, :clone, '--mirror', repo_url, config.local_repo_path
-      end
+      scm.clone
     end
   end
 
   desc 'Update the repo mirror to reflect the origin state'
   task update: :'bundle_rsync:clone' do
     run_locally do
-      within config.local_repo_path do
-        execute :git, :remote, :update
-      end
+      scm.update
     end
   end
 
   desc 'Copy repo to releases'
   task create_release: :'bundle_rsync:update' do
-    hosts = roles(:all)
     run_locally do
-      execute "mkdir -p #{config.local_release_path}"
-
-      within config.local_repo_path do
-        execute :git, :archive, fetch(:branch), '| tar -x -C', "#{config.local_release_path}"
-      end
-
-      rsync_options = config.rsync_options
-      Parallel.each(hosts, in_processes: config.max_parallels(hosts)) do |host|
-        ssh = config.build_ssh_command(host)
-        execute :rsync, "#{rsync_options} --rsh='#{ssh}' #{config.local_release_path}/ #{host}:#{release_path}/"
-      end
+      scm.create_release
     end
   end
 
   desc 'Determine the revision that will be deployed'
   task :set_current_revision do
     run_locally do
-      within config.local_repo_path do
-        set :current_revision, capture(:git, "rev-parse --short #{fetch(:branch)}")
-      end
+      scm.set_current_revision
     end
   end
 
   before 'deploy:updated', 'bundle_rsync:bundler:install'
 end
-
-namespace :load do
-  task :defaults do
-    set :bundle_rsync_local_base_path, nil
-    set :bundle_rsync_local_repo_path, nil
-    set :bundle_rsync_local_release_path, nil
-    set :bundle_rsync_local_bundle_path, nil
-    set :bundle_rsync_local_bin_path, nil
-    set :bundle_rsync_config_files, nil
-    set :bundle_rsync_ssh_options, nil # Default to be ssh_options. Note: :password is not supported.
-    set :bundle_rsync_max_parallels, nil
-  end
-end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-bundle_rsync
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - sonots
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-09 00:00:00.000000000 Z
+date: 2014-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -82,9 +82,19 @@ files:
 - README.md
 - Rakefile
 - capistrano-bundle_rsync.gemspec
+- example/Capfile
+- example/Gemfile
+- example/config/deploy.rb
+- example/config/deploy/local_git.rb
+- example/config/deploy/sample.rb
 - lib/capistrano-bundle_rsync.rb
 - lib/capistrano/bundle_rsync.rb
+- lib/capistrano/bundle_rsync/base.rb
+- lib/capistrano/bundle_rsync/bundler.rb
 - lib/capistrano/bundle_rsync/config.rb
+- lib/capistrano/bundle_rsync/git.rb
+- lib/capistrano/bundle_rsync/local_git.rb
+- lib/capistrano/bundle_rsync/scm.rb
 - lib/capistrano/tasks/bundle_rsync.rake
 homepage: https://github.com/sonots/capistrano-bundle_rsync
 licenses: