git-version-bump 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94d95a18eae098b144f0f9afff676405cb1a05cf35b6786410e160269d7b34ec
-  data.tar.gz: db3e976ffa2d7e5493c957d340aafaffdd570d45bc3db83e2f0d6f70742e58c0
+  metadata.gz: ed72f5f43e0499fd3173d49cba195cc578b5caed0469ecae7d6767c5e138ed25
+  data.tar.gz: 738c6792fccd8af5808ed0c682fe4bac074bb0b0cdc26a54d2468f20077ed2b6
 SHA512:
-  metadata.gz: 4c2a692ace08cda02976a2647dec09b978a82829e51e7bdec4a93c7954d3e4728e24bcac211fa128861fec979f5f41290e88ca40f6e04feb371f362854abf9e3
-  data.tar.gz: 737dd2b41d89ca7d33722948e69a9de74f10e260d4776aba82cfee9f6b4a15df28042b86d839ceb53012ac7a1247278b8e46b259e10ced7cae904cadb512510d
+  metadata.gz: '06647807704eb29d67b960a806159f01353f0f220cce1340fccf4c0413a71ec80f7f0898a59929996a18a147f8c7938c1ce61c146946edb442889a872c97b407'
+  data.tar.gz: 4d540d47ddb7ef19f99b7402a2d4e695672aabfea51f2f94a5617b5576dde50225d7e6254902eef672608b69d95e1b0dbb1a8f64175407ea7d2a9ba10caaf15d

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

@@ -18,11 +18,13 @@ if ARGV[0].nil? or
 
 		-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
@@ -48,6 +50,6 @@ end
 if dry_run
 	puts result
 else
-	GVB.tag_version result, release_notes
+	GVB.tag_version result, release_notes, lite_tags
 	puts "Version is now #{GVB.version(true)}."
 end

data/lib/git-version-bump.rb

@@ -5,9 +5,11 @@ require 'pathname'
 module GitVersionBump
 	class VersionUnobtainable < StandardError; 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)
+	def self.version(use_local_git=false, include_lite_tags=false)
 		if use_local_git
 			unless git_available?
 				raise RuntimeError,
@@ -19,7 +21,10 @@ module GitVersionBump
 			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> #{DEVNULL}`.
+		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('-', '.')
@@ -31,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 > #{DEVNULL} 2>&1")
-		$? == 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]+$/
@@ -50,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]+$/
@@ -62,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]+$/
@@ -74,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)
@@ -95,11 +102,11 @@ module GitVersionBump
 		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 --no-show-signature --format=format:%cd --date=short`.lines.first.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')
 
@@ -221,10 +230,13 @@ 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 > #{DEVNULL} 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
@@ -235,11 +247,9 @@ module GitVersionBump
 		$? == 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> #{DEVNULL} || ! git diff-index --cached --quiet HEAD 2> #{DEVNULL}")
-
-		$? == 0
+		!system("git -C #{sq_git_dir} diff --no-ext-diff --quiet --exit-code 2> #{DEVNULL}") || !("git -C #{sq_git_dir} diff-index --cached --quiet HEAD 2> #{DEVNULL}")
 	end
 
 	def self.caller_file
@@ -248,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
@@ -260,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}" } +
-			              [File.join(spec.full_gem_path, spec.bindir)]
+			# 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git-version-bump
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Matt Palmer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-19 00:00:00.000000000 Z
+date: 2020-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github-release
@@ -102,8 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Manage your app version entirely via git tags