Merge pull request #78 from mobify/release-2.1.0

Release 2.1.0

Author: ellenmobify

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,6 +1,6 @@
 Status: **Ready for Review** or **Open for Visibility**
 Owner: 
-Reviewers: @ellenmobify @marlowpayne @mikenikles
+Reviewers: @ellenmobify @jasecode
 
 ## Changes
 - (change1)

CHANGELOG

@@ -1,3 +1,7 @@
+2.1.0
+    - Adds a `triggerClick` command that uses JavaScript's click.
+    - Renames `navigate` to `clickAndWaitUntilMobified` to avoid colliding with a core Nightwatch command with the same name. Resolves https://github.com/mobify/nightwatch-commands/issues/74
+    - Warnings related to a missing `site.json` should no longer be output if not using the `.preview()` command. Resolves https://github.com/mobify/nightwatch-commands/issues/73
 2.0.1
     -Update [selenium-download](https://github.com/groupon/selenium-download) to 2.0.10
         - selenium chromedriver 2.29

README.md

@@ -165,9 +165,9 @@ this.demoTest = function (browser) {
 };
 ```
 
-#### navigate(selector, callback)
+#### clickAndWaitUntilMobified(selector, callback)
 
-The `navigate` command initiates a `click` command on the supplied selector link, navigates to the URL, and then it initiates the `waitUntilMobified` function before it continues the chain of tests.
+The `clickAndWaitUntilMobified` command initiates a `click` command on the supplied selector link, navigates to the URL, and then it initiates the `waitUntilMobified` function before it continues the chain of tests.
 
 Parameter Name | Parameter Type | Description
 -------------  | -------------- | -----------
@@ -176,7 +176,7 @@ callback       | Function       | _optional_ A function to call after the curren
 
 ```
 this.demoTest = function (browser) {
-    browser.navigate('.myLink');
+    browser.clickAndWaitUntilMobified('.myLink');
 };
 ```
 
@@ -267,6 +267,21 @@ this.demoTest = function (browser) {
 };
 ```
 
+#### triggerClick(selector, callback)
+
+The `triggerClick` command uses Javascript's click function on a given selector. Use this when the regular Selenium `.click` does not work. 
+
+Parameter Name | Parameter Type | Description
+-------------  | -------------- | -----------
+selector       | String         | The CSS/Xpath selector to locate the element.
+callback       | Function       | _optional_ A function to call after the current command finishes execution.  
+
+```
+this.demoTest = function (browser) {
+    browser.triggerClick('.myLink');
+};
+```
+
 #### triggerTouch(selector, type, callback)
 
 The `triggerTouch` command simulates a specified touch type event on the supplied DOM element. Use this command when Selenium's `click` does not register.

commands/navigate.js commands/clickAndWaitUntilMobified.jscommands/navigate.js renamed to commands/clickAndWaitUntilMobified.js

@@ -27,35 +27,34 @@
  */
 
 var path = require('path');
+var qs = require('querystring');
 
-try {
-    var siteConfig = require(path.join(path.resolve('./'), '/tests/system/site.json'));
-} catch (e) {
-    if (e instanceof Error && e.code === 'MODULE_NOT_FOUND') {
-        console.log('Not using optional site.json. Looking for site.js...');
-    }
-}
+exports.command = function(url, callback) {
+    var browser = this;
 
-try {
-    var siteConfig = require(path.join(path.resolve('./'), '/tests/system/site.js'));
-} catch (e) {
-    if (e instanceof Error && e.code === 'MODULE_NOT_FOUND') {
-        console.log('Not using optional /tests/system/site.js.');
+    try {
+        var siteConfig = require(path.join(path.resolve('./'), '/tests/system/site.json'));
+    } catch (e) {
+        if (e instanceof Error && e.code === 'MODULE_NOT_FOUND') {
+            console.log('Not using optional site.json. Looking for site.js...');
+        }
     }
-}
 
-try {
-    var siteConfig = require(path.join(path.resolve('./'), '/system/site.js'));
-} catch (e) {
-    if (e instanceof Error && e.code === 'MODULE_NOT_FOUND') {
-        console.log('Not using optional /system/site.js.');
+    try {
+        var siteConfig = require(path.join(path.resolve('./'), '/tests/system/site.js'));
+    } catch (e) {
+        if (e instanceof Error && e.code === 'MODULE_NOT_FOUND') {
+            console.log('Not using optional /tests/system/site.js.');
+        }
     }
-}
 
-var qs = require('querystring');
-
-exports.command = function(url, callback) {
-    var browser = this;
+    try {
+        var siteConfig = require(path.join(path.resolve('./'), '/system/site.js'));
+    } catch (e) {
+        if (e instanceof Error && e.code === 'MODULE_NOT_FOUND') {
+            console.log('Not using optional /system/site.js.');
+        }
+    }
 
     if (siteConfig) {
         var site = siteConfig.profiles[siteConfig.activeProfile];

commands/preview.js

@@ -0,0 +1,13 @@
+exports.command = function(selector, callback) {
+    var client = this;
+    /*
+    / Use Javascript's click when Selenium's does not register.
+    */
+    client.execute('document.querySelector("' + selector + '").click();', function(result) {
+        if (typeof callback === 'function') {
+            callback.call(client, result);
+        }
+    });
+
+    return this;
+};

commands/triggerClick.js

@@ -1,6 +1,6 @@
 {
   "name": "nightwatch-commands",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "description": "A set of Mobify specific custom commands for Nightwatch.js",
   "repository": {
     "type": "git",