v0.1.0

Makefile

@@ -0,0 +1,4 @@
+test:
+	./node_modules/.bin/mocha --reporter spec
+
+.PHONY: test

package.json

@@ -0,0 +1,48 @@
+{
+  "name": "raneto-core",
+  "version": "0.1.0",
+  "description": "Core module for Raneto",
+  "author": "Gilbert Pellegrom <[email protected]>",
+  "license": "MIT",
+  "keywords": [
+    "raneto",
+    "markdown",
+    "static",
+    "site",
+    "generator"
+  ],
+  "main": "raneto.js",
+  "scripts": {
+    "test": "make test"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/gilbitron/Raneto-Core.git"
+  },
+  "bugs": {
+    "url": "https://github.com/gilbitron/Raneto-Core/issues"
+  },
+  "homepage": "https://github.com/gilbitron/Raneto-Core",
+  "licenses": [
+    {
+      "type": "MIT",
+      "url": "https://raw.githubusercontent.com/gilbitron/Raneto-Core/master/LICENSE"
+    }
+  ],
+  "engines": {
+    "node": "~0.10.0"
+  },
+  "dependencies": {
+    "glob": "^4.0.0",
+    "lunr": "^0.5.3",
+    "marked": "^0.3.2",
+    "moment": "^2.6.0",
+    "underscore": "^1.6.0",
+    "underscore.string": "^2.3.3",
+    "validator": "^3.13.0"
+  },
+  "devDependencies": {
+    "chai": "^1.9.1",
+    "mocha": "^1.20.1"
+  }
+}

raneto.js

@@ -0,0 +1,212 @@
+var path = require('path'),
+	fs = require('fs'),
+	glob = require('glob'),
+	_ = require('underscore'),
+	_s = require('underscore.string'),
+	moment = require('moment'),
+	marked = require('marked'),
+	lunr = require('lunr'),
+	validator = require('validator');
+
+var raneto = {
+
+	// Default content directory where Markdown files are stored
+	contentDir: './content/',
+
+	// Toggle debug logging
+	debug: false,
+
+	// Regex for page meta
+	_metaRegex: /^\/\*([\s\S]*?)\*\//i,
+
+	// Makes filename safe strings
+	cleanString: function(str, use_underscore) {
+		var u = use_underscore || false;
+		str = str.replace(/\//g, ' ').trim();
+		if(u){
+			return _s.underscored(str);
+		} else {
+			return _s.trim(_s.dasherize(str), '-');
+		}
+	},
+
+	// Convert a slug to a title
+	slugToTitle: function(slug) {
+		slug = slug.replace('.md', '').trim();
+		return _s.titleize(_s.humanize(path.basename(slug)));
+	},
+
+	// Get meta information from Markdown content
+	processMeta: function(markdownContent) {
+		var metaArr = markdownContent.match(raneto._metaRegex),
+			meta = {};
+
+		var metaString = metaArr ? metaArr[1].trim() : '';
+		if(metaString){
+			var metas = metaString.match(/(.*): (.*)/ig);
+			metas.forEach(function(item){
+				var parts = item.split(': ');
+				if(parts[0] && parts[1]){
+					meta[raneto.cleanString(parts[0], true)] = parts[1].trim();
+				}
+			});
+		}
+
+		return meta;
+	},
+
+	// Strip meta from Markdown content
+	stripMeta: function(markdownContent) {
+		return markdownContent.replace(raneto._metaRegex, '').trim();
+	},
+
+	// Replace content variables in Markdown content
+	processVars: function(markdownContent, config) {
+		config = config || {};
+		if(typeof config.base_url !== 'undefined') markdownContent = markdownContent.replace(/\%base_url\%/g, config.base_url);
+		if (typeof config.image_url !== 'undefined') markdownContent = markdownContent.replace(/\%image_url\%/g, config.image_url);
+		return markdownContent;
+	},
+
+	// Get a page
+	getPage: function(filePath, config) {
+		config = config || {};
+		try {
+			var file = fs.readFileSync(filePath),
+				slug = filePath.replace(raneto.contentDir, '').trim();
+
+			if(slug.indexOf('index.md') > -1){
+				slug = slug.replace('index.md', '');
+			}
+			slug = slug.replace('.md', '').trim();
+
+			var meta = raneto.processMeta(file.toString('utf-8')),
+				content = raneto.stripMeta(file.toString('utf-8'));
+			content = raneto.processVars(content, config);
+			var html = marked(content);
+
+			return {
+				'slug': slug,
+				'title': meta.title ? meta.title : raneto.slugToTitle(slug),
+				'body': html,
+				'excerpt': _s.prune(_s.stripTags(_s.unescapeHTML(html)), config.excerpt_length)
+			};
+		}
+		catch(e){
+			if(raneto.debug) console.log(e);
+			return null;
+		}
+	},
+
+	// Get a structured array of the contents of contentDir
+	getPages: function(activePageSlug, config) {
+		activePageSlug = activePageSlug || '';
+		config = config || {};
+		var page_sort_meta = config.page_sort_meta || '',
+			category_sort = config.category_sort || false,
+			files = glob.sync(raneto.contentDir +'**/*'),
+			filesProcessed = [];
+
+		filesProcessed.push({
+			slug: '.',
+			title: '',
+			is_index: true,
+			class: 'category-index',
+			sort: 0,
+			files: []
+		});
+
+		files.forEach(function(filePath){
+            var shortPath = filePath.replace(raneto.contentDir, '').trim(),
+				stat = fs.lstatSync(filePath);
+
+			if(stat.isDirectory()){
+				var sort = 0;
+				if(category_sort){
+					try {
+						var sortFile = fs.readFileSync(raneto.contentDir + shortPath +'/sort');
+						sort = parseInt(sortFile.toString('utf-8'), 10);
+					}
+					catch(e){
+						if(raneto.debug) console.log(e);
+					}
+				}
+
+				filesProcessed.push({
+					slug: shortPath,
+					title: _s.titleize(_s.humanize(path.basename(shortPath))),
+					is_index: false,
+					class: 'category-'+ raneto.cleanString(shortPath),
+					sort: sort,
+					files: []
+				});
+			}
+			if(stat.isFile() && path.extname(shortPath) == '.md'){
+				try {
+					var file = fs.readFileSync(filePath),
+						slug = shortPath,
+						pageSort = 0;
+
+					if(shortPath.indexOf('index.md') > -1){
+						slug = slug.replace('index.md', '');
+					}
+					slug = slug.replace('.md', '').trim();
+
+					var dir = path.dirname(shortPath),
+						meta = raneto.processMeta(file.toString('utf-8'));
+
+					if(page_sort_meta && meta[page_sort_meta]) pageSort = parseInt(meta[page_sort_meta], 10);
+
+					var val = _.find(filesProcessed, function(item){ return item.slug == dir; });
+					val.files.push({
+						slug: slug,
+						title: meta.title ? meta.title : raneto.slugToTitle(slug),
+						active: (activePageSlug.trim() == '/'+ slug),
+						sort: pageSort
+					});
+				}
+				catch(e){
+					if(raneto.debug) console.log(e);
+				}
+			}
+		});
+
+		filesProcessed = _.sortBy(filesProcessed, function(cat){ return cat.sort; });
+		filesProcessed.forEach(function(category){
+			category.files = _.sortBy(category.files, function(file){ return file.sort; });
+		});
+
+		return filesProcessed;
+	},
+
+	// Index and search contents
+	doSearch: function(query) {
+		var files = glob.sync(raneto.contentDir +'**/*.md');
+		var idx = lunr(function(){
+			this.field('title', { boost: 10 });
+			this.field('body');
+		});
+
+		files.forEach(function(filePath){
+			try {
+				var shortPath = filePath.replace(raneto.contentDir, '').trim(),
+					file = fs.readFileSync(filePath);
+
+				var meta = raneto.processMeta(file.toString('utf-8'));
+				idx.add({
+					'id': shortPath,
+					'title': meta.title ? meta.title : raneto.slugToTitle(shortPath),
+					'body': file.toString('utf-8')
+				});
+			}
+			catch(e){
+				if(raneto.debug) console.log(e);
+			}
+		});
+
+		return idx.search(query);
+	}
+
+};
+
+module.exports = raneto;

test/content/example-page.md

@@ -0,0 +1,6 @@
+/*
+Title: Example Page
+Sort: 2
+*/
+
+This is some example content.

test/content/sub/page.md

@@ -0,0 +1,5 @@
+/*
+Title: Example Sub Page
+*/
+
+This is some example content.