spec-detective - npm Package Compare versions

Comparing version 0.0.2 to 0.0.3

lib/featureTransformer.js

@@ -1,6 +0,8 @@
-var featureParser = require('./featureParser');
+var ParserFactory = require('./parserFactory');
 
 function transformFeature(input, callback) {
     var output = {};
-    featureParser(input, function(spec){
+    var factory = new ParserFactory();
+    var parser = factory.getParserForString(input);
+    parser(input, function(spec){
         handleSpec(spec, output, callback);
@@ -7,0 +9,0 @@ });

lib/markdownParser.js

@@ -5,5 +5,6 @@ var lineReader = require('line-reader');
     var output = {suite: [], last: false};
+    //TODO: Refactor these into modules to by DRY
     var lineTypes = {
         'SPEC' : {
-            tokens: ['*', '+'],
+            tokens: ['+'],
             match: function(line) {
@@ -39,2 +40,14 @@ for(var i = 0; i < this.tokens.length; i++) {
             }
+        },
+        'SKIP' : {
+            tokens: ['> skip'],
+            match: function(line) {
+                for(var i = 0; i < this.tokens.length; i++) {
+                    var regex = new RegExp('\\' + this.tokens[i] + '([^\n]*)');
+                    if(line.match(regex)) {
+                        return line.match(regex);
+                    }
+                }
+                return false;
+            }
         }
@@ -56,16 +69,28 @@ }
     function handleLine(line, callback) {
-        var type = getLineType(line);
-        var typeObject = lineTypes[type];
-        switch(type) {
-            case 'SPEC':
-                output.description = typeObject.strip(line);
+        if(!output.skip) {
+            var type = getLineType(line);
+            var typeObject = lineTypes[type];
+            switch(type) {
+                case 'SPEC':
+                    output.description = typeObject.strip(line);
+                    callback(output);
+                    return;
+                case 'DESCRIBE':
+                    //place the describe at the correct level
+                    output.suite[typeObject.level(line) -1] = typeObject.strip(line);
+                    //strip describes that are closed
+                    output.suite = output.suite.splice(0, typeObject.level(line));
+                    return;
+                case 'SKIP' :
+                    output.skip = true;
+                    output.last = true;
+            }
+            if(output.last) {
+                output.description = null;
+                output.last = true;
                 callback(output);
-                break;
-            case 'DESCRIBE':
-                //place the describe at the correct level
-                output.suite[typeObject.level(line) -1] = typeObject.strip(line);
-                //strip describes that are closed
-                output.suite = output.suite.splice(0, typeObject.level(line));
-                break;
+            }
+
         }
+
     }
@@ -79,5 +104,5 @@
                 }
-                
             }
         }
+        return null;
     }
@@ -84,0 +109,0 @@

package.json

 {
   "name": "spec-detective",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "A cool way to find out if your spec's in feature files and the like have met expectations.",
@@ -9,2 +9,5 @@ "main": "index.js",
   },
+  "bin": {
+    "detect": "./bin/spec-detective"
+  },
   "repository": {
@@ -11,0 +14,0 @@ "type": "git",

test/featureTransformerSpec.js

@@ -7,3 +7,3 @@ var featureTransformer = require('../lib/featureTransformer'),
 
-describe("Tranformation", function() {
+describe("Transformation", function() {
 
@@ -14,3 +14,3 @@ it("transforms a single IT", function(done) {
             "should do something" : "test/fixtures/spec/exampleSpec.feature:1"
-        }
+        };
         verifyOutput(inputFile, expectedOutput, done);
@@ -26,3 +26,3 @@
             }
-        }
+        };
         verifyOutput(inputFile, expectedOutput, done);
@@ -41,3 +41,3 @@
             }
-        }
+        };
         verifyOutput(inputFile, expectedOutput, done);
@@ -52,3 +52,3 @@ });
             }
-        }
+        };
         verifyOutput(inputFile, expectedOutput, done);
@@ -68,3 +68,3 @@ });
             }
-        }
+        };
         verifyOutput(inputFile, expectedOutput, done);
@@ -84,3 +84,3 @@ });
             }
-        }
+        };
         verifyOutput(inputFile, expectedOutput, done);
@@ -98,3 +98,3 @@ });
             'should NOT display the tab on fallback devices/browsers.' : "test/fixtures/spec/realSpec.feature:13"
-        }
+        };
 
@@ -104,2 +104,15 @@ verifyOutput(inputFile, expectedOutput, done);
 
+    describe("parsing markdown", function() {
+
+        it("can parse a markdown file", function(done) {
+            var inputFile = "test/fixtures/markdown/describe.md";
+            var expectedOutput = {
+                "a description" : {
+                    "should do something" : "test/fixtures/markdown/describe.md:2"
+                }
+            };
+            verifyOutput(inputFile, expectedOutput, done);
+        });
+    });
+
     function verifyOutput(inputFile, expectedOutput, done) {
@@ -106,0 +119,0 @@

test/fixtures/markdown/describe.md

 # a description
-* it should do something
++ it should do something

test/fixtures/markdown/describeReset.md

 # a describe
 ## another describe
-* a spec
++ a spec
 # reset describe
-* a second spec
++ a second spec

test/fixtures/markdown/exampleSpec.md

@@ -1,1 +0,1 @@
-* it should do something
++ it should do something

test/fixtures/markdown/full.md

 # a description
 ## another description
-* a spec
++ a spec
 ## a third description
 ### a fourth description
-* a second spec
++ a second spec

test/fixtures/markdown/skipStep.md

 # a description
 - a spec
+* ignore
 + a second spec

test/inspectorFullSpec.js

@@ -8,3 +8,3 @@ (function(require){
 
-    describe.only("Inspector full", function() {
+    describe("Inspector full", function() {
         it("should match top level specs", function() {
@@ -11,0 +11,0 @@ var expected = [

test/markdownParserSpec.js

@@ -67,3 +67,39 @@ var markdownParser = require('../lib/markdownParser'),
     });
+    //+ a spec
+    ///            -----> empty last line
+    it("handles files with extra returns", function(done) {
+        var inputFile = "test/fixtures/markdown/emptyLast.md";
+        var count = 0;
+        markdownParser(inputFile, function(spec) {
+            count++;
+            if(count == 2) {
+                assert.equal(spec.last, true);
+                assert.equal(spec.description, null);
+                done();
+            }
+        });
+    });
 
+    it("skips a file with a chevron on the first line", function(done) {
+        var inputFile = "test/fixtures/markdown/skipFile.md";
+        markdownParser(inputFile, function(spec) {
+            assert.equal(spec.last, true);
+            assert.equal(spec.skip, true);
+            assert.equal(spec.description, null);
+            done();
+        });
+    });
+
+    it("skips everything after a skip", function(done) {
+        var inputFile = "test/fixtures/markdown/skipPart.md";
+        var count = 0;
+        markdownParser(inputFile, function(spec) {
+            count++;
+            if(count >= 2) {
+                assert.equal(spec.skip, true);
+                done();
+            }
+        });
+    });
+
 });

No alert changes

Improved metrics

Total package byte prevSize

43792

increased by10.07%

Number of package files

47

increased by11.9%

Lines of code

1053

increased by10.84%

No dependency changes