From 92353864d5f94bbf2e8cb81c64622aed35763540 Mon Sep 17 00:00:00 2001 From: Nathan Pastor Date: Fri, 15 Nov 2024 11:56:46 -0500 Subject: [PATCH] Improve testing directions in the readme --- .github/workflows/ci.yml | 2 +- README.md | 17 +++++++---------- 2 files changed, 8 insertions(+), 11 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 885a697..eb539a1 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -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 ] gemfile: [ Gemfile ] exclude: # Rack 3 needs >= Ruby 2.4 diff --git a/README.md b/README.md index e46ec95..e9edf31 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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: