Merge pull request #110 from LinusU/entry-name

Add optional name attribute to entries

Author: LinusU

README.md

@@ -75,6 +75,7 @@ the JSON file's path.
           + `file` - Adds a file to the DMG
           + `position` - Positions a present file
       + `path` (string, required) - Path to the file
+      + `name` (string, optional) - Name of the file within the DMG
 
 `0.1.x` used a different JSON format. This format is still supported but
 deprecated, please update your json.

lib/appdmg.js

@@ -322,8 +322,8 @@ module.exports = exports = function (options) {
     }
 
     async.each(global.links, function (entry, cb) {
-      var title = path.basename(entry.path)
-      var finalPath = path.join(global.temporaryMountPath, title)
+      var name = entry.name || path.basename(entry.path)
+      var finalPath = path.join(global.temporaryMountPath, name)
 
       fs.symlink(entry.path, finalPath, cb)
     }, next)
@@ -339,8 +339,8 @@ module.exports = exports = function (options) {
     }
 
     async.each(global.files, function (entry, cb) {
-      var title = path.basename(entry.path)
-      var finalPath = path.join(global.temporaryMountPath, title)
+      var name = entry.name || path.basename(entry.path)
+      var finalPath = path.join(global.temporaryMountPath, name)
 
       util.sh('cp', ['-R', resolvePath(entry.path), finalPath], cb)
     }, next)
@@ -378,7 +378,7 @@ module.exports = exports = function (options) {
     }
 
     global.opts.contents.forEach(function (e) {
-      ds.setIconPos(path.basename(e.path), e.x, e.y)
+      ds.setIconPos(e.name || path.basename(e.path), e.x, e.y)
     })
 
     ds.write(path.join(global.temporaryMountPath, '.DS_Store'), function (err) {

schema.json

@@ -86,6 +86,9 @@
           },
           "path": {
             "type": "string"
+          },
+          "name": {
+            "type": "string"
           }
         },
         "required": [

test/accepted-3.png

@@ -150,4 +150,31 @@ describe('api', function () {
 
     runAppdmg(opts, verify, done)
   })
+
+  it('creates an image with custom names', function (done) {
+    this.timeout(60000) // 1 minute
+
+    var opts = {
+      target: targetPath,
+      basepath: path.join(__dirname, 'assets'),
+      specification: {
+        title: 'Test Title',
+        icon: 'TestIcon.icns',
+        background: 'TestBkg.png',
+        contents: [
+          { x: 448, y: 344, type: 'link', path: '/Applications', name: 'System Apps' },
+          { x: 192, y: 344, type: 'file', path: 'TestApp.app', name: 'My Nice App.app' },
+          { x: 512, y: 128, type: 'file', path: 'TestDoc.txt', name: 'Documentation.txt' }
+        ]
+      }
+    }
+
+    var verify = {
+      format: 'UDZO',
+      title: 'Test Title',
+      visually: 'accepted-3.png'
+    }
+
+    runAppdmg(opts, verify, done)
+  })
 })