support for ignore flag (fix for #10)

goya · goya · commit cd3b81fa4548 · 2018-09-13T12:20:54.000-07:00
diff --git a/lib/commands/helpers/app.js b/lib/commands/helpers/app.js
diff --git a/lib/commands/new.js b/lib/commands/new.js
diff --git a/lib/commands/update.js b/lib/commands/update.js
diff --git a/lib/commands/usage/new.txt b/lib/commands/usage/new.txt
@@ -5,7 +5,11 @@ Add a new app from the specified repository, directory or file
 Properties: 
 
   phonegap, android-phonegap, ios-phonegap, winphone-phonegap, hydrates, share, 
-  tag, debug, private, android-key, windows-key, ios-key, winphone-key
+  tag, debug, private, android-key, windows-key, ios-key, winphone-key, ignore
+
+  The ignore flag allows you to specify directories or files that should NOT
+  be uploaded. It supports the glob format (https://git-scm.com/docs/gitignore)
+  and can be specified multiple times.
 
 Options:
 
diff --git a/lib/commands/usage/update.txt b/lib/commands/usage/update.txt
@@ -6,7 +6,11 @@ directory or file
 Properties:
 
   phonegap, android-phonegap, ios-phonegap, winphone-phonegap, hydrates, share, 
-  tag, debug, private, android-key, windows-key, ios-key, winphone-key
+  tag, debug, private, android-key, windows-key, ios-key, winphone-key, ignore
+
+  The ignore flag allows you to specify directories or files that should NOT
+  be uploaded. It supports the glob format (https://git-scm.com/docs/gitignore)
+  and can be specified multiple times.
 
 Options:
 
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "pgb-cli",
-  "version": "1.0.4-dev",
+  "version": "1.1.0",
   "description": "nodeJS CLI to PhoneGap Build",
   "keywords": [
     "PhoneGap",
@@ -55,7 +55,7 @@
   },
   "dependencies": {
     "easy-utf8-table": "^0.2.0",
-    "pgb-api": "^1.0.5",
+    "pgb-api": "^1.1.1",
     "visualwidth": "^0.1.0"
   }
 }
diff --git a/src/commands/helpers/app.js b/src/commands/helpers/app.js
@@ -1,8 +1,23 @@
 const payload = require('./payload')
+const merge = require('../../util/misc').merge
+const path = require('path')
+const fs = require('fs')
 
 module.exports.getData = (repoOrFile) => {
   let data = { keys: {} }
 
+  if (repoOrFile) {
+    try {
+      let file = path.resolve(path.join(repoOrFile, '.pgbrc'))
+      pgb.opts.variables = merge(JSON.parse(fs.readFileSync(file, 'utf8')), pgb.opts.variables)
+      pgb.debug(`reading ${file}`)
+    } catch (e) {
+      if (e.name === 'SyntaxError') {
+        throw new Error('invalid json in .pgbrc file')
+      }
+    }
+  }
+
   payload.addVariables(
     data, 'hydrates', 'share', 'tag', 'debug', 'private', 'pull', 'zip', 'android-phonegap:android_phonegap_version',
     'winphone-phonegap:winphone_phonegap_version', 'ios-phonegap:ios_phonegap_version', 'phonegap:phonegap_version'
@@ -12,5 +27,7 @@ module.exports.getData = (repoOrFile) => {
     data.keys, 'android-key:android', 'windows-key:windows', 'ios-key:ios', 'winphone-key:winphone'
   )
 
+  data.ignore = pgb.opts.variables.ignore || []
+
   return data
 }
diff --git a/src/commands/new.js b/src/commands/new.js
@@ -8,8 +8,9 @@ module.exports = () => {
   has.args(1)
 
   let progress = BindProgress()
+  let repoOrFile = pgb.opts.commands[1]
 
-  return pgb.api.addApp(pgb.opts.commands[1], appHelper.getData())
+  return pgb.api.addApp(repoOrFile, appHelper.getData(repoOrFile))
     .then(app => {
       pgb.print(`app ${pgb.colours.bold(app.id)} added`)
       return wait(app).then((app) => pgb.print({ bare: app.id, json: app }))
diff --git a/src/commands/update.js b/src/commands/update.js
@@ -10,8 +10,9 @@ module.exports = () => {
   let id = has.id(pgb.opts.commands[1])
 
   let progress = BindProgress()
+  let repoOrFile = pgb.opts.commands[2]
 
-  return pgb.api.updateApp(id, pgb.opts.commands[2], appHelper.getData())
+  return pgb.api.updateApp(id, repoOrFile, appHelper.getData(repoOrFile))
     .then((app) => {
       pgb.print(`app ${pgb.colours.bold(app.id)} updated`)
       return wait(app).then((app) =>
diff --git a/src/commands/usage/new.txt b/src/commands/usage/new.txt
@@ -5,7 +5,11 @@ Add a new app from the specified repository, directory or file
 Properties: 
 
   phonegap, android-phonegap, ios-phonegap, winphone-phonegap, hydrates, share, 
-  tag, debug, private, android-key, windows-key, ios-key, winphone-key
+  tag, debug, private, android-key, windows-key, ios-key, winphone-key, ignore
+
+  The ignore flag allows you to specify directories or files that should NOT
+  be uploaded. It supports the glob format (https://git-scm.com/docs/gitignore)
+  and can be specified multiple times.
 
 Options:
 
diff --git a/src/commands/usage/update.txt b/src/commands/usage/update.txt
@@ -6,7 +6,11 @@ directory or file
 Properties:
 
   phonegap, android-phonegap, ios-phonegap, winphone-phonegap, hydrates, share, 
-  tag, debug, private, android-key, windows-key, ios-key, winphone-key
+  tag, debug, private, android-key, windows-key, ios-key, winphone-key, ignore
+
+  The ignore flag allows you to specify directories or files that should NOT
+  be uploaded. It supports the glob format (https://git-scm.com/docs/gitignore)
+  and can be specified multiple times.
 
 Options:
 
diff --git a/test/commands/helpers/app.js b/test/commands/helpers/app.js
@@ -1,20 +1,35 @@
 const app = require('../../../src/commands/helpers/app.js')
+const fs = require('fs')
 
 describe('app', () => {
   beforeEach(() => {
     global.pgb = { opts: { variables: {} } }
   })
 
-  test('should format platforms', () => {
+  test('should be a function', () => {
     expect(app.getData).toBeInstanceOf(Function)
   })
 
   test('should return empty object with no variables', () =>
-    expect(app.getData()).toEqual({ keys: {} })
+    expect(app.getData()).toEqual({ keys: {}, ignore: [] })
   )
 
+  test('should not fail if config file not found', () =>
+    expect(app.getData('not_found')).toEqual({ keys: {}, ignore: [] })
+  )
+
+  test('should throw error on bad json', () => {
+    fs.writeFileSync('/.pgbrc', 'not json')
+    expect(() => app.getData('/')).toThrow('invalid json in .pgbrc file')
+  })
+
+  test('should get variables from file', () => {
+    fs.writeFileSync('/.pgbrc', '{ "private": true }')
+    expect(app.getData('/')).toEqual({ 'ignore': [], 'keys': {}, 'private': true })
+  })
+
   test('should attach whitelisted variables to object', () => {
-    global.pgb.opts.variables = { share: true, foo: 'bar', 'android-key': 12 }
-    expect(app.getData()).toEqual({ share: true, keys: { android: 12 } })
+    global.pgb.opts.variables = { share: true, foo: 'bar', 'android-key': 12, ignore: [ 'node_modules' ] }
+    expect(app.getData()).toEqual({ share: true, keys: { android: 12 }, ignore: [ 'node_modules' ] })
   })
 })
diff --git a/test/commands/new.js b/test/commands/new.js
@@ -37,7 +37,7 @@ describe('new', () => {
       .then(command)
       .then(() => {
         expect(pgb.print).toBeCalledWith('app 12 added')
-        expect(pgb.api.addApp).toBeCalledWith('org/repo', { 'hydrates': true, 'keys': {} })
+        expect(pgb.api.addApp).toBeCalledWith('org/repo', { 'hydrates': true, 'keys': {}, ignore: [] })
         expect(BindTransfer).toBeCalled()
       })
   })
diff --git a/test/commands/update.js b/test/commands/update.js
@@ -39,7 +39,7 @@ describe('update', () => {
       .then(command)
       .then(() => {
         expect(pgb.print).toBeCalledWith('app 12 updated')
-        expect(pgb.api.updateApp).toBeCalledWith('12', 'org/repo', { 'hydrates': true, 'keys': {} })
+        expect(pgb.api.updateApp).toBeCalledWith('12', 'org/repo', { 'hydrates': true, 'keys': {}, ignore: [] })
         expect(BindTransfer).toBeCalled()
       })
   })

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "pgb-cli",`
`3`		`- "version": "1.0.4-dev",`
	`3`	`+ "version": "1.1.0",`
`4`	`4`	`"description": "nodeJS CLI to PhoneGap Build",`
`5`	`5`	`"keywords": [`
`6`	`6`	`"PhoneGap",`
`@@ -55,7 +55,7 @@`
`55`	`55`	`},`
`56`	`56`	`"dependencies": {`
`57`	`57`	`"easy-utf8-table": "^0.2.0",`
`58`		`- "pgb-api": "^1.0.5",`
	`58`	`+ "pgb-api": "^1.1.1",`
`59`	`59`	`"visualwidth": "^0.1.0"`
`60`	`60`	`}`
`61`	`61`	`}`