capistrano-git-copy 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0c1bd7f1f0427e2237d05ec40bfd2b04c263cc1d
-  data.tar.gz: a04f09b5de4cf6fc31191910d20aa0809e0fe851
+  metadata.gz: 5674b8d5f3ded4e8674afea47a7f1f60b5642b03
+  data.tar.gz: 9bdc1dcf572d1172e3bfbb7a1c1dc8b76fb4fb13
 SHA512:
-  metadata.gz: ace9a0e03014d24d19e691725adb5a068701eb1fd074d19d47d08cdf7af1d6d0e195e06c64f813c9d80c640a661046a79e4e7c8042c33714b99393a1c6e6c08a
-  data.tar.gz: fa69a38fec6225118f9cbf35e7b38d5325802ba7506896e3991aadaf9b4abeb94991347eda42947158cf28f10bbe7f12b88fec4fe164ace0447a9f91e2959eea
+  metadata.gz: d4dcfa2bf859b3b332a7b2500ffd11b912724ccb670fd81d20b34bacd8abe4d5ab005a4b90e4d79d07101de304dee2bb22b144da1745973a21a777063b00bde5
+  data.tar.gz: 8e2dd9adb6f3ea20954d99c1641d1534ffd9cb768e0eee46660bc19fed41544c218633fd09b32c38fbb38157dbf35581cb66fafbe683ed5a50d6c9d8482a366c

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Change Log
 
+## 1.3.0 (2016-12-11)
+  - capistrano 3.7.x compatibility - see updated README.md
+
 ## 1.2.1 (2016-12-11)
 ### Changes
   - updated _git-archive-all_ to HEAD

data/README.md

@@ -23,23 +23,20 @@ And require it in your `Capfile`:
 
 ```ruby
 require 'capistrano/git_copy'
+install_plugin Capistrano::GitCopy::SCM
 ```
 
-Now use `git_copy` as your SCM type in your `config/deploy.rb`:
-
-    set :scm, :git_copy
-
 By default, it includes all submodules into the deployment package. However,
 if they are not needed in a particular deployment, you can disable them with
 a configuration option:
-
-    set :with_submodules, false
-
+```ruby
+set :with_submodules, false
+```
 Besides using `export-ignore` in `.gitattributes` it's possible exclude files and directories by
 adding them to `git_excludes`:
-
-    set :git_excludes, %w(config/database.yml.example test rspec)
-
+```ruby
+append :git_excludes, 'config/database.yml.example', 'test', 'rspec'
+```
 ## Notes
 
 * Uses [git-archive-all](https://github.com/Kentzo/git-archive-all) for bundling repositories.

data/capistrano-git-copy.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Capistrano::GitCopy::VERSION
   spec.authors       = ['Florian Schwab']
   spec.email         = ['me@ydkn.de']
-  spec.description   = 'Copy local git repository deploy strategy for capistrano'
-  spec.summary       = 'Copy local git repository deploy strategy for capistrano'
+  spec.description   = 'Copy local git repository deploy strategy for capistrano.'
+  spec.summary       = 'Copy local git repository deploy strategy for capistrano.'
   spec.homepage      = 'https://github.com/ydkn/capistrano-git-copy'
   spec.license       = 'MIT'
 
@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'capistrano', '>= 3.1.0', '< 3.7.0'
+  spec.add_dependency 'capistrano', '>= 3.7.0', '< 4.0.0'
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'

data/lib/capistrano/git_copy.rb

@@ -1,2 +1 @@
-require 'capistrano/git_copy/utility'
-require 'capistrano/git_copy/task'
+require 'capistrano/git_copy/scm'

data/lib/capistrano/git_copy/scm.rb

@@ -0,0 +1,203 @@
+require 'capistrano/scm/plugin'
+
+module Capistrano
+  module GitCopy
+    class SCM < ::Capistrano::SCM::Plugin
+      # set default values
+      def set_defaults
+        set_if_empty :with_submodules, true
+        set_if_empty :git_excludes,    []
+        set_if_empty :repo_tree,       false
+      end
+
+      # define plugin tasks
+      def define_tasks
+        eval_rakefile File.expand_path('../tasks/git_copy.rake', __FILE__)
+      end
+
+      # register capistrano hooks
+      def register_hooks
+        after  'deploy:new_release_path',     'git_copy:create_release'
+        before 'deploy:check',                'git_copy:check'
+        before 'deploy:set_current_revision', 'git_copy:set_current_revision'
+      end
+
+      # Check if repository is accessible
+      #
+      # @return void
+      def check
+        git(:'ls-remote --heads', repo_url)
+      end
+
+      # Check if repository cache exists and is valid
+      #
+      # @return [Boolean] indicates if repo cache exists
+      def test
+        if backend.test("[ -d #{repo_cache_path} ]")
+          backend.within(repo_cache_path) do
+            if backend.test(:git, :status, '>/dev/null 2>/dev/null')
+              true
+            else
+              backend.execute(:rm, '-rf', repo_cache_path)
+
+              false
+            end
+          end
+        else
+          false
+        end
+      end
+
+      # Clone repo to cache
+      #
+      # @return void
+      def clone
+        backend.execute(:mkdir, '-p', tmp_path)
+
+        git(:clone, fetch(:repo_url), repo_cache_path)
+      end
+
+      # Update repo and submodules to branch
+      #
+      # @return void
+      def update
+        git(:remote, :update)
+        git(:reset, '--hard', commit_hash)
+
+        # submodules
+        if fetch(:with_submodules)
+          git(:submodule, :init)
+          git(:submodule, :update)
+          git(:submodule, :foreach, '--recursive', :git, :submodule, :update, '--init')
+        end
+
+        # cleanup
+        git(:clean, '-d', '-f')
+
+        if fetch(:with_submodules)
+          git(:submodule, :foreach, '--recursive', :git, :clean, '-d', '-f')
+        end
+      end
+
+      # Create tar archive
+      #
+      # @return void
+      def prepare_release
+        target = fetch(:repo_tree) ? "HEAD:#{fetch(:repo_tree)}" : 'HEAD'
+
+        if fetch(:with_submodules)
+          backend.execute(git_archive_all_bin, "--prefix=''", archive_path)
+        else
+          git(:archive, '--format=tar', target, '|', 'gzip', "> #{archive_path}")
+        end
+
+        exclude_files_from_archive if fetch(:git_excludes, []).count > 0
+      end
+
+      # Upload and extract release
+      #
+      # @return void
+      def release
+        backend.execute :mkdir, '-p', release_path
+
+        remote_archive_path = File.join(fetch(:deploy_to), File.basename(archive_path))
+
+        backend.upload!(archive_path, remote_archive_path)
+
+        backend.execute(:mkdir, '-p', release_path)
+        backend.execute(:tar, '-f', remote_archive_path, '-x', '-C', release_path)
+        backend.execute(:rm, '-f', remote_archive_path)
+      end
+
+      # Set deployed revision
+      #
+      # @return void
+      def fetch_revision
+        backend.capture(:git, 'rev-list', '--max-count=1', '--abbrev-commit', commit_hash).strip
+      end
+
+      # Cleanup repo cache
+      #
+      # @return void
+      def cleanup
+        backend.execute(:rm, '-rf', tmp_path)
+
+        backend.info('Local repo cache was removed')
+      end
+
+      # Temporary path for all git-copy operations
+      #
+      # @return [String]
+      def tmp_path
+        @_tmp_path ||= File.join(Dir.tmpdir, deploy_id)
+      end
+
+      # Path to repository cache
+      #
+      # @return [String]
+      def repo_cache_path
+        @_repo_cache_path ||= File.join(tmp_path, 'repo')
+      end
+
+      # Path to archive
+      #
+      # @return [String]
+      def archive_path
+        @_archive_path ||= File.join(tmp_path, 'archive.tar.gz')
+      end
+
+      private
+
+      def deploy_id
+        [
+          fetch(:application),
+          fetch(:stage),
+          Digest::MD5.hexdigest(fetch(:repo_url))[0..7],
+          Digest::MD5.hexdigest(Dir.getwd)[0..7]
+        ].compact.join('_').gsub(/[^\w]/, '')
+      end
+
+      def commit_hash
+        return @_commit_hash if @_commit_hash
+
+        branch = fetch(:branch, 'master').to_s.strip
+
+        if backend.test(:git, 'rev-parse', "origin/#{branch}", '>/dev/null 2>/dev/null')
+          @_commit_hash = backend.capture(:git, 'rev-parse', "origin/#{branch}").strip
+        else
+          @_commit_hash = backend.capture(:git, 'rev-parse', branch).strip
+        end
+      end
+
+      def git_archive_all_bin
+        File.expand_path('../../../../vendor/git-archive-all/git_archive_all.py', __FILE__)
+      end
+
+      def git(*args)
+        backend.execute(:git, *args)
+      end
+
+      def exclude_files_from_archive
+        archive_dir = File.join(tmp_path, 'archive')
+
+        backend.execute :rm, '-rf', archive_dir
+        backend.execute :mkdir, '-p', archive_dir
+        backend.execute :tar, '-xzf', archive_path, '-C', archive_dir
+
+        fetch(:git_excludes, []).each do |f|
+          file_path = File.join(archive_dir, f.gsub(/\A\//, ''))
+
+          unless File.exists?(file_path)
+            backend.warn("#{f} does not exists!")
+
+            next
+          end
+
+          FileUtils.rm_rf(file_path)
+        end
+
+        backend.execute :tar, '-czf', archive_path, '-C', archive_dir, '.'
+      end
+    end
+  end
+end

data/lib/capistrano/git_copy/tasks/git_copy.rake

@@ -0,0 +1,59 @@
+git_copy_plugin = self
+
+namespace :git_copy do
+  desc 'Check that the repository is reachable'
+  task :check do
+    run_locally do
+      git_copy_plugin.check
+    end
+  end
+
+  desc 'Clone the repo to the cache'
+  task :clone do
+    run_locally do
+      if git_copy_plugin.test
+        info t(:mirror_exists, at: git_copy_plugin.repo_cache_path)
+      else
+        git_copy_plugin.clone
+      end
+    end
+  end
+
+  desc 'Update the repo mirror to reflect the origin state'
+  task update: :'git_copy:clone' do
+    run_locally do
+      within git_copy_plugin.repo_cache_path do
+        git_copy_plugin.update
+      end
+    end
+  end
+
+  desc 'Copy repo to releases'
+  task create_release: :'git_copy:update' do
+    run_locally do
+      within git_copy_plugin.repo_cache_path do
+        git_copy_plugin.prepare_release
+      end
+    end
+
+    on release_roles :all do
+      git_copy_plugin.release
+    end
+  end
+
+  desc 'Determine the revision that will be deployed'
+  task set_current_revision: :'git_copy:update' do
+    run_locally do
+      within git_copy_plugin.repo_cache_path do
+        set :current_revision, git_copy_plugin.fetch_revision
+      end
+    end
+  end
+
+  desc 'Clean repo cache'
+  task :cleanup do
+    run_locally do
+      git_copy_plugin.cleanup
+    end
+  end
+end

data/lib/capistrano/git_copy/version.rb

@@ -3,6 +3,6 @@ module Capistrano
   # GitCopy
   module GitCopy
     # gem version
-    VERSION = '1.2.1'
+    VERSION = '1.3.0'
   end
 end

data/vendor/git-archive-all/git_archive_all.py

@@ -34,7 +34,7 @@ import tarfile
 from zipfile import ZipFile, ZipInfo, ZIP_DEFLATED
 import re
 
-__version__ = "1.13"
+__version__ = "1.15"
 
 
 class GitArchiver(object):
@@ -306,10 +306,8 @@ class GitArchiver(object):
             file_name = path.basename(repo_file_path)
             main_repo_file_path = path.join(repo_path, repo_file_path)  # file path relative to the main repo
 
-            # Only list symlinks and files that don't start with git.
-            if file_name.startswith(".git") or (
-                not path.islink(main_repo_file_path) and path.isdir(main_repo_file_path)
-            ):
+            # Only list symlinks and files.
+            if not path.islink(main_repo_file_path) and path.isdir(main_repo_file_path):
                 continue
 
             if self.is_file_excluded(repo_abspath, repo_file_path, exclude_patterns):

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-git-copy
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Florian Schwab
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.7.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.7.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -72,7 +72,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Copy local git repository deploy strategy for capistrano
+description: Copy local git repository deploy strategy for capistrano.
 email:
 - me@ydkn.de
 executables: []
@@ -87,11 +87,9 @@ files:
 - README.md
 - Rakefile
 - capistrano-git-copy.gemspec
-- lib/capistrano/git/copy.rb
 - lib/capistrano/git_copy.rb
-- lib/capistrano/git_copy/task.rb
-- lib/capistrano/git_copy/tasks/deploy.cap
-- lib/capistrano/git_copy/utility.rb
+- lib/capistrano/git_copy/scm.rb
+- lib/capistrano/git_copy/tasks/git_copy.rake
 - lib/capistrano/git_copy/version.rb
 - vendor/git-archive-all/git_archive_all.py
 homepage: https://github.com/ydkn/capistrano-git-copy
@@ -117,5 +115,5 @@ rubyforge_project:
 rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
-summary: Copy local git repository deploy strategy for capistrano
+summary: Copy local git repository deploy strategy for capistrano.
 test_files: []

data/lib/capistrano/git/copy.rb

@@ -1 +0,0 @@
-STDERR.puts("[DEPRECATION] Please change \"require 'capistrano/git/copy'\" to \"require 'capistrano/git_copy'\" in your Capfile, and make sure to disable the default require in your Gemfile with 'gem \"capistrano-git-copy\", require: false\"' to make this warning disappear.")

data/lib/capistrano/git_copy/task.rb

@@ -1 +0,0 @@
-load File.expand_path('../tasks/deploy.cap', __FILE__)

data/lib/capistrano/git_copy/tasks/deploy.cap

@@ -1,70 +0,0 @@
-namespace :load do
-  task :defaults do
-     set :with_submodules, fetch(:with_submodules, true)
-     set :git_excludes,    fetch(:git_excludes, [])
-  end
-end
-
-namespace :git_copy do
-  def git_copy_utility
-    @git_copy_utility ||= Capistrano::GitCopy::Utility.new(self)
-  end
-
-  task :wrapper do; end
-
-  desc 'Check that the repository is reachable'
-  task check: :'git_copy:wrapper' do
-    run_locally do
-      git_copy_utility.check
-    end
-  end
-
-  desc 'Clone the repo to the cache'
-  task clone: :'git_copy:wrapper' do
-    run_locally do
-      if git_copy_utility.test
-        info t(:mirror_exists, at: git_copy_utility.repo_path)
-      else
-        git_copy_utility.clone
-      end
-    end
-  end
-
-  desc 'Update the repo mirror to reflect the origin state'
-  task update: :'git_copy:clone' do
-    run_locally do
-      within git_copy_utility.repo_path do
-        git_copy_utility.update
-      end
-    end
-  end
-
-  desc 'Copy repo to releases'
-  task create_release: :'git_copy:update' do
-    run_locally do
-      within git_copy_utility.repo_path do
-        git_copy_utility.prepare_release
-      end
-    end
-
-    on release_roles :all do
-      git_copy_utility.release
-    end
-  end
-
-  desc 'Determine the revision that will be deployed'
-  task set_current_revision: :'git_copy:update' do
-    run_locally do
-      within git_copy_utility.repo_path do
-        set :current_revision, git_copy_utility.fetch_revision
-      end
-    end
-  end
-
-  desc 'Clean repo cache'
-  task :cleanup do
-    run_locally do
-      git_copy_utility.cleanup
-    end
-  end
-end

data/lib/capistrano/git_copy/utility.rb

@@ -1,219 +0,0 @@
-require 'tmpdir'
-require 'digest/md5'
-
-module Capistrano
-  module GitCopy
-    # Utility stuff to avoid cluttering of deploy.cap
-    class Utility
-      attr_reader :with_submodules
-      attr_reader :git_excludes
-
-      def initialize(context)
-        @context         = context
-        @with_submodules = fetch(:with_submodules, true)
-        @repo_tree = fetch(:repo_tree, false)
-        @with_submodules = @repo_tree? false : @with_submodules # If repo_tree is specified, set with_submodules to false
-        @git_excludes    = fetch(:git_excludes, [])
-      end
-
-      # Check if repo cache exists and is valid
-      #
-      # @return [Boolean] indicates if repo cache exists
-      def test
-        if test!("[ -d #{repo_path} ]")
-          @context.within(repo_path) do
-            if test!(:git, :status, '>/dev/null 2>/dev/null')
-              true
-            else
-              execute(:rm, '-rf', repo_path)
-              false
-            end
-          end
-        else
-          false
-        end
-      end
-
-      # Check if repo is accessible
-      #
-      # @return void
-      def check
-        git(:'ls-remote --heads', repo_url)
-      end
-
-      # Clone repo to cache
-      #
-      # @return void
-      def clone
-        execute(:mkdir, '-p', tmp_path)
-
-        git(:clone, fetch(:repo_url), repo_path)
-      end
-
-      # Update repo and submodules to branch
-      #
-      # @return void
-      def update
-        git(:remote, :update)
-        git(:reset, '--hard', commit_hash)
-
-        # submodules
-        if with_submodules
-          git(:submodule, :init)
-          git(:submodule, :update)
-          git(:submodule, :foreach, '--recursive', :git, :submodule, :update, '--init')
-        end
-
-        # cleanup
-        git(:clean, '-d', '-f')
-        if with_submodules
-          git(:submodule, :foreach, '--recursive', :git, :clean, '-d', '-f')
-        end
-      end
-
-      # Create tar archive
-      #
-      # @return void
-      def prepare_release
-        target = @repo_tree? "HEAD:#{@repo_tree}" : 'HEAD'
-        if with_submodules
-          execute(git_archive_all_bin, "--prefix=''", archive_path)
-        else
-          git(:archive, '--format=tar', target, '|', 'gzip', "> #{archive_path}")
-        end
-
-        exclude_files_from_archive if git_excludes.count > 0
-      end
-
-      # Upload and extract release
-      #
-      # @return void
-      def release
-        remote_archive_path = File.join(fetch(:deploy_to), File.basename(archive_path))
-
-        upload!(archive_path, remote_archive_path)
-
-        execute(:mkdir, '-p', release_path)
-        execute(:tar, '-f', remote_archive_path, '-x', '-C', release_path)
-        execute(:rm, '-f', remote_archive_path)
-      end
-
-      # Set deployed revision
-      #
-      # @return void
-      def fetch_revision
-        capture(:git, 'rev-list', '--max-count=1', '--abbrev-commit', commit_hash).strip
-      end
-
-      # Cleanup repo cache
-      #
-      # @return void
-      def cleanup
-        execute(:rm, '-rf', tmp_path)
-
-        info('Local repo cache was removed')
-      end
-
-      # Temporary path for all git-copy operations
-      #
-      # @return [String]
-      def tmp_path
-        @_tmp_path ||= File.join(Dir.tmpdir, deploy_id)
-      end
-
-      # Path to repo cache
-      #
-      # @return [String]
-      def repo_path
-        @_repo_path ||= File.join(tmp_path, 'repo')
-      end
-
-      # Path to archive
-      #
-      # @return [String]
-      def archive_path
-        @_archive_path ||= File.join(tmp_path, 'archive.tar.gz')
-      end
-
-      private
-
-      def fetch(*args)
-        @context.fetch(*args)
-      end
-
-      def test!(*args)
-        @context.test(*args)
-      end
-
-      def execute(*args)
-        @context.execute(*args)
-      end
-
-      def capture(*args)
-        @context.capture(*args)
-      end
-
-      def upload!(*args)
-        @context.upload!(*args)
-      end
-
-      def info(*args)
-        @context.info(*args)
-      end
-
-      def warn(*args)
-        @context.warn(*args)
-      end
-
-      def git(*args)
-        execute(:git, *args)
-      end
-
-      def git_archive_all_bin
-        File.expand_path('../../../../vendor/git-archive-all/git_archive_all.py', __FILE__)
-      end
-
-      def deploy_id
-        [
-          fetch(:application),
-          fetch(:stage),
-          Digest::MD5.hexdigest(fetch(:repo_url))[0..7],
-          Digest::MD5.hexdigest(Dir.getwd)[0..7]
-        ].compact.join('_').gsub(/[^\w]/, '')
-      end
-
-      def commit_hash
-        return @_commit_hash if @_commit_hash
-
-        branch = fetch(:branch, 'master').to_s.strip
-
-        if test!(:git, 'rev-parse', "origin/#{branch}", '>/dev/null 2>/dev/null')
-          @_commit_hash = capture(:git, 'rev-parse', "origin/#{branch}").strip
-        else
-          @_commit_hash = capture(:git, 'rev-parse', branch).strip
-        end
-      end
-    end
-
-    def exclude_files_from_archive
-      archive_dir = File.join(tmp_path, 'archive')
-
-      execute :rm, '-rf', archive_dir
-      execute :mkdir, '-p', archive_dir
-      execute :tar, '-xzf', archive_path, '-C', archive_dir
-
-      git_excludes.each do |f|
-        file_path = File.join(archive_dir, f.gsub(/\A\//, ''))
-
-        unless File.exists?(file_path)
-          warn("#{f} does not exists!")
-          next
-        end
-
-        FileUtils.rm_rf(file_path)
-      end
-
-      execute :tar, '-czf', archive_path, '-C', archive_dir, '.'
-    end
-  end
-end