Merge pull request #207 from adobe/jasonsanjose/sprint21

peterflynn · peterflynn · commit 537e65ee3bd6 · 2013-02-21T16:49:22.000-08:00
Add grunt to brackets-shell with a sprint number updating task, and update to sprint 21
diff --git a/.gitignore b/.gitignore
@@ -2,6 +2,8 @@
 *.swp
 xcodebuild
 xcodebuild/*
+/node_modules
+/npm-debug.log
 
 appshell.xcodeproj
 Brackets.vcxproj
@@ -41,5 +43,4 @@ tools
 *.wixobj
 bracketsharvestmanager.wxs
 fr-fr.mst
-
 appshell/node-core/node_modules
diff --git a/.jshintrc b/.jshintrc
@@ -0,0 +1,75 @@
+{
+    "bitwise"       : true,
+    "curly"         : true,
+    "eqeqeq"        : true,
+    "forin"         : true,
+    "immed"         : true,
+    "latedef"       : true,
+    "newcap"        : true,
+    "noarg"         : true,
+    "noempty"       : true,
+    "nonew"         : true,
+    "plusplus"      : true,
+    "regexp"        : true,
+    "undef"         : true,
+    "strict"        : true,
+    "trailing"      : false,
+    
+    "asi"           : false,
+    "boss"          : false,
+    "debug"         : false,
+    "eqnull"        : false,
+    "es5"           : false,
+    "esnext"        : false,
+    "evil"          : false,
+    "expr"          : false,
+    "funcscope"     : false,
+    "globalstrict"  : false,
+    "iterator"      : false,
+    "lastsemic"     : false,
+    "laxbreak"      : false,
+    "laxcomma"      : false,
+    "loopfunc"      : false,
+    "multistr"      : false,
+    "onecase"       : false,
+    "proto"         : false,
+    "regexdash"     : false,
+    "scripturl"     : false,
+    "smarttabs"     : false,
+    "shadow"        : false,
+    "sub"           : false,
+    "supernew"      : false,
+    "validthis"     : false,
+    
+    "browser"       : true,
+    "couch"         : false,
+    "devel"         : false,
+    "dojo"          : false,
+    "jquery"        : false,
+    "mootools"      : false,
+    "node"          : false,
+    "nonstandard"   : false,
+    "prototypejs"   : false,
+    "rhino"         : false,
+    "wsh"           : false,
+    
+    "nomen"         : false,
+    "onevar"        : false,
+    "passfail"      : false,
+    "white"         : false,
+ 
+    "maxerr"        : 100,
+    "predef"        : [
+    ],
+    "indent"        : 4,
+    "globals"       : [
+        "require",
+        "define",
+        "brackets",
+        "$",
+        "PathUtils",
+        "window",
+        "navigator",
+        "Mustache"
+    ]
+}
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -0,0 +1,45 @@
+/*
+ * Copyright (c) 2013 Adobe Systems Incorporated. All rights reserved.
+ *  
+ * 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.
+ * 
+ */
+/*global module, require*/
+/*jslint regexp:true*/
+module.exports = function (grunt) {
+    "use strict";
+
+    grunt.initConfig({
+        jshint: {
+            all: [
+                "Gruntfile.js",
+                "tasks/**/*.js"
+            ],
+            /* use strict options to mimic JSLINT until we migrate to JSHINT in Brackets */
+            options: {
+                jshintrc: ".jshintrc"
+            }
+        }
+    });
+
+    grunt.loadTasks("tasks");
+    grunt.loadNpmTasks("grunt-contrib-jshint");
+
+    grunt.registerTask("default", "jshint");
+};
diff --git a/appshell/mac/Info.plist b/appshell/mac/Info.plist
@@ -19,9 +19,9 @@
 	<key>CFBundleSignature</key>
 	<string>????</string>
 	<key>CFBundleVersion</key>
-	<string>0.20.0</string>
+	<string>0.21.0</string>
 	<key>CFBundleShortVersionString</key>
-	<string>0.20.0</string>
+	<string>0.21.0</string>
 	<key>NSMainNibFile</key>
 	<string>MainMenu</string>
 	<key>NSPrincipalClass</key>
diff --git a/appshell/version.rc b/appshell/version.rc
@@ -32,7 +32,7 @@ LANGUAGE LANG_ENGLISH, SUBLANG_ENGLISH_US
 //
 
 VS_VERSION_INFO VERSIONINFO
-FILEVERSION    	0,20,0,0
+FILEVERSION    	0,21,0,0
 /* PRODUCTVERSION 	1,0,0,0 */
 FILEOS         	VOS__WINDOWS32
 FILETYPE       	VFT_APP
@@ -43,7 +43,7 @@ BEGIN
         BEGIN
             VALUE "CompanyName",      "brackets.io\0"
             VALUE "FileDescription",  "\0"
-            VALUE "FileVersion",      "Sprint 20\0"
+            VALUE "FileVersion",      "Sprint 21\0"
             VALUE "ProductName",      APP_NAME "\0"
             VALUE "ProductVersion",   "\0"
             VALUE "LegalCopyright",   "(c) 2012 Adobe Systems, Inc.\0"
diff --git a/installer/mac/buildInstaller.sh b/installer/mac/buildInstaller.sh
@@ -1,7 +1,7 @@
 #!/bin/bash 
 
 # config
-releaseName="Brackets Sprint 20"
+releaseName="Brackets Sprint 21"
 format="bzip2"
 encryption="none"
 tmpLayout="./dropDmgConfig/layouts/tempLayout"
diff --git a/installer/win/Brackets.wxs b/installer/win/Brackets.wxs
@@ -32,7 +32,7 @@ xmlns:fire="http://schemas.microsoft.com/wix/FirewallExtension">
     </DirectoryRef>
 
     <DirectoryRef Id="ProgramMenuFolder">
-      <Component Id="StartMenuShortcut" Guid="{3DF2D99D-316C-4B34-818D-FA57E27CF1BF}" Win64="no" >
+      <Component Id="StartMenuShortcut" Guid="{44c53d18-d59b-8b53-912d-35c1de410fb4}" Win64="no" >
         <Shortcut Id="AppShortcut" Name="!(loc.ProductName) $(var.ProductVersionName)"
                  Description="!(loc.ShortcutDescription)"
                  Target="[INSTALLDIR]\$(var.ExeName).exe" />
diff --git a/installer/win/README.MD b/installer/win/README.MD
@@ -28,8 +28,14 @@ Normally, the installer scripts are run from a specific pre-set-up build machine
 10. `git clone` the brackets and brackets-shell Git repos
 11. Set `BRACKETS_SRC` to the root folder of the brackets repo
 
+## To rev the Brackets sprint number with Grunt, both brackets-shell and brackets
+## repositories must be updated. For the initial Grunt setup, see:
+## https://github.com/adobe/brackets/wiki/Grunt-Setup.
+##
+##   brackets       > grunt set-sprint --sprint=NN
+##   brackets-shell > grunt set-sprint --sprint=NN
 
-## To rev the Brackets sprint number
+## To rev the Brackets sprint number manually
 1. Open brackets-win-install-build.xml and change `product.sprint.number`
 2. Open brackets-shell\installer\mac\buildInstaller.sh and change `releaseName`
 3. Open Brackets.wxs and replace the `StartMenuShortcut` GUID property with a newly generated GUID
diff --git a/installer/win/brackets-win-install-build.xml b/installer/win/brackets-win-install-build.xml
@@ -12,7 +12,7 @@ default="build.mul">
   <!-- See also: product name definitions in Brackets_<locale>.wxl -->
   <property name="product.shortname" value="Brackets"/>
   <property name="product.fullname" value="Brackets"/>
-  <property name="product.sprint.number" value="20"/>
+  <property name="product.sprint.number" value="21"/>
   <property name="product.version.number" value="0.${product.sprint.number}"/>
   <property name="product.version.name" value="Sprint ${product.sprint.number}"/>
   <property name="product.manufacturer" value="brackets.io"/>
diff --git a/package.json b/package.json
@@ -0,0 +1,20 @@
+{
+    "name": "Brackets-Shell",
+    "version": "0.21.0-0",
+    "homepage": "http://brackets.io",
+    "issues": {
+        "url": "http://github.com/adobe/brackets-shell/issues"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/adobe/brackets-shell.git",
+        "branch": "",
+        "SHA": ""
+    },
+    "devDependencies": {
+        "grunt": ">=0.4.0rc5",
+        "grunt-cli": ">=0.1.6",
+        "grunt-contrib-jshint": ">=0.1.1rc6",
+        "guid": ">=0.0.10"
+    }
+}
diff --git a/tasks/set-sprint.js b/tasks/set-sprint.js
@@ -0,0 +1,125 @@
+/*
+ * Copyright (c) 2013 Adobe Systems Incorporated. All rights reserved.
+ *  
+ * 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.
+ * 
+ */
+/*global module, require*/
+
+module.exports = function (grunt) {
+    "use strict";
+    
+    var guid = require("guid");
+    
+    function writeJSON(path, obj) {
+        grunt.file.write(path, JSON.stringify(obj, null, "    "));
+    }
+
+    function safeReplace(content, regexp, replacement) {
+        var newContent = content.replace(regexp, replacement);
+
+        if (newContent === content) {
+            grunt.fail.fatal("Regexp " + regexp + " did not match");
+        }
+
+        return newContent;
+    }
+    
+    // task: set-sprint
+    grunt.registerTask("set-sprint", "Update occurrences of sprint number for all native installers and binaries", function () {
+        var packageJsonPath             = "package.json",
+            packageJSON                 = grunt.file.readJSON(packageJsonPath),
+            winInstallerBuildXmlPath    = "installer/win/brackets-win-install-build.xml",
+            buildInstallerScriptPath    = "installer/mac/buildInstaller.sh",
+            wxsPath                     = "installer/win/Brackets.wxs",
+            versionRcPath               = "appshell/version.rc",
+            infoPlistPath               = "appshell/mac/Info.plist",
+            sprint                      = grunt.option("sprint") || 0,
+            versionShort                = packageJSON.version.substr(0, packageJSON.version.indexOf("-")),
+            text;
+
+        // replace sprint number in short version, e.g. N.<sprint>.N
+        versionShort = versionShort.replace(/([0-9]+\.)([0-9]+)(\.[0-9]+)/, "$1" + sprint + "$3");
+
+        if (!sprint) {
+            grunt.fail.fatal("Please specify a sprint. e.g. grunt set-sprint --sprint=21");
+        }
+        
+        // 1. Update package.json
+        packageJSON.version = safeReplace(
+            packageJSON.version,
+            /([0-9]+\.)([0-9]+)([\.\-a-zA-Z0-9]*)?/,
+            "$1" + sprint + "$3");
+        writeJSON(packageJsonPath, packageJSON);
+        
+        // 2. Open installer/win/brackets-win-install-build.xml and change `product.sprint.number`
+        text = grunt.file.read(winInstallerBuildXmlPath);
+        text = safeReplace(
+            text,
+            /<property name="product\.sprint\.number" value="([0-9]+)"\/>/,
+            '<property name="product.sprint.number" value="' + sprint + '"/>');
+        grunt.file.write(winInstallerBuildXmlPath, text);
+        
+        // 3. Open installer/mac/buildInstaller.sh and change `releaseName`
+        text = grunt.file.read(buildInstallerScriptPath);
+        text = safeReplace(
+            text,
+            /(Brackets Sprint )([0-9]+)/,
+            "$1" + sprint
+        );
+        grunt.file.write(buildInstallerScriptPath, text);
+        
+        // 4. Open installer/win/Brackets.wxs and replace the `StartMenuShortcut` GUID property with a newly generated GUID
+        text = grunt.file.read(wxsPath);
+        text = safeReplace(
+            text,
+            /<Component Id="StartMenuShortcut" Guid="\{[0-9A-Fa-f\-]+\}" Win64="no" >/,
+            '<Component Id="StartMenuShortcut" Guid="{' + guid.raw() + '}" Win64="no" >'
+        );
+        grunt.file.write(wxsPath, text);
+        
+        // 5. Open appshell/version.rc and change `FILEVERSION` and `"FileVersion"`
+        text = grunt.file.read(versionRcPath);
+        text = safeReplace(
+            text,
+            /(FILEVERSION\s+[0-9]+,)([0-9]+)/,
+            "$1" + sprint
+        );
+        text = safeReplace(
+            text,
+            /(Sprint )([0-9]+)/,
+            "$1" + sprint
+        );
+        grunt.file.write(versionRcPath, text);
+        
+        // 6. Open appshell/mac/Info.plist and change `CFBundleShortVersionString` and `CFBundleVersion`text = grunt.file.read(wxsPath);
+        text = grunt.file.read(infoPlistPath);
+        text = safeReplace(
+            text,
+            /(<key>CFBundleVersion<\/key>\s*<string>)([0-9]+\.[0-9]+\.[0-9]+)(<\/string>)/,
+            "$1" + versionShort + "$3"
+        );
+        text = safeReplace(
+            text,
+            /(<key>CFBundleShortVersionString<\/key>\s*<string>)([0-9]+\.[0-9]+\.[0-9]+)(<\/string>)/,
+            "$1" + versionShort + "$3"
+        );
+        grunt.file.write(infoPlistPath, text);
+    });
+};
