Merge pull request #439 from ger-benjamin/427_support_parsers_constructor_options

427 support parser's constructor options

Author: jansule

README.md

@@ -27,7 +27,7 @@ geostyler-cli --output new-qgis-style.qml my-existing.sld
 ## Usage without installation ⚡
 
 `Node.js` includes [npx](https://docs.npmjs.com/cli/v10/commands/npx), this
-allows you to run commands from an npm package without having to install it.
+allows you to run commands from a npm package without having to install it.
 
 ```
 npx geostyler-cli -s sld -t qgis -o output.qml input.sld
@@ -106,16 +106,19 @@ geostyler-cli -t sld testdata/point_simple.qml
 * `-h` / `--help` Display the help and exit.
 * `-o` / `--output` Output filename or directory. Required when the source is a directory.
 For a file leave this empty to write to `stdout`. [string]
-* `-s` / `--source` Source parser, either `mapbox`, `mapfile` or `map`, 
-"sld" or "se" for SLD - the parser will read the version from the file,
-"qgis" or "qml" for QGIS QML files, and "ol-flat" for OpenLayers FlatStyles.
+* `-s` / `--source` Source parser, either `mapbox`, `mapfile`, `map`
+`sld` - the parser will read the version from the file -
+`qgis` or `qml` for QGIS QML files, and `ol-flat` for OpenLayers FlatStyles.
 If not given, it will be guessed from the extension of the input file.
-Mandatory if the the target is a directory.
-* `-t` / `--target` Target parser, either `mapbox`, `sld` (for SLD 1.0), `se` (for SLD 1.1),
-"qgis" or "qml" for QGIS QML files, or "ol-flat" for OpenLayers FlatStyles.
+Mandatory if the target is a directory.
+* `-t` / `--target` Target parser, either `mapbox`, `sld`,
+`qgis` or `qml` for QGIS QML files, or `ol-flat` for OpenLayers FlatStyles.
 If not given, it will be guessed from the extension of the output file.
 Mapfiles are not currently supported as target.
-Mandatory if the the target is a directory.
+Mandatory if the target is a directory.
+* `--sourceOptions` Options for the constructor of the source parser. This must
+be a comma-separated string like `--sourceOptions 'version:1.1.0,debug:true'`.
+* `--targetOptions` Same as sourceOptions, but for the target parser.
 * `-v` / `--version` Display the version of the program.
 * `--quiet` Suppress all interactive output.
 

src/index.ts

@@ -23,6 +23,7 @@ import {
   logVersion
 } from './logHelper.js';
 import path from 'path';
+import {getParserOptions} from './utils.js';
 
 const ensureTrailingSlash = (inputString: string): string => {
   if (!inputString) {
@@ -31,25 +32,23 @@ const ensureTrailingSlash = (inputString: string): string => {
   return inputString.at(- 1) === path.sep ? inputString : `${inputString}` + path.sep;
 };
 
-const getParserFromFormat = (inputString: string): StyleParser | undefined => {
+const getParserFromFormat = (inputString: string, parserOptions: Record<string, unknown>): StyleParser | undefined => {
   if (!inputString) {
     throw new Error('No input');
   }
   switch (inputString.toLowerCase()) {
     case 'lyrx':
       return new LyrxParser();
     case 'mapbox':
-      return new MapboxParser();
+      return new MapboxParser(parserOptions);
     case 'mapfile':
     case 'map':
-      return new MapfileParser();
+      return new MapfileParser(parserOptions);
     case 'sld':
-      return new SLDParser();
-    case 'se':
-      return new SLDParser({ sldVersion: '1.1.0' });
+      return new SLDParser(parserOptions);
     case 'qgis':
     case 'qml':
-      return new QGISParser();
+      return new QGISParser(parserOptions);
     case 'ol-flat':
       return new OlFlatStyleParser();
     case 'geostyler':
@@ -119,7 +118,7 @@ const computeTargetPath = (
   outputPath = path.normalize(outputPath);
 
   // Case file -> directory
-  // Get output name from source and add extension.
+  // Gets output name from source and add extension.
   const pathElements = sourcePathFile.split(path.sep);
   const lastElement = pathElements?.pop();
   pathElements.shift();
@@ -236,8 +235,10 @@ async function main() {
   const {
     s,
     source,
+    sourceOptions,
     t,
     target,
+    targetOptions,
     o,
     output,
     h,
@@ -270,20 +271,20 @@ async function main() {
     isSilent: !!quiet || false,
   }).start();
 
-  // Check source path arg.
+  // Check the source path arg.
   if (!sourcePath) {
     indicator.fail('No input file or folder specified.');
     process.exit(1);
   }
 
-  // Check source exists, is a dir or a file ?
+  // Check a source exists, is a dir or a file?
   if (sourcePath !== '-' && !existsSync(sourcePath)) {
     indicator.fail('Input file or folder does not exist.');
     process.exit(1);
   }
   const sourceIsFile = (sourcePath !== '-') && lstatSync(sourcePath).isFile();
 
-  // Try to define type of target (file or dir).
+  // Try to define the type of target (file or dir).
   // Assume the target is the same as the source
   let targetIsFile = sourceIsFile;
 
@@ -301,28 +302,30 @@ async function main() {
     indicator.info('No sourceparser was specified. Input will be parsed as a GeoStyler object.');
     sourceFormat = 'geostyler';
   }
-  const sourceParser = getParserFromFormat(sourceFormat);
+  const sourceParserOptions = getParserOptions(sourceOptions);
+  const sourceParser = getParserFromFormat(sourceFormat, sourceParserOptions);
 
-  // Get target parser.
+  // Get the target parser.
   if (!targetFormat && targetIsFile) {
     targetFormat = getFormatFromFilename(outputPath);
   }
   if (!targetFormat) {
     indicator.info('No targetparser was specified. Output will be a GeoStyler object.');
     targetFormat = 'geostyler';
   }
-  const targetParser = getParserFromFormat(targetFormat);
+  const targetParserOptions = getParserOptions(targetOptions);
+  const targetParser = getParserFromFormat(targetFormat, targetParserOptions);
 
-  // Get source(s) path(s).
+  // Get the source(s) path(s).
   const sourcePaths = collectPaths(sourcePath, sourceIsFile);
 
   const writePromises: Promise<number>[] = [];
   sourcePaths.forEach((srcPath) => {
     indicator.text = `Transforming ${srcPath} from ${sourceFormat} to ${targetFormat}`;
-    // Get correct output path
+    // Get a correct output path
     const outputPathFile = computeTargetPath(srcPath, outputPath, targetIsFile, targetFormat);
 
-    // Add the the translation promise.
+    // Add the translation promise.
     writePromises.push(writeFile(srcPath, sourceParser, outputPathFile, targetParser, indicator));
   });
 

src/logHelper.ts

@@ -12,7 +12,7 @@ export const logTitle = () => {
   `));
 };
 
-export const logHelp = () :void => {
+export const logHelp = (): void => {
   logTitle();
   console.log(`
   Basic syntax:
@@ -25,22 +25,25 @@ export const logHelp = () :void => {
     geostyler-cli -s sld -t qgis -o ./output-sld testdata/sld
     
   Options:
-    -h / --help   : Display this help and exit.
-    -o / --output : Output filename or directory. Required when the source is a directory.
-                    For a file leave this empty to write to stdout. [string]
-    -s / --source : Source parser, either "mapbox", "mapfile" or "map",
-                    "sld" or "se" for SLD - the parser will read the version from the file,
-                    "qgis" or "qml" for QGIS QML files, and "ol-flat" for OpenLayers FlatStyles.
-                    If not given, it will be guessed from the extension of the input file.
-                    Mandatory if the the target is a directory.
-    -t / --target : Target parser, either "mapbox", "sld" (for SLD 1.0), "se" (for SLD 1.1),
-                    "qgis" or "qml" for QGIS QML files, or "ol-flat" for OpenLayers FlatStyles.
-                    If not given, it will be guessed from the extension of the output file.
-                    Mapfiles are not currently supported as target.
-                    Mandatory if the the target is a directory.
-    --from-stdin  : Read input from stdin. If this option is set, the input file is ignored.
-    -v / --version: Display the version of the program.
-    --quiet       : Suppress all interactive output.
+    -h / --help    : Display this help and exit.
+    -o / --output  : Output filename or directory. Required when the source is a directory.
+                     For a file leave this empty to write to stdout. [string]
+    -s / --source  : Source parser, either "mapbox", "mapfile", "map",
+                     "sld" - the parser will read the version from the file -
+                     "qgis" or "qml" for QGIS QML files, and "ol-flat" for OpenLayers FlatStyles.
+                     If not given, it will be guessed from the extension of the input file.
+                     Mandatory if the the target is a directory.
+    -t / --target  : Target parser, either "mapbox", "sld",
+                     "qgis" or "qml" for QGIS QML files, or "ol-flat" for OpenLayers FlatStyles.
+                     If not given, it will be guessed from the extension of the output file.
+                     Mapfiles are not currently supported as target.
+                     Mandatory if the the target is a directory.
+    --sourceOptions: Options for the constructor of the source parser. This must
+                     be a comma-separated string like --sourceOptions 'version:1.1.0,debug:true'.
+    --targetOptions: Same as sourceOptions, but for the target parser.
+    --from-stdin   : Read input from stdin. If this option is set, the input file is ignored.
+    -v / --version : Display the version of the program.
+    --quiet        : Suppress all interactive output.
   `);
 };
 

src/utils.ts

@@ -0,0 +1,36 @@
+const parseOption = (value: string): boolean | number | string | undefined => {
+  const asNumber = Number(value);
+  if (!isNaN(asNumber)) {
+    return asNumber;
+  }
+  const isTrue = value.toLowerCase() === 'true';
+  if (isTrue) {
+    return true;
+  }
+  const isFalse = value.toLowerCase() === 'false';
+  if (isFalse) {
+    return false;
+  }
+  return value;
+};
+
+/**
+ * Parses the option string into a (flat) object and parse boolean (false/true) and numeric values.
+ * Expected input "key1:value1,key2:value2"
+ */
+export const getParserOptions = (optionsAsString: string): Record<string, unknown> => {
+  if (!optionsAsString) {
+    return {};
+  }
+  const options = optionsAsString.split(',');
+  const optionsObject: Record<string, unknown> = {};
+  options.forEach((option) => {
+    const splitOption = option.split(':');
+    if (splitOption.length === 2) {
+      const optionName = splitOption[0].trim();
+      const optionValue = splitOption[1].trim();
+      optionsObject[optionName] = parseOption(optionValue);
+    }
+  });
+  return optionsObject;
+};

test.js

@@ -1,5 +1,6 @@
 const fs = require('fs');
 const { spawnSync } = require('child_process');
+const { getParserOptions } = require('./build/src/utils.js');
 
 function checkFileCreated(outputFile) {
   try {
@@ -22,6 +23,40 @@ function runTest(args, outputFile) {
   return result;
 }
 
+function parseOptionsTest() {
+  const result = getParserOptions('version:1.2.0,debug:true,silent:false,num:1.1');
+  if (result.version !== '1.2.0') {
+    return false;
+  }
+  if (result.debug !== true) {
+    return false;
+  }
+  if (result.silent !== false) {
+    return false;
+  }
+  return result.num === 1.1;
+}
+
+function parseEmptyOptionsTest() {
+  const isEmptyObject = (obj) => {
+    return Object.keys(obj).length === 0 && obj.constructor === Object;
+  };
+  let result = getParserOptions(undefined);
+  if (!isEmptyObject(result)) {
+    return false;
+  }
+  result = getParserOptions(null);
+  if (!isEmptyObject(result)) {
+    return false;
+  }
+  result = getParserOptions('');
+  if (!isEmptyObject(result)) {
+    return false;
+  }
+  result = getParserOptions('true');
+  return isEmptyObject(result);
+}
+
 function runAllTests() {
 
   let success = true;
@@ -117,6 +152,14 @@ function runAllTests() {
     success = false;
   }
 
+  // Test the parseOptions functions.
+  if (!parseOptionsTest() || !parseEmptyOptionsTest()) {
+    console.log('Parser options tests failed');
+    success = false;
+  } else {
+    console.log('Parser options tests ok');
+  }
+
   return success;
 }