hoe-halostatue 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad97817e3c7c25d416ce2d84fd8768ef988585984ec9c121faeead466a7f6eae
-  data.tar.gz: e4909280d9be7adbb5bfc781830554850b94c42f466f6445cb66959654c14960
+  metadata.gz: b19e26f2b478d5b4f6f3e3f9df2ce7daa349871c81ba5be8d842c9aefe157584
+  data.tar.gz: 72de2f56fcf575787e2a776c77a22e46e69a740b554defefad17a7eff99370db
 SHA512:
-  metadata.gz: 30f90f79f0f6170a551602bc77b9d68e1abfb2df5ded177ff37f12b7a5a6d6125f1819a4062e115355af84ef16aa10ebf385b9f7ace9560b058ec666ee87b5bf
-  data.tar.gz: 3afd08e69cec5931e41fa5f66f395b76e29f40f85a92ef2c9715da93c14efdd6b8bc5447c2cf7cd6d651c08450907f53ac927f1864aa7adb061c4ef80bc15372
+  metadata.gz: 984b0a2599039fd0eae94a72f5565d13d4b12a0924f27a7048332c989fd1e4ecd647f4350f42ae976bfea168978f93bb244536e238665fd08fb38d294f973366
+  data.tar.gz: daabe4505ba07b2ff42f9356cbfa45d8da4cc68092ab21d9baded8b302e16d17873076bea73d91da6b4b569c9f5df010a38a8647d1001225882fa606618b8cb4

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # hoe-halostatue Changelog
 
+## 2.0.0 / 2025-02-19
+
+- Directly incorporate the functionality of `hoe-doofus` and `hoe-git2` into
+  `hoe-halostatue` and make it possible to disable features that would block
+  automated releases via [rubygems/release-gem][trusted].
+
+- Minor improvements to `Hoe#parse_urls` for Markdown READMEs so that wrapped
+  URLs work.
+
+- Added a `trusted_release` mode that skips the need for a `VERSION` specifier
+  on the release task and ensures that features which impede automated releases
+  are disabled.
+
+- Enabled trusted publishing for this repo.
+
 ## 1.0.1 / 2024-12-31
 
 - Birthday!
+
+[trusted]: https://github.com/rubygems/release-gem

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at [INSERT CONTACT
+METHOD]. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+<https://www.contributor-covenant.org/version/2/1/code_of_conduct.html>.
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+<https://www.contributor-covenant.org/faq>. Translations are available at
+<https://www.contributor-covenant.org/translations>.
+
+[homepage]: https://www.contributor-covenant.org
+[Mozilla CoC]: https://github.com/mozilla/diversity

data/CONTRIBUTING.md

@@ -0,0 +1,35 @@
+# Contributing
+
+I value any contribution to Hoe::Halostatue you can provide: a bug report, a
+feature request, or code contributions. There are a few guidelines for
+contributing to Hoe::Halostatue:
+
+- Match my coding style.
+- Use a thoughtfully-named topic branch that contains your change. Rebase your
+  commits into logical chunks as necessary.
+- Use [quality commit messages][quality commit messages].
+- Do not change the version number; when your patch is accepted and a release is
+  made, the version will be updated at that point.
+- Submit a GitHub pull request with your changes.
+- New or changed behaviours require appropriate documentation.
+
+Hoe::Halostatue uses Ryan Davis's [Hoe][Hoe] to manage the release process, and
+it adds a number of rake tasks.
+
+## Workflow
+
+Here's the most direct way to get your work merged into the project:
+
+- Fork the project.
+- Clone your fork (`git clone git://github.com/<username>/hoe-halostatue.git`).
+- Create a topic branch to contain your change
+  (`git checkout -b my_awesome_feature`).
+- Hack away, add tests. Not necessarily in that order.
+- Make sure everything still passes by running `rake`.
+- If necessary, rebase your commits into logical chunks, without errors.
+- Push the branch up (`git push origin my_awesome_feature`).
+- Create a pull request against halostatue/hoe-halostatue and describe what your
+  change does and the why you think it should be merged.
+
+[quality commit messages]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+[hoe]: https://github.com/seattlerb/hoe

data/CONTRIBUTORS.md

@@ -0,0 +1,20 @@
+# Contributors
+
+- Austin Ziegler created Hoe::Halostatue.
+
+It would not be possible without Ryan Davis's [Hoe][hoe] and depends on the work
+of others in the Ruby community:
+
+- James Tucker (@raggi) for [`hoe-gemspec2`][hoe-gemspec2]
+- James Barnette (@jbarnette) for [`hoe-doofus`][hoe-doofus],
+  [`hoe-git2`][hoe-git2], and [`hoe-rubygems`][hoe-rubygems]
+- Mike Dalessio (@flavorjones) for [`hoe-markdown`][hoe-markdown]
+- Samuel Giddins (@segiddins) for providing the inspiration to make all of this
+  work better for trusted publishing for RubyGems.
+
+[hoe]: https://github.com/seattlerb/hoe
+[hoe-doofus]: https://github.com/jbarnette/hoe-doofus
+[hoe-gemspec2]: https://github.com/raggi/hoe-gemspec2
+[hoe-git2]: https://github.com/halostatue/hoe-git2
+[hoe-markdown]: https://github.com/flavorjones/hoe-markdown
+[hoe-rubygems]: https://github.com/jbarnette/hoe-rubygems

data/LICENCE.md

@@ -0,0 +1,24 @@
+## Licence
+
+Hoe::Halostatue is free software available under the MIT licence.
+
+Copyright 2022-2025 Austin Ziegler (halostatue@gmail.com)
+
+Portions copyright 2009 John Barnette
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the 'Software'), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -1,5 +1,11 @@
 CHANGELOG.md
+CODE_OF_CONDUCT.md
+CONTRIBUTING.md
+CONTRIBUTORS.md
+LICENCE.md
 Manifest.txt
 README.md
 Rakefile
+SECURITY.md
 lib/hoe/halostatue.rb
+lib/hoe/halostatue/version.rb

data/README.md

@@ -1,66 +1,159 @@
-# Hoe - Halostatue Meta-Plugin
+# Hoe::Halostatue Meta-Plugin
+
+- home :: <https://github.com/halostatue/halostatue-data/>
+- issues :: <https://github.com/halostatue/halostatue-data/issues>
+- code :: <https://github.com/halostatue/halostatue-data/>
+- changelog ::
+  <https://github.com/halostatue/halostatue-data/blob/main/CHANGELOG.md>
 
 ## Description
 
-Hoe::Halostatue is a [Hoe][hoe] meta-plugin that ensures that the following
-plugins are installed and enabled for your project:
+Hoe::Halostatue is a [Hoe][hoe] meta-plugin that provides improved support for
+Markdown README files, provides features from other plugins, and enables
+improved support for [trusted publishing][tp].
 
-- [`hoe-doofus`][hoe-doofus]
-- [`hoe-gemspec2`][hoe-gemspec2]
-- [`hoe-git2`][hoe-git2]
-- [`hoe-markdown`][hoe-markdown]
-- [`hoe-rubygems`][hoe-rubygems]
+## Examples
 
-It also provides an improved implementation for `Hoe#parse_urls` that works
-better with a Markdown README. It allows either `*` or `-` as list leaders for
-the README. It also allows the URLs to be blank. Double colons are still
-required for pattern matching.
+```ruby
+# In your Rakefile
+Hoe.plugin :halostatue
 
-In addition to the four letter aliases in `Hoe::URLS_TO_META_MAP` (`bugs`,
-`clog`, `doco`, `docs`, `home`, `code`, `wiki`, and `mail`), this adds:
+Hoe.spec "myproj" do
+  self.checklist = nil if ENV["rubygems_release_gem"] == "true"
+  self.git_tag_enabled = ENV["rubygems_release_gem"] != "true"
+  # ...
+end
+```
 
-- `changelog`, `changes`, and `history` as aliases for `changelog_uri`
-- `documentation` for `documentation_uri`
-- `issues` and `tickets` for `bug_tracker_uri`
+If this plugin cannot see that it is in a `.git` directory, `hoe-git2` derived
+features will be deactivated.
 
-## Examples
+## Features
+
+Hoe::Halostatue automatically enables Hoe plugins
+[`hoe-gemspec2`][hoe-gemspec2], [`hoe-markdown`][hoe-markdown], and
+[`hoe-rubygems`][hoe-rubygems].
+
+With version 2, the functionality of [`hoe-doofus`][hoe-doofus] and
+[`hoe-git2`][hoe-git2] have been incorporated into Hoe::Halostatue to improve
+automated release support.
+
+### Improved Metadata URL Parsing
+
+Hoe::Halostatue provides an improved implementation for `Hoe#parse_urls`. The
+expected format is more or less the same, but accepts any left-aligned Markdown
+list (beginning with `-`, `+`, or `*`) and handles lists that wrap lines (such
+as the `changelog` entry at the top of this file).
+
+It is more strict than the default `Hoe#parse_urls` because it only accepts the
+known aliases for the various RubyGems URI meta keys.
+
+| RubyGems URI Meta Key | Alias                                     |
+| --------------------- | ----------------------------------------- |
+| `documentation_uri`   | `doco`, `docs`, `documentation`           |
+| `bug_tracker_uri`     | `bugs`, `issues`, `tickets`               |
+| `changelog_uri`       | `clog`, `changelog`, `changes`, `history` |
+| `homepage_uri`        | `home`, `homepage`                        |
+| `wiki_uri`            | `wiki`                                    |
+| `mailing_list_uri`    | `mail`                                    |
+
+### Automated Release Support
+
+Certain features offered by Hoe plugins supported are useful for manual
+releases, but work against automated releases (see [trusted publishing][tp]).
+
+- `hoe-doofus` has been replaced with an internal implementation that disables
+  the display if the release checklist is unset or empty.
+
+- `hoe-git2` has been incorporated into Hoe::Halostatue, but the pieces which
+  affect release can be disabled through configuration.
+
+In the example below, the release checklist and Git tag creation will be
+disabled if `$rubygems_release_gem` is `true`.
 
 ```ruby
-# in your Rakefile
 Hoe.plugin :halostatue
+
+Hoe.spec "myproj" do
+  self.checklist = nil if ENV["rubygems_release_gem"] == "true"
+  self.git_tag_enabled = ENV["rubygems_release_gem"] != "true"
+  # ...
+end
 ```
 
-## Dependencies
+### Release Checklist (from `hoe-doofus`)
 
-Hoe and Git, obviously. I wouldn't be surprised if things don't quite work for
-git < 2.37.
+The release checklist feature has been incorporated from `hoe-doofus`.
 
-## Installation
+> A Hoe plugin that helps me (and you, maybe?) keep from messing up gem
+> releases. It shows a configurable checklist when `rake release` is run, and
+> provides a chance to abort if anything's been forgotten.
+
+The current checklist can be seen by running `rake checklist` and the checklist
+may be set by using `self.checklist << "new item"` in your spec. If the
+checklist is `nil` or empty, the checklist prompt will not be displayed.
+
+```ruby
+Hoe.plugin :halostatue
+
+Hoe.spec "myproj" do
+  if ENV["rubygems_release_gem"] == "true"
+    self.checklist = nil
+  else
+    checklist << "Given the release a snappy name"
+  end
+end
+```
+
+### Git Integration Tasks (from `hoe-git2`)
+
+Support for generating the CHANGELOG from the git commit messages has not been
+incorporated into Hoe::Halostatue.
+
+#### Generating the Manifest
+
+The `Manifest.txt` required by Hoe can be generated with `rake git:manifest`.
+This uses `git ls-files`, respecting the Hoe manifest sort order and excludes.
+
+#### Tagging and Sanity Checking a Release
+
+A release will be aborted if your Git index is dirty or there are untracked
+files present. After the release is published, a Git tag will be created and
+pushed to your repo remotes. Both `$PRERELEASE` and `$PRE` tags are supported,
+with `$PRERELEASE` taking precedence over `$PRE`, just as with Hoe itself.
+
+In the following example with no other configuration, a `v1.0.0.beta.1` tag will
+be created and pushed to the `origin` remote.
 
 ```console
-$ gem install hoe-halostatue
+$ rake release VERSION=1.0.0 PRERELEASE=beta.1
 ```
 
-## License
+The tag prefix can be with `self.git_release_tag_prefix`, which defaults to `v`.
+
+The created tag can be pushed to different remotes with `self.git_remotes`,
+which defaults to `["origin"]`.
+
+### Trusted Release
 
-Copyright 2024 Austin Ziegler (halostatue@gmail.com)
+If `spec.trusted_release` is set to `true` changes will be made to the `release`
+workflow. This flag is intended to be used only with a [trusted publishing][tp]
+workflow. It will bypass certain protections offered by Hoe and Hoe::Halostatue:
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the 'Software'), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
-the Software, and to permit persons to whom the Software is furnished to do so,
-subject to the following conditions:
+- The version discovered by Hoe will be trusted as correct, removing the need
+  for specifying the version.
+
+- The release checklist will be skipped.
+
+## Dependencies
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+Hoe and Git 2.37 or later.
 
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+## Installation
+
+```console
+$ gem install hoe-halostatue
+```
 
 [hoe-doofus]: https://github.com/jbarnette/hoe-doofus
 [hoe-gemspec2]: https://github.com/raggi/hoe-gemspec2
@@ -68,3 +161,4 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 [hoe-markdown]: https://github.com/flavorjones/hoe-markdown
 [hoe-rubygems]: https://github.com/jbarnette/hoe-rubygems
 [hoe]: https://github.com/seattlerb/hoe
+[tp]: https://guides.rubygems.org/trusted-publishing/

data/Rakefile

@@ -9,14 +9,18 @@ Hoe.plugin :halostatue
 Hoe.spec "hoe-halostatue" do
   developer "Austin Ziegler", "halostatue@gmail.com"
 
+  self.trusted_release = ENV["rubygems_release_gem"] == "true"
+
   self.extra_rdoc_files = FileList["*.rdoc"]
 
   license "MIT"
 
+  spec_extras[:metadata] = ->(val) {
+    val.merge!({"rubygems_mfa_required" => "true"})
+  }
+
   extra_deps << ["hoe", ">= 3.0", "< 5"]
-  extra_deps << ["hoe-doofus", "~> 1.0"]
   extra_deps << ["hoe-gemspec2", "~> 1.1"]
-  extra_deps << ["hoe-git2", "~> 1.8"]
   extra_deps << ["hoe-markdown", "~> 1.6"]
   extra_deps << ["hoe-rubygems", "~> 1.0"]
 

data/SECURITY.md

@@ -0,0 +1,20 @@
+# Hoe::Halostatue Security Policy
+
+## Supported Versions
+
+Security reports are accepted only for the most recent minor release.
+
+## Reporting a Vulnerability
+
+Alternatively, Send an email to [hoe-halostatue@halostatue.ca][email] with the
+text `hoe-halostatue` in the subject. Emails sent to this address should be
+encrypted using [age][age] with the following public key:
+
+```
+age1fc6ngxmn02m62fej5cl30lrvwmxn4k3q2atqu53aatekmnqfwumqj4g93w
+```
+
+[email]: mailto:hoe-halostatue@halostatue.ca
+[age]: https://github.com/FiloSottile/age
+[CVE-2017-17405]: https://nvd.nist.gov/vuln/detail/CVE-2017-17405
+[openuri]: https://sakurity.com/blog/2015/02/28/openuri.html

data/lib/hoe/halostatue/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Hoe::Halostatue
+  VERSION = "2.0.0"
+end

data/lib/hoe/halostatue.rb

@@ -1,64 +1,223 @@
 # frozen_string_literal: true
 
-Hoe.plugin :doofus
+require "shellwords"
+require_relative "halostatue/version"
+
 Hoe.plugin :gemspec2
-Hoe.plugin :git2
 Hoe.plugin :markdown
 Hoe.plugin :rubygems
 
-# Hoe::Halostatue is a Hoe meta-plugin that ensures that the following
-# plugins are installed and enabled for your project:
+# This module is a Hoe plugin. You can set its options in your Rakefile Hoe spec, like
+# this:
 #
-# - hoe-doofus (release checklist)
-# - hoe-gemspec2 (gemspec generation)
-# - hoe-git2 (git manifest and tag generation)
-# - hoe-markdown (default to Markdown files and auto-linkification)
+#    Hoe.plugin :git
 #
-# It also provides an improved implementation for Hoe#parse_urls that
-# works better with a Markdown README. It allows either +*+ or +-+ as
-# list leaders for the README. It also allows the URLs to be blank.
-# Double colons are still required for pattern matching.
+#    Hoe.spec "myproj" do
+#      self.checklist = nil if ENV["rubygems_release_gem"] == "true"
+#      self.git_release_tag_prefix = "REL_"
+#      self.git_remotes << "myremote"
+#    end
 #
-# In addition to the four letter aliases in Hoe::URLS_TO_META_MAP
-# (+bugs+, +clog+, +doco+, +docs+, +home+, +code+, +wiki+, and +mail+),
-# this adds:
+# === Tasks
 #
-# - +changelog+, +changes+, and +history+ as aliases for +changelog_uri+
-# - +documentation+ for +documentation_uri+
-# - +issues+ and +tickets+ for +bug_tracker_uri+
-
+# git:changelog:: Print the current changelog.
+# git:manifest::  Update the manifest with Git's file list.
+# git:tag::       Create and push a tag.
+#
+# === Options
+#
+# - +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_release_tag_prefix+: What do you want at the front of your release tags? The
+#   default is <tt>"v"</tt>.
+#
+# - +git_remotes+: Which remotes do you want to push tags, etc. to? The default is
+#   <tt>%w[origin]</tt>
+#
+# - +git_tag_enabled+: Whether a git tag should be created on release. The default is
+#   +true+.
 module Hoe::Halostatue
-  VERSION = "1.0.1"
+  # Indicates that this release is being run as part of a trusted release workflow.
+  # [default: +false+]
+  attr_accessor :trusted_release
 
-  def initialize_halostatue # :nodoc:
-    Hoe::URLS_TO_META_MAP.update Hoe::Halostatue::ParseUrls::URLS_TO_META_MAP
+  # 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
 
-    Hoe.prepend Hoe::Halostatue::ParseUrls
-  end
+  # What do you want at the front of your release tags?
+  # [default: <tt>"v"</tt>]
+  attr_accessor :git_release_tag_prefix
 
-  def define_halostatue_tasks # :nodoc:
-  end
+  # Which remotes do you want to push tags, etc. to?
+  # [default: <tt>%w[origin]</tt>]
+  attr_accessor :git_remotes
 
-  module ParseUrls
-    URLS_TO_META_MAP = {
+  # 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",
-      "tickets" => "bug_tracker_uri"
-    }
+      "mail" => "mailing_list_uri",
+      "tickets" => "bug_tracker_uri",
+      "wiki" => "wiki_uri"
+    })
+    Hoe.prepend Hoe::Halostatue::ParseUrls
 
-    def parse_urls text
-      lines = text.gsub(/^[-*] /, "").delete("<>").split("\n").grep(/\S+/)
+    self.checklist = [
+      "bump the version",
+      "check everything in",
+      "review the manifest",
+      "update the README and RDocs",
+      "update the changelog",
+      "regenerate the gemspec"
+    ]
 
-      return {} if lines.empty?
+    self.git_release_tag_prefix = "v"
+    self.git_remotes = %w[origin]
+    self.git_tag_enabled = true
+    self.trusted_release = false
+  end
 
-      if /::/.match?(lines.first)
-        Hash[lines.map { |line| line.split(/\s*::\s*/) }]
+  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_text do
+      spec.description =
+        spec.description.gsub(/\[([^\]]+)\]\([^)]+\)/, '\1')
+          .gsub(/\[([^\]]+)\]\[[^\]]+\]/, '\1')
+
+      spec.summary =
+        spec.summary.gsub(/\[([^\]]+)\]\([^)]+\)/, '\1')
+          .gsub(/\[([^\]]+)\]\[[^\]]+\]/, '\1')
+    end
+
+    task "#{spec.name}.gemspec" => :spec_clean_markdown_text
+
+    if trusted_release
+      task :trusted_release do
+        vm = %r{^(?<version>\d+(?:\.\d+)+)(?:\.(?<pre>[a-z]\w+(?:\.\d+)+))?}
+          .match(spec.version.to_s)
+
+        ENV["VERSION"] = vm[:version]
+        ENV["PRERELEASE"] = vm[:pre]
       end
+
+      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}"
+  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
+
+  # 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
+
+      text.scan(pattern).to_h
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hoe-halostatue
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Austin Ziegler
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-31 00:00:00.000000000 Z
+date: 2025-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hoe
@@ -30,20 +30,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '5'
-- !ruby/object:Gem::Dependency
-  name: hoe-doofus
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: hoe-gemspec2
   requirement: !ruby/object:Gem::Requirement
@@ -58,20 +44,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: hoe-git2
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: hoe-markdown
   requirement: !ruby/object:Gem::Requirement
@@ -135,44 +107,43 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '7'
 description: |-
-  Hoe::Halostatue is a [Hoe][hoe] meta-plugin that ensures that the following
-  plugins are installed and enabled for your project:
-
-  - [`hoe-doofus`][hoe-doofus]
-  - [`hoe-gemspec2`][hoe-gemspec2]
-  - [`hoe-git2`][hoe-git2]
-  - [`hoe-markdown`][hoe-markdown]
-  - [`hoe-rubygems`][hoe-rubygems]
-
-  It also provides an improved implementation for `Hoe#parse_urls` that works
-  better with a Markdown README. It allows either `*` or `-` as list leaders for
-  the README. It also allows the URLs to be blank. Double colons are still
-  required for pattern matching.
-
-  In addition to the four letter aliases in `Hoe::URLS_TO_META_MAP` (`bugs`,
-  `clog`, `doco`, `docs`, `home`, `code`, `wiki`, and `mail`), this adds:
-
-  - `changelog`, `changes`, and `history` as aliases for `changelog_uri`
-  - `documentation` for `documentation_uri`
-  - `issues` and `tickets` for `bug_tracker_uri`
+  Hoe::Halostatue is a [Hoe][hoe] meta-plugin that provides improved support for
+  Markdown README files, provides features from other plugins, and enables
+  improved support for [trusted publishing][tp].
 email:
 - halostatue@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- CONTRIBUTORS.md
+- LICENCE.md
 - Manifest.txt
 - README.md
+- SECURITY.md
 files:
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- CONTRIBUTORS.md
+- LICENCE.md
 - Manifest.txt
 - README.md
 - Rakefile
+- SECURITY.md
 - lib/hoe/halostatue.rb
-homepage:
+- lib/hoe/halostatue/version.rb
+homepage: https://github.com/halostatue/halostatue-data/
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/halostatue/halostatue-data/
+  bug_tracker_uri: https://github.com/halostatue/halostatue-data/issues
+  source_code_uri: https://github.com/halostatue/halostatue-data/
+  changelog_uri: https://github.com/halostatue/halostatue-data/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options:
 - "--main"
@@ -190,12 +161,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
-summary: 'Hoe::Halostatue is a [Hoe][hoe] meta-plugin that ensures that the following
-  plugins are installed and enabled for your project:  - [`hoe-doofus`][hoe-doofus]
-  - [`hoe-gemspec2`][hoe-gemspec2] - [`hoe-git2`][hoe-git2] - [`hoe-markdown`][hoe-markdown]
-  - [`hoe-rubygems`][hoe-rubygems]  It also provides an improved implementation for
-  `Hoe#parse_urls` that works better with a Markdown README'
+summary: Hoe::Halostatue is a [Hoe][hoe] meta-plugin that provides improved support
+  for Markdown README files, provides features from other plugins, and enables improved
+  support for [trusted publishing][tp].
 test_files: []