hoe-halostatue 2.0.0 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b19e26f2b478d5b4f6f3e3f9df2ce7daa349871c81ba5be8d842c9aefe157584
4
- data.tar.gz: 72de2f56fcf575787e2a776c77a22e46e69a740b554defefad17a7eff99370db
3
+ metadata.gz: 570731e6de226658f45ba1cc9ad567c6027432da0c12d9117c728daf9a43e439
4
+ data.tar.gz: fba129d2f1576bcbedbb7ea378f6cb5b3be3638e5e934ba619dabf6a50042261
5
5
  SHA512:
6
- metadata.gz: 984b0a2599039fd0eae94a72f5565d13d4b12a0924f27a7048332c989fd1e4ecd647f4350f42ae976bfea168978f93bb244536e238665fd08fb38d294f973366
7
- data.tar.gz: daabe4505ba07b2ff42f9356cbfa45d8da4cc68092ab21d9baded8b302e16d17873076bea73d91da6b4b569c9f5df010a38a8647d1001225882fa606618b8cb4
6
+ metadata.gz: 7fd7d157a549b89800b00dd3a9668eaede571c3a3ccce22193f6465d3564f21e2201a1f2b84f112a3d298e3c36909e3ecfce16e04d7ac20e607560443a1461e4
7
+ data.tar.gz: 429b470526f4a4b777ce7c7893b65943e9dc5a75080ccd0da6931c5f925e942d86810fe010a08b50ec5eb1b02a251f2519b5e071552a856d9ca7276dcb3d694d
data/CHANGELOG.md CHANGED
@@ -1,5 +1,18 @@
1
1
  # hoe-halostatue Changelog
2
2
 
3
+ ## 2.1.0 / 2025-06-18
4
+
5
+ - Add support for enabling "strict warnings" similar to
6
+ [RailsStrictWarnings][rsw].
7
+
8
+ - Updated several governance documents.
9
+
10
+ - Improved summary and link description cleaning.
11
+
12
+ ## 2.0.1 / 2025-06-12
13
+
14
+ - Update minimum version of hoe-gemspec2.
15
+
3
16
  ## 2.0.0 / 2025-02-19
4
17
 
5
18
  - Directly incorporate the functionality of `hoe-doofus` and `hoe-git2` into
@@ -19,4 +32,5 @@
19
32
 
20
33
  - Birthday!
21
34
 
35
+ [rsw]: https://github.com/rails/rails/blob/66732971111a62e5940268e1daf7d413c72a234f/tools/strict_warnings.rb
22
36
  [trusted]: https://github.com/rubygems/release-gem
data/CODE_OF_CONDUCT.md CHANGED
@@ -59,8 +59,9 @@ representative at an online or offline event.
59
59
  ## Enforcement
60
60
 
61
61
  Instances of abusive, harassing, or otherwise unacceptable behavior may be
62
- reported to the community leaders responsible for enforcement at [INSERT CONTACT
63
- METHOD]. All complaints will be reviewed and investigated promptly and fairly.
62
+ privately reported to the community leaders responsible for enforcement as a
63
+ [security vulnerability][security vulnerability]. All complaints will be
64
+ reviewed and investigated promptly and fairly.
64
65
 
65
66
  All community leaders are obligated to respect the privacy and security of the
66
67
  reporter of any incident.
@@ -124,5 +125,6 @@ For answers to common questions about this code of conduct, see the FAQ at
124
125
  <https://www.contributor-covenant.org/faq>. Translations are available at
125
126
  <https://www.contributor-covenant.org/translations>.
126
127
 
127
- [homepage]: https://www.contributor-covenant.org
128
128
  [Mozilla CoC]: https://github.com/mozilla/diversity
129
+ [homepage]: https://www.contributor-covenant.org
130
+ [security vulnerability]: https://github.com/halostatue/hoe-halostatue/security/advisories/new
data/CONTRIBUTING.md CHANGED
@@ -31,5 +31,5 @@ Here's the most direct way to get your work merged into the project:
31
31
  - Create a pull request against halostatue/hoe-halostatue and describe what your
32
32
  change does and the why you think it should be merged.
33
33
 
34
- [quality commit messages]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
35
34
  [hoe]: https://github.com/seattlerb/hoe
35
+ [quality commit messages]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
data/CONTRIBUTORS.md CHANGED
@@ -1,20 +1,30 @@
1
1
  # Contributors
2
2
 
3
- - Austin Ziegler created Hoe::Halostatue.
3
+ - Austin Ziegler ([@halostatue][@halostatue]) created Hoe::Halostatue.
4
4
 
5
5
  It would not be possible without Ryan Davis's [Hoe][hoe] and depends on the work
6
6
  of others in the Ruby community:
7
7
 
8
- - James Tucker (@raggi) for [`hoe-gemspec2`][hoe-gemspec2]
9
- - James Barnette (@jbarnette) for [`hoe-doofus`][hoe-doofus],
10
- [`hoe-git2`][hoe-git2], and [`hoe-rubygems`][hoe-rubygems]
11
- - Mike Dalessio (@flavorjones) for [`hoe-markdown`][hoe-markdown]
12
- - Samuel Giddins (@segiddins) for providing the inspiration to make all of this
13
- work better for trusted publishing for RubyGems.
8
+ - James Tucker ([@raggi][@raggi]) for [`hoe-gemspec2`][hoe-gemspec2].
9
+ - James Barnette ([@jbarnette][@jbarnette]) for [`hoe-doofus`][hoe-doofus],
10
+ [`hoe-git2`][hoe-git2], and [`hoe-rubygems`][hoe-rubygems].
11
+ - Mike Dalessio ([@flavorjones][@flavorjones]) for
12
+ [`hoe-markdown`][hoe-markdown].
13
+ - Samuel Giddins ([@segiddins][@segiddins]) for providing the inspiration to
14
+ make all of this work better for trusted publishing for RubyGems.
15
+ - Jean Boussier ([@byroot][@byroot]) for creating and pointing me to
16
+ [RailsStrictWarnings][rsw].
14
17
 
15
- [hoe]: https://github.com/seattlerb/hoe
18
+ [@byroot]: https://github.com/byroot
19
+ [@flavorjones]: https://github.com/flavorjones
20
+ [@halostatue]: https://github.com/halostatue
21
+ [@jbarnette]: https://github.com/jbarnette
22
+ [@raggi]: https://github.com/raggi
23
+ [@segiddins]: https://github.com/segiddins
16
24
  [hoe-doofus]: https://github.com/jbarnette/hoe-doofus
17
25
  [hoe-gemspec2]: https://github.com/raggi/hoe-gemspec2
18
26
  [hoe-git2]: https://github.com/halostatue/hoe-git2
19
27
  [hoe-markdown]: https://github.com/flavorjones/hoe-markdown
20
28
  [hoe-rubygems]: https://github.com/jbarnette/hoe-rubygems
29
+ [hoe]: https://github.com/seattlerb/hoe
30
+ [rsw]: https://github.com/rails/rails/blob/66732971111a62e5940268e1daf7d413c72a234f/tools/strict_warnings.rb
data/README.md CHANGED
@@ -145,6 +145,35 @@ workflow. It will bypass certain protections offered by Hoe and Hoe::Halostatue:
145
145
 
146
146
  - The release checklist will be skipped.
147
147
 
148
+ ### Strict Warnings
149
+
150
+ Warnings can be made strict (an exception will be thrown) for tests by adding
151
+ the following to your test or spec helper file (`test/minitest_helper.rb` or
152
+ `spec/rspec_helper.rb` or similar):
153
+
154
+ ```ruby
155
+ require "hoe/halostatue/strict_warnings"
156
+
157
+ # Optional but recommended to avoid getting warnings outside of your code.
158
+ Hoe::Halostatue::StrictWarnings.project_root = File.expand_path("../", __dir__)
159
+
160
+ # Optional regex patterns to suppress. Suppressed messages will not be printed
161
+ # to standard error. The patterns provided will be converted to a single regex
162
+ # on assignment.
163
+ Hoe::Halostatue::StrictWarnings.suppressed = [
164
+ /circular require considered harmful/
165
+ ]
166
+
167
+ # Optional regex patterns to allow. Allowed messages will be printed to
168
+ # standard error, but will not raise an exception. The patterns provided will
169
+ # be converted to a single regex on assignment.
170
+ Hoe::Halostatue::StrictWarnings.allowed = [
171
+ /oval require considered harmful/
172
+ ]
173
+ ```
174
+
175
+ This is based on [RailsStrictWarnings][rsw].
176
+
148
177
  ## Dependencies
149
178
 
150
179
  Hoe and Git 2.37 or later.
@@ -161,4 +190,5 @@ $ gem install hoe-halostatue
161
190
  [hoe-markdown]: https://github.com/flavorjones/hoe-markdown
162
191
  [hoe-rubygems]: https://github.com/jbarnette/hoe-rubygems
163
192
  [hoe]: https://github.com/seattlerb/hoe
193
+ [rsw]: https://github.com/rails/rails/blob/66732971111a62e5940268e1daf7d413c72a234f/tools/strict_warnings.rb
164
194
  [tp]: https://guides.rubygems.org/trusted-publishing/
data/Rakefile CHANGED
@@ -20,7 +20,7 @@ Hoe.spec "hoe-halostatue" do
20
20
  }
21
21
 
22
22
  extra_deps << ["hoe", ">= 3.0", "< 5"]
23
- extra_deps << ["hoe-gemspec2", "~> 1.1"]
23
+ extra_deps << ["hoe-gemspec2", "~> 1.4"]
24
24
  extra_deps << ["hoe-markdown", "~> 1.6"]
25
25
  extra_deps << ["hoe-rubygems", "~> 1.0"]
26
26
 
data/SECURITY.md CHANGED
@@ -6,15 +6,15 @@ Security reports are accepted only for the most recent minor release.
6
6
 
7
7
  ## Reporting a Vulnerability
8
8
 
9
- Alternatively, Send an email to [hoe-halostatue@halostatue.ca][email] with the
10
- text `hoe-halostatue` in the subject. Emails sent to this address should be
11
- encrypted using [age][age] with the following public key:
9
+ Create a [draft security advisory][advisory]. Alternatively, send an email to
10
+ [hoe-halostatue@halostatue.ca][email] with the text `hoe-halostatue` in the
11
+ subject. Emails sent to this address should be encrypted using [age][age] with
12
+ the following public key:
12
13
 
13
14
  ```
14
15
  age1fc6ngxmn02m62fej5cl30lrvwmxn4k3q2atqu53aatekmnqfwumqj4g93w
15
16
  ```
16
17
 
17
- [email]: mailto:hoe-halostatue@halostatue.ca
18
+ [advisory]: https://github.com/halostatue/hoe-halostatue/security/advisories/new
18
19
  [age]: https://github.com/FiloSottile/age
19
- [CVE-2017-17405]: https://nvd.nist.gov/vuln/detail/CVE-2017-17405
20
- [openuri]: https://sakurity.com/blog/2015/02/28/openuri.html
20
+ [email]: mailto:hoe-halostatue@halostatue.ca
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Hoe::Halostatue
4
- VERSION = "2.0.0"
4
+ VERSION = "2.1.0"
5
5
  end
@@ -95,6 +95,8 @@ module Hoe::Halostatue
95
95
  self.trusted_release = false
96
96
  end
97
97
 
98
+ LINKS = /\[(?<name>.+?)\](?:\(.+?\)|\[.+?\])/
99
+
98
100
  def define_halostatue_tasks # :nodoc:
99
101
  desc "Show a reminder for steps I frequently forget"
100
102
  task :checklist do
@@ -121,17 +123,12 @@ module Hoe::Halostatue
121
123
  end
122
124
  end
123
125
 
124
- task :spec_clean_markdown_text do
125
- spec.description =
126
- spec.description.gsub(/\[([^\]]+)\]\([^)]+\)/, '\1')
127
- .gsub(/\[([^\]]+)\]\[[^\]]+\]/, '\1')
128
-
129
- spec.summary =
130
- spec.summary.gsub(/\[([^\]]+)\]\([^)]+\)/, '\1')
131
- .gsub(/\[([^\]]+)\]\[[^\]]+\]/, '\1')
126
+ task :spec_clean_markdown_links do
127
+ spec.description = spec.description.gsub(LINKS, '\k<name>').gsub(/\r?\n/, " ")
128
+ spec.summary = spec.summary.gsub(LINKS, '\k<name>').gsub(/\r?\n/, " ")
132
129
  end
133
130
 
134
- task "#{spec.name}.gemspec" => :spec_clean_markdown_text
131
+ task "#{spec.name}.gemspec" => :spec_clean_markdown_links
135
132
 
136
133
  if trusted_release
137
134
  task :trusted_release do
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: hoe-halostatue
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.0.0
4
+ version: 2.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Austin Ziegler
8
- autorequire:
9
8
  bindir: bin
10
9
  cert_chain: []
11
- date: 2025-02-19 00:00:00.000000000 Z
10
+ date: 1980-01-02 00:00:00.000000000 Z
12
11
  dependencies:
13
12
  - !ruby/object:Gem::Dependency
14
13
  name: hoe
@@ -36,14 +35,14 @@ dependencies:
36
35
  requirements:
37
36
  - - "~>"
38
37
  - !ruby/object:Gem::Version
39
- version: '1.1'
38
+ version: '1.4'
40
39
  type: :runtime
41
40
  prerelease: false
42
41
  version_requirements: !ruby/object:Gem::Requirement
43
42
  requirements:
44
43
  - - "~>"
45
44
  - !ruby/object:Gem::Version
46
- version: '1.1'
45
+ version: '1.4'
47
46
  - !ruby/object:Gem::Dependency
48
47
  name: hoe-markdown
49
48
  requirement: !ruby/object:Gem::Requirement
@@ -144,7 +143,6 @@ metadata:
144
143
  source_code_uri: https://github.com/halostatue/halostatue-data/
145
144
  changelog_uri: https://github.com/halostatue/halostatue-data/blob/main/CHANGELOG.md
146
145
  rubygems_mfa_required: 'true'
147
- post_install_message:
148
146
  rdoc_options:
149
147
  - "--main"
150
148
  - README.md
@@ -161,8 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
161
159
  - !ruby/object:Gem::Version
162
160
  version: '0'
163
161
  requirements: []
164
- rubygems_version: 3.5.22
165
- signing_key:
162
+ rubygems_version: 3.6.9
166
163
  specification_version: 4
167
164
  summary: Hoe::Halostatue is a [Hoe][hoe] meta-plugin that provides improved support
168
165
  for Markdown README files, provides features from other plugins, and enables improved