summaryrefslogtreecommitdiffstats
path: root/lib/plugins
diff options
context:
space:
mode:
authorSamy Pessé <samypesse@gmail.com>2016-06-08 15:02:34 +0200
committerSamy Pessé <samypesse@gmail.com>2016-06-08 15:02:34 +0200
commit004f91f02c7b98005f8f7cc032ad24d8800651da (patch)
treed175bb7e4e9b8e2004f0ddde5f8d1e22797c501a /lib/plugins
parente6c6ec4293fdf0bd225f1c6613ea484469fa98fd (diff)
downloadgitbook-004f91f02c7b98005f8f7cc032ad24d8800651da.zip
gitbook-004f91f02c7b98005f8f7cc032ad24d8800651da.tar.gz
gitbook-004f91f02c7b98005f8f7cc032ad24d8800651da.tar.bz2
sortPlugins should not be async
Diffstat (limited to 'lib/plugins')
-rw-r--r--lib/plugins/__tests__/sortPlugins.js70
-rw-r--r--lib/plugins/loadForBook.js15
-rw-r--r--lib/plugins/sortPlugins.js47
3 files changed, 60 insertions, 72 deletions
diff --git a/lib/plugins/__tests__/sortPlugins.js b/lib/plugins/__tests__/sortPlugins.js
index 0f54646..2d7a66d 100644
--- a/lib/plugins/__tests__/sortPlugins.js
+++ b/lib/plugins/__tests__/sortPlugins.js
@@ -7,56 +7,54 @@ describe('sortPlugins', function() {
var deps = PluginDependency.listFromString('theme-faq'),
allPlugins = listAll(deps);
- return sortPlugins(allPlugins, [])
- .then(function(sorted) {
- var plugins = sorted.slice(0, -2),
- themes = sorted.slice(-2);
+ var sorted = sortPlugins(allPlugins, []);
- var pluginsOk = plugins.every(function(plugin) {
- return !plugin.isTheme();
- });
+ var plugins = sorted.slice(0, -2),
+ themes = sorted.slice(-2);
- var themesOk = themes.every(function(theme) {
- return theme.isTheme();
- });
+ var pluginsOk = plugins.every(function(plugin) {
+ return !plugin.isTheme();
+ });
+
+ var themesOk = themes.every(function(theme) {
+ return theme.isTheme();
+ });
- expect(pluginsOk).toBe(true);
- expect(plugins.has('search')).toBe(true);
+ expect(pluginsOk).toBe(true);
+ expect(plugins.has('search')).toBe(true);
- expect(themesOk).toBe(true);
- expect(themes.size).toBe(2);
- expect(themes.has('theme-faq')).toBe(true);
- expect(themes.has('theme-default')).toBe(true);
+ expect(themesOk).toBe(true);
+ expect(themes.size).toBe(2);
+ expect(themes.has('theme-faq')).toBe(true);
+ expect(themes.has('theme-default')).toBe(true);
- // theme-default should be last
- expect(themes.last().getName()).toBe('theme-default');
- });
+ // theme-default should be last
+ expect(themes.last().getName()).toBe('theme-default');
});
it('must load themes after plugins with a complex dependencies list', function() {
var deps = PluginDependency.listFromString('comment,theme-faq,-search,ga'),
allPlugins = listAll(deps);
- return sortPlugins(allPlugins, [])
- .then(function(sorted) {
- var plugins = sorted.slice(0, -2),
- themes = sorted.slice(-2);
+ var sorted = sortPlugins(allPlugins, []);
- var pluginsOk = plugins.every(function(plugin) {
- return !plugin.isTheme();
- });
+ var plugins = sorted.slice(0, -2),
+ themes = sorted.slice(-2);
- var themesOk = themes.every(function(theme) {
- return theme.isTheme();
- });
-
- expect(pluginsOk).toBe(true);
- expect(plugins.has('search')).toBe(false);
+ var pluginsOk = plugins.every(function(plugin) {
+ return !plugin.isTheme();
+ });
- expect(themesOk).toBe(true);
- expect(themes.size).toBe(2);
- expect(themes.has('theme-faq')).toBe(true);
- expect(themes.has('theme-default')).toBe(true);
+ var themesOk = themes.every(function(theme) {
+ return theme.isTheme();
});
+
+ expect(pluginsOk).toBe(true);
+ expect(plugins.has('search')).toBe(false);
+
+ expect(themesOk).toBe(true);
+ expect(themes.size).toBe(2);
+ expect(themes.has('theme-faq')).toBe(true);
+ expect(themes.has('theme-default')).toBe(true);
});
}); \ No newline at end of file
diff --git a/lib/plugins/loadForBook.js b/lib/plugins/loadForBook.js
index fd45a77..296cb01 100644
--- a/lib/plugins/loadForBook.js
+++ b/lib/plugins/loadForBook.js
@@ -7,11 +7,10 @@ var sortPlugins = require('./sortPlugins');
/**
- Load a list of plugins in a book
-
- @param {Book}
- @return {Promise<Map<String:Plugin>}
-*/
+ * Load a list of plugins in a book
+ * @param {Book}
+ * @return {Promise<Map<String:Plugin>}
+ */
function loadForBook(book) {
var logger = book.getLogger();
var requirements = listForBook(book);
@@ -28,9 +27,9 @@ function loadForBook(book) {
);
});
- return sortPlugins(installed, requirementsKeys);
- })
- .then(function(installed) {
+ // Sort plugins
+ installed = sortPlugins(installed, requirementsKeys);
+
// Log state
logger.info.ln(installed.size + ' plugins are installed');
if (requirements.size != installed.size) {
diff --git a/lib/plugins/sortPlugins.js b/lib/plugins/sortPlugins.js
index 6626936..e96b02c 100644
--- a/lib/plugins/sortPlugins.js
+++ b/lib/plugins/sortPlugins.js
@@ -1,44 +1,35 @@
-var Promise = require('../utils/promise');
-
var THEME_PREFIX = require('../constants/themePrefix');
var LOADING_ORDER = ['plugin', 'theme'];
/**
- Returns the type of a plugin given its name
-
- @return {String}
-*/
+ * Returns the type of a plugin given its name
+ * @return {String}
+ */
function pluginType(name) {
return (name && name.indexOf(THEME_PREFIX) === 0) ? 'theme' : 'plugin';
}
/**
- Sort the list of installed plugins to match list in book.json
- The themes should always be loaded after the plugins
-
- @param {<OrderedMap<String:Plugin>>} plugins
- @param {<List<String>>} requirementsKeys
- @return {Promise<OrderedMap<String:Plugin>>}
-*/
-
+ * Sort the list of installed plugins to match list in book.json
+ * The themes should always be loaded after the plugins
+ *
+ * @param {<OrderedMap<String:Plugin>>} plugins
+ * @param {<List<String>>} requirementsKeys
+ * @return {OrderedMap<String:Plugin>}
+ */
function sortPlugins(plugins, requirementsKeys) {
- return Promise()
- .then(function() {
- // Sort plugins to match list in book.json
- plugins = plugins.sort(function(a, b) {
- // Get order from book.json
- var definitionOrder = requirementsKeys.indexOf(a.getName()) < requirementsKeys.indexOf(b.getName());
-
- // Get order from plugins a and b type
- var aType = pluginType(a.getName()),
- bType = pluginType(b.getName()),
- loadingOrder = LOADING_ORDER.indexOf(aType) < LOADING_ORDER.indexOf(bType);
+ // Sort plugins to match list in book.json
+ return plugins.sort(function(a, b) {
+ // Get order from book.json
+ var definitionOrder = requirementsKeys.indexOf(a.getName()) < requirementsKeys.indexOf(b.getName());
- return loadingOrder || definitionOrder ? -1 : 1;
- });
+ // Get order from plugins a and b type
+ var aType = pluginType(a.getName()),
+ bType = pluginType(b.getName()),
+ loadingOrder = LOADING_ORDER.indexOf(aType) < LOADING_ORDER.indexOf(bType);
- return plugins;
+ return loadingOrder || definitionOrder ? -1 : 1;
});
}