Release 2.2.0

Author: oraclejet

README.md

@@ -1,37 +1,39 @@
-# generator-oraclejet 1.1.0
-
-## About the generator
-This Yeoman generator for Oracle JET lets you quickly set up a project for use as a Web application or mobile-hybrid application for Android and iOS. 
-
-This is an open source project maintained by Oracle Corp.
-
-### Installation
-For step-by-step instructions on using Yeoman and this generator to build an Oracle JET application, including possible pre-requisites for installation, please see the [Oracle JET Developers Guide](http://docs.oracle.com/middleware/jet210/jet/)
-```bash
-npm install -g generator-oraclejet
-```
-
-### Usage
-Once you have the generator installed, the following commands will scaffold up a JET based application. See the [Oracle JET Developers Guide](http://docs.oracle.com/middleware/jet210/jet/) for information about all of the available Command Line options as well as details on pre-requisites for installation and usage with Mobile-Hybrid applications.
-
-```bash
-# Generate a web based application with default blank template
-yo oraclejet <app name>
-```
-```bash
-# Generate a web based application with QuickStart_Basic template
-yo oraclejet <app name> --template=basic
-```
-```bash
-# Generate a mobile hybrid application for Android with default navdrawer template
-yo oraclejet:hybrid myApp --appid=com.oracle.samples --appname=MyApp --template=navdrawer --platforms=android
-```
-
-### [Contributing](https://github.com/oracle/generator-oraclejet/tree/master/CONTRIBUTING.md)
-Oracle JET is an open source project.  Pull Requests are currently not being accepted. See 
-[CONTRIBUTING](https://github.com/oracle/generator-oraclejet/tree/master/CONTRIBUTING.md)
-for details.
-
-### [License](https://github.com/oracle/generator-oraclejet/tree/master/LICENSE.md)
-Copyright (c) 2014, 2016 Oracle and/or its affiliates
+# generator-oraclejet 2.2.0
+
+> Yeoman generator for Oracle JET web and mobile applications
+
+## About the generator
+This Yeoman generator for Oracle JET lets you quickly set up a project for use as a web application or hybrid mobile application for Android, iOS or Windows 10. 
+
+This is an open source project maintained by Oracle Corp.
+
+## Installation
+For step-by-step instructions on using Yeoman and this generator to build an Oracle JET application, including possible pre-requisites for installation, please see the [Oracle JET Developers Guide](http://docs.oracle.com/middleware/jet210/jet/)
+```bash
+npm install -g generator-oraclejet
+```
+
+## Usage
+Once you have the generator installed, the following commands will scaffold up a JET based application. See the [Oracle JET Developers Guide](http://docs.oracle.com/middleware/jet210/jet/) for information about all of the available command line options as well as details on pre-requisites for installation.
+
+```bash
+# Generate a web application with default blank template
+yo oraclejet <app name>
+```
+```bash
+# Generate a web application with default basic template
+yo oraclejet <app name> --template=basic
+```
+```bash
+# Generate a hybrid mobile application for Android with default navdrawer template
+yo oraclejet:hybrid myApp --appid=com.oracle.samples.myapp --appname=MyApp --template=navdrawer --platform=android
+```
+
+## [Contributing](https://github.com/oracle/generator-oraclejet/tree/master/CONTRIBUTING.md)
+Oracle JET is an open source project.  Pull Requests are currently not being accepted. See 
+[CONTRIBUTING](https://github.com/oracle/generator-oraclejet/tree/master/CONTRIBUTING.md)
+for details.
+
+## [License](https://github.com/oracle/generator-oraclejet/tree/master/LICENSE.md)
+Copyright (c) 2014, 2016 Oracle and/or its affiliates
 The Universal Permissive License (UPL), Version 1.0

RELEASENOTES.md

@@ -0,0 +1,4 @@
+## Release Notes for generator-oraclejet ##
+
+### 2.2.0 (Oct 21, 2016)
+* Provide help page for generator

common/restore.js

@@ -31,14 +31,17 @@ module.exports =
 
       fs.stat(configPath, function(err,stats)
       {
+        var generatorVersion = _getOracleJetGeneratorVersion(generator);
         if (err)
         {
-          generator.log(commonMessages.appendJETPrefix() + "No config file...writing the default config...");  
-          var generatorVersion = _getOracleJetGeneratorVersion(generator);
+          generator.log(commonMessages.appendJETPrefix() + "No config file...writing the default config...");
           fs.writeJSONSync(configPath, {"generatorVersion": generatorVersion});       
         }
         else
         {
+          var configJson = fs.readJSONSync(configPath);
+          configJson.generatorVersion = generatorVersion;
+          fs.writeJSONSync(configPath, configJson);     
           generator.log(commonMessages.appendJETPrefix() + ORACLE_JET_CONFIG_FILE +" file exists...checking config...");
         }
       });
@@ -83,7 +86,8 @@ module.exports =
  */
 function _getOracleJetGeneratorVersion(generator)
 {
-  var generatorJSON =  generator.sourceRoot("package.json");
-  return fs.readJSONSync(generatorJSON).version;
-}
-
+  // We intend to read the top level package.json for the generator-oraclejet module.
+  // Note this path to package.json depends on the location of this file within the module (common/restore.js)
+  var generatorJSON = require('../package.json');
+  return generatorJSON.version;
+}

common/template/index.js

@@ -15,7 +15,7 @@ var _WEB = "web";
 
 var BLANK_TEMPLATE = blankTemplate.BLANK_TEMPLATE;
 
-var _TEMPLATES_NPM_URL =  "oraclejet-templates@2.1.0";
+var _TEMPLATES_NPM_URL = "oraclejet-templates@~2.2.0";
 
 var _TEMPLATES = [BLANK_TEMPLATE, 'basic',  'navbar', 'navdrawer'];
 
@@ -55,7 +55,7 @@ module.exports =
 
 function _isUrl(url) 
 {
-  return /^https?:\/\/?([\da-z\.-]+)(:\d{2,4})?([\/\w \.-]*)*\/?$/.test(url);
+  return /^https?:\/\/[^\s\/$.?#].[^\s]*$/i.test(url);
 }
 
 function _toTemplateUrl(template) 

generators/add-hybrid/index.js

@@ -23,13 +23,22 @@ var OracleJetAddHybridGenerator = generators.Base.extend(
   {
     generators.Base.apply(this, arguments);
 
-    this.option("platforms");
-    this.option("platform");
-    this.option("appid");
-    this.option("appId");
-    this.option("appname");
-    this.option("appName");
-
+    this.option('platforms', {
+      desc: 'Specify the platforms to be supported by the scaffolded hybrid app [android, ios, windows]',
+    });
+    this.option('platform', {
+      desc: 'Alias for --platforms if the user wishes to specify a single hybrid platform [android, ios, windows]'
+    });
+    this.option('appid', {
+      desc: 'Specify the app ID for scaffolded hybrid app'
+    });
+    // Deprecated version
+    this.option("appId",{desc:"Deprecated. Use --appid instead."});
+    this.option('appname', {
+      desc: 'Specify the app name for scaffolded hybrid app'
+    });
+    // Deprecated version
+    this.option("appName", {desc:"Deprecated. Use --appname instead."});
   },
 
   initializing: function() 
@@ -70,6 +79,7 @@ var OracleJetAddHybridGenerator = generators.Base.extend(
       .then(cordovaHelper.create.bind(this))
       .then(commonHybrid.copyHooks.bind(this))
       .then(commonHybrid.copyResources.bind(this))
+      .then(_copyCordovaMocks.bind(this))
       .then(commonHybrid.removeExtraCordovaFiles.bind(this))
       .then(platformsHelper.addPlatforms.bind(this))                 
       .then(commonHybrid.updateConfigXml.bind(this)) 
@@ -149,3 +159,29 @@ function _validateHybridDirDoesNotExist(generator)
   }
   return Promise.resolve(generator);  
 }
+
+function _copyCordovaMocks(generator)
+{
+  var source = generator.templatePath("../../hybrid/templates/common/src/js/");
+  var dest = generator.destinationPath("./src-hybrid/js/");
+
+  return new Promise(function (resolve, reject)
+  {
+    if (common.fsExistsSync(source))
+    {
+      fs.copy(source, dest, function (err)
+      {
+        if (err)
+        {
+          reject(err);
+          return;
+        }
+        resolve(generator);
+      });
+    }
+    else
+    {
+      reject('Missing file \'/js/cordovaMocks.js\'.')
+    }
+  });
+}

generators/add-theme/index.js

@@ -42,7 +42,11 @@ var OracleJetAddThemeGenerator = generators.Base.extend(
       this.env.error(commonMessages.prefixError(err));
     }
     if(this.themeName === constants.DEFAULT_THEME) {
-      this.env.error(commonMessages.prefixError("Theme " + constants.DEFAULT_THEME + " is reserved."));    }    
+      this.env.error(commonMessages.prefixError("Theme " + constants.DEFAULT_THEME + " is reserved.")); }
+
+    if(!_isValidThemeName(this.themeName)) {
+      this.env.error(commonMessages.prefixError(`Special characters invalid in theme name ${this.themeName}.`));
+    }    
   },
 
   writing: function() 
@@ -74,7 +78,6 @@ module.exports = OracleJetAddThemeGenerator;
 
 function _addSassTheme(generator) {
   var themeName = generator.themeName;
-
   const srcPath = generator.destinationPath(constants.APP_SRC_DIRECTORY);
   const themeDestPath =  path.join(srcPath, 'themes', themeName);
   fs.ensureDirSync(themeDestPath);
@@ -130,6 +133,10 @@ function _isScssFile(file) {
   return /scss/.test(path.extname(file));
 }
 
+function _isValidThemeName(string) {
+  return !(/[-!$%^&*()_+|~=`{}\[\]:";'<>?,.\/]/.test(string));
+}
+
 function _getJetVersion(generator) {
   let bowerJSON = generator.destinationPath('bower_components/oraclejet/bower.json');
   bowerJSON = fs.readJsonSync(bowerJSON);
@@ -155,7 +162,7 @@ function _copySettingsFilesFromJETSrc(themeName, dest, generator) {
     const srcSettingFileName = _getSrcSettingFileName(platform);
     const srcPath = path.join(JET_SCSS_SRC_PATH, platformPath, srcSettingFileName);
 
-    const destSettingFileName = _getDestSettingFileName(themeName, platform);
+    const destSettingFileName = _getDestSettingFileName(DEFAULT_THEME, platform);
     const destPath = path.join(dest, platform, destSettingFileName);
 
     fs.copySync(srcPath, destPath);
@@ -187,27 +194,23 @@ function _copySettingsFilesFromJETSrc(themeName, dest, generator) {
   function _getValuePairsArray() {
     return [
       {
-        str:'@import "../utilities/oj.utilities.urls";',
-        newStr: '@import "../../../../bower_components/oraclejet/dist/scss/utilities/oj.utilities.urls";',
-      },
-      {
-        str: '@import "../utilities/oj.utilities.math";',
-        newStr: '@import "../../../../bower_components/oraclejet/dist/scss/utilities/oj.utilities.math";',
+        str: new RegExp('@import\ \"\.\.\/utilities', 'g'),
+        newStr: '@import "../../../../bower_components/oraclejet/dist/scss/utilities',
       },
       {
-        str: new RegExp('.*\\$themeName.*'),
+        str: new RegExp('.*\\$themeName.*', 'g'),
         newStr: `$themeName:           ${THEMENAME_TOKEN} !default;`,
       },
       {
-        str: new RegExp('.*\\$imageDir.*'),
+        str: new RegExp('.*\\$imageDir.*', 'g'),
         newStr: `$imageDir: "../../../alta/${JET_VERSION_TOKEN}/${PLATFORM_TOKEN}/images/" !default;`,
       },
       {
-        str: new RegExp('.*\\$fontDir.*'),
+        str: new RegExp('.*\\$fontDir.*', 'g'),
         newStr: `$fontDir:  "../../../alta/${JET_VERSION_TOKEN}/${PLATFORM_TOKEN}/fonts/" !default;`,
       },
       {
-        str: new RegExp('.*\\$commonImageDir.*'),
+        str: new RegExp('.*\\$commonImageDir.*', 'g'),
         newStr: `$commonImageDir:  "../../../alta/${JET_VERSION_TOKEN}/common/images/" !default;`,
       },
     ];

generators/app/index.js

@@ -50,6 +50,10 @@ var OracleJetWebCreateGenerator = generators.Base.extend(
         defaults: ".",
         desc: "Application directory to contain the scaffold content"
       });
+    
+    this.option('template', {
+      desc: 'blank, basic[:web|:hybrid], navbar[:web|:hybrid], navdrawer[:web|:hybrid], or <URL to zip file>'
+    });
   },
 
   writing: function () 

generators/app/templates/blank/index.html

@@ -32,7 +32,7 @@
     <meta name="apple-mobile-web-app-title" content="Oracle JET">
 
     <!-- injector:theme -->
-    <link rel="stylesheet" href="css/libs/oj/v2.1.0/alta/oj-alta-min.css" id="css" />
+    <link rel="stylesheet" href="css/libs/oj/v2.2.0/alta/oj-alta-min.css" id="css" />
     <!-- endinjector -->
 
     <!-- This is where you would add any app specific styling -->

generators/app/templates/blank/js/main-release-paths.json

@@ -5,9 +5,9 @@
   "promise": "libs/es6-promise/es6-promise.min",
   "hammerjs": "libs/hammer/hammer-2.0.8.min",
   "ojdnd": "libs/dnd-polyfill/dnd-polyfill-1.0.0.min",
-  "ojs": "libs/oj/v2.1.0/min",
-  "ojL10n": "libs/oj/v2.1.0/ojL10n",
-  "ojtranslations": "libs/oj/v2.1.0/resources",
+  "ojs": "libs/oj/v2.2.0/min",
+  "ojL10n": "libs/oj/v2.2.0/ojL10n",
+  "ojtranslations": "libs/oj/v2.2.0/resources",
   "text": "libs/require/text",
   "signals": "libs/js-signals/signals.min"
 }

generators/app/templates/blank/js/main.js

@@ -26,9 +26,9 @@ requirejs.config(
     'promise': 'libs/es6-promise/es6-promise',
     'hammerjs': 'libs/hammer/hammer-2.0.8',
     'ojdnd': 'libs/dnd-polyfill/dnd-polyfill-1.0.0',
-    'ojs': 'libs/oj/v2.1.0/debug',
-    'ojL10n': 'libs/oj/v2.1.0/ojL10n',
-    'ojtranslations': 'libs/oj/v2.1.0/resources',
+    'ojs': 'libs/oj/v2.2.0/debug',
+    'ojL10n': 'libs/oj/v2.2.0/ojL10n',
+    'ojtranslations': 'libs/oj/v2.2.0/resources',
     'text': 'libs/require/text',
     'signals': 'libs/js-signals/signals'
   }