Remove `mime-types`, `rexml`, and `webrick` runtime dependencies #559

orien · 2023-01-07T07:53:12Z

Summary

I notice cucumber-rails doesn't directly use the mime-types, rexml, and webrick gems.

Let's remove them from the gemspec to avoid forcing unnecessary dependencies on downstream projects.

How Has This Been Tested?

The automated test suite passes showing these gems are unneeded.

Types of changes

Bug fix (non-breaking change which fixes an issue).
New feature (non-breaking change which adds functionality).
Breaking change (fix or feature that would cause existing functionality to not work as expected).

Checklist:

I've added tests for my code.
My change requires a change to the documentation.
I have updated the documentation accordingly.

orien · 2023-01-07T07:57:55Z

features/support/cucumber_rails_helper.rb

      add_gem 'sqlite3', '~> 1.4'
+      add_gem 'selenium-webdriver', '~> 4', group: :test


The selenium-webdriver uses the rexml library. Downstream projects only need rexml if they are also using the optional Selenium framework.

The selenium-webdriver maintainers have added an explicit runtime dependency in version 4. This resolves the test errors when running on Ruby 3.

features/support/cucumber_rails_helper.rb

orien · 2023-01-07T09:11:37Z

features/step_definitions/cucumber_rails_steps.rb

+  step 'I append to "Gemfile" with:', "gem 'webrick', group: 'test'\n"
+  run_command_and_stop('bundle install --jobs 4')


Install the webrick gem in this step to support the Capybara configuration above.

cucumber-rails/features/step_definitions/cucumber_rails_steps.rb

Line 64 in 3f332f9

Capybara.server = :webrick

This configuration is optional for downstream projects. If developers choose to use webrick, they can add the gem as a dependency in their Rails project.

luke-hill

Couple of stylistic changes to make. All in all I've not got any major problems with it.

Would be good to get your take on the ruby3 gems. I'm on the fence and didn't introduce it originally.

luke-hill · 2023-01-10T11:05:22Z

features/support/cucumber_rails_helper.rb

      add_gem 'sqlite3', '~> 1.4'
+      add_gem 'selenium-webdriver', '~> 4', group: :test


stylistically I'm not a fan of single digits in the twiddle. I know it works, but for completeness / style can we say 4.0

Updated in 10649a3

luke-hill · 2023-01-10T11:06:34Z

features/step_definitions/cucumber_rails_steps.rb

@@ -65,6 +65,8 @@
  }

  step 'I append to "features/support/env.rb" with:', selenium_config
+  step 'I append to "Gemfile" with:', "gem 'webrick', group: 'test'\n"


These references to step need removing actually. So I'd prefer not doing this.

Fixed in 7928281

luke-hill · 2023-01-10T11:11:48Z

cucumber-rails.gemspec

  s.add_runtime_dependency('nokogiri', '~> 1.10')
  s.add_runtime_dependency('railties', ['>= 5.0', '< 8'])
-  s.add_runtime_dependency('rexml', '~> 3.0') # rexml is a bundled gem from ruby 3


We still support lower ruby versions. I'm kinda on the fence about this, as ideally people should be controlling their own version constraints if they need this. So I think I'm 50-50 about this. I don't see the harm in retaining this until we're ruby 3.0+ only (Which isn't likely to be too long at current development rates).

That being said, if you're passionate about this, I don't see the harm in making this change. It was originally made when we introduced ruby3 into our support matrix.

My argument is there is no code in the cucumber-rails gem that uses rexml or webrick. It operates identically, with or without these dependencies, on all supported versions of Ruby. There is no value in declaring them as runtime dependencies.

luke-hill · 2023-01-10T11:13:03Z

features/support/cucumber_rails_helper.rb

@@ -4,7 +4,7 @@
 require 'cucumber'
 require 'capybara'

-module CucumberRailsHelper
+module CucumberRailsHelper # rubocop:todo Layout/ModuleLength


Wherever possible we're trying to avoid doing in-line exclusions and using the top level control with a comment explaining why.

Ideally longer term we should compress this down a bit. But it is test only code, so it's low prio.

I fixed this by removing a superfluous line in 7f667a8.

luke-hill

Think this is good. I do think some of the tidy ups inside the module do need cleaning up more. But that can be done at another time.

aslakhellesoy · 2023-01-11T09:26:48Z

Hi @orien,

Thanks for your making your first contribution to Cucumber, and welcome to the Cucumber committers team! You can now push directly to this repo and all other repos under the cucumber organization! 🍾

In return for this generous offer we hope you will:

✅ Continue to use branches and pull requests. When someone on the core team approves a pull request (yours or someone else's), you're welcome to merge it yourself.
💚 Commit to setting a good example by following and upholding our code of conduct in your interactions with other collaborators and users.
💬 Join the community Slack channel to meet the rest of the team and make yourself at home.
ℹ️ Don't feel obliged to help, just do what you can if you have the time and the energy.
🙋 Ask if you need anything. We're looking for feedback about how to make the project more welcoming, so please tell us!

On behalf of the Cucumber core team,
Aslak Hellesøy
Creator of Cucumber

orien added 3 commits January 7, 2023 18:38

Remove runtime dependencies: mime-types and rexml

dbc735f

Allow the latest selenium-webdriver in feature tests for Rails 6+

f6c8f88

Rubocop resolutions

4d2373b

orien commented Jan 7, 2023

View reviewed changes

features/support/cucumber_rails_helper.rb Show resolved Hide resolved

Remove webrick runtime dependency

a1ad97d

orien changed the title ~~Remove mime-types and rexml runtime dependencies~~ Remove mime-types, rexml, and webrick runtime dependencies Jan 7, 2023

orien commented Jan 7, 2023

View reviewed changes

mathieujobin approved these changes Jan 9, 2023

View reviewed changes

luke-hill requested changes Jan 10, 2023

View reviewed changes

orien added 4 commits January 11, 2023 07:30

Constrain the selenium-webdriver dependency to >=4.0, <5

10649a3

Avoid using 'step' in step definitions

7928281

Rubocop: remove superfluous code

7f667a8

Merge remote-tracking branch 'upstream/main' into runtime-dependencies

081bd2a

luke-hill approved these changes Jan 11, 2023

View reviewed changes

luke-hill merged commit 8363873 into cucumber:main Jan 11, 2023

orien deleted the runtime-dependencies branch January 11, 2023 09:51

luke-hill mentioned this pull request Jan 16, 2023

Config proposals citizensadvice/citizens-advice-style-ruby#33

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove `mime-types`, `rexml`, and `webrick` runtime dependencies #559

Remove `mime-types`, `rexml`, and `webrick` runtime dependencies #559

orien commented Jan 7, 2023 •

edited

Loading

orien Jan 7, 2023 •

edited

Loading

orien Jan 7, 2023 •

edited

Loading

luke-hill left a comment

luke-hill Jan 10, 2023

orien Jan 10, 2023 •

edited

Loading

luke-hill Jan 10, 2023

orien Jan 10, 2023

luke-hill Jan 10, 2023

orien Jan 10, 2023

luke-hill Jan 10, 2023

orien Jan 10, 2023

luke-hill left a comment

aslakhellesoy commented Jan 11, 2023

		add_gem 'sqlite3', '~> 1.4'
		add_gem 'selenium-webdriver', '~> 4', group: :test

		step 'I append to "Gemfile" with:', "gem 'webrick', group: 'test'\n"
		run_command_and_stop('bundle install --jobs 4')

Remove mime-types, rexml, and webrick runtime dependencies #559

Remove mime-types, rexml, and webrick runtime dependencies #559

Conversation

orien commented Jan 7, 2023 • edited Loading

Summary

How Has This Been Tested?

Types of changes

Checklist:

orien Jan 7, 2023 • edited Loading

Choose a reason for hiding this comment

orien Jan 7, 2023 • edited Loading

Choose a reason for hiding this comment

luke-hill left a comment

Choose a reason for hiding this comment

luke-hill Jan 10, 2023

Choose a reason for hiding this comment

orien Jan 10, 2023 • edited Loading

Choose a reason for hiding this comment

luke-hill Jan 10, 2023

Choose a reason for hiding this comment

orien Jan 10, 2023

Choose a reason for hiding this comment

luke-hill Jan 10, 2023

Choose a reason for hiding this comment

orien Jan 10, 2023

Choose a reason for hiding this comment

luke-hill Jan 10, 2023

Choose a reason for hiding this comment

orien Jan 10, 2023

Choose a reason for hiding this comment

luke-hill left a comment

Choose a reason for hiding this comment

aslakhellesoy commented Jan 11, 2023

Remove `mime-types`, `rexml`, and `webrick` runtime dependencies #559

Remove `mime-types`, `rexml`, and `webrick` runtime dependencies #559

orien commented Jan 7, 2023 •

edited

Loading

orien Jan 7, 2023 •

edited

Loading

orien Jan 7, 2023 •

edited

Loading

orien Jan 10, 2023 •

edited

Loading