Bring in the `Document` plugin test from the Annotator project

Modified to fit our needs of course..

src/annotator/plugin/test/document-test.coffee

+$ = require('jquery')
+proxyquire = require('proxyquire')
+Document = null
+
+###
+** Adapted from:
+** https://github.com/openannotation/annotator/blob/v1.2.x/test/spec/plugin/document_spec.coffee
+**
+** Annotator v1.2.10
+** https://github.com/openannotation/annotator
+**
+** Copyright 2015, the Annotator project contributors.
+** Dual licensed under the MIT and GPLv3 licenses.
+** https://github.com/openannotation/annotator/blob/master/LICENSE
+###
+
+describe 'Document', ->
+  testDocument = null
+
+# stub the baseURI for the following testing setup
+  docBaseUri = 'https://example.com/a_document.html'
+
+  beforeEach ->
+    Document = proxyquire('../document', {
+      'document-base-uri': docBaseUri
+    })
+    testDocument = new Document($('<div></div>')[0], {})
+
+  afterEach ->
+    $(document).unbind()
+
+  describe 'annotation should have some metadata', ->
+# add some metadata to the page
+    head = $("head")
+    head.append('<link rel="alternate" href="foo.pdf" type="application/pdf"></link>')
+    head.append('<link rel="alternate" href="foo.doc" type="application/msword"></link>')
+    head.append('<link rel="bookmark" href="http://example.com/bookmark"></link>')
+    head.append('<link rel="shortlink" href="http://example.com/bookmark/short"></link>')
+    head.append('<link rel="alternate" href="es/foo.html" hreflang="es" type="text/html"></link>')
+    head.append('<meta name="citation_doi" content="10.1175/JCLI-D-11-00015.1">')
+    head.append('<meta name="citation_title" content="Foo">')
+    head.append('<meta name="citation_pdf_url" content="foo.pdf">')
+    head.append('<meta name="dc.identifier" content="doi:10.1175/JCLI-D-11-00015.1">')
+    head.append('<meta name="dc:identifier" content="isbn:123456789">')
+    head.append('<meta name="DC.type" content="Article">')
+    head.append('<meta property="og:url" content="http://example.com">')
+    head.append('<meta name="twitter:site" content="@okfn">')
+    head.append('<link rel="icon" href="http://example.com/images/icon.ico"></link>')
+    head.append('<meta name="eprints.title" content="Computer Lib / Dream Machines">')
+    head.append('<meta name="prism.title" content="Literary Machines">')
+    head.append('<link rel="alternate" href="feed" type="application/rss+xml"></link>')
+    head.append('<link rel="canonical" href="http://example.com/canonical"></link>')
+
+    metadata = null
+
+    beforeEach ->
+      testDocument.pluginInit()
+      metadata = testDocument.metadata
+
+    it 'should have metadata', ->
+      assert.ok(metadata)
+
+    it 'should have a title, derived from highwire metadata if possible', ->
+      assert.equal(metadata.title, 'Foo')
+
+    it 'should have links with absolute hrefs and types', ->
+      assert.ok(metadata.link)
+      assert.equal(metadata.link.length, 9)
+      assert.match(metadata.link[0].href, docBaseUri)
+      assert.equal(metadata.link[1].rel, "alternate")
+      assert.match(metadata.link[1].href, /^.+foo\.pdf$/)
+      assert.equal(metadata.link[1].type, "application/pdf")
+      assert.equal(metadata.link[2].rel, "alternate")
+      assert.match(metadata.link[2].href, /^.+foo\.doc$/)
+      assert.equal(metadata.link[2].type, "application/msword")
+      assert.equal(metadata.link[3].rel, "bookmark")
+      assert.equal(metadata.link[3].href, "http://example.com/bookmark")
+      assert.equal(metadata.link[4].rel, "shortlink")
+      assert.equal(metadata.link[4].href, "http://example.com/bookmark/short")
+      assert.equal(metadata.link[5].rel, "canonical")
+      assert.equal(metadata.link[5].href, "http://example.com/canonical")
+      assert.equal(metadata.link[6].href, "doi:10.1175/JCLI-D-11-00015.1")
+      assert.match(metadata.link[7].href, /.+foo\.pdf$/)
+      assert.equal(metadata.link[7].type, "application/pdf")
+      assert.equal(metadata.link[8].href, "doi:10.1175/JCLI-D-11-00015.1")
+
+    it 'should ignore atom and RSS feeds and alternate languages', ->
+      assert.equal(metadata.link.length, 9)
+
+    it 'should have highwire metadata', ->
+      assert.ok(metadata.highwire)
+      assert.deepEqual(metadata.highwire.pdf_url, ['foo.pdf'])
+      assert.deepEqual(metadata.highwire.doi, ['10.1175/JCLI-D-11-00015.1'])
+      assert.deepEqual(metadata.highwire.title, ['Foo'])
+
+    it 'should have dublincore metadata', ->
+      assert.ok(metadata.dc)
+      assert.deepEqual(metadata.dc.identifier, ["doi:10.1175/JCLI-D-11-00015.1", "isbn:123456789"])
+      assert.deepEqual(metadata.dc.type, ["Article"])
+
+    it 'should have facebook metadata', ->
+      assert.ok(metadata.facebook)
+      assert.deepEqual(metadata.facebook.url, ["http://example.com"])
+
+    it 'should have eprints metadata', ->
+      assert.ok(metadata.eprints)
+      assert.deepEqual(metadata.eprints.title, ['Computer Lib / Dream Machines'])
+
+    it 'should have prism metadata', ->
+      assert.ok(metadata.prism)
+      assert.deepEqual(metadata.prism.title, ['Literary Machines'])
+
+      it 'should have twitter card metadata', ->
+        assert.ok(metadata.twitter)
+        assert.deepEqual(metadata.twitter.site, ['@okfn'])
+
+    it 'should have unique uris', ->
+      uris = testDocument.uris()
+      assert.equal(uris.length, 7)
+
+    it 'uri() returns the canonical uri', ->
+      uri = testDocument.uri()
+      assert.equal(uri, metadata.link[5].href)
+
+    it 'should have a favicon', ->
+      assert.equal(
+        metadata.favicon
+        'http://example.com/images/icon.ico'
+      )
+
+  describe '#_absoluteUrl', ->
+
+    it 'should add the protocol when the url starts with two slashes', ->
+      result = testDocument._absoluteUrl('//example.com/')
+      expected = "#{document.location.protocol}//example.com/"
+      assert.equal(result, expected)
+
+    it 'should add a trailing slash when given an empty path', ->
+      result = testDocument._absoluteUrl('http://example.com')
+      assert.equal(result, 'http://example.com/')
+
+    it 'should make a relative path into an absolute url', ->
+      result = testDocument._absoluteUrl('path')
+      expected = (
+        document.location.protocol + '//' +
+          document.location.host +
+          document.location.pathname.replace(/[^\/]+$/, '') +
+          'path'
+      )
+      assert.equal(result, expected)
+
+    it 'should make an absolute path into an absolute url', ->
+      result = testDocument._absoluteUrl('/path')
+      expected = (
+        document.location.protocol + '//' +
+          document.location.host +
+          '/path'
+      )
+      assert.equal(result, expected)
+
+  describe '#_getDocumentHref', ->
+
+    it 'should use the baseURI for the current testing setup', ->
+      assert.equal(testDocument._getDocumentHref(), docBaseUri)
+
+    it 'should use the test page href in a different case', ->
+      Document = proxyquire('../document', {
+        'document-base-uri': document.location.href
+      })
+      altDocument = new Document($('<div></div>')[0], {})
+      assert.equal(altDocument._getDocumentHref(), document.location.href)
\ No newline at end of file