From e8cc85f733a49ca53e8cda5a96bbaacc9a20ac7e Mon Sep 17 00:00:00 2001 From: Vojta Jina Date: Thu, 17 Oct 2013 14:16:32 -0700 Subject: chore(docs): generate header ids for better linking - generate ids for all headers - collect defined anchors - check broken links (even if the page exists, but the anchor/id does not) --- docs/spec/domSpec.js | 65 +++++++++++++++++++++++++++++++++++++++++++++++--- docs/spec/ngdocSpec.js | 52 +++++++++++++++++++++------------------- 2 files changed, 90 insertions(+), 27 deletions(-) (limited to 'docs/spec') diff --git a/docs/spec/domSpec.js b/docs/spec/domSpec.js index 7bc6a7f4..d10db9dc 100644 --- a/docs/spec/domSpec.js +++ b/docs/spec/domSpec.js @@ -1,4 +1,5 @@ var DOM = require('../src/dom.js').DOM; +var normalizeHeaderToId = require('../src/dom.js').normalizeHeaderToId; describe('dom', function() { var dom; @@ -7,6 +8,31 @@ describe('dom', function() { dom = new DOM(); }); + describe('html', function() { + it('should add ids to all h tags', function() { + dom.html('

Some Header

'); + expect(dom.toString()).toContain('

Some Header

'); + }); + + it('should collect anchors too', function() { + dom.html('

Xxx and bar '); + expect(dom.anchors).toContain('foo'); + expect(dom.anchors).toContain('bar'); + }) + }); + + it('should collect h tag ids', function() { + dom.h('Page Title', function() { + dom.html('

Second

xxx

Third

'); + dom.h('Another Header', function() {}); + }); + + expect(dom.anchors).toContain('page-title'); + expect(dom.anchors).toContain('second'); + expect(dom.anchors).toContain('second_third'); + expect(dom.anchors).toContain('another-header'); + }); + describe('h', function() { it('should render using function', function() { @@ -25,7 +51,7 @@ describe('dom', function() { this.html('

sub-heading

'); }); expect(dom.toString()).toContain('

heading

'); - expect(dom.toString()).toContain('

sub-heading

'); + expect(dom.toString()).toContain('

sub-heading

'); }); it('should properly number nested headings', function() { @@ -40,12 +66,45 @@ describe('dom', function() { expect(dom.toString()).toContain('

heading

'); expect(dom.toString()).toContain('

heading2

'); - expect(dom.toString()).toContain('

heading3

'); + expect(dom.toString()).toContain('

heading3

'); expect(dom.toString()).toContain('

other1

'); - expect(dom.toString()).toContain('

other2

'); + expect(dom.toString()).toContain('

other2

'); + }); + + + it('should add nested ids to all h tags', function() { + dom.h('Page Title', function() { + dom.h('Second', function() { + dom.html('some

Third

'); + }); + }); + + var resultingHtml = dom.toString(); + expect(resultingHtml).toContain('

Page Title

'); + expect(resultingHtml).toContain('

Second

'); + expect(resultingHtml).toContain('

Third

'); + }); + + }); + + + describe('normalizeHeaderToId', function() { + it('should ignore content in the parenthesis', function() { + expect(normalizeHeaderToId('One (more)')).toBe('one'); + }); + + it('should ignore html content', function() { + expect(normalizeHeaderToId('Section ')).toBe('section'); }); + it('should ignore special characters', function() { + expect(normalizeHeaderToId('Section \'!?')).toBe('section'); + }); + + it('should ignore html entities', function() { + expect(normalizeHeaderToId('angular's-jqlite')).toBe('angulars-jqlite'); + }); }); }); diff --git a/docs/spec/ngdocSpec.js b/docs/spec/ngdocSpec.js index 607745d8..15fd0ba4 100644 --- a/docs/spec/ngdocSpec.js +++ b/docs/spec/ngdocSpec.js @@ -262,33 +262,37 @@ describe('ngdoc', function() { expect(docs[0].events).toEqual([eventA, eventB]); expect(docs[0].properties).toEqual([propA, propB]); }); + }); + describe('checkBrokenLinks', function() { + var docs; - describe('links checking', function() { - var docs; - beforeEach(function() { - spyOn(console, 'log'); - docs = [new Doc({section: 'api', id: 'fake.id1', links: ['non-existing-link']}), - new Doc({section: 'api', id: 'fake.id2'}), - new Doc({section: 'api', id: 'fake.id3'})]; - }); - - it('should log warning when any link doesn\'t exist', function() { - ngdoc.merge(docs); - expect(console.log).toHaveBeenCalled(); - expect(console.log.argsForCall[0][0]).toContain('WARNING:'); - }); + beforeEach(function() { + spyOn(console, 'log'); + docs = [new Doc({section: 'api', id: 'fake.id1', anchors: ['one']}), + new Doc({section: 'api', id: 'fake.id2'}), + new Doc({section: 'api', id: 'fake.id3'})]; + }); - it('should say which link doesn\'t exist', function() { - ngdoc.merge(docs); - expect(console.log.argsForCall[0][0]).toContain('non-existing-link'); - }); + it('should log warning when a linked page does not exist', function() { + docs.push(new Doc({section: 'api', id: 'with-broken.link', links: ['non-existing-link']})) + ngdoc.checkBrokenLinks(docs); + expect(console.log).toHaveBeenCalled(); + var warningMsg = console.log.argsForCall[0][0] + expect(warningMsg).toContain('WARNING:'); + expect(warningMsg).toContain('non-existing-link'); + expect(warningMsg).toContain('api/with-broken.link'); + }); - it('should say where is the non-existing link', function() { - ngdoc.merge(docs); - expect(console.log.argsForCall[0][0]).toContain('api/fake.id1'); - }); + it('should log warning when a linked anchor does not exist', function() { + docs.push(new Doc({section: 'api', id: 'with-broken.link', links: ['api/fake.id1#non-existing']})) + ngdoc.checkBrokenLinks(docs); + expect(console.log).toHaveBeenCalled(); + var warningMsg = console.log.argsForCall[0][0] + expect(warningMsg).toContain('WARNING:'); + expect(warningMsg).toContain('non-existing'); + expect(warningMsg).toContain('api/with-broken.link'); }); }); @@ -524,7 +528,7 @@ describe('ngdoc', function() { doc.ngdoc = 'filter'; doc.parse(); expect(doc.html()).toContain( - '

Animations

\n' + + '

Animations

\n' + '
' + '