gsadmin/gitbook
1
0
Fork 0
mirror of https://github.com/GitbookIO/gitbook.git synced 2026-10-06 05:13:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Adapt tests for website rendering and render languages index

Browse Source
This commit is contained in:
Samy Pesse
2016-10-12 12:12:08 +02:00
parent 5d4dc499a5
commit 4b6fc0ae2f
3 changed files with 32 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/gitbook/src/json/encodeState.js
+1 -1
View File
@@ -31,7 +31,7 @@ function encodeStateToJSON(output, page) {
glossary: encodeGlossary(book.getGlossary(), urls),
readme: encodeReadme(book.getReadme(), urls),
config: book.getConfig().getValues().toJS(),
languages: book.isMultilingual() ? encodeLanguages(book.getLanguages()) : undefined,
languages: book.isMultilingual() ? encodeLanguages(book.getLanguages(), urls) : undefined,
page: page ? encodePage(page, book.getSummary(), urls) : undefined,
file: page ? encodeFile(page.getFile(), urls) : undefined
packages/gitbook/src/output/__tests__/website.js
+19 -33
View File
@@ -1,22 +1,21 @@
const fs = require('fs');
const generateMock = require('./generateMock');
const WebsiteGenerator = require('../website');
describe('WebsiteGenerator', function() {
describe('WebsiteGenerator', () => {
it('should generate an index.html', function() {
it('should generate an index.html', () => {
return generateMock(WebsiteGenerator, {
'README.md': 'Hello World'
})
.then(function(folder) {
.then((folder) => {
expect(folder).toHaveFile('index.html');
});
});
describe('Glossary', function() {
describe('Glossary', () => {
let folder;
before(function() {
before(() => {
return generateMock(WebsiteGenerator, {
'README.md': 'Hello World',
'SUMMARY.md': '* [Deep](folder/page.md)',
@@ -25,43 +24,30 @@ describe('WebsiteGenerator', function() {
},
'GLOSSARY.md': '# Glossary\n\n## Hello\n\nHello World'
})
.then(function(_folder) {
.then((_folder) => {
folder = _folder;
});
});
it('should generate a GLOSSARY.html', function() {
it('should generate a GLOSSARY.html', () => {
expect(folder).toHaveFile('GLOSSARY.html');
});
it('should correctly resolve glossary links in README', function() {
const html = fs.readFileSync(folder + '/index.html', 'utf8');
expect(html).toHaveDOMElement('.page-inner a[href="GLOSSARY.html#hello"]');
});
it('should correctly resolve glossary links in directory', function() {
const html = fs.readFileSync(folder + '/folder/page.html', 'utf8');
expect(html).toHaveDOMElement('.page-inner a[href="../GLOSSARY.html#hello"]');
});
it('should accept a custom glossary file', function() {
it('should accept a custom glossary file', () => {
return generateMock(WebsiteGenerator, {
'README.md': 'Hello World',
'book.json': '{ "structure": { "glossary": "custom.md" } }',
'custom.md': '# Glossary\n\n## Hello\n\nHello World'
})
.then(function(folder) {
expect(folder).toHaveFile('custom.html');
expect(folder).toNotHaveFile('GLOSSARY.html');
const html = fs.readFileSync(folder + '/index.html', 'utf8');
expect(html).toHaveDOMElement('.page-inner a[href="custom.html#hello"]');
.then((result) => {
expect(result).toHaveFile('custom.html');
expect(result).toNotHaveFile('GLOSSARY.html');
});
});
});
it('should copy asset files', function() {
it('should copy asset files', () => {
return generateMock(WebsiteGenerator, {
'README.md': 'Hello World',
'myJsFile.js': 'var a = "test";',
@@ -69,14 +55,14 @@ describe('WebsiteGenerator', function() {
'AnotherAssetFile.md': '# Even md'
}
})
.then(function(folder) {
.then((folder) => {
expect(folder).toHaveFile('index.html');
expect(folder).toHaveFile('myJsFile.js');
expect(folder).toHaveFile('folder/AnotherAssetFile.md');
});
});
it('should generate an index.html for AsciiDoc', function() {
it('should generate an index.html for AsciiDoc', () => {
return generateMock(WebsiteGenerator, {
'README.adoc': 'Hello World'
})
@@ -85,7 +71,7 @@ describe('WebsiteGenerator', function() {
});
});
it('should generate an HTML file for each articles', function() {
it('should generate an HTML file for each articles', () => {
return generateMock(WebsiteGenerator, {
'README.md': 'Hello World',
'SUMMARY.md': '# Summary\n\n* [Page](test/page.md)',
@@ -99,7 +85,7 @@ describe('WebsiteGenerator', function() {
});
});
it('should not generate file if entry file doesn\'t exist', function() {
it('should not generate file if entry file doesn\'t exist', () => {
return generateMock(WebsiteGenerator, {
'README.md': 'Hello World',
'SUMMARY.md': '# Summary\n\n* [Page 1](page.md)\n* [Page 2](test/page.md)',
@@ -107,14 +93,14 @@ describe('WebsiteGenerator', function() {
'page.md': 'Hello 2'
}
})
.then(function(folder) {
.then((folder) => {
expect(folder).toHaveFile('index.html');
expect(folder).toNotHaveFile('page.html');
expect(folder).toHaveFile('test/page.html');
});
});
it('should generate a multilingual book', function() {
it('should generate a multilingual book', () => {
return generateMock(WebsiteGenerator, {
'LANGS.md': '# Languages\n\n* [en](en)\n* [fr](fr)',
'en': {
@@ -124,7 +110,7 @@ describe('WebsiteGenerator', function() {
'README.md': 'Bonjour'
}
})
.then(function(folder) {
.then((folder) => {
// It should generate languages
expect(folder).toHaveFile('en/index.html');
expect(folder).toHaveFile('fr/index.html');
packages/gitbook/src/output/website/onFinish.js
+12 -2
View File
@@ -1,4 +1,7 @@
const JSONUtils = require('../../json');
const Promise = require('../../utils/promise');
const writeFile = require('../helper/writeFile');
const render = require('../../browser/render');
/**
* Finish the generation, write the languages index.
@@ -13,8 +16,15 @@ function onFinish(output) {
return Promise(output);
}
// TODO: multilingual index
return Promise(output);
const plugins = output.getPlugins();
// Generate initial state
const initialState = JSONUtils.encodeState(output);
// Render using React
const html = render(plugins, initialState, 'browser', 'website:languages');
return writeFile(output, 'index.html', html);
}
module.exports = onFinish;