casperjs 1.0.0.RC1 → 1.0.0

data/CHANGELOG.md

@@ -1,10 +1,298 @@
 CasperJS Changelog
 ==================
 
-XXXX-XX-XX, v1.0.0
+XXXX-XX-XX, v1.0.1
 ------------------
 
+- fixed [#336](https://github.com/n1k0/casperjs/issues/336) - Test result duration may have an exotic value
+
+2012-12-24, v1.0.0
+------------------
+
+### Important Changes & Caveats
+
+- PhantomJS 1.6.x support has been dropped. Both PhantomJS [1.7](http://phantomjs.org/release-1.7.html) & [1.8](http://phantomjs.org/release-1.8.html) will be supported.
+- the deprecated `injector` module has been removed from the codebase (RIP dude)
+- a [`1.0` maintenance branch](https://github.com/n1k0/casperjs/tree/1.0) has been created
+- CasperJS 1.1 development is now taking place on the `master` branch
+
+### Bugfixes & enhancements
+
+- fixed `page.initialized` event didn't get the initialized `WebPage` instance
+- fixed a bug preventing `Casper.options.onPageInitialized()` from being called
+- fixed [#215](https://github.com/n1k0/casperjs/issues/215) - fixed broken `--fail-fast` option creating an endless loop on error
+- fixed `Tester.renderFailureDetails()` which couldn't print failure details correctly in certain circumstances
+- fixed `Casper.getHTML()` wasn't retrieving active frame contents when using `Casper.withFrame()`
+- fixed [#327](https://github.com/n1k0/casperjs/issues/327) - event handler for `page.confirm` always returns true
+- merged PR [#322](https://github.com/n1k0/casperjs/pull/322) - Support number in `Casper.withFrame()`
+- fixed [#323](https://github.com/n1k0/casperjs/issues/323) - `thenEvaluate()` should be updated to take the same parameters as `evaluate()`, while maintaining backwards compatibility.
+- merged PR [#319](https://github.com/n1k0/casperjs/pull/319), fixed [#209](https://github.com/n1k0/casperjs/issues/209) - test duration has been added to XUnit XML result file.
+- `Casper.userAgent()` does not require the instance to be started anymore
+- dubious tests now have dedicated color & styling
+- added hint printing when a possible `casperjs` command call is detected
+
+2012-12-14, v1.0.0-RC6
+----------------------
+
+I'm still expecting a 1.0 stable for Christmas. Feedback: bring it on.
+
+### Important Changes & Caveats
+
+#### Added experimental support for frames
+
+A minimal convenient API has been added to Casper in order to ease the switch of current page context:
+
+```js
+casper.start('tests/site/frames.html', function() {
+    this.test.assertTitle('CasperJS frameset');
+});
+
+casper.withFrame('frame1', function() {
+    this.test.assertTitle('CasperJS frame 1');
+});
+
+casper.then(function() {
+    this.test.assertTitle('CasperJS frameset');
+});
+```
+
+#### Reverted to emulated mouse events
+
+Native mouse events didn't play well with (i)frames, because the computed element coordinates of the clicked element were erroneous.
+
+So programmatic mouse events are reintroduced back into this corrective RC until a better solution is found.
+
+### Bugfixes & enhancements
+
+- merged [#269](https://github.com/n1k0/casperjs/issues/269) - Windows Batch script: fixed unsupported spaces in path and argument splitting
+
+2012-12-10, v1.0.0-RC5
+----------------------
+
+I told you there won't be an 1.0.0-RC5? I lied. Expect 1.0 stable for Christmas, probably.
+
+### Important Changes & Caveats
+
+#### Casper.evaluate() signature compatibility with PhantomJS
+
+`Casper.evaluate()` method signature is now compatible with PhantomJS' one, so you can now write:
+
+```js
+casper.evaluate(function(a, b) {
+    return a === "foo" && b === "bar";
+}, "foo", "bar"); // true
+```
+
+The old way to pass arguments has been kept backward compatible in order not to break your existing scripts though:
+
+```js
+casper.evaluate(function(a, b) {
+    return a === "foo" && b === "bar";
+}, {a: "foo", b: "bar"}); // true
+```
+
+#### Specification of planned tests
+
+In order to check that every planned test has actuall been executed, a new optional `planned` parameter has been added to `Tester.done()`:
+
+```js
+casper.test.assert(true);
+casper.test.assert(true);
+casper.test.assert(true);
+casper.test.done(4);
+```
+
+Will trigger a failure:
+
+```
+fail: 4 tests planned, 3 tests executed.
+```
+
+That's especially useful in case a given test script is abruptly interrupted leaving you with no obvious way to know it and an erroneous success status.
+
+The whole [CapserJS test suite](https://github.com/n1k0/casperjs/tree/master/tests/) has been migrated to use this new feature.
+
+#### Experimental support for popups
+
+PhantomJS 1.7 ships with support for new opened pages — aka popups. CasperJS can now wait for a popup to be opened and loaded to react accordingly using the new [`Casper.waitForPopup()`](http://casperjs.org/api.html#casper.waitForPopup) and [`Casper.withPopup()`](http://casperjs.org/api.html#casper.withPopup) methods:
+
+```js
+casper.start('http://foo.bar/').then(function() {
+    this.test.assertTitle('Main page title');
+    this.clickLabel('Open me a popup');
+});
+
+// this will wait for the popup to be opened and loaded
+casper.waitForPopup(/popup\.html$/, function() {
+    this.test.assertEquals(this.popups.length, 1);
+});
+
+// this will set the popup DOM as the main active one only for time the
+// step closure being executed
+casper.withPopup(/popup\.html$/, function() {
+    this.test.assertTitle('Popup title');
+});
+
+// next step will automatically revert the current page to the initial one
+casper.then(function() {
+    this.test.assertTitle('Main page title');
+});
+```
+
+#### `Casper.mouseEvent()` now uses native events for most operations
+
+Native mouse events from PhantomJS bring a far more accurate behavior.
+
+Also, `Casper.mouseEvent()` will now directly trigger an error on failure instead of just logging an `error` event.
+
+### Bugfixes & enhancements
+
+- fixed [#308](https://github.com/n1k0/casperjs/issues/308) & [#309](https://github.com/n1k0/casperjs/issues/309) - proper module error backtraces
+- fixed [#306](https://github.com/n1k0/casperjs/issues/306) - Raise an explicit error on invalid test path
+- fixed [#300](https://github.com/n1k0/casperjs/issues/300) - Ensure that `findOne()` and `findAll()` observe the scope for XPath expressions, not just when passed CSS selectors
+- fixed [#294](https://github.com/n1k0/casperjs/issues/294) - Automatically fail test on any runtime error or timeout
+- fixed [#281](https://github.com/n1k0/casperjs/issues/281) - `Casper.evaluate()` should take an array as context not object
+- fixed [#266](https://github.com/n1k0/casperjs/issues/266) - Fix `tester` module and its self tests
+- fixed [#268](https://github.com/n1k0/casperjs/issues/266) - Wrong message on step timeout
+- fixed [#215](https://github.com/n1k0/casperjs/issues/215) - added a `--fail-fast` option to the `casper test` command, in order to terminate a test suite execution as soon as any failure is encountered
+- fixed [#274](https://github.com/n1k0/casperjs/issues/274) - some headers couldn't be set
+- fixed [#277](https://github.com/n1k0/casperjs/issues/277) - multiline support in `ClientUtils.echo()`
+- fixed [#282](https://github.com/n1k0/casperjs/issues/282) - added support for remote client scripts loading with a new `remoteScripts` casper option
+- fixed [#290](https://github.com/n1k0/casperjs/issues/#290) - add a simplistic RPM spec file to make it easier to (un)install casperjs
+- fixed [`utils.betterTypeOf()`](http://casperjs.org/api.html#casper.betterTypeOf) to properly handle `undefined` and `null` values
+- fixed `Casper.die()` and `Casper.evaluateOrDie()` were not printing the error onto the console
+- added JSON support to `require()`
+- added [`Tester.assertTruthy()`](http://casperjs.org/api.html#tester.assertTruthy) and [`Tester.assertFalsy()`](http://casperjs.org/api.html#tester.assertFalsy)
+- added [`Casper.sendKeys()`](http://casperjs.org/api.html#casper.sendKeys) to send native keyboard events to the element matching a given selector
+- added [`Casper.getFormValues()`](http://casperjs.org/api.html#casper.getFormValues) to check for the field values of a given form
+- added [`Tester.assertTextDoesntExist()`](http://casperjs.org/api.html#tester.assertTextDoesntExist)
+- added `Tester.assertFalse()` as an alias of `Tester.assertNot()`
+- added `page.resource.requested` and `page.resource.received` events
+- added [`translate.js`](https://github.com/n1k0/casperjs/tree/master/samples/translate.js) and [`translate.coffee`](https://github.com/n1k0/casperjs/tree/master/samples/translate.coffee) samples
+
+2012-10-31, v1.0.0-RC4
+----------------------
+
+Next version should be 1.0.0 stable.
+
+- fixed [#261](https://github.com/n1k0/casperjs/issues/261) - Impossible to require CoffeeScript modules
+- fixed [#262](https://github.com/n1k0/casperjs/issues/262) - Injecting clientScripts is not working
+- fixed [#259](https://github.com/n1k0/casperjs/issues/259) - enhanced `Tester.assertField()` method, which can now tests for other field types than `input`s.
+- fixed `Casper.getCurrentUrl()` could misbehave with encoded urls
+- added [`Casper.echo()`](http://casperjs.org/api.html#clientutils.echo) to print a message to the casper console from the remote DOM environment
+- added [`Casper.waitForText()`](http://casperjs.org/api.html#casper.waitForText) to wait for a given text to be present in page HTML contents
+- added [`ClientUtils.getFieldValue()`](http://casperjs.org/api.html#clientutils.getFieldValue)
+- Local CoffeeScript version has been upgraded to 1.4.0
+
+2012-10-23, v1.0.0-RC3
+----------------------
+
+### Important Changes & Caveats
+
+- the `injector` module is now deprecated, but kept for backward compatibility purpose.
+- **BC BREAK**: fixes [#220](https://github.com/n1k0/casperjs/issues/220), [#237](https://github.com/n1k0/casperjs/issues/237) - added a `waitTimeout` options, removed `defaultWaitTimeout` option.
+- **BC BREAK** (for the better): fixes [#249](https://github.com/n1k0/casperjs/issues/249) - default timeout functions don't `die()` anymore in tests
+- **BC BREAK** (for the better): merged [#188](https://github.com/n1k0/casperjs/issues/188) - Easy access to current response object;
+  You can now access the current response object as the first parameter of step callbacks:
+
+```javascript
+require('casper').create().start('http://www.google.fr/', function(response) {
+    require('utils').dump(response);
+}).run();
+```
+
+That gives:
+
+```
+$ casperjs dump-headers.js
+{
+    "contentType": "text/html; charset=UTF-8",
+    "headers": [
+        {
+            "name": "Date",
+            "value": "Thu, 18 Oct 2012 08:17:29 GMT"
+        },
+        {
+            "name": "Expires",
+            "value": "-1"
+        },
+        // ... lots of other headers
+    ],
+    "id": 1,
+    "redirectURL": null,
+    "stage": "end",
+    "status": 200,
+    "statusText": "OK",
+    "time": "2012-10-18T08:17:37.068Z",
+    "url": "http://www.google.fr/"
+}
+```
+
+To fetch a particular header by its name:
+
+```javascript
+require('casper').create().start('http://www.google.fr/', function(response) {
+    this.echo(response.headers.get('Date'));
+}).run();
+```
+
+That gives:
+
+```javascript
+$ casperjs dump-single-header.js
+Thu, 18 Oct 2012 08:26:34 GMT
+```
+
+The documentation has been [updated accordingly](http://casperjs.org/api.html#casper.then.callbacks).
+
+### Bugfixes & enhancements
+
+- merged [#234](https://github.com/n1k0/casperjs/issues/234) - New Windows Loader written in Batch. Python is no more a requirement for using CasperJS on Windows. New installation instructions are [available](http://casperjs.org/installation.html#windows).
+- a new `onWaitTimeout` option has been added, to allow defining a default behavior when a `waitFor*` function times out.
+- [Casper.resourceExists()](http://casperjs.org/api.html#casper.resourceExists) and related functions now checks for non HTTP-404 received responses.
+- fixed [#167](https://github.com/n1k0/casperjs/issues/167) - fixed opening truncated/uncomplete root urls may give erroneous HTTP statuses
+- closes [#205](https://github.com/n1k0/casperjs/issues/205) - [`debugHTML()`](http://casperjs.org/api.html#casper.debugHTML) can have a selector passed; added [`getHTML()`](http://casperjs.org/api.html#casper.getHTML)
+- closes [#230](https://github.com/n1k0/casperjs/issues/230) - added [`ClientUtils.getElementsBound()`](http://casperjs.org/api.html#clientutils.getElementsBounds) and [`Casper.getElementsBound()`](http://casperjs.org/api.html#casper.getElementsBounds)
+- fixed [#235](https://github.com/n1k0/casperjs/issues/235) - updated `Casper.evaluate()` to use phantomjs >= 1.6 native one. As a consequence, **the `injector` module is marked as deprecated**.
+- fixed [#250](https://github.com/n1k0/casperjs/issues/250) - prevent self tests to be run using the standard `casper test` command
+- fixed [#254](https://github.com/n1k0/casperjs/issues/254) - fix up one use of qsa, hit when filling forms with missing elements
+- [fixed](https://github.com/n1k0/casperjs/commit/ef6c1828c7b64e1cf99b98e27600d0b63308cad3) edge case when current document url couldn't be properly decoded
+
+2012-10-01, v1.0.0-RC2
+----------------------
+
+### Important Changes & Caveats
+
+- **PhantomJS 1.6 is now the minimal requirement**, PhantomJS 1.7 is supported.
+- CasperJS continues to ship with its own implementation of CommonJS' module pattern, due to the way it has to work to offer its own executable. While the implementations are nearly the same, **100% compatibility is not guaranteed**.
+
+### Bugfixes & enhancements
+
+- fixed [#119](https://github.com/n1k0/casperjs/issues/119) - `Casper.currentHTTPStatus` now defaults to `null` when resource are loaded using the `file://` protocol
+- fixed [#130](https://github.com/n1k0/casperjs/issues/130) - added a `--no-colors` option to the `casper test` command to skip output coloration
+- fixed [#153](https://github.com/n1k0/casperjs/issues/153) - erroneous mouse event results when `event.preventDefault()` was used.
 - fixed [#164](https://github.com/n1k0/casperjs/issues/164) - ability to force CLI parameters as strings (see [related documentation](http://casperjs.org/cli.html#raw)).
+- fixed [#178](https://github.com/n1k0/casperjs/issues/178) - added `Casper.getPageContent()` to access raw page body contents on non-html received content-types.
+- fixed [#180](https://github.com/n1k0/casperjs/issues/180) - CasperJS tests are now run against a local HTTP test server. A new `casper selftest` command has been added as well.
+- fixed [#189](https://github.com/n1k0/casperjs/issue/189) - fixed invalid XML due to message colorization
+- fixed [#197](https://github.com/n1k0/casperjs/pull/197) & [#240](https://github.com/n1k0/casperjs/pull/240/) - Added new tester methods:
+  * [`assertField`](http://casperjs.org/api.html#tester.assertField)
+  * [`assertSelectorHasText`](http://casperjs.org/api.html#tester.assertSelectorHasText)
+  * [`assertSelectorDoesntHaveText`](http://casperjs.org/api.html#tester.assertSelectorDoesntHaveText)
+  * [`assertVisible`](http://casperjs.org/api.html#tester.assertVisible)
+  * [`assertNotVisible`](http://casperjs.org/api.html#tester.assertNotVisible)
+- fixed [#202](https://github.com/n1k0/casperjs/pull/202) - Fix test status timeouts when running multiple suites
+- fixed [#204](https://github.com/n1k0/casperjs/pull/204) - Fix for when the url is changed via javascript
+- fixed [#210](https://github.com/n1k0/casperjs/pull/210) - Changed `escape` to `encodeURIComponent` for downloading binaries via POST
+- fixed [#216](https://github.com/n1k0/casperjs/pull/216) - Change clientutils to be able to set a global scope
+- fixed [#219](https://github.com/n1k0/casperjs/issues/219) - ease chaining of `run()` calls ([more explanations](https://groups.google.com/forum/#!topic/casperjs/jdQ-CrgnUd8))
+- fixed [#222](https://github.com/n1k0/casperjs/pull/222) & [#211](https://github.com/n1k0/casperjs/issues/211) - Change mouse event to include an X + Y value for click position
+- fixed [#231](https://github.com/n1k0/casperjs/pull/231) - added `--pre` and `--post` options to the `casperjs test` command to load test files before and after the execution of testsuite
+- fixed [#232](https://github.com/n1k0/casperjs/issues/232) - symlink resolution in the ruby version of the `casperjs` executable
+- fixed [#236](https://github.com/n1k0/casperjs/issues/236) - fixed `Casper.exit` returned `this` after calling `phantom.exit()` which may caused PhantomJS to hang
+- fixed [#252](https://github.com/n1k0/casperjs/issues/252) - better form.fill() error handling
+- added [`ClientUtils.getDocumentHeight()`](http://casperjs.org/api.html#clientutils.getDocumentHeight)
+- added [`toString()`](http://casperjs.org/api.html#casper.toString) and [`status()`](http://casperjs.org/api.html#casper.status) methods to `Casper` prototype.
 
 2012-06-26, v1.0.0-RC1
 ----------------------

data/CONTRIBUTING.md

@@ -0,0 +1,93 @@
+# Contribution Guide
+
+*Note: this guide has been heavily inspired by [PhantomJS' one](https://github.com/ariya/phantomjs/blob/master/CONTRIBUTING.md).*
+
+**This page describes how to contribute changes to the [CasperJS](http://casperjs.org/) project.**
+
+Please do **not** create a pull request without reading this guide first. Failure to do so may result in the **rejection** of the pull request.
+
+## For The Impatients
+
+**Work on a feature branch**.
+If your changes need to be modified due to some reviews, it is less clutter to tweak an isolated feature branch and push it again.
+
+**Create a ticket in the [issue tracker](https://github.com/n1k0/casperjs/issues/)**.
+This serves as a placeholder for important feedback, review, or any future updates. **Please ensure searching the bugtracker for an already opened issue matching your case before filing a new issue.**
+
+In the commit message(s):
+
+* **Keep the first line short**. Write additional paragraphs if necessary.
+* **Reference an opened issue**, by referencing the issue ID prefixed by a `#` and the keyword `refs`, eg. `refs #123`
+
+Sample commit message:
+
+> refs #123 - fixed error message formatting
+>
+> (optional: a short explanation of what the patch actually does)
+
+**Run tests**
+
+Run CasperJS' test suite to see you didn't break something:
+
+    $ casperjs selftest
+
+The result status bar **must be green** before sending your PR.
+
+## Communicate
+
+**Improvement and feature request**. If you have an improvement idea, please send an email to the [mailing list](http://groups.google.com/group/casperjs) (preferable than contacting the developers directly) so that other people can give their insights and opinions. This is also important to avoid duplicate work.
+
+**Help request**. If you're stuck using CasperJS and don't understand how to achieve something, please [ask on the mailing-list](https://groups.google.com/forum/#!forum/casperjs) first. Please don't ask for all the kind people to write your scripts for you.
+
+**Ensure the issue is related to CasperJS**. Please try to reproduce the issue using plain PhantomJS. If it works with the native PhantomJS API but doesn't with CasperJS, then the issue is probably valid. In the opposite case, please file an issue on [PhantomJS issue tracker](http://code.google.com/p/phantomjs/issues/list).
+
+**Extending with new API**. Whenever you want to introduce a new API, please send an email to the mailing list along with the link to the issue if any. It may require few iterations to agree on the final API and hence it is important to engage all interested parties as early as possible.
+
+## Get Ready
+
+### Use Feature Branch
+
+To isolate your change, please avoid working on the master branch. Instead, work on a *feature branch* (often also known as *topic branch*). You can create a new branch (example here crash-fix) off the master branch by using:
+
+    git checkout -b crash-fix master
+
+Refer to your favorite Git tutorial/book for further detailed help.
+
+Some good practices for the feature branch:
+
+* Give it a meaningful name instead of, e.g. `prevent-zero-divide` instead of just `fix`
+* Make *granular* and *atomic* commits, e.g. do not mix a typo fix with some major refactoring
+* Keep one branch for one specific issue. If you need to work on other unrelated issues, create another branch.
+
+### Write tests
+
+CasperJS being partly a testing framework, how irrelevant would be to send a pull request with no test? So, please take the time to write and attach tests to your PR. Furthermore, testing with CasperJS is quite [exhaustively documented](http://casperjs.org/testing.html).
+
+### Run tests!
+
+This may sound obvious but **don't send pull requests which break the casperjs test suite**.
+
+To see if your modifications broke the suite, just run:
+
+    $ casperjs selftest
+
+### Write documentation
+
+Do you appreciate the [CasperJS documentation](http://casperjs.org/)? I do too. As the documentation contents are managed and generated using Github, Markdown and CasperJS itself, take the time to read the [Documentation Contribution Guide](https://github.com/n1k0/casperjs/blob/gh-pages/README.md#casperjs-documentation) and write the documentation related to your PR whenever applicable.
+
+**Note:** As the documentation is handled in a [dedicated separated `gh-pages` branch](https://github.com/n1k0/casperjs/tree/gh-pages), you'll have to send a dedicated PR for doc patches. I'm working on a more comfortable solution, but it's no easy task though.
+
+## Review and Merge
+
+When your branch is ready, send the pull request.
+
+While it is not always the case, often it is necessary to improve parts of your code in the branch. This is the actual review process.
+
+Here is a check list for the review:
+
+* It does not break the test suite
+* There is no typo
+* The coding style follows the existing one
+* There is a reasonable amount of comment
+* The license header is intact
+* All examples are still working

data/CONTRIBUTORS.md

@@ -0,0 +1,53 @@
+# CasperJS contributors
+
+You can check out the [contribution graphs on github](https://github.com/n1k0/casperjs/graphs/contributors).
+
+```
+$ git shortlog -s -n | cut -c8-
+Nicolas Perriault
+Brikou CARRE
+oncletom
+hannyu
+Chris Lorenzo
+Victor Yap
+nrabinowitz
+pborreli
+Rob Barreca
+Andrew Childs
+Solomon White
+reina.sweet
+Dave Lee
+Reina Sweet
+Elmar Langholz
+Jason Funk
+Donovan Hutchinson
+Julien Moulin
+Michael Geers
+Jan Schaumann
+Clochix
+Raphaël Benitte
+Tim Bunce
+alfetopito
+jean-philippe serafin
+snkashis
+Andrew de Andrade
+Ben Lowery
+Chris Winters
+Christophe Benz
+Harrison Reiser
+Jan Pochyla
+Jan-Martin Fruehwacht
+Julian Gruber
+Justin Slattery
+Justine Tunney
+KaroDidi
+Leandro Boscariol
+Maisons du monde
+Marcel Duran
+Mathieu Agopian
+Mehdi Kabab
+Mikko Peltonen
+Pascal Borreli
+Rafael
+Rafael Garcia
+```

data/README.md

@@ -23,7 +23,35 @@ Subscribe to the [project mailing-list](https://groups.google.com/forum/#!forum/
 
 Follow the CasperJS project [on twitter](https://twitter.com/casperjs_org) and [Google+](https://plus.google.com/b/106641872690063476159/).
 
-## Contributing to the docs
+## Show me some code!
+
+Sample test to see if some dropdown can be opened:
+
+```javascript
+casper.start('http://twitter.github.com/bootstrap/javascript.html#dropdowns', function() {
+    this.test.assertExists('#navbar-example');
+    this.click('#dropdowns .nav-pills .dropdown:last-of-type a.dropdown-toggle');
+    this.waitUntilVisible('#dropdowns .nav-pills .open', function() {
+        this.test.pass('Dropdown is open');
+    });
+});
+
+casper.run(function() {
+    this.test.done();
+});
+```
+
+Run the script:
+
+![](http://cl.ly/image/112m0F2n162i/Capture%20d%E2%80%99%C3%A9cran%202012-10-19%20%C3%A0%2016.37.15.png)
+
+## Contributing
+
+### Contributing code
+
+Please read the [CONTRIBUTING.md](https://github.com/n1k0/casperjs/blob/master/CONTRIBUTING.md) file contents.
+
+### Contributing documentation
 
 CasperJS's documentation is written using the [Markdown format](http://daringfireball.net/projects/markdown/), and hosted on Github thanks to the [Github Pages Feature](http://pages.github.com/).