git-deploy-ng 0.8.0 → 0.9.0

data/lib/git_deploy/changelog.rb

@@ -0,0 +1,125 @@
+require 'date'
+
+class GitDeploy
+  module Changelog
+    HEADER = <<~HEADER
+      # Changelog
+
+      All notable changes to this project will be documented in this file.
+
+      The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+      and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+    HEADER
+
+    UNRELEASED = '## [Unreleased]'
+
+    CATEGORY_FOR = {
+      'feat' => 'Added',
+      'fix'  => 'Fixed',
+      'docs' => 'Changed',
+      'perf' => 'Changed'
+    }.freeze
+
+    CATEGORY_ORDER = ['Added', 'Changed', 'Fixed', 'Removed', 'Deprecated', 'Security'].freeze
+
+    module_function
+
+    def gemspec_version(path = 'git-deploy-ng.gemspec')
+      line = File.readlines(path).find { |l| l =~ /gem\.version\s*=/ }
+      line[/['"]([^'"]+)['"]/, 1]
+    end
+
+    def categorize(subject)
+      type = subject[/\A(\w+)(?:\([^)]+\))?!?:/, 1]
+      return nil unless type
+
+      CATEGORY_FOR[type]
+    end
+
+    def format_entry(subject)
+      body = subject.sub(/\A\w+(?:\([^)]+\))?!?:\s*/, '')
+      breaking = subject.include?('!:') || subject.match?(/\A\w+!:/)
+      entry = body.empty? ? subject : body[0].upcase + body[1..]
+      breaking ? "**BREAKING:** #{entry}" : entry
+    end
+
+    def group_commits(subjects)
+      groups = Hash.new { |h, k| h[k] = [] }
+      subjects.each do |subject|
+        next if subject.start_with?('Merge ')
+        category = categorize(subject) || next
+        groups[category] << format_entry(subject)
+      end
+      groups.each_value(&:uniq!)
+      groups
+    end
+
+    def render_section(version, date, groups)
+      lines = ["## [#{version}] - #{date}", '']
+      CATEGORY_ORDER.each do |category|
+        entries = groups[category]
+        next if entries.nil? || entries.empty?
+
+        lines << "### #{category}"
+        entries.sort.each { |entry| lines << "- #{entry}" }
+        lines << ''
+      end
+      lines.join("\n").rstrip + "\n"
+    end
+
+    def extract_section(content, version)
+      pattern = /^## \[#{Regexp.escape(version)}\][^\n]*\n(.*?)(?=^## \[|\z)/m
+      match = content.match(pattern)
+      return nil unless match
+
+      body = match[1].strip
+      body.empty? ? nil : body
+    end
+
+    def verify_version!(content, version)
+      section = extract_section(content, version)
+      abort "Error: CHANGELOG.md has no entry for version #{version}" if section.nil?
+      section
+    end
+
+    def update_content(content, version, date:, groups:)
+      section = render_section(version, date, groups)
+      if content.nil? || content.dup.force_encoding(Encoding::UTF_8).strip.empty?
+        return HEADER + "\n#{UNRELEASED}\n\n" + section + "\n"
+      end
+
+      content = content.dup.force_encoding(Encoding::UTF_8)
+
+      unless content.include?(UNRELEASED)
+        abort "Error: CHANGELOG.md is missing the #{UNRELEASED} heading"
+      end
+
+      if content.match?(/^## \[#{Regexp.escape(version)}\]/m)
+        abort "Error: CHANGELOG.md already has a section for version #{version}"
+      end
+
+      content.sub("#{UNRELEASED}\n", "#{UNRELEASED}\n\n#{section}\n")
+    end
+
+    def git_log_subjects(since_ref, until_ref: 'HEAD')
+      range = since_ref ? "#{since_ref}..#{until_ref}" : until_ref
+      `git log #{range} --pretty=format:%s --no-merges`.
+        force_encoding(Encoding::UTF_8).
+        split("\n", -1).
+        reject(&:empty?)
+    end
+
+    def latest_tag
+      tag = `git describe --tags --abbrev=0 2>/dev/null`.strip
+      tag.empty? ? nil : tag
+    end
+
+    def update_file(path, version, date: Date.today.iso8601, since_ref: latest_tag)
+      subjects = git_log_subjects(since_ref)
+      groups = group_commits(subjects)
+      content = File.exist?(path) ? File.read(path) : nil
+      File.write(path, update_content(content, version, date: date, groups: groups))
+    end
+  end
+end

data/lib/git_deploy/configuration.rb

@@ -12,14 +12,21 @@ class GitDeploy
 
     def deploy_to
       @deploy_to ||= begin
-        if remote_url.path.start_with? '/~/'
-          remote_url.path[1..-1]
-        else
-          remote_url.path 
-        end
+        remote_url
+        normalize_deploy_path(
+          GitDeploy::RemotePath.deploy_path(remote_url_string) { remote_home }
+        )
       end
     end
 
+    def remote_url_string(remote = options[:remote])
+      remote_urls(remote).first
+    end
+
+    def normalize_deploy_path(path)
+      path.start_with?('/~/') ? path[1..-1] : path
+    end
+
     def remote_user
       @user ||= begin
         user = remote_url.user
@@ -56,6 +63,7 @@ class GitDeploy
       @remote_url[remote] ||= begin
         url = remote_urls(remote).first
         if url.nil?
+          require_remote! if remote.nil? || remote.to_s.strip.empty?
           abort "Error: Remote url not found for remote #{remote.inspect}"
         elsif url =~ /(^|@)github\.com\b/
           abort "Error: Remote url for #{remote.inspect} points to GitHub. Can't deploy there!"
@@ -91,5 +99,12 @@ class GitDeploy
     def tracked_for(branch)
       git_config['config branch.%s.merge' % normalize_branch(branch)]
     end
+
+    def require_remote!
+      remote = options[:remote]
+      if remote.nil? || remote.to_s.strip.empty?
+        abort "Error: Specify a remote with -r (e.g. git deploy setup -r production)"
+      end
+    end
   end
 end

data/lib/git_deploy/generator.rb

@@ -3,10 +3,24 @@ require 'thor/group'
 class GitDeploy::Generator < Thor::Group
   include Thor::Actions
 
+  TEMPLATES = %w[rails-passenger rails-puma php-composer generic].freeze
+
+  class_option :template, :type => :string, :default => 'rails-passenger'
+
   def self.source_root
     File.expand_path('../templates', __FILE__)
   end
 
+  def verify_deploy_target
+    if File.exist?('deploy') && !File.directory?('deploy')
+      abort "Error: './deploy' exists but is a file. Remove or rename it before running init."
+    end
+
+    if File.directory?('deploy') && !Dir.empty?('deploy')
+      say "Warning: deploy/ already exists and is not empty. Existing files will not be overwritten.", :yellow
+    end
+  end
+
   def copy_main_hook
     copy_hook 'after_push.sh', 'deploy/after_push'
   end
@@ -16,13 +30,36 @@ class GitDeploy::Generator < Thor::Group
   end
 
   def copy_restart_callbacks
-    copy_hook 'before_restart.rb', 'deploy/before_restart'
+    source = Dir[File.join(template_dir, 'before_restart.*')].first
+    abort "Error: No before_restart script in template #{options[:template].inspect}" unless source
+    copy_hook File.basename(source), 'deploy/before_restart'
   end
 
   private
 
+  def template_dir
+    @template_dir ||= begin
+      name = options[:template] || 'rails-passenger'
+      unless TEMPLATES.include?(name)
+        abort "Error: Unknown template #{name.inspect}. Choose from: #{TEMPLATES.join(', ')}"
+      end
+
+      root = File.expand_path(self.class.source_root)
+      dir = File.expand_path(name, root)
+      unless dir.start_with?("#{root}#{File::SEPARATOR}") && File.directory?(dir)
+        abort "Error: Unknown template #{name.inspect}. Choose from: #{TEMPLATES.join(', ')}"
+      end
+      dir
+    end
+  end
+
   def copy_hook(template, destination)
-    copy_file template, destination
+    return if File.exist?(destination)
+
+    source = File.join(template_dir, template)
+    abort "Error: Missing #{template} in template #{options[:template].inspect}" unless File.file?(source)
+
+    copy_file source, destination
     chmod destination, 0744 unless File.executable? destination
   end
 end

data/lib/git_deploy/remote_path.rb

@@ -0,0 +1,28 @@
+require 'uri'
+
+class GitDeploy
+  module RemotePath
+    SCP_PATH = %r{\A(?:[^@]+@)?[^:]+:(.+)\z}
+
+    def self.raw_path(url)
+      if url.nil? || url.to_s.strip.empty?
+        abort "Error: No deploy remote URL configured. Specify a remote with -r."
+      end
+
+      if url.match?(%r{\A[\w-]+://})
+        URI.parse(url).path
+      else
+        match = url.match(SCP_PATH)
+        match ? match[1] : url
+      end
+    end
+
+    def self.deploy_path(url, home: nil)
+      path = raw_path(url)
+      return path if path.start_with?('/', '~')
+
+      home = yield if home.nil? && block_given?
+      File.join(home, path)
+    end
+  end
+end

data/lib/git_deploy/ssh_methods.rb

@@ -1,5 +1,6 @@
 class GitDeploy
   module SSHMethods
+    require 'fileutils'
     private
 
     def sudo_cmd
@@ -91,6 +92,20 @@ class GitDeploy
       channels.each { |c| c.wait }
     end
 
+    def scp_download(files)
+      channels = []
+      files.each do |remote, local|
+        puts "FILE: [#{options[:remote]}] #{remote}  ->  [local] #{local}"
+        FileUtils.mkdir_p(File.dirname(local)) unless local.end_with?('/') || File.dirname(local) == '.'
+        channels << ssh_connection.scp.download(remote, local) unless options.noop?
+      end
+      channels.each { |c| c.wait }
+    end
+
+    def remote_home
+      @remote_home ||= run("echo $HOME").strip
+    end
+
     def ssh_connection
       @ssh ||= begin
         ssh = Net::SSH.start(host, remote_user, :port => remote_port || 22)

data/lib/git_deploy/templates/generic/after_push.sh

@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+set -e
+oldrev=$1
+newrev=$2
+
+run() {
+  [ -x $1 ] && $1 $oldrev $newrev
+}
+
+echo files changed: $(git diff $oldrev $newrev --diff-filter=ACDMR --name-only | wc -l)
+
+umask 002
+
+run deploy/before_restart
+run deploy/restart && run deploy/after_restart

data/lib/git_deploy/templates/generic/before_restart.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+# Add pre-deploy steps here (dependencies, build, etc.)
+exit 0

data/lib/git_deploy/templates/generic/restart.sh

@@ -0,0 +1,2 @@
+#!/bin/sh
+echo "no restart configured — edit deploy/restart for your stack"

data/lib/git_deploy/templates/php-composer/after_push.sh

@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+set -e
+oldrev=$1
+newrev=$2
+
+run() {
+  [ -x $1 ] && $1 $oldrev $newrev
+}
+
+echo files changed: $(git diff $oldrev $newrev --diff-filter=ACDMR --name-only | wc -l)
+
+umask 002
+
+run deploy/before_restart
+run deploy/restart && run deploy/after_restart

data/lib/git_deploy/templates/php-composer/before_restart.sh

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+set -e
+oldrev=$1
+newrev=$2
+
+if [ -f composer.json ]; then
+  composer install --no-dev --optimize-autoloader --no-interaction
+fi
+
+if [ -f artisan ]; then
+  php artisan migrate --force
+fi

data/lib/git_deploy/templates/php-composer/restart.sh

@@ -0,0 +1,13 @@
+#!/bin/sh
+# Reload PHP-FPM — adjust the service name for your server
+if command -v systemctl >/dev/null 2>&1; then
+  for service in php-fpm php8.3-fpm php8.2-fpm; do
+    if sudo systemctl reload "$service" 2>/dev/null; then
+      echo "reloaded $service"
+      exit 0
+    fi
+  done
+  echo "Error: could not reload PHP-FPM (tried php-fpm, php8.3-fpm, php8.2-fpm)" >&2
+  exit 1
+fi
+echo "restarted PHP app"

data/lib/git_deploy/templates/rails-puma/after_push.sh

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+set -e
+oldrev=$1
+newrev=$2
+
+run() {
+  [ -x $1 ] && $1 $oldrev $newrev
+}
+
+echo files changed: $(git diff $oldrev $newrev --diff-filter=ACDMR --name-only | wc -l)
+
+umask 002
+
+git submodule sync && git submodule update --init --recursive
+
+run deploy/before_restart
+run deploy/restart && run deploy/after_restart

data/lib/git_deploy/templates/rails-puma/before_restart.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+oldrev, newrev = ARGV
+
+def run(cmd)
+  exit($?.exitstatus) unless system "umask 002 && #{cmd}"
+end
+
+RAILS_ENV   = ENV['RAILS_ENV'] || 'production'
+use_bundler = File.file? 'Gemfile'
+rake_cmd    = use_bundler ? 'bundle exec rake' : 'rake'
+
+if use_bundler
+  bundler_args = ['--deployment']
+  BUNDLE_WITHOUT = ENV['BUNDLE_WITHOUT'] || 'development:test'
+  bundler_args << '--without' << BUNDLE_WITHOUT unless BUNDLE_WITHOUT.empty?
+
+  run "bundle install #{bundler_args.join(' ')}"
+end
+
+if File.file? 'Rakefile'
+  tasks = []
+
+  if File.exist?('db/migrate')
+    num_migrations = `git diff #{oldrev} #{newrev} --diff-filter=A --name-only -z -- db/migrate`.split("\0").size
+  else
+    num_migrations = 0
+  end
+
+  tasks << "db:migrate" if num_migrations > 0
+
+  asset_paths = %w[app/assets app/javascript config/importmap.rb package.json yarn.lock]
+  changed_assets = `git diff #{oldrev} #{newrev} --name-only -z -- #{asset_paths.join(' ')}`.split("\0")
+  tasks << "assets:precompile" if changed_assets.size > 0
+
+  run "#{rake_cmd} #{tasks.join(' ')} RAILS_ENV=#{RAILS_ENV}" if tasks.any?
+end
+
+run "git clean -x -f -- public/assets tmp/cache/assets" if Dir.exist?('public/assets')

data/lib/git_deploy/templates/rails-puma/restart.sh

@@ -0,0 +1,9 @@
+#!/bin/sh
+mkdir -p tmp/pids
+if [ -f tmp/pids/puma.pid ]; then
+  bundle exec pumactl -P tmp/pids/puma.pid restart
+else
+  mkdir -p tmp
+  touch tmp/restart.txt
+  echo "restarting Puma app (tmp/restart.txt fallback — configure puma.pid for pumactl restart)"
+fi

data/lib/git_deploy.rb

@@ -6,23 +6,34 @@ class GitDeploy < Thor
   LOCAL_DIR = File.expand_path('..', __FILE__)
 
   require 'git_deploy/configuration'
+  require 'git_deploy/remote_path'
   require 'git_deploy/ssh_methods'
   include Configuration
   include SSHMethods
 
-  class_option :remote, :aliases => '-r', :type => :string, :default => 'origin'
+  class_option :remote, :aliases => '-r', :type => :string
   class_option :noop, :aliases => '-n', :type => :boolean, :default => false
 
   desc "init", "Generates deployment customization scripts for your app"
+  method_option :template, :type => :string, :default => 'rails-passenger',
+    :desc => 'Template stack (rails-passenger, rails-puma, php-composer, generic)'
   def init
     require 'git_deploy/generator'
-    Generator::start([])
+    Generator.start(['--template', options[:template]])
   end
 
   desc "setup", "Create the remote git repository and install push hooks for it"
   method_option :shared, :aliases => '-g', :type => :boolean, :default => false
   method_option :sudo, :aliases => '-s', :type => :boolean, :default => false
+  method_option :force, :aliases => '-f', :type => :boolean, :default => false
   def setup
+    require_remote!
+
+    remote_hook = "#{deploy_to}/.git/hooks/post-receive"
+    if run_test("[ -f #{remote_hook} ]") && !options[:force]
+      abort "Error: Remote already has a post-receive hook. Use --force to overwrite."
+    end
+
     sudo = options.sudo? ? "#{sudo_cmd} " : ''
 
     unless run_test("test -x #{deploy_to}")
@@ -35,17 +46,27 @@ class GitDeploy < Thor
     run [] do |cmd|
       cmd << "chmod g+ws #{deploy_to}" if options.shared?
       cmd << "cd #{deploy_to}"
-      cmd << "git init #{options.shared? ? '--shared' : ''}"
-      cmd << "sed -i'' -e 's/master/#{branch}/' .git/HEAD" unless branch == 'master'
+      unless run_test("[ -d #{deploy_to}/.git ]")
+        cmd << "git init #{options.shared? ? '--shared' : ''}"
+        cmd << "sed -i'' -e 's/master/#{branch}/' .git/HEAD" unless branch == 'master'
+      end
       cmd << "git config --bool receive.denyNonFastForwards false" if options.shared?
       cmd << "git config receive.denyCurrentBranch ignore"
     end
 
-    invoke :hooks
+    invoke :hooks, [], force: options[:force]
   end
 
   desc "hooks", "Installs git hooks to the remote repository"
+  method_option :force, :aliases => '-f', :type => :boolean, :default => false
   def hooks
+    require_remote!
+
+    remote_hook = "#{deploy_to}/.git/hooks/post-receive"
+    if run_test("[ -f #{remote_hook} ]") && !options[:force]
+      abort "Error: Remote already has a post-receive hook. Use --force to overwrite."
+    end
+
     hooks_dir = File.join(LOCAL_DIR, 'hooks')
     remote_dir = "#{deploy_to}/.git/hooks"
 
@@ -55,11 +76,13 @@ class GitDeploy < Thor
   
   desc "restart", "Restarts the application on the server"
   def restart
+    require_remote!
     run "cd #{deploy_to} && deploy/restart 2>&1 | tee -a log/deploy.log"
   end
 
   desc "rerun", "Runs the `deploy/after_push' callback as if a new revision was pushed via git"
   def rerun
+    require_remote!
     run <<-BASH, :echo => false
       bash -e -c '
         cd '#{deploy_to}'
@@ -71,6 +94,7 @@ class GitDeploy < Thor
 
   desc "rollback", "Rolls back the checkout to before the last push"
   def rollback
+    require_remote!
     run <<-BASH, :echo => false
       bash -e -c '
         cd '#{deploy_to}'
@@ -87,12 +111,14 @@ class GitDeploy < Thor
   method_option :tail, :aliases => '-t', :type => :boolean, :default => false
   method_option :lines, :aliases => '-l', :type => :numeric, :default => 20
   def log(n = nil)
+    require_remote!
     tail_args = options.tail? ? '-f' : "-n#{n || options.lines}"
     run "tail #{tail_args} #{deploy_to}/log/deploy.log"
   end
 
   desc "upload <files>", "Copy local files to the remote app"
   def upload(*files)
+    require_remote!
     files = files.map { |f| Dir[f.strip] }.flatten
     abort "Error: Specify at least one file to upload" if files.empty?
 
@@ -101,4 +127,16 @@ class GitDeploy < Thor
       all
     }
   end
+
+  desc "download <files>", "Copy remote files from the app to local"
+  def download(*files)
+    require_remote!
+    abort "Error: Specify at least one file to download" if files.empty?
+
+    scp_download files.inject({}) { |all, file|
+      file = file.strip
+      all[File.join(deploy_to, file)] = file
+      all
+    }
+  end
 end

data/spec/changelog_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+require 'git_deploy/changelog'
+
+describe GitDeploy::Changelog do
+  describe '.categorize' do
+    it 'maps conventional commit types to Keep a Changelog headings' do
+      expect(described_class.categorize('feat: add download')).to eq('Added')
+      expect(described_class.categorize('fix: path resolution')).to eq('Fixed')
+      expect(described_class.categorize('docs: refresh README')).to eq('Changed')
+      expect(described_class.categorize('chore: deps')).to be_nil
+    end
+  end
+
+  describe '.format_entry' do
+    it 'capitalizes the subject and marks breaking changes' do
+      expect(described_class.format_entry('feat: add download')).
+        to eq('Add download')
+      expect(described_class.format_entry('feat!: require remote')).
+        to eq('**BREAKING:** Require remote')
+    end
+  end
+
+  describe '.group_commits' do
+    it 'groups and deduplicates entries by category' do
+      groups = described_class.group_commits([
+        'feat: add download',
+        'fix: path resolution',
+        'Merge pull request #12',
+        'chore: ignore tmp'
+      ])
+
+      expect(groups['Added']).to eq(['Add download'])
+      expect(groups['Fixed']).to eq(['Path resolution'])
+      expect(groups.key?('Changed')).to be false
+    end
+  end
+
+  describe '.render_section' do
+    it 'renders a Keep a Changelog version section' do
+      section = described_class.render_section('0.9.0', '2026-07-04', {
+        'Added' => ['Download command'],
+        'Fixed' => ['Remote path resolution']
+      })
+
+      expect(section).to include('## [0.9.0] - 2026-07-04')
+      expect(section).to include('### Added')
+      expect(section).to include('- Download command')
+      expect(section).to include('### Fixed')
+    end
+  end
+
+  describe '.update_content' do
+    let(:base) do
+      described_class::HEADER + "\n#{described_class::UNRELEASED}\n\n"
+    end
+
+    it 'inserts a new version section after Unreleased' do
+      updated = described_class.update_content(base, '0.9.0',
+        date: '2026-07-04',
+        groups: { 'Added' => ['Download command'] })
+
+      expect(updated).to include("## [Unreleased]\n\n## [0.9.0]")
+      expect(updated).to include('- Download command')
+    end
+
+    it 'aborts when the version section already exists' do
+      content = base + "## [0.9.0] - 2026-07-04\n\n"
+      expect {
+        described_class.update_content(content, '0.9.0',
+          date: '2026-07-04', groups: { 'Added' => ['X'] })
+      }.to output(/already has a section/).to_stderr.and raise_error(SystemExit)
+    end
+  end
+
+  describe '.extract_section' do
+    let(:content) do
+      <<~CHANGELOG
+        ## [Unreleased]
+
+        ## [0.9.0] - 2026-07-04
+
+        ### Added
+        - Download command
+
+        ## [0.8.0] - 2026-06-10
+      CHANGELOG
+    end
+
+    it 'returns the body for a version section' do
+      body = described_class.extract_section(content, '0.9.0')
+      expect(body).to include('### Added')
+      expect(body).to include('- Download command')
+      expect(body).not_to include('0.8.0')
+    end
+  end
+
+  describe '.verify_version!' do
+    it 'aborts when the version is missing' do
+      expect {
+        described_class.verify_version!("## [Unreleased]\n", '0.9.0')
+      }.to output(/no entry for version 0.9.0/).to_stderr.and raise_error(SystemExit)
+    end
+  end
+
+  describe '.gemspec_version' do
+    it 'reads the version from git-deploy-ng.gemspec' do
+      expect(described_class.gemspec_version).to eq('0.9.0')
+    end
+  end
+end

data/spec/cli_spec.rb

@@ -4,7 +4,15 @@ describe GitDeploy do
   it 'exposes the upstream CLI commands' do
     commands = described_class.all_commands.keys
     expect(commands).to include(
-      'init', 'setup', 'hooks', 'restart', 'rerun', 'rollback', 'log', 'upload'
+      'init', 'setup', 'hooks', 'restart', 'rerun', 'rollback', 'log', 'upload', 'download'
     )
   end
+
+  it 'allows init without a remote name' do
+    Dir.mktmpdir do |dir|
+      Dir.chdir(dir) do
+        expect { described_class.start(%w[init]) }.not_to raise_error
+      end
+    end
+  end
 end