capistrano-git-copy 0.6.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49518f26b320e7bc5bf917264cd19c3b386c75ab
-  data.tar.gz: 6aea180c205916da185cbc642021a2d72e0e7a6a
+  metadata.gz: b2af2b9b1eb48bc206244ecbda119ffa9769e978
+  data.tar.gz: 3dd5ff5a4a71cdb64fef39f0875bb5f92f1a9177
 SHA512:
-  metadata.gz: 73f8e3e51de78e4029f76fe48f083aa7122a743d685e17025a4a9dcd124f7650a89f2cfff72c78a3635f00d69a222eca47294a9121f3a1c0437ba5a608dfc1be
-  data.tar.gz: 5eceecae6940c915762e8bfb5bbc92a77397d5056b26e4cce02c01a10f001de5adeaabe758c227cbfb1f36ffa414e01e59eaa1a42169c8819f3f58faed2eea2f
+  metadata.gz: 5d4a0f91a0780fadb3c11d0fbd914a47011d24af088aec896d34fa440f18b721769b5d755b1733d7646aded5ad4ff39aca682f77cb915a9a814620394f1824ff
+  data.tar.gz: a2e88cc490728d6943257563975d87e08ee5cc8cd2f4fdfe18f9714ce543e069a40b81eaae208011346d4c5237713892dcc1639f22522c3c0aeaccb080ca4d45

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "vendor/git-archive-all"]
+	path = vendor/git-archive-all
+	url = https://github.com/Kentzo/git-archive-all.git

data/README.md

@@ -1,3 +1,7 @@
+[![Gem Version](https://img.shields.io/gem/v/capistrano-git-copy.svg)](https://rubygems.org/gems/capistrano-git-copy)
+[![Dependencies](https://img.shields.io/gemnasium/ydkn/capistrano-git-copy.svg)](https://gemnasium.com/ydkn/capistrano-git-copy)
+[![Code Climate](https://img.shields.io/codeclimate/github/ydkn/capistrano-git-copy.svg)](https://codeclimate.com/github/ydkn/capistrano-git-copy)
+
 # Capistrano::GIT::Copy
 
 Creates a tar archive locally from the git repository and uploads it to the remote server.
@@ -22,13 +26,6 @@ Now use `git_copy` as your SCM type in your `config/deploy.rb`:
 
     set :scm, :git_copy
 
-## Configuration
-
-You can modify any of the following Capistrano variables in your `deploy.rb` config.
-
-- `git_archive_all_bin`     - Set the path for the git-archive-all command. Defaults to git-archive-all found in $PATH or the included version as a fallback.
-- `git_copy_tmp_path`       - Temporary path where the repository is cloned to and the archive is created.
-
 ## Notes
 
 * Uses [git-archive-all](https://github.com/Kentzo/git-archive-all) for bundling repositories.
@@ -40,10 +37,3 @@ You can modify any of the following Capistrano variables in your `deploy.rb` con
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
-
-
- 
-
-[![Gem Version](https://img.shields.io/gem/v/capistrano-git-copy.svg)](https://rubygems.org/gems/capistrano-git-copy)
-[![Dependencies](https://img.shields.io/gemnasium/ydkn/capistrano-git-copy.svg)](https://gemnasium.com/ydkn/capistrano-git-copy)
-[![Code Climate](https://img.shields.io/codeclimate/github/ydkn/capistrano-git-copy.svg)](https://codeclimate.com/github/ydkn/capistrano-git-copy)

data/Rakefile

@@ -1 +1 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'

data/capistrano-git-copy.gemspec

@@ -4,19 +4,19 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'capistrano/git/copy/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "capistrano-git-copy"
+  spec.name          = 'capistrano-git-copy'
   spec.version       = Capistrano::Git::Copy::VERSION
-  spec.authors       = ["Florian Schwab"]
-  spec.email         = ["me@ydkn.de"]
-  spec.description   = %q{Copy local git repository deploy strategy for capistrano}
-  spec.summary       = %q{Copy local git repository deploy strategy for capistrano}
-  spec.homepage      = "https://github.com/ydkn/capistrano-git-copy"
-  spec.license       = "MIT"
+  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.homepage      = 'https://github.com/ydkn/capistrano-git-copy'
+  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($/) + %w( vendor/git-archive-all/git-archive-all )
   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"]
+  spec.require_paths = ['lib']
 
   spec.add_dependency 'capistrano', '>= 3.1.0', '< 4.0.0'
 

data/lib/capistrano/git/copy.rb

@@ -1,18 +1,3 @@
-# Capistrano
-module Capistrano
-  # GIT
-  module Git
-    # Copy
-    module Copy
-      # Quick-Access to this gems root directory
-      #
-      # @return [String] Root directory of this gem
-      def self.root_path
-        File.expand_path('../../../..', __FILE__)
-      end
-    end
-  end
-end
+require 'capistrano/git/copy/utility'
 
-require 'capistrano/git/copy/version'
-require 'capistrano/git/copy/deploy'
+load File.expand_path('../copy/tasks/deploy.cap', __FILE__)

data/lib/capistrano/git/copy/tasks/deploy.cap

@@ -1,102 +1,61 @@
-namespace :load do
-  task :defaults do
-    set :git_archive_all_bin, -> {
-      bin = `which git-archive-all`.strip
-      bin.length > 0 ? bin : File.join(Capistrano::Git::Copy.root_path, 'vendor', 'bin', 'git-archive-all')
-    }
-
-    set :git_copy_tmp_path, -> { File.join(Dir.tmpdir, "#{fetch(:application)}_#{fetch(:stage)}") }
-  end
-end
-
 namespace :git_copy do
-  task :wrapper do
-    fail "git-archive-all binary not found" if fetch(:git_archive_all_bin).strip.length == 0
-
-    invoke 'git_copy:update_local_working_copy'
+  def git_copy_utility
+    @git_copy_utility ||= Capistrano::Git::Copy::Utility.new(self)
   end
 
-  task :check do; end
-  task :clone do; end
-
-  desc 'Create tar and upload to server'
-  task update: :'git_copy:wrapper' do
-    # create tar with git-archive-all
-    system("cd #{fetch(:local_repo_path)} && #{fetch(:git_archive_all_bin)} __tmp.tar")
-
-    # create tar.gz for upload
-    system("cd #{fetch(:local_repo_path)} && tar -xf __tmp.tar && cd __tmp && tar -czf #{fetch(:local_tar_file)} .")
+  task :wrapper do; end
 
-    # upload to all servers
-    on release_roles :all do
-      upload!(fetch(:local_tar_file), "#{fetch(:tmp_dir)}/#{fetch(:application)}_#{fetch(:stage)}.tar.gz")
+  desc 'Check that the repository is reachable'
+  task check: :'git_copy:wrapper' do
+    run_locally do
+      git_copy_utility.check
     end
+  end
 
-    # delete temporary tar.gz archive
-    system("rm -rf #{fetch(:local_tar_file)}")
+  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 'Extract tar to release path'
-  task create_release: :'git_copy:update' do
-    on release_roles :all do
-      execute(:mkdir, '-p', release_path)
-      execute(:tar, '-f', "#{fetch(:tmp_dir)}/#{fetch(:application)}_#{fetch(:stage)}.tar.gz", '-x -C', release_path)
-      execute(:rm, '-f', "#{fetch(:tmp_dir)}/#{fetch(:application)}_#{fetch(:stage)}.tar.gz")
+  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 'Determine the revision that will be deployed'
-  task set_current_revision: :'git_copy:wrapper' do
-    revision = `cd #{fetch(:local_repo_path)} && git rev-parse --short HEAD 2>/dev/null`.strip
+  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
-      set :current_revision, revision
+      git_copy_utility.release
     end
   end
 
-  desc 'Clean up temp dir'
-  task :cleanup do
-    tmp_path = fetch(:git_copy_tmp_path)
-
-    if File.exists?(tmp_path)
-      system("rm -rf #{tmp_path}")
-      print "Removed #{tmp_path}\n"
-    else
-      print "Nothing to cleanup (#{tmp_path} not found)\n"
+  desc 'Determine the revision that will be deployed'
+  task :set_current_revision do
+    run_locally do
+      set :current_revision, git_copy_utility.fetch_revision
     end
   end
 
-  task update_local_working_copy: :'git_copy:wrapper' do
-    tmp_path = fetch(:git_copy_tmp_path)
-
-    set :local_repo_path, File.join(tmp_path, 'repo')
-    set :local_tar_file,  File.join(tmp_path, 'archive.tar.gz')
-
-    # track if the repo url has changed
-    local_repo_url = `cd #{fetch(:local_repo_path)} 2>/dev/null && git config --get remote.origin.url 2>/dev/null`.strip
-    system("rm -rf #{tmp_path}") unless fetch(:repo_url) == local_repo_url
-
-    # prepare temp directory
-    system("mkdir -p #{tmp_path}")
-
-    # clone repository if necessary
-    unless File.exists?(fetch(:local_repo_path))
-      system("git clone #{fetch(:repo_url)} #{fetch(:local_repo_path)}")
+  desc 'Clean repo cache'
+  task :cleanup do
+    run_locally do
+      git_copy_utility.cleanup
     end
-
-    # update repository
-    system("cd #{fetch(:local_repo_path)} && git fetch origin && git fetch origin --tags")
-
-    # reset repository
-    system("cd #{fetch(:local_repo_path)} && git reset --hard #{fetch(:branch, 'master')} 2>/dev/null")
-    system("cd #{fetch(:local_repo_path)} && git reset --hard origin/#{fetch(:branch, 'master')} 2>/dev/null")
-
-    # init and update submodules
-    system("cd #{fetch(:local_repo_path)} && git submodule init && git submodule update")
-    system("cd #{fetch(:local_repo_path)} && git submodule foreach --recursive git submodule update --init")
-
-    # clean up working directory
-    system("cd #{fetch(:local_repo_path)} && git clean -d -f")
-    system("cd #{fetch(:local_repo_path)} && git submodule foreach --recursive git clean -d -f")
   end
 end

data/lib/capistrano/git/copy/utility.rb

@@ -0,0 +1,167 @@
+require 'tmpdir'
+require 'digest/md5'
+
+module Capistrano
+  module Git
+    module Copy
+      # Utility stuff to avoid cluttering of deploy.cap
+      class Utility
+        def initialize(context)
+          @context = context
+        end
+
+        # Check if repo cache exists
+        #
+        # @return [Boolean] indicates if repo cache exists
+        def test
+          test! " [ -d #{repo_path} ] "
+        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
+          git :submodule, :init
+          git :submodule, :update
+          git :submodule, :foreach, '--recursive', :git, :submodule, :update, '--init'
+
+          # cleanup
+          git :clean, '-d', '-f'
+          git :submodule, :foreach, '--recursive', :git, :clean, '-d', '-f'
+        end
+
+        # Create tar archive
+        #
+        # @return void
+        def prepare_release
+          execute git_archive_all_bin, "--prefix=''", archive_path
+        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', fetch(:branch)).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 git(*args)
+          args.unshift(:git)
+          execute(*args)
+        end
+
+        def git_archive_all_bin
+          File.expand_path('../../../../../vendor/git-archive-all/git-archive-all', __FILE__)
+        end
+
+        def deploy_id
+          [
+            fetch(:application),
+            fetch(:stage),
+            Digest::MD5.hexdigest(fetch(:repo_url))[0..7]
+          ].compact.join('_')
+        end
+
+        def commit_hash
+          return @_commit_hash if @_commit_hash
+
+          branch = fetch(:branch, 'master')
+
+          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
+    end
+  end
+end

data/lib/capistrano/git/copy/version.rb

@@ -1,8 +1,11 @@
+# Capistrano
 module Capistrano
+  # Git
   module Git
+    # Copy
     module Copy
       # gem version
-      VERSION = '0.6.3'
+      VERSION = '0.7.0'
     end
   end
 end

data/vendor/{bin → git-archive-all}/git-archive-all

@@ -4,7 +4,7 @@
 from __future__ import print_function
 from __future__ import unicode_literals
 
-__version__ = "1.8"
+__version__ = "1.9"
 
 import logging
 from os import extsep, path, readlink
@@ -79,7 +79,7 @@ class GitArchiver(object):
         Create the archive at output_file_path.
 
         Type of the archive is determined either by extension of output_file_path or by output_format.
-        Supported formats are: gz, zip, bz2, tar, tgz
+        Supported formats are: gz, zip, bz2, xz, tar, tgz, txz
 
         @param output_path: Output file path.
         @type output_path: string
@@ -108,11 +108,13 @@ class GitArchiver(object):
                         i.create_system = 3
                         i.external_attr = 0xA1ED0000
                         archive.writestr(i, readlink(file_path))
-            elif output_format in ['tar', 'bz2', 'gz', 'tgz']:
+            elif output_format in ['tar', 'bz2', 'gz', 'xz', 'tgz', 'txz']:
                 if output_format == 'tar':
                     t_mode = 'w'
                 elif output_format == 'tgz':
                     t_mode = 'w:gz'
+                elif output_format == 'txz':
+                    t_mode = 'w:xz'
                 else:
                     t_mode = 'w:{0}'.format(output_format)
 
@@ -428,8 +430,8 @@ if __name__ == '__main__':
     parser.add_option('--prefix',
                       type='string',
                       dest='prefix',
-                      default='',
-                      help="prepend PREFIX to each filename in the archive. OUTPUT_FILE name is used by default to avoid tarbomb")
+                      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")
 
     parser.add_option('-v', '--verbose',
                       action='store_true',
@@ -469,13 +471,13 @@ if __name__ == '__main__':
         parser.error("You cannot use directory as output")
 
     # avoid tarbomb
-    if options.prefix:
+    if options.prefix is not None:
         options.prefix = path.join(options.prefix, '')
     else:
         import re
 
         output_name = path.basename(output_file_path)
-        output_name = re.sub('(\.zip|\.tar|\.tgz|\.gz|\.bz2|\.tar\.gz|\.tar\.bz2)$', '', 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:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-git-copy
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0
 platform: ruby
 authors:
 - Florian Schwab
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-03 00:00:00.000000000 Z
+date: 2015-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -80,18 +80,18 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".gitmodules"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - capistrano-git-copy.gemspec
-- lib/capistrano-git-copy.rb
 - lib/capistrano/git/copy.rb
-- lib/capistrano/git/copy/deploy.rb
 - lib/capistrano/git/copy/tasks/deploy.cap
+- lib/capistrano/git/copy/utility.rb
 - lib/capistrano/git/copy/version.rb
 - lib/capistrano/git_copy.rb
-- vendor/bin/git-archive-all
+- vendor/git-archive-all/git-archive-all
 homepage: https://github.com/ydkn/capistrano-git-copy
 licenses:
 - MIT
@@ -112,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Copy local git repository deploy strategy for capistrano

data/lib/capistrano/git/copy/deploy.rb

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