chore: Install ostruct alongside virtus #403
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Background: ostruct (aka OpenStruct) is part of Ruby's standard library,
but it's being pulled out of the standard library and into a gem. For
now, both versions are available. If you require the version from the
standard library, Ruby 3.3.5 will print a warning urging you to switch
over to using the gem version. In Ruby 3.5.0, the standard library
version will not exist.
The warning looks like this:
```
/Users/mjacobson/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/virtus-2.0.0/lib/virtus.rb:1: warning: /Users/mjacobson/.rbenv/versions/3.3.5/lib/ruby/3.3.0/ostruct.rb was loaded from the standard library, but will no longer be part of the default gems starting from Ruby 3.5.0.
You can add ostruct to your Gemfile or gemspec to silence this warning.
Also please contact the author of virtus-2.0.0 to request adding ostruct into its gemspec.
```
Because axe-core-gems uses virtus, and virtus uses ostruct, users of
axe-core-gems will start to see this warning when they upgrade to Ruby
3.3.5.
Ideally, virtus itself would add ostruct to its gemspec, but virtus is
discontinued and has not received an update in years and is not likely
to receive one again. Given that, I suggest axe-core-gems adds ostruct
to its gemspecs, to make sure the gem version is installed and used.
That way, no warning will be printed and the gem should be compatible
with Ruby 3.5.0.
I tried running `rake build` and thought about committing the changes,
but there were more than I expected:
```diff
diff --git a/packages/axe-core-api/Gemfile.lock b/packages/axe-core-api/Gemfile.lock
index c71e6b6..3aa5560 100644
--- a/packages/axe-core-api/Gemfile.lock
+++ b/packages/axe-core-api/Gemfile.lock
@@ -1,8 +1,9 @@
PATH
remote: .
specs:
- axe-core-api (4.8.0)
+ axe-core-api (4.9.1)
dumb_delegator
+ ostruct
virtus
GEM
@@ -35,8 +36,11 @@ GEM
language_server-protocol (3.17.0.3)
matrix (0.4.2)
mini_mime (1.1.5)
- nokogiri (1.15.5-arm64-darwin)
+ mini_portile2 (2.8.7)
+ nokogiri (1.15.5)
+ mini_portile2 (~> 2.8.2)
racc (~> 1.4)
+ ostruct (0.6.0)
parallel (1.23.0)
parser (3.2.2.4)
ast (~> 2.4.1)
@@ -100,6 +104,7 @@ GEM
PLATFORMS
arm64-darwin-22
+ arm64-darwin-23
DEPENDENCIES
axe-core-api!
diff --git a/packages/axe-core-capybara/Gemfile.lock b/packages/axe-core-capybara/Gemfile.lock
index 6e71a01..936366c 100644
--- a/packages/axe-core-capybara/Gemfile.lock
+++ b/packages/axe-core-capybara/Gemfile.lock
@@ -1,15 +1,16 @@
PATH
remote: ..
specs:
- axe-core-api (4.8.0)
+ axe-core-api (4.9.1)
dumb_delegator
+ ostruct
virtus
PATH
remote: .
specs:
- axe-core-capybara (4.8.0)
- axe-core-api
+ axe-core-capybara (4.9.1)
+ axe-core-api (= 4.9.1)
dumb_delegator
GEM
@@ -42,8 +43,11 @@ GEM
language_server-protocol (3.17.0.3)
matrix (0.4.2)
mini_mime (1.1.5)
- nokogiri (1.15.5-arm64-darwin)
+ mini_portile2 (2.8.7)
+ nokogiri (1.15.5)
+ mini_portile2 (~> 2.8.2)
racc (~> 1.4)
+ ostruct (0.6.0)
parallel (1.23.0)
parser (3.2.2.4)
ast (~> 2.4.1)
@@ -104,6 +108,7 @@ GEM
PLATFORMS
arm64-darwin-22
+ arm64-darwin-23
DEPENDENCIES
axe-core-api!
diff --git a/packages/axe-core-cucumber/Gemfile.lock b/packages/axe-core-cucumber/Gemfile.lock
index 556b6d7..fa7ad04 100644
--- a/packages/axe-core-cucumber/Gemfile.lock
+++ b/packages/axe-core-cucumber/Gemfile.lock
@@ -1,16 +1,18 @@
PATH
remote: ..
specs:
- axe-core-api (4.8.0)
+ axe-core-api (4.9.1)
dumb_delegator
+ ostruct
virtus
PATH
remote: .
specs:
- axe-core-cucumber (4.8.0)
- axe-core-api
+ axe-core-cucumber (4.9.1)
+ axe-core-api (= 4.9.1)
dumb_delegator
+ ostruct
virtus
GEM
@@ -58,6 +60,7 @@ GEM
language_server-protocol (3.17.0.3)
mini_mime (1.1.5)
multi_test (1.1.0)
+ ostruct (0.6.0)
parallel (1.23.0)
parser (3.2.2.4)
ast (~> 2.4.1)
@@ -108,6 +111,7 @@ GEM
PLATFORMS
arm64-darwin-22
+ arm64-darwin-23
DEPENDENCIES
axe-core-api!
diff --git a/packages/axe-core-rspec/Gemfile.lock b/packages/axe-core-rspec/Gemfile.lock
index 596ea3c..8e1a1a6 100644
--- a/packages/axe-core-rspec/Gemfile.lock
+++ b/packages/axe-core-rspec/Gemfile.lock
@@ -1,16 +1,18 @@
PATH
remote: ..
specs:
- axe-core-api (4.8.0)
+ axe-core-api (4.9.1)
dumb_delegator
+ ostruct
virtus
PATH
remote: .
specs:
- axe-core-rspec (4.8.0)
- axe-core-api
+ axe-core-rspec (4.9.1)
+ axe-core-api (= 4.9.1)
dumb_delegator
+ ostruct
virtus
GEM
@@ -30,6 +32,7 @@ GEM
ice_nine (0.11.2)
json (2.7.0)
language_server-protocol (3.17.0.3)
+ ostruct (0.6.0)
parallel (1.23.0)
parser (3.2.2.4)
ast (~> 2.4.1)
@@ -78,6 +81,7 @@ GEM
PLATFORMS
arm64-darwin-22
+ arm64-darwin-23
DEPENDENCIES
axe-core-api!
```
Should I? Happy to push that up, or leave it to y'all when you cut a
release.
|
|
dylanb
changed the title
dylanb
approved these changes
Sep 18, 2024
|
For some reason, security review app is not working - approved security |
This was referenced Sep 18, 2024
scottmries
added a commit
that referenced
this pull request
Sep 19, 2024
Closes #402 Background: ostruct (aka OpenStruct) is part of Ruby's standard library, but it's being pulled out of the standard library and into a gem. For now, both versions are available. If you require the version from the standard library, Ruby 3.3.5 will print a warning urging you to switch over to using the gem version. In Ruby 3.5.0, the standard library version will not exist. The warning looks like this: ``` /Users/mjacobson/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/virtus-2.0.0/lib/virtus.rb:1: warning: /Users/mjacobson/.rbenv/versions/3.3.5/lib/ruby/3.3.0/ostruct.rb was loaded from the standard library, but will no longer be part of the default gems starting from Ruby 3.5.0. You can add ostruct to your Gemfile or gemspec to silence this warning. Also please contact the author of virtus-2.0.0 to request adding ostruct into its gemspec. ``` Because axe-core-gems uses virtus, and virtus uses ostruct, users of axe-core-gems will start to see this warning when they upgrade to Ruby 3.3.5. Ideally, virtus itself would add ostruct to its gemspec, but virtus is discontinued and has not received an update in years and is not likely to receive one again. Given that, I suggest axe-core-gems adds ostruct to its gemspecs, to make sure the gem version is installed and used. That way, no warning will be printed and the gem should be compatible with Ruby 3.5.0. Note: this is a fork of #403 that allows CI to run. No QA required. Co-authored-by: Max Jacobson <max@hardscrabble.net>
|
I'll close this, since it was merged in this other PR: #406 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #402
Background: ostruct (aka OpenStruct) is part of Ruby's standard library, but it's being pulled out of the standard library and into a gem. For now, both versions are available. If you require the version from the standard library, Ruby 3.3.5 will print a warning urging you to switch over to using the gem version. In Ruby 3.5.0, the standard library version will not exist.
The warning looks like this:
Because axe-core-gems uses virtus, and virtus uses ostruct, users of axe-core-gems will start to see this warning when they upgrade to Ruby 3.3.5.
Ideally, virtus itself would add ostruct to its gemspec, but virtus is discontinued and has not received an update in years and is not likely to receive one again. Given that, I suggest axe-core-gems adds ostruct to its gemspecs, to make sure the gem version is installed and used. That way, no warning will be printed and the gem should be compatible with Ruby 3.5.0.
I tried running
rake buildand thought about committing the changes, but there were more than I expected:Diff after running `rake build`
Should I? Happy to push that up, or leave it to y'all when you cut a release.
QA notes: standard regression