rake-deveiate 0.15.1 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fd5ebf2ecae73378b090addfcda377b8f6eaa034d4c7a3ad39de0649701c5fe
-  data.tar.gz: 22b38e5878db4fd78e4cbc5a0bcbff0813812d4a57ed236fbaf00ae60d1c9794
+  metadata.gz: 6294dfb27450c830428cd59e747a2039b33691e2092a2a70470370612347297f
+  data.tar.gz: fba0f6a23e4cd52de453bfb7d1441b873afe3a340cd0f137edf0621aeece57a4
 SHA512:
-  metadata.gz: 715be431cafef4db394efc1740b35bbb61d8df3f53b850837a66d82ca9d2cb0095bf2c88ad8b93316600ca00b6769060b9cf7b635ee032896bac48709935e0b1
-  data.tar.gz: f172e22901d23884594f6703dec21f3af5976aa67460a9e062323578f5987680e2edbdb196f6d37cc4f227df72552922702cb30737d4f757d79a01241325fe88
+  metadata.gz: 23eea2fb28c372d70bd5456ce7de3fd474e9c5312db520ce9562af3fb35ee377514030acb6728bc3ae6e9376e7ac7fd066c1ea5cec868768102faa64ec5e8710
+  data.tar.gz: 5806ea7d4bc077138b875e64ef4d11ad02d816a81d8e17760ffa4393451d08c2e8b70b3cfa354147dff88f4b20063ff76f673e11749d8fa9c4f2422ca39213e0

data.tar.gz.sig

@@ -1,2 +1,3 @@
-��t~��H��ۻ������ �%��ɕ����%z�r���/����L���5z̟������dZ
-�ҍ'K���/��p�w�l���X��Z#���ɼz��0w�[�����t!Q���l�8#����׼���J
�����F�g�2�{P1�;�G�p�ތęsڹ��5��+�,&�$A���^%[E�m���Lxu9h0�7�Wb;w��x}��Yϐ���Bp��(�(��
+ELA��L�#��	ᬤ�
+:�%&טU�����<~����Y�3�Sd�Ƕ�]7�."��$^	�=r(��< 䏰�[Xo80�r��z����z�5����j����dCs�%����Y�U�C���l>�i ;)c�P�$�ꠣ���2f����W�����c��p��������Z�|��{�?v�t��6�,���h+�Ye�	�%�ê��VnU�>^RaNq�z�&�ܼS/N�:�SK��_�5�<P�h#|�2���ӕ��v�
+�^}0�ѧ��X���Ke�:erL2��)�K��n��9o܅��da��^[��9$lV= ���4��5#�����r�ޥ���p/��'H��fx1�5���H�o�C��@.�ئ�3��

data/History.md

@@ -1,6 +1,14 @@
 # Release History for rake-deveiate
 
 ---
+
+## 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:

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.1'
+	VERSION = '0.16.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

@@ -78,6 +78,10 @@ module Rake::DevEiate::Extension
 		end
 
 		task :spec => :compile
+
+		task :maint do
+			ENV['V'] = 1
+		end
 	end
 
 
@@ -89,7 +93,6 @@ module Rake::DevEiate::Extension
 	end
 
 
-
 	### Task function -- output debugging for extension tasks.
 	def do_extensions_debug( task, args )
 		self.prompt.say( "Extension config scripts:", color: :bright_green )

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/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.1
+  version: 0.16.0
 platform: ruby
 authors:
 - Michael Granger
@@ -33,7 +33,7 @@ cert_chain:
   83uuAYSy65yXDGXXPVBeKPVnYrqp91pqpS5Nh7wfuiCrE8lgU8PATh7K4BV1UhAT
   0MHbAT42wTYkfUj3
   -----END CERTIFICATE-----
-date: 2020-10-29 00:00:00.000000000 Z
+date: 2020-11-23 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
@@ -233,7 +247,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: This is a collection of Rake tasks I use for development.