Merge pull request #301 from BranchMetrics/added-changelog

feat: added changelog script

Author: ethanneff

.gitignore

@@ -13,3 +13,4 @@ out/
 src/cordova-ionic-phonegap-branch-deep-linking.iml
 npm-debug.log*
 *.map
+yarn.lock

CHANGELOG.md

@@ -29,7 +29,13 @@
 - Gulp
 
   ```sh
-  npm install -g gulp-cli;
+  npm install -g gulp-cli; # linter
+  ```
+
+- Yarn
+
+  ```sh
+  npm install -g yarn # faster npm
   ```
 
 ## Setup
@@ -40,7 +46,7 @@
   git clone [email protected]:BranchMetrics/cordova-ionic-phonegap-branch-deep-linking.git;
   cd cordova-ionic-phonegap-branch-deep-linking;
   rm -rf node_modules;
-  npm install --save-dev;
+  yarn install --save-dev;
   ```
 
 ## Develop

CONTRIBUTING.md

@@ -457,15 +457,15 @@
     Branch.setIdentity(userId).then(function (res) {
       alert('Response: ' + JSON.stringify(res))
     }).catch(function (err) {
-      alert('Error: ' + JSON.stringify(err))
+      alert('Error: ' + JSON.stringify(err.message))
     })
     ```
 
     ```js
     Branch.logout().then(function (res) {
       alert('Response: ' + JSON.stringify(res))
     }).catch(function (err) {
-      alert('Error: ' + JSON.stringify(err))
+      alert('Error: ' + JSON.stringify(err.message))
     })
     ```
 
@@ -483,7 +483,7 @@
     Branch.userCompletedAction(eventName, metaData).then(function (res) {
       alert('Response: ' + JSON.stringify(res))
     }).catch(function (err) {
-      alert('Error: ' + JSON.stringify(err))
+      alert('Error: ' + JSON.stringify(err.message))
     })
     ```
 
@@ -492,7 +492,7 @@
     Branch.userCompletedAction(eventName).then(function (res) {
       alert('Response: ' + JSON.stringify(res))
     }).catch(function (err) {
-      alert('Error: ' + JSON.stringify(err))
+      alert('Error: ' + JSON.stringify(err.message))
     })
     ```
 

README.md

@@ -2,7 +2,7 @@
   "name": "branch-cordova-sdk",
   "description": "Branch Metrics Cordova SDK",
   "main": "www/branch.js",
-  "version": "2.5.9",
+  "version": "2.5.10",
   "homepage": "https://github.com/BranchMetrics/cordova-ionic-phonegap-branch-deep-linking",
   "repository": {
     "type": "git",
@@ -36,27 +36,28 @@
     }
   },
   "scripts": {
+    "changelog": "node ./src/scripts/npm/updateChangeLog -reset=true",
     "commitmsg": "validate-commit-msg",
     "precommit": "gulp prod",
-    "prepush": "semantic-release pre --verifyRelease='./src/scripts/npm/updateNpmVersion'",
+    "prepush": "semantic-release pre --verifyRelease='./src/scripts/npm/updateNpmVersion' || true",
     "prerelease": "gulp prod",
     "semantic-release": "semantic-release pre && npm publish && semantic-release post"
   },
   "dependencies": {
     "mkpath": "^1.0.0",
     "node-version-compare": "^1.0.1",
-    "plist": "^1.2.0",
-    "xml2js": "^0.4.16"
+    "plist": "^2.0.1",
+    "xml2js": "^0.4.17"
   },
   "devDependencies": {
     "gulp": "^3.9.1",
-    "gulp-standard": "^8.0.3",
-    "husky": "^0.12.0",
+    "gulp-standard": "^9.0.0",
+    "husky": "^0.13.2",
     "mkpath": "^1.0.0",
     "node-version-compare": "^1.0.1",
-    "plist": "^1.2.0",
+    "plist": "^2.0.1",
     "semantic-release": "^6.3.6",
-    "validate-commit-msg": "^2.8.2",
+    "validate-commit-msg": "^2.11.2",
     "xml2js": "^0.4.17"
   }
-}
+}

package.json

@@ -24,7 +24,7 @@ SOFTWARE.
 <plugin xmlns="http://apache.org/cordova/ns/plugins/1.0"
   xmlns:android="http://schemas.android.com/apk/res/android"
   id="branch-cordova-sdk"
-  version="2.5.9">
+  version="2.5.10">
 
   <!-- DO NOT EDIT THIS FILE. MAKE ALL CHANGES TO plugin.template.xml INSTEAD -->
 

plugin.template.xml

@@ -24,7 +24,7 @@ SOFTWARE.
 <plugin xmlns="http://apache.org/cordova/ns/plugins/1.0"
   xmlns:android="http://schemas.android.com/apk/res/android"
   id="branch-cordova-sdk"
-  version="2.5.9">
+  version="2.5.10">
 
   <!-- DO NOT EDIT THIS FILE. MAKE ALL CHANGES TO plugin.template.xml INSTEAD -->
 

plugin.xml

@@ -86,7 +86,7 @@ Branch.prototype.setIdentity = function (identity) {
     return execute('setIdentity', [String(identity)])
   } else {
     return new Promise(function (resolve, reject) {
-      reject('Please set an identity')
+      reject(new Error('Please set an identity'))
     })
   }
 }
@@ -98,7 +98,7 @@ Branch.prototype.logout = function () {
 Branch.prototype.userCompletedAction = function (action, metaData) {
   if (!action) {
     return new Promise(function (resolve, reject) {
-      reject('Please set an event name')
+      reject(new Error('Please set an event name'))
     })
   }
 
@@ -159,7 +159,7 @@ Branch.prototype.createBranchUniversalObject = function (options) {
           return execute('listOnSpotlight', [obj.instanceId])
         } else {
           return new Promise(function (resolve, reject) {
-            reject('iOS Spotlight only')
+            reject(new Error('iOS Spotlight only'))
           })
         }
       }

src/branch.js

@@ -17,6 +17,7 @@
     var obj = convertXmlToObject(xml)
 
     obj = appendPlist(obj, preferences)
+    obj = correctPlistBlanks(obj)
     xml = convertObjectToXml(obj)
     writePList(filePath, xml)
   }
@@ -87,4 +88,15 @@
 
     return obj
   }
+
+  // npm list 1.2.0 -> 2.0.1 causes app crash due to malformed plist (from <string/> to <string></string>)
+  // specifically NSMainNibFile and NSMainNibFile~ipad
+  function correctPlistBlanks (obj) {
+    for (var key in obj) {
+      var val = obj[key]
+      if (!val) obj[key] = ''
+    }
+
+    return obj
+  }
 })()

src/scripts/ios/updatePlist.js

@@ -0,0 +1,217 @@
+// TODO: test git push
+// TODO: early exit based on last changelog version
+// TODO: 'Authorization': 'token xxxx', for testing
+// TODO: add npm run changelog to pre push
+// TODO: uncomment functions
+
+(function () {
+  // libs
+  'use strict'
+  var path = require('path')
+  // var exec = require('child_process').exec
+  var fileHelper = require('../lib/fileHelper.js')
+  var request = require('request')
+  var FILE = path.join(__dirname, '../../../', 'CHANGELOG.md')
+
+  // properties
+  var apiURL = 'https://api.github.com/repos/'
+  var gitURL = 'https://github.com/'
+  var baseURL = 'BranchMetrics/cordova-ionic-phonegap-branch-deep-linking/'
+  var tagsURL = apiURL + baseURL + 'tags'
+  var issuesURL = apiURL + baseURL + 'issues'
+  var commitsURL = apiURL + baseURL + 'commits'
+
+  // entry
+  module.exports = updateChangeLog()
+
+  function updateChangeLog () {
+    var pageLimit = isReset() ? 50 : 2
+    var tags = new Promise(function (resolve, reject) {
+      readData(tagsURL, [], 1, pageLimit, function (values) {
+        resolve(values)
+      })
+    })
+    var issues = new Promise(function (resolve, reject) {
+      readData(issuesURL, [], 1, pageLimit, function (values) {
+        resolve(values)
+      })
+    })
+    var commits = new Promise(function (resolve, reject) {
+      readData(commitsURL, [], 1, pageLimit, function (values) {
+        resolve(values)
+      })
+    })
+
+    Promise.all([tags, issues, commits]).then(function (values) {
+      var markdown = generateMarkdown(values)
+      fileHelper.writeFile(FILE, markdown)
+      // commitChanges()
+    })
+  }
+
+  function isReset () {
+    var args = process.argv.slice(2)
+    for (var i = 0; i < args.length; i++) {
+      var arg = args[i]
+      if (arg === '-reset=true') {
+        return true
+      }
+    }
+    return false
+  }
+
+  function readData (url, data, page, pageLimit, callback) {
+    var link = url + '?page=' + page
+    link += (url.indexOf('issues') > 0) ? '&state=closed' : ''
+
+    readGit(link, function (values) {
+      data.push.apply(data, values)
+      if (values.length === 0 || page >= pageLimit) {
+        callback(data)
+      } else {
+        page += 1
+        readData(url, data, page, pageLimit, callback)
+      }
+    })
+  }
+
+  function readGit (url, callback) {
+    var options = {
+      method: 'GET',
+      url: url,
+      headers: {
+        'User-Agent': 'branch-cordova-sdk',
+        'cache-control': 'no-cache'
+      }
+    }
+    request(options, function (error, response, body) {
+      if (response.statusCode === 200) {
+        callback(JSON.parse(body))
+      } else {
+        throw new Error(JSON.parse(error || body))
+      }
+    })
+  }
+
+  function generateMarkdown (values) {
+    // 3/2(O)n (swap)
+    var tags = values[0].reverse()
+    var issues = values[1].reverse()
+    var commits = values[2].reverse()
+
+    var output = getHeader()
+
+    // (O)n (tags)
+    var tagParagraph = ''
+    while (tags.length > 0) {
+      var currentTag = tags.pop()
+
+      tagParagraph += getTagHeader(currentTag)
+      tagParagraph += getCommitParagraph(currentTag, commits)
+      tagParagraph += getIssueParagraph(currentTag, issues)
+
+      output += tagParagraph
+      tagParagraph = ''
+    }
+
+    return output
+  }
+
+  function getHeader () {
+    return '# CHANGELOG\nQuestions? [Contact us](https://support.branch.io/support/tickets/new)\n\n'
+  }
+
+  function getTagHeader (currentTag) {
+    return '## [' + currentTag.name + '](' + gitURL + baseURL + 'releases/tag/' + currentTag.name + ') '
+  }
+
+  function getCommitParagraph (currentTag, commits) {
+    var body = '\n\n'
+    if (commits.length === 0) {
+      return body
+    }
+
+    // (O)n (commits)
+    var paragraph = ''
+    var hasHeader = false
+    while (commits.length > 0) {
+      var current = commits.pop()
+
+      // (O)n (commit messages)
+      var message = current.commit.message.replace(/(\r\n|\n|\r)/gm, '')
+
+      if (!hasHeader) {
+        paragraph += '- **Completed Changes**\n'
+        hasHeader = true
+      }
+
+      paragraph += '  - ' + message + ' ([' + current.sha.substr(0, 5) + '](' + current.html_url + '))\n'
+
+      if (currentTag.commit.sha === current.sha) {
+        // assign date to be used for header and issues conditional
+        var date = current.commit.author.date
+        currentTag.date = date
+
+        // complete body
+        body = ''
+        body += '(' + date.substr(0, 10) + ')\n\n'
+        body += paragraph + '\n'
+        break
+      }
+    }
+    return body
+  }
+
+  function getIssueParagraph (currentTag, issues) {
+    var body = ''
+    if (issues.length === 0) {
+      return body
+    }
+
+    // (O)n (issues)
+    var paragraph = ''
+    var hasHeader = false
+    while (issues.length > 0) {
+      var current = issues.pop()
+
+      if (!current.hasOwnProperty('pull_request')) {
+        if (!hasHeader) {
+          paragraph += '- **Closed Issues**\n'
+          hasHeader = true
+        }
+
+        paragraph += '  - ' + current.title.replace(/(\r\n|\n|\r)/gm, '') + ' ([#' + current.number + '](' + current.html_url + '))\n'
+      }
+
+      if (new Date(current.closed_at).getTime() < new Date(currentTag.date).getTime() && hasHeader) {
+        body += paragraph + '\n'
+        break
+      }
+    }
+
+    return body
+  }
+
+  // only show conventional-commit-types
+  // function isValidCommitMessage (message) {
+  //   var commitMessages = ['feat:', 'fix:', 'docs:', 'style:', 'refactor:', 'perf:', 'test:', 'chore:', 'revert:']
+  //   for (var i = 0; i < commitMessages.length; i++) {
+  //     var commitMessage = commitMessages[i]
+  //     if (message.indexOf(commitMessage) === 0) {
+  //       return true
+  //     }
+  //   }
+  //   return false
+  // }
+
+  // push file code changes to github
+  // function commitChanges () {
+  //   var git = 'git add ' + FILE + ' && git add git commit -m "chore: updated changelog" && git push'
+  //   git = 'echo'
+  //   exec(git, function (err, stdout, stderr) {
+  //     if (err) {
+  //       throw new Error('BRANCH SDK: Failed cto ommit git changes for changelog. Docs https://goo.gl/GijGKP')
+  //     }
+  //   })
+  // }
+})()