git-version-bump 0.17.1 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '084e552015ea8de36e92598ea4ec4de57916b0cdf0ba9ee8c8ff7974da9df8ff'
-  data.tar.gz: e361b6214097aa2e9cf4a30e993cb4ad9dc9c5f3283ae6d39d219e28f684f8fb
+  metadata.gz: 80ff2d2ad4a6b5c8ea81891a9004d97507f4d9075081638034e319cd9ddccb81
+  data.tar.gz: ea24000b5f002ae3f3369cd41bff4b31c91c7dfd32a88d1ae45cfa6ce0648114
 SHA512:
-  metadata.gz: 4e168a05d6349ecc3b69bf09eff3d1ddd28253dde4c69b4ee007257de73af6a7b195dc9e1186d7fca9106dfa40c88680f02139fcc808fb5a2906e8da3b09c534
-  data.tar.gz: 4e295c50077e23342b48c4a9dbfad2a356be4c0d33a5489f365812309c1fa90cd45b3c50197f8ab94b5a8b9fc70aa0771363ed933ffb44e4bee3cbd85b2a7457
+  metadata.gz: 837115664720c3e410e3f07b9111a81bad5451fcf81ca76c4b6255d387a4ce802098c2fe178157eaddf01fb5d67cc62dd744027f73f8c5c387e34fb363ecb840
+  data.tar.gz: 1f9b8a018b2c8d54bd0eea72d65578d6fe28f799a32579e2397e22ffddcce2335c530d0db5ba96627e1987d0133407a58f9141477eb6e3cbe29b74ffc2ba8754

data/bin/git-version-bump

@@ -1,14 +1,12 @@
 #!/usr/bin/env ruby
 
-require 'git-version-bump'
-
 if ARGV[0].nil? or
    ARGV[0].empty? or
    (ARGV.length == 1 && (ARGV[0] == "-d" || ARGV[0] == "--dry-run")) or
    ARGV[0] == '-h' or
    ARGV[0] == '--help'
 	$stderr.puts <<-EOF.gsub(/^\t\t/, '')
-		Usage: git version-bump [-n|--notes] [-d|--dry-run] <major|minor|patch|show>
+		Usage: git version-bump [-n|--notes] [-l|--lite-tags] [-d|--dry-run] <major|minor|patch|show>
 
 		'major': x.y.z -> x+1.0.0
 		'minor': x.y.z -> x.y+1.0
@@ -32,24 +30,40 @@ elsif ARGV[0] == '-h' or ARGV[0] == '--help'
 	exit 0
 end
 
-result = case ARGV[0].downcase
-	when /^maj?o?r?$/
-		"#{GVB.major_version(true) + 1}.0.0"
-	when /^min?o?r?$/
-		"#{GVB.major_version(true)}.#{GVB.minor_version(true)+1}.0"
-	when /^pa?t?c?h?$/
-		"#{GVB.major_version(true)}.#{GVB.minor_version(true)}.#{GVB.patch_version(true)+1}"
-	when /^sh?o?w?$/
-		puts GVB.version(true)
-		exit 0
-	else
-		$stderr.puts "Unknown argument: #{ARGV[0]}.  Try --help."
-		exit 1
-end
+begin
+  require 'git-version-bump'
+
+  result = case ARGV[0].downcase
+    when /^maj?o?r?$/
+      "#{GVB.major_version(true) + 1}.0.0"
+    when /^min?o?r?$/
+      "#{GVB.major_version(true)}.#{GVB.minor_version(true)+1}.0"
+    when /^pa?t?c?h?$/
+      "#{GVB.major_version(true)}.#{GVB.minor_version(true)}.#{GVB.patch_version(true)+1}"
+    when /^sh?o?w?$/
+      puts GVB.version(true)
+      exit 0
+    else
+      $stderr.puts "Unknown argument: #{ARGV[0]}.  Try --help."
+      exit 1
+  end
 
-if dry_run
-	puts result
-else
-	GVB.tag_version result, release_notes, lite_tags
-	puts "Version is now #{GVB.version(true)}."
+  if dry_run
+    puts result
+  else
+    unless GVB.tag_version result, release_notes, lite_tags
+      exit 1
+    end
+    puts "Version is now #{GVB.version(true)}."
+  end
+rescue GVB::VersionUnobtainable => ex
+  $stderr.puts "Could not obtain version information.  #{ex.message} (git available: #{GVB.git_available?.inspect})"
+  exit 1
+rescue GVB::CommandFailure => ex
+  $stderr.puts "#{ex.message} (exit status: #{ex.exitstatus})"
+  $stderr.puts "command output was:"
+  $stderr.puts "----8<----"
+  $stderr.puts ex.output
+  $stderr.puts "---->8----"
+  exit 1
 end

data/lib/git-version-bump.rb

@@ -1,47 +1,43 @@
 require 'tempfile'
 require 'digest/sha1'
+require 'open3'
 require 'pathname'
 
 module GitVersionBump
 	class VersionUnobtainable < StandardError; end
+	class CommandFailure < StandardError
+		attr_accessor :output, :exitstatus
+
+		def initialize(m, output, exitstatus)
+			super(m)
+			@output, @exitstatus = output, exitstatus
+		end
+	end
 
 	VERSION_TAG_GLOB = 'v[0-9]*.[0-9]*.*[0-9]'
 
 	DEVNULL = Gem.win_platform? ? "NUL" : "/dev/null"
 
 	def self.version(use_local_git=false, include_lite_tags=false)
-		if use_local_git
-			unless git_available?
-				raise RuntimeError,
-				      "GVB.version(use_local_git=true) called, but git isn't installed"
-			end
-
-			sq_git_dir = shell_quoted_string(Dir.pwd)
-		else
-			sq_git_dir = shell_quoted_string((File.dirname(caller_file) rescue nil || Dir.pwd))
-		end
+		git_cmd = ["git", "-C", git_dir(use_local_git), "describe", "--dirty=.1.dirty.#{Time.now.strftime("%Y%m%d.%H%M%S")}", "--match=#{VERSION_TAG_GLOB}"]
+		git_cmd << "--tags" if include_lite_tags
 
-		git_cmd = "git -C #{sq_git_dir} describe --dirty='.1.dirty.#{Time.now.strftime("%Y%m%d.%H%M%S")}' --match='#{VERSION_TAG_GLOB}'"
-		git_cmd << " --tags" if include_lite_tags
-
-		git_ver = `#{git_cmd} 2> #{DEVNULL}`.
-		            strip.
-		            gsub(/^v/, '').
-		            gsub('-', '.')
-
-		# If git returned success, then it gave us a described version.
-		# Success!
-		return git_ver if $? == 0
-
-		# git failed us; we're either not in a git repo or else we've never
-		# tagged anything before.
-
-		# Are we in a git repo with no tags?  If so, try to use the gemspec
-		# and if that fails then abort
 		begin
-			return gem_version(use_local_git)
-		rescue VersionUnobtainable
-			return "0.0.0.1.ENOTAG"
+			run_command(git_cmd, "getting current version descriptor").
+			            strip.
+			            gsub(/^v/, '').
+			            gsub('-', '.')
+		rescue CommandFailure
+			# git failed us; we're either not in a git repo or else we've never
+			# tagged anything before.
+
+			# Are we in a git repo with no tags?  If so, try to use the gemspec
+			# and if that fails then abort
+			begin
+				gem_version(use_local_git)
+			rescue VersionUnobtainable
+				"0.0.0.1.ENOTAG"
+			end
 		end
 	end
 
@@ -86,56 +82,47 @@ module GitVersionBump
 	end
 
 	def self.date(use_local_git=false)
-		if use_local_git
-			unless git_available?
-				raise RuntimeError,
-				      "GVB.date(use_local_git=true), but git is not installed"
-			end
-
-			sq_git_dir = shell_quoted_string(Dir.pwd)
-		else
-			sq_git_dir = shell_quoted_string((File.dirname(caller_file) rescue nil || Dir.pwd))
-		end
-
 		# Are we in a git tree?
-		system("git -C #{sq_git_dir} status > #{DEVNULL} 2>&1")
-		if $? == 0
-			# Yes, we're in git.
+		begin
+			try_command(["git", "-C", git_dir(use_local_git), "status"])
 
-			if dirty_tree?(sq_git_dir)
-				return Time.now.strftime("%F")
+			if dirty_tree?(git_dir(use_local_git))
+				Time.now.strftime("%F")
 			else
 				# Clean tree.  Date of last commit is needed.
-				return (`git -C #{sq_git_dir} show --no-show-signature --format=format:%cd --date=short`.lines.first || "").strip
+				(run_command(["git", "-C", git_dir(use_local_git), "show", "--no-show-signature", "--format=format:%cd", "--date=short"], "getting date of last commit").lines.first || "").strip
 			end
-		else
+		rescue CommandFailure
+			# Presumably not in a git tree
 			if use_local_git
 				raise RuntimeError,
 				      "GVB.date(use_local_git=true) called from non-git location"
 			end
 
-			# Not in git; time to hit the gemspecs
 			if spec = caller_gemspec
-				return spec.date.strftime("%F")
+				spec.date.strftime("%F")
+			else
+				raise RuntimeError,
+				      "GVB.date called from mysterious, non-gem location."
 			end
-
-			raise RuntimeError,
-			      "GVB.date called from mysterious, non-gem location."
 		end
 	end
 
 	def self.tag_version(v, release_notes = false, include_lite_tags=false)
 		if dirty_tree?
 			puts "You have uncommitted files.  Refusing to tag a dirty tree."
-		else
-			if release_notes
+			return false
+		end
+		if release_notes
+			log_file = Tempfile.new('gvb')
+
+			begin
 				# We need to find the tag before this one, so we can list all the commits
 				# between the two.  This is not a trivial operation.
-				git_cmd = "git describe --match='#{VERSION_TAG_GLOB}' --always"
-				git_cmd << ' --tags' if include_lite_tags
-				prev_tag = `#{git_cmd}`.strip.gsub(/-\d+-g[0-9a-f]+$/, '')
+				git_cmd = ["git", "describe", "--match=#{VERSION_TAG_GLOB}", "--always"]
+				git_cmd << "--tags" if include_lite_tags
 
-				log_file = Tempfile.new('gvb')
+				prev_tag = run_command(git_cmd, "getting previous release tag").strip.gsub(/-\d+-g[0-9a-f]+$/, '')
 
 				log_file.puts <<-EOF.gsub(/^\t\t\t\t\t/, '')
 
@@ -146,29 +133,30 @@ module GitVersionBump
 					# are listed below. This will become v#{v}
 					#
 				EOF
+				log_file.puts run_command(["git", "log", "--no-show-signature", "--format=# %h  %s", "#{prev_tag}..HEAD"], "getting commit range of release")
 
 				log_file.close
-				system("git log --no-show-signature --format='# %h  %s' #{prev_tag}..HEAD >>#{log_file.path}")
 
 				pre_hash = Digest::SHA1.hexdigest(File.read(log_file.path))
-				system("git config -e -f #{log_file.path}")
+				run_command(["git", "config", "-e", "-f", log_file.path], "editing release notes")
 				if Digest::SHA1.hexdigest(File.read(log_file.path)) == pre_hash
-					puts "Release notes not edited; aborting"
+					puts "Release notes not edited; not making release"
 					log_file.unlink
 					return
 				end
 
 				puts "Tagging version #{v}..."
-				system("git tag -a -F #{log_file.path} v#{v}")
+				run_command(["git", "tag", "-a", "-F", log_file.path, "v#{v}"], "tagging release with annotations")
+			ensure
 				log_file.unlink
-			else
-				# Crikey this is a lot simpler
-				system("git tag -a -m 'Version v#{v}' v#{v}")
 			end
-
-			system("git push > #{DEVNULL} 2>&1")
-			system("git push --tags > #{DEVNULL} 2>&1")
+		else
+			# Crikey this is a lot simpler
+			run_command(["git", "tag", "-a", "-m", "Version v#{v}", "v#{v}"], "tagging release")
 		end
+
+		run_command(["git", "push"], "pushing commits to the default remote repository")
+		run_command(["git", "push", "--tags"], "pushing tags to the default remote repository")
 	end
 
 	# Calculate a version number based on the date of the most recent git commit.
@@ -199,18 +187,7 @@ module GitVersionBump
 	# make builds off a branch, basically.
 	#
 	def self.commit_date_version(use_local_git = false)
-		if use_local_git
-			unless git_available?
-				raise RuntimeError,
-				      "GVB.commit_date_version(use_local_git=true) called, but git isn't installed"
-			end
-
-			sq_git_dir = shell_quoted_string(Dir.pwd)
-		else
-			sq_git_dir = shell_quoted_string((File.dirname(caller_file) rescue nil || Dir.pwd))
-		end
-
-		commit_dates = `git -C #{sq_git_dir} log --format=%at`.
+		commit_dates = run_command(["git", "-C", git_dir(use_local_git), "log", "--no-show-signature", "--format=%at"], "getting dates of all commits").
 		               split("\n").
 		               map { |l| Time.at(Integer(l)).strftime("%Y%m%d") }
 
@@ -242,14 +219,50 @@ module GitVersionBump
 	private
 
 	def self.git_available?
-		system("git --version > #{DEVNULL} 2>&1")
-
-		$? == 0
+		try_command(["git", "--version"])
 	end
 
-	def self.dirty_tree?(sq_git_dir='.')
+	def self.dirty_tree?(dir='.')
 		# Are we in a dirty, dirty tree?
-		! `git -C #{sq_git_dir} status --porcelain 2> #{DEVNULL}`.empty?
+		! run_command(["git", "-C", dir, "status", "--porcelain"], "checking for tree cleanliness").empty?
+	end
+
+	# Execute a command, specified as an array.
+	#
+	# On success, the full output of the command (stdout+stderr, interleaved) is returned.
+	# On error, a `CommandFailure` exception is raised.
+	#
+	def self.run_command(cmd, desc)
+		unless cmd.is_a?(Array)
+			raise ArgumentError, "Must pass command line arguments in an array"
+		end
+
+		unless cmd.all? { |s| s.is_a?(String) }
+			raise ArgumentError, "Command line arguments must be strings"
+		end
+
+		if debug?
+			p :GVB_CMD, desc, cmd
+		end
+
+		out, status = Open3.capture2e(*cmd)
+
+		if status.exitstatus != 0
+			raise CommandFailure.new("Failed while #{desc}", out, status.exitstatus)
+		else
+			out
+		end
+	end
+
+	# Execute a command, and return whether it succeeded or failed.
+	#
+	def self.try_command(cmd)
+		begin
+			run_command(cmd, "try_command")
+			true
+		rescue CommandFailure
+			false
+		end
 	end
 
 	def self.caller_file
@@ -260,6 +273,7 @@ module GitVersionBump
 		Pathname(
 		  caller_locations.
 		  map(&:path).
+		  tap { |c| p :CALLER_LOCATIONS, c if debug? }.
 		  find { |l| l != __FILE__ }
 		).realpath.to_s rescue nil
 	end
@@ -319,17 +333,23 @@ module GitVersionBump
 		end
 	end
 
-	def self.shell_quoted_string(dir_string)
-		if Gem.win_platform?
-			return "\"#{dir_string}\""
+	def self.git_dir(use_local_git = false)
+		if use_local_git
+			unless git_available?
+				raise RuntimeError,
+				      "Cannot use git-version-bump with use_local_git, as git is not installed"
+			end
+
+			Dir.pwd
 		else
-			# Shell Quoted, for your convenience
-			return "'#{dir_string.gsub("'", "'\\''")}'"
-		end
+			File.dirname(caller_file) rescue nil || Dir.pwd
+		end.tap { |d| p :GVB_GIT_DIR, use_local_git, d if debug? }
 	end
+	private_class_method :git_dir
 
-	private_class_method :shell_quoted_string
-
+	def self.debug?
+		ENV.key?("GVB_DEBUG")
+	end
 end
 
 GVB = GitVersionBump unless defined? GVB

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git-version-bump
 version: !ruby/object:Gem::Version
-  version: 0.17.1
+  version: 0.18.0
 platform: ruby
 authors:
 - Matt Palmer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-10 00:00:00.000000000 Z
+date: 2023-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github-release
@@ -102,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.5
 signing_key: 
 specification_version: 4
 summary: Manage your app version entirely via git tags