Gonzales 3.0: Update sort-order option

Author: tonyganch

lib/options/sort-order.js

@@ -1,3 +1,5 @@
+var gonzales = require('gonzales-pe');
+
 module.exports = {
     name: 'sort-order',
 
@@ -33,10 +35,9 @@ module.exports = {
 
     /**
      * Processes tree node.
-     * @param {String} nodeType
      * @param {node} node
      */
-    process: function(nodeType, node) {
+    process: function(node) {
         var _this = this;
         // Types of nodes that can be sorted:
         var NODES = ['atruleb', 'atruler', 'atrules', 'commentML', 'commentSL',
@@ -73,7 +74,7 @@ module.exports = {
          * @param {node} node Space node.
          */
         var removeEmptyLines = function(node) {
-            node[1] = node[1].replace(/\n[\s\t\n\r]*\n/, '\n');
+            node.content = node.content.replace(/\n[\s\t\n\r]*\n/, '\n');
         };
 
         /**
@@ -88,7 +89,7 @@ module.exports = {
             var d = [];
 
             for (; i < l; i++) {
-                currentNode = node[i];
+                currentNode = node.get(i);
                 // If there is no node left,
                 // stop and do nothing with previously found spaces/comments:
                 if (!currentNode) {
@@ -97,7 +98,7 @@ module.exports = {
 
                 // If the node is declaration or @-rule, stop and return all
                 // found nodes with spaces and comments (if there are any):
-                if (SC.indexOf(currentNode[0]) === -1) break;
+                if (SC.indexOf(currentNode.type) === -1) break;
 
                 sc.push(currentNode);
                 d.push(i);
@@ -124,26 +125,28 @@ module.exports = {
 
             // Check every next node:
             for (; i < l; i++) {
-                currentNode = node[i + 1];
+                currentNode = node.get(i + 1);
                 // If there is no node, or it is nor spaces neither comment, stop:
-                if (!currentNode || SC.indexOf(currentNode[0]) === -1) break;
+                if (!currentNode || SC.indexOf(currentNode.type) === -1) break;
 
-                if (['commentML', 'commentSL'].indexOf(currentNode[0]) > -1) {
+                if (currentNode.is('commentML') || currentNode.is('commentSL')) {
                     sc.push(currentNode);
                     d.push(i + 1);
                     continue;
                 }
 
-                lbIndex = currentNode[1].indexOf('\n');
+                lbIndex = currentNode.content.indexOf('\n');
 
                 // If there are any line breaks in a node with spaces, stop and
                 // split the node into two: one with spaces before line break
                 // and one with `\n` symbol and everything that goes after.
                 // Combine the first one with declaration/@-rule's node:
                 if (lbIndex > -1) {
                     // TODO: Don't push an empty array
-                    sc.push(['s', currentNode[1].substring(0, lbIndex)]);
-                    currentNode[1] = currentNode[1].substring(lbIndex);
+                    var s = currentNode.content.substring(0, lbIndex);
+                    var space = gonzales.createNode({ type: 's', content: s });
+                    sc.push(space);
+                    currentNode.content = currentNode.content.substring(lbIndex);
                     break;
                 }
 
@@ -162,8 +165,8 @@ module.exports = {
          * @returns {Object} Extended node
          */
         var extendNode = function() {
-            currentNode = node[i];
-            var nextNode = node[i + 1];
+            currentNode = node.get(i);
+            var nextNode = node.get(i + 1);
             // Object containing current node, all corresponding spaces,
             // comments and other information:
             var extendedNode;
@@ -195,13 +198,13 @@ module.exports = {
             extendedNode.sc1 = checkSC1();
 
             if (extendedNode.sc1.length) {
-                currentNode = node[i];
-                nextNode = node[i + 1];
+                currentNode = node.get(i);
+                nextNode = node.get(i + 1);
             }
 
             // If there is `;` right after the declaration, save it with the
             // declaration and mark it for removing from parent node:
-            if (currentNode && nextNode && nextNode[0] === 'declDelim') {
+            if (currentNode && nextNode && nextNode.is('declDelim')) {
                 extendedNode.delim.push(nextNode);
                 deleted.push(i + 1);
                 i++;
@@ -229,8 +232,8 @@ module.exports = {
             var prefixesRegExp = /^(-webkit-|-moz-|-ms-|-o-)(.*)$/;
 
             // Get property name (i.e. `color`, `-o-animation`):
-            a = a.node[1][1][1];
-            b = b.node[1][1][1];
+            a = a.node.get(0).get(0).content;
+            b = b.node.get(0).get(0).content;
 
             // Get prefix and unprefixed part. For example:
             // ['-o-animation', '-o-', 'animation']
@@ -252,23 +255,23 @@ module.exports = {
 
         // TODO: Think it through!
         // Sort properties only inside blocks:
-        if (nodeType !== 'block') return;
+        if (!node.is('block')) return;
 
         // Check every child node.
         // If it is declaration (property-value pair, e.g. `color: tomato`),
         // or @-rule (e.g. `@include nani`),
         // combine it with spaces, semicolon and comments and move them from
         // current node to a separate list for further sorting:
         for (i = 0, l = node.length; i < l; i++) {
-            if (NODES.indexOf(node[i][0]) === -1) continue;
+            if (NODES.indexOf(node.get(i).type) === -1) continue;
 
             // Save preceding spaces and comments, if there are any, and mark
             // them for removing from parent node:
             sc0 = checkSC0();
             if (!sc0) continue;
 
             // If spaces/comments are the last nodes, stop and go to sorting:
-            if (!node[i]) {
+            if (!node.get(i)) {
                 deleted.splice(deleted.length - sc0.length, deleted.length + 1);
                 break;
             }
@@ -279,17 +282,19 @@ module.exports = {
             // If not, proceed with the next node:
             propertyName = null;
             // Look for includes:
-            if (node[i][0] === 'include') {
+            if (node.get(i).is('include')) {
                 propertyName = '$include';
             } else {
-                for (j = 1, nl = node[i].length; j < nl; j++) {
-                    currentNode = node[i][j];
-                    if (currentNode[0] === 'property') {
-                        propertyName = currentNode[1][0] === 'variable' ?
-                            '$variable' : currentNode[1][1];
+                for (j = 0, nl = node.get(i).length; j < nl; j++) {
+                    currentNode = node.get(i).get(j);
+                    if (!currentNode) continue;
+
+                    if (currentNode.is('property')) {
+                        propertyName = currentNode.get(0).is('variable') ?
+                            '$variable' : currentNode.get(0).content;
                         break;
-                    } else if (currentNode[0] === 'atkeyword' &&
-                        currentNode[1][1] === 'import') { // Look for imports
+                    } else if (currentNode.is('atkeyword') &&
+                        currentNode.get(0).content === 'import') { // Look for imports
                         propertyName = '$import';
                         break;
                     }
@@ -310,7 +315,7 @@ module.exports = {
 
         // Remove all nodes, that were moved to a `sorted` list, from parent node:
         for (i = deleted.length - 1; i > -1; i--) {
-            node.splice(deleted[i], 1);
+            node.content.splice(deleted[i], 1);
         }
 
         // Sort declarations saved for sorting:
@@ -353,25 +358,29 @@ module.exports = {
 
                 // Divide declarations from different groups with an empty line:
                 if (prevNode && currentNode.groupIndex > prevNode.groupIndex) {
-                    if (sc0[0] && sc0[0][0] === 's' &&
+                    if (sc0[0] && sc0[0].is('s') &&
                        (this.syntax === 'sass' ||
-                        sc0[0][1].match(/\n/g) &&
-                        sc0[0][1].match(/\n/g).length < 2)) {
-                        sc0[0][1] = '\n' + sc0[0][1];
+                        sc0[0].content.match(/\n/g) &&
+                        sc0[0].content.match(/\n/g).length < 2)) {
+                        sc0[0].content = '\n' + sc0[0].content;
                     }
                 }
 
                 for (j = 0, nl = sc2.length; j < nl; j++) {
-                    node.unshift(sc2[j]);
+                    node.content.unshift(sc2[j]);
+                }
+                if (currentNode.delim.length > 0) {
+                    var delim = this.syntax === 'sass' ? '\n' : ';';
+                    var declDelim = gonzales.createNode({ type: 'declDelim', content: delim });
+                    node.content.unshift(declDelim);
                 }
-                if (currentNode.delim.length > 0) node.unshift(['declDelim']);
                 for (j = 0, nl = sc1.length; j < nl; j++) {
-                    node.unshift(sc1[j]);
+                    node.content.unshift(sc1[j]);
                 }
-                node.unshift(currentNode.node);
+                node.content.unshift(currentNode.node);
 
                 for (j = 0, nl = sc0.length; j < nl; j++) {
-                    node.unshift(sc0[j]);
+                    node.content.unshift(sc0[j]);
                 }
             }
         }

test/options/sort-order-fallback/test.js

@@ -1,4 +1,4 @@
-describe.skip('options/sort-order-fallback', function() {
+describe('options/sort-order-fallback', function() {
     it('Should sort leftovers alphabetically if `sort-order-fallback` is set', function() {
         var config = {
             'sort-order-fallback': 'abc',

test/options/sort-order-less/test.js

@@ -1,4 +1,4 @@
-describe.skip('options/sort-order (less)', function() {
+describe('options/sort-order (less)', function() {
     it('Should sort properties inside rules', function() {
         this.comb.configure({ 'sort-order': [
             ['top', 'color']

test/options/sort-order-sass/test.js

@@ -1,4 +1,4 @@
-describe.skip('options/sort-order (sass)', function() {
+describe('options/sort-order (sass)', function() {
     it('Should sort properties inside rules', function() {
         this.comb.configure({ 'sort-order': [
             ['top', 'color']

test/options/sort-order-scss/test.js

@@ -1,4 +1,4 @@
-describe.skip('options/sort-order (scss)', function() {
+describe('options/sort-order (scss)', function() {
     it('Should sort properties inside rules (single line)', function() {
         this.comb.configure({ 'sort-order': [
             ['top', 'color']

test/options/sort-order/test.js

@@ -1,6 +1,6 @@
 var assert = require('assert');
 
-describe.skip('options/sort-order', function() {
+describe('options/sort-order', function() {
     it('Should be in expected order in case properties are not grouped', function() {
         this.comb.configure({ 'sort-order': ['position', 'z-index'] });
         this.shouldBeEqual('single-group.css', 'single-group.expected.css');
@@ -61,47 +61,47 @@ describe.skip('options/sort-order', function() {
         assert.equal(input, expected);
     });
 
-    it('Issue 94. Test 1', function() {
+    it.skip('Issue 94. Test 1', function() {
         var config = this.Comb.getConfig('csscomb');
         this.comb.configure(config);
         this.shouldBeEqual('issue-94-1.css', 'issue-94-1.expected.css');
     });
 
-    it('Issue 94. Test 2', function() {
+    it.skip('Issue 94. Test 2', function() {
         var config = this.Comb.getConfig('csscomb');
         this.comb.configure(config);
         this.shouldBeEqual('issue-94-2.css', 'issue-94-2.expected.css');
     });
 
-    it('Issue 94. Test 3', function() {
+    it.skip('Issue 94. Test 3', function() {
         var config = this.Comb.getConfig('csscomb');
         this.comb.configure(config);
         this.shouldBeEqual('issue-94-3.css', 'issue-94-3.expected.css');
     });
 
-    it('Should place the leftovers in the end', function() {
+    it.skip('Should place the leftovers in the end', function() {
         var config = this.Comb.getConfig('csscomb');
         this.comb.configure(config);
         this.shouldBeEqual('leftovers-1.css', 'leftovers-1.expected.css');
     });
 
-    it('Should place the leftovers in the beginning', function() {
+    it.skip('Should place the leftovers in the beginning', function() {
         var config = this.Comb.getConfig('csscomb');
         config['sort-order'][0].unshift(['...']);
         this.comb.configure(config);
         this.shouldBeEqual('leftovers-2.css', 'leftovers-2.expected.css');
         config['sort-order'][0].shift();
     });
 
-    it('Should place the leftovers in the beginning of its group', function() {
+    it.skip('Should place the leftovers in the beginning of its group', function() {
         var config = this.Comb.getConfig('csscomb');
         config['sort-order'][1].unshift('...');
         this.comb.configure(config);
         this.shouldBeEqual('leftovers-3.css', 'leftovers-3.expected.css');
         config['sort-order'][1].shift();
     });
 
-    it('Should place the leftovers in the middle of its group', function() {
+    it.skip('Should place the leftovers in the middle of its group', function() {
         var config = this.Comb.getConfig('csscomb');
         config['sort-order'][1].splice(1, 0, '...');
         this.comb.configure(config);