From add1b4e9d9600c9b071315ff720c4c7ceaab6de3 Mon Sep 17 00:00:00 2001
From: Robert Knight <robertknight@gmail.com>
Date: Mon, 21 Sep 2020 17:14:35 +0100
Subject: [PATCH] Remove unused code in `Guest` class

 - Remove several methods in `Guest` which were never called in the
   application. This includes the `deleteAnnotation` method which was
   used in a few tests that should have been calling `detach` instead.

 - Remove untested error paths in plugin loading in `Guest`. These were needed
   when the plugins could be defined by the consumer of Annotator but
   this is no longer the case. All plugins are purely internal.

 - Remove logic for setting `annotator` property on root element which
   was never read anywhere
---
 src/annotator/guest.js           | 63 ++------------------------------
 src/annotator/test/guest-test.js | 61 +++----------------------------
 2 files changed, 10 insertions(+), 114 deletions(-)

diff --git a/src/annotator/guest.js b/src/annotator/guest.js
index 2fc177bbf80..e8a105cc688 100644
--- a/src/annotator/guest.js
+++ b/src/annotator/guest.js
@@ -210,23 +210,10 @@ export default class Guest extends Delegator {
   }
 
   addPlugin(name, options) {
-    if (this.plugins[name]) {
-      console.error('You cannot have more than one instance of any plugin.');
-    } else {
-      const Klass = this.options.pluginClasses[name];
-      if (typeof Klass === 'function') {
-        this.plugins[name] = new Klass(this.element[0], options);
-        this.plugins[name].annotator = this;
-        this.plugins[name].pluginInit?.();
-      } else {
-        console.error(
-          'Could not load ' +
-            name +
-            ' plugin. Have you included the appropriate <script> tag?'
-        );
-      }
-    }
-    return this; // allow chaining
+    const Klass = this.options.pluginClasses[name];
+    this.plugins[name] = new Klass(this.element[0], options);
+    this.plugins[name].annotator = this;
+    this.plugins[name].pluginInit?.();
   }
 
   // Get the document info
@@ -330,8 +317,6 @@ export default class Guest extends Delegator {
       $(element).remove();
     });
 
-    this.element.data('annotator', null);
-
     for (let name of Object.keys(this.plugins)) {
       this.plugins[name].destroy();
     }
@@ -538,41 +523,6 @@ export default class Guest extends Delegator {
     return this.createAnnotation({ $highlight: true });
   }
 
-  // Create a blank comment (AKA "page note")
-  createComment() {
-    const annotation = {};
-
-    const prepare = info => {
-      annotation.document = info.metadata;
-      annotation.uri = info.uri;
-      annotation.target = [{ source: info.uri }];
-    };
-
-    this.getDocumentInfo()
-      .then(prepare)
-      .then(() => this.publish('beforeAnnotationCreated', [annotation]));
-
-    return annotation;
-  }
-
-  // Public: Deletes the annotation by removing the highlight from the DOM.
-  // Publishes the 'annotationDeleted' event on completion.
-  //
-  // annotation - An annotation Object to delete.
-  //
-  // Returns deleted annotation.
-  deleteAnnotation(annotation) {
-    if (annotation.highlights) {
-      for (let h of annotation.highlights) {
-        if (h.parentNode !== null) {
-          $(h).replaceWith(h.childNodes);
-        }
-      }
-    }
-
-    this.publish('annotationDeleted', [annotation]);
-  }
-
   showAnnotations(annotations) {
     const tags = annotations.map(a => a.$tag);
     this.crossframe?.call('showAnnotations', tags);
@@ -584,11 +534,6 @@ export default class Guest extends Delegator {
     this.crossframe?.call('toggleAnnotationSelection', tags);
   }
 
-  updateAnnotations(annotations) {
-    const tags = annotations.map(a => a.$tag);
-    this.crossframe?.call('updateAnnotations', tags);
-  }
-
   focusAnnotations(annotations) {
     const tags = annotations.map(a => a.$tag);
     this.crossframe?.call('focusAnnotations', tags);
diff --git a/src/annotator/test/guest-test.js b/src/annotator/test/guest-test.js
index 69b8092e24f..923612c2e95 100644
--- a/src/annotator/test/guest-test.js
+++ b/src/annotator/test/guest-test.js
@@ -572,47 +572,6 @@ describe('Guest', () => {
     });
   });
 
-  describe('#createComment', () => {
-    it('adds metadata to the annotation object', () => {
-      const guest = createGuest();
-      sinon.stub(guest, 'getDocumentInfo').returns(
-        Promise.resolve({
-          metadata: { title: 'hello' },
-          uri: 'http://example.com/',
-        })
-      );
-
-      const annotation = guest.createComment();
-
-      return timeoutPromise().then(() => {
-        assert.equal(annotation.uri, 'http://example.com/');
-        assert.deepEqual(annotation.document, { title: 'hello' });
-      });
-    });
-
-    it('adds a single target with a source property', () => {
-      const guest = createGuest();
-      sinon.stub(guest, 'getDocumentInfo').returns(
-        Promise.resolve({
-          metadata: { title: 'hello' },
-          uri: 'http://example.com/',
-        })
-      );
-
-      const annotation = guest.createComment();
-
-      return timeoutPromise().then(() =>
-        assert.deepEqual(annotation.target, [{ source: 'http://example.com/' }])
-      );
-    });
-
-    it('triggers a beforeAnnotationCreated event', done => {
-      const guest = createGuest();
-      guest.subscribe('beforeAnnotationCreated', () => done());
-      guest.createComment();
-    });
-  });
-
   describe('#anchor', () => {
     let el;
     let range;
@@ -823,7 +782,9 @@ describe('Guest', () => {
       const guest = createGuest();
       const annotation = {};
       guest.anchors.push({ annotation });
+
       guest.detach(annotation);
+
       assert.equal(guest.anchors.length, 0);
     });
 
@@ -831,21 +792,11 @@ describe('Guest', () => {
       const guest = createGuest();
       guest.plugins.BucketBar = { update: sinon.stub() };
       const annotation = {};
-
       guest.anchors.push({ annotation });
-      guest.detach(annotation);
-      assert.calledOnce(guest.plugins.BucketBar.update);
-    });
-
-    it('publishes the "annotationDeleted" event', () => {
-      const guest = createGuest();
-      const annotation = {};
-      const publish = sandbox.stub(guest, 'publish');
 
-      guest.deleteAnnotation(annotation);
+      guest.detach(annotation);
 
-      assert.calledOnce(publish);
-      assert.calledWith(publish, 'annotationDeleted', [annotation]);
+      assert.calledOnce(guest.plugins.BucketBar.update);
     });
 
     it('removes any highlights associated with the annotation', () => {
@@ -853,9 +804,9 @@ describe('Guest', () => {
       const annotation = {};
       const highlights = [document.createElement('span')];
       const { removeHighlights } = highlighter;
-
       guest.anchors.push({ annotation, highlights });
-      guest.deleteAnnotation(annotation);
+
+      guest.detach(annotation);
 
       assert.calledOnce(removeHighlights);
       assert.calledWith(removeHighlights, highlights);