Skip to content

Commit e6ff3b7

Browse files
pbolingpboling
committed
📝 Documentation updates
1 parent 78091b8 commit e6ff3b7

File tree

2 files changed

+21
-19
lines changed

2 files changed

+21
-19
lines changed

‎.rubocop_gradual.lock

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -66,15 +66,15 @@
6666
[1082, 11, 82, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 1524553529],
6767
[1162, 17, 12, "RSpec/ContextWording: Context description should match /^when\\b/, /^with\\b/, or /^without\\b/.", 664794325]
6868
],
69-
"spec/oauth2/error_spec.rb:1648148825": [
69+
"spec/oauth2/error_spec.rb:1692696277": [
7070
[23, 1, 28, "RSpec/SpecFilePathFormat: Spec path should end with `o_auth2/error*_spec.rb`.", 3385870076],
71-
[93, 11, 332, "RSpec/NoExpectationExample: No expectation found in this example.", 970111147],
72-
[105, 11, 210, "RSpec/NoExpectationExample: No expectation found in this example.", 3948582233],
73-
[237, 11, 534, "RSpec/NoExpectationExample: No expectation found in this example.", 3347340910],
74-
[253, 11, 210, "RSpec/NoExpectationExample: No expectation found in this example.", 3948582233],
75-
[311, 11, 534, "RSpec/NoExpectationExample: No expectation found in this example.", 3347340910],
76-
[372, 11, 534, "RSpec/NoExpectationExample: No expectation found in this example.", 3347340910],
77-
[388, 11, 210, "RSpec/NoExpectationExample: No expectation found in this example.", 3948582233]
71+
[93, 11, 460, "RSpec/NoExpectationExample: No expectation found in this example.", 3630511675],
72+
[108, 11, 210, "RSpec/NoExpectationExample: No expectation found in this example.", 3948582233],
73+
[240, 11, 534, "RSpec/NoExpectationExample: No expectation found in this example.", 3347340910],
74+
[256, 11, 210, "RSpec/NoExpectationExample: No expectation found in this example.", 3948582233],
75+
[314, 11, 534, "RSpec/NoExpectationExample: No expectation found in this example.", 3347340910],
76+
[375, 11, 534, "RSpec/NoExpectationExample: No expectation found in this example.", 3347340910],
77+
[391, 11, 210, "RSpec/NoExpectationExample: No expectation found in this example.", 3948582233]
7878
],
7979
"spec/oauth2/response_spec.rb:3742350944": [
8080
[3, 1, 31, "RSpec/SpecFilePathFormat: Spec path should end with `o_auth2/response*_spec.rb`.", 3190869319],

‎README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,8 @@ NOTE: `header` - The content type specified in the `curl` is already the default
8383

8484
| Tokens to Remember | [![Gem name][⛳️name-img]][⛳️gem-name] [![Gem namespace][⛳️namespace-img]][⛳️gem-namespace] |
8585
|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
86-
| Works with JRuby | [![JRuby 9.1 Compat][💎jruby-9.1i]][🚎10-j-wf] [![JRuby 9.2 Compat][💎jruby-9.2i]][🚎10-j-wf] [![JRuby 9.3 Compat][💎jruby-9.3i]][🚎10-j-wf] [![JRuby 9.4 Compat][💎jruby-9.4i]][🚎10-j-wf] [![JRuby 10.0 Compat][💎jruby-c-i]][🚎11-c-wf] [![JRuby HEAD Compat][💎jruby-headi]][🚎3-hd-wf] |
87-
| Works with Truffle Ruby | [![Truffle Ruby 22.3 Compat][💎truby-22.3i]][🚎9-t-wf] [![Truffle Ruby 23.0 Compat][💎truby-23.0i]][🚎9-t-wf] [![Truffle Ruby 23.1 Compat][💎truby-23.1i]][🚎9-t-wf] [![Truffle Ruby 24.1 Compat][💎truby-c-i]][🚎11-c-wf] [![Truffle Ruby HEAD Compat][💎truby-headi]][🚎3-hd-wf] |
86+
| Works with JRuby | [![JRuby 9.2 Compat][💎jruby-9.2i]][🚎10-j-wf] [![JRuby 9.3 Compat][💎jruby-9.3i]][🚎10-j-wf] [![JRuby 9.4 Compat][💎jruby-9.4i]][🚎10-j-wf] [![JRuby 10.0 Compat][💎jruby-c-i]][🚎11-c-wf] [![JRuby HEAD Compat][💎jruby-headi]][🚎3-hd-wf] |
87+
| Works with Truffle Ruby | [![Truffle Ruby 23.1 Compat][💎truby-23.1i]][🚎9-t-wf] [![Truffle Ruby 24.1 Compat][💎truby-c-i]][🚎11-c-wf] [![Truffle Ruby HEAD Compat][💎truby-headi]][🚎3-hd-wf] |
8888
| Works with MRI Ruby 3 | [![Ruby 3.0 Compat][💎ruby-3.0i]][🚎4-lg-wf] [![Ruby 3.1 Compat][💎ruby-3.1i]][🚎6-s-wf] [![Ruby 3.2 Compat][💎ruby-3.2i]][🚎6-s-wf] [![Ruby 3.3 Compat][💎ruby-3.3i]][🚎6-s-wf] [![Ruby 3.4 Compat][💎ruby-c-i]][🚎11-c-wf] [![Ruby HEAD Compat][💎ruby-headi]][🚎3-hd-wf] |
8989
| Works with MRI Ruby 2 | [![Ruby 2.3 Compat][💎ruby-2.3i]][🚎1-an-wf] [![Ruby 2.4 Compat][💎ruby-2.4i]][🚎1-an-wf] [![Ruby 2.5 Compat][💎ruby-2.5i]][🚎1-an-wf] [![Ruby 2.6 Compat][💎ruby-2.6i]][🚎7-us-wf] [![Ruby 2.7 Compat][💎ruby-2.7i]][🚎7-us-wf] |
9090
| 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] |
@@ -104,7 +104,7 @@ NOTE: `header` - The content type specified in the `curl` is already the default
104104

105105
| Version | Release Date | Readme |
106106
|---------|--------------|-------------------------------------------------------------|
107-
| 2.0.10 | 2022-09-27 | https://gitlab.com/oauth-xx/oauth2/-/blob/v2.0.10/README.md |
107+
| 2.0.10 | 2025-05-16 | https://gitlab.com/oauth-xx/oauth2/-/blob/v2.0.10/README.md |
108108
| 2.0.9 | 2022-09-16 | https://gitlab.com/oauth-xx/oauth2/-/blob/v2.0.9/README.md |
109109
| 2.0.8 | 2022-09-01 | https://gitlab.com/oauth-xx/oauth2/-/blob/v2.0.8/README.md |
110110
| 2.0.7 | 2022-08-22 | https://gitlab.com/oauth-xx/oauth2/-/blob/v2.0.7/README.md |
@@ -238,9 +238,10 @@ For more see [SECURITY.md][🔐security].
238238

239239
## Compatibility
240240

241-
Targeted ruby compatibility is non-EOL versions of Ruby, currently 2.7, 3.0 and
242-
3.1. Compatibility is further distinguished by supported and unsupported versions of Ruby.
243-
Ruby is limited to 2.2+ for 2.x releases. See `1-4-stable` branch for older rubies.
241+
Targeted ruby compatibility is non-EOL versions of Ruby, currently 3.2, 3.3, and 3.4.
242+
Compatibility is further distinguished as "Best Effort Support" or "Incidental Support" for older versions of Ruby.
243+
This gem will install on Ruby versions >= v2.2 for 2.x releases.
244+
See `1-4-stable` branch for older rubies.
244245

245246
<details>
246247
<summary>Ruby Engine Compatibility Policy</summary>
@@ -269,11 +270,11 @@ fashion. If critical issues for a particular implementation exist at the time
269270
of a major release, support for that Ruby version may be dropped.
270271
</details>
271272

272-
| | Ruby OAuth2 Version | Maintenance Branch | Supported Officially | Supported Unofficially | Supported Incidentally |
273-
|:----|---------------------|--------------------|-------------------------|------------------------|------------------------|
274-
| 1️⃣ | 2.0.x | `main` | 2.7, 3.0, 3.1 | 2.5, 2.6 | 2.2, 2.3, 2.4 |
275-
| 2️⃣ | 1.4.x | `1-4-stable` | 2.5, 2.6, 2.7, 3.0, 3.1 | 2.1, 2.2, 2.3, 2.4 | 1.9, 2.0 |
276-
| 3️⃣ | older | N/A | Best of luck to you! | Please upgrade! | |
273+
| | Ruby OAuth2 Version | Maintenance Branch | Targeted Support | Best Effort Support | Incidental Support |
274+
|:----|---------------------|--------------------|----------------------|-------------------------|------------------------------|
275+
| 1️⃣ | 2.0.x | `main` | 3.2, 3.3, 3.4 | 2.5, 2.6, 2.7, 3.0, 3.1 | 2.2, 2.3, 2.4 |
276+
| 2️⃣ | 1.4.x | `1-4-stable` | 3.2, 3.3, 3.4 | 2.5, 2.6, 2.7, 3.0, 3.1 | 1.9, 2.0, 2.1, 2.2, 2.3, 2.4 |
277+
| 3️⃣ | older | N/A | Best of luck to you! | Please upgrade! | |
277278

278279
NOTE: The 1.4 series will only receive critical security updates.
279280
See [SECURITY.md][🚎sec-pol]
@@ -290,6 +291,7 @@ OAuth2::AccessToken.from_hash: `hash` contained more than one 'token' key
290291
```ruby
291292
OAuth2.configure do |config|
292293
config.silence_extra_tokens_warning = true # default: false
294+
config.silence_no_tokens_warning = true # default: false, if you want to also silence warnings about no tokens
293295
end
294296
```
295297

0 commit comments

Comments
 (0)