Merge pull request #166 from varya/features/kss-divider

KSS blocks splitter. Initial edition

Author: hannu

.jscsrc

@@ -11,6 +11,8 @@
       "test/angular/**",
       "bin/**",
       "lib/dist/**",
-      "lib/app/js/components/**"
+      "lib/app/js/components/**",
+      "lib/modules/kss-blocks-parser.js",
+      "test/kss-splitter.js" // Does not allow multiple linebreaks in comments
     ]
 }

gulpfile.js

@@ -10,6 +10,7 @@ var gulp = require('gulp'),
     bower = require('gulp-bower'),
     mainBowerFiles = require('main-bower-files'),
     path = require('path'),
+    run = require('gulp-run'),
     jscs = require('gulp-jscs'),
     runSequence = require('run-sequence'),
     styleguide = require('./lib/styleguide'),
@@ -109,6 +110,12 @@ gulp.task('sass', function() {
     .pipe(gulp.dest(distPath + '/css'));
 });
 
+gulp.task('kss-splitter', function() {
+
+  run('./node_modules/ometajs/bin/ometajs2js -i lib/modules/kss-blocks-parser.ometajs -o lib/modules/kss-blocks-parser.js');
+
+});
+
 gulp.task('demo', function() {
   options.server = true;
   configPath = __dirname + '/lib/app/styleguide_config.json';
@@ -158,7 +165,7 @@ gulp.task('watch', [], function() {
   gulp.watch(sourcePath + '/**', ['styleguide']);
 });
 
-gulp.task('build', ['sass', 'js:app', 'js:vendor', 'html', 'assets']);
+gulp.task('build', ['sass', 'kss-splitter', 'js:app', 'js:vendor', 'html', 'assets']);
 
 gulp.task('changelog', function() {
 

lib/modules/kss-blocks-parser.js

@@ -0,0 +1,46 @@
+ometa kssBlocksParser {
+
+  lineBreak = seq('\n'),
+  lineEnd = lineBreak | end,
+
+  inlineCommentPrefix = seq('//'),
+  lineWithNoComments = (~inlineCommentPrefix char)* lineEnd, // every line with no inline comments
+
+  // A set of numbers divided with "."
+  kssReferenceNumber_ = '.' digit+ kssReferenceNumber_*,
+  kssReferenceNumber = digit+ kssReferenceNumber_*,
+
+  // In-comment string mentioning styleguide reference
+  kssReferenceString = seq(' ')* seq('Styleguide ') kssReferenceNumber seq(' ')*,
+
+  // A block of inline comments
+  inlineComment = inlineCommentPrefix (~lineEnd ~kssReferenceString char)*,
+
+  multiLineCommentPrefix = seq('/*'),
+  multiLineCommentSuffix = seq('*/'),
+
+  // A block of multiline comments
+  multiLineCommentBody = (~multiLineCommentSuffix char)*,
+  multiLineComment = (multiLineCommentPrefix multiLineCommentBody multiLineCommentSuffix):c -> [#comment, c],
+
+  // A block of inline comments with KSS markup
+  kssLastString = inlineCommentPrefix kssReferenceString lineEnd,
+  kssMarkupInline = ((~lineWithNoComments inlineComment lineEnd)* kssLastString):k -> [#kss, k],
+
+  // A block of multiline comments with KSS markup
+  kssLastStringMultiline = kssReferenceString lineEnd?,
+  kssMarkupMultiLineBody = (~multiLineCommentSuffix ~kssLastStringMultiline char)* kssLastStringMultiline,
+  kssMarkupMultiLine = (multiLineCommentPrefix kssMarkupMultiLineBody multiLineCommentSuffix):k -> [#kss, k],
+
+  // KSS markup can be either in any block of comments
+  kssMarkup = kssMarkupInline | kssMarkupMultiLine,
+
+  // A code block is anything which is not KSS markup block
+  code = (~kssMarkup char)*:c -> [#code, c.join('')],
+
+  // A block consists of KSS markup and following code block
+  block = kssMarkup:k lineEnd* code:c -> [#block, k, c],
+
+  any = code? (block)*
+
+}

lib/modules/kss-blocks-parser.ometajs

@@ -0,0 +1,32 @@
+'use strict'
+
+var kssBlocksParser = require('./kss-blocks-parser').kssBlocksParser;
+
+module.exports = {
+
+  getAst: function(source) {
+    var ast = kssBlocksParser.matchAll(source, 'any');
+    return ast;
+  },
+  getBlocks: function(source) {
+    var ast = this.getAst(source),
+      blocks = [];
+    ast.forEach(function(token) {
+      var kss, code;
+      if (token[0] == 'block') {
+        if (token[1][0] == 'kss') {
+          kss = token[1][1]
+        }
+        if (token[2][0] == 'code') {
+          code = token[2][1]
+        }
+      }
+      blocks.push({
+        kss: kss,
+        code: code
+      });
+    });
+    return blocks;
+  }
+
+}

lib/modules/kss-splitter.js

@@ -34,6 +34,7 @@
     "gulp-marked": "^1.0.0",
     "gulp-mustache": "^1.0.0",
     "gulp-rename": "^1.2.0",
+    "gulp-run": "^1.6.4",
     "gulp-sass": "^1.2.2",
     "gulp-util": "^3.0.1",
     "jade": "^1.7.0",
@@ -45,6 +46,7 @@
     "node-bourbon": "^1.2.3",
     "node-neat": "^1.3.0",
     "node.extend": "^1.1.2",
+    "ometajs": "^3.3.7",
     "run-sequence": "^1.0.1",
     "sanitize-html": "^1.4.3",
     "serve-favicon": "^2.1.6",