git-version-bump 0.14.0 → 0.17.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 837dc82b6ee0a0b96af85d279801fc5a5e59e459
-  data.tar.gz: 5d93a51479c3701e104fb02a006305cebeac8f17
+SHA256:
+  metadata.gz: '084e552015ea8de36e92598ea4ec4de57916b0cdf0ba9ee8c8ff7974da9df8ff'
+  data.tar.gz: e361b6214097aa2e9cf4a30e993cb4ad9dc9c5f3283ae6d39d219e28f684f8fb
 SHA512:
-  metadata.gz: dc025408b232aa2c39b8b9dea02a1c51e1155fe2a2543bd5a18e0b0b957c4cfc428134725de8c27f096e41b34365d7d6c2189ae4dd76810d53ce5a73a025bd15
-  data.tar.gz: 61b58d5d4134bf8d1e57f3c8396ff2d1a8b0e049210c4eff2599195eacce6c56b2cf7aaef6d4d6e3225ac4faa86487867338140fb7dce3af95a27110436e52e7
+  metadata.gz: 4e168a05d6349ecc3b69bf09eff3d1ddd28253dde4c69b4ee007257de73af6a7b195dc9e1186d7fca9106dfa40c88680f02139fcc808fb5a2906e8da3b09c534
+  data.tar.gz: 4e295c50077e23342b48c4a9dbfad2a356be4c0d33a5489f365812309c1fa90cd45b3c50197f8ab94b5a8b9fc70aa0771363ed933ffb44e4bee3cbd85b2a7457

data/README.md

@@ -99,7 +99,7 @@ gemspec, like this:
     Gem::Specification.new do |s|
       s.version = GVB.version
       s.date    = GVB.date
-      
+
       ...
     end
 
@@ -118,7 +118,7 @@ what version of a library you're running, then you probably like to define a
 to do:
 
     require 'git-version-bump'
-    
+
     class Foobar
       VERSION = GVB.version
     end
@@ -126,6 +126,20 @@ to do:
 This will work correctly inside your git tree, and also in your installed
 gem.  Magical!
 
+#### For projects using lite tags
+
+If you are using GitHub releases for your project or some other method that
+involves light tags (tags with no annotations), you might notice that these
+tags are not detected by git-version-bump by default.  If you want these
+commits to be detected then use the following configuration:
+
+    require 'git-version-bump'
+
+    class Foobar
+      # First parameter is use_local_git, second is include_lite_tags
+      VERSION = GVB.version(false, true)
+    end
+
 
 # Contributing
 

data/bin/git-version-bump

@@ -4,10 +4,11 @@ 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] <major|minor|patch|show>
+		Usage: git version-bump [-n|--notes] [-d|--dry-run] <major|minor|patch|show>
 
 		'major': x.y.z -> x+1.0.0
 		'minor': x.y.z -> x.y+1.0
@@ -15,11 +16,15 @@ if ARGV[0].nil? or
 
 		'show': Display the current GVB version
 
-		--release: Prompt for "release notes" to add to the release tag
+		-d, --dry-run: Calculate and return the bump value, but don't update git workspace or remote
+		-n, --notes: Prompt for "release notes" to add to the release tag
+		-l, --lite-tags: Include non-annotated git tags
 	EOF
 end
 
 release_notes = ARGV.delete('-n') || ARGV.delete('--notes')
+dry_run = ARGV.delete('-d') || ARGV.delete('--dry-run')
+lite_tags = ARGV.delete('-l') || ARGV.delete('--lite-tags')
 
 if ARGV[0].nil? or ARGV[0].empty?
 	exit 1
@@ -27,13 +32,13 @@ elsif ARGV[0] == '-h' or ARGV[0] == '--help'
 	exit 0
 end
 
-case ARGV[0].downcase
+result = case ARGV[0].downcase
 	when /^maj?o?r?$/
-		GVB.tag_version "#{GVB.major_version(true) + 1}.0.0", release_notes
+		"#{GVB.major_version(true) + 1}.0.0"
 	when /^min?o?r?$/
-		GVB.tag_version "#{GVB.major_version(true)}.#{GVB.minor_version(true)+1}.0", release_notes
+		"#{GVB.major_version(true)}.#{GVB.minor_version(true)+1}.0"
 	when /^pa?t?c?h?$/
-		GVB.tag_version "#{GVB.major_version(true)}.#{GVB.minor_version(true)}.#{GVB.patch_version(true)+1}", release_notes
+		"#{GVB.major_version(true)}.#{GVB.minor_version(true)}.#{GVB.patch_version(true)+1}"
 	when /^sh?o?w?$/
 		puts GVB.version(true)
 		exit 0
@@ -42,4 +47,9 @@ case ARGV[0].downcase
 		exit 1
 end
 
-puts "Version is now #{GVB.version(true)}."
+if dry_run
+	puts result
+else
+	GVB.tag_version result, release_notes, lite_tags
+	puts "Version is now #{GVB.version(true)}."
+end

data/git-version-bump.gemspec

@@ -1,4 +1,6 @@
-require File.expand_path('../lib/git-version-bump', __FILE__)
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'git-version-bump'
 
 Gem::Specification.new do |s|
 	s.name = "git-version-bump"
@@ -6,7 +8,8 @@ Gem::Specification.new do |s|
 	s.version = GVB.version
 	s.date    = GVB.date
 
-	s.platform = Gem::Platform::RUBY
+	s.platform              = Gem::Platform::RUBY
+	s.required_ruby_version = ">= 2.1.0"
 
 	s.homepage = "http://theshed.hezmatt.org/git-version-bump"
 	s.summary = "Manage your app version entirely via git tags"

data/lib/git-version-bump.rb

@@ -5,20 +5,26 @@ require 'pathname'
 module GitVersionBump
 	class VersionUnobtainable < StandardError; end
 
-	def self.version(use_local_git=false)
+	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 = "'#{Dir.pwd.gsub("'", "'\\''")}'"
+			sq_git_dir = shell_quoted_string(Dir.pwd)
 		else
-			# Shell Quoted, for your convenience
-			sq_git_dir = "'" + (File.dirname(caller_file) rescue nil || Dir.pwd).gsub("'", "'\\''") + "'"
+			sq_git_dir = shell_quoted_string((File.dirname(caller_file) rescue nil || Dir.pwd))
 		end
 
-		git_ver = `git -C #{sq_git_dir} describe --dirty='.1.dirty.#{Time.now.strftime("%Y%m%d.%H%M%S")}' --match='v[0-9]*.[0-9]*.*[0-9]' 2>/dev/null`.
+		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('-', '.')
@@ -30,15 +36,17 @@ module GitVersionBump
 		# 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, dump out our
-		# super-special version and be done with it, otherwise try to use the
-		# gem version.
-		system("git -C #{sq_git_dir} status >/dev/null 2>&1")
-		 "0.0.0.1.ENOTAG" if $? == 0 ? "0.0.0.1.ENOTAG" : gem_version(use_local_git)
+		# 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"
+		end
 	end
 
-	def self.major_version(use_local_git=false)
-		ver = version(use_local_git)
+	def self.major_version(use_local_git=false, include_lite_tags=false)
+		ver = version(use_local_git, include_lite_tags)
 		v   = ver.split('.')[0]
 
 		unless v =~ /^[0-9]+$/
@@ -49,8 +57,8 @@ module GitVersionBump
 		return v.to_i
 	end
 
-	def self.minor_version(use_local_git=false)
-		ver = version(use_local_git)
+	def self.minor_version(use_local_git=false, include_lite_tags=false)
+		ver = version(use_local_git, include_lite_tags)
 		v   = ver.split('.')[1]
 
 		unless v =~ /^[0-9]+$/
@@ -61,8 +69,8 @@ module GitVersionBump
 		return v.to_i
 	end
 
-	def self.patch_version(use_local_git=false)
-		ver = version(use_local_git)
+	def self.patch_version(use_local_git=false, include_lite_tags=false)
+		ver = version(use_local_git, include_lite_tags)
 		v   = ver.split('.')[2]
 
 		unless v =~ /^[0-9]+$/
@@ -73,8 +81,8 @@ module GitVersionBump
 		return v.to_i
 	end
 
-	def self.internal_revision(use_local_git=false)
-		version(use_local_git).split('.', 4)[3].to_s
+	def self.internal_revision(use_local_git=false, include_lite_tags=false)
+		version(use_local_git, include_lite_tags).split('.', 4)[3].to_s
 	end
 
 	def self.date(use_local_git=false)
@@ -84,22 +92,21 @@ module GitVersionBump
 				      "GVB.date(use_local_git=true), but git is not installed"
 			end
 
-			sq_git_dir = "'#{Dir.pwd.gsub("'", "'\\''")}'"
+			sq_git_dir = shell_quoted_string(Dir.pwd)
 		else
-			# Shell Quoted, for your convenience
-			sq_git_dir = "'" + (File.dirname(caller_file) rescue nil || Dir.pwd).gsub("'", "'\\''") + "'"
+			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 >/dev/null 2>&1")
+		system("git -C #{sq_git_dir} status > #{DEVNULL} 2>&1")
 		if $? == 0
 			# Yes, we're in git.
 
-			if dirty_tree?
+			if dirty_tree?(sq_git_dir)
 				return Time.now.strftime("%F")
 			else
 				# Clean tree.  Date of last commit is needed.
-				return `git -C #{sq_git_dir} show --format=format:%ad --date=short | head -n 1`.strip
+				return (`git -C #{sq_git_dir} show --no-show-signature --format=format:%cd --date=short`.lines.first || "").strip
 			end
 		else
 			if use_local_git
@@ -117,14 +124,16 @@ module GitVersionBump
 		end
 	end
 
-	def self.tag_version(v, release_notes = false)
+	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
 				# 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.
-				prev_tag = `git describe --always`.strip.gsub(/-\d+-g[0-9a-f]+$/, '')
+				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]+$/, '')
 
 				log_file = Tempfile.new('gvb')
 
@@ -139,7 +148,7 @@ module GitVersionBump
 				EOF
 
 				log_file.close
-				system("git log --format='# %h  %s' #{prev_tag}..HEAD >>#{log_file.path}")
+				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}")
@@ -157,8 +166,8 @@ module GitVersionBump
 				system("git tag -a -m 'Version v#{v}' v#{v}")
 			end
 
-			system("git push >/dev/null 2>&1")
-			system("git push --tags >/dev/null 2>&1")
+			system("git push > #{DEVNULL} 2>&1")
+			system("git push --tags > #{DEVNULL} 2>&1")
 		end
 	end
 
@@ -196,10 +205,9 @@ module GitVersionBump
 				      "GVB.commit_date_version(use_local_git=true) called, but git isn't installed"
 			end
 
-			sq_git_dir = "'#{Dir.pwd.gsub("'", "'\\''")}'"
+			sq_git_dir = shell_quoted_string(Dir.pwd)
 		else
-			# Shell Quoted, for your convenience
-			sq_git_dir = "'" + (File.dirname(caller_file) rescue nil || Dir.pwd).gsub("'", "'\\''") + "'"
+			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`.
@@ -222,25 +230,26 @@ module GitVersionBump
 		# git failed us; either we're not in a git repo or else it's a git
 		# repo that's not got any commits.
 
-		# Are we in a git repo with no tags?  If so, dump out our
-		# super-special version and be done with it.
-		system("git -C #{sq_git_dir} status >/dev/null 2>&1")
-		$? == 0 ? "0.0.0.1.ENOCOMMITS" : gem_version(use_local_git)
+		# Are we in a git repo with no commits?  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.ENOCOMMITS"
+		end
 	end
 
 	private
 
 	def self.git_available?
-		system("git --version >/dev/null 2>&1")
+		system("git --version > #{DEVNULL} 2>&1")
 
 		$? == 0
 	end
 
-	def self.dirty_tree?
+	def self.dirty_tree?(sq_git_dir='.')
 		# Are we in a dirty, dirty tree?
-		system("! git diff --no-ext-diff --quiet --exit-code 2>/dev/null || ! git diff-index --cached --quiet HEAD 2>/dev/null")
-
-		$? == 0
+		! `git -C #{sq_git_dir} status --porcelain 2> #{DEVNULL}`.empty?
 	end
 
 	def self.caller_file
@@ -249,8 +258,8 @@ module GitVersionBump
 		# instead we need to parse the caller stack ourselves to find which
 		# gem we're trying to version all over.
 		Pathname(
-		  caller.
-		  map  { |l| l.split(':')[0] }.
+		  caller_locations.
+		  map(&:path).
 		  find { |l| l != __FILE__ }
 		).realpath.to_s rescue nil
 	end
@@ -261,8 +270,16 @@ module GitVersionBump
 		# Grovel through all the loaded gems to try and find the gem
 		# that contains the caller's file.
 		Gem.loaded_specs.values.each do |spec|
-			search_dirs = spec.require_paths.map { |d| "#{spec.full_gem_path}/#{d}" } +
-			              [spec.bin_dir]
+			# On Windows I have encountered gems that already have an absolute
+			# path, verify that the path is relative before appending to it
+			search_dirs = spec.require_paths.map do |path|
+				if Pathname(path).absolute?
+					path
+				else
+					File.join(spec.full_gem_path, path)
+				end
+			end
+			search_dirs << File.join(spec.full_gem_path, spec.bindir)
 			search_dirs.map! do |d|
 				begin
 					Pathname(d).realpath.to_s
@@ -301,6 +318,18 @@ module GitVersionBump
 			end
 		end
 	end
+
+	def self.shell_quoted_string(dir_string)
+		if Gem.win_platform?
+			return "\"#{dir_string}\""
+		else
+			# Shell Quoted, for your convenience
+			return "'#{dir_string.gsub("'", "'\\''")}'"
+		end
+	end
+
+	private_class_method :shell_quoted_string
+
 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.14.0
+  version: 0.17.1
 platform: ruby
 authors:
 - Matt Palmer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-13 00:00:00.000000000 Z
+date: 2020-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github-release
@@ -95,17 +95,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Manage your app version entirely via git tags
 test_files: []
-has_rdoc: