Add parseFileSync and parseStringSync

Author: cheton

README.md

@@ -22,6 +22,9 @@ parser.parseFile(file, function(err, results) {
  console.log(results);
 });
 
+// Synchronous version of parseFile.
+results = parser.parseFileSync(file);
+
 // Parse from stream
 var stream = fs.createReadStream(file, { encoding: 'utf8' });
 parser.parseStream(stream, function(err, results) {
@@ -33,6 +36,9 @@ var str = fs.readFileSync(file, 'utf8');
 parser.parseString(str, function(err, results) {
  console.log(results);
 });
+
+// Synchronous version of parseString.
+results = parser.parseStringSync(file);
 ```
 
 ## Advanced Usage

src/index.js

@@ -168,6 +168,10 @@ const parseFile = (file, options, callback = noop) => {
  return parseStream(s, options, callback);
 };
 
+const parseFileSync = (file, options) => {
+ return parseStringSync(fs.readFileSync(file, 'utf8'), options);
+};
+
 // @param {string} str The G-code text string
 // @param {options} options The options object
 // @param {function} callback The callback function
@@ -179,6 +183,27 @@ const parseString = (str, options, callback = noop) => {
  return parseStream(streamify(str), options, callback);
 };
 
+const parseStringSync = (str, options) => {
+ const { noParseLine = false } = { ...options };
+ const results = [];
+ const lines = str.split('\n');
+
+ for (let i = 0; i < lines.length; ++i) {
+ const line = lines[i].trim();
+ if (line.length === 0) {
+ continue;
+ }
+ const result = parseLine(line, { noParseLine });
+ results.push(result);
+ }
+
+ return results;
+};
+
+// @param {string} str The G-code text string
+// @param {options} options The options object
+
+
 class GCodeLineStream extends Transform {
  state = {
  lineCount: 0,
@@ -275,5 +300,7 @@ export {
  parseLine,
  parseStream,
  parseFile,
- parseString
+ parseFileSync,
+ parseString,
+ parseStringSync
 };

test/index.js

@@ -1,11 +1,18 @@
 import chai from 'chai';
 import fs from 'fs';
-import { GCodeParser, parseFile, parseString, parseStream } from '../lib';
+import {
+ GCodeParser,
+ parseStream,
+ parseString,
+ parseStringSync,
+ parseFile,
+ parseFileSync
+} from '../lib';
 
 const expect = chai.expect;
 const should = chai.should();
 
-describe('G-code Parser', () => {
+describe('gcode-parser', () => {
  describe('Pass a null value as the first argument', () => {
  it('should call parseString\'s callback.', (done) => {
  parseString(null, (err, results) => {
@@ -138,7 +145,7 @@ describe('G-code Parser', () => {
  });
  });
 
- describe('parseFile / parseStream / parseString', () => {
+ describe('parseStream()', () => {
  const expectedResults = [
  {
  line: 'G0 X-5 Y0 Z0 F200',
@@ -170,30 +177,175 @@ describe('G-code Parser', () => {
  }
  ];
 
- it('should get the expected results in the parseFile\'s callback.', (done) => {
- parseFile('test/fixtures/circle.gcode', (err, results) => {
+ it('should get expected results in the callback.', (done) => {
+ const stream = fs.createReadStream('test/fixtures/circle.gcode', { encoding: 'utf8' });
+ parseStream(stream, (err, results) => {
  expect(results).to.deep.equal(expectedResults);
  done();
  });
  });
+ });
 
- it('should get the expected results in the parseStream\'s callback.', (done) => {
- const stream = fs.createReadStream('test/fixtures/circle.gcode', { encoding: 'utf8' });
- parseStream(stream, (err, results) => {
+ describe('parseString()', () => {
+ const expectedResults = [
+ {
+ line: 'G0 X-5 Y0 Z0 F200',
+ words: [['G', 0], ['X', -5], ['Y', 0], ['Z', 0], ['F', 200]]
+ },
+ {
+ line: 'G2 X0 Y5 I5 J0 F200',
+ words: [['G', 2], ['X', 0], ['Y', 5], ['I', 5], ['J', 0], ['F', 200]]
+ },
+ {
+ line: 'G02 X5 Y0 I0 J-5',
+ words: [['G', 2], ['X', 5], ['Y', 0], ['I', 0], ['J', -5]]
+ },
+ {
+ line: 'G02 X0 Y-5 I-5 J0',
+ words: [['G', 2], ['X', 0], ['Y',-5], ['I', -5], ['J', 0]]
+ },
+ {
+ line: 'G02 X-5 Y0 I0 J5',
+ words: [['G', 2], ['X', -5], ['Y', 0], ['I', 0], ['J', 5]]
+ },
+ {
+ line: 'G01 Z1 F500',
+ words: [['G', 1], ['Z', 1], ['F', 500]]
+ },
+ {
+ line: 'G00 X0 Y0 Z5',
+ words: [['G', 0], ['X', 0], ['Y', 0], ['Z', 5]]
+ }
+ ];
+
+ it('should get expected results in the callback.', (done) => {
+ const str = fs.readFileSync('test/fixtures/circle.gcode', 'utf8');
+ parseString(str, (err, results) => {
  expect(results).to.deep.equal(expectedResults);
  done();
  });
  });
+ });
+
+ describe('parseStringSync()', () => {
+ const expectedResults = [
+ {
+ line: 'G0 X-5 Y0 Z0 F200',
+ words: [['G', 0], ['X', -5], ['Y', 0], ['Z', 0], ['F', 200]]
+ },
+ {
+ line: 'G2 X0 Y5 I5 J0 F200',
+ words: [['G', 2], ['X', 0], ['Y', 5], ['I', 5], ['J', 0], ['F', 200]]
+ },
+ {
+ line: 'G02 X5 Y0 I0 J-5',
+ words: [['G', 2], ['X', 5], ['Y', 0], ['I', 0], ['J', -5]]
+ },
+ {
+ line: 'G02 X0 Y-5 I-5 J0',
+ words: [['G', 2], ['X', 0], ['Y',-5], ['I', -5], ['J', 0]]
+ },
+ {
+ line: 'G02 X-5 Y0 I0 J5',
+ words: [['G', 2], ['X', -5], ['Y', 0], ['I', 0], ['J', 5]]
+ },
+ {
+ line: 'G01 Z1 F500',
+ words: [['G', 1], ['Z', 1], ['F', 500]]
+ },
+ {
+ line: 'G00 X0 Y0 Z5',
+ words: [['G', 0], ['X', 0], ['Y', 0], ['Z', 5]]
+ }
+ ];
 
- it('should get the expected results in the parseString\'s callback.', (done) => {
+ it('should return expected results.', (done) => {
  const str = fs.readFileSync('test/fixtures/circle.gcode', 'utf8');
- parseString(str, (err, results) => {
+ const results = parseStringSync(str);
+ expect(results).to.deep.equal(expectedResults);
+ done();
+ });
+ });
+
+ describe('parseFile()', () => {
+ const expectedResults = [
+ {
+ line: 'G0 X-5 Y0 Z0 F200',
+ words: [['G', 0], ['X', -5], ['Y', 0], ['Z', 0], ['F', 200]]
+ },
+ {
+ line: 'G2 X0 Y5 I5 J0 F200',
+ words: [['G', 2], ['X', 0], ['Y', 5], ['I', 5], ['J', 0], ['F', 200]]
+ },
+ {
+ line: 'G02 X5 Y0 I0 J-5',
+ words: [['G', 2], ['X', 5], ['Y', 0], ['I', 0], ['J', -5]]
+ },
+ {
+ line: 'G02 X0 Y-5 I-5 J0',
+ words: [['G', 2], ['X', 0], ['Y',-5], ['I', -5], ['J', 0]]
+ },
+ {
+ line: 'G02 X-5 Y0 I0 J5',
+ words: [['G', 2], ['X', -5], ['Y', 0], ['I', 0], ['J', 5]]
+ },
+ {
+ line: 'G01 Z1 F500',
+ words: [['G', 1], ['Z', 1], ['F', 500]]
+ },
+ {
+ line: 'G00 X0 Y0 Z5',
+ words: [['G', 0], ['X', 0], ['Y', 0], ['Z', 5]]
+ }
+ ];
+
+ it('should get expected results in the callback.', (done) => {
+ parseFile('test/fixtures/circle.gcode', (err, results) => {
  expect(results).to.deep.equal(expectedResults);
  done();
  });
  });
  });
 
+ describe('parseFileSync()', () => {
+ const expectedResults = [
+ {
+ line: 'G0 X-5 Y0 Z0 F200',
+ words: [['G', 0], ['X', -5], ['Y', 0], ['Z', 0], ['F', 200]]
+ },
+ {
+ line: 'G2 X0 Y5 I5 J0 F200',
+ words: [['G', 2], ['X', 0], ['Y', 5], ['I', 5], ['J', 0], ['F', 200]]
+ },
+ {
+ line: 'G02 X5 Y0 I0 J-5',
+ words: [['G', 2], ['X', 5], ['Y', 0], ['I', 0], ['J', -5]]
+ },
+ {
+ line: 'G02 X0 Y-5 I-5 J0',
+ words: [['G', 2], ['X', 0], ['Y',-5], ['I', -5], ['J', 0]]
+ },
+ {
+ line: 'G02 X-5 Y0 I0 J5',
+ words: [['G', 2], ['X', -5], ['Y', 0], ['I', 0], ['J', 5]]
+ },
+ {
+ line: 'G01 Z1 F500',
+ words: [['G', 1], ['Z', 1], ['F', 500]]
+ },
+ {
+ line: 'G00 X0 Y0 Z5',
+ words: [['G', 0], ['X', 0], ['Y', 0], ['Z', 5]]
+ }
+ ];
+
+ it('should return expected results.', (done) => {
+ const results = parseFileSync('test/fixtures/circle.gcode');
+ expect(results).to.deep.equal(expectedResults);
+ done();
+ });
+ });
+
  describe('More examples', () => {
  it('should contain the line number.', (done) => {
  parseFile('test/fixtures/circle-inch.gcode', (err, list) => {