Skip to content

Commit

Permalink
INTEGRATE: Documentation changes for 0.14.1 release
Browse files Browse the repository at this point in the history
* dev:
  Add missing 'Patches' header to changelog
  Document removal of Travis CI in credits
  Remove duplicate XCode version note from CONTRIBUTING.md
  Simplify debugging instructions in CONTRIBUTING.md
  Improve roadmap checkboxes
  Prepare documentation for 0.14.1 release
  • Loading branch information
jamesshore committed Apr 9, 2020
2 parents d145259 + b0c009e commit 0b40d62
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 40 deletions.
11 changes: 4 additions & 7 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,14 @@
Changes are listed by minor version, from newest to oldest. Under each minor version, patches are listed from oldest to newest.


## 0.15.x: Minor Rendered Element improvements

**9 Nov 2020.** A few small improvements to the behavior of the `element.rendered` descriptor. The code no longer throws an exception when different values are used for `overflow-x` and `overflow-y`, or if a compound `overflow` parameter is used.

**No breaking changes.**


## 0.14.x: Minor QFrame improvements

**14 Nov 2017.** This small release adds quality-of-life improvements to `QFrame`. Quixote now checks URLs asynchronously in `quixote.createFrame()`, which may speed up tests slightly. This also means Firefox and Chrome will no longer show XMLHttpRequest deprecation warnings in the console. In addition, several `QFrame` methods have been updated to fail fast if they're used before the frame is loaded, which will make debugging easier.

*Patches:*

* *0.14.1, 9 Apr 2020:* Bugfix: No longer throw exception when `element.rendered` descriptor sees different values for `overflow-x` and `overflow-y`, or if a compound `overflow` parameter is used.

**Breaking changes:**

* `QFrame.toDomElement()` now throws an exception if it's called before the frame is loaded.
Expand Down
18 changes: 5 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,23 +58,15 @@ To work with the code on your own computer:
At this time, the build has only been tested on Mac OS X. It should also work on Unix without any trouble. It's theoretically capable of working on Windows, but needs some script work before that's easy and convenient.
### Debugging with tests
### Visually inspecting test output
Sometimes, you'll need to manually inspect the results of a test. But Karma (our test runner) automatically resets itself after the end of every test run. To see the results, you need to press the "DEBUG" button on the Karma page in the browser you want to look at. This will open a new tab and run the tests in that tab. It doesn't automatically refresh, so after you make changes, you'll need to run the tests and then manually refresh the tab.

We have a global `beforeEach()` defined in `__reset.js` that resets the test frame before every test run, so you'll only be able to see the results of the last test that runs. Don't change `__reset.js`; instead, make the code run just the one test you want by using Mocha's `.only` feature. To use it, change the test function you care about from `it(...)` to `it.only(...)`. (You can also use `it.skip(...)` to skip tests.)
Therefore, use this process when manually debugging tests:
To look at the results of a test run, use this process:
1. Change the test you want to debug to use `it.only(...)`.
2. Run the tests using the `quick` option so the build only runs the tests you changed.
3. Press the 'Debug' button on the Karma page in the browser you want to check.
4. Debug.
a. Do some work.
b. Run the tests.
c. Refresh the Karma 'Debug' tab.
d. Repeat until done.
5. When done, remove any uses of `.only` and close the Karma 'Debug' tab.
4. Karma will open the test in a new tab and you'll be able to see the output.
4. To check again, run the tests again and reload Karma's debug tab.
### Build parameters
Expand Down Expand Up @@ -111,7 +103,7 @@ You can perform this one-time process to make it easier to run the Simulator:
1. Locate XCode.app in the Finder. It's probably in the Applications folder.
2. Right-click XCode.app and select "Show Package Contents".
3. Navigate to Contents/Developer/Applications. (This path is correct for XCode v11.3.1. It might be different for other versions.)
3. Navigate to Contents/Developer/Applications.
4. You should see Simulator.app. Right-click it and select "Make Alias".
5. Drag the alias to the Applications folder. You might find it useful to rename it to "iOS Simulator.app".
6. From now on, you should be able to run the Simulator by opening the alias in the Applications folder.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -482,7 +482,7 @@ Created by James Shore as part of the [Let's Code: Test-Driven JavaScript](http:
Many thanks to our contributors!
* Jay Bazuzi (@JayBazuzi): Travis CI integration (v0.1)
* Jay Bazuzi (@JayBazuzi): Travis CI integration (v0.1; removed in v0.14.1)
* Bjorn Hansen (@bjornicus): Fail fast if HTML or stylesheet URL is invalid (v0.3)
* Steve Henty (@cognivator): `QFrame.reload()` for single-page apps and other scripts (v0.11)
* Dave Woldrich (@woldie): `none` option in position and size descriptors, documentation improvements (v0.12)
Expand Down
30 changes: 11 additions & 19 deletions ROADMAP.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,21 @@

## Release Ideas

* ** v0.1** Basic DOM manipulation; raw position and style information
* ** v0.2** "Cooked" absolute position info; initial assertion API
* ** v0.3** Positioning relative to other elements
* ** v0.4** Advanced positioning (middle, center, height, width, arithmetic, fractions)
* ** v0.5** API hardening
* ** v0.6** Responsive design
* ** v0.7** Page and viewport assertions
* ** v0.8 - v0.11** Dogfooding and real-world usage (more dogfooding releases to come)
* ** v0.12** Element display status descriptors
* ** v0.13** Element rendering boundaries
* ** v0.14** QFrame quality of life improvements
* ** v0.1** Basic DOM manipulation; raw position and style information
* ** v0.2** "Cooked" absolute position info; initial assertion API
* ** v0.3** Positioning relative to other elements
* ** v0.4** Advanced positioning (middle, center, height, width, arithmetic, fractions)
* ** v0.5** API hardening
* ** v0.6** Responsive design
* ** v0.7** Page and viewport assertions
* ** v0.8 - v0.11** Dogfooding and real-world usage (more dogfooding releases to come)
* ** v0.12** Element display status descriptors
* ** v0.13** Element rendering boundaries
* ** v0.14** QFrame quality of life improvements
* **v0.15** New assertions
* See our [work-in-progress roadmap](https://github.com/jamesshore/quixote/blob/master/ROADMAP.md) for upcoming release plans.


## Current Feature: Issue #57

* Fix issue
* Document fix
* Fail fast when `overflow: overlay` used; say that it's deprecated
* Fail fast when `overflow: clip` used, but say that it could be added when browser support is added


## Upcoming Feature: Support for third-party assertion libraries

* Value.toPrimitive()
Expand Down

0 comments on commit 0b40d62

Please sign in to comment.