Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 8 commits into from
Jan 11, 2023
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
This file is intended to be modified using the [`changelog`](github.com/cucumber/changelog) command-line tool.

## [Unreleased]
### Removed
- Removed runtime dependencies: `mime-types`, `rexml`, and `webrick` [#559](https://github.com/cucumber/cucumber-rails/pull/559)

## [2.6.1] - 2022-10-12
### Changed
Expand Down
3 changes: 0 additions & 3 deletions cucumber-rails.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,8 @@ Gem::Specification.new do |s|

s.add_runtime_dependency('capybara', ['>= 2.18', '< 4'])
s.add_runtime_dependency('cucumber', '>= 3.2', '< 9')
s.add_runtime_dependency('mime-types', ['~> 3.3'])
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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

s.add_runtime_dependency('webrick', '~> 1.7') # webrick is a bundled gem from ruby 3

# Main development dependencies
s.add_development_dependency('ammeter', '>= 1.1.4')
Expand Down
2 changes: 2 additions & 0 deletions features/step_definitions/cucumber_rails_steps.rb
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in 7928281

run_command_and_stop('bundle install --jobs 4')
Copy link
Contributor Author

@orien orien Jan 7, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

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.

end

Given('I force {string} to use select boxes for dates') do |file|
Expand Down
22 changes: 11 additions & 11 deletions features/support/cucumber_rails_helper.rb
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
require 'cucumber'
require 'capybara'

module CucumberRailsHelper
module CucumberRailsHelper # rubocop:todo Layout/ModuleLength
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

def rails_new(options = {})
validate_rails_new_success(run_rails_new_command(options))
cd options[:name]
Expand All @@ -16,10 +16,10 @@ def rails_new(options = {})

def install_cucumber_rails(*options)
add_conditional_gems(options)
add_rails_specific_gems

add_gem 'cucumber', Cucumber::VERSION, group: :test
add_gem 'capybara', Capybara::VERSION, group: :test
add_gem 'selenium-webdriver', '~> 3.11', group: :test
add_gem 'rspec-expectations', '~> 3.7', group: :test
add_gem 'database_cleaner', '>= 1.8.0', group: :test unless options.include?(:no_database_cleaner)
add_gem 'database_cleaner-active_record', '>= 2.0.0.beta2', group: :test if options.include?(:database_cleaner_active_record)
Expand Down Expand Up @@ -79,8 +79,8 @@ def run_rails_new_command(options)
options[:name] ||= 'test_app'
flags = %w[ --skip-action-cable --skip-action-mailer --skip-active-job --skip-bootsnap --skip-bundle --skip-javascript
--skip-jbuilder --skip-listen --skip-spring --skip-sprockets --skip-test-unit --skip-turbolinks ]
flags += %w[--skip-active-storage] if rails_5_2_or_higher?
flags += %w[--skip-action-mailbox --skip-action-text] if rails_6_0_or_higher?
flags += %w[--skip-active-storage] if rails_equal_or_higher_than?('5.2')
flags += %w[--skip-action-mailbox --skip-action-text] if rails_equal_or_higher_than?('6.0')
run_command "bundle exec rails new #{options[:name]} #{flags.join(' ')} #{options[:args]}"
end

Expand All @@ -94,12 +94,8 @@ def clear_bundle_env_vars
delete_environment_variable 'BUNDLE_GEMFILE'
end

def rails_5_2_or_higher?
Rails.gem_version >= Gem::Version.new('5.2')
end

def rails_6_0_or_higher?
Rails.gem_version >= Gem::Version.new('6.0')
def rails_equal_or_higher_than?(version)
Rails.gem_version >= Gem::Version.new(version)
luke-hill marked this conversation as resolved.
Show resolved Hide resolved
end

def add_conditional_gems(options)
Expand All @@ -108,11 +104,15 @@ def add_conditional_gems(options)
else
add_gem 'cucumber-rails', group: :test, require: false, path: File.expand_path('.').to_s
end
end

if rails_6_0_or_higher?
def add_rails_specific_gems
if rails_equal_or_higher_than?('6.0')
add_gem 'sqlite3', '~> 1.4'
add_gem 'selenium-webdriver', '~> 4', group: :test
Copy link
Contributor Author

@orien orien Jan 7, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

@orien orien Jan 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated in 10649a3

else
add_gem 'sqlite3', '~> 1.3.13'
add_gem 'selenium-webdriver', '~> 3.11', group: :test
end
end

Expand Down