rake-deveiate 0.15.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c2bb0778d27418700022a963c18f81a16cae82f69e09688fd2a8e13b6096eb4
-  data.tar.gz: 31304d8589879cf4d72125462820ae71409628381e8728a3d21ef96039797cdb
+  metadata.gz: 15de23bdc94b63e1920bf2204867e308c43bb2dca45180adda2bda900bc4999c
+  data.tar.gz: f2e0237372b484d97e74e4c37bc9f73bc31c5970d12e270f7854eadb20e56bfd
 SHA512:
-  metadata.gz: da94940cf35b7adc4a51f42aa42f6768fb2665d56d364fea128a1f5a2430f166e44a5ecb4c39559f70029dacb3c3f488cf7197f48158e7a2becceb0c485f9f4d
-  data.tar.gz: 9cad415102523353cefbb8539d20e6919b9816216cbf6ba8744ee8c3d9a21414ce94b68f888e6c700798d48e313a3e65df52627aebb4bcd87ee8a1d5d14d75d9
+  metadata.gz: f30928f9d73561ec1d761539a19c3841d7e197663757113a4b8e67222a5e8df2ec7a56cd6aad1670e05bde1c448e944efe61cdd137eff4715f370d5c707458ef
+  data.tar.gz: 5ddc4f21e660442837a4029e538b840b0c58c9373e4eac0f833398b784835651845fd4b4a7db009e65e2fdd38134510204d55fbdd7ccc62d17ed30e23d875e5f

data/History.md

@@ -1,6 +1,42 @@
 # Release History for rake-deveiate
 
 ---
+
+## v0.17.0 [2020-12-28] Michael Granger <ged@FaerieMUD.org>
+
+Improvements:
+
+- Allow multi-level extension directory structure.
+
+
+## v0.16.2 [2020-11-23] Michael Granger <ged@FaerieMUD.org>
+
+Bugfixes:
+
+- Include another missing file.
+
+
+## v0.16.1 [2020-11-23] Michael Granger <ged@FaerieMUD.org>
+
+Bugfixes:
+
+- Include missing `git` tasklib.
+
+
+## v0.16.0 [2020-11-23] Michael Granger <ged@FaerieMUD.org>
+
+Improvements:
+
+- Add support for projects managed with Git.
+
+
+## v0.15.1 [2020-10-29] Michael Granger <ged@FaerieMUD.org>
+
+Bugfixes:
+
+- Add the extension tasks file to the gem.
+
+
 ## v0.15.0 [2020-10-29] Michael Granger <ged@FaerieMUD.org>
 
 Improvements:

data/lib/rake/deveiate.rb

@@ -35,7 +35,7 @@ class Rake::DevEiate < Rake::TaskLib
 	VERSION_PATTERN = /VERSION\s*=\s*(?<quote>['"])(?<version>\d+(\.\d+){2}.*)\k<quote>/
 
 	# The version of this library
-	VERSION = '0.15.0'
+	VERSION = '0.17.0'
 
 	# The server to release to by default
 	DEFAULT_GEMSERVER = 'https://rubygems.org/'
@@ -46,6 +46,9 @@ class Rake::DevEiate < Rake::TaskLib
 	# The version to use if one cannot be read from the source
 	DEFAULT_VERSION = '0.1.0'
 
+	# The prefix to use for release version tags by default
+	DEFAULT_RELEASE_TAG_PREFIX = 'v'
+
 	# Words in the package/gem name that should not be included in deriving paths,
 	# file names, etc.
 	PACKAGE_IGNORE_WORDS = %w[ruby]
@@ -158,6 +161,7 @@ class Rake::DevEiate < Rake::TaskLib
 		@licenses      = [ DEFAULT_LICENSE ]
 		@version_from  = env( :version_from, as_pathname: true ) ||
 			LIB_DIR + "%s.rb" % [ version_file_from(name) ]
+		@release_tag_prefix = DEFAULT_RELEASE_TAG_PREFIX
 
 		@docs_dir      = DOCS_DIR.dup
 
@@ -289,6 +293,10 @@ class Rake::DevEiate < Rake::TaskLib
 	# The version of Ruby required by this gem, in Gem version format.
 	attr_accessor :required_ruby_version
 
+	##
+	# The prefix to use for version tags
+	attr_accessor :release_tag_prefix
+
 
 	#
 	# Task definition
@@ -372,6 +380,11 @@ class Rake::DevEiate < Rake::TaskLib
 			self.install_dependencies
 		end
 
+		desc "Turn on maintainer mode: build with extra warnings and debugging"
+		task :maint do
+			ENV['MAINTAINER_MODE'] = 'yes'
+		end
+
 	end
 
 
@@ -532,6 +545,24 @@ class Rake::DevEiate < Rake::TaskLib
 	end
 
 
+	### Return a Regexp that matches the project's convention for versions.
+	def release_tag_pattern
+		prefix = self.release_tag_prefix
+		return /#{prefix}\d+(\.\d+)+/
+	end
+
+
+	### Fetch the list of the versions of releases that have entries in the history
+	### file.
+	def get_history_file_versions
+		tag_pattern = self.release_tag_pattern
+
+		return IO.readlines( self.history_file ).grep( tag_pattern ).map do |line|
+			line[ /^(?:h\d\.|#+|=+)\s+(#{tag_pattern})\s+/, 1 ]
+		end.compact
+	end
+
+
 	### Returns +true+ if the manifest file exists and is readable.
 	def has_manifest?
 		return self.manifest_file.readable?
@@ -665,6 +696,7 @@ class Rake::DevEiate < Rake::TaskLib
 
 	### Install the gems listed in the gem dependencies file.
 	def install_dependencies
+		self.prompt.say "Installing dependencies"
 		ruby '-S', 'gem', 'i', '-Ng'
 	end
 
@@ -744,9 +776,9 @@ class Rake::DevEiate < Rake::TaskLib
 		self.prompt.say( "Summary: " )
 		self.prompt.say( summary, color: :bold )
 		self.prompt.say( "Description:" )
-		self.prompt.say( description, color: :bold )
+		self.prompt.say( "   " + description, color: :bold )
 		self.prompt.say( "Homepage:" )
-		self.prompt.say( homepage, color: :bold )
+		self.prompt.say( "   " + homepage, color: :bold )
 		self.prompt.say( "\n" )
 	end
 
@@ -824,4 +856,29 @@ class Rake::DevEiate < Rake::TaskLib
 			join( '/' )
 	end
 
+
+	### Delete the files in the given +filelist+ after confirming with the user.
+	def delete_extra_files( *filelist )
+		description = humanize_file_list( filelist, '	 ' )
+		self.prompt.say "Files to delete:"
+		self.prompt.say( description )
+
+		if self.prompt.yes?( "Really delete them?" ) {|q| q.default(false) }
+			filelist.each do |f|
+				rm_rf( f, verbose: true )
+			end
+		end
+	end
+
+
+	### Returns a human-scannable file list by joining and truncating the list if it's too long.
+	def humanize_file_list( list, indent=FILE_INDENT )
+		listtext = list[0..5].join( "\n#{indent}" )
+		if list.length > 5
+			listtext << " (and %d other/s)" % [ list.length - 5 ]
+		end
+
+		return listtext
+	end
+
 end # class Rake::DevEiate

data/lib/rake/deveiate/extensions.rb

@@ -0,0 +1,119 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+require 'pathname'
+require 'rake'
+
+require 'rake/deveiate' unless defined?( Rake::DevEiate )
+
+
+# Extension compilation and maintenance tasks
+module Rake::DevEiate::Extension
+	extend Rake::DSL
+
+	# The glob pattern to use when looking for extension config scripts (relative to
+	# EXT_DIR).
+	EXTENSION_GLOB_PATTERN = '**/extconf.rb'
+
+
+	### Set some defaults when the task lib is set up.
+	def setup( _name, **options )
+		super if defined?( super )
+
+		self.extensions.include( Rake::DevEiate::EXT_DIR + EXTENSION_GLOB_PATTERN )
+		@disable_rake_compiler = false
+	end
+
+
+	##
+	# Set to +true+ to indicate that this project provides its own
+	# extension-management tasks.
+	attr_accessor :disable_rake_compiler
+
+
+	### Predicate for the #disable_rake_compiler attribute.
+	def disable_rake_compiler?
+		return self.disable_rake_compiler ? true :false
+	end
+
+
+	### Returns +true+ if there appear to be extensions as part of the current
+	### project.
+	def extensions_present?
+		return !self.extensions.empty?
+	end
+
+
+	### Define extension tasks
+	def define_tasks
+		super if defined?( super )
+
+		if self.extensions_present?
+			if self.has_rakecompiler_dependency?
+				self.define_extension_tasks
+			elsif !self.disable_rake_compiler?
+				warn <<~END_WARNING
+
+					You appear to have one or more extensions, but rake-compiler
+					is not a dependency. You should either add it to gem.deps.rb
+					or set `disable_rake_compiler` on the project to disable this
+					warning.
+
+				END_WARNING
+			end
+		end
+
+		task( :extensions_debug, &method(:do_extensions_debug) )
+		task :debug => :extensions_debug
+	end
+
+
+	### Set up the tasks to build extensions.
+	def define_extension_tasks
+		ENV['RUBY_CC_VERSION'] ||= RUBY_VERSION[ /(\d+\.\d+)/ ]
+
+		require 'rake/extensiontask'
+		self.extensions.each do |extconf|
+			Rake::ExtensionTask.new( extconf.pathmap('%{ext,}d') )
+		end
+
+		task :spec => :compile
+
+		task :maint do
+			ENV['V'] = 1
+		end
+	end
+
+
+	### Returns +true+ if the projects dependencies include `rake-compiler`.
+	def has_rakecompiler_dependency?
+		return self.dependencies.any? do |dep|
+			dep.name == 'rake-compiler'
+		end
+	end
+
+
+	### Task function -- output debugging for extension tasks.
+	def do_extensions_debug( task, args )
+		self.prompt.say( "Extension config scripts:", color: :bright_green )
+
+		if self.extensions.empty?
+			self.prompt.say "None."
+		else
+			self.extensions.uniq.each do |path|
+				self.prompt.say "- %s" % [ path ]
+			end
+		end
+
+		if self.has_rakecompiler_dependency?
+			self.prompt.say "\n"
+			self.prompt.say "✔ has rake-compiler dependency"
+		end
+
+		self.prompt.say( "\n" )
+	end
+
+
+end # module Rake::DevEiate::Extensions
+
+

data/lib/rake/deveiate/gemspec.rb

@@ -204,6 +204,10 @@ module Rake::DevEiate::Gemspec
 				bt_uri = source_uri.dup
 				bt_uri.host = 'todo.sr.ht'
 				metadata['bug_tracker_uri'] = bt_uri.to_s
+			when /\.gitlab\.com/
+				bt_uri = source_uri.dup
+				bt_uri.path += '-/issues'
+				metadata['bug_tracker_uri'] = bt_uri.to_s
 			else
 				self.trace "No idea what bug tracker URIs for %s look like!" % [ source_uri.host ]
 			end

data/lib/rake/deveiate/generate.rb

@@ -54,11 +54,23 @@ module Rake::DevEiate::Generate
 
 		# Abstract named tasks; mostly for invoking programmatically
 		namespace :generate do
+
+			desc "Generate a Rakefile"
 			task :rakefile => self.rakefile
+
+			desc "Generate a %s file" % [ self.readme_file ]
 			task :readme => self.readme_file
+
+			desc "Generate a %s file" % [ self.history_file ]
 			task :history_file => self.history_file
+
+			desc "Generate a %s file" % [ self.manifest_file ]
 			task :manifest => self.manifest_file
+
+			desc "Generate a %s file" % [ RUBY_VERSION_FILE ]
 			task :ruby_version_file => RUBY_VERSION_FILE
+
+			desc "Generate a %s file" % [ GEMSET_FILE ]
 			task :gemset_file => GEMSET_FILE
 		end
 

data/lib/rake/deveiate/git-refinements.rb

@@ -0,0 +1,28 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+require 'git'
+
+require 'rake/deveiate' unless defined?( Rake::DevEiate )
+
+
+# Monkeypatches to allow command options the `git` gem doesn't allow.
+#
+# Refs:
+# - https://github.com/ruby-git/ruby-git/issues/394
+module Rake::DevEiate::GitRefinements
+
+	refine Git::Base do
+		def cmd( cmd )
+			self.lib.cmd( cmd )
+		end
+	end
+
+	refine Git::Lib do
+		def cmd( cmd )
+			command( cmd )
+		end
+	end
+
+end # module GitRefinements
+

data/lib/rake/deveiate/git.rb

@@ -0,0 +1,524 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+require 'tempfile'
+require 'shellwords'
+require 'git'
+require 'tty/editor'
+
+require 'rake/deveiate' unless defined?( Rake::DevEiate )
+require 'rake/deveiate/git-refinements'
+
+using Rake::DevEiate::GitRefinements
+
+
+# Git version-control tasks
+module Rake::DevEiate::Git
+
+	# The name of the file to edit for the commit message
+	COMMIT_MSG_FILE = Pathname( 'commit-msg.txt' )
+
+	# The name of the ignore file
+	IGNORE_FILE = Rake::DevEiate::PROJECT_DIR + '.gitignore'
+
+	# Colors for presenting file statuses
+	STATUS_COLORS = {
+		'M' => [:blue],                  # modified
+		'A' => [:bold, :green],          # added
+		'R' => [:bold, :black],          # removed
+		'C' => [:white],                 # clean
+		'!' => [:bold, :white, :on_red], # missing
+		'?' => [:yellow],                # not tracked
+		'I' => [:dim, :white],           # ignored
+	}
+
+	# File indentation
+	FILE_INDENT = " • "
+
+
+	### Define version-control tasks
+	def define_tasks
+		super if defined?( super )
+
+		return unless self.is_git_working_copy?
+
+		# :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.message ]
+		raise
+	end
+
+
+	### Returns +true+ if the current directory looks like a Git working copy.
+	def is_git_working_copy?
+		return File.directory?( '.git' )
+	end
+
+
+	### The body of the git:prerelease task.
+	def do_git_prerelease( task, args )
+		uncommitted_files = self.git.status( n: true )
+		unless uncommitted_files.empty?
+			self.show_git_file_statuses( uncommitted_files )
+
+			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.identity.id
+
+		# 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.tag( pkg_version_tag, rev: rev )
+
+		# Sign the tag
+		if self.git.extension_enabled?( :gpg )
+			if self.prompt.yes?( "Sign %s?" % [pkg_version_tag] )
+				self.git.sign( pkg_version_tag, message: "Signing %s" % [pkg_version_tag] )
+			end
+		end
+	end
+
+
+	### The body of the git:postrelease task.
+	def do_git_postrelease( task, args )
+		if self.git.status( 'checksum', unknown: true ).any?
+			self.prompt.say "Adding release artifacts..."
+			self.git.add( 'checksum' )
+			self.git.commit( 'checksum', message: "Adding release checksum." )
+		end
+
+		if self.prompt.yes?( "Move released changesets to public phase?" )
+			self.prompt.say "Publicising changesets..."
+			self.git.phase( public: true )
+		end
+
+		if self.git.extension_enabled?( :topic )
+			current_topic = self.git.topic
+			if current_topic && self.prompt.yes?( "Clear the current topic (%s)?" %[current_topic] )
+				self.git.topic( clear: true )
+			end
+		end
+
+		Rake::Task['git:push'].invoke
+	end
+
+
+	### The body of the git:newfiles task.
+	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
+
+
+	### The body of the git:pull task.
+	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
+
+
+	### The body of the git:pull_without_confirmation task.
+	def do_git_pull_without_confirmation( task, args )
+		self.git.pull
+	end
+
+
+	### The body of the git:update task.
+	def do_git_update( task, args )
+		self.git.pull_update
+	end
+
+
+	### The body of the git:update_and_clobber task.
+	def do_git_update_and_clobber( task, args )
+		self.git.update( clean: true )
+	end
+
+
+	### The body of the checkin task.
+	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
+
+
+	### The body of the push task.
+	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 )
+				self.prompt.ok "Done."
+			else
+				abort
+			end
+		else
+			trace "Skipping push: No 'default' path."
+		end
+	end
+
+
+	### Check the history file against the list of release tags in the working copy
+	### and ensure there's an entry for each tag.
+	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
+
+
+	### Check the status of the repo and ensure there are outstanding changes. If there
+	### are no changes, abort.
+	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
+
+
+	### Generate a new history file entry for the current version.
+	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( rev: "#{previous_tag}~-2::" )
+			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
+
+
+	### Show debugging information.
+	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
+
+	#
+	# utility methods
+	#
+
+	### Return a Git::Repo for the directory rake was invoked in, creating it if
+	### necessary.
+	def git
+		@git ||= Git.open( Rake::DevEiate::PROJECT_DIR )
+	end
+
+
+	### Given a +status_hash+ like that returned by Git::Repo.status, return a
+	### string description of the files and their status.
+	def show_git_file_statuses( statuses )
+		lines = statuses.map do |entry|
+			status_color = STATUS_COLORS[ entry.status ]
+			"	%s: %s" % [
+				self.pastel.white( entry.path.to_s ),
+				self.pastel.decorate( entry.status_description, *status_color ),
+			]
+		end
+
+		self.prompt.say( self.pastel.headline "Uncommitted files:" )
+		self.prompt.say( lines.join("\n") )
+	end
+
+
+	### Fetch the name of the current version's tag.
+	def current_git_version_tag
+		return [ self.release_tag_prefix, self.version ].join
+	end
+
+
+	### Fetch the name of the tag for the previous version.
+	def previous_git_version_tag
+		return self.get_git_version_tag_names.first
+	end
+
+
+	### Fetch the list of names of tags that match the versioning scheme of this
+	### project.
+	def get_git_version_tag_names
+		tag_pattern = self.release_tag_pattern
+		return self.git.tags.map( &:name ).grep( tag_pattern )
+	end
+
+
+	### Read the list of tags and return any that don't have a corresponding section
+	### in the history file.
+	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
+
+
+	### Generate a commit log and invoke the user's editor on it.
+	def edit_git_commit_log( logfile )
+		diff = self.git.diff
+
+		TTY::Editor.open( logfile, text: diff )
+	end
+
+
+	### Add the list of +pathnames+ to the .gitignore list.
+	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
+
+end # module Rake::DevEiate::Git
+
+

data/lib/rake/deveiate/hg.rb

@@ -9,7 +9,7 @@ require 'tty/editor'
 require 'rake/deveiate' unless defined?( Rake::DevEiate )
 
 
-# Version-control tasks
+# Mercurial version-control tasks
 module Rake::DevEiate::Hg
 
 	# The name of the file to edit for the commit message
@@ -18,9 +18,6 @@ module Rake::DevEiate::Hg
 	# The name of the ignore file
 	IGNORE_FILE = Rake::DevEiate::PROJECT_DIR + '.hgignore'
 
-	# The prefix to use for release version tags by default
-	DEFAULT_RELEASE_TAG_PREFIX = 'v'
-
 	# Colors for presenting file statuses
 	STATUS_COLORS = {
 		'M' => [:blue],                  # modified
@@ -36,29 +33,16 @@ module Rake::DevEiate::Hg
 	FILE_INDENT = " • "
 
 
-	### Set up defaults
-	def setup( _name, **options )
-		super if defined?( super )
-
-		@release_tag_prefix = options[:release_tag_prefix] || DEFAULT_RELEASE_TAG_PREFIX
-	end
-
-
-	##
-	# The prefix to use for version tags
-	attr_accessor :release_tag_prefix
-
-
 	### Define version-control tasks
 	def define_tasks
 		super if defined?( super )
 
-		return unless File.directory?( '.hg' )
+		return unless self.is_hg_working_copy?
 
 		file COMMIT_MSG_FILE.to_s do |task|
 			commit_log = Pathname( task.name )
 
-			edit_commit_log( commit_log )
+			hg_edit_commit_log( commit_log )
 			unless commit_log.size?
 				self.prompt.error "Empty commit message; aborting."
 				commit_log.unlink if commit_log.exist?
@@ -137,11 +121,17 @@ module Rake::DevEiate::Hg
 	end
 
 
+	### Returns +true+ if the current directory looks like a Mercurial working copy.
+	def is_hg_working_copy?
+		return File.directory?( '.hg' )
+	end
+
+
 	### The body of the hg:prerelease task.
 	def do_hg_prerelease( task, args )
 		uncommitted_files = self.hg.status( n: true )
 		unless uncommitted_files.empty?
-			self.show_file_statuses( uncommitted_files )
+			self.show_hg_file_statuses( uncommitted_files )
 
 			fail unless self.prompt.yes?( "Release anyway?" ) do |q|
 				q.default( false )
@@ -150,7 +140,7 @@ module Rake::DevEiate::Hg
 			self.prompt.warn "Okay, releasing with uncommitted versions."
 		end
 
-		pkg_version_tag = self.current_version_tag
+		pkg_version_tag = self.current_hg_version_tag
 		rev = self.hg.identity.id
 
 		# Look for a tag for the current release version, and if it exists abort
@@ -316,7 +306,7 @@ module Rake::DevEiate::Hg
 		end
 
 		self.prompt.say "Checking history..."
-		missing_tags = self.get_unhistoried_version_tags
+		missing_tags = self.get_hg_unhistoried_version_tags
 
 		unless missing_tags.empty?
 			self.prompt.error "%s needs updating; missing entries for tags: %s" %
@@ -343,8 +333,8 @@ module Rake::DevEiate::Hg
 			abort
 		end
 
-		version_tag = self.current_version_tag
-		previous_tag = self.previous_version_tag
+		version_tag = self.current_hg_version_tag
+		previous_tag = self.previous_hg_version_tag
 		self.prompt.say "Updating history for %s..." % [ version_tag ]
 
 		if self.get_history_file_versions.include?( version_tag )
@@ -408,27 +398,31 @@ module Rake::DevEiate::Hg
 	def do_hg_debug( task, args )
 		self.prompt.say( "Hg Info", color: :bright_green )
 
-		self.prompt.say( "Mercurial version: " )
-		self.prompt.say( Hglib.version, color: :bold )
-		self.prompt.say( "Release tag prefix: " )
-		self.prompt.say( self.release_tag_prefix, color: :bold )
+		if self.is_hg_working_copy?
+			self.prompt.say( "Mercurial version: " )
+			self.prompt.say( Hglib.version, color: :bold )
+			self.prompt.say( "Release tag prefix: " )
+			self.prompt.say( self.release_tag_prefix, color: :bold )
 
-		self.prompt.say( "Version tags:" )
-		self.get_version_tag_names.each do |tag|
-			self.prompt.say( '- ' )
-			self.prompt.say( tag, color: :bold )
-		end
+			self.prompt.say( "Version tags:" )
+			self.get_hg_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( "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_unhistoried_version_tags.each do |tag|
-			self.prompt.say( '- ' )
-			self.prompt.say( tag, color: :bold )
+			self.prompt.say( "Unhistoried version tags:" )
+			self.get_hg_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 Mercurial repository." )
 		end
 
 		self.prompt.say( "\n" )
@@ -447,7 +441,7 @@ module Rake::DevEiate::Hg
 
 	### Given a +status_hash+ like that returned by Hglib::Repo.status, return a
 	### string description of the files and their status.
-	def show_file_statuses( statuses )
+	def show_hg_file_statuses( statuses )
 		lines = statuses.map do |entry|
 			status_color = STATUS_COLORS[ entry.status ]
 			"	%s: %s" % [
@@ -462,48 +456,30 @@ module Rake::DevEiate::Hg
 
 
 	### Fetch the name of the current version's tag.
-	def current_version_tag
+	def current_hg_version_tag
 		return [ self.release_tag_prefix, self.version ].join
 	end
 
 
 	### Fetch the name of the tag for the previous version.
-	def previous_version_tag
-		return self.get_version_tag_names.first
-	end
-
-
-	### Return a Regexp that matches the project's convention for versions.
-	def release_tag_pattern
-		prefix = self.release_tag_prefix
-		return /#{prefix}\d+(\.\d+)+/
+	def previous_hg_version_tag
+		return self.get_hg_version_tag_names.first
 	end
 
 
 	### Fetch the list of names of tags that match the versioning scheme of this
 	### project.
-	def get_version_tag_names
+	def get_hg_version_tag_names
 		tag_pattern = self.release_tag_pattern
 		return self.hg.tags.map( &:name ).grep( tag_pattern )
 	end
 
 
-	### Fetch the list of the versions of releases that have entries in the history
-	### file.
-	def get_history_file_versions
-		tag_pattern = self.release_tag_pattern
-
-		return IO.readlines( self.history_file ).grep( tag_pattern ).map do |line|
-			line[ /^(?:h\d\.|#+|=+)\s+(#{tag_pattern})\s+/, 1 ]
-		end.compact
-	end
-
-
 	### Read the list of tags and return any that don't have a corresponding section
 	### in the history file.
-	def get_unhistoried_version_tags( include_current_version: true )
-		release_tags = self.get_version_tag_names
-		release_tags.unshift( self.current_version_tag ) if include_current_version
+	def get_hg_unhistoried_version_tags( include_current_version: true )
+		release_tags = self.get_hg_version_tag_names
+		release_tags.unshift( self.current_hg_version_tag ) if include_current_version
 
 		self.get_history_file_versions.each do |tag|
 			release_tags.delete( tag )
@@ -514,7 +490,7 @@ module Rake::DevEiate::Hg
 
 
 	### Generate a commit log and invoke the user's editor on it.
-	def edit_commit_log( logfile )
+	def hg_edit_commit_log( logfile )
 		diff = self.hg.diff
 
 		TTY::Editor.open( logfile, text: diff )
@@ -533,32 +509,6 @@ module Rake::DevEiate::Hg
 		end
 	end
 
-
-	### Delete the files in the given +filelist+ after confirming with the user.
-	def delete_extra_files( *filelist )
-		description = humanize_file_list( filelist, '	 ' )
-		self.prompt.say "Files to delete:"
-		self.prompt.say( description )
-
-		if self.prompt.yes?( "Really delete them?" ) {|q| q.default(false) }
-			filelist.each do |f|
-				rm_rf( f, verbose: true )
-			end
-		end
-	end
-
-
-	### Returns a human-scannable file list by joining and truncating the list if it's too long.
-	def humanize_file_list( list, indent=FILE_INDENT )
-		listtext = list[0..5].join( "\n#{indent}" )
-		if list.length > 5
-			listtext << " (and %d other/s)" % [ list.length - 5 ]
-		end
-
-		return listtext
-	end
-
-
 end # module Rake::DevEiate::Hg
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rake-deveiate
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Michael Granger
@@ -10,9 +10,9 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIID+DCCAmCgAwIBAgIBAjANBgkqhkiG9w0BAQsFADAiMSAwHgYDVQQDDBdnZWQv
-  REM9RmFlcmllTVVEL0RDPW9yZzAeFw0xOTEyMjQyMDE5NTFaFw0yMDEyMjMyMDE5
-  NTFaMCIxIDAeBgNVBAMMF2dlZC9EQz1GYWVyaWVNVUQvREM9b3JnMIIBojANBgkq
+  MIID+DCCAmCgAwIBAgIBAzANBgkqhkiG9w0BAQsFADAiMSAwHgYDVQQDDBdnZWQv
+  REM9RmFlcmllTVVEL0RDPW9yZzAeFw0yMDEyMjQyMDU1MjlaFw0yMTEyMjQyMDU1
+  MjlaMCIxIDAeBgNVBAMMF2dlZC9EQz1GYWVyaWVNVUQvREM9b3JnMIIBojANBgkq
   hkiG9w0BAQEFAAOCAY8AMIIBigKCAYEAvyVhkRzvlEs0fe7145BYLfN6njX9ih5H
   L60U0p0euIurpv84op9CNKF9tx+1WKwyQvQP7qFGuZxkSUuWcP/sFhDXL1lWUuIl
   M4uHbGCRmOshDrF4dgnBeOvkHr1fIhPlJm5FO+Vew8tSQmlDsosxLUx+VB7DrVFO
@@ -23,17 +23,17 @@ cert_chain:
   ozilJg4aar2okb/RA6VS87o+d7g6LpDDMMQjH4G9OPnJENLdhu8KnPw/ivSVvQw7
   N2I4L/ZOIe2DIVuYH7aLHfjZDQv/mNgpAgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYD
   VR0PBAQDAgSwMB0GA1UdDgQWBBRyjf55EbrHagiRLqt5YAd3yb8k4DANBgkqhkiG
-  9w0BAQsFAAOCAYEAifxlz7x0EfT3fjhM520ZEIrWa+tLMuLKNefkY18u8tZnx4EX
-  Xxwh3tna3fvNfrOrdY5leIj1dbv4FTRg+gIBnIxAySqvpGvI/Axg5EdYbwninCLL
-  LAKCmRo+5QwaPMYN2zdHIjGrp8jg1neCo5zy6tVvyTv0DMI6FLrydVJYduMMDFSy
-  gQKR1rVOcCJtnBnLCF9+kKEUKohAHOmGsE7OBZFnjMIpH5yUDUVJKByv0gIipFt0
-  1T6zff6oVU0w8WBiNKR381+6sF3wIZVnVY0XeJg6hNL+YecE8ILxLhHTmtT/BO0S
-  3xPze9uXDR+iD6HYl8KU5QEg/dXFPhfQb512vVkTJDZvMcwu6PxDUjHFChLjAji/
-  AZXjg1C5E9znTkeUR8ieU9F1MOKoiH57a5lYSTI8Ga8PpsNXTxNeXc16Ob26CqrJ
-  83uuAYSy65yXDGXXPVBeKPVnYrqp91pqpS5Nh7wfuiCrE8lgU8PATh7K4BV1UhAT
-  0MHbAT42wTYkfUj3
+  9w0BAQsFAAOCAYEAMYegZanJi8zq7QKPT7wqXefX4C88I5JWeBHR3PvvWK0CwyMV
+  peyiu5I13w/lYX+HUZjE4qsSpJMJFXWl4WZCOo+AMprOcf0PxfuJpxCej5D4tavf
+  vRfhahSw7XJrcZih/3J+/UgoH7R05MJ+8LTcy3HGrB3a0vTafjm8OY7Xpa0LJDoN
+  JDqxK321VIHyTibbKeA1hWSE6ljlQDvFbTqiCj3Ulp1jTv3TOlvRl8fqcfhxUJI0
+  +5Q82jJODjEN+GaWs0V+NlrbU94cXwS2PH5dXogftB5YYA5Ex8A0ikZ73xns4Hdo
+  XxdLdd92F5ovxA23j/rKe/IDwqr6FpDkU3nPXH/Qp0TVGv9zZnVJc/Z6ChkuWj8z
+  pW7JAyyiiHZgKKDReDrA2LA7Zs3o/7KA6UtUH0FHf8LYhcK+pfHk6RtjRe65ffw+
+  MCh97sQ/Z/MOusb5+QddBmB+k8EicXyGNl4b5L4XpL7fIQu+Y96TB3JEJlShxFD9
+  k9FjI4d9EP54gS/4
   -----END CERTIFICATE-----
-date: 2020-10-29 00:00:00.000000000 Z
+date: 2020-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -167,6 +167,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rdoc-generator-fivefish
   requirement: !ruby/object:Gem::Requirement
@@ -200,10 +214,13 @@ files:
 - lib/rake/deveiate.rb
 - lib/rake/deveiate/checks.rb
 - lib/rake/deveiate/docs.rb
+- lib/rake/deveiate/extensions.rb
 - lib/rake/deveiate/fixup.rb
 - lib/rake/deveiate/gem_dep_finder.rb
 - lib/rake/deveiate/gemspec.rb
 - lib/rake/deveiate/generate.rb
+- lib/rake/deveiate/git-refinements.rb
+- lib/rake/deveiate/git.rb
 - lib/rake/deveiate/hg.rb
 - lib/rake/deveiate/packaging.rb
 - lib/rake/deveiate/releases.rb
@@ -232,7 +249,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: This is a collection of Rake tasks I use for development.