Merge pull request #76 from isleofcode/feat/live-reload-automation

feat(live-reload): automates and eases onboarding for live-reload

Author: alexblom

.editorconfig

@@ -12,6 +12,7 @@ trim_trailing_whitespace = true
 insert_final_newline = true
 indent_style = space
 indent_size = 2
+max_line_length = 80;
 
 [*.js]
 indent_style = space

.eslintrc.js

@@ -70,7 +70,7 @@ module.exports = {
     /*** Strict Mode ***/
 
     // JSHint "strict"
-    'strict': [2, 'global'],
+    'strict': [0, 'global'],
 
 
     /*** Variables ***/

README.md

@@ -1,4 +1,4 @@
-# Ember Cordova (beta)
+# Ember Cordova
 
 [![Build Status](https://travis-ci.org/isleofcode/ember-cordova.svg?branch=feat%2Ftravis)](https://travis-ci.org/isleofcode/ember-cordova)
 
@@ -36,7 +36,7 @@ If you are migrating from ember-cli-cordova, read the [migration
 guide](docs/migration-from-ember-cli.md).
 
 
-```
+```cli
   ember install ember-cordova
 ```
 
@@ -46,11 +46,11 @@ name will be used.
 
 If you already have a Cordova project here it will not be overwritten.
 
-1. ####Set your config.locationType to 'hash'.
+1. #### Set your config.locationType to 'hash'.
 
 2. As a final step, add your desired platforms, e.g.:
 
-```
+```cli
 ember cdv platform add ios
 ember cdv platform add android
 ember cdv platform add browser #experimental
@@ -62,7 +62,8 @@ Cordova working relies on the cordova.js script being injected. By default, this
 
 Some cordova/phonegap plugins have browser fallbacks. For example [phonegap-plugin-barcodescanner](https://github.com/phonegap/phonegap-plugin-barcodescanner) will ask you to manually type the barcode value. Using the browser platform, you'll be able to develop your cordova app as it was a regular ember app.
 
-##Features and Documentation
+## Features and Documentation
+
 * [CLI](docs/cli.md)
 * [Cordova Service & Event Bindings](docs/services/cordova.md)
 * Device:
@@ -74,24 +75,23 @@ Some cordova/phonegap plugins have browser fallbacks. For example [phonegap-plug
 * [Live reload](docs/livereload.md)
 * [Available Plugins](docs/plugins.md)
 
-##Upcoming Extensions
+## Upcoming Extensions
 
 We are working on four major items right now:
 
 1. Improving test coverage;
-2. Livereload improvements;
-3. Bindings to Cordova Plugins [see plugins](docs/plugins.md); and
-4. Either having ember install ember-cordova-plugin-foo install both the
+2. Bindings to Cordova Plugins [see plugins](docs/plugins.md); and
+3. Either having ember install ember-cordova-plugin-foo install both the
 ember addon & cordova plugin, or achieving the same through ember
 cdv:install foo.
 
-##Contributing
+## Contributing
 
 PRs are very welcome. You can read our style guides [here](https://github.com/isleofcode/style-guide).
 
 If you are unsure about your contribution idea, please feel free to
 open an Issue for feedback.
 
-##Credits
+## Credits
 
 ember-cordova is maintained by [Isle of Code](https://isleofcode.com), and started as a fork of [ember-cli-cordova](https://github.com/poetic/ember-cli-cordova).

docs/livereload.md

@@ -1,11 +1,69 @@
-##Live reload
+# Device Live Reload
+
+Live reload works for device & simulator builds. It is automatically enabled and configured for `ember-cordova`
+`>= 0.2.0`.  Instructions for advanced configuration are below.
+
+**Caveats**
+
+- Live reload will not run in production or test environments.
+Your computer and phone must be on the same network.
+
+- Live reload is for assistance in developing your application (just like
+ember-cli's live-reload in the browser). It is not a solution for delivering
+updates to a production application.
+
+- If you are on Android >4.0, you will need to also install the whitelist plugin:
+` ember cdv plugin add cordova-plugin-whitelist `
+
+For help troubleshooting earlier versions, see the [old version guide](#old-version-guide).
+
+## Basic usage
+
+```
+  ember cdv:serve
+```
+
+You can use s as a shorthand. Serve takes a platform option (e.g. android
+or ios) and any options accepted by Ember serve.
+
+## Advanced Configuration
+
+There are times you may find yourself wanting to enable live-reload 
+from a remote host and port, or to customize a local url.
+
+## Customize the device live-reload url
+
+In all cases below, `<url>` refers to the full url including protocol,
+host, and port.
+
+*via commandline arg*
+
+```cli
+ember cdv:serve --reload-url="<url>"
+```
+
+or
+
+```cli
+ember cdv:s -r "<url>"
+```
+
+*via .ember-cli*
+
+```json
+{
+  deviceLiveReloadUrl: "<url>"
+}
+```
+
+---------------------------------------------------------------------
+
+# Old Version Guide
 
 There are a few manual steps to getting live reload working right now.
 We hope to eventually automate them.
 
-live reload will not run in production or test environments. Your computer and phone must be on the same network.
-
-* Modify Cordovas config.xml to allow-navigation to http based urls. You can either specify localhost:4200, your local IP,
+* Modify Cordova's config.xml to allow-navigation to http based urls. You can either specify localhost:4200, your local IP,
 or a wildcard. Wildcards are generally unsafe, and you should comment them out before production builds.
 
 ```
@@ -43,7 +101,7 @@ You can run the app on an emulator or any device connected to your local network
 * Because cordova:serve creates a new build, you should re-build when
   you are finished.
 
-###Troubleshooting / Finding your Network IP
+#### Troubleshooting / Finding your Network IP
 
 * If the defaults don't work, you will need to find your computers network ip and use
 the reload-url param. For Mac Users, you can find your Network IP at System Preferences -> Network.

index.js

@@ -2,8 +2,7 @@
 
 var commands              = require('./lib/commands');
 var cordovaPath           = require('./lib/utils/cordova-path');
-var isTargetCordova       = require('./lib/utils/is-target-cordova');
-var isCordovaLiveReload   = require('./lib/utils/is-cordova-live-reload');
+var getNetworkIp          = require('./lib/utils/get-network-ip');
 
 var chalk                 = require('chalk');
 var mergeTrees            = require('broccoli-merge-trees');
@@ -14,31 +13,34 @@ var fs                    = require('fs');
 module.exports = {
   name: 'ember-cordova',
 
-  config: function (env, baseConfig) {
-    if (isCordovaLiveReload()) {
-      var conf = {};
-      //If cordova live reload, set the reload url
-      var reloadUrl = process.env.CORDOVA_RELOAD_ADDRESS;
-      conf.cordova = {};
-      conf.cordova.reloadUrl = reloadUrl;
+  config: function(/* env, baseConfig */) {
+    if (this.project.targetIsCordova) {
+      var conf = { cordova: {} };
+      if (!!this.project.RELOAD_PORT) {
+        //If cordova live reload, set the reload url
+        var networkAddress = getNetworkIp();
+        var deviceServerUrl = 'http://' + networkAddress + ':' + this.project.RELOAD_PORT;
+
+        conf.cordova.reloadUrl = deviceServerUrl;
+      }
 
       return conf;
     }
   },
 
-  contentFor: function (type) {
-    if (isTargetCordova() && type === 'body') {
+  contentFor: function(type) {
+    if (this.project.targetIsCordova && type === 'body') {
       return '<script src="cordova.js"></script>';
     }
   },
 
-  includedCommands: function () {
+  includedCommands: function() {
     return commands;
   },
 
-  treeForPublic: function (tree) {
-    if (isCordovaLiveReload()) {
-      var platform = process.env.CORDOVA_PLATFORM;
+  treeForPublic: function(tree) {
+    if (this.project.targetIsCordova) {
+      var platform = this.project.CORDOVA_PLATFORM;
 
       var platformsPath = path.join(cordovaPath(this.project), 'platforms');
       var pluginsPath;
@@ -51,7 +53,7 @@ module.exports = {
         pluginsPath = path.join(platformsPath, 'browser', 'www');
       }
 
-      var files = ['cordova.js', 'cordova_plugins.js'];
+      var files = ['cordova_plugins.js'];
 
       files.forEach(function (file) {
         var filePath = path.join(pluginsPath, file);
@@ -72,8 +74,6 @@ module.exports = {
         destDir: '/'
       });
 
-      this.ui.writeLine(chalk.green('ember-cordova: Device LiveReload is enabled'));
-
       return mergeTrees([tree, pluginsTree]);
     }
 

lib/commands/build.js

@@ -1,60 +1,77 @@
 'use strict';
 
-var EmberBuildTask  = require('../tasks/ember-build');
 var CdvBuildTask    = require('../tasks/cordova-build');
-var LinkTask        = require('../tasks/link-environment');
 var HookTask        = require('../tasks/run-hook');
+var BuildTask       = require('../tasks/ember-build');
 
-var defaultPlatform = require('../utils/default-platform');
+var validateLocationType    = require('../utils/validate-location-type');
+var getCordovaConfig        = require('../utils/get-cordova-config');
+var validateAllowNavigation = require('../utils/validate-allow-navigation');
 
-var validateLocationType = require('../utils/validate-location-type');
+var chalk   = require('chalk');
 
 module.exports = {
   name: 'cordova:build',
-  aliases: ['cdv:build'],
-  description: 'Build ember & cordova applications',
+  aliases: ['cdv:build', 'cdv:b'],
+  description: 'Build the ember application for cordova',
   works: 'insideProject',
 
-  availableOptions: [{
-    name: 'environment',
-    type: String,
-    default: 'development',
-    aliases: ['env']
-  }, {
-    name: 'platform',
-    type: String
-  }],
+  /* eslint-disable max-len */
+  availableOptions: [
+    { name: 'platform',             type: String,  default: 'ios' },
+    { name: 'verbose',              type: Boolean, default: false,         aliases: ['v'] },
+    { name: 'environment',          type: String,  default: 'development', aliases: ['e', 'env', { 'dev': 'development' }, { 'prod': 'production' }] },
+    { name: 'output-path',          type: 'Path',  default: 'ember-cordova/cordova/www',       aliases: ['op', 'out'] },
+  ],
+  /* eslint-enable max-len */
 
   run: function(options) {
+    var hook, build, cordovaBuild, validateCordovaConfig;
+    var ui = this.ui;
+    var project = this.project;
+
     validateLocationType(this.project.config());
 
-    var platform = options.platform || defaultPlatform(this.project);
+    validateCordovaConfig = getCordovaConfig(this.project)
+      .then(function(cordovaConfig) {
+        return validateAllowNavigation(
+          cordovaConfig,
+          false
+        );
+      });
 
-    var hook = new HookTask({
-      project: this.project,
-      ui: this.ui
-    });
+    project.targetIsCordova = true;
+    var platform = project.CORDOVA_PLATFORM = options.platform;
 
-    var emberBuild = new EmberBuildTask({
-      project: this.project,
-      ui: this.ui,
-      buildOptions: options.buildOptions
+    hook = new HookTask({
+      project: project,
+      ui: ui
     });
 
-    var link = new LinkTask({
-      project: this.project,
-      ui: this.ui
+    build = new BuildTask({
+      ui: ui,
+      project: project,
+      environment: options.environment,
+      outputPath: options.outputPath
     });
 
-    var cordovaBuild = new CdvBuildTask({
-      project: this.project,
-      ui: this.ui
+    cordovaBuild = new CdvBuildTask({
+      project: project,
+      ui: ui
     });
 
-    return hook.run('beforeBuild')
-           .then(emberBuild.run(options.environment))
-           .then(link.run())
-           .then(cordovaBuild.run(platform, options.environment))
-           .then(hook.run('afterBuild'));
+    ui.writeLine(chalk.green('Building'));
+
+    return validateCordovaConfig
+      .then(hook.prepare('beforeBuild'))
+      .then(build.prepare())
+      .then(cordovaBuild.prepare(platform))
+      .then(hook.prepare('afterBuild'))
+      .then(function() {
+        ui.writeLine(chalk.green('Cordova Project Built.'));
+      })
+      .catch(function(e) {
+        throw e;
+      });
   }
 };

lib/commands/link.js

@@ -1,19 +1,21 @@
 'use strict';
 
-var LinkTask        = require('../tasks/link-environment');
+var easyError = require('../utils/easy-error');
+var chalk = require('chalk');
+var LINK_DEPRECATION = chalk.yellow(
+  '\n\tDEPRECATED\n\t--------------\n' +
+  '\t`cordova:link` and alias `cdv:link` have been deprecated because\n' +
+  '\ttheir behavior is no longer utilized by `ember-cordova` since assets\n'  +
+  '\tare now built directly into the cordova/www folder.\n'
+);
 
 module.exports = {
   name: 'cordova:link',
   aliases: ['cdv:link'],
-  description: 'symlink dist to cordova/www',
+  description: '[DEPRECATED] symlink dist to cordova/www',
   works: 'insideProject',
 
-  run: function(options) {
-    var link = new LinkTask({
-      project: this.project,
-      ui: this.ui
-    });
-
-    return link.run();
+  run: function() {
+    easyError(LINK_DEPRECATION);
   }
 };