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.

Sign up for GitHub

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

Improve testing directions in the readme #197

Merged
merged 1 commit into from
Nov 15, 2024
Merged

Improve testing directions in the readme #197

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 1 addition & 1 deletion .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
matrix:
os: [ ubuntu-20.04 ]
rack: [ '~> 2.0', '~> 3.0' ]
ruby: [ 2.3, 2.4, 2.5, 2.6, 2.7, '3.0', 3.1, 3.2 ]
ruby: [ 2.3, 2.4, 2.5, 2.6, 2.7, '3.0', 3.1, 3.2, 3.3 ]
mpalmer marked this conversation as resolved.
Show resolved Hide resolved
gemfile: [ Gemfile ]
exclude:
# Rack 3 needs >= Ruby 2.4
Expand Down
17 changes: 7 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ This package is [semver compliant](https://semver.org); you should use a
pessimistic version constraint (`~>`) against the relevant `2.x` version of
this gem.

This version of `rack-contrib` is only compatible with `rack` 2.x. If you
This version of `rack-contrib` is compatible with `rack` 2.x and 3.x. If you
are using `rack` 1.x, you will need to use `rack-contrib` 1.x. A suitable
pessimistic version constraint (`~>`) is recommended.

Expand All @@ -74,19 +74,16 @@ pessimistic version constraint (`~>`) is recommended.

To contribute to the project, begin by cloning the repo and installing the necessary gems:

gem install json rack ruby-prof test-spec test-unit
gem install bundler
bundle install

To run the entire test suite, run
To run the entire test suite, run:

rake test
bundle exec rake test

To run a specific component's tests run
To run a specific component's tests, use the `TEST` environment variable:

specrb -Ilib:test -w test/spec_rack_thecomponent.rb

This works on ruby 1.8.7 but has problems under ruby 1.9.x.

TODO: instructions for 1.9.x and include bundler
TEST=test/spec_rack_thecomponent.rb bundle exec rake test

### Criteria for inclusion
The criteria for middleware being included in this project are roughly as follows:
Expand Down