Closes #43

thiagodp · Jun 18, 2019 · 616355b · 616355b
1 parent eb84c6a
commit 616355b
Show file tree

Hide file tree

Showing 94 changed files with 762 additions and 324 deletions.
diff --git a/__tests__/lexer/TagLexerTest.spec.ts b/__tests__/lexer/TagLexerTest.spec.ts
@@ -1,5 +1,6 @@
-import { TagLexer } from "../../modules/lexer/TagLexer";
+import { TagLexer, TagSubLexer } from "../../modules/lexer/TagLexer";
 import { NodeTypes } from "../../modules/req/NodeTypes";
+import { ReservedTags } from "concordialang-types/dist";
 
 /**
  * @author Thiago Delgado Pinto
@@ -36,7 +37,7 @@ describe( 'TagLexerTest', () => {
         let names = lexer.analyze( line ).nodes.map( ( node ) => node.name );
         expect( names ).toEqual( [ "hello", "world" ] );
     } );
-    
+
     it( 'detects a tag with content', () => {
         let line = '@hello( world )';
         let r = lexer.analyze( line );
@@ -100,7 +101,23 @@ describe( 'TagLexerTest', () => {
         expect( nodeOne.content ).toEqual( [ 'bar' ] );
         let nodeTwo = r.nodes[ 1 ];
         expect( nodeTwo.name ).toEqual( 'a' );
-        expect( nodeTwo.content ).toEqual( [ 'b', 'c' ] );        
+        expect( nodeTwo.content ).toEqual( [ 'b', 'c' ] );
+    } );
+
+
+
+    it( 'detects subtypes', () => {
+
+        const l = new TagLexer( [
+            new TagSubLexer( ReservedTags.IGNORE, [ ReservedTags.IGNORE ] )
+        ] );
+
+        const r = l.analyze( '@ignore' );
+        expect( r ).toBeDefined();
+        expect( r.errors ).toHaveLength( 0 );
+        expect( r.nodes ).toHaveLength( 1 );
+
+        expect( r.nodes[ 0 ].subType ).toEqual( ReservedTags.IGNORE );
     } );
 
 } );
diff --git a/__tests__/semantic/TestCaseSSATest.spec.ts b/__tests__/semantic/TestCaseSSATest.spec.ts
@@ -1,7 +1,6 @@
 import { join } from 'path';
-import { FileInfo, Import, Location, Feature, Document, TestCase, Tag } from 'concordialang-types';
+import { FileInfo, Import, Location, Feature, Document, TestCase, Tag, ReservedTags } from 'concordialang-types';
 import { NodeTypes } from '../../modules/req/NodeTypes';
-import { ReservedTags } from '../../modules/req/ReservedTags';
 import { AugmentedSpec } from '../../modules/ast/AugmentedSpec';
 import { TestCaseSSA } from '../../modules/semantic/TestCaseSSA';
 

diff --git a/__tests__/testcase/TCGenTest.spec.ts b/__tests__/testcase/TCGenTest.spec.ts
@@ -103,7 +103,7 @@ describe( 'TCGenTest', () => {
             ]
         );
 
-        expect( tc.shoudFail ).toBeFalsy();
+        expect( tc.shouldFail ).toBeFalsy();
 
     } );
 
@@ -168,7 +168,7 @@ describe( 'TCGenTest', () => {
             ]
         );
 
-        expect( tc.shoudFail ).toBeTruthy();
+        expect( tc.shouldFail ).toBeTruthy();
 
         // ---
 

diff --git a/data/pt.json b/data/pt.json
@@ -31,6 +31,8 @@
         "tagImportance": [ "importance" ],
         "tagIgnore": [ "ignore" ],
         "tagGenerated": [ "generated" ],
+        "tagFail": [ "fail" ],
+        "tagGenerateOnlyValidValues": [ "generate-only-valid-values" ],
 
         "language": [ "language" ],
 

diff --git a/dist/data/pt.json b/dist/data/pt.json
@@ -31,6 +31,8 @@
         "tagImportance": [ "importance" ],
         "tagIgnore": [ "ignore" ],
         "tagGenerated": [ "generated" ],
+        "tagFail": [ "fail" ],
+        "tagGenerateOnlyValidValues": [ "generate-only-valid-values" ],
 
         "language": [ "language" ],
 

diff --git a/dist/modules/app/TCGenController.js b/dist/modules/app/TCGenController.js
@@ -8,6 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const concordialang_types_1 = require("concordialang-types");
 const PreTestCaseGenerator_1 = require("../testscenario/PreTestCaseGenerator");
 const TSGen_1 = require("../testscenario/TSGen");
 const VariantSelectionStrategy_1 = require("../selection/VariantSelectionStrategy");
@@ -20,7 +21,6 @@ const util_1 = require("util");
 const RuntimeException_1 = require("../req/RuntimeException");
 const fs_1 = require("fs");
 const Defaults_1 = require("./Defaults");
-const ReservedTags_1 = require("../req/ReservedTags");
 const Warning_1 = require("../req/Warning");
 const DataTestCaseMix_1 = require("../testcase/DataTestCaseMix");
 class TCGenController {
@@ -154,7 +154,7 @@ class TCGenController {
             case Defaults_1.VariantSelectionOptions.FIRST:
                 return new VariantSelectionStrategy_1.FirstVariantSelectionStrategy();
             case Defaults_1.VariantSelectionOptions.FIRST_MOST_IMPORTANT:
-                return new VariantSelectionStrategy_1.FirstMostImportantVariantSelectionStrategy(options.importance, [ReservedTags_1.ReservedTags.IMPORTANCE]);
+                return new VariantSelectionStrategy_1.FirstMostImportantVariantSelectionStrategy(options.importance, [concordialang_types_1.ReservedTags.IMPORTANCE]);
             case Defaults_1.VariantSelectionOptions.ALL:
                 return new VariantSelectionStrategy_1.AllVariantsSelectionStrategy();
             default: {

diff --git a/dist/modules/dict/EnglishKeywordDictionary.js b/dist/modules/dict/EnglishKeywordDictionary.js
@@ -38,6 +38,8 @@ class EnglishKeywordDictionary {
         this.tagImportance = ['importance'];
         this.tagIgnore = ['ignore'];
         this.tagGenerated = ['generated'];
+        this.tagFail = ['fail'];
+        this.tagGenerateOnlyValidValues = ['generate-only-valid-values'];
         // Also available in Gherkin
         this.language = ['language'];
         this.feature = ['feature', 'story', 'user story'];

diff --git a/dist/modules/lexer/Lexer.js b/dist/modules/lexer/Lexer.js
@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const concordialang_types_1 = require("concordialang-types");
 const VariantLexer_1 = require("./VariantLexer");
 const TestEventLexer_1 = require("../lexer/TestEventLexer");
 const DatabasePropertyLexer_1 = require("./DatabasePropertyLexer");
@@ -52,16 +53,28 @@ class Lexer {
         this._lexers = [];
         this._lexersMap = new Map(); // iterable in insertion order
         this._lastLexer = null;
+        this._subLexers = [];
         this._inLongString = false;
         this._mustRecognizeAsText = false;
         const dictionary = this.loadDictionary(_defaultLanguage); // may throw Error
         if (!dictionary) {
             throw new Error('Cannot load a dictionary for the language: ' + _defaultLanguage);
         }
+        this._subLexers = [
+            new TagLexer_1.TagSubLexer(concordialang_types_1.ReservedTags.IGNORE, dictionary.tagIgnore),
+            new TagLexer_1.TagSubLexer(concordialang_types_1.ReservedTags.GENERATED, dictionary.tagGenerated),
+            new TagLexer_1.TagSubLexer(concordialang_types_1.ReservedTags.FAIL, dictionary.tagFail),
+            new TagLexer_1.TagSubLexer(concordialang_types_1.ReservedTags.SCENARIO, dictionary.tagScenario),
+            new TagLexer_1.TagSubLexer(concordialang_types_1.ReservedTags.VARIANT, dictionary.tagVariant),
+            new TagLexer_1.TagSubLexer(concordialang_types_1.ReservedTags.FEATURE, dictionary.tagFeature),
+            new TagLexer_1.TagSubLexer(concordialang_types_1.ReservedTags.GENERATE_ONLY_VALID_VALUES, dictionary.tagGenerateOnlyValidValues),
+            new TagLexer_1.TagSubLexer(concordialang_types_1.ReservedTags.IMPORTANCE, dictionary.tagImportance),
+            new TagLexer_1.TagSubLexer(concordialang_types_1.ReservedTags.GLOBAL, dictionary.tagGlobal)
+        ];
         this._lexers = [
             new LongStringLexer_1.LongStringLexer(),
             new LanguageLexer_1.LanguageLexer(dictionary.language),
-            new TagLexer_1.TagLexer(),
+            new TagLexer_1.TagLexer(this._subLexers),
             new ImportLexer_1.ImportLexer(dictionary.import),
             new FeatureLexer_1.FeatureLexer(dictionary.feature),
             new BackgroundLexer_1.BackgroundLexer(dictionary.background),
@@ -160,7 +173,6 @@ class Lexer {
             return false;
         }
         let result;
-        let node;
         // Analyze with lexers of the suggested node types
         if (this._lastLexer !== null) {
             const suggestedNodeTypes = this._lastLexer.suggestedNextNodeTypes();
@@ -251,13 +263,12 @@ class Lexer {
             || {};
         for (let lexer of this._lexers) {
             if (this.isAWordBasedLexer(lexer)) {
-                let nodeType = lexer.affectedKeyword();
-                let words = dict[nodeType];
-                if (words) {
-                    lexer.updateWords(words);
-                }
+                this.updateKeywordBasedLexer(lexer, dict);
             }
         }
+        for (let subLexer of this._subLexers) {
+            this.updateKeywordBasedLexer(subLexer, dict);
+        }
         return dict;
     }
     /**
@@ -273,5 +284,12 @@ class Lexer {
     isAWordBasedLexer(obj) {
         return obj.updateWords !== undefined;
     }
+    updateKeywordBasedLexer(kbl, dict) {
+        const nodeType = kbl.affectedKeyword();
+        const words = dict[nodeType];
+        if (words) {
+            kbl.updateWords(words);
+        }
+    }
 }
 exports.Lexer = Lexer;
diff --git a/dist/modules/lexer/TagLexer.js b/dist/modules/lexer/TagLexer.js
@@ -11,13 +11,23 @@ const XRegExp = require('xregexp');
  * @author Thiago Delgado Pinto
  */
 class TagLexer {
+    constructor(_subLexers = []) {
+        this._subLexers = _subLexers;
+    }
     /** @inheritDoc */
     nodeType() {
         return NodeTypes_1.NodeTypes.TAG;
     }
     /** @inheritDoc */
     suggestedNextNodeTypes() {
-        return [NodeTypes_1.NodeTypes.TAG, NodeTypes_1.NodeTypes.VARIANT, NodeTypes_1.NodeTypes.FEATURE, NodeTypes_1.NodeTypes.SCENARIO];
+        return [
+            NodeTypes_1.NodeTypes.TAG,
+            NodeTypes_1.NodeTypes.VARIANT,
+            NodeTypes_1.NodeTypes.FEATURE,
+            NodeTypes_1.NodeTypes.SCENARIO,
+            NodeTypes_1.NodeTypes.UI_ELEMENT,
+            NodeTypes_1.NodeTypes.UI_PROPERTY
+        ];
     }
     /** @inheritDoc */
     analyze(line, lineNumber) {
@@ -67,9 +77,44 @@ class TagLexer {
                 name: result[1],
                 content: content
             };
+            // Try to decide what subtype the tag has.
+            // An undefined subtype is valid and it means that the tag is not a reserved tag.
+            for (let subLexer of this._subLexers) {
+                if (subLexer.containsName(node.name)) {
+                    node.subType = subLexer.affectedKeyword();
+                }
+            }
             nodes.push(node);
         }
         return { nodes: nodes, errors: errors };
     }
 }
 exports.TagLexer = TagLexer;
+/**
+ * Allows to compare a tag name against a set of words in order to detect its subtype.
+ *
+ * @author Thiago Delgado Pinto
+ */
+class TagSubLexer {
+    constructor(_affectedKeyword, _words) {
+        this._affectedKeyword = _affectedKeyword;
+        this._words = _words;
+    }
+    /** @inheritDoc */
+    affectedKeyword() {
+        return this._affectedKeyword;
+    }
+    /** @inheritDoc */
+    updateWords(words) {
+        this._words = words.map(w => w.toLowerCase());
+    }
+    /**
+     * Compares if the tag's name is in the set of words.
+     *
+     * @param name Name to compare
+     */
+    containsName(name) {
+        return this._words.indexOf(name.toLowerCase()) >= 0;
+    }
+}
+exports.TagSubLexer = TagSubLexer;
diff --git a/dist/modules/parser/AfterAllParser.js b/dist/modules/parser/AfterAllParser.js
@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const SyntaticException_1 = require("../req/SyntaticException");
+const SyntacticException_1 = require("../req/SyntacticException");
 const TypeChecking_1 = require("../util/TypeChecking");
 /**
  * AfterAll parser
@@ -12,7 +12,7 @@ class AfterAllParser {
     analyze(node, context, it, errors) {
         // Check whether a similar node was already declared
         if (TypeChecking_1.isDefined(context.doc.afterAll)) {
-            let e = new SyntaticException_1.SyntaticException('Event already declared: After All', node.location);
+            let e = new SyntacticException_1.SyntacticException('Event already declared: After All', node.location);
             errors.push(e);
             return false;
         }

diff --git a/dist/modules/parser/AfterEachScenarioParser.js b/dist/modules/parser/AfterEachScenarioParser.js
@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const SyntaticException_1 = require("../req/SyntaticException");
+const SyntacticException_1 = require("../req/SyntacticException");
 const TypeChecking_1 = require("../util/TypeChecking");
 /**
  * AfterEachScenario parser
@@ -12,13 +12,13 @@ class AfterEachScenarioParser {
     analyze(node, context, it, errors) {
         // Check whether a Feature was declared
         if (!context.doc.feature) {
-            let e = new SyntaticException_1.SyntaticException('The event After Each Scenario must be declared after a Feature', node.location);
+            let e = new SyntacticException_1.SyntacticException('The event After Each Scenario must be declared after a Feature', node.location);
             errors.push(e);
             return false;
         }
         // Check whether a similar node was already declared
         if (TypeChecking_1.isDefined(context.doc.afterEachScenario)) {
-            let e = new SyntaticException_1.SyntaticException('Event already declared: After Each Scenario', node.location);
+            let e = new SyntacticException_1.SyntacticException('Event already declared: After Each Scenario', node.location);
             errors.push(e);
             return false;
         }

diff --git a/dist/modules/parser/AfterFeatureParser.js b/dist/modules/parser/AfterFeatureParser.js
@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const SyntaticException_1 = require("../req/SyntaticException");
+const SyntacticException_1 = require("../req/SyntacticException");
 const TypeChecking_1 = require("../util/TypeChecking");
 /**
  * AfterFeature parser
@@ -12,13 +12,13 @@ class AfterFeatureParser {
     analyze(node, context, it, errors) {
         // Check whether a Feature was declared
         if (!context.doc.feature) {
-            let e = new SyntaticException_1.SyntaticException('The event After Feature must be declared after a Feature', node.location);
+            let e = new SyntacticException_1.SyntacticException('The event After Feature must be declared after a Feature', node.location);
             errors.push(e);
             return false;
         }
         // Check whether a similar node was already declared
         if (TypeChecking_1.isDefined(context.doc.afterFeature)) {
-            let e = new SyntaticException_1.SyntaticException('Event already declared: After Feature', node.location);
+            let e = new SyntacticException_1.SyntacticException('Event already declared: After Feature', node.location);
             errors.push(e);
             return false;
         }

diff --git a/dist/modules/parser/BackgroundParser.js b/dist/modules/parser/BackgroundParser.js
@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const SyntaticException_1 = require("../req/SyntaticException");
+const SyntacticException_1 = require("../req/SyntacticException");
 const TypeChecking_1 = require("../util/TypeChecking");
 /**
  * Background parser
@@ -12,18 +12,18 @@ class BackgroundParser {
     analyze(node, context, it, errors) {
         // Checks if a feature has been declared before it
         if (!context.doc.feature) {
-            let e = new SyntaticException_1.SyntaticException('A background must be declared after a feature.', node.location);
+            let e = new SyntacticException_1.SyntacticException('A background must be declared after a feature.', node.location);
             errors.push(e);
             return false;
         }
         let feature = context.doc.feature;
         if (feature.background) {
-            let e = new SyntaticException_1.SyntaticException('A feature cannot have more than one background.', node.location);
+            let e = new SyntacticException_1.SyntacticException('A feature cannot have more than one background.', node.location);
             errors.push(e);
             return false;
         }
         if (TypeChecking_1.isDefined(feature.scenarios) && feature.scenarios.length > 0) {
-            let e = new SyntaticException_1.SyntaticException('A background must be declared before a scenario.', node.location);
+            let e = new SyntacticException_1.SyntacticException('A background must be declared before a scenario.', node.location);
             errors.push(e);
             return false;
         }

diff --git a/dist/modules/parser/BeforeAllParser.js b/dist/modules/parser/BeforeAllParser.js
@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const SyntaticException_1 = require("../req/SyntaticException");
+const SyntacticException_1 = require("../req/SyntacticException");
 const TypeChecking_1 = require("../util/TypeChecking");
 /**
  * BeforeAll parser
@@ -12,7 +12,7 @@ class BeforeAllParser {
     analyze(node, context, it, errors) {
         // Check whether a similar node was already declared
         if (TypeChecking_1.isDefined(context.doc.beforeAll)) {
-            let e = new SyntaticException_1.SyntaticException('Event already declared: Before All', node.location);
+            let e = new SyntacticException_1.SyntacticException('Event already declared: Before All', node.location);
             errors.push(e);
             return false;
         }