fix(worker): appstream file paths should use underscore sanitization

BREAKING CHANGE: appstream file paths should use underscores to match the appstream ID

issue #566

src/worker/task/appstream/content-rating.ts

@@ -19,7 +19,7 @@ export class AppstreamContentRating extends Task {
    * @return {string}
    */
   public get name () {
-    return sanitize(this.worker.context.nameDomain, '-')
+    return sanitize(this.worker.context.nameDomain, '_')
   }
 
   /**

src/worker/task/appstream/description.ts

@@ -19,7 +19,7 @@ export class AppstreamDescription extends Task {
    * @return {string}
    */
   public get name () {
-    return sanitize(this.worker.context.nameDomain, '-')
+    return sanitize(this.worker.context.nameDomain, '_')
   }
 
   /**

src/worker/task/appstream/id.ts

@@ -13,22 +13,13 @@ import { Task } from '../task'
 
 export class AppstreamId extends Task {
 
-  /**
-   * Returns what the appstream ID should be
-   *
-   * @return {string}
-   */
-  public get id () {
-    return sanitize(this.worker.context.nameDomain, '_')
-  }
-
   /**
    * Returns the main appstream file name
    *
    * @return {string}
    */
   public get name () {
-    return sanitize(this.worker.context.nameDomain, '-')
+    return sanitize(this.worker.context.nameDomain, '_')
   }
 
   /**
@@ -53,15 +44,15 @@ export class AppstreamId extends Task {
     const id = $('component > id')
 
     if (id.length === 0) {
-      $('component').prepend(`<id>${this.id}</id>`)
+      $('component').prepend(`<id>${this.name}</id>`)
       await fs.writeFile(this.path, $.xml())
 
       throw new Log(Log.Level.WARN, 'Missing "id" field')
-    } else if (id.text() !== this.id) {
-      id.text(this.id)
+    } else if (id.text() !== this.name) {
+      id.text(this.name)
       await fs.writeFile(this.path, $.xml())
 
-      throw new Log(Log.Level.WARN, `"id" field should be "${this.id}"`)
+      throw new Log(Log.Level.WARN, `"id" field should be "${this.name}"`)
     }
   }
 }

src/worker/task/appstream/index.ts

@@ -66,7 +66,7 @@ export class Appstream extends WrapperTask {
    * @return {string}
    */
   public get name () {
-    return sanitize(this.worker.context.nameDomain, '-')
+    return sanitize(this.worker.context.nameDomain, '_')
   }
 
   /**

src/worker/task/appstream/license.ts

@@ -19,7 +19,7 @@ export class AppstreamLicense extends Task {
    * @return {string}
    */
   public get name () {
-    return sanitize(this.worker.context.nameDomain, '-')
+    return sanitize(this.worker.context.nameDomain, '_')
   }
 
   /**

src/worker/task/appstream/name.ts

@@ -19,7 +19,7 @@ export class AppstreamName extends Task {
    * @return {string}
    */
   public get name () {
-    return sanitize(this.worker.context.nameDomain, '-')
+    return sanitize(this.worker.context.nameDomain, '_')
   }
 
   /**

src/worker/task/appstream/release.ts

@@ -40,7 +40,7 @@ export class AppstreamRelease extends Task {
    * @return {string}
    */
   public get name () {
-    return sanitize(this.worker.context.nameDomain, '-')
+    return sanitize(this.worker.context.nameDomain, '_')
   }
 
   /**

src/worker/task/appstream/screenshot.ts

@@ -19,7 +19,7 @@ export class AppstreamScreenshot extends Task {
    * @return {string}
    */
   public get name () {
-    return sanitize(this.worker.context.nameDomain, '-')
+    return sanitize(this.worker.context.nameDomain, '_')
   }
 
   /**

src/worker/task/appstream/stripe.ts

@@ -19,7 +19,7 @@ export class AppstreamStripe extends Task {
    * @return {string}
    */
   public get name () {
-    return sanitize(this.worker.context.nameDomain, '-')
+    return sanitize(this.worker.context.nameDomain, '_')
   }
 
   /**

src/worker/task/appstream/summary.ts

@@ -19,7 +19,7 @@ export class AppstreamSummary extends Task {
    * @return {string}
    */
   public get name () {
-    return sanitize(this.worker.context.nameDomain, '-')
+    return sanitize(this.worker.context.nameDomain, '_')
   }
 
   /**

src/worker/task/appstream/validate.ts

@@ -27,7 +27,7 @@ export class AppstreamValidate extends Task {
    * @return {string}
    */
   public get name () {
-    return sanitize(this.worker.context.nameDomain, '-')
+    return sanitize(this.worker.context.nameDomain, '_')
   }
 
   /**

test/spec/worker/task/appstream/content-rating.ts

@@ -14,7 +14,7 @@ test('missing content_rating causes an error', async (t) => {
     nameDomain: 'com.github.philip-scott.spice-up'
   })
 
-  await worker.mock('task/appstream/blank.xml', 'package/usr/share/metainfo/com.github.philip-scott.spice-up.appdata.xml')
+  await worker.mock('task/appstream/blank.xml', 'package/usr/share/metainfo/com.github.philip_scott.spice_up.appdata.xml')
 
   worker.tasks.push(AppstreamContentRating)
 
@@ -33,7 +33,7 @@ test('missing a content_rating attribute causes an error', async (t) => {
     nameDomain: 'com.github.philip-scott.spice-up'
   })
 
-  await worker.mock('task/appstream/content-rating.xml', 'package/usr/share/metainfo/com.github.philip-scott.spice-up.appdata.xml')
+  await worker.mock('task/appstream/content-rating.xml', 'package/usr/share/metainfo/com.github.philip_scott.spice_up.appdata.xml')
 
   worker.tasks.push(AppstreamContentRating)
 

test/spec/worker/task/appstream/id.ts

@@ -14,7 +14,7 @@ test('passes with a matching ID', async (t) => {
     nameDomain: 'com.github.philip-scott.spice-up'
   })
 
-  await worker.mock('task/appstream/spice-up.xml', 'package/usr/share/metainfo/com.github.philip-scott.spice-up.appdata.xml')
+  await worker.mock('task/appstream/spice-up.xml', 'package/usr/share/metainfo/com.github.philip_scott.spice_up.appdata.xml')
 
   worker.tasks.push(AppstreamId)
 

test/spec/worker/task/appstream/index.ts

@@ -26,7 +26,7 @@ test('com.github.philip-scott.spice-up passes appstream tests', async (t) => {
     nameDomain: 'com.github.philip-scott.spice-up'
   })
 
-  await worker.mock('task/appstream/spice-up.xml', 'package/usr/share/metainfo/com.github.philip-scott.spice-up.appdata.xml')
+  await worker.mock('task/appstream/spice-up.xml', 'package/usr/share/metainfo/com.github.philip_scott.spice_up.appdata.xml')
 
   worker.tasks.push(Appstream)
 
@@ -42,7 +42,7 @@ test('basic errors get concated to single log', async (t) => {
     nameDomain: 'com.github.philip-scott.spice-up'
   })
 
-  await worker.mock('task/appstream/blank.xml', 'package/usr/share/metainfo/com.github.philip-scott.spice-up.appdata.xml')
+  await worker.mock('task/appstream/blank.xml', 'package/usr/share/metainfo/com.github.philip_scott.spice_up.appdata.xml')
 
   worker.tasks.push(Appstream)
 

test/spec/worker/task/appstream/screenshot.ts

@@ -14,7 +14,7 @@ test('passes with screenshots specified', async (t) => {
     nameDomain: 'com.github.philip-scott.spice-up'
   })
 
-  await worker.mock('task/appstream/spice-up.xml', 'package/usr/share/metainfo/com.github.philip-scott.spice-up.appdata.xml')
+  await worker.mock('task/appstream/spice-up.xml', 'package/usr/share/metainfo/com.github.philip_scott.spice_up.appdata.xml')
 
   worker.tasks.push(AppstreamScreenshot)
 

test/spec/worker/task/appstream/validate.ts

@@ -15,7 +15,7 @@ test('passes with a valid appstream file', async (t) => {
     nameDomain: 'com.github.philip-scott.spice-up'
   })
 
-  await worker.mock('task/appstream/spice-up.xml', 'package/usr/share/metainfo/com.github.philip-scott.spice-up.appdata.xml')
+  await worker.mock('task/appstream/spice-up.xml', 'package/usr/share/metainfo/com.github.philip_scott.spice_up.appdata.xml')
 
   worker.tasks.push(AppstreamValidate)
 
@@ -33,7 +33,7 @@ test('fails with a blank appstream file', async (t) => {
     nameDomain: 'com.github.philip-scott.spice-up'
   })
 
-  await worker.mock('task/appstream/blank.xml', 'package/usr/share/metainfo/com.github.philip-scott.spice-up.appdata.xml')
+  await worker.mock('task/appstream/blank.xml', 'package/usr/share/metainfo/com.github.philip_scott.spice_up.appdata.xml')
 
   worker.tasks.push(AppstreamValidate)