rake-deveiate 0.17.4 → 0.19.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75429da7cdad951ae72e7dcb020a5b7c96dbc0fe61e9c440061e426122081679
-  data.tar.gz: ed1113af4145ba0eec87f020a7db97877e9c119c7a68a682dc574522fdae4e6d
+  metadata.gz: 3900c51a118d3efb1e13225b82f4dbac2ea8792f74d7b8fe32db4aa329011e67
+  data.tar.gz: fe24055a0e3a4d2f08afaf7be993c2754ecd1dd1ce991501e5dcc848ed7c1cfc
 SHA512:
-  metadata.gz: b608212076021421b83d5fb0e13676da66729e8f82aa1885667a42a0a9d60650f1a9e4c24d6ef8438e4a31eb3328742657e32dd901b753609de7b17b2f1f6b5e
-  data.tar.gz: 9e0e5373d7a3cb71601d0f86f3326fca517cc7d9a1bac94180aa451fa6a73d29e2b4cf704d8ecf4e838ed91658987d4dc82b54cfb403441135633dcf04f9631c
+  metadata.gz: d076e4bae89817d35de6a4799bc025f82a937931570c953f17022699e066d0ee202ac605b79a40784195de87e46bbe389c11334efa53942d4c68192064430c69
+  data.tar.gz: 2f176f8e665e5205a36eabaab21557ee6750da8b75b464990ec20db10c9a269748763c39e6f85b6cb1d8a09afcfda5d5fffa03d430c5db7056155953648c31a0

data/History.md

@@ -2,6 +2,41 @@
 
 ---
 
+## v0.19.2 [2021-07-15] Michael Granger <ged@FaerieMUD.org>
+
+Bugfixes:
+
+- Defer gem path until version_from has a chance to be defined
+
+
+
+## v0.19.1 [2021-05-08] Michael Granger <ged@FaerieMUD.org>
+
+Bugfixes:
+
+- Fix version and version_from.
+
+
+## v0.19.0 [2021-03-08] Michael Granger <ged@FaerieMUD.org>
+
+Enhancements:
+
+- Add support for SCP gem pushing.
+
+Bugfixes:
+
+- Push git repos with tags.
+
+
+## v0.18.0 [2021-01-07] Michael Granger <ged@FaerieMUD.org>
+
+Improvements:
+
+- Add gem push key setting
+- Add release branch check
+- Fix a bunch of git functionality
+
+
 ## v0.17.4 [2021-01-02] 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.17.4'
+	VERSION = '0.19.2'
 
 	# The server to release to by default
 	DEFAULT_GEMSERVER = 'https://rubygems.org/'
@@ -106,7 +106,7 @@ class Rake::DevEiate < Rake::TaskLib
 		.svg
 	]
 
-	# The path to the data directory for the Prestigio library.
+	# The path to the data directory
 	DEVEIATE_DATADIR = if ENV['DEVEIATE_DATADIR']
 			Pathname( ENV['DEVEIATE_DATADIR'] )
 		elsif Gem.loaded_specs['rake-deveiate'] &&
@@ -211,11 +211,6 @@ class Rake::DevEiate < Rake::TaskLib
 	# The summary description of the gem.
 	attr_accessor :summary
 
-	##
-	# The Gem::Version of the current library, extracted from the top-level
-	# namespace.
-	attr_reader :version
-
 	##
 	# The README of the project as an RDoc::Markup::Document
 	attr_accessor :readme
@@ -285,6 +280,10 @@ class Rake::DevEiate < Rake::TaskLib
 	# The gemserver to push gems to
 	attr_accessor :allowed_push_host
 
+	##
+	# An alternative key to use for pushing gems (private gemserver)
+	attr_accessor :gem_push_key
+
 	##
 	# The rsync-compatible target to publish documentation to.
 	attr_accessor :publish_to
@@ -297,6 +296,10 @@ class Rake::DevEiate < Rake::TaskLib
 	# The prefix to use for version tags
 	attr_accessor :release_tag_prefix
 
+	##
+	# The name of the branch to release from
+	attr_accessor :release_branch
+
 
 	#
 	# Task definition
@@ -445,7 +448,7 @@ class Rake::DevEiate < Rake::TaskLib
 
 	### Extract a summary from the README if possible. Returns +nil+ if not.
 	def extract_summary
-		return self.description.split( /(?<=\.)\s+/ ).first.gsub( /\n/, ' ' )
+		return self.description.split( /(?<=\.)\s+/ ).first&.gsub( /\n/, ' ' )
 	end
 
 
@@ -474,7 +477,8 @@ class Rake::DevEiate < Rake::TaskLib
 		content = readme.parts.grep_v( RDoc::Markup::BlankLine )
 
 		heading, list = content.each_cons( 2 ).find do |heading, list|
-			heading.is_a?( RDoc::Markup::Heading ) && heading.text =~ /^authors?/i &&
+			heading.is_a?( RDoc::Markup::Heading ) &&
+				heading.text =~ /^(author|maintainer)s?/i &&
 				list.is_a?( RDoc::Markup::List )
 		end
 
@@ -794,6 +798,10 @@ class Rake::DevEiate < Rake::TaskLib
 			self.prompt.say( table.render(:unicode, padding: [0,1]) )
 		end
 		self.prompt.say( "\n" )
+
+		self.prompt.say( "Version from:" )
+		self.prompt.say( "  " + self.version_from.to_s, color: :bold )
+		self.prompt.say( "\n" )
 	end
 
 

data/lib/rake/deveiate/gemspec.rb

@@ -208,6 +208,10 @@ module Rake::DevEiate::Gemspec
 				bt_uri = source_uri.dup
 				bt_uri.path += '-/issues'
 				metadata['bug_tracker_uri'] = bt_uri.to_s
+			when /\.github\.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/git.rb

@@ -13,6 +13,24 @@ using Rake::DevEiate::GitRefinements
 
 
 # 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)
+#
 module Rake::DevEiate::Git
 
 	# The name of the file to edit for the commit message
@@ -25,16 +43,26 @@ module Rake::DevEiate::Git
 	STATUS_COLORS = {
 		'M' => [:blue],                  # modified
 		'A' => [:bold, :green],          # added
-		'R' => [:bold, :black],          # removed
+		'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 indentation
 	FILE_INDENT = " • "
 
+	# The name of the branch releases should be created from
+	DEFAULT_RELEASE_BRANCH = 'master'
+
 
 	### Define version-control tasks
 	def define_tasks
@@ -42,6 +70,8 @@ module Rake::DevEiate::Git
 
 		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 )
@@ -120,7 +150,7 @@ module Rake::DevEiate::Git
 
 		task :debug => 'git:debug'
 	rescue ::Exception => err
-		$stderr.puts "%s while defining Git tasks: %s" % [ err.class.name, err.message ]
+		$stderr.puts "%s while defining Git tasks: %s" % [ err.class.name, err.full_message(order: :bottom) ]
 		raise
 	end
 
@@ -133,9 +163,17 @@ module Rake::DevEiate::Git
 
 	### 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 )
+		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 )
@@ -145,7 +183,7 @@ module Rake::DevEiate::Git
 		end
 
 		pkg_version_tag = self.current_git_version_tag
-		rev = self.git.identity.id
+		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 }
@@ -155,35 +193,17 @@ module Rake::DevEiate::Git
 
 		# 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
+		self.git.cmd "tag -s -m 'Tagging for release %s' %s %s" %
+			[ pkg_version_tag, pkg_version_tag, rev ]
 	end
 
 
 	### The body of the git:postrelease task.
 	def do_git_postrelease( task, args )
-		if self.git.status( 'checksum', unknown: true ).any?
+		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( '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
+			self.git.commit( "Adding release checksum." )
 		end
 
 		Rake::Task['git:push'].invoke
@@ -300,7 +320,7 @@ module Rake::DevEiate::Git
 					end
 				end
 
-				git.push( 'origin', git.current_branch )
+				git.push( 'origin', git.current_branch, tags: true )
 				self.prompt.ok "Done."
 			else
 				abort
@@ -371,7 +391,7 @@ module Rake::DevEiate::Git
 		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::" )
+				self.git.log.between( previous_tag )
 			else
 				self.git.log
 			end
@@ -455,11 +475,14 @@ module Rake::DevEiate::Git
 	### 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 ]
+		entries = statuses.select( &:type ) + statuses.untracked.values
+
+		lines = entries.map do |entry|
+			status = entry.type || '?'
+			status_color = STATUS_COLORS[ status ]
 			"	%s: %s" % [
-				self.pastel.white( entry.path.to_s ),
-				self.pastel.decorate( entry.status_description, *status_color ),
+				self.pastel.bold.white( entry.path.to_s ),
+				self.pastel.decorate( STATUS_DESCRIPTIONS[status], *status_color ),
 			]
 		end
 

data/lib/rake/deveiate/hg.rb

@@ -32,6 +32,9 @@ module Rake::DevEiate::Hg
 	# File indentation
 	FILE_INDENT = " • "
 
+	# The name of the branch releases should be created from
+	DEFAULT_RELEASE_BRANCH = 'default'
+
 
 	### Define version-control tasks
 	def define_tasks
@@ -39,6 +42,10 @@ module Rake::DevEiate::Hg
 
 		return unless self.is_hg_working_copy?
 
+		# :TODO: Actually check for this? Doesn't make much as much sense given my
+		# Mercurial workflow.
+		self.release_branch = DEFAULT_RELEASE_BRANCH
+
 		file COMMIT_MSG_FILE.to_s do |task|
 			commit_log = Pathname( task.name )
 

data/lib/rake/deveiate/packaging.rb

@@ -14,10 +14,8 @@ module Rake::DevEiate::Packaging
 	def setup( name, **options )
 		super if defined?( super )
 
-		gem_basename = "%s-%s" % [ name, self.version ]
-
-		@gem_filename = gem_basename + '.gem'
-		@gem_path     = Rake::DevEiate::PKG_DIR + @gem_filename
+		@gem_filename = nil
+		@gem_path     = nil
 	end
 
 	##
@@ -31,6 +29,10 @@ module Rake::DevEiate::Packaging
 
 	### Set up packaging tasks.
 	def define_tasks
+		gem_basename = "%s-%s" % [ name, self.version ]
+		@gem_filename = gem_basename + '.gem'
+		@gem_path     = Rake::DevEiate::PKG_DIR + @gem_filename
+
 		super if defined?( super )
 
 		task :release_gem => :gem

data/lib/rake/deveiate/releases.rb

@@ -41,8 +41,37 @@ module Rake::DevEiate::Releases
 	def do_release_gem( task, args )
 		gemserver = self.allowed_push_host || Rake::DevEiate::DEFAULT_GEMSERVER
 
+		case gemserver
+		when /\Ascp:/
+			self.do_scp_push( gemserver )
+		else
+			self.do_gem_push( gemserver )
+		end
+	end
+
+
+	### Push a new gem via a gemserver.
+	def do_gem_push( gemserver )
 		if self.prompt.yes?( "Push a new gem to #{gemserver}?" ) {|q| q.default(false) }
-			sh( Gem.ruby, "-S", "gem", "push", self.gem_path.to_s )
+			push_args = [ "push", self.gem_path.to_s ]
+			push_args << '-k' << self.gem_push_key if self.gem_push_key
+
+			sh( Gem.ruby, "-S", "gem", *push_args )
+		end
+	end
+
+
+	### Push a new gem via scp.
+	def do_scp_push( gemserver )
+		gemserver_url = URI( gemserver )
+
+		if self.prompt.yes?( "Push a new gem with scp to #{gemserver_url.host}?" ) {|q| q.default(false) }
+			require 'net/scp'
+
+			# Strip off one leading '/' if one is present
+			remote_path = gemserver_url.path[ %r{/(.*)}, 1 ]
+
+			Net::SCP.upload!( gemserver_url.host, gemserver_url.user, self.gem_path.to_s, remote_path )
 		end
 	end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rake-deveiate
 version: !ruby/object:Gem::Version
-  version: 0.17.4
+  version: 0.19.2
 platform: ruby
 authors:
 - Michael Granger
@@ -33,7 +33,7 @@ cert_chain:
   MCh97sQ/Z/MOusb5+QddBmB+k8EicXyGNl4b5L4XpL7fIQu+Y96TB3JEJlShxFD9
   k9FjI4d9EP54gS/4
   -----END CERTIFICATE-----
-date: 2021-01-02 00:00:00.000000000 Z
+date: 2021-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -55,14 +55,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '6.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '6.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -175,6 +175,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: net-scp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: ed25519
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: bcrypt_pbkdf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rdoc-generator-fivefish
   requirement: !ruby/object:Gem::Requirement
@@ -243,7 +285,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: This is a collection of Rake tasks I use for development.