rake-deveiate 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bee3cef237145810a6484e8d4177523424197d0225c2ffce50c8c965c9b9fbdd
-  data.tar.gz: 1874de0bcaffbee0f647b72b1401ca09b734f786e4f7979945932e9b040f548e
+  metadata.gz: f2ea1b2c13c4a64b66b4f9f70ed3fa8c253e38b8070fbbc2c9b6e2e05b2a34c2
+  data.tar.gz: 5d151b30f0a6e0f4e2ec550ef2fbb74981f3bba2c89561a2dc32ac52afea864a
 SHA512:
-  metadata.gz: d64b90cfb788aec9af147c7f5c7c1862a7fb61e657dfc3fe687c423369e82ff652e609c42b8da94bc043a279fcc07ed4dba15af2411e025c5e6fe4e7f6c64b2f
-  data.tar.gz: 9f22838336874b9fb461a9a66b682de78aa8e7113868fb5dd690ffad657080e7eaadbe88ecef90110c5de4808b5c067cab48bb23064f9b1e6c50389bd1dc7baf
+  metadata.gz: '08c1efed49f74b109300bb0362fa319faa49c3e4d0ba3191c48da5c4e49364ee559da560ab4fa3fb0081829e452c51981527763459972d5099a9ea08d0266b60'
+  data.tar.gz: 901f6960dbcc3d70a834dcb408f402c5ce298f9413fc1fe5acfe088d6f5439f5aa97031bec3fc4df5471bcde057b935340f27c2dd834566bc72974f1002160e3

data/History.md

@@ -2,6 +2,18 @@
 
 ---
 
+## v0.11.0 [2020-02-26] Michael Granger <ged@FaerieMUD.org>
+
+Improvements:
+
+- Add metadata extraction.
+- Try to strip markup from the gemspec description and summary
+
+Bugfixes:
+
+- Fix a bug in history file task when there's already an entry for the current version.
+
+
 ## v0.10.0 [2020-02-12] Michael Granger <ged@FaerieMUD.org>
 
 Improvements:

data/lib/rake/deveiate/gemspec.rb

@@ -130,6 +130,8 @@ module Rake::DevEiate::Gemspec
 		spec.licenses     = self.licenses
 		spec.date         = Date.today
 
+		spec.metadata     = self.make_gem_metadata
+
 		spec.required_ruby_version = self.required_ruby_version if
 			self.required_ruby_version
 		spec.metadata['allowed_push_host'] = self.allowed_push_host if self.allowed_push_host
@@ -171,6 +173,73 @@ module Rake::DevEiate::Gemspec
 	end
 
 
+	### Build the hash of metadata that should be attached to the gem.
+	def make_gem_metadata
+	    # "bug_tracker_uri"   => "https://example.com/user/bestgemever/issues",
+	    # "changelog_uri"     => "https://example.com/user/bestgemever/CHANGELOG.md",
+	    # "documentation_uri" => "https://www.example.info/gems/bestgemever/0.0.1",
+	    # "homepage_uri"      => "https://bestgemever.example.io",
+	    # "mailing_list_uri"  => "https://groups.example.com/bestgemever",
+	    # "source_code_uri"   => "https://example.com/user/bestgemever",
+	    # "wiki_uri"          => "https://example.com/user/bestgemever/wiki"
+
+		metadata = {
+			"homepage_uri" => self.homepage
+		}
+
+		if docs_uri = self.extract_documentation_uri
+			metadata['documentation_uri'] = docs_uri.to_s
+			if docs_uri.path.end_with?( '/', self.name )
+				cl_uri = docs_uri.dup
+				cl_uri.path = File.join( cl_uri.path, 'History_md.html' )
+				metadata['changelog_uri'] = cl_uri.to_s
+			end
+		end
+
+		if source_uri = self.extract_source_uri
+			metadata['source_uri'] = source_uri.to_s
+			case source_uri.host
+			when /\.sr\.ht/
+				bt_uri = source_uri.dup
+				bt_uri.host = 'todo.sr.ht'
+				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
+		end
+
+		return metadata
+	end
+
+
+	### Extract the documentation URI from the `docs` item of the first NOTE-type
+	### list in the README. Returns +nil+ if no such URI could be found.
+	def extract_documentation_uri
+		return fail_extraction( :documentation, "no README" ) unless self.readme
+
+		list = self.readme.parts.find {|part| RDoc::Markup::List === part && part.type == :NOTE } or
+			return fail_extraction(:documentation, "No NOTE list")
+		item = list.items.find {|item| item.label.include?('docs') } or
+			return fail_extraction(:documentation, "No `docs` item")
+
+		return URI( item.parts.first.text )
+	end
+
+
+	### Extract the source URI from the `docs` item of the first NOTE-type
+	### list in the README. Returns +nil+ if no such URI could be found.
+	def extract_source_uri
+		return fail_extraction( :source, "no README" ) unless self.readme
+
+		list = self.readme.parts.find {|part| RDoc::Markup::List === part && part.type == :NOTE } or
+			return fail_extraction(:code, "No NOTE list")
+		item = list.items.find {|item| item.label.include?('code') } or
+			return fail_extraction(:code, "No `code` item")
+
+		return URI( item.parts.first.text )
+	end
+
+
 	### Return a version string
 	def prerelease_version
 		return "#{self.version.bump}.0.pre.#{Time.now.strftime("%Y%m%d%H%M%S")}"

data/lib/rake/deveiate/hg.rb

@@ -348,7 +348,7 @@ module Rake::DevEiate::Hg
 		self.prompt.say "Updating history for %s..." % [ version_tag ]
 
 		if self.get_history_file_versions.include?( version_tag )
-			self.log.ok "History file already includes a section for %s" % [ version_tag ]
+			self.trace "History file already includes a section for %s" % [ version_tag ]
 			abort
 		end
 

data/lib/rake/deveiate.rb

@@ -34,7 +34,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.10.0'
+	VERSION = '0.11.0'
 
 	# The server to release to by default
 	DEFAULT_GEMSERVER = 'https://rubygems.org/'
@@ -88,6 +88,10 @@ class Rake::DevEiate < Rake::TaskLib
 		.md
 		.rdoc
 		.txt
+		.png
+		.jpg
+		.gif
+		.svg
 	]
 
 	# The path to the data directory for the Prestigio library.
@@ -316,7 +320,7 @@ class Rake::DevEiate < Rake::TaskLib
 		task :update_history
 
 		desc "Package up and push a release"
-		task :release => [ :prerelease, :release_gem, :postrelease ]
+		task :release => [ :prerelease, :gem, :release_gem, :postrelease ]
 		task :prerelease
 		task :release_gem
 		task :postrelease
@@ -398,7 +402,11 @@ class Rake::DevEiate < Rake::TaskLib
 	### Extract a description from the README if possible. Returns +nil+ if not.
 	def extract_description
 		parts = self.readme&.parts or return nil
-		return parts.find {|part| part.is_a?(RDoc::Markup::Paragraph) }&.text
+		desc_para = parts.find {|part| part.is_a?(RDoc::Markup::Paragraph) }&.text or return nil
+		formatter = RDoc::Markup::ToHtmlSnippet.new( RDoc::Options.new )
+		html = formatter.convert( desc_para )
+
+		return html.gsub( /<.*?>/, '' ).strip
 	end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rake-deveiate
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Michael Granger
@@ -34,7 +34,7 @@ cert_chain:
   jBZSA+N+xUTgUWpXjjwsLZjzJkhWATJWq+krNXcqpwXo6HsjmdUxoFMt63RBb+sI
   XrxOxp8o0uOkU7FdLSGsyqJ2LzsR4obN
   -----END CERTIFICATE-----
-date: 2020-02-12 00:00:00.000000000 Z
+date: 2020-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -162,11 +162,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
-description: |-
-  This is a collection of Rake tasks I use for development. I distribute them as
-  a gem mostly so people who wish to contribute to the other Open Source
-  libraries I maintain can do so easily, but of course you're welcome to use them
-  yourself if you find them useful.
+description: This is a collection of Rake tasks I use for development. I distribute
+  them as a gem mostly so people …
 email:
 - ged@FaerieMUD.org
 executables: []
@@ -190,7 +187,10 @@ files:
 homepage: https://hg.sr.ht/~ged/rake-deveiate
 licenses:
 - BSD-3-Clause
-metadata: {}
+metadata:
+  homepage_uri: https://hg.sr.ht/~ged/rake-deveiate
+  documentation_uri: https://deveiate.org/code/rake-deveiate/
+  changelog_uri: https://deveiate.org/code/rake-deveiate/History_md.html
 post_install_message: 
 rdoc_options: []
 require_paths:

metadata.gz.sig

@@ -1,3 +1,2 @@
-�*I5ܘh4�����ms~nr�c��5|~���@i�N����y�@��x|��ط:��n.�ǃ9���
-ѳ�&,��.$���ZĮ/R�e�ܳRlAs�FW�96�~b���ڇ�����-I};���7�
-+V(�ox��c�N;�b�P9��=| ���n��B:����i�m�zB�,�J��^�?��G����317,����M��v`���i�ש#Y\�q���Q.mS$�Y�H�]���Y���?���3��p�v��f��`��E�Y��e��t��G�K���u%'����H�ga���|��x�5�j�@��'��6�H�0�`�&����N/�|3��Z��R�FhK�"�F�p��W�oj�
+0U���H�w!g�A]�'n[�ܳ0�{������3���3���uk���0�4��@��`�'�)D��cއk_?�:�@��B�&Q��]������J�����#Y��� W�ɨq����
�_���F�D�j�Ђ"F��"��z��K9�FO��ig���,���)�>+7����u�ʸye��y�f$e����:�k歪����]xԽ�����(Є�J|􆙇[�*�0]^��Lץ����.�؞�Af�Q�2$��U������~�Fp�r�l;E�P
jk�/�jM��.m=×X���a��
+������,��V�54�9���HΘ��ޑ��)���a)�zDZ���8@X�*q"�K7D���w��ˮ�`