Skip to content

Commit

Permalink
Move testing info to CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mislav committed Mar 13, 2015
1 parent 8099146 commit 3b1163e
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 18 deletions.
37 changes: 37 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Contributing

For running the tests, you will need:

* Ruby 1.9.3+ with Bundler
* PhantomJS (for headless testing)

First run bootstrap to ensure necessary dependencies:

```
$ script/bootstrap
```

Then run headless tests in the console:

```
$ script/test [<test-file>]
```

To run tests in other browsers, start a server:

```
$ script/server
# now open http://localhost:4567/
```

## Test structure

There are 3 main test modules:

* `test/unit/fn_pjax.js` - Primarily tests the `$.fn.pjax` method and its options
* `test/unit/pjax.js` - Main comprehensive pjax functionality tests
* `test/unit/pjax_fallback.js` - Tests that verify same result after navigation
even if pjax is disabled (like for browsers that don't support pushState).

Each test drives a hidden test page in an `<iframe>`. See other tests to see how
they trigger pjax by using the `frame` reference and remember to do so as well.
18 changes: 0 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -386,24 +386,6 @@ end

Deploying a deploy, bumping the version constant to force clients to do a full reload the next request getting the new layout and assets.

## Contributing

```
$ git clone https://github.com/defunkt/jquery-pjax.git
$ cd jquery-pjax/
```

To run the test suite locally, start up the Sinatra test application.

```
$ bundle install
$ bundle exec ruby test/app.rb
== Sinatra/1.4.5 has taken the stage on 4567 for development with backup from WEBrick
# in another tab:
$ open http://localhost:4567/
```

[compat]: http://caniuse.com/#search=pushstate
[$.fn.on]: http://api.jquery.com/on/
[$.ajax]: http://api.jquery.com/jQuery.ajax/
Expand Down

0 comments on commit 3b1163e

Please sign in to comment.