Skip to content

Commit 854c82c

Browse files
pbolingpboling
committed
📝 Improve markdown
1 parent 9786e18 commit 854c82c

File tree

3 files changed

+68
-59
lines changed

3 files changed

+68
-59
lines changed

‎CHANGELOG.md

+10
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1010
### Fixed
1111
### Removed
1212

13+
## 3.1.1 - 2024-09-25
14+
- COVERAGE: 91.81% -- 3520/3834 lines in 49 files
15+
- BRANCH COVERAGE: 87.03% -- 1074/1234 branches in 49 files
16+
- 63.08% documented
17+
### Added
18+
- Improved Documentation
19+
### Fixed
20+
- Documentation typos
21+
- Documentation in Yard (on RubyDoc.info)
22+
1323
## 3.1.0 - 2024-09-24
1424
- COVERAGE: 91.81% -- 3520/3834 lines in 49 files
1525
- BRANCH COVERAGE: 87.03% -- 1074/1234 branches in 49 files

‎README.md

+52-53
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Ruby OpenID
22

3-
<div id="badges">
4-
53
[![Version](https://img.shields.io/gem/v/ruby-openid2.svg)](https://rubygems.org/gems/ruby-openid2)
64
[![Downloads Today](https://img.shields.io/gem/rd/ruby-openid2.svg)](https://github.com/oauth-xx/ruby-openid2)
75
[![CI Supported Build][🚎s-wfi]][🚎s-wf]
@@ -10,6 +8,14 @@
108
[![CI Coverage Build][🚎cov-wfi]][🚎cov-wf]
119
[![CI Heads Build][🚎hd-wfi]][🚎hd-wf]
1210

11+
-----
12+
13+
[![Liberapay Patrons][⛳liberapay-img]][⛳liberapay]
14+
[![Sponsor Me on Github][🖇sponsor-img]][🖇sponsor]
15+
[![Polar Shield][🖇polar-img]][🖇polar]
16+
[![Donate to my FLOSS or refugee efforts at ko-fi.com][🖇kofi-img]][🖇kofi]
17+
[![Donate to my FLOSS or refugee efforts using Patreon][🖇patreon-img]][🖇patreon]
18+
1319
[🚎s-wf]: https://github.com/oauth-xx/ruby-openid2/actions/workflows/supported.yml
1420
[🚎s-wfi]: https://github.com/oauth-xx/ruby-openid2/actions/workflows/supported.yml/badge.svg
1521
[🚎us-wf]: https://github.com/oauth-xx/ruby-openid2/actions/workflows/unsupported.yml
@@ -21,16 +27,6 @@
2127
[🚎hd-wf]: https://github.com/oauth-xx/ruby-openid2/actions/workflows/heads.yml
2228
[🚎hd-wfi]: https://github.com/oauth-xx/ruby-openid2/actions/workflows/heads.yml/badge.svg
2329

24-
-----
25-
26-
<div align="center">
27-
28-
[![Liberapay Patrons][⛳liberapay-img]][⛳liberapay]
29-
[![Sponsor Me on Github][🖇sponsor-img]][🖇sponsor]
30-
[![Polar Shield][🖇polar-img]][🖇polar]
31-
[![Donate to my FLOSS or refugee efforts at ko-fi.com][🖇kofi-img]][🖇kofi]
32-
[![Donate to my FLOSS or refugee efforts using Patreon][🖇patreon-img]][🖇patreon]
33-
3430
[⛳liberapay-img]: https://img.shields.io/liberapay/patrons/pboling.svg?logo=liberapay
3531
[⛳liberapay]: https://liberapay.com/pboling/donate
3632
[🖇sponsor-img]: https://img.shields.io/badge/Sponsor_Me!-pboling.svg?style=social&logo=github
@@ -42,13 +38,6 @@
4238
[🖇patreon-img]: https://img.shields.io/badge/patreon-donate-yellow.svg
4339
[🖇patreon]: https://patreon.com/galtzo
4440

45-
<span class="badge-buymealatte">
46-
<a href="https://www.buymeacoffee.com/pboling"><img src="https://img.buymeacoffee.com/button-api/?text=Buy me a latte&emoji=&slug=pboling&button_colour=FFDD00&font_colour=000000&font_family=Cookie&outline_colour=000000&coffee_colour=ffffff" /></a>
47-
</span>
48-
49-
</div>
50-
</div>
51-
5241
A Ruby library for verifying and serving OpenID identities.
5342

5443
## Features
@@ -76,34 +65,6 @@ If bundler is not being used to manage dependencies, install the gem by executin
7665

7766
$ gem install ruby-openid2
7867

79-
| Primary Namespace | OpenID |
80-
|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
81-
| gem name | [ruby-openid2](https://rubygems.org/gems/ruby-openid2) |
82-
| code triage | [![Open Source Helpers](https://www.codetriage.com/oauth-xx/ruby-openid2/badges/users.svg)](https://www.codetriage.com/oauth-xx/ruby-openid2) |
83-
| documentation | [on Github.com][homepage], [on Rdoc.info][documentation] |
84-
| expert support | [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/peterboling?utm_source=github&utm_medium=button&utm_term=peterboling&utm_campaign=github) |
85-
| `...` 💖 | [![Liberapay Patrons][⛳liberapay-img]][⛳liberapay] [![Sponsor Me][🖇sponsor-img]][🖇sponsor] [![Follow Me on LinkedIn][🖇linkedin-img]][🖇linkedin] [![Find Me on WellFound:][✌️wellfound-img]][✌️wellfound] [![Find Me on CrunchBase][💲crunchbase-img]][💲crunchbase] [![My LinkTree][🌳linktree-img]][🌳linktree] [![Follow Me on Ruby.Social][🐘ruby-mast-img]][🐘ruby-mast] [![Tweet @ Peter][🐦tweet-img]][🐦tweet] [💻][coderme] [🌏][aboutme] |
86-
87-
<!-- 7️⃣ spread 💖 -->
88-
[🐦tweet-img]: https://img.shields.io/twitter/follow/galtzo.svg?style=social&label=Follow%20%40galtzo
89-
[🐦tweet]: http://twitter.com/galtzo
90-
[🚎blog]: http://www.railsbling.com/tags/ruby-openid2/
91-
[🚎blog-img]: https://img.shields.io/badge/blog-railsbling-brightgreen.svg?style=flat
92-
[🖇linkedin]: http://www.linkedin.com/in/peterboling
93-
[🖇linkedin-img]: https://img.shields.io/badge/PeterBoling-blue?style=plastic&logo=linkedin
94-
[✌️wellfound]: https://angel.co/u/peter-boling
95-
[✌️wellfound-img]: https://img.shields.io/badge/peter--boling-orange?style=plastic&logo=wellfound
96-
[💲crunchbase]: https://www.crunchbase.com/person/peter-boling
97-
[💲crunchbase-img]: https://img.shields.io/badge/peter--boling-purple?style=plastic&logo=crunchbase
98-
[🐘ruby-mast]: https://ruby.social/@galtzo
99-
[🐘ruby-mast-img]: https://img.shields.io/mastodon/follow/109447111526622197?domain=https%3A%2F%2Fruby.social&style=plastic&logo=mastodon&label=Ruby%20%40galtzo
100-
[🌳linktree]: https://linktr.ee/galtzo
101-
[🌳linktree-img]: https://img.shields.io/badge/galtzo-purple?style=plastic&logo=linktree
102-
103-
<!-- Maintainer Contact Links -->
104-
[aboutme]: https://about.me/peter.boling
105-
[coderme]: https://coderwall.com/Peter%20Boling
106-
10768
### Note about the deprecation of stdlib gems `logger`, `rexml`, `net-http`, and `uri`
10869

10970
Versions 3.0.x were released with hard dependencies on the new stand alone gem replacements
@@ -133,10 +94,37 @@ The library code is quite well documented, so don't be squeamish, and
13394
look at the library itself if there's anything you don't understand in
13495
the examples.
13596

136-
## Homepage
97+
## General Info
98+
99+
| Primary Namespace | OpenID |
100+
|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
101+
| gem name | [ruby-openid2](https://rubygems.org/gems/ruby-openid2) |
102+
| code triage | [![Open Source Helpers](https://www.codetriage.com/oauth-xx/ruby-openid2/badges/users.svg)](https://www.codetriage.com/oauth-xx/ruby-openid2) |
103+
| documentation | [on Github.com][homepage], [on rubydoc.info][documentation] |
104+
| expert support | [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/peterboling?utm_source=github&utm_medium=button&utm_term=peterboling&utm_campaign=github) |
105+
| `...` 💖 | [![Liberapay Patrons][⛳liberapay-img]][⛳liberapay] [![Sponsor Me][🖇sponsor-img]][🖇sponsor] [![Follow Me on LinkedIn][🖇linkedin-img]][🖇linkedin] [![Find Me on WellFound:][✌️wellfound-img]][✌️wellfound] [![Find Me on CrunchBase][💲crunchbase-img]][💲crunchbase] [![My LinkTree][🌳linktree-img]][🌳linktree] [![Follow Me on Ruby.Social][🐘ruby-mast-img]][🐘ruby-mast] [![Tweet @ Peter][🐦tweet-img]][🐦tweet] [💻][coderme] [🌏][aboutme] |
106+
107+
<!-- 7️⃣ spread 💖 -->
108+
[🐦tweet-img]: https://img.shields.io/twitter/follow/galtzo.svg?style=social&label=Follow%20%40galtzo
109+
[🐦tweet]: http://twitter.com/galtzo
110+
[🚎blog]: http://www.railsbling.com/tags/ruby-openid2/
111+
[🚎blog-img]: https://img.shields.io/badge/blog-railsbling-brightgreen.svg?style=flat
112+
[🖇linkedin]: http://www.linkedin.com/in/peterboling
113+
[🖇linkedin-img]: https://img.shields.io/badge/PeterBoling-blue?style=plastic&logo=linkedin
114+
[✌️wellfound]: https://angel.co/u/peter-boling
115+
[✌️wellfound-img]: https://img.shields.io/badge/peter--boling-orange?style=plastic&logo=wellfound
116+
[💲crunchbase]: https://www.crunchbase.com/person/peter-boling
117+
[💲crunchbase-img]: https://img.shields.io/badge/peter--boling-purple?style=plastic&logo=crunchbase
118+
[🐘ruby-mast]: https://ruby.social/@galtzo
119+
[🐘ruby-mast-img]: https://img.shields.io/mastodon/follow/109447111526622197?domain=https%3A%2F%2Fruby.social&style=plastic&logo=mastodon&label=Ruby%20%40galtzo
120+
[🌳linktree]: https://linktr.ee/galtzo
121+
[🌳linktree-img]: https://img.shields.io/badge/galtzo-purple?style=plastic&logo=linktree
122+
[documentation]: https://rubydoc.info/github/oauth-xx/rack-openid2
123+
[homepage]: https://github.com/oauth-xx/rack-openid2
137124

138-
* GitHub repository: [oauth-xx/ruby-openid2](http://github.com/oauth-xx/ruby-openid2)
139-
* Homepage: [OpenID.net](http://openid.net/)
125+
<!-- Maintainer Contact Links -->
126+
[aboutme]: https://about.me/peter.boling
127+
[coderme]: https://coderwall.com/Peter%20Boling
140128

141129
## Community
142130

@@ -209,9 +197,20 @@ See [CHANGELOG.md][📌changelog] for list of releases.
209197
[railsbling]: http://www.railsbling.com
210198
[peterboling]: http://www.peterboling.com
211199
[bundle-group-pattern]: https://gist.github.com/pboling/4564780
212-
[documentation]: http://rdoc.info/github/oauth-xx/ruby-openid2/frames
213-
[homepage]: https://github.com/oauth-xx/ruby-openid2
214200

215-
## License
201+
## 📄 License
216202

217203
Apache Software License. For more information see the LICENSE file.
204+
205+
## 🤑 One more thing
206+
207+
You made it to the bottom of the page!
208+
If you think maintaining this gem is more difficult than parsing a README,
209+
or if you think I've done a bang up job with this gem,
210+
please consider supporting my efforts via this link,
211+
or one of the others at the head.
212+
213+
[![Buy me a latte][🖇buyme-img]][🖇buyme]
214+
215+
[🖇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
216+
[🖇buyme]: https://www.buymeacoffee.com/pboling

‎bin/bundle

+6-6
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ m = Module.new do
2727
bundler_version = nil
2828
update_index = nil
2929
ARGV.each_with_index do |a, i|
30-
if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
30+
if update_index && update_index.succ == i && a.match?(Gem::Version::ANCHORED_VERSION_PATTERN)
3131
bundler_version = a
3232
end
33-
next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/o
33+
next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
3434
bundler_version = $1
3535
update_index = i
3636
end
@@ -56,7 +56,7 @@ m = Module.new do
5656
def lockfile_version
5757
return unless File.file?(lockfile)
5858
lockfile_contents = File.read(lockfile)
59-
return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/o
59+
return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
6060
Regexp.last_match(1)
6161
end
6262

@@ -83,15 +83,15 @@ m = Module.new do
8383

8484
def activate_bundler
8585
gem_error = activation_error_handling do
86-
gem("bundler", bundler_requirement)
86+
gem "bundler", bundler_requirement
8787
end
8888
return if gem_error.nil?
8989
require_error = activation_error_handling do
9090
require "bundler/version"
9191
end
9292
return if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION))
93-
warn("Activating bundler (#{bundler_requirement}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_requirement}'`")
94-
exit(42)
93+
warn "Activating bundler (#{bundler_requirement}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_requirement}'`"
94+
exit 42
9595
end
9696

9797
def activation_error_handling

0 commit comments

Comments
 (0)