Module: Rake::DevEiate::Git

Defined in:
lib/rake/deveiate/git.rb

Overview

Git version-control tasks

:TODO:

  • Handle ‘ci` when on a branch that isn’t yet published. Currently it does:

Pull and update from 'git@github.com:RavnGroup/ravn.git'? Yes
Fetching...
Pulling...
rake aborted!
Git::GitExecuteError: git '--git-dir=/Users/ged/source/ravn/ravn/.git'
  '--work-tree=/Users/ged/source/ravn/ravn' '-c' 'color.ui=false' pull
  'origin' '<branchname>' 2>&1:fatal: couldn't find remote ref
  <branchname>
/Users/ged/.rvm/gems/ruby-2.7.3@ravn/gems/rake-13.0.3/exe/rake:27:in `<top (required)>'
/Users/ged/.rvm/gems/ruby-2.7.3@ravn/bin/ruby_executable_hooks:22:in `eval'
/Users/ged/.rvm/gems/ruby-2.7.3@ravn/bin/ruby_executable_hooks:22:in `<main>'
Tasks: TOP => ci => checkin => precheckin => git:precheckin => git:pull
(See full trace by running task with --trace)

Constant Summary collapse

COMMIT_MSG_FILE =

The name of the file to edit for the commit message

Pathname( 'commit-msg.txt' )
IGNORE_FILE =

The name of the ignore file

Rake::DevEiate::PROJECT_DIR + '.gitignore'
STATUS_COLORS =

Colors for presenting file statuses

{
	'M' => [:blue],                  # modified
	'A' => [:bold, :green],          # added
	'D' => [:bold, :black],          # deleted
	'C' => [:white],                 # clean
	'!' => [:bold, :white, :on_red], # missing
	'?' => [:yellow],                # not tracked
	'I' => [:dim, :white],           # ignored
}
STATUS_DESCRIPTIONS = 
{
	'M' => 'modified',
	'D' => 'deleted',
	'?' => 'untracked',
	'A' => 'new',
}
FILE_INDENT =

File indentation

" • "
DEFAULT_RELEASE_BRANCH =

The name of the branch releases should be created from

'master'

Instance Method Summary collapse

Instance Method Details

#current_git_version_tag ⇒ Object

Fetch the name of the current version’s tag.



495
496
497
 
# File 'lib/rake/deveiate/git.rb', line 495

def current_git_version_tag
	return [ self.release_tag_prefix, self.version ].join
end

#define_tasks ⇒ Object

Define version-control tasks



68
69
70
71
72
73
74
75
76
77
78
79
80
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
119
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
 
# File 'lib/rake/deveiate/git.rb', line 68

def define_tasks
	super if defined?( super )

	return unless self.is_git_working_copy?

	self.release_branch = DEFAULT_RELEASE_BRANCH

	# :TODO: Should be refactored up with the same code in the hg lib.
	file COMMIT_MSG_FILE.to_s do |task|
		commit_log = Pathname( task.name )

		edit_git_commit_log( commit_log )
		unless commit_log.size?
			self.prompt.error "Empty commit message; aborting."
			commit_log.unlink if commit_log.exist?
			abort
		end
	end

	CLEAN.include( COMMIT_MSG_FILE.to_s )

	namespace :git do

		desc "Prepare for a new release"
		task( :prerelease, &method(:do_git_prerelease) )

		desc "Check for new files and offer to add/ignore/delete them."
		task( :newfiles, &method(:do_git_newfiles) )
		task :add => :newfiles

		desc "Pull and update from the default repo"
		task( :pull, &method(:do_git_pull) )

		desc "Pull and update without confirmation"
		task( :pull_without_confirmation, &method(:do_git_pull_without_confirmation) )

		desc "Update to tip"
		task( :update, &method(:do_git_update) )

		desc "Clobber all changes (git up -C)"
		task( :update_and_clobber, &method(:do_git_update_and_clobber) )

		desc "Git-specific pre-checkin hook"
		task :precheckin => [ :pull, :newfiles, :check_for_changes ]

		desc "Check the current code in if tests pass"
		task( :checkin => COMMIT_MSG_FILE.to_s, &method(:do_git_checkin) )

		desc "Git-specific pre-release hook"
		task :prerelease => 'git:check_history'

		desc "Git-specific post-release hook"
		task( :postrelease, &method(:do_git_postrelease) )

		desc "Push to the default origin repo (if there is one)"
		task( :push, &method(:do_git_push) )

		desc "Push to the default repo without confirmation"
		task :push_without_confirmation do |task, args|
			self.git.push
		end

		desc "Check the history file to ensure it contains an entry for each release tag"
		task( :check_history, &method(:do_git_check_history) )

		desc "Generate and edit a new version entry in the history file"
		task( :update_history, &method(:do_git_update_history) )

		task( :check_for_changes, &method(:do_git_check_for_changes) )
		task( :debug, &method(:do_git_debug) )
	end


	# Hook some generic tasks to the mercurial-specific ones
	task :checkin => 'git:checkin'
	task :precheckin => 'git:precheckin'

	task :prerelease => 'git:prerelease'
	task :postrelease => 'git:postrelease'

	desc "Update the history file with the changes since the last version tag."
	task :update_history => 'git:update_history'

	task :debug => 'git:debug'
rescue ::Exception => err
	$stderr.puts "%s while defining Git tasks: %s" % [ err.class.name, err.full_message(order: :bottom) ]
	raise
end

#do_git_check_for_changes(task, args) ⇒ Object

Check the status of the repo and ensure there are outstanding changes. If there are no changes, abort.



355
356
357
358
359
360
361
 
# File 'lib/rake/deveiate/git.rb', line 355

def do_git_check_for_changes( task, args )
	# :FIXME: Figure out a better way to do this.
	unless self.git.status.any?( &:type )
		self.prompt.error "Working copy is clean."
		abort
	end
end

#do_git_check_history(task, args) ⇒ Object

Check the history file against the list of release tags in the working copy and ensure there’s an entry for each tag.



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/rake/deveiate/git.rb', line 336

def do_git_check_history( task, args )
	unless self.history_file.readable?
		self.prompt.error "History file is missing or unreadable."
		abort
	end

	self.prompt.say "Checking history..."
	missing_tags = self.get_git_unhistoried_version_tags

	unless missing_tags.empty?
		self.prompt.error "%s needs updating; missing entries for tags: %s" %
			[ self.history_file, missing_tags.join(', ') ]
		abort
	end
end

#do_git_checkin(task, args) ⇒ Object

The body of the checkin task.



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/rake/deveiate/git.rb', line 292

def do_git_checkin( task, args )
	commit_msg = COMMIT_MSG_FILE.read.strip

	self.prompt.say( "---", color: :cyan )
	self.prompt.say( commit_msg )
	self.prompt.say( "---", color: :cyan )

	if self.prompt.yes?( "Continue with checkin?" )
		self.git.commit( COMMIT_MSG_FILE.read )
		rm_f COMMIT_MSG_FILE
	else
		abort
	end
	Rake::Task[ 'git:push' ].invoke
end

#do_git_debug(task, args) ⇒ Object

Show debugging information.



433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/rake/deveiate/git.rb', line 433

def do_git_debug( task, args )
	self.prompt.say( "Git Info", color: :bright_green )

	if self.is_git_working_copy?
		self.prompt.say( "Release tag prefix: " )
		self.prompt.say( self.release_tag_prefix, color: :bold )

		self.prompt.say( "Version tags:" )
		self.get_git_version_tag_names.each do |tag|
			self.prompt.say( '- ' )
			self.prompt.say( tag, color: :bold )
		end

		self.prompt.say( "History file versions:" )
		self.get_history_file_versions.each do |tag|
			self.prompt.say( '- ' )
			self.prompt.say( tag, color: :bold )
		end

		self.prompt.say( "Unhistoried version tags:" )
		self.get_git_unhistoried_version_tags.each do |tag|
			self.prompt.say( '- ' )
			self.prompt.say( tag, color: :bold )
		end
	else
		self.prompt.say( "Doesn't appear to be a Git repository." )
	end

	self.prompt.say( "\n" )
end

#do_git_newfiles(task, args) ⇒ Object

The body of the git:newfiles task.



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/rake/deveiate/git.rb', line 214

def do_git_newfiles( task, args )
	self.prompt.say "Checking for new files..."
	status = self.git.status

	files_to_add = status.changed.keys
	files_to_ignore = []
	files_to_delete = []

	status.untracked.each do |path, status_file|
		description = "  %s: untracked" % [ path ]
		action = self.prompt.select( description ) do |menu|
			menu.choice "add", :a
			menu.choice "ignore", :i
			menu.choice "skip", :s
			menu.choice "delete", :d
		end

		case action
		when :a
			files_to_add << path
		when :i
			files_to_ignore << path
		when :d
			files_to_delete << path
		end
	end

	unless files_to_add.empty?
		$stderr.puts "Adding: %p" % [ files_to_add ]
		self.git.add( files_to_add )
	end

	unless files_to_ignore.empty?
		git_ignore_files( *files_to_ignore )
	end

	unless files_to_delete.empty?
		delete_extra_files( *files_to_delete )
	end
end

#do_git_postrelease(task, args) ⇒ Object

The body of the git:postrelease task.



202
203
204
205
206
207
208
209
210
 
# File 'lib/rake/deveiate/git.rb', line 202

def do_git_postrelease( task, args )
	if self.git.status.untracked.keys.any? {|path| path.start_with?('checksum/') }
		self.prompt.say "Adding release artifacts..."
		self.git.add( 'checksum' )
		self.git.commit( "Adding release checksum." )
	end

	Rake::Task['git:push'].invoke
end

#do_git_prerelease(task, args) ⇒ Object

The body of the git:prerelease task.



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/rake/deveiate/git.rb', line 165

def do_git_prerelease( task, args )
	if self.release_branch
		current_branch = self.git.cmd( 'branch', '--show-current' )
		unless self.release_branch == current_branch
			self.prompt.warn "Releasing from a non-release branch (%s)." % [ current_branch ]
			fail unless self.prompt.yes?( "Release anyway?" )
		end
	end

	status = self.git.status
	unless status.untracked.empty? && status.changed.empty?
		self.show_git_file_statuses( status )

		fail unless self.prompt.yes?( "Release anyway?" ) do |q|
			q.default( false )
		end

		self.prompt.warn "Okay, releasing with uncommitted versions."
	end

	pkg_version_tag = self.current_git_version_tag
	rev = self.git.revparse( 'HEAD' )

	# Look for a tag for the current release version, and if it exists abort
	if self.git.tags.find {|tag| tag.name == pkg_version_tag }
		self.prompt.error "Version #{self.version} already has a tag."
		fail
	end

	# Tag the current rev
	self.prompt.ok "Tagging rev %s as %s" % [ rev, pkg_version_tag ]
	self.git.cmd( 'tag', '-as', '-m', "Tagging for release #{pkg_version_tag}",
		 pkg_version_tag, rev )
end

#do_git_pull(task, args) ⇒ Object

The body of the git:pull task.



257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/rake/deveiate/git.rb', line 257

def do_git_pull( task, args )
	origin = self.git.remote

	if ( origin_url = origin.url )
		if self.prompt.yes?( "Pull and update from '#{origin_url}'?" )
			self.prompt.say "Fetching..."
			self.git.fetch( 'origin', prune: true )
			self.prompt.say "Pulling..."
			self.git.pull( 'origin', self.git.current_branch )
		end
	else
		trace "Skipping pull: No 'origin' remote."
	end
end

#do_git_pull_without_confirmation(task, args) ⇒ Object

The body of the git:pull_without_confirmation task.



274
275
276
 
# File 'lib/rake/deveiate/git.rb', line 274

def do_git_pull_without_confirmation( task, args )
	self.git.pull
end

#do_git_push(task, args) ⇒ Object

The body of the push task.



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/rake/deveiate/git.rb', line 310

def do_git_push( task, args )
	git = self.git
	origin = git.remote

	if (origin_url = origin.url)
		if self.prompt.yes?( "Push to '#{origin_url}'?" ) {|q| q.default(false) }
			unless git.is_remote_branch?( git.current_branch )
				if self.prompt.yes?( "Create tracking branch?" ) {|q| q.default(true) }
					tracking_branch = "origin/%s" % [ git.current_branch ]
					git.cmd( 'branch', '-u', tracking_branch )
				end
			end

			git.push( 'origin', git.current_branch, tags: true )
			self.prompt.ok "Done."
		else
			abort
		end
	else
		trace "Skipping push: No 'default' path."
	end
end

#do_git_update(task, args) ⇒ Object

The body of the git:update task.



280
281
282
 
# File 'lib/rake/deveiate/git.rb', line 280

def do_git_update( task, args )
	self.git.pull_update
end

#do_git_update_and_clobber(task, args) ⇒ Object

The body of the git:update_and_clobber task.



286
287
288
 
# File 'lib/rake/deveiate/git.rb', line 286

def do_git_update_and_clobber( task, args )
	self.git.update( clean: true )
end

#do_git_update_history(task, args) ⇒ Object

Generate a new history file entry for the current version.



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/rake/deveiate/git.rb', line 365

def do_git_update_history( task, args ) # Needs refactoring
	unless self.history_file.readable?
		self.prompt.error "History file is missing or unreadable."
		abort
	end

	version_tag = self.current_git_version_tag
	previous_tag = self.previous_git_version_tag
	self.prompt.say "Updating history for %s..." % [ version_tag ]

	if self.get_history_file_versions.include?( version_tag )
		self.trace "History file already includes a section for %s" % [ version_tag ]
		abort
	end

	header, rest = self.history_file.read( encoding: 'utf-8' ).
		split( /(?<=^---)/m, 2 )

	self.trace "Rest is: %p" % [ rest ]
	if !rest || rest.empty?
		self.prompt.warn "History file needs a header with a `---` marker to support updating."
		self.prompt.say "Adding an auto-generated one."
		rest = header
		header = self.load_and_render_template( 'History.erb', self.history_file )
	end

	header_char = self.header_char_for( self.history_file )
	ext = self.history_file.extname
	log_entries = if previous_tag
			self.git.log.between( previous_tag, 'HEAD' )
		else
			self.git.log
		end

	Tempfile.create( ['History', ext], encoding: 'utf-8' ) do |tmp_copy|
		tmp_copy.print( header )
		tmp_copy.puts

		tmp_copy.puts "%s %s [%s] %s" % [
			header_char * 2,
			version_tag,
			Date.today.strftime( '%Y-%m-%d' ),
			self.authors.first,
		]

		tmp_copy.puts
		log_entries.each do |entry|
			tmp_copy.puts "- %s" % [ entry.message ]
		end
		tmp_copy.puts
		tmp_copy.puts

		tmp_copy.print( rest )
		tmp_copy.close

		TTY::Editor.open( tmp_copy.path )

		if File.size?( tmp_copy.path )
			cp( tmp_copy.path, self.history_file )
		else
			self.prompt.error "Empty file: aborting."
		end
	end

end

#edit_git_commit_log(logfile) ⇒ Object

Generate a commit log and invoke the user’s editor on it.



529
530
531
532
533
 
# File 'lib/rake/deveiate/git.rb', line 529

def edit_git_commit_log( logfile )
	diff = self.git.diff

	TTY::Editor.open( logfile, text: diff )
end

#get_git_unhistoried_version_tags(include_current_version: true) ⇒ Object

Read the list of tags and return any that don’t have a corresponding section in the history file.



516
517
518
519
520
521
522
523
524
525
 
# File 'lib/rake/deveiate/git.rb', line 516

def get_git_unhistoried_version_tags( include_current_version: true )
	release_tags = self.get_git_version_tag_names
	release_tags.unshift( self.current_git_version_tag ) if include_current_version

	self.get_history_file_versions.each do |tag|
		release_tags.delete( tag )
	end

	return release_tags
end

#get_git_version_tag_names ⇒ Object

Fetch the list of names of tags that match the versioning scheme of this project.



508
509
510
511
 
# File 'lib/rake/deveiate/git.rb', line 508

def get_git_version_tag_names
	tag_pattern = /#{self.release_tag_pattern}$/
	return self.git.tags.map( &:name ).grep( tag_pattern )
end

#git ⇒ Object

Return a Git::Repo for the directory rake was invoked in, creating it if necessary.



470
471
472
 
# File 'lib/rake/deveiate/git.rb', line 470

def git
	@git ||= Git.open( Rake::DevEiate::PROJECT_DIR )
end

#git_ignore_files(*pathnames) ⇒ Object

Add the list of pathnames to the .gitignore list.



537
538
539
540
541
542
543
 
# File 'lib/rake/deveiate/git.rb', line 537

def git_ignore_files( *pathnames )
	self.trace "Ignoring %d files." % [ pathnames.length ]

	IGNORE_FILE.open( File::CREAT|File::WRONLY|File::APPEND, 0644 ) do |fh|
		fh.puts( pathnames )
	end
end

#is_git_working_copy? ⇒ Boolean

Returns true if the current directory looks like a Git working copy.

Returns:

  • (Boolean) 


159
160
161
 
# File 'lib/rake/deveiate/git.rb', line 159

def is_git_working_copy?
	return File.directory?( '.git' )
end

#previous_git_version_tag ⇒ Object

Fetch the name of the tag for the previous version.



501
502
503
 
# File 'lib/rake/deveiate/git.rb', line 501

def previous_git_version_tag
	return self.get_git_version_tag_names.first
end

#show_git_file_statuses(statuses) ⇒ Object

Given a status_hash like that returned by Git::Repo.status, return a string description of the files and their status.



477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
 
# File 'lib/rake/deveiate/git.rb', line 477

def show_git_file_statuses( statuses )
	entries = statuses.select( &:type ) + statuses.untracked.values

	lines = entries.map do |entry|
		status = entry.type || '?'
		status_color = STATUS_COLORS[ status ]
		"	%s: %s" % [
			self.pastel.bold.white( entry.path.to_s ),
			self.pastel.decorate( STATUS_DESCRIPTIONS[status], *status_color ),
		]
	end

	self.prompt.say( self.pastel.headline "Uncommitted files:" )
	self.prompt.say( lines.join("\n") )
end