Module: GitVersionBump

Defined in:
lib/git-version-bump.rb,
lib/git-version-bump/version.rb

Defined Under Namespace

Classes: VersionUnobtainable

Constant Summary collapse

DEVNULL = 
Gem.win_platform? ? "NUL" : "/dev/null"
VERSION = 
GVB.version
MAJOR_VERSION = 
GVB.major_version
MINOR_VERSION = 
GVB.minor_version
PATCH_VERSION = 
GVB.patch_version
INTERNAL_REVISION = 
GVB.internal_revision
DATE = 
GVB.date

Class Method Summary collapse

Class Method Details

.caller_file ⇒ Object 



245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/git-version-bump.rb', line 245

def self.caller_file
	# Who called us?  Because this method gets called from other methods
	# within this file, we can't just look at Gem.location_of_caller, but
	# 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] }.
	  find { |l| l != __FILE__ }
	).realpath.to_s rescue nil
end

.caller_gemspec ⇒ Object

Raises:



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/git-version-bump.rb', line 257

def self.caller_gemspec
	cf = caller_file or return nil

	# 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)]
		search_dirs.map! do |d|
			begin
				Pathname(d).realpath.to_s
			rescue Errno::ENOENT
				nil
			end
		end.compact!

		if search_dirs.find { |d| cf.index(d) == 0 }
			return spec
		end
	end

	raise VersionUnobtainable,
	      "Unable to find gemspec for caller file #{cf}"
end

.commit_date_version(use_local_git = false) ⇒ Object

Calculate a version number based on the date of the most recent git commit.

Return a version format string of the form ‘“0.YYYYMMDD.N”`, where `YYYYMMDD` is the date of the “top-most” commit in the tree, and `N` is the number of other commits also made on that date.

This version format is not recommented for general use. It has benefit only in situations where the principles of Semantic Versioning have no real meaning, such as packages where there is little or no concept of “backwards compatibility” (eg packages which only contain images and other assets), or where the package can, for reasons outside that of the package itself, never break backwards compatibility (definitions of binary-packed structures shared amongst multiple systems).

The format of this commit-date-based version format allows for a strictly monotonically-increasing version number, aligned with the progression of the underlying git commit log.

One limitation of the format is that it doesn’t deal with the issue of package builds made from multiple divergent trees. Unlike ‘git-describe`-based output, there is no “commit hash” identity included in the version string. This is because of (ludicrous) limitations of the Rubygems format definition – the moment there’s a letter in the version number, the package is considered a “pre-release” version. Since hashes are hex, we’re boned. Sorry about that. Don’t make builds off a branch, basically.



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/git-version-bump.rb', line 192

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`.
	               split("\n").
	               map { |l| Time.at(Integer(l)).strftime("%Y%m%d") }

	if $? == 0
		# We got a log; calculate our version number and we're done.
		version_date = commit_dates.first
		commit_count = commit_dates.select { |d| d == version_date }.length - 1
		dirty_suffix = if dirty_tree?
			".dirty.#{Time.now.strftime("%Y%m%d.%H%M%S")}"
		else
			""
		end

		return "0.#{version_date}.#{commit_count}#{dirty_suffix}"
	end

	# 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)
end

.date(use_local_git = false) ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/git-version-bump.rb', line 81

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.

		if dirty_tree?
			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
		end
	else
		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")
		end

		raise RuntimeError,
		      "GVB.date called from mysterious, non-gem location."
	end
end

.dirty_tree? ⇒ Boolean

Returns:

  • (Boolean) 


238
239
240
241
242
243
 
# File 'lib/git-version-bump.rb', line 238

def self.dirty_tree?
	# 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
end

.gem_version(use_local_git = false) ⇒ Object 



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/git-version-bump.rb', line 282

def self.gem_version(use_local_git = false)
	if use_local_git
		raise VersionUnobtainable,
		      "Unable to determine version from local git repo.  This should never happen."
	end

	if spec = caller_gemspec
		return spec.version.to_s
	else
		# If we got here, something went *badly* wrong -- presumably, we
		# weren't called from within a loaded gem, and so we've got *no*
		# idea what's going on.  Time to bail!
		if git_available?
			raise VersionUnobtainable,
			      "GVB.version(#{use_local_git.inspect}) failed, and I really don't know why."
		else
			raise VersionUnobtainable,
			      "GVB.version(#{use_local_git.inspect}) failed; perhaps you need to install git?"
		end
	end
end

.git_available? ⇒ Boolean

Returns:

  • (Boolean) 


232
233
234
235
236
 
# File 'lib/git-version-bump.rb', line 232

def self.git_available?
	system("git --version > #{DEVNULL} 2>&1")

	$? == 0
end

.internal_revision(use_local_git = false) ⇒ Object 



77
78
79
 
# File 'lib/git-version-bump.rb', line 77

def self.internal_revision(use_local_git=false)
	version(use_local_git).split('.', 4)[3].to_s
end

.major_version(use_local_git = false) ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/git-version-bump.rb', line 41

def self.major_version(use_local_git=false)
	ver = version(use_local_git)
	v   = ver.split('.')[0]

	unless v =~ /^[0-9]+$/
		raise ArgumentError,
		        "#{v} (part of #{ver.inspect}) is not a numeric version component.  Abandon ship!"
	end

	return v.to_i
end

.minor_version(use_local_git = false) ⇒ Object 



53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/git-version-bump.rb', line 53

def self.minor_version(use_local_git=false)
	ver = version(use_local_git)
	v   = ver.split('.')[1]

	unless v =~ /^[0-9]+$/
		raise ArgumentError,
		        "#{v} (part of #{ver.inspect}) is not a numeric version component.  Abandon ship!"
	end

	return v.to_i
end

.patch_version(use_local_git = false) ⇒ Object 



65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/git-version-bump.rb', line 65

def self.patch_version(use_local_git=false)
	ver = version(use_local_git)
	v   = ver.split('.')[2]

	unless v =~ /^[0-9]+$/
		raise ArgumentError,
		        "#{v} (part of #{ver.inspect}) is not a numeric version component.  Abandon ship!"
	end

	return v.to_i
end

.tag_version(v, release_notes = false) ⇒ Object 



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/git-version-bump.rb', line 120

def self.tag_version(v, release_notes = 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]+$/, '')

			log_file = Tempfile.new('gvb')

			log_file.puts <<-EOF.gsub(/^\t\t\t\t\t/, '')



				# Write your release notes above.  The first line should be the release name.
				# To help you remember what's in here, the commits since your last release
				# are listed below. This will become v#{v}
				#
			EOF

			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}")
			if Digest::SHA1.hexdigest(File.read(log_file.path)) == pre_hash
				puts "Release notes not edited; aborting"
				log_file.unlink
				return
			end

			puts "Tagging version #{v}..."
			system("git tag -a -F #{log_file.path} v#{v}")
			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")
	end
end

.version(use_local_git = false) ⇒ Object 



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/git-version-bump.rb', line 10

def self.version(use_local_git=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_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}`.
	            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, 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)
end