Migrate YAML-based Regex Rules to CommonJS Modules

index.js

@@ -54,9 +54,6 @@ const aliasDevice = new AliasDevice();
 aliasDevice.setReplaceBrand(false);
 const infoDevice = new InfoDevice();
 
-IndexerDevice.init();
-IndexerClient.init();
-
 class DeviceDetector {
 
   vendorParserList = {};

parser/abstract-parser.js

@@ -1,5 +1,4 @@
 const helper = require('./helper');
-const BASE_REGEXES_DIR = __dirname + '/../regexes/';
 
 /**
  * @param {string} result
@@ -20,45 +19,14 @@ function fixStringVersion(result) {
   return result.trim();
 }
 
-const collectionMap = {};
-
 class ParserAbstract {
   constructor() {
-    this.fixtureFile = null;
+    this.collection = null;
     this.type = null;
     this.versionTruncation = null;
     this.maxUserAgentSize = null;
   }
 
-  get collection() {
-    if (!this.hasLoadCollection()) {
-      return null;
-    }
-    return collectionMap[this.fixtureFile];
-  }
-
-  hasLoadCollection() {
-    return collectionMap[this.fixtureFile] !== void 0
-  }
-
-  /**
-   * load collection
-   */
-  loadCollection() {
-    if (!this.hasLoadCollection()) {
-      collectionMap[this.fixtureFile] = this.loadYMLFile(this.fixtureFile);
-    }
-  }
-
-  /**
-   * load yaml file
-   * @param {string} file
-   * @returns {*}
-   */
-  loadYMLFile(file) {
-    return helper.loadYMLFile(BASE_REGEXES_DIR + file);
-  }
-
   /**
    * A special method that overwrites placeholders in a string
    * @param {string} item

parser/bot-abstract-parser.js

@@ -3,8 +3,7 @@ const ParserAbstract = require('./abstract-parser');
 class BotAbstractParser extends ParserAbstract {
   constructor() {
     super();
-    this.fixtureFile = 'bots.yml';
-    this.loadCollection();
+    this.collection = require('../regexes/bots');
   }
 
   /**

parser/client/browser.js

@@ -35,9 +35,8 @@ const compareBrandForClientHints = (brand) => {
 class Browser extends ClientAbstractParser {
   constructor() {
     super();
-    this.engine_collection = [];
-    this.fixtureFile = 'client/browsers.yml';
-    this.loadCollection();
+    this.engine_collection = require('../../regexes/client/browser_engine');
+    this.collection = require('../../regexes/client/browsers');
     this.type = CLIENT_TYPE.BROWSER;
     this.collectionLength = this.collection.length;
   }
@@ -50,11 +49,6 @@ class Browser extends ClientAbstractParser {
     return Object.keys(this.getCollectionBrowsers());
   }
 
-  loadCollection() {
-    super.loadCollection();
-    this.engine_collection = this.loadYMLFile('client/browser_engine.yml');
-  }
-
   /**
    * Generates the result for the parse method
    *

parser/client/feed-reader.js

@@ -5,8 +5,7 @@ const CLIENT_TYPE = require('./../const/client-type');
 class FeedReader extends ClientAbstractParser {
   constructor() {
     super();
-    this.fixtureFile = 'client/feed_readers.yml';
-    this.loadCollection();
+    this.collection = require('../../regexes/client/feed_readers');
     this.collectionLength = this.collection.length;
     this.type = CLIENT_TYPE.FEED_READER;
   }

parser/client/hints/app-hints.js

@@ -4,8 +4,7 @@ class AppHints extends AbstractParser
 {
   constructor() {
     super();
-    this.fixtureFile = 'client/hints/apps.yml';
-    this.loadCollection();
+    this.collection = require('../../../regexes/client/hints/apps');
   }
 
   parse(clientHints) {

parser/client/hints/browser-hints.js

@@ -4,8 +4,7 @@ class BrowserHints extends AbstractParser
 {
   constructor() {
     super();
-    this.fixtureFile = 'client/hints/browsers.yml';
-    this.loadCollection();
+    this.collection = require('../../../regexes/client/hints/browsers');
   }
 
   parse(clientHints) {

parser/client/indexer-client.js

@@ -1,5 +1,6 @@
 const helper = require('../helper');
 const CLIENT_TYPES = require('../const/client-type');
+const collection = require('../../regexes/client-index-hash');
 
 const CLIENT_TYPES_MAP = {}
 CLIENT_TYPES_MAP[CLIENT_TYPES.BROWSER] = 0;
@@ -9,8 +10,6 @@ CLIENT_TYPES_MAP[CLIENT_TYPES.MEDIA_PLAYER] = 3;
 CLIENT_TYPES_MAP[CLIENT_TYPES.FEED_READER] = 4;
 CLIENT_TYPES_MAP[CLIENT_TYPES.PIM] = 5;
 
-let collection;
-let path = __dirname + '/../../regexes/client-index-hash.yml';
 
 class IndexerClient {
 
@@ -20,10 +19,6 @@ class IndexerClient {
    * @returns {null|array}
    */
   static findClientRegexPositionsForUserAgent(userAgent, type) {
-    if (!IndexerClient.ready()) {
-      return null;
-    }
-
     let index = CLIENT_TYPES_MAP[type];
     if (index === void 0) {
       return null;
@@ -39,16 +34,6 @@ class IndexerClient {
     return null;
   }
 
-  static ready() {
-    return collection !== void 0;
-  }
-
-  static init() {
-    if (helper.hasFile(path)) {
-      collection = helper.loadYMLFile(path);
-    }
-  }
-
 }
 
 module.exports = IndexerClient;

parser/client/library.js

@@ -5,8 +5,7 @@ const CLIENT_TYPE = require('./../const/client-type');
 class Library extends ClientAbstractParser {
   constructor() {
     super();
-    this.fixtureFile = 'client/libraries.yml';
-    this.loadCollection();
+    this.collection = require('../../regexes/client/libraries');
     this.collectionLength = this.collection.length;
     this.type = CLIENT_TYPE.LIBRARY;
   }

parser/client/media-player.js

@@ -5,8 +5,7 @@ const CLIENT_TYPE = require('./../const/client-type');
 class MediaPlayer extends ClientAbstractParser {
   constructor() {
     super();
-    this.fixtureFile = 'client/mediaplayers.yml';
-    this.loadCollection();
+    this.collection = require('../../regexes/client/mediaplayers');
     this.collectionLength = this.collection.length;
     this.type = CLIENT_TYPE.MEDIA_PLAYER;
   }

parser/client/mobile-app.js

@@ -8,8 +8,7 @@ const appHints = new AppHints;
 class MobileApp extends ClientAbstractParser {
   constructor() {
     super();
-    this.fixtureFile = 'client/mobile_apps.yml';
-    this.loadCollection();
+    this.collection = require('../../regexes/client/mobile_apps');
     this.collectionLength = this.collection.length;
     this.type = CLIENT_TYPE.MOBILE_APP;
   }

parser/client/pim.js

@@ -4,8 +4,7 @@ const CLIENT_TYPE = require('./../const/client-type');
 class PIM extends ClientAbstractParser {
   constructor() {
     super();
-    this.fixtureFile = 'client/pim.yml';
-    this.loadCollection();
+    this.collection = require('../../regexes/client/pim');
     this.collectionLength = this.collection.length;
     this.type = CLIENT_TYPE.PIM;
   }

parser/device/alias-device.js

@@ -35,8 +35,7 @@ class AliasDevice extends AbstractParser {
   #replaceBrand = true;
   constructor() {
     super();
-    this.fixtureFile = 'device/alias-device.yml';
-    this.loadCollection();
+    this.collection = require('../../regexes/device/alias-device');
   }
 
   /**

parser/device/camera.js

@@ -3,8 +3,7 @@ const DeviceAbstractParser = require('./../device-abstract-parser');
 class Camera extends DeviceAbstractParser {
   constructor() {
     super();
-    this.fixtureFile = 'device/cameras.yml';
-    this.loadCollection();
+    this.collection = require('../../regexes/device/cameras');
   }
 }
 

parser/device/car-browser.js

@@ -3,8 +3,7 @@ const DeviceAbstractParser = require('./../device-abstract-parser');
 class CarBrowser extends DeviceAbstractParser {
   constructor() {
     super();
-    this.fixtureFile = 'device/car_browsers.yml';
-    this.loadCollection();
+    this.collection = require('../../regexes/device/car_browsers');
   }
 }
 

parser/device/console.js

@@ -3,8 +3,7 @@ const DeviceAbstractParser = require('./../device-abstract-parser');
 class Console extends DeviceAbstractParser {
   constructor() {
     super();
-    this.fixtureFile = 'device/consoles.yml';
-    this.loadCollection();
+    this.collection = require('../../regexes/device/consoles');
   }
 }
 

parser/device/hbb-tv.js

@@ -8,8 +8,7 @@ class HbbTv extends DeviceAbstractParser {
    */
   constructor() {
     super();
-    this.fixtureFile = 'device/televisions.yml';
-    this.loadCollection();
+    this.collection = require('../../regexes/device/televisions');
   }
 
   /**

parser/device/indexer-device.js

@@ -1,14 +1,7 @@
-const helper = require("../helper");
-
-let collection;
-let path = __dirname + '/../../regexes/device-index-hash.yml';
+const collection = require('../../regexes/device-index-hash');
 
 class IndexerDevice {
   static findDeviceBrandsForDeviceCode(deviceCode) {
-    if (!IndexerDevice.ready()) {
-      return null;
-    }
-
     let lDeviceCode = deviceCode.toLowerCase();
     let brands = collection[lDeviceCode];
     if (brands !== void 0) {
@@ -18,16 +11,6 @@ class IndexerDevice {
     return [];
   }
 
-  static ready() {
-    return collection !== void 0;
-  }
-
-  static init() {
-    if (helper.hasFile(path)) {
-      collection = helper.loadYMLFile(path);
-    }
-  }
-
 }
 
 module.exports = IndexerDevice;

parser/device/info-device.js

@@ -1,5 +1,8 @@
 const ParserAbstract = require('./../abstract-parser');
 const DataPacker = require('./../../lib/data-packer');
+const collectionHardwareCPU = require('../../regexes/device-info/hardware-cpu');
+const collectionHardwareGPU = require('../../regexes/device-info/hardware-gpu');
+const collectionSoftware = require('../../regexes/device-info/software');
 
 
 
@@ -177,9 +180,6 @@ const SHORT_KEYS = {
   TG: 'performance.geekbench'      // int: geekbench score
 };
 
-let collectionHardwareCPU = null;
-let collectionHardwareGPU = null;
-let collectionSoftware = null;
 
 /**
  * Class for obtaining information on a device
@@ -193,23 +193,7 @@ class InfoDevice extends ParserAbstract {
     /** @type {boolean} convert display.resolution 1080x1920 to object {width, height} */
     this.resolutionConvertObject = false;
     /** @type {string} fixture path to file */
-    this.fixtureFile = 'device-info/device.yml';
-    this.loadCollection();
-  }
-
-  loadCollection() {
-    super.loadCollection();
-    // load hardware properties
-    if (collectionHardwareCPU === null) {
-      collectionHardwareCPU = this.loadYMLFile('device-info/hardware-cpu.yml');
-    }
-    if (collectionHardwareGPU === null) {
-      collectionHardwareGPU = this.loadYMLFile('device-info/hardware-gpu.yml');
-    }
-    // load software properties
-    if (collectionSoftware === null) {
-      collectionSoftware = this.loadYMLFile('device-info/software.yml');
-    }
+    this.collection = require('../../regexes/device-info/device');
   }
 
   /**

parser/device/mobile.js

@@ -3,8 +3,7 @@ const DeviceAbstractParser = require('./../device-abstract-parser');
 class Mobile extends DeviceAbstractParser {
   constructor() {
     super();
-    this.fixtureFile = 'device/mobiles.yml';
-    this.loadCollection();
+    this.collection = require('../../regexes/device/mobiles');
   }
 }
 

parser/device/notebook.js

@@ -5,8 +5,7 @@ const DEVICE_TYPE = require('./../const/device-type');
 class Notebook extends DeviceAbstractParser {
   constructor() {
     super();
-    this.fixtureFile = 'device/notebooks.yml';
-    this.loadCollection();
+    this.collection = require('../../regexes/device/notebooks');
   }
 
   /**

parser/device/portable-media-player.js

@@ -3,8 +3,7 @@ const DeviceAbstractParser = require('./../device-abstract-parser');
 class PortableMediaPlayer extends DeviceAbstractParser {
   constructor() {
     super();
-    this.fixtureFile = 'device/portable_media_player.yml';
-    this.loadCollection();
+    this.collection = require('../../regexes/device/portable_media_player');
   }
 }
 

parser/device/shell-tv.js

@@ -8,8 +8,7 @@ class ShellTv extends DeviceAbstractParser {
    */
   constructor() {
     super();
-    this.fixtureFile = 'device/shell_tv.yml';
-    this.loadCollection();
+    this.collection = require('../../regexes/device/shell_tv');
   }
 
   /**

parser/helper.js

@@ -335,10 +335,6 @@ function loadYMLFile(file) {
   return YAML.load(fs.readFileSync(file));
 }
 
-function hasFile(file) {
-  return fs.existsSync(file);
-}
-
 /**
  * Remove chars for string
  * @param {string} str
@@ -442,7 +438,6 @@ module.exports = {
   attr,
   revertObject,
   loadYMLFile,
-  hasFile,
   trimChars,
   splitUserAgent,
   matchReplace,