Exposes your your favorite selenium webdriver through a "page object"-esque interface / DSL.
npm i -S cavalier
Please see examples/cucumber
- Adapter
-
abstract object. Should be extended when used and not directly used as it is missing "length" method
- Element
-
represents a single Element
- Elements
-
represents a collection of Elements
- Interface
-
represents a whole or sub interface of "elements :?"
- Interfaces
-
represents a collection of Interfaces
abstract object. Should be extended when used and not directly used as it is missing "length" method
Kind: global class
-
Adapter
- new Adapter(e)
-
.context([Element]) ⇒
Array.<(string|number)> -
.contextulise(e) ⇒
Object
| Param | Type |
|---|---|
| e | Element |
get an "absolute" selector, where the context of the adapter "prefixed" on to the elements selector
Kind: instance method of Adapter
| Param | Type |
|---|---|
| [Element] | Object |
Kind: instance method of Adapter
| Param | Type |
|---|---|
| e | Element |
represents a single Element
Kind: global class
-
Element
- new Element([selector], [adapter], [index])
-
.selector ⇒
Array.<(string|number)> -
.index ⇒
number -
.adapter ⇒
adapter
| Param | Type |
|---|---|
| [selector] | string |
| [adapter] | Object |
| [index] | number |
Kind: instance property of Element
Kind: instance property of Element
Kind: instance property of Element
represents a collection of Elements
Kind: global class
promises to return the length of elements in the collection
Kind: instance property of Elements
elements.first ⇒ Element
returns an object that represents the first element in collection
Kind: instance property of Elements
elements.last ⇒ Element
returns an object that represents the last element in the collection
Kind: instance property of Elements
elements.at(nth) ⇒ Element
returns an object that represents the nth element in collection
Kind: instance method of Elements
| Param | Type |
|---|---|
| nth | number |
represents a whole or sub interface of "elements :?"
Kind: global class
| Param | Type |
|---|---|
| adapter | Object |
Kind: instance property of Interface
interface.root ⇒ Element
Kind: instance property of Interface
interface.element(name, selector) ⇒ Element
Kind: instance method of Interface
| Param | Type |
|---|---|
| name | string |
| selector | string |
interface.elements(name, selector) ⇒ Array.<Element>
Kind: instance method of Interface
| Param | Type |
|---|---|
| name | string |
| selector | string |
interface.section(SubInterface, name, selector) ⇒ Interface
Kind: instance method of Interface
| Param | Type |
|---|---|
| SubInterface | Interface |
| name | string |
| selector | string |
interface.sections(SubInterface, name, selector) ⇒ Interfaces
Kind: instance method of Interface
| Param | Type |
|---|---|
| SubInterface | Interface |
| name | string |
| selector | string |
represents a collection of Interfaces
Kind: global class
| Param | Type | Description |
|---|---|---|
| SubInterface | Inteface |
class |
| adapter | Object |
Kind: instance property of Interfaces
promises to return the length of interfaces in the collection
Kind: instance property of Interfaces
interfaces.first ⇒ Element
returns an object that represents the first inteface in collection
Kind: instance property of Interfaces
interfaces.last ⇒ Element
returns an object that represents the last inteface in the collection
Kind: instance property of Interfaces
interfaces.at(nth) ⇒ Element
returns an object that represents the nth inteface in collection
Kind: instance method of Interfaces
| Param | Type |
|---|---|
| nth | number |
The following methods are the minimum requirements for a custom adapter:
contextulise({Element} e) => {Object} (dependants: Interface, Interfaces)
context({Element} e) => {string} (dependants: Element)
length(Element e) => {number} (dependants: Elements, Interfaces)
methods() => {Array<string>} Optional: (dependants: Element)
See lib/adapter/webdriverio.js.
- [x] proof of concept
- [ ] used for a production ready system #proofOfUsefulness
- [ ] complete documentation and examples
- [ ] implement selenium driver based adapter (webdriverio, selenium-webdriver)
- [ ] implement non-selenium driver adapter (phantomjs, zombiejs)
- [ ] update documentation and examples
- [ ] rename Interface(s) => Component(s)
- [ ] rename adapter.contextulise => clone
- Could this be used to write run browser driven tests, from within a browser? (e.g. using a insecure iframe ;)
- Better error handling?
- Performance?
The MIT License (MIT)
Copyright (c) 2015 Mudi Renegare
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Generated: Sun 3 Jan 2016 00:05:21 GMT