Skip to content

Commit bf0d6f3

Browse files
pbolingpboling
committed
🔖 Prepare release v3.1.0
## 3.1.0 - 2024-09-24 - COVERAGE: 91.81% -- 3520/3834 lines in 49 files - BRANCH COVERAGE: 87.03% -- 1074/1234 branches in 49 files - 63.08% documented ### Removed - Direct dependency on logger, rexml, net-http, & uri - these stdlib gems became deprecated in favor of the stand alone versions in Ruby 3.3 - they will begin to raise an error in Ruby 3.5. - Downstream code should add them explicitly to move away from the stdlib versions sooner than Ruby 3.5 - Ref: rubygems/rubygems#7178 (comment)
1 parent f1eb7cc commit bf0d6f3

9 files changed

+89
-19
lines changed

‎CHANGELOG.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,22 +10,33 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1010
### Fixed
1111
### Removed
1212

13+
## 3.1.0 - 2024-09-24
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+
### Removed
18+
- Direct dependency on logger, rexml, net-http, & uri
19+
- these stdlib gems became deprecated in favor of the stand alone versions in Ruby 3.3
20+
- they will begin to raise an error in Ruby 3.5.
21+
- Downstream code should add them explicitly to move away from the stdlib versions sooner than Ruby 3.5
22+
- Ref: https://github.com/rubygems/rubygems/issues/7178#issuecomment-2372558363
23+
1324
## 3.0.3 - 2024-09-24
1425
### Fixed
1526
- Add logger gem for Ruby 3.5 compatibility
1627
- Restrict minitest to < 6, because first we must use assert_nil if expecting nil
1728

1829
## 3.0.2 - 2024-09-24
19-
COVERAGE: 91.72% -- 3522/3840 lines in 49 files
20-
BRANCH COVERAGE: 87.03% -- 1074/1234 branches in 49 files
21-
63.08% documented
30+
- COVERAGE: 91.72% -- 3522/3840 lines in 49 files
31+
- BRANCH COVERAGE: 87.03% -- 1074/1234 branches in 49 files
32+
- 63.08% documented
2233
### Added
2334
- Automatic loading via bundler
2435

2536
## 3.0.1 - 2024-09-20
26-
COVERAGE: 91.72% -- 3521/3839 lines in 48 files
27-
BRANCH COVERAGE: 87.03% -- 1074/1234 branches in 48 files
28-
63.08% documented
37+
- COVERAGE: 91.72% -- 3521/3839 lines in 48 files
38+
- BRANCH COVERAGE: 87.03% -- 1074/1234 branches in 48 files
39+
- 63.08% documented
2940
### Added
3041
- More and better documentation
3142
### Fixed
@@ -38,8 +49,8 @@ BRANCH COVERAGE: 87.03% -- 1074/1234 branches in 48 files
3849
- Copyright years in LICENSE.txt
3950

4051
## 3.0.0 - 2024-09-04
41-
3839 relevant lines, 3521 lines covered and 318 lines missed. ( 91.72% )
42-
1234 total branches, 1073 branches covered and 161 branches missed. ( 86.95% )
52+
- 3839 relevant lines, 3521 lines covered and 318 lines missed. ( 91.72% )
53+
- 1234 total branches, 1073 branches covered and 161 branches missed. ( 86.95% )
4354
### Fixed
4455
- Compatibility with Ruby 2.7+
4556
### Removed

‎Gemfile

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,24 @@
11
# frozen_string_literal: true
22

3+
source "https://rubygems.org"
4+
5+
git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
6+
37
#### IMPORTANT #######################################################
48
# Gemfile is for local development ONLY; Gemfile is NOT loaded in CI #
59
####################################################### IMPORTANT ####
10+
# Root Gemfile is only for local development only. It is not loaded on CI.
11+
# On CI we only need the gemspecs' dependencies (including development dependencies).
12+
# Exceptions, if any, will be found in gemfiles/*.gemfile
613

7-
source "https://rubygems.org"
8-
9-
git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
14+
# When depended on directly, these previously stdlib gems,
15+
# deprecated in Ruby 3.3 & removed in Ruby 3.5
16+
# make it difficult to build on GA CI with Ruby 2.7 and bundler v2.4.22.
17+
# See: https://github.com/rubygems/rubygems/issues/7178#issuecomment-2372558363
18+
gem "net-http", "~> 0.4", ">= 0.4.1"
19+
gem "uri", "~> 0.13", ">= 0.13.1"
20+
gem "logger", "~> 1.6", ">= 1.6.1"
21+
gem "rexml", "~> 3.3", ">= 3.3.7"
1022

1123
# Specify your gem's dependencies in ruby-openid.gemspec
1224
gemspec

‎Gemfile.lock

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
11
PATH
22
remote: .
33
specs:
4-
ruby-openid2 (3.0.3)
5-
logger (~> 1.6, >= 1.6.1)
6-
net-http (~> 0.4, >= 0.4.1)
7-
rexml (~> 3.3, >= 3.3.7)
4+
ruby-openid2 (3.1.0)
85
version_gem (~> 1.1, >= 1.1.4)
96

107
GEM
@@ -146,13 +143,17 @@ PLATFORMS
146143
DEPENDENCIES
147144
byebug (>= 11)
148145
kettle-soup-cover (~> 1.0, >= 1.0.2)
146+
logger (~> 1.6, >= 1.6.1)
149147
minitest (>= 5, < 6)
148+
net-http (~> 0.4, >= 0.4.1)
150149
rake (>= 13)
150+
rexml (~> 3.3, >= 3.3.7)
151151
rubocop-lts (~> 18.2, >= 18.2.1)
152152
rubocop-minitest (~> 0.36)
153153
rubocop-packaging (~> 0.5, >= 0.5.2)
154154
ruby-openid2!
155155
standard (~> 1.37)
156+
uri (~> 0.13, >= 0.13.1)
156157
webrick (~> 1.8)
157158
yard (~> 0.9, >= 0.9.37)
158159
yard-junk (~> 0.0, >= 0.0.10)

‎README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,17 @@ Check the installation:
110110

111111
The library is known to work with Ruby 1.9.2 and above on Unix, Max OS X and Win32.
112112

113+
### Note about the deprecation of stdlib gems `logger`, `rexml`, `net-http`, and `uri`
114+
115+
Versions 3.0.x were released with hard dependencies on the new stand alone gem replacements
116+
for the old stdlib gems.
117+
118+
This made it impossible for downstream libraries to make the choice to stay on the old stdlib gems.
119+
120+
As a result, starting with version 3.1.0, they will not be direct dependencies.
121+
122+
See [this discussion](https://github.com/rubygems/rubygems/issues/7178#issuecomment-2372558363) for more information.
123+
113124
## Getting Started
114125

115126
The best way to start is to look at the rails_openid example.

‎gemfiles/coverage.gemfile

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,22 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
22

33
source "https://rubygems.org"
44

5+
#### IMPORTANT #######################################################
6+
# Gemfile is for local development ONLY; Gemfile is NOT loaded in CI #
7+
####################################################### IMPORTANT ####
58
# Root Gemfile is only for local development only. It is not loaded on CI.
69
# On CI we only need the gemspecs' dependencies (including development dependencies).
710
# Exceptions, if any, will be found in gemfiles/*.gemfile
11+
12+
# When depended on directly, these previously stdlib gems,
13+
# deprecated in Ruby 3.3 & removed in Ruby 3.5
14+
# make it difficult to build on GA CI with Ruby 2.7 and bundler v2.4.22.
15+
# See: https://github.com/rubygems/rubygems/issues/7178#issuecomment-2372558363
16+
gem "net-http", "~> 0.4", ">= 0.4.1"
17+
gem "uri", "~> 0.13", ">= 0.13.1"
18+
gem "logger", "~> 1.6", ">= 1.6.1"
19+
gem "rexml", "~> 3.3", ">= 3.3.7"
20+
821
gem "kettle-soup-cover", "~> 1.0", ">= 1.0.2"
922

1023
gemspec path: "../"

‎gemfiles/style.gemfile

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,22 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
22

33
source "https://rubygems.org"
44

5+
#### IMPORTANT #######################################################
6+
# Gemfile is for local development ONLY; Gemfile is NOT loaded in CI #
7+
####################################################### IMPORTANT ####
58
# Root Gemfile is only for local development only. It is not loaded on CI.
69
# On CI we only need the gemspecs' dependencies (including development dependencies).
710
# Exceptions, if any, will be found in gemfiles/*.gemfile
11+
12+
# When depended on directly, these previously stdlib gems,
13+
# deprecated in Ruby 3.3 & removed in Ruby 3.5
14+
# make it difficult to build on GA CI with Ruby 2.7 and bundler v2.4.22.
15+
# See: https://github.com/rubygems/rubygems/issues/7178#issuecomment-2372558363
16+
gem "net-http", "~> 0.4", ">= 0.4.1"
17+
gem "uri", "~> 0.13", ">= 0.13.1"
18+
gem "logger", "~> 1.6", ">= 1.6.1"
19+
gem "rexml", "~> 3.3", ">= 3.3.7"
20+
821
gem "rubocop-packaging", "~> 0.5", ">= 0.5.2"
922

1023
gemspec path: "../"

‎gemfiles/vanilla.gemfile

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,20 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
22

33
source "https://rubygems.org"
44

5+
#### IMPORTANT #######################################################
6+
# Gemfile is for local development ONLY; Gemfile is NOT loaded in CI #
7+
####################################################### IMPORTANT ####
58
# Root Gemfile is only for local development only. It is not loaded on CI.
69
# On CI we only need the gemspecs' dependencies (including development dependencies).
710
# Exceptions, if any, will be found in gemfiles/*.gemfile
811

12+
# When depended on directly, these previously stdlib gems,
13+
# deprecated in Ruby 3.3 & removed in Ruby 3.5
14+
# make it difficult to build on GA CI with Ruby 2.7 and bundler v2.4.22.
15+
# See: https://github.com/rubygems/rubygems/issues/7178#issuecomment-2372558363
16+
gem "net-http", "~> 0.4", ">= 0.4.1"
17+
gem "uri", "~> 0.13", ">= 0.13.1"
18+
gem "logger", "~> 1.6", ">= 1.6.1"
19+
gem "rexml", "~> 3.3", ">= 3.3.7"
20+
921
gemspec path: "../"

‎lib/openid/version.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
module OpenID
22
module Version
3-
VERSION = "3.0.3"
3+
VERSION = "3.1.0"
44
end
55
end

‎ruby-openid2.gemspec

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,6 @@ Gem::Specification.new do |spec|
4343
spec.metadata["funding_uri"] = "https://liberapay.com/pboling"
4444
spec.metadata["rubygems_mfa_required"] = "true"
4545

46-
spec.add_dependency("logger", "~> 1.6", ">= 1.6.1")
47-
spec.add_dependency("net-http", "~> 0.4", ">= 0.4.1")
48-
spec.add_dependency("rexml", "~> 3.3", ">= 3.3.7")
4946
spec.add_dependency("version_gem", "~> 1.1", ">= 1.1.4")
5047

5148
spec.add_development_dependency("minitest", ">= 5", "< 6") # Use assert_nil if expecting nil

0 commit comments

Comments
 (0)