capistrano-git-copy 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d4ae3564eccef2c188c4176c2ad8f2276b1f7c88
-  data.tar.gz: 993bfa2dc61a9c78376b5af0847f7c0fed5c6ae3
+  metadata.gz: e7784ccb4cb4af337de3e9023b46775da88e48e4
+  data.tar.gz: 7f9abc9ceefb06d7247ecdc7c6080bdb2dd6a751
 SHA512:
-  metadata.gz: 4833479a333245dda86f3b10fe27b90fd5050be08b9ec10444d751c11745c75d586de4d6e67b5d25ea1d1869b888aeb22aa1e71f219579f268f839a76b98c7b5
-  data.tar.gz: 31bd01e829bd93683883deb00a2ba0f960979d1f5badd3e77b4f7e6d855eb8b0a12b9607e05e98b676d2d87de7a22de1312c8989da00f3455abdee9e442a024e
+  metadata.gz: 8dd0c5ad1efaf9c7c8a9da570d2c4bd51c4ecc52f3c85c8d8edffdea818d03489d628e5de526e18f5f8049491ee2cac52735c1a86fb40ed9ac8cc6d51fb89073
+  data.tar.gz: 10200bb1f194a6489a2cfc77a8086d093a6bda24349f1a56c49b585c88cd8d6d5e596972363ed7d54e1a1a7f7dafbbba6ba32b5fe266d9c3f8893d1d9951ec3b

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 1.2.0 (2016-01-25)
+### Changes
+  - Check if local repository mirror is working and reinitialize if necessary
+  - Added config option `git_excludes` to exclude files and directories
+  - updated _git-archive-all_ to v1.13
+
 ## 1.1.0 (2015-08-10)
 ### Changes
   - Deprecated: require 'capistrano/git/copy'

data/README.md

@@ -29,12 +29,17 @@ 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 
+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
 
+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)
+
 ## Notes
 
 * Uses [git-archive-all](https://github.com/Kentzo/git-archive-all) for bundling repositories.

data/capistrano-git-copy.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/ydkn/capistrano-git-copy'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/) + %w( vendor/git-archive-all/git-archive-all )
+  spec.files         = `git ls-files`.split($/) + %w( vendor/git-archive-all/git_archive_all.py )
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']

data/lib/capistrano/git/copy.rb

@@ -1 +1 @@
-STDERR.puts("[DEPRECATION] Please change \"require 'capistrano/git/copy'\" to \"require 'capistrano/git_copy'\" in your Capfile.")
+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/tasks/deploy.cap

@@ -1,6 +1,7 @@
 namespace :load do
   task :defaults do
-     set :with_submodules, true
+     set :with_submodules, fetch(:with_submodules, true)
+     set :git_excludes,    fetch(:git_excludes, [])
   end
 end
 

data/lib/capistrano/git_copy/utility.rb

@@ -6,53 +6,66 @@ module Capistrano
     # Utility stuff to avoid cluttering of deploy.cap
     class Utility
       attr_reader :with_submodules
+      attr_reader :git_excludes
 
       def initialize(context)
-        @context = context
+        @context         = context
         @with_submodules = fetch(:with_submodules, true)
+        @git_excludes    = fetch(:git_excludes, [])
       end
 
-      # Check if repo cache exists
+      # Check if repo cache exists and is valid
       #
       # @return [Boolean] indicates if repo cache exists
       def test
-        test! " [ -d #{repo_path} ] "
+        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
+        git(:'ls-remote --heads', repo_url)
       end
 
       # Clone repo to cache
       #
       # @return void
       def clone
-        execute :mkdir, '-p', tmp_path
+        execute(:mkdir, '-p', tmp_path)
 
-        git :clone, fetch(:repo_url), repo_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
+        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'
+          git(:submodule, :init)
+          git(:submodule, :update)
+          git(:submodule, :foreach, '--recursive', :git, :submodule, :update, '--init')
         end
 
         # cleanup
-        git :clean, '-d', '-f'
+        git(:clean, '-d', '-f')
         if with_submodules
-          git :submodule, :foreach, '--recursive', :git, :clean, '-d', '-f'
+          git(:submodule, :foreach, '--recursive', :git, :clean, '-d', '-f')
         end
       end
 
@@ -61,9 +74,30 @@ module Capistrano
       # @return void
       def prepare_release
         if with_submodules
-          execute git_archive_all_bin, "--prefix=''", archive_path
+          execute(git_archive_all_bin, "--prefix=''", archive_path)
         else
-          git "archive --format=tar HEAD | gzip > #{archive_path}"
+          git(:archive, '--format=tar', 'HEAD', '|', 'gzip', "> #{archive_path}")
+        end
+
+        if git_excludes.count > 0
+          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
 
@@ -73,11 +107,11 @@ module Capistrano
       def release
         remote_archive_path = File.join(fetch(:deploy_to), File.basename(archive_path))
 
-        upload! archive_path, remote_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
+        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
@@ -91,9 +125,9 @@ module Capistrano
       #
       # @return void
       def cleanup
-        execute :rm, '-rf', tmp_path
+        execute(:rm, '-rf', tmp_path)
 
-        info 'Local repo cache was removed'
+        info('Local repo cache was removed')
       end
 
       # Temporary path for all git-copy operations
@@ -143,12 +177,16 @@ module Capistrano
         @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', __FILE__)
+        File.expand_path('../../../../vendor/git-archive-all/git_archive_all.py', __FILE__)
       end
 
       def deploy_id
@@ -165,7 +203,7 @@ module Capistrano
 
         branch = fetch(:branch, 'master').to_s.strip
 
-        if test! :git, 'rev-parse', "origin/#{branch}", '>/dev/null 2>/dev/null'
+        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

data/lib/capistrano/git_copy/version.rb

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

data/vendor/git-archive-all/{git-archive-all → git_archive_all.py}

@@ -1,11 +1,31 @@
 #! /usr/bin/env python
 # coding=utf-8
 
+# The MIT License (MIT)
+#
+# Copyright (c) 2010 Ilya Kulakov
+#
+# 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.
+
 from __future__ import print_function
 from __future__ import unicode_literals
 
-__version__ = "1.9"
-
 import logging
 from os import extsep, path, readlink, curdir
 from subprocess import CalledProcessError, Popen, PIPE
@@ -13,6 +33,8 @@ import sys
 import tarfile
 from zipfile import ZipFile, ZipInfo, ZIP_DEFLATED
 
+__version__ = "1.13"
+
 
 class GitArchiver(object):
     """
@@ -64,9 +86,12 @@ class GitArchiver(object):
         try:
             self.run_shell("[ -d .git ] || git rev-parse --git-dir > /dev/null 2>&1", main_repo_abspath)
         except Exception as e:
-            raise ValueError("Not a git repository (or any of the parent directories).")
+            raise ValueError("{0} not a git repository (or any of the parent directories).".format(main_repo_abspath))
 
-        main_repo_abspath = path.abspath(self.read_git_shell('git rev-parse --show-toplevel', main_repo_abspath).rstrip())
+        main_repo_abspath = path.abspath(
+            self.read_git_shell('git rev-parse --show-toplevel', main_repo_abspath)
+            .rstrip()
+        )
 
         self.prefix = prefix
         self.exclude = exclude
@@ -94,7 +119,7 @@ class GitArchiver(object):
         if output_format is None:
             file_name, file_ext = path.splitext(output_path)
             output_format = file_ext[len(extsep):].lower()
-            self.LOG.debug("Output format is not explicitly set, determined format is {}.".format(output_format))
+            self.LOG.debug("Output format is not explicitly set, determined format is {0}.".format(output_format))
 
         if not dry_run:
             if output_format == 'zip':
@@ -116,21 +141,25 @@ class GitArchiver(object):
                 elif output_format == 'txz':
                     t_mode = 'w:xz'
                 else:
-                    t_mode = 'w:{}'.format(output_format)
+                    t_mode = 'w:{0}'.format(output_format)
 
                 archive = tarfile.open(path.abspath(output_path), t_mode)
-                add_file = lambda file_path, arcname: archive.add(file_path, arcname)
+
+                def add_file(file_path, arcname):
+                    archive.add(file_path, arcname)
             else:
-                raise RuntimeError("Unknown format: {}".format(output_format))
+                raise RuntimeError("Unknown format: {0}".format(output_format))
 
             def archiver(file_path, arcname):
-                self.LOG.debug("Compressing {} => {}...".format(file_path, arcname))
+                self.LOG.debug("Compressing {0} => {1}...".format(file_path, arcname))
                 add_file(file_path, arcname)
         else:
             archive = None
-            archiver = lambda file_path, arcname: self.LOG.info("{} => {}".format(file_path, arcname))
 
-        self.archive_all_files(archiver)
+            def archiver(file_path, arcname):
+                self.LOG.info("{0} => {1}".format(file_path, arcname))
+
+        self.archive_all_files(archiver)  # this will take care of submodule init and update
 
         if archive is not None:
             archive.close()
@@ -225,7 +254,7 @@ class GitArchiver(object):
                 patterns = exclude_patterns[key]
                 for p in patterns:
                     if fnmatch(file_name, p) or fnmatch(repo_file_path, p):
-                        self.LOG.debug("Exclude pattern matched {}: {}".format(p, repo_file_path))
+                        self.LOG.debug("Exclude pattern matched {0}: {1}".format(p, repo_file_path))
                         is_excluded = True
 
             if not len(components):
@@ -239,7 +268,8 @@ class GitArchiver(object):
         """
         Archive all files using archiver.
 
-        @param archiver: Function that accepts 2 arguments: abspath to file on the system and relative path within archive.
+        @param archiver: Callable that accepts 2 arguments:
+            abspath to file on the system and relative path within archive.
         """
         for file_path in self.extra:
             archiver(path.abspath(file_path), path.join(self.prefix, file_path))
@@ -263,7 +293,10 @@ class GitArchiver(object):
         @return:    Iterator to traverse files under git control relative to main_repo_abspath.
         """
         repo_abspath = path.join(self.main_repo_abspath, repo_path)
-        repo_file_paths = self.read_git_shell("git ls-files --cached --full-name --no-empty-directory", repo_abspath).splitlines()
+        repo_file_paths = self.read_git_shell(
+            "git ls-files --cached --full-name --no-empty-directory",
+            repo_abspath
+        ).splitlines()
         exclude_patterns = self.get_exclude_patterns(repo_abspath, repo_file_paths)
 
         for repo_file_path in repo_file_paths:
@@ -273,7 +306,9 @@ class GitArchiver(object):
             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)):
+            if file_name.startswith(".git") or (
+                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):
@@ -322,7 +357,10 @@ class GitArchiver(object):
             raise ValueError("abspath MUST be absoulte path.")
 
         if not path.commonprefix([repo_abspath, abspath]):
-            raise ValueError("abspath (\"{}\") MUST have common prefix with repo_abspath (\"{}\")".format(abspath, repo_abspath))
+            raise ValueError(
+                "abspath (\"{0}\") MUST have common prefix with repo_abspath (\"{1}\")"
+                .format(abspath, repo_abspath)
+            )
 
         components = []
 
@@ -383,7 +421,7 @@ class GitArchiver(object):
         output = output.decode(encoding)
 
         if p.returncode:
-            if sys.version_info > (2,6):
+            if sys.version_info > (2, 6):
                 raise CalledProcessError(returncode=p.returncode, cmd=cmd, output=output)
             else:
                 raise CalledProcessError(returncode=p.returncode, cmd=cmd)
@@ -411,7 +449,7 @@ class GitArchiver(object):
         output = output.decode('unicode_escape').encode('raw_unicode_escape').decode('utf-8')
 
         if p.returncode:
-            if sys.version_info > (2,6):
+            if sys.version_info > (2, 6):
                 raise CalledProcessError(returncode=p.returncode, cmd=cmd, output=output)
             else:
                 raise CalledProcessError(returncode=p.returncode, cmd=cmd)
@@ -419,17 +457,22 @@ class GitArchiver(object):
         return output
 
 
-if __name__ == '__main__':
+def main():
     from optparse import OptionParser
 
-    parser = OptionParser(usage="usage: %prog [-v] [--prefix PREFIX] [--no-exclude] [--force-submodules] [--extra EXTRA1 [EXTRA2]] [--dry-run] OUTPUT_FILE",
-                          version="%prog {}".format(__version__))
+    parser = OptionParser(
+        usage="usage: %prog [-v] [--prefix PREFIX] [--no-exclude] [--force-submodules]"
+              " [--extra EXTRA1 [EXTRA2]] [--dry-run] OUTPUT_FILE",
+        version="%prog {0}".format(__version__)
+    )
 
     parser.add_option('--prefix',
                       type='string',
                       dest='prefix',
                       default=None,
-                      help="prepend PREFIX to each filename in the archive. OUTPUT_FILE name is used by default to avoid tarbomb. You can set it to '' in order to explicitly request tarbomb")
+                      help="""prepend PREFIX to each filename in the archive.
+                          OUTPUT_FILE name is used by default to avoid tarbomb.
+                          You can set it to '' in order to explicitly request tarbomb""")
 
     parser.add_option('-v', '--verbose',
                       action='store_true',
@@ -445,7 +488,7 @@ if __name__ == '__main__':
     parser.add_option('--force-submodules',
                       action='store_true',
                       dest='force_sub',
-                      help="force a git submodule init && git submodule update at each level before iterating submodules")
+                      help='force a git submodule init && git submodule update at each level before iterating submodules')
 
     parser.add_option('--extra',
                       action='append',
@@ -475,7 +518,11 @@ if __name__ == '__main__':
         import re
 
         output_name = path.basename(output_file_path)
-        output_name = re.sub('(\.zip|\.tar|\.tgz|\.txz|\.gz|\.bz2|\.xz|\.tar\.gz|\.tar\.bz2|\.tar\.xz)$', '', output_name) or "Archive"
+        output_name = re.sub(
+            '(\.zip|\.tar|\.tgz|\.txz|\.gz|\.bz2|\.xz|\.tar\.gz|\.tar\.bz2|\.tar\.xz)$',
+            '',
+            output_name
+        ) or "Archive"
         options.prefix = path.join(output_name, '')
 
     try:
@@ -489,6 +536,10 @@ if __name__ == '__main__':
                                options.extra)
         archiver.create(output_file_path, options.dry_run)
     except Exception as e:
-        parser.exit(2, "{}\n".format(e))
+        parser.exit(2, "{0}\n".format(e))
 
     sys.exit(0)
+
+
+if __name__ == '__main__':
+    main()

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-git-copy
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Florian Schwab
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-10 00:00:00.000000000 Z
+date: 2016-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -93,7 +93,7 @@ files:
 - lib/capistrano/git_copy/tasks/deploy.cap
 - lib/capistrano/git_copy/utility.rb
 - lib/capistrano/git_copy/version.rb
-- vendor/git-archive-all/git-archive-all
+- vendor/git-archive-all/git_archive_all.py
 homepage: https://github.com/ydkn/capistrano-git-copy
 licenses:
 - MIT
@@ -114,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Copy local git repository deploy strategy for capistrano