sanitize_email 2.0.13 → 2.0.14

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.
Files changed (22) hide show
  1. checksums.yaml +4 -4
  2. checksums.yaml.gz.sig +0 -0
  3. data/CHANGELOG.md +107 -1
  4. data/LICENSE.md +1 -1
  5. data/README.md +19 -17
  6. data/lib/sanitize_email/bleach.rb +1 -3
  7. data/lib/sanitize_email/deprecation.rb +4 -4
  8. data/lib/sanitize_email/test_helpers.rb +1 -1
  9. data/lib/sanitize_email/version.rb +4 -1
  10. data/lib/sanitize_email.rb +0 -2
  11. data.tar.gz.sig +0 -0
  12. metadata +50 -46
  13. metadata.gz.sig +0 -0
  14. data/CITATION.cff +0 -20
  15. data/CODE_OF_CONDUCT.md +0 -134
  16. data/CONTRIBUTING.md +0 -275
  17. data/FUNDING.md +0 -70
  18. data/MIT.md +0 -21
  19. data/RUBOCOP.md +0 -71
  20. data/SECURITY.md +0 -21
  21. data/certs/pboling.pem +0 -27
  22. /data/sig/{sanitize_email/version.rbs → sanitize_email.rbs} +0 -0
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e428d45c83d29ee8b27c9752d85bb8b53518bd3ea1ababeab6829719e6422c7a
4
- data.tar.gz: 87522e8f3cb045b99c8a1d3ee16253182c76a673542d3de812f3650c609ca74a
3
+ metadata.gz: a7c1513706ef8c25c5376a39267da18091ce45963253472d8cc406caf6cd71ca
4
+ data.tar.gz: 7457f74e949bf2edf5820a7dbbe80fac5641ede488c883423c4ccb4503046e14
5
5
  SHA512:
6
- metadata.gz: 3af8f96025e00cbcdb2a6e76e661e0a312db260ee564d1312aad841e19c6ac26b61cbd29ca61fd42ad74fecc7dcf5f91191d03743d2e2f6ebadd0f8b6401b5c1
7
- data.tar.gz: cdd89499132bb6ac8845678113eb857aac44db01214062207d8e18c921fef04091c05b0950fe0b0338390dfd759f4e4cd1692200894e1a161138a872acdfd81e
6
+ metadata.gz: 2259f6c3680f9a0ec80a1ec45e687901415050c4e5757b930d7c00772ec44532ee81e56ccf84a68ffbd2665a28892afed3de5a887b6f40c9efcda69b27577ba0
7
+ data.tar.gz: b0f2df9d12456f3c736445fe10ac28783e1871128d378848c54d7d33201346a3379f222c34e0c5ba3e30b766b9c45c854835a2522d1affde20ba0f23a67e537f
checksums.yaml.gz.sig CHANGED
Binary file
data/CHANGELOG.md CHANGED
@@ -30,6 +30,110 @@ Please file a bug if you notice a violation of semantic versioning.
30
30
 
31
31
  ### Security
32
32
 
33
+ ## [2.0.14] - 2026-07-31
34
+
35
+ - TAG: [v2.0.14][2.0.14t]
36
+ - COVERAGE: 95.58% -- 368/385 lines in 13 files
37
+ - BRANCH COVERAGE: 82.91% -- 97/117 branches in 13 files
38
+ - 53.41% documented
39
+
40
+ ### Changed
41
+
42
+ - kettle-jem-template-20260716-001 - Shim gemspec manifests now include
43
+ `LICENSE.md` instead of nonexistent `LICENSE.txt`.
44
+ - kettle-jem-template-20260716-002 - Generated gemspec manifests now ship fewer
45
+ repository-only files by default to reduce downstream distro packaging churn.
46
+ - kettle-jem-template-20260720-001 - Generated READMEs can now render
47
+ template-managed corporate sponsor logos from project or family config.
48
+ - kettle-jem-template-20260720-002 - Generated development Gemfiles now use the
49
+ released `tree_sitter_language_pack` gem 1.13.3 or newer by default.
50
+ - kettle-jem-template-20260720-003 - Generated StructuredMerge Git diff driver
51
+ config now uses the installed `smorg-rb` Ruby driver name.
52
+ - kettle-jem-template-20260720-004 - Generated multi-engine workflow files now
53
+ omit JRuby and TruffleRuby jobs when project config declares MRI-only engines.
54
+ - kettle-jem-template-20260720-005 - Generated README Support & Community rows
55
+ now include a RubyForum help badge.
56
+ - kettle-jem-template-20260725-001 - Generated JRuby and TruffleRuby workflow
57
+ files now run when pull request head branches start with `feature/release`,
58
+ so release CI monitoring does not report intentionally skipped engine
59
+ workflows as failures.
60
+
61
+ - kettle-jem-template-20260725-002 - Generated gemspec templates now include
62
+ `anonymous_loader` as a development dependency, and version specs use it to
63
+ execute generated `version.rb` files for coverage without redefining package
64
+ constants. Managed version specs are removed when `version_gem` is disabled
65
+ or incompatible with the project's runtime Ruby floor.
66
+
67
+ - kettle-jem-template-20260728-001 - Generated Ruby workflows now use clearer
68
+ setup-ruby-flash planning and can prepare appraisal-only jobs without
69
+ installing the main Gemfile bundle.
70
+
71
+ ### Fixed
72
+
73
+ - Root development bundle now includes the Rails test harness fragment, so
74
+ `bundle exec kettle-test` can load the suite outside appraisal-specific
75
+ Gemfiles.
76
+ - Added coverage for legacy test helper, matcher, and Rails integration shim
77
+ surfaces so release coverage thresholds pass.
78
+
79
+ - Root release bundles now include the default Rails test support, and
80
+ Rails-dependent specs load `rails_helper` explicitly for parallel workers.
81
+
82
+ - kettle-jem-template-20260726-002 - Generated version files now document their
83
+ version namespace and constants, reducing warning-only YARD lint output.
84
+
85
+ - kettle-jem-template-20260726-003 - Coverage upload steps now treat Coveralls,
86
+ QLTY, and Codecov as optional, so provider outages do not fail CI when local
87
+ coverage thresholds still pass.
88
+ - kettle-jem-template-20260728-002 - Generated RuboCop configs now ignore the
89
+ same `gemfiles/vendor/bundle` tree as `.gitignore`, so vendored dependency
90
+ installs are not reported as project lint debt.
91
+ - kettle-jem-template-20260728-003 - Generated dep-heads workflows now run
92
+ TruffleRuby jobs with current RubyGems and Bundler, avoiding setup failures
93
+ before the test suite starts.
94
+
95
+ - kettle-jem-template-20260728-004 - Generated dep-heads workflows now use the
96
+ setup-ruby Bundler install path for direct appraisal Gemfiles, avoiding rv
97
+ lockfile parser failures on Git and path dependencies.
98
+
99
+ - kettle-jem-template-20260728-005 - VersionGem bootstrap now creates the
100
+ missing canonical version spec when a project only has shim namespace version
101
+ specs.
102
+
103
+ - kettle-jem-template-20260729-001 - Generated JRuby 9.4 workflows now use the
104
+ legacy manual bundle install path, avoiding setup-time Bundler full-index
105
+ failures against `gem.coop`.
106
+
107
+ - kettle-jem-template-20260729-002 - VersionGem bootstrap now preserves
108
+ and templates dedicated `version_gem.rb` entrypoints even when the gemspec
109
+ dependency is intentionally omitted, and generated anonymous-loader specs
110
+ cover both `version.rb` and `version_gem.rb`.
111
+
112
+ - kettle-jem-template-20260729-003 - Old-Ruby gems below the VersionGem runtime
113
+ floor now get managed minimal `version.rb` files and anonymous-loader version
114
+ specs without adding `version_gem`.
115
+ - kettle-jem-template-20260730-001 - Gemspec package file enumeration now runs
116
+ relative to the gemspec directory, so packaged template assets are included
117
+ even when the gemspec is loaded from another working directory.
118
+
119
+ - Legacy test helpers now reject unsupported match values consistently on Ruby
120
+ 2.5, where plain objects still respond to `=~`.
121
+
122
+ ### Added
123
+
124
+ - Documentation linting now has its generated `yard-lint` dependency and severity config available in the local bundle.
125
+
126
+ - kettle-jem-template-20260726-001 - Projects now include YARD lint
127
+ configuration and documentation dependencies so documentation issues fail
128
+ before generated docs are refreshed.
129
+
130
+ - kettle-jem-template-20260727-001 - Spec harness documentation now lists the
131
+ RSpec helpers provided by `kettle-test`.
132
+
133
+ - kettle-jem-template-20260729-005 - Gemspec metadata now publishes this
134
+ project's RubyForum tag as `mailing_list_uri`, and support docs link to the
135
+ tagged RubyForum community alongside Discord.
136
+
33
137
  ## [2.0.13] - 2026-07-02
34
138
 
35
139
  - TAG: [v2.0.13][2.0.13t]
@@ -482,7 +586,9 @@ Old version?
482
586
  * Fixed require paths
483
587
  * added about.yml and this CHANGELOG
484
588
 
485
- [Unreleased]: https://github.com/galtzo-floss/sanitize_email/compare/v2.0.13...HEAD
589
+ [Unreleased]: https://github.com/galtzo-floss/sanitize_email/compare/v2.0.14...HEAD
590
+ [2.0.14]: https://github.com/galtzo-floss/sanitize_email/compare/v2.0.13...v2.0.14
591
+ [2.0.14t]: https://github.com/galtzo-floss/sanitize_email/releases/tag/v2.0.14
486
592
  [2.0.13]: https://github.com/galtzo-floss/sanitize_email/compare/v2.0.12...v2.0.13
487
593
  [2.0.13t]: https://github.com/galtzo-floss/sanitize_email/releases/tag/v2.0.13
488
594
  [2.0.12]: https://github.com/galtzo-floss/sanitize_email/compare/v2.0.11...v2.0.12
data/LICENSE.md CHANGED
@@ -3,7 +3,7 @@
3
3
  This project is made available under the following license.
4
4
  Choose the option that best fits your use case:
5
5
 
6
- - [MIT](MIT.md)
6
+ - [MIT](https://github.com/galtzo-floss/sanitize_email/blob/main/MIT.md)
7
7
 
8
8
  ## Copyright Notice
9
9
 
data/README.md CHANGED
@@ -2,9 +2,9 @@
2
2
 
3
3
  # 📧 SanitizeEmail
4
4
 
5
- [![Version][👽versioni]][👽version] [![GitHub tag (latest SemVer)][⛳️tag-img]][⛳️tag] [![License: MIT][📄license-img]][📄license] [![Downloads Rank][👽dl-ranki]][👽dl-rank] [![CodeCov Test Coverage][🏀codecovi]][🏀codecov] [![Coveralls Test Coverage][🏀coveralls-img]][🏀coveralls] [![QLTY Test Coverage][🏀qlty-covi]][🏀qlty-cov] [![QLTY Maintainability][🏀qlty-mnti]][🏀qlty-mnt] [![CI Heads][🚎3-hd-wfi]][🚎3-hd-wf] [![CI Runtime Dependencies @ HEAD][🚎12-crh-wfi]][🚎12-crh-wf] [![CI Current][🚎11-c-wfi]][🚎11-c-wf] [![CI Truffle Ruby][🚎9-t-wfi]][🚎9-t-wf] [![CI JRuby][🚎10-j-wfi]][🚎10-j-wf] [![Deps Locked][🚎13-🔒️-wfi]][🚎13-🔒️-wf] [![Deps Unlocked][🚎14-🔓️-wfi]][🚎14-🔓️-wf] [![CI Test Coverage][🚎2-cov-wfi]][🚎2-cov-wf] [![CI Style][🚎5-st-wfi]][🚎5-st-wf] [![Apache SkyWalking Eyes License Compatibility Check][🚎15-🪪-wfi]][🚎15-🪪-wf]
5
+ [![Version][👽versioni]][👽version] [![Ruby Users Forum][✉️ruby-forum-top-img]][✉️ruby-forum] [![GitHub tag (latest SemVer)][⛳️tag-img]][⛳️tag] [![License: MIT][📄license-img]][📄license] [![Downloads Rank][👽dl-ranki]][👽dl-rank] [![CodeCov Test Coverage][🏀codecovi]][🏀codecov] [![Coveralls Test Coverage][🏀coveralls-img]][🏀coveralls] [![QLTY Test Coverage][🏀qlty-covi]][🏀qlty-cov] [![QLTY Maintainability][🏀qlty-mnti]][🏀qlty-mnt] [![CI Heads][🚎3-hd-wfi]][🚎3-hd-wf] [![CI Runtime Dependencies @ HEAD][🚎12-crh-wfi]][🚎12-crh-wf] [![CI Current][🚎11-c-wfi]][🚎11-c-wf] [![CI Truffle Ruby][🚎9-t-wfi]][🚎9-t-wf] [![CI JRuby][🚎10-j-wfi]][🚎10-j-wf] [![Deps Locked][🚎13-🔒️-wfi]][🚎13-🔒️-wf] [![Deps Unlocked][🚎14-🔓️-wfi]][🚎14-🔓️-wf] [![CI Test Coverage][🚎2-cov-wfi]][🚎2-cov-wf] [![CI Style][🚎5-st-wfi]][🚎5-st-wf] [![Apache SkyWalking Eyes License Compatibility Check][🚎15-🪪-wfi]][🚎15-🪪-wf]
6
6
 
7
- `if ci_badges.map(&:color).detect { it != "green"}` ☝️ [let me know][✉️discord-invite], as I may have missed the [discord notification][✉️discord-invite].
7
+ `if ci_badges.map(&:color).detect { it != "green"}` ☝️ [let me know on Discord][✉️discord-invite] or [RubyForum][✉️ruby-forum], as I may have missed the notification.
8
8
 
9
9
  ---
10
10
 
@@ -41,8 +41,8 @@ It's particularly helpful when you want to prevent the delivery of email (e.g. i
41
41
  | Works with MRI Ruby 4 | [![Ruby current Compat][💎ruby-c-i]][🚎11-c-wf] [![Ruby HEAD Compat][💎ruby-headi]][🚎3-hd-wf]|
42
42
  | Works with MRI Ruby 3 | [![Ruby 3.0 Compat][💎ruby-3.0i]][🚎ruby-3.0-wf] [![Ruby 3.1 Compat][💎ruby-3.1i]][🚎ruby-3.1-wf] [![Ruby 3.2 Compat][💎ruby-3.2i]][🚎ruby-3.2-wf] [![Ruby 3.3 Compat][💎ruby-3.3i]][🚎ruby-3.3-wf] [![Ruby 3.4 Compat][💎ruby-3.4i]][🚎ruby-3.4-wf]|
43
43
  | Works with MRI Ruby 2 | ![Ruby 2.3 Compat][💎ruby-2.3i] <br/> [![Ruby 2.4 Compat][💎ruby-2.4i]][🚎ruby-2.4-wf] [![Ruby 2.5 Compat][💎ruby-2.5i]][🚎ruby-2.5-wf] [![Ruby 2.6 Compat][💎ruby-2.6i]][🚎ruby-2.6-wf] [![Ruby 2.7 Compat][💎ruby-2.7i]][🚎ruby-2.7-wf]|
44
- | Support & Community | [![Join Me on Daily.dev's RubyFriends][✉️ruby-friends-img]][✉️ruby-friends] [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite] [![Get help from me on Upwork][👨🏼‍🏫expsup-upwork-img]][👨🏼‍🏫expsup-upwork] [![Get help from me on Codementor][👨🏼‍🏫expsup-codementor-img]][👨🏼‍🏫expsup-codementor] |
45
- | Source | [![Source on GitLab.com][📜src-gl-img]][📜src-gl] [![Source on CodeBerg.org][📜src-cb-img]][📜src-cb] [![Source on Github.com][📜src-gh-img]][📜src-gh] [![The best SHA: dQw4w9WgXcQ!][🧮kloc-img]][🧮kloc] |
44
+ | Support & Community | [![Join Me on Daily.dev's RubyFriends][✉️ruby-friends-img]][✉️ruby-friends] [![Get help from RubyForum][✉️ruby-forum-img]][✉️ruby-forum] [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite] [![Get help from me on Upwork][👨🏼‍🏫expsup-upwork-img]][👨🏼‍🏫expsup-upwork] [![Get help from me on Codementor][👨🏼‍🏫expsup-codementor-img]][👨🏼‍🏫expsup-codementor] |
45
+ | Source | [![Source on GitLab.com][📜src-gl-img]][📜src-gl] [![Source on CodeBerg.org][📜src-cb-img]][📜src-cb] [![Source on GitHub.com][📜src-gh-img]][📜src-gh] [![The best SHA: dQw4w9WgXcQ!][🧮kloc-img]][🧮kloc] |
46
46
  | Documentation | [![Current release on RubyDoc.info][📜docs-cr-rd-img]][🚎yard-current] [![YARD on Galtzo.com][📜docs-head-rd-img]][🚎yard-head] [![Maintainer Blog][🚂maint-blog-img]][🚂maint-blog] [![GitLab Wiki][📜gl-wiki-img]][📜gl-wiki] [![GitHub Wiki][📜gh-wiki-img]][📜gh-wiki] |
47
47
  | Compliance | [![License: MIT][📄license-img]][📄license] [![Apache license compatibility: Category A][📄license-compat-img]][📄license-compat] [![📄ilo-declaration-img]][📄ilo-declaration] [![Security Policy][🔐security-img]][🔐security] [![Contributor Covenant 2.1][🪇conduct-img]][🪇conduct] [![SemVer 2.0.0][📌semver-img]][📌semver] |
48
48
  | Style | [![Enforced Code Style Linter][💎rlts-img]][💎rlts] [![Keep-A-Changelog 1.0.0][📗keep-changelog-img]][📗keep-changelog] [![Gitmoji Commits][📌gitmoji-img]][📌gitmoji] [![Compatibility appraised by: appraisal2][💎appraisal2-img]][💎appraisal2] |
@@ -82,17 +82,14 @@ The _amazing_ test matrix is powered by the kettle-dev stack.
82
82
  <details markdown="1">
83
83
  <summary>Find this repo on federated forges (Coming soon!)</summary>
84
84
 
85
- | Federated [DVCS][💎d-in-dvcs] Repository | Status | Issues | PRs | Wiki | CI | Discussions |
86
- |-------------------------------------------------|-----------------------------------------------------------------------|---------------------------|--------------------------|---------------------------|--------------------------|------------------------------|
87
- | 🧪 [galtzo-floss/sanitize_email on GitLab][📜src-gl] | The Truth | [💚][🤝gl-issues] | [💚][🤝gl-pulls] | [💚][📜gl-wiki] | 🐭 Tiny Matrix | ➖ |
88
- | 🧊 [galtzo-floss/sanitize_email on CodeBerg][📜src-cb] | An Ethical Mirror ([Donate][🤝cb-donate]) | [💚][🤝cb-issues] | [💚][🤝cb-pulls] | ➖ | ⭕️ No Matrix | ➖ |
89
- | 🐙 [galtzo-floss/sanitize_email on GitHub][📜src-gh] | Another Mirror | [💚][🤝gh-issues] | [💚][🤝gh-pulls] | [💚][📜gh-wiki] | 💯 Full Matrix | [💚][gh-discussions] |
90
- | 🎮️ [Discord Server][✉️discord-invite] | [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite] | [Let's][✉️discord-invite] | [talk][✉️discord-invite] | [about][✉️discord-invite] | [this][✉️discord-invite] | [library!][✉️discord-invite] |
85
+ | Federated [DVCS][💎d-in-dvcs] Repository | Status | Issues | PRs | Wiki | CI |
86
+ |-------------------------------------------------|-------------------------------------------|-------------------|------------------|-----------------|----------------|
87
+ | 🧪 [galtzo-floss/sanitize_email on GitLab][📜src-gl] | The Truth | [💚][🤝gl-issues] | [💚][🤝gl-pulls] | [💚][📜gl-wiki] | 🐭 Tiny Matrix |
88
+ | 🧊 [galtzo-floss/sanitize_email on CodeBerg][📜src-cb] | An Ethical Mirror ([Donate][🤝cb-donate]) | [💚][🤝cb-issues] | [💚][🤝cb-pulls] | ➖ | ⭕️ No Matrix |
89
+ | 🐙 [galtzo-floss/sanitize_email on GitHub][📜src-gh] | Another Mirror | [💚][🤝gh-issues] | [💚][🤝gh-pulls] | [💚][📜gh-wiki] | 💯 Full Matrix |
91
90
 
92
91
  </details>
93
92
 
94
- [gh-discussions]: https://github.com/galtzo-floss/sanitize_email/discussions
95
-
96
93
  ### Enterprise Support [![Tidelift](https://tidelift.com/badges/package/rubygems/sanitize_email)](https://tidelift.com/subscription/pkg/rubygems-sanitize_email?utm_source=rubygems-sanitize_email&utm_medium=referral&utm_campaign=readme)
97
94
 
98
95
  Available as part of the Tidelift Subscription.
@@ -110,6 +107,7 @@ The maintainers of this and thousands of other packages are working with Tidelif
110
107
 
111
108
  Alternatively:
112
109
 
110
+ - [![Ruby Users Forum][✉️ruby-forum-img]][✉️ruby-forum]
113
111
  - [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite]
114
112
  - [![Get help from me on Upwork][👨🏼‍🏫expsup-upwork-img]][👨🏼‍🏫expsup-upwork]
115
113
  - [![Get help from me on Codementor][👨🏼‍🏫expsup-codementor-img]][👨🏼‍🏫expsup-codementor]
@@ -294,7 +292,7 @@ See [CHANGELOG.md][📌changelog] for a list of releases.
294
292
  ## 📄 License
295
293
 
296
294
  The gem is available as open source under the terms of
297
- the [MIT](MIT.md) [![License: MIT][📄license-img]][📄license-ref].
295
+ the [MIT](https://github.com/galtzo-floss/sanitize_email/blob/main/MIT.md) [![License: MIT][📄license-img]][📄license-ref].
298
296
 
299
297
  ### © Copyright
300
298
 
@@ -328,11 +326,12 @@ I'm hoping to be able to pay for my kids' health insurance this month,
328
326
  so if you value the work I am doing, I need your support.
329
327
  Please consider sponsoring me or the project.
330
328
 
331
- To join the community or get help 👇️ Join the Discord.
329
+ To join the community or get help, use the RubyForum or Discord.
332
330
 
331
+ [![Ruby Users Forum][✉️ruby-forum-img]][✉️ruby-forum]
333
332
  [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite]
334
333
 
335
- To say "thanks!" ☝️ Join the Discord or 👇️ send money.
334
+ To say "thanks!" ☝️ Join the community or 👇️ send money.
336
335
 
337
336
  [![Sponsor galtzo-floss/sanitize_email on Open Source Collective][🖇osc-all-bottom-img]][🖇osc] 💌 [![Sponsor me on GitHub Sponsors][🖇sponsor-bottom-img]][🖇sponsor] 💌 [![Sponsor me on Liberapay][⛳liberapay-bottom-img]][⛳liberapay] 💌 [![Donate on PayPal][🖇paypal-bottom-img]][🖇paypal]
338
337
 
@@ -373,6 +372,9 @@ Thanks for RTFM. ☺️
373
372
  [✉️discord-invite-img-ftb]: https://img.shields.io/discord/1373797679469170758?style=for-the-badge&logo=discord
374
373
  [✉️ruby-friends-img]: https://img.shields.io/badge/daily.dev-%F0%9F%92%8E_Ruby_Friends-0A0A0A?style=for-the-badge&logo=dailydotdev&logoColor=white
375
374
  [✉️ruby-friends]: https://app.daily.dev/squads/rubyfriends
375
+ [✉️ruby-forum-top-img]: https://img.shields.io/discourse/topics?server=https%3A%2F%2Fwww.rubyforum.org&style=flat&logo=discourse&label=Ruby%20Users%20Forum
376
+ [✉️ruby-forum-img]: https://img.shields.io/discourse/topics?server=https%3A%2F%2Fwww.rubyforum.org&style=for-the-badge&logo=discourse&label=Ruby%20Users%20Forum
377
+ [✉️ruby-forum]: https://www.rubyforum.org/tag/sanitize-email
376
378
 
377
379
  [✇bundle-group-pattern]: https://gist.github.com/pboling/4564780
378
380
  [⛳️gem-namespace]: https://github.com/galtzo-floss/sanitize_email
@@ -418,7 +420,7 @@ Thanks for RTFM. ☺️
418
420
  [📜src-gl]: https://gitlab.com/galtzo-floss/sanitize_email
419
421
  [📜src-cb-img]: https://img.shields.io/badge/CodeBerg-4893CC?style=for-the-badge&logo=CodeBerg&logoColor=blue
420
422
  [📜src-cb]: https://codeberg.org/galtzo-floss/sanitize_email
421
- [📜src-gh-img]: https://img.shields.io/badge/GitHub-238636?style=for-the-badge&logo=Github&logoColor=green
423
+ [📜src-gh-img]: https://img.shields.io/badge/GitHub-238636?style=for-the-badge&logo=GitHub&logoColor=green
422
424
  [📜src-gh]: https://github.com/galtzo-floss/sanitize_email
423
425
  [📜docs-cr-rd-img]: https://img.shields.io/badge/RubyDoc-Current_Release-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white
424
426
  [📜docs-head-rd-img]: https://img.shields.io/badge/YARD_on_Galtzo.com-HEAD-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white
@@ -534,7 +536,7 @@ Thanks for RTFM. ☺️
534
536
  [🔐security-img]: https://img.shields.io/badge/security-policy-259D6C.svg?style=flat
535
537
  [📄copyright-notice-explainer]: https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year
536
538
  [📄license]: LICENSE.md
537
- [📄license-ref]: MIT.md
539
+ [📄license-ref]: https://github.com/galtzo-floss/sanitize_email/blob/main/MIT.md
538
540
  [📄license-img]: https://img.shields.io/badge/License-MIT-259D6C.svg
539
541
  [📄license-compat]: https://www.apache.org/legal/resolved.html#category-a
540
542
  [📄license-compat-img]: https://img.shields.io/badge/Apache_Compatible:_Category_A-%E2%9C%93-259D6C.svg?style=flat&logo=Apache
data/lib/sanitize_email/bleach.rb CHANGED
@@ -1,8 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # Copyright (c) 2008 - 2018, 2020, 2022, 2024 Peter H. Boling of RailsBling.com
4
- # Released under the MIT license
5
-
3
+ # Email header sanitization helpers.
6
4
  module SanitizeEmail
7
5
  # Determines whether to sanitize the headers of an email,
8
6
  # and does so when appropriate.
data/lib/sanitize_email/deprecation.rb CHANGED
@@ -22,8 +22,8 @@ module SanitizeEmail
22
22
  @deprecate_in_silence = false
23
23
 
24
24
  # Define a deprecated alias for a method
25
- # @param [Symbol] name - name of method to define
26
- # @param [Symbol] replacement - name of method to (alias)
25
+ # @param name [Symbol] name of method to define
26
+ # @param replacement [Symbol] name of method to (alias)
27
27
  def deprecated_alias(name, replacement)
28
28
  # Create a wrapped version
29
29
  define_method(name) do |*args, &block|
@@ -33,8 +33,8 @@ module SanitizeEmail
33
33
  end
34
34
 
35
35
  # Deprecate a defined method
36
- # @param [Symbol] name - name of deprecated method
37
- # @param [Symbol] replacement - name of the desired replacement
36
+ # @param name [Symbol] name of deprecated method
37
+ # @param replacement [Symbol] name of the desired replacement
38
38
  def deprecated(name, replacement = nil)
39
39
  # Replace old method
40
40
  old_name = :"#{name}_without_deprecation"
data/lib/sanitize_email/test_helpers.rb CHANGED
@@ -17,7 +17,7 @@ module SanitizeEmail
17
17
 
18
18
  def string_matching(matcher, part, attribute)
19
19
  # Can we match a regex against it?
20
- raise UnexpectedMailType, "Cannot match #{matcher} for #{part}" unless attribute.respond_to?(:=~)
20
+ raise UnexpectedMailType, "Cannot match #{matcher} for #{part}" unless attribute.is_a?(String)
21
21
  attribute =~ if matcher.is_a?(Regexp)
22
22
  matcher
23
23
  else
data/lib/sanitize_email/version.rb CHANGED
@@ -1,8 +1,11 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module SanitizeEmail
4
+ # Version namespace for this gem.
4
5
  module Version
5
- VERSION = "2.0.13"
6
+ # Current gem version.
7
+ VERSION = "2.0.14"
6
8
  end
9
+ # Current gem version exposed at the traditional constant location.
7
10
  VERSION = Version::VERSION # Traditional Constant Location
8
11
  end
data/lib/sanitize_email.rb CHANGED
@@ -114,7 +114,6 @@ module SanitizeEmail
114
114
  # subject "subject"
115
115
  # end
116
116
  # end
117
- #
118
117
  def sanitary(config_options = {})
119
118
  raise MissingBlockParameter, "SanitizeEmail.sanitary must be called with a block" unless block_given?
120
119
  forcing =
@@ -145,7 +144,6 @@ module SanitizeEmail
145
144
  # subject "subject"
146
145
  # end
147
146
  # end
148
- #
149
147
  def unsanitary
150
148
  raise MissingBlockParameter, "SanitizeEmail.unsanitary must be called with a block" unless block_given?
151
149
  janitor(forcing: false) do
data.tar.gz.sig CHANGED
Binary file
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: sanitize_email
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.0.13
4
+ version: 2.0.14
5
5
  platform: ruby
6
6
  authors:
7
7
  - Peter Boling
@@ -71,7 +71,7 @@ dependencies:
71
71
  version: '1.1'
72
72
  - - ">="
73
73
  - !ruby/object:Gem::Version
74
- version: 1.1.13
74
+ version: 1.1.14
75
75
  type: :runtime
76
76
  prerelease: false
77
77
  version_requirements: !ruby/object:Gem::Requirement
@@ -81,27 +81,27 @@ dependencies:
81
81
  version: '1.1'
82
82
  - - ">="
83
83
  - !ruby/object:Gem::Version
84
- version: 1.1.13
84
+ version: 1.1.14
85
85
  - !ruby/object:Gem::Dependency
86
86
  name: kettle-dev
87
87
  requirement: !ruby/object:Gem::Requirement
88
88
  requirements:
89
89
  - - "~>"
90
90
  - !ruby/object:Gem::Version
91
- version: '2.3'
91
+ version: '2.5'
92
92
  - - ">="
93
93
  - !ruby/object:Gem::Version
94
- version: 2.3.0
94
+ version: 2.5.13
95
95
  type: :development
96
96
  prerelease: false
97
97
  version_requirements: !ruby/object:Gem::Requirement
98
98
  requirements:
99
99
  - - "~>"
100
100
  - !ruby/object:Gem::Version
101
- version: '2.3'
101
+ version: '2.5'
102
102
  - - ">="
103
103
  - !ruby/object:Gem::Version
104
- version: 2.3.0
104
+ version: 2.5.13
105
105
  - !ruby/object:Gem::Dependency
106
106
  name: bundler-audit
107
107
  requirement: !ruby/object:Gem::Requirement
@@ -150,26 +150,46 @@ dependencies:
150
150
  - - ">="
151
151
  - !ruby/object:Gem::Version
152
152
  version: 1.0.4
153
+ - !ruby/object:Gem::Dependency
154
+ name: anonymous_loader
155
+ requirement: !ruby/object:Gem::Requirement
156
+ requirements:
157
+ - - "~>"
158
+ - !ruby/object:Gem::Version
159
+ version: '0.1'
160
+ - - ">="
161
+ - !ruby/object:Gem::Version
162
+ version: 0.1.3
163
+ type: :development
164
+ prerelease: false
165
+ version_requirements: !ruby/object:Gem::Requirement
166
+ requirements:
167
+ - - "~>"
168
+ - !ruby/object:Gem::Version
169
+ version: '0.1'
170
+ - - ">="
171
+ - !ruby/object:Gem::Version
172
+ version: 0.1.3
153
173
  - !ruby/object:Gem::Dependency
154
174
  name: appraisal2
155
175
  requirement: !ruby/object:Gem::Requirement
156
176
  requirements:
157
177
  - - "~>"
158
178
  - !ruby/object:Gem::Version
159
- version: '3.1'
179
+ version: '3.2'
160
180
  - - ">="
161
181
  - !ruby/object:Gem::Version
162
- version: 3.1.4
182
+ version: 3.2.0
163
183
  type: :development
164
184
  prerelease: false
165
185
  version_requirements: !ruby/object:Gem::Requirement
166
186
  requirements:
167
187
  - - "~>"
168
188
  - !ruby/object:Gem::Version
169
- version: '3.1'
189
+ version: '3.2'
170
190
  - - ">="
171
191
  - !ruby/object:Gem::Version
172
- version: 3.1.4
192
+ version: 3.2.0
173
193
  - !ruby/object:Gem::Dependency
174
194
  name: kettle-test
175
195
  requirement: !ruby/object:Gem::Requirement
@@ -179,7 +199,7 @@ dependencies:
179
199
  version: '2.0'
180
200
  - - ">="
181
201
  - !ruby/object:Gem::Version
182
- version: 2.0.9
202
+ version: 2.0.17
183
203
  type: :development
184
204
  prerelease: false
185
205
  version_requirements: !ruby/object:Gem::Requirement
@@ -189,27 +209,27 @@ dependencies:
189
209
  version: '2.0'
190
210
  - - ">="
191
211
  - !ruby/object:Gem::Version
192
- version: 2.0.9
212
+ version: 2.0.17
193
213
  - !ruby/object:Gem::Dependency
194
214
  name: turbo_tests2
195
215
  requirement: !ruby/object:Gem::Requirement
196
216
  requirements:
197
217
  - - "~>"
198
218
  - !ruby/object:Gem::Version
199
- version: '3.1'
219
+ version: '3.2'
200
220
  - - ">="
201
221
  - !ruby/object:Gem::Version
202
- version: 3.1.6
222
+ version: 3.2.4
203
223
  type: :development
204
224
  prerelease: false
205
225
  version_requirements: !ruby/object:Gem::Requirement
206
226
  requirements:
207
227
  - - "~>"
208
228
  - !ruby/object:Gem::Version
209
- version: '3.1'
229
+ version: '3.2'
210
230
  - - ">="
211
231
  - !ruby/object:Gem::Version
212
- version: 3.1.6
232
+ version: 3.2.4
213
233
  - !ruby/object:Gem::Dependency
214
234
  name: ruby-progressbar
215
235
  requirement: !ruby/object:Gem::Requirement
@@ -233,7 +253,7 @@ dependencies:
233
253
  version: '1.0'
234
254
  - - ">="
235
255
  - !ruby/object:Gem::Version
236
- version: 1.0.4
256
+ version: 1.0.8
237
257
  type: :development
238
258
  prerelease: false
239
259
  version_requirements: !ruby/object:Gem::Requirement
@@ -243,7 +263,7 @@ dependencies:
243
263
  version: '1.0'
244
264
  - - ">="
245
265
  - !ruby/object:Gem::Version
246
- version: 1.0.4
266
+ version: 1.0.8
247
267
  - !ruby/object:Gem::Dependency
248
268
  name: gitmoji-regex
249
269
  requirement: !ruby/object:Gem::Requirement
@@ -253,7 +273,7 @@ dependencies:
253
273
  version: '2.0'
254
274
  - - ">="
255
275
  - !ruby/object:Gem::Version
256
- version: 2.0.4
276
+ version: 2.0.11
257
277
  type: :development
258
278
  prerelease: false
259
279
  version_requirements: !ruby/object:Gem::Requirement
@@ -263,7 +283,7 @@ dependencies:
263
283
  version: '2.0'
264
284
  - - ">="
265
285
  - !ruby/object:Gem::Version
266
- version: 2.0.4
286
+ version: 2.0.11
267
287
  - !ruby/object:Gem::Dependency
268
288
  name: appraisal
269
289
  requirement: !ruby/object:Gem::Requirement
@@ -349,7 +369,7 @@ dependencies:
349
369
  version: '0.1'
350
370
  - - ">="
351
371
  - !ruby/object:Gem::Version
352
- version: 0.1.16
372
+ version: 0.1.25
353
373
  type: :development
354
374
  prerelease: false
355
375
  version_requirements: !ruby/object:Gem::Requirement
@@ -359,7 +379,7 @@ dependencies:
359
379
  version: '0.1'
360
380
  - - ">="
361
381
  - !ruby/object:Gem::Version
362
- version: 0.1.16
382
+ version: 0.1.25
363
383
  description: |2
364
384
  Email Condom for your Ruby Server.
365
385
  In Rails, Sinatra, et al, or simply the mail gem: Aids in development, testing, qa, and production troubleshooting of email issues without worrying that emails will get sent to actual live addresses.
@@ -367,28 +387,11 @@ email:
367
387
  - floss@galtzo.com
368
388
  executables: []
369
389
  extensions: []
370
- extra_rdoc_files:
371
- - CHANGELOG.md
372
- - CITATION.cff
373
- - CODE_OF_CONDUCT.md
374
- - CONTRIBUTING.md
375
- - FUNDING.md
376
- - LICENSE.md
377
- - README.md
378
- - RUBOCOP.md
379
- - SECURITY.md
390
+ extra_rdoc_files: []
380
391
  files:
381
392
  - CHANGELOG.md
382
- - CITATION.cff
383
- - CODE_OF_CONDUCT.md
384
- - CONTRIBUTING.md
385
- - FUNDING.md
386
393
  - LICENSE.md
387
- - MIT.md
388
394
  - README.md
389
- - RUBOCOP.md
390
- - SECURITY.md
391
- - certs/pboling.pem
392
395
  - lib/sanitize_email.rb
393
396
  - lib/sanitize_email/bleach.rb
394
397
  - lib/sanitize_email/config.rb
@@ -402,20 +405,21 @@ files:
402
405
  - lib/sanitize_email/rspec_matchers.rb
403
406
  - lib/sanitize_email/test_helpers.rb
404
407
  - lib/sanitize_email/version.rb
405
- - sig/sanitize_email/version.rbs
408
+ - sig/sanitize_email.rbs
406
409
  homepage: https://github.com/galtzo-floss/sanitize_email
407
410
  licenses:
408
411
  - MIT
409
412
  metadata:
410
413
  homepage_uri: https://sanitize-email.galtzo.com
411
- source_code_uri: https://github.com/galtzo-floss/sanitize_email/tree/v2.0.13
412
- changelog_uri: https://github.com/galtzo-floss/sanitize_email/blob/v2.0.13/CHANGELOG.md
414
+ source_code_uri: https://github.com/galtzo-floss/sanitize_email/tree/v2.0.14
415
+ changelog_uri: https://github.com/galtzo-floss/sanitize_email/blob/v2.0.14/CHANGELOG.md
413
416
  bug_tracker_uri: https://github.com/galtzo-floss/sanitize_email/issues
414
- documentation_uri: https://www.rubydoc.info/gems/sanitize_email/2.0.13
417
+ documentation_uri: https://www.rubydoc.info/gems/sanitize_email/2.0.14
415
418
  funding_uri: https://github.com/sponsors/pboling
416
419
  wiki_uri: https://github.com/galtzo-floss/sanitize_email/wiki
417
420
  news_uri: https://www.railsbling.com/tags/sanitize_email
418
421
  discord_uri: https://discord.gg/3qme4XHNKN
422
+ mailing_list_uri: https://www.rubyforum.org/tag/sanitize-email
419
423
  rubygems_mfa_required: 'true'
420
424
  rdoc_options:
421
425
  - "--title"
@@ -440,7 +444,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
440
444
  - !ruby/object:Gem::Version
441
445
  version: '0'
442
446
  requirements: []
443
- rubygems_version: 4.0.10
447
+ rubygems_version: 4.0.17
444
448
  specification_version: 4
445
449
  summary: "\U0001F4E7 Email Condom for your Ruby Server"
446
450
  test_files: []
metadata.gz.sig CHANGED
Binary file
data/CITATION.cff DELETED
@@ -1,20 +0,0 @@
1
- cff-version: 1.2.0
2
- title: "sanitize_email"
3
- message: >-
4
- If you use this work and you want to cite it,
5
- then you can use the metadata from this file.
6
- type: software
7
- authors:
8
- - given-names: "Peter H."
9
- family-names: "Boling"
10
- email: "floss@galtzo.com"
11
- affiliation: "galtzo.com"
12
- orcid: 'https://orcid.org/0009-0008-8519-441X'
13
- identifiers:
14
- - type: url
15
- value: 'https://github.com/galtzo-floss/sanitize_email'
16
- description: "sanitize_email"
17
- repository-code: 'https://github.com/galtzo-floss/sanitize_email'
18
- abstract: >-
19
- sanitize_email
20
- license: See license file
data/CODE_OF_CONDUCT.md DELETED
@@ -1,134 +0,0 @@
1
- # Contributor Covenant Code of Conduct
2
-
3
- ## Our Pledge
4
-
5
- We as members, contributors, and leaders pledge to make participation in our
6
- community a harassment-free experience for everyone, regardless of age, body
7
- size, visible or invisible disability, ethnicity, sex characteristics, gender
8
- identity and expression, level of experience, education, socio-economic status,
9
- nationality, personal appearance, race, caste, color, religion, or sexual
10
- identity and orientation.
11
-
12
- We pledge to act and interact in ways that contribute to an open, welcoming,
13
- diverse, inclusive, and healthy community.
14
-
15
- ## Our Standards
16
-
17
- Examples of behavior that contributes to a positive environment for our
18
- community include:
19
-
20
- * Demonstrating empathy and kindness toward other people
21
- * Being respectful of differing opinions, viewpoints, and experiences
22
- * Giving and gracefully accepting constructive feedback
23
- * Accepting responsibility and apologizing to those affected by our mistakes,
24
- and learning from the experience
25
- * Focusing on what is best not just for us as individuals, but for the overall
26
- community
27
-
28
- Examples of unacceptable behavior include:
29
-
30
- * The use of sexualized language or imagery, and sexual attention or advances of
31
- any kind
32
- * Trolling, insulting or derogatory comments, and personal or political attacks
33
- * Public or private harassment
34
- * Publishing others' private information, such as a physical or email address,
35
- without their explicit permission
36
- * Other conduct which could reasonably be considered inappropriate in a
37
- professional setting
38
-
39
- ## Enforcement Responsibilities
40
-
41
- Community leaders are responsible for clarifying and enforcing our standards of
42
- acceptable behavior and will take appropriate and fair corrective action in
43
- response to any behavior that they deem inappropriate, threatening, offensive,
44
- or harmful.
45
-
46
- Community leaders have the right and responsibility to remove, edit, or reject
47
- comments, commits, code, wiki edits, issues, and other contributions that are
48
- not aligned to this Code of Conduct, and will communicate reasons for moderation
49
- decisions when appropriate.
50
-
51
- ## Scope
52
-
53
- This Code of Conduct applies within all community spaces, and also applies when
54
- an individual is officially representing the community in public spaces.
55
- Examples of representing our community include using an official email address,
56
- posting via an official social media account, or acting as an appointed
57
- representative at an online or offline event.
58
-
59
- ## Enforcement
60
-
61
- Instances of abusive, harassing, or otherwise unacceptable behavior may be
62
- reported to the community leaders responsible for enforcement at
63
- [![Contact Maintainer][🚂maint-contact-img]][🚂maint-contact].
64
- All complaints will be reviewed and investigated promptly and fairly.
65
-
66
- All community leaders are obligated to respect the privacy and security of the
67
- reporter of any incident.
68
-
69
- ## Enforcement Guidelines
70
-
71
- Community leaders will follow these Community Impact Guidelines in determining
72
- the consequences for any action they deem in violation of this Code of Conduct:
73
-
74
- ### 1. Correction
75
-
76
- **Community Impact**: Use of inappropriate language or other behavior deemed
77
- unprofessional or unwelcome in the community.
78
-
79
- **Consequence**: A private, written warning from community leaders, providing
80
- clarity around the nature of the violation and an explanation of why the
81
- behavior was inappropriate. A public apology may be requested.
82
-
83
- ### 2. Warning
84
-
85
- **Community Impact**: A violation through a single incident or series of
86
- actions.
87
-
88
- **Consequence**: A warning with consequences for continued behavior. No
89
- interaction with the people involved, including unsolicited interaction with
90
- those enforcing the Code of Conduct, for a specified period of time. This
91
- includes avoiding interactions in community spaces as well as external channels
92
- like social media. Violating these terms may lead to a temporary or permanent
93
- ban.
94
-
95
- ### 3. Temporary Ban
96
-
97
- **Community Impact**: A serious violation of community standards, including
98
- sustained inappropriate behavior.
99
-
100
- **Consequence**: A temporary ban from any sort of interaction or public
101
- communication with the community for a specified period of time. No public or
102
- private interaction with the people involved, including unsolicited interaction
103
- with those enforcing the Code of Conduct, is allowed during this period.
104
- Violating these terms may lead to a permanent ban.
105
-
106
- ### 4. Permanent Ban
107
-
108
- **Community Impact**: Demonstrating a pattern of violation of community
109
- standards, including sustained inappropriate behavior, harassment of an
110
- individual, or aggression toward or disparagement of classes of individuals.
111
-
112
- **Consequence**: A permanent ban from any sort of public interaction within the
113
- community.
114
-
115
- ## Attribution
116
-
117
- This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118
- version 2.1, available at
119
- [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120
-
121
- Community Impact Guidelines were inspired by
122
- [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123
-
124
- For answers to common questions about this code of conduct, see the FAQ at
125
- [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
126
- [https://www.contributor-covenant.org/translations][translations].
127
-
128
- [homepage]: https://www.contributor-covenant.org
129
- [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130
- [Mozilla CoC]: https://github.com/mozilla/diversity
131
- [FAQ]: https://www.contributor-covenant.org/faq
132
- [translations]: https://www.contributor-covenant.org/translations
133
- [🚂maint-contact]: http://www.railsbling.com/contact
134
- [🚂maint-contact-img]: https://img.shields.io/badge/Contact-Maintainer-0093D0.svg?style=flat&logo=rubyonrails&logoColor=red
data/CONTRIBUTING.md DELETED
@@ -1,275 +0,0 @@
1
- # Contributing
2
-
3
- Bug reports and pull requests are welcome on [CodeBerg][📜src-cb], [GitLab][📜src-gl], or [GitHub][📜src-gh].
4
- This project should be a safe, welcoming space for collaboration, so contributors agree to adhere to
5
- the [code of conduct][🤝conduct].
6
-
7
- To submit a patch, please fork the project, create a patch with tests, and send a pull request.
8
-
9
- Remember to [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog] if you make changes.
10
-
11
- ## Developer Certificate of Origin
12
-
13
- In order to protect users of this project, we require all contributors to comply with the
14
- [Developer Certificate of Origin](https://developercertificate.org/).
15
- This ensures that all contributions are properly licensed and attributed.
16
-
17
- ## Help out!
18
-
19
- Take a look at the open issues and pull requests, or use the gem and find something to improve.
20
-
21
- Follow these instructions:
22
-
23
- 1. Join the Discord: [![Live Chat on Discord][✉️discord-invite-img]][✉️discord-invite]
24
- 2. Fork the repository
25
- 3. Create your feature branch (`git checkout -b my-new-feature`)
26
- 4. Make some fixes.
27
- 5. Commit your changes (`git commit -am 'Added some feature'`)
28
- 6. Push to the branch (`git push origin my-new-feature`)
29
- 7. Make sure to add tests for it. This is important, so it doesn't break in a future release.
30
- 8. Create new Pull Request.
31
- 9. Announce it in the channel for this org in the [Discord][✉️discord-invite]!
32
-
33
- ## Executables vs Rake tasks
34
-
35
- Executables shipped by dependencies, such as kettle-dev, and stone_checksums, are available
36
- after running `bin/setup`. These include:
37
-
38
- - gem_checksums
39
- - kettle-changelog
40
- - kettle-commit-msg
41
- - kettle-dev-setup
42
- - kettle-dvcs
43
- - kettle-pre-release
44
- - kettle-readme-backers
45
- - kettle-release
46
-
47
- There are many Rake tasks available as well. You can see them by running:
48
-
49
- ```shell
50
- bin/rake -T
51
- ```
52
-
53
- ## Code quality checks
54
-
55
- Run the Reek task when you want a smell check that fails on current findings:
56
-
57
- ```shell
58
- bin/rake reek
59
- ```
60
-
61
- Refresh the checked-in `REEK` backlog through the rake task, not by redirecting
62
- the raw `reek` executable output. The rake task uses the project bundle and
63
- avoids stale generated binstubs shadowing the Reek gem executable:
64
-
65
- ```shell
66
- bin/rake reek:update
67
- ```
68
-
69
- ## Environment Variables for Local Development
70
-
71
- Below are the primary environment variables recognized by stone_checksums (and its integrated tools). Unless otherwise noted, set boolean values to the string "true" to enable.
72
-
73
- General/runtime
74
- - DEBUG: Enable extra internal logging for this library (default: false)
75
- - REQUIRE_BENCH: Enable `require_bench` to profile requires (default: false)
76
- - CI: When set to true, adjusts default rake tasks toward CI behavior
77
-
78
- Coverage (kettle-soup-cover / SimpleCov)
79
- - K_SOUP_COV_DO: Enable coverage collection (default: true in `mise.toml`)
80
- - K_SOUP_COV_FORMATTERS: Comma-separated list of formatters (html, xml, rcov, lcov, json, tty)
81
- - K_SOUP_COV_MIN_LINE: Minimum line coverage threshold (integer, e.g., 100)
82
- - K_SOUP_COV_MIN_BRANCH: Minimum branch coverage threshold (integer, e.g., 100)
83
- - K_SOUP_COV_MIN_HARD: Fail the run if thresholds are not met (true/false)
84
- - K_SOUP_COV_MULTI_FORMATTERS: Enable multiple formatters at once (true/false)
85
- - K_SOUP_COV_OPEN_BIN: Path to browser opener for HTML (empty disables auto-open)
86
- - MAX_ROWS: Limit console output rows for simplecov-console (e.g., 1)
87
- Tip: When running a single spec file locally, you may want `K_SOUP_COV_MIN_HARD=false` to avoid failing thresholds for a partial run.
88
-
89
- GitHub API and CI helpers
90
- - GITHUB_TOKEN or GH_TOKEN: Token used by `ci:act` and release workflow checks to query GitHub Actions status at higher rate limits
91
-
92
- Releasing and signing
93
- - SKIP_GEM_SIGNING: If set, skip gem signing during build/release
94
- - GEM_CERT_USER: Username for selecting your public cert in `certs/<USER>.pem` (defaults to $USER)
95
- - SOURCE_DATE_EPOCH: Reproducible build timestamp.
96
- - `kettle-release` will set this automatically for the session.
97
- - Not needed on bundler >= 2.7.0, as reproducible builds have become the default.
98
-
99
- Git hooks and commit message helpers (exe/kettle-commit-msg)
100
- - GIT_HOOK_BRANCH_VALIDATE: Branch name validation mode (e.g., `jira`) or `false` to disable
101
- - GIT_HOOK_FOOTER_APPEND: Append a footer to commit messages when goalie allows (true/false)
102
- - GIT_HOOK_FOOTER_SENTINEL: Required when footer append is enabled — a unique first-line sentinel to prevent duplicates
103
- - GIT_HOOK_FOOTER_APPEND_DEBUG: Extra debug output in the footer template (true/false)
104
-
105
- Git diff driver setup
106
- - Local setup writes repository `.gitattributes` entries and local Git `diff.smorg-*` command config so this checkout uses StructuredMerge semantic diffs.
107
- - Global setup registers `diff.smorg-*` commands once in the user Git config; use it when you work across several StructuredMerge-enabled repositories.
108
- - Include-file setup writes `.git/smorg/config` and includes it from local Git config, keeping command registrations out of the repository files.
109
- - Git hosting forges generally ignore external diff drivers, so pull request views may still show raw textual diffs even when local `git diff` uses semantic drivers.
110
-
111
- ```console
112
- K_JEM_TEMPLATING=true kettle-jem install
113
- ```
114
-
115
- Troubleshooting Git diffs
116
- - Use `git diff --no-ext-diff` to compare against Git's built-in diff output.
117
- - Use `git diff --no-textconv` when a textconv projection obscures the raw file bytes you need to inspect.
118
- - If Git reports a missing `smorg-*` executable, rerun `bundle install` and the setup command above, then check `git config --local --get-regexp '^diff\.smorg-'`.
119
- - To remove managed local entries, run `K_JEM_TEMPLATING=true kettle-jem install --undo`; remove global command registrations with `git config --global --unset-all diff.smorg-ruby.command`.
120
-
121
- For a quick starting point, this repository’s `mise.toml` defines the shared defaults, and `.env.local` can override them locally. Copy `.env.local.example` to `.env.local`, use `KEY=value` lines, and either activate `mise` in your shell or run commands through `mise exec -C /path/to/project -- ...`.
122
-
123
- ## Appraisals
124
-
125
- From time to time the [appraisal2][🚎appraisal2] gemfiles in `gemfiles/` will need to be updated.
126
- Generated appraisal and CI workflow floors are controlled by `ruby.test_minimum`
127
- in `.structuredmerge/kettle-jem.yml`; this project was templated with `ruby.test_minimum: 2.4`.
128
- That value describes the lowest Ruby version expected to run the test/development
129
- toolchain, and it may be higher than the gemspec runtime floor.
130
-
131
- They are created and updated with the commands:
132
-
133
- ```console
134
- bin/rake appraisal:generate
135
- ```
136
-
137
- Use `bin/rake appraisal:update` when you intentionally need to resolve fresh
138
- appraisal locks.
139
-
140
- If you need to reset all gemfiles/*.gemfile.lock files:
141
-
142
- ```console
143
- bin/rake appraisal:reset
144
- ```
145
-
146
- When adding an appraisal to CI, check the [runner tool cache][🏃‍♂️runner-tool-cache] to see which runner to use.
147
-
148
- ## Run Tests
149
-
150
- Run tests via `kettle-test` (provided by `kettle-test`). It runs RSpec, writes the full log to
151
- `tmp/kettle-test/rspec-TIMESTAMP.log`, and prints a compact highlight block with timing, seed,
152
- pass/fail count, failing example list, and SimpleCov coverage percentages.
153
-
154
- ```console
155
- bundle exec kettle-test
156
- ```
157
-
158
- For targeted runs, disable the hard coverage threshold to avoid false failures:
159
-
160
- ```console
161
- K_SOUP_COV_MIN_HARD=false bundle exec kettle-test spec/path/to/spec.rb
162
- ```
163
-
164
- ### Spec organization (required)
165
-
166
- - One spec file per class/module. For each class or module under `lib/`, keep all of its unit tests in a single spec file under `spec/` that mirrors the path and file name exactly: `lib/sanitize_email/my_class.rb` -> `spec/sanitize_email/my_class_spec.rb`.
167
- - Exception: Integration specs that intentionally span multiple classes. Place these under `spec/integration/` (or a clearly named integration folder), and do not directly mirror a single class. Name them after the scenario, not a class.
168
-
169
- ## Lint It
170
-
171
- Run all the default tasks, which includes running the gradually autocorrecting linter, `rubocop-gradual`.
172
-
173
- ```console
174
- bundle exec rake
175
- ```
176
-
177
- Or just run the linter.
178
-
179
- ```console
180
- bundle exec rake rubocop_gradual:autocorrect
181
- ```
182
-
183
- For more detailed information about using RuboCop in this project, please see the [RUBOCOP.md](RUBOCOP.md) guide. This project uses `rubocop_gradual` instead of vanilla RuboCop, which requires specific commands for checking violations.
184
-
185
- ### Important: Do not add inline RuboCop disables
186
-
187
- Never add `# rubocop:disable ...` / `# rubocop:enable ...` comments to code or specs (except when following the few existing `rubocop:disable` patterns for a rule already being disabled elsewhere in the code). Instead:
188
-
189
- - Prefer configuration-based exclusions when a rule should not apply to certain paths or files (e.g., via `.rubocop.yml`).
190
- - When a violation is temporary, and you plan to fix it later, record it in `.rubocop_gradual.lock` using the gradual workflow:
191
- - `bundle exec rake rubocop_gradual:autocorrect` (preferred)
192
- - `bundle exec rake rubocop_gradual:force_update` (only when you cannot fix the violations immediately)
193
-
194
- As a general rule, fix style issues rather than ignoring them. For example, our specs should follow RSpec conventions like using `described_class` for the class under test.
195
-
196
- ## Contributors
197
-
198
- Your picture could be here!
199
-
200
- [![Contributors][🖐contributors-img]][🖐contributors]
201
-
202
- Made with [contributors-img][🖐contrib-rocks].
203
-
204
- Also see GitLab Contributors: [https://gitlab.com/galtzo-floss/sanitize_email/-/graphs/main][🚎contributors-gl]
205
-
206
- ## For Maintainers
207
-
208
- ### One-time, Per-maintainer, Setup
209
-
210
- **IMPORTANT**: To sign a build,
211
- a public key for signing gems will need to be picked up by the line in the
212
- `gemspec` defining the `spec.cert_chain` (check the relevant ENV variables there).
213
- All releases are signed releases.
214
- See: [RubyGems Security Guide][🔒️rubygems-security-guide]
215
-
216
- NOTE: To build without signing the gem set `SKIP_GEM_SIGNING` to any value in the environment.
217
-
218
- ### To release a new version:
219
-
220
- #### Automated process
221
-
222
- 1. Update version.rb to contain the correct version-to-be-released.
223
- 2. Run `bundle exec kettle-changelog`.
224
- 3. Run `bundle exec kettle-release`.
225
- 4. Stay awake and monitor the release process for any errors, and answer any prompts.
226
-
227
- #### Manual process
228
-
229
- 1. Run `bin/setup && bin/rake` as a "test, coverage, & linting" sanity check
230
- 2. Update the version number in `version.rb`, and ensure `CHANGELOG.md` reflects changes
231
- 3. Run `bin/setup && bin/rake` again as a secondary check, and to update `Gemfile.lock`
232
- 4. Run `bin/rake yard` to regenerate the docs site using the canonical docs task
233
- 5. Run `git commit -am "🔖 Prepare release v<VERSION>"` to commit the changes
234
- 6. Run `git push` to trigger the final CI pipeline before release, and merge PRs
235
- - NOTE: Remember to [check the build][🧪build].
236
- 7. Run `export GIT_TRUNK_BRANCH_NAME="$(git remote show origin | grep 'HEAD branch' | cut -d ' ' -f5)" && echo $GIT_TRUNK_BRANCH_NAME`
237
- 8. Run `git checkout $GIT_TRUNK_BRANCH_NAME`
238
- 9. Run `git pull origin $GIT_TRUNK_BRANCH_NAME` to ensure latest trunk code
239
- 10. Optional for older Bundler (< 2.7.0): Set `SOURCE_DATE_EPOCH` so `rake build` and `rake release` use the same timestamp and generate the same checksums
240
- - If your Bundler is >= 2.7.0, you can skip this; builds are reproducible by default.
241
- - Run `export SOURCE_DATE_EPOCH=$EPOCHSECONDS && echo $SOURCE_DATE_EPOCH`
242
- - If the echo above has no output, then it didn't work.
243
- - Note: `zsh/datetime` module is needed, if running `zsh`.
244
- - In older versions of `bash` you can use `date +%s` instead, i.e. `export SOURCE_DATE_EPOCH=$(date +%s) && echo $SOURCE_DATE_EPOCH`
245
- 11. Run `bundle exec rake build`
246
- 12. Run `bin/gem_checksums` (more context [1][🔒️rubygems-checksums-pr], [2][🔒️rubygems-guides-pr])
247
- to create SHA-256 and SHA-512 checksums. This functionality is provided by the `stone_checksums`
248
- [gem][💎stone_checksums].
249
- - The script automatically commits but does not push the checksums
250
- 13. Sanity check the SHA256, comparing with the output from the `bin/gem_checksums` command:
251
- - `sha256sum pkg/<gem name>-<version>.gem`
252
- 14. Run `bundle exec rake release` which will create a git tag for the version,
253
- push git commits and tags, and push the `.gem` file to the gem host configured in the gemspec.
254
-
255
- [📜src-gl]: https://gitlab.com/galtzo-floss/sanitize_email
256
- [📜src-cb]: https://codeberg.org/galtzo-floss/sanitize_email
257
- [📜src-gh]: https://github.com/galtzo-floss/sanitize_email
258
- [🧪build]: https://github.com/galtzo-floss/sanitize_email/actions
259
- [🤝conduct]: https://github.com/galtzo-floss/sanitize_email/blob/main/CODE_OF_CONDUCT.md
260
- [🖐contrib-rocks]: https://contrib.rocks
261
- [🖐contributors]: https://github.com/galtzo-floss/sanitize_email/graphs/contributors
262
- [🚎contributors-gl]: https://gitlab.com/galtzo-floss/sanitize_email/-/graphs/main
263
- [🖐contributors-img]: https://contrib.rocks/image?repo=galtzo-floss/sanitize_email
264
- [💎gem-coop]: https://gem.coop
265
- [🔒️rubygems-security-guide]: https://guides.rubygems.org/security/#building-gems
266
- [🔒️rubygems-checksums-pr]: https://github.com/rubygems/rubygems/pull/6022
267
- [🔒️rubygems-guides-pr]: https://github.com/rubygems/guides/pull/325
268
- [💎stone_checksums]: https://github.com/galtzo-floss/stone_checksums
269
- [📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
270
- [📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-FFDD67.svg?style=flat
271
- [📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
272
- [📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
273
- [🚎appraisal2]: https://github.com/appraisal-rb/appraisal2
274
- [🏃‍♂️runner-tool-cache]: https://github.com/ruby/ruby-builder/releases/tag/toolcache
275
- [✉️discord-invite]: https://discord.gg/3qme4XHNKN
data/FUNDING.md DELETED
@@ -1,70 +0,0 @@
1
- <!-- RELEASE-NOTES-FOOTER-START -->
2
-
3
- Official Discord 👉️ [![Live Chat on Discord][✉️discord-invite-img]][✉️discord-invite]
4
-
5
- Many paths lead to being a sponsor or a backer of this project. Are you on such a path?
6
-
7
- [![OpenCollective Backers][🖇osc-backers-i]][🖇osc-backers] [![OpenCollective Sponsors][🖇osc-sponsors-i]][🖇osc-sponsors] [![Sponsor Me on Github][🖇sponsor-img]][🖇sponsor] [![Liberapay Goal Progress][⛳liberapay-img]][⛳liberapay] [![Donate on PayPal][🖇paypal-img]][🖇paypal]
8
-
9
- [![Buy me a coffee][🖇buyme-small-img]][🖇buyme] [![Donate to my FLOSS efforts at ko-fi.com][🖇kofi-img]][🖇kofi]
10
-
11
- [⛳liberapay-img]: https://img.shields.io/liberapay/goal/pboling.svg?logo=liberapay&color=a51611&style=flat
12
- [⛳liberapay]: https://liberapay.com/pboling/donate
13
- [🖇osc-backers]: https://opencollective.com/galtzo-floss#backer
14
- [🖇osc-backers-i]: https://opencollective.com/galtzo-floss/backers/badge.svg?style=flat
15
- [🖇osc-sponsors]: https://opencollective.com/galtzo-floss#sponsor
16
- [🖇osc-sponsors-i]: https://opencollective.com/galtzo-floss/sponsors/badge.svg?style=flat
17
- [🖇sponsor-img]: https://img.shields.io/badge/Sponsor_Me!-pboling.svg?style=social&logo=github
18
- [🖇sponsor]: https://github.com/sponsors/pboling
19
- [🖇kofi-img]: https://img.shields.io/badge/ko--fi-%E2%9C%93-a51611.svg?style=flat
20
- [🖇kofi]: https://ko-fi.com/pboling
21
- [🖇buyme-small-img]: https://img.shields.io/badge/buy_me_a_coffee-%E2%9C%93-a51611.svg?style=flat
22
- [🖇buyme]: https://www.buymeacoffee.com/pboling
23
- [🖇paypal-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=flat&logo=paypal
24
- [🖇paypal]: https://www.paypal.com/paypalme/peterboling
25
- [✉️discord-invite]: https://discord.gg/3qme4XHNKN
26
- [✉️discord-invite-img]: https://img.shields.io/discord/1373797679469170758?style=flat
27
-
28
- <!-- RELEASE-NOTES-FOOTER-END -->
29
-
30
- # 🤑 A request for help
31
-
32
- Maintainers have teeth and need to pay their dentists.
33
- After getting laid off in an RIF in March, and encountering difficulty finding a new one,
34
- I began spending most of my time building open source tools.
35
- I'm hoping to be able to pay for my kids' health insurance this month,
36
- so if you value the work I am doing, I need your support.
37
- Please consider sponsoring me or the project.
38
-
39
- To join the community or get help 👇️ Join the Discord.
40
-
41
- [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite]
42
-
43
- To say "thanks!" ☝️ Join the Discord or 👇️ send money.
44
-
45
- [![Sponsor galtzo-floss/sanitize_email on Open Source Collective][🖇osc-all-bottom-img]][🖇osc] 💌 [![Sponsor me on GitHub Sponsors][🖇sponsor-bottom-img]][🖇sponsor] 💌 [![Sponsor me on Liberapay][⛳liberapay-bottom-img]][⛳liberapay] 💌 [![Donate on PayPal][🖇paypal-bottom-img]][🖇paypal]
46
-
47
- # Another Way to Support Open Source Software
48
-
49
- I’m driven by a passion to foster a thriving open-source community – a space where people can tackle complex problems, no matter how small. Revitalizing libraries that have fallen into disrepair, and building new libraries focused on solving real-world challenges, are my passions. I was recently affected by layoffs, and the tech jobs market is unwelcoming. I’m reaching out here because your support would significantly aid my efforts to provide for my family, and my farm (11 🐔 chickens, 2 🐶 dogs, 3 🐰 rabbits, 8 🐈‍ cats).
50
-
51
- If you work at a company that uses my work, please encourage them to support me as a corporate sponsor. My work on gems you use might show up in `bundle fund`.
52
-
53
- I’m developing a new library, [floss_funding][🖇floss-funding-gem], designed to empower open-source developers like myself to get paid for the work we do, in a sustainable way. Please give it a look.
54
-
55
- **[Floss-Funding.dev][🖇floss-funding.dev]: 👉️ No network calls. 👉️ No tracking. 👉️ No oversight. 👉️ Minimal crypto hashing. 💡 Easily disabled nags**
56
-
57
- [⛳liberapay-bottom-img]: https://img.shields.io/liberapay/goal/pboling.svg?style=for-the-badge&logo=liberapay&color=a51611
58
- [🖇osc-all-img]: https://img.shields.io/opencollective/all/galtzo-floss
59
- [🖇osc-sponsors-img]: https://img.shields.io/opencollective/sponsors/galtzo-floss
60
- [🖇osc-backers-img]: https://img.shields.io/opencollective/backers/galtzo-floss
61
- [🖇osc-all-bottom-img]: https://img.shields.io/opencollective/all/galtzo-floss?style=for-the-badge
62
- [🖇osc-sponsors-bottom-img]: https://img.shields.io/opencollective/sponsors/galtzo-floss?style=for-the-badge
63
- [🖇osc-backers-bottom-img]: https://img.shields.io/opencollective/backers/galtzo-floss?style=for-the-badge
64
- [🖇osc]: https://opencollective.com/galtzo-floss
65
- [🖇sponsor-bottom-img]: https://img.shields.io/badge/Sponsor_Me!-pboling-blue?style=for-the-badge&logo=github
66
- [🖇buyme-img]: https://img.buymeacoffee.com/button-api/?text=Buy%20me%20a%20latte&emoji=&slug=pboling&button_colour=FFDD00&font_colour=000000&font_family=Cookie&outline_colour=000000&coffee_colour=ffffff
67
- [🖇paypal-bottom-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=for-the-badge&logo=paypal&color=0A0A0A
68
- [🖇floss-funding.dev]: https://floss-funding.dev
69
- [🖇floss-funding-gem]: https://github.com/galtzo-floss/floss_funding
70
- [✉️discord-invite-img-ftb]: https://img.shields.io/discord/1373797679469170758?style=for-the-badge
data/MIT.md DELETED
@@ -1,21 +0,0 @@
1
- The MIT License (MIT)
2
-
3
- See [LICENSE.md](LICENSE.md) for the copyright notice.
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in
13
- all copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
- THE SOFTWARE.
data/RUBOCOP.md DELETED
@@ -1,71 +0,0 @@
1
- # RuboCop Usage Guide
2
-
3
- ## Overview
4
-
5
- A tale of two RuboCop plugin gems.
6
-
7
- ### RuboCop Gradual
8
-
9
- This project uses `rubocop_gradual` instead of vanilla RuboCop for code style checking. The `rubocop_gradual` tool allows for gradual adoption of RuboCop rules by tracking violations in a lock file.
10
-
11
- ### RuboCop LTS
12
-
13
- This project uses `rubocop-lts` to ensure, on a best-effort basis, compatibility with Ruby >= 1.9.2.
14
- RuboCop rules are meticulously configured by the `rubocop-lts` family of gems to ensure that a project is compatible with a specific version of Ruby. See: https://rubocop-lts.gitlab.io for more.
15
-
16
- ## Checking RuboCop Violations
17
-
18
- To check for RuboCop violations in this project, always use:
19
-
20
- ```bash
21
- bundle exec rake rubocop_gradual:check
22
- ```
23
-
24
- **Do not use** the standard RuboCop commands like:
25
- - `bundle exec rubocop`
26
- - `rubocop`
27
-
28
- ## Understanding the Lock File
29
-
30
- The `.rubocop_gradual.lock` file tracks all current RuboCop violations in the project. This allows the team to:
31
-
32
- 1. Prevent new violations while gradually fixing existing ones
33
- 2. Track progress on code style improvements
34
- 3. Ensure CI builds don't fail due to pre-existing violations
35
-
36
- ## Common Commands
37
-
38
- - **Check violations**
39
- - `bundle exec rake rubocop_gradual`
40
- - `bundle exec rake rubocop_gradual:check`
41
- - **(Safe) Autocorrect violations, and update lockfile if no new violations**
42
- - `bundle exec rake rubocop_gradual:autocorrect`
43
- - **Force update the lock file (w/o autocorrect) to match violations present in code**
44
- - `bundle exec rake rubocop_gradual:force_update`
45
-
46
- ## Workflow
47
-
48
- 1. Before submitting a PR, run `bundle exec rake rubocop_gradual:autocorrect`
49
- a. or just the default `bundle exec rake`, as autocorrection is a pre-requisite of the default task.
50
- 2. If there are new violations, either:
51
- - Fix them in your code
52
- - Run `bundle exec rake rubocop_gradual:force_update` to update the lock file (only for violations you can't fix immediately)
53
- 3. Commit the updated `.rubocop_gradual.lock` file along with your changes
54
-
55
- ## Never add inline RuboCop disables
56
-
57
- Do not add inline `rubocop:disable` / `rubocop:enable` comments anywhere in the codebase (including specs, except when following the few existing `rubocop:disable` patterns for a rule already being disabled elsewhere in the code). We handle exceptions in two supported ways:
58
-
59
- - Permanent/structural exceptions: prefer adjusting the RuboCop configuration (e.g., in `.rubocop.yml`) to exclude a rule for a path or file pattern when it makes sense project-wide.
60
- - Temporary exceptions while improving code: record the current violations in `.rubocop_gradual.lock` via the gradual workflow:
61
- - `bundle exec rake rubocop_gradual:autocorrect` (preferred; will autocorrect what it can and update the lock only if no new violations were introduced)
62
- - If needed, `bundle exec rake rubocop_gradual:force_update` (as a last resort when you cannot fix the newly reported violations immediately)
63
-
64
- In general, treat the rules as guidance to follow; fix violations rather than ignore them. For example, RSpec conventions in this project expect `described_class` to be used in specs that target a specific class under test.
65
-
66
- ## Benefits of rubocop_gradual
67
-
68
- - Allows incremental adoption of code style rules
69
- - Prevents CI failures due to pre-existing violations
70
- - Provides a clear record of code style debt
71
- - Enables focused efforts on improving code quality over time
data/SECURITY.md DELETED
@@ -1,21 +0,0 @@
1
- # Security Policy
2
-
3
- ## Supported Versions
4
-
5
- | Version | Supported |
6
- |----------|-----------|
7
- | 2.0.latest | ✅ |
8
-
9
- ## Security contact information
10
-
11
- To report a security vulnerability, please use the
12
- [Tidelift security contact](https://tidelift.com/security).
13
- Tidelift will coordinate the fix and disclosure.
14
-
15
- ## Additional Support
16
-
17
- If you are interested in support for versions older than the latest release,
18
- please consider sponsoring the project / maintainer @ https://liberapay.com/pboling/donate,
19
- or find other sponsorship links in the [README].
20
-
21
- [README]: README.md
data/certs/pboling.pem DELETED
@@ -1,27 +0,0 @@
1
- -----BEGIN CERTIFICATE-----
2
- MIIEgDCCAuigAwIBAgIBATANBgkqhkiG9w0BAQsFADBDMRUwEwYDVQQDDAxwZXRl
3
- ci5ib2xpbmcxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkW
4
- A2NvbTAeFw0yNTA1MDQxNTMzMDlaFw00NTA0MjkxNTMzMDlaMEMxFTATBgNVBAMM
5
- DHBldGVyLmJvbGluZzEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPy
6
- LGQBGRYDY29tMIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEAruUoo0WA
7
- uoNuq6puKWYeRYiZekz/nsDeK5x/0IEirzcCEvaHr3Bmz7rjo1I6On3gGKmiZs61
8
- LRmQ3oxy77ydmkGTXBjruJB+pQEn7UfLSgQ0xa1/X3kdBZt6RmabFlBxnHkoaGY5
9
- mZuZ5+Z7walmv6sFD9ajhzj+oIgwWfnEHkXYTR8I6VLN7MRRKGMPoZ/yvOmxb2DN
10
- coEEHWKO9CvgYpW7asIihl/9GMpKiRkcYPm9dGQzZc6uTwom1COfW0+ZOFrDVBuV
11
- FMQRPswZcY4Wlq0uEBLPU7hxnCL9nKK6Y9IhdDcz1mY6HZ91WImNslOSI0S8hRpj
12
- yGOWxQIhBT3fqCBlRIqFQBudrnD9jSNpSGsFvbEijd5ns7Z9ZMehXkXDycpGAUj1
13
- to/5cuTWWw1JqUWrKJYoifnVhtE1o1DZ+LkPtWxHtz5kjDG/zR3MG0Ula0UOavlD
14
- qbnbcXPBnwXtTFeZ3C+yrWpE4pGnl3yGkZj9SMTlo9qnTMiPmuWKQDatAgMBAAGj
15
- fzB9MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBQE8uWvNbPVNRXZ
16
- HlgPbc2PCzC4bjAhBgNVHREEGjAYgRZwZXRlci5ib2xpbmdAZ21haWwuY29tMCEG
17
- A1UdEgQaMBiBFnBldGVyLmJvbGluZ0BnbWFpbC5jb20wDQYJKoZIhvcNAQELBQAD
18
- ggGBAJbnUwfJQFPkBgH9cL7hoBfRtmWiCvdqdjeTmi04u8zVNCUox0A4gT982DE9
19
- wmuN12LpdajxZONqbXuzZvc+nb0StFwmFYZG6iDwaf4BPywm2e/Vmq0YG45vZXGR
20
- L8yMDSK1cQXjmA+ZBKOHKWavxP6Vp7lWvjAhz8RFwqF9GuNIdhv9NpnCAWcMZtpm
21
- GUPyIWw/Cw/2wZp74QzZj6Npx+LdXoLTF1HMSJXZ7/pkxLCsB8m4EFVdb/IrW/0k
22
- kNSfjtAfBHO8nLGuqQZVH9IBD1i9K6aSs7pT6TW8itXUIlkIUI2tg5YzW6OFfPzq
23
- QekSkX3lZfY+HTSp/o+YvKkqWLUV7PQ7xh1ZYDtocpaHwgxe/j3bBqHE+CUPH2vA
24
- 0V/FwdTRWcwsjVoOJTrYcff8pBZ8r2MvtAc54xfnnhGFzeRHfcltobgFxkAXdE6p
25
- DVjBtqT23eugOqQ73umLcYDZkc36vnqGxUBSsXrzY9pzV5gGr2I8YUxMqf6ATrZt
26
- L9nRqA==
27
- -----END CERTIFICATE-----