hoe-halostatue 2.1.1 → 3.0.0

data/lib/hoe/halostatue/markdown.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+require_relative "markdown/linkify"
+
+module Hoe::Halostatue::Markdown
+  # Specify which markdown files to linkify.
+  #
+  # Should always be a list. May contain `:default` or `{exclude: patterns}` for special
+  # handling.
+  #
+  # `:default` ensures that all `.md` files in the manifest are included.
+  #
+  # `{exclude: patterns}` excludes files matching any of the provided patterns (a glob
+  # string, a regular expression, or a list of glob strings or regular expressions).
+  #
+  # [default: `[:default]`, any markdown files found in `spec.files`]
+  attr_accessor :markdown_linkify_files
+
+  # The style for producing links. The options are:
+  #
+  # - `:reference`, which will produce named reference links (e.g., `[#123][gh-issue-123]`)
+  # - `:inline`, which produces inline links (e.g., `[#123](https://…)`)
+  #
+  # Existing links _will not be modified_.
+  #
+  # When using reference links, existing reference link definitions will not be moved, but
+  # new definitions will be appended to the end of the file.
+  attr_accessor :markdown_linkify_style
+
+  # Controls whether shortened URIs for the current repository have prefixes added to
+  # them. This is either falsy (no prefixes added), `true` default prefixes are added, or
+  # a map with one or more type (`issue`, `pull`, `discussion`) and the prefix to be
+  # applied. The default prefixes (when `true`) are
+  # `{issue: 'issue', pull: 'pull', discussion: 'discussion'}`.
+  #
+  # Examples (assuming `true`):
+  #
+  # ```markdown
+  # [issue #123](https://github.com/cogswellcogs/sprocketkiller/issues/123
+  # [pull #246](https://github.com/cogswellcogs/sprocketkiller/pull/246)
+  # [discussion #369](https://github.com/cogswellcogs/sprocketkiller/discussions/369)
+  # ```
+  attr_accessor :markdown_linkify_uri_prefixes
+
+  private
+
+  def default_markdown_linkify_files
+    spec.files.grep(/\.md$/)
+  end
+
+  def initialize_halostatue_markdown
+    self.markdown_linkify_files = [:default]
+    self.markdown_linkify_style = :reference
+    self.markdown_linkify_uri_prefixes = nil
+
+    # TODO: We should check for `Changelog.md`, `ChangeLog.md` and `History.md`, etc., as
+    # documented
+
+    if File.exist?("CHANGELOG.md")
+      self.history_file = "CHANGELOG.md"
+    end
+
+    # TODO: Be case insensitive here, too
+
+    if File.exist?("README.md")
+      self.readme_file = "README.md"
+    end
+  end
+
+  def define_halostatue_markdown_tasks
+    return unless resolve_linkify_options
+
+    namespace_name = "markdown:linkify"
+    linkify_tasks = []
+
+    namespace namespace_name do
+      markdown_linkify_files.each do |mdfile_path|
+        mdfile_name = File.basename(mdfile_path)
+        task_name = mdfile_name.downcase.split(".")[0..-2].join(".")
+
+        linkifier = Hoe::Halostatue::Markdown::Linkify.new(
+          bug_tracker_uri: spec.metadata["bug_tracker_uri"],
+          style: markdown_linkify_style,
+          uri_prefixes: markdown_linkify_uri_prefixes
+        )
+
+        desc "hyperlink github issues and usernames in #{mdfile_name}"
+        task task_name do
+          original_markdown = File.read(mdfile_path)
+
+          linkifier.linkify(original_markdown) => {markdown:, changed:}
+
+          if changed
+            puts "markdown:linkify: updating #{mdfile_path}"
+            File.write(mdfile_path, markdown)
+          else
+            puts "markdown:linkify: no changes to #{mdfile_path}"
+          end
+        end
+
+        linkify_tasks << "#{namespace_name}:#{task_name}"
+      end
+    end
+
+    desc "hyperlink github issues and usernames in markdown files"
+    task namespace_name => linkify_tasks
+  end
+
+  def resolve_linkify_options
+    unless [:reference, :inline].include? markdown_linkify_style
+      raise ArgumentError, "Invalid markdown_linkify_style: #{markdown_linkify_style.inspect}"
+    end
+
+    self.markdown_linkify_uri_prefixes =
+      Hoe::Halostatue::Markdown::Linkify.normalize_uri_prefixes(markdown_linkify_uri_prefixes)
+
+    resolve_linkify_files
+  end
+
+  def resolve_linkify_files
+    @markdown_linkify_files ||= [:default]
+    return false if markdown_linkify_files.empty?
+
+    exclude_patterns =
+      markdown_linkify_files
+        .select { _1.is_a?(Hash) && _1.key?(:exclude) }
+        .flat_map { Array(_1[:exclude]) }.uniq
+
+    unless exclude_patterns.all? { _1.is_a?(Regexp) || _1.is_a?(String) }
+      raise ArgumentError, "exclude patterns must be Regexp or String"
+    end
+
+    markdown_linkify_files.reject! { _1.is_a?(Hash) }
+
+    if markdown_linkify_files.include?(:default)
+      markdown_linkify_files
+        .concat(default_markdown_linkify_files)
+        .delete(:default)
+    end
+
+    markdown_linkify_files.flatten!
+
+    markdown_linkify_files.reject! do |file|
+      exclude_patterns.any? { |pattern|
+        pattern.is_a?(Regexp) ? file.match?(pattern) : File.fnmatch?(pattern, file)
+      }
+    end
+
+    markdown_linkify_files.uniq!
+    !markdown_linkify_files.empty?
+  end
+end

data/lib/hoe/halostatue/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Hoe::Halostatue
-  VERSION = "2.1.1"
+  VERSION = "3.0.0" # :nodoc:
 end

data/lib/hoe/halostatue.rb

@@ -1,135 +1,97 @@
 # frozen_string_literal: true
 
-require "shellwords"
 require_relative "halostatue/version"
+require_relative "halostatue/checklist"
+require_relative "halostatue/gemspec"
+require_relative "halostatue/git"
+require_relative "halostatue/markdown"
 
-Hoe.plugin :gemspec2
-Hoe.plugin :markdown
-Hoe.plugin :rubygems
+class Hoe; end # :nodoc:
 
-# This module is a Hoe plugin. You can set its options in your Rakefile Hoe spec, like
-# this:
+Hoe.plugins.delete :git
+Hoe.plugins.delete :newb
+Hoe.plugins.delete :publish
+Hoe.plugins.delete :signing
+
+# This module is a Hoe plugin which applies extremely opinionated reconfiguration to Hoe.
+# You can set its options in your Rakefile Hoe spec, like this:
+#
+# ```ruby
+# Hoe.plugin :halostatue
+#
+# Hoe.spec "myproj" do
+#   self.checklist = nil if ENV["rubygems_release_gem"] == "true"
+#   self.git_release_tag_prefix = "REL_"
+#   self.git_remotes << "myremote"
+# end
+# ```
+#
+# The `:git` plugin (built into Hoe since Hoe 4.5 or present in the `hoe-git` or
+# `hoe-git2` dependencies) should not be enabled as that implementation differs from what
+# is included here.
+#
+# ### Tasks
+#
+# - `checklist`: Show the list of checklist questions.
+# - `git:manifest`: Update the manifest with Git's file list.
+# - `git:tag`: Create and push a tag.
 #
-#    Hoe.plugin :git
+# ### Options
 #
-#    Hoe.spec "myproj" do
-#      self.checklist = nil if ENV["rubygems_release_gem"] == "true"
-#      self.git_release_tag_prefix = "REL_"
-#      self.git_remotes << "myremote"
-#    end
+# - `checklist`: An array of reminder questions that should be asked before a release, in
+#   the form "Did you... [question]?". The default questions are:
 #
-# === Tasks
+#   - `Bump the version?`
+#   - `Check everything in?`
+#   - `Review the manifest?`
+#   - `Update the README and docs?`
+#   - `Update the changelog?`
+#   - `Regenerate the gemspec?`
 #
-# git:changelog:: Print the current changelog.
-# git:manifest::  Update the manifest with Git's file list.
-# git:tag::       Create and push a tag.
+#   If the checklist is `nil` or empty, or trusted publishing is on, the checklist will
+#   not be shown.
 #
-# === Options
+# - `git_release_tag_prefix`: What do you want at the front of your release tags? The
+#   default is `"v"`.
 #
-# - +checklist+: An array of reminder questions that should be asked before a release, in
-#   the form, "Did you... [question]?" You can see the defaults by running <tt>rake
-#   checklist</tt>. If the checklist is +nil+ or empty, the checklist will not shown
-#   during release. This is originally from hoe-doofus and called +doofus_checklist+.
+# - `git_remotes`: Which remotes do you want to push tags, etc. to? The default is
+#   `%w[origin]`.
 #
-# - +git_release_tag_prefix+: What do you want at the front of your release tags? The
-#   default is <tt>"v"</tt>.
+# - `git_tag_enabled`: Whether a git tag should be created on release. The default is
+#   `true`.
 #
-# - +git_remotes+: Which remotes do you want to push tags, etc. to? The default is
-#   <tt>%w[origin]</tt>
+# - `reproducible_gemspec`: Whether a fixed date should be used for reproducible gemspec
+#   values. This is ignored if `$SOURCE_DATE_EPOCH` is set. Acceptable values are:
 #
-# - +git_tag_enabled+: Whether a git tag should be created on release. The default is
-#   +true+.
+#   - `:default` or `true`: uses the RubyGems default source date epoch
+#   - `:current`: uses the date stored in the most recent gemspec file
+#   - `false`: sets the release date to the current date
+#   - An epoch value, either as an Integer or a String
+#
+#   The default is `:default`.
+#
+# - `trusted_release`: Indicates that this release is being run as part of a trusted
+#   release workflow.
 module Hoe::Halostatue
+  include Hoe::Halostatue::Checklist
+  include Hoe::Halostatue::Gemspec
+  include Hoe::Halostatue::Git
+  include Hoe::Halostatue::Markdown
+
   # Indicates that this release is being run as part of a trusted release workflow.
-  # [default: +false+]
+  # [default: `false`]
   attr_accessor :trusted_release
 
-  # An array of reminder questions that should be asked before a release, in the form,
-  # "Did you... [question]?" You can see the defaults by running <tt>rake checklist</tt>.
-  #
-  # If the checklist is +nil+ or empty, the checklist will not shown during release.
-  attr_accessor :checklist
-
-  # What do you want at the front of your release tags?
-  # [default: <tt>"v"</tt>]
-  attr_accessor :git_release_tag_prefix
-
-  # Which remotes do you want to push tags, etc. to?
-  # [default: <tt>%w[origin]</tt>]
-  attr_accessor :git_remotes
-
-  # Should git tags be created on release? [default: +true+]
-  attr_accessor :git_tag_enabled
-
   def initialize_halostatue # :nodoc:
-    Hoe::URLS_TO_META_MAP.update({
-      "bugs" => "bug_tracker_uri",
-      "changelog" => "changelog_uri",
-      "changes" => "changelog_uri",
-      "clog" => "changelog_uri",
-      "code" => "source_code_uri",
-      "doco" => "documentation_uri",
-      "docs" => "documentation_uri",
-      "documentation" => "documentation_uri",
-      "history" => "changelog_uri",
-      "home" => "homepage_uri",
-      "issues" => "bug_tracker_uri",
-      "mail" => "mailing_list_uri",
-      "tickets" => "bug_tracker_uri",
-      "wiki" => "wiki_uri"
-    })
-    Hoe.prepend Hoe::Halostatue::ParseUrls
-
-    self.checklist = [
-      "bump the version",
-      "check everything in",
-      "review the manifest",
-      "update the README and RDocs",
-      "update the changelog",
-      "regenerate the gemspec"
-    ]
-
-    self.git_release_tag_prefix = "v"
-    self.git_remotes = %w[origin]
-    self.git_tag_enabled = true
+    initialize_halostatue_checklist
+    initialize_halostatue_gemspec
+    initialize_halostatue_git
+    initialize_halostatue_markdown
+
     self.trusted_release = false
   end
 
-  LINKS = /\[(?<name>.+?)\](?:\(.+?\)|\[.+?\])/
-
   def define_halostatue_tasks # :nodoc:
-    desc "Show a reminder for steps I frequently forget"
-    task :checklist do
-      if checklist.nil? || checklist.empty?
-        puts "Checklist is empty."
-      else
-        puts "\n### HEY! Did you...\n\n"
-
-        checklist.each do |question|
-          question = question[0..0].upcase + question[1..]
-          question = "#{question}?" unless question.end_with?("?")
-          puts "  * #{question}"
-        end
-
-        puts
-      end
-    end
-
-    task :release_sanity do
-      unless checklist.nil? || checklist.empty? || trusted_release
-        Rake::Task[:checklist].invoke
-        puts "Hit return if you're sure, Ctrl-C if you forgot something."
-        $stdin.gets
-      end
-    end
-
-    task :spec_clean_markdown_links do
-      spec.description = spec.description.gsub(LINKS, '\k<name>').gsub(/\r?\n/, " ")
-      spec.summary = spec.summary.gsub(LINKS, '\k<name>').gsub(/\r?\n/, " ")
-    end
-
-    task "#{spec.name}.gemspec" => :spec_clean_markdown_links
-
     if trusted_release
       task :trusted_release do
         vm = %r{^(?<version>\d+(?:\.\d+)+)(?:\.(?<pre>[a-z]\w+(?:\.\d+)+))?}
@@ -142,79 +104,40 @@ module Hoe::Halostatue
       task release_sanity: :trusted_release
     end
 
-    return unless __run_git("rev-parse", "--is-inside-work-tree") == "true"
-
-    desc "Update the manifest with Git's file list. Use Hoe's excludes."
-    task "git:manifest" do
-      with_config do |config, _|
-        files = __run_git("ls-files").split($/)
-        files.reject! { |f| f =~ config["exclude"] }
-
-        File.open "Manifest.txt", "w" do |f|
-          f.puts files.sort.join("\n")
-        end
-      end
-    end
-
-    desc "Create and push a TAG (default #{git_release_tag_prefix}#{version})."
-    task "git:tag" do
-      if git_tag_enabled
-        tag = ENV["TAG"]
-        ver = ENV["VERSION"] || version
-        pre = ENV["PRERELEASE"] || ENV["PRE"]
-        ver += ".#{pre}" if pre
-        tag ||= "#{git_release_tag_prefix}#{ver}"
-
-        git_tag_and_push tag
-      end
-    end
-
-    task :release_sanity do
-      unless __run_git("status", "--porcelain").empty?
-        abort "Won't release: Dirty index or untracked files present!"
-      end
-    end
-
-    task release_to: "git:tag"
-  end
-
-  def __git(command, *params)
-    "git #{command.shellescape} #{params.compact.shelljoin}"
+    define_halostatue_checklist_tasks
+    define_halostatue_gemspec_tasks
+    define_halostatue_git_tasks
+    define_halostatue_markdown_tasks
   end
 
-  def __run_git(command, *params)
-    `#{__git(command, *params)}`.strip.chomp
-  end
-
-  def git_svn?
-    File.exist?(File.join(__run_git("rev-parse", "--show-toplevel"), ".git/svn"))
-  end
-
-  def git_tag_and_push tag
-    msg = "Tagging #{tag}."
-
-    if git_svn?
-      sh __git("svn", "tag", tag, "-m", msg)
-    else
-      flags =
-        if __run_git("config", "--get", "user.signingkey").empty?
-          nil
-        else
-          "-s"
-        end
-
-      sh __git("tag", flags, "-f", tag, "-m", msg)
-      git_remotes.each { |remote| sh __git("push", "-f", remote, "tag", tag) }
-    end
-  end
+  private
+
+  ::Hoe::URLS_TO_META_MAP.update({
+    "bugs" => "bug_tracker_uri",
+    "changelog" => "changelog_uri",
+    "changes" => "changelog_uri",
+    "clog" => "changelog_uri",
+    "code" => "source_code_uri",
+    "doco" => "documentation_uri",
+    "docs" => "documentation_uri",
+    "documentation" => "documentation_uri",
+    "history" => "changelog_uri",
+    "home" => "homepage_uri",
+    "issues" => "bug_tracker_uri",
+    "mail" => "mailing_list_uri",
+    "tickets" => "bug_tracker_uri",
+    "wiki" => "wiki_uri"
+  })
 
   # This replaces Hoe#parse_urls with something that works better for Markdown.
   module ParseUrls # :nodoc:
     def parse_urls text
       keys = Hoe::URLS_TO_META_MAP.keys.join("|")
-      pattern = %r{^[-+*]\s+(#{keys})\s+::\s+[<]?(\w+://[^>\s]+)[>]?}m
+      pattern = %r{^[-+*]\s+(#{keys})\s+::\s+<?(\w+://[^>\s]+)>?}m
 
       text.scan(pattern).to_h
     end
+
+    ::Hoe.prepend self
   end
 end

data/licences/dco.txt

@@ -0,0 +1,34 @@
+Developer Certificate of Origin
+Version 1.1
+
+Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+
+Developer's Certificate of Origin 1.1
+
+By making a contribution to this project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I
+    have the right to submit it under the open source license
+    indicated in the file; or
+
+(b) The contribution is based upon previous work that, to the best
+    of my knowledge, is covered under an appropriate open source
+    license and I have the right under that license to submit that
+    work with modifications, whether created in whole or in part
+    by me, under the same open source license (unless I am
+    permitted to submit under a different license), as indicated
+    in the file; or
+
+(c) The contribution was provided directly to me by some other
+    person who certified (a), (b) or (c) and I have not modified
+    it.
+
+(d) I understand and agree that this project and the contribution
+    are public and that a record of the contribution (including all
+    personal information I submit with it, including my sign-off) is
+    maintained indefinitely and may be redistributed consistent with
+    this project or the open source license(s) involved.