Cavalier

Exposes your your favorite selenium webdriver through a "page object"-esque interface / DSL.

Install

npm i -S cavalier

Usage

Please see examples/cucumber

API Reference (TBC)

Classes

Adapter

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

new Adapter(e)

| Param | Type | | --- | --- | | e | Element |

adapter.context([Element]) ⇒ Array.<(string|number)>

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 |

adapter.contextulise(e) ⇒ Object

Kind: instance method of Adapter

| Param | Type | | --- | --- | | e | Element |

Element

represents a single Element

Kind: global class

• Element
  • new Element([selector], [adapter], [index])
  • .selector ⇒ Array.<(string|number)>
  • .index ⇒ number
  • .adapter ⇒ adapter

new Element([selector], [adapter], [index])

| Param | Type | | --- | --- | | [selector] | string | | [adapter] | Object | | [index] | number |

element.selector ⇒ Array.<(string|number)>

Kind: instance property of Element

element.index ⇒ number

Kind: instance property of Element

element.adapter ⇒ adapter

Kind: instance property of Element

Elements

represents a collection of Elements

Kind: global class

• Elements
  • .length ⇒ Promise.<int>
  • .first ⇒ Element
  • .last ⇒ Element
  • .at(nth) ⇒ Element

elements.length ⇒ Promise.<int>

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 |

Interface

represents a whole or sub interface of "elements :?"

Kind: global class

• Interface
  • new Interface(adapter)
  • .adapter ⇒ Object
  • .root ⇒ Element
  • .element(name, selector) ⇒ Element
  • .elements(name, selector) ⇒ Array.<Element>
  • .section(SubInterface, name, selector) ⇒ Interface
  • .sections(SubInterface, name, selector) ⇒ Interfaces

new Interface(adapter)

| Param | Type | | --- | --- | | adapter | Object |

interface.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 |

Interfaces

represents a collection of Interfaces

Kind: global class

• Interfaces
  • new Interfaces(SubInterface, adapter)
  • .adapter ⇒ Object
  • .length ⇒ Promise.<int>
  • .first ⇒ Element
  • .last ⇒ Element
  • .at(nth) ⇒ Element

new Interfaces(SubInterface, adapter)

| Param | Type | Description | | --- | --- | --- | | SubInterface | Inteface | class | | adapter | Object | |

interfaces.adapter ⇒ Object

Kind: instance property of Interfaces

interfaces.length ⇒ Promise.<int>

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 |

Custom Adapter interface

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.

Road Map

v0.0.1

• [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

Thoughts

• Could this be used to write run browser driven tests, from within a browser? (e.g. using a insecure iframe ;)
• Better error handling?
• Performance?

LICENSE

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