Merge branch 'fixes'

1 files changed, 258 insertions, 0 deletions

diff --git a/lib/models/book.js b/lib/models/book.js
new file mode 100644
index 0000000..f960df1
--- /dev/null
+++ b/lib/models/book.js
@@ -0,0 +1,258 @@
+var path = require('path');
+var Immutable = require('immutable');
+var Ignore = require('ignore');
+
+var Logger = require('../utils/logger');
+
+var FS = require('./fs');
+var Config = require('./config');
+var Readme = require('./readme');
+var Summary = require('./summary');
+var Glossary = require('./glossary');
+var Languages = require('./languages');
+
+
+var Book = Immutable.Record({
+    // Logger for outptu message
+    logger:         Logger(),
+
+    // Filesystem binded to the book scope to read files/directories
+    fs:             FS(),
+
+    // Ignore files parser
+    ignore:         Ignore(),
+
+    // Structure files
+    config:         Config(),
+    readme:         Readme(),
+    summary:        Summary(),
+    glossary:       Glossary(),
+    languages:      Languages(),
+
+    // ID of the language for language books
+    language:       String(),
+
+    // List of children, if multilingual (String -> Book)
+    books:          Immutable.OrderedMap()
+});
+
+Book.prototype.getLogger = function() {
+    return this.get('logger');
+};
+
+Book.prototype.getFS = function() {
+    return this.get('fs');
+};
+
+Book.prototype.getIgnore = function() {
+    return this.get('ignore');
+};
+
+Book.prototype.getConfig = function() {
+    return this.get('config');
+};
+
+Book.prototype.getReadme = function() {
+    return this.get('readme');
+};
+
+Book.prototype.getSummary = function() {
+    return this.get('summary');
+};
+
+Book.prototype.getGlossary = function() {
+    return this.get('glossary');
+};
+
+Book.prototype.getLanguages = function() {
+    return this.get('languages');
+};
+
+Book.prototype.getBooks = function() {
+    return this.get('books');
+};
+
+Book.prototype.getLanguage = function() {
+    return this.get('language');
+};
+
+/**
+    Return FS instance to access the content
+
+    @return {FS}
+*/
+Book.prototype.getContentFS = function() {
+    var fs = this.getFS();
+    var config = this.getConfig();
+    var rootFolder = config.getValue('root');
+
+    if (rootFolder) {
+        return FS.reduceScope(fs, rootFolder);
+    }
+
+    return fs;
+};
+
+/**
+    Return root of the book
+
+    @return {String}
+*/
+Book.prototype.getRoot = function() {
+    var fs = this.getFS();
+    return fs.getRoot();
+};
+
+/**
+    Return root for content of the book
+
+    @return {String}
+*/
+Book.prototype.getContentRoot = function() {
+    var fs = this.getContentFS();
+    return fs.getRoot();
+};
+
+/**
+    Check if a file is ignore (should not being parsed, etc)
+
+    @param {String} ref
+    @return {Page|undefined}
+*/
+Book.prototype.isFileIgnored = function(filename) {
+    var ignore = this.getIgnore();
+    var language = this.getLanguage();
+
+    // Ignore is always relative to the root of the main book
+    if (language) {
+        filename = path.join(language, filename);
+    }
+
+
+    return ignore.filter([filename]).length == 0;
+};
+
+/**
+    Check if a content file is ignore (should not being parsed, etc)
+
+    @param {String} ref
+    @return {Page|undefined}
+*/
+Book.prototype.isContentFileIgnored = function(filename) {
+    var config = this.getConfig();
+    var rootFolder = config.getValue('root');
+
+    if (rootFolder) {
+        filename = path.join(rootFolder, filename);
+    }
+
+    return this.isFileIgnored(filename);
+};
+
+/**
+    Return a page from a book by its path
+
+    @param {String} ref
+    @return {Page|undefined}
+*/
+Book.prototype.getPage = function(ref) {
+    return this.getPages().get(ref);
+};
+
+/**
+    Is this book the parent of language's books
+
+    @return {Boolean}
+*/
+Book.prototype.isMultilingual = function() {
+    return (this.getLanguages().getCount() > 0);
+};
+
+/**
+    Return true if book is associated to a language
+
+    @return {Boolean}
+*/
+Book.prototype.isLanguageBook = function() {
+    return Boolean(this.getLanguage());
+};
+
+/**
+    Add a new language book
+
+    @param {String} language
+    @param {Book} book
+    @return {Book}
+*/
+Book.prototype.addLanguageBook = function(language, book) {
+    var books = this.getBooks();
+    books = books.set(language, book);
+
+    return this.set('books', books);
+};
+
+/**
+    Set the summary for this book
+
+    @param {Summary}
+    @return {Book}
+*/
+Book.prototype.setSummary = function(summary) {
+    return this.set('summary', summary);
+};
+
+/**
+    Set the readme for this book
+
+    @param {Readme}
+    @return {Book}
+*/
+Book.prototype.setReadme = function(readme) {
+    return this.set('readme', readme);
+};
+
+/**
+    Change log level
+
+    @param {String} level
+    @return {Book}
+*/
+Book.prototype.setLogLevel = function(level) {
+    this.getLogger().setLevel(level);
+    return this;
+};
+
+/**
+    Create a book using a filesystem
+
+    @param {FS} fs
+    @return {Book}
+*/
+Book.createForFS = function createForFS(fs) {
+    return new Book({
+        fs: fs
+    });
+};
+
+/**
+    Create a language book from a parent
+
+    @param {Book} parent
+    @param {String} language
+    @return {Book}
+*/
+Book.createFromParent = function createFromParent(parent, language) {
+    var ignore = parent.getIgnore();
+
+    return new Book({
+        // Inherits config. logegr and list of ignored files
+        logger: parent.getLogger(),
+        config: parent.getConfig(),
+        ignore: Ignore().add(ignore),
+
+        language: language,
+        fs: FS.reduceScope(parent.getContentFS(), language)
+    });
+};
+
+module.exports = Book;