gherkin/parse.js

/**
 * Copyright (c) 2015 Christopher M. Baker
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 */

const R_NEWLINE = /\r?\n/g;
const R_FEATURE = /^\s*Feature:(.*)$/;
const R_AS = /^\s*As (.*)$/;
const R_I_WANT = /^\s*I want (.*)$/;
const R_SO_THAT = /^\s*So that (.*)$/;
const R_IN_ORDER = /^\s*In order (.*)$/;
const R_SCENARIO = /^\s*Scenario:(.*)$/;
const R_GIVEN = /^\s*Given (.*)$/;
const R_WHEN = /^\s*When(.*)$/;
const R_THEN = /^\s*Then (.*)$/;
const R_AND = /^\s*And (.*)$/;
const R_BUT = /^\s*But (.*)$/;
const R_TAG = /^\s*\@(.*)$/;


function extract(line, regex, index) {
  return line.match(regex)[index].trim();
}

export const parse = (text) => {
  let feature;
  let scenario;
  let previous;
  const features = [];
  const lines = (text || '').toString().split(R_NEWLINE);
  const tags = [

  ];

  lines.forEach((line, lineCount) => {
    if (R_FEATURE.test(line)) {
      feature = {
        feature: extract(line, R_FEATURE, 1),
        scenarios: []
      };

      features.push(feature);
    }
    else if (R_AS.test(line)) {
      feature.perspective = extract(line, R_AS, 1);
    }
    else if (R_I_WANT.test(line)) {
      feature.desire = extract(line, R_I_WANT, 1);
    }
    else if (R_SO_THAT.test(line)) {
      feature.reason = extract(line, R_SO_THAT, 1);
    }
    else if (R_IN_ORDER.test(line)) {
      feature.reason = extract(line, R_IN_ORDER, 1);
    }
    else if (R_SCENARIO.test(line)) {
      scenario = {
        scenario: extract(line, R_SCENARIO, 1),
        given: [],
        when: [],
        then: []
      };

      feature.scenarios.push(scenario);
    }
    else if (R_TAG.test(line)) {
      const extracted = extract(line, R_TAG, 1);     
      tags.push({extracted, line: lineCount });
    }
    else if (R_GIVEN.test(line)) {
      previous = scenario.given;
      scenario.given.push(extract(line, R_GIVEN, 1));
    }
    else if (R_WHEN.test(line)) {
      previous = scenario.when;
      scenario.when.push(extract(line, R_WHEN, 1));
    }
    else if (R_THEN.test(line)) {
      previous = scenario.then;
      scenario.then.push(extract(line, R_THEN, 1));
    }
    else if (R_AND.test(line)) {
      previous.push(extract(line, R_AND, 1));
    }
    else if (R_BUT.test(line)) {
      previous.push(extract(line, R_BUT, 1));
    }    
    else if (line.trim().length > 0) {
      throw new SyntaxError(line.trim());
    }
  });

  return features;
};