Merge pull request #543 from DinoChiesa/class-refactor

Class refactor - no new function

Author: ssvaidyanathan

lib/package/Bundle.js

@@ -1,5 +1,5 @@
 /*
-  Copyright 2019, 2023 Google LLC
+  Copyright 2019, 2023, 2025 Google LLC
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
@@ -14,78 +14,46 @@
   limitations under the License.
 */
 
-const TruthTable = require("./TruthTable.js");
+const TruthTable = require("./TruthTable.js"),
+  ConfigElement = require("./ConfigElement.js");
 
-function Condition(element, parent) {
-  this.parent = parent;
-  this.element = element;
-}
+class Condition extends ConfigElement {
+  constructor(element, parent) {
+    super(element, parent);
+  }
 
-Condition.prototype.getExpression = function () {
-  return (
+  getExpression = () =>
     (this.element.childNodes &&
       this.element.childNodes[0] &&
       this.element.childNodes[0].nodeValue) ||
-    ""
-  );
-};
-
-Condition.prototype.getMessages = function () {
-  return this.parent.getMessages();
-};
-
-Condition.prototype.getElement = function () {
-  return this.element;
-};
-
-Condition.prototype.getParent = function () {
-  return this.parent;
-};
-
-Condition.prototype.getLines = function (start, stop) {
-  return this.parent.getLines(start, stop);
-};
-
-Condition.prototype.getSource = function () {
-  if (!this.source) {
-    const start = this.element.lineNumber - 1,
-      stop = this.element.nextSibling.lineNumber - 1;
-    this.source = this.getLines(start, stop);
+    "";
+
+  getTruthTable() {
+    if (!this.truthTable) {
+      this.truthTable = new TruthTable(
+        this.getExpression().replace(/(\n| +)/g, " "),
+      );
+    }
+    return this.truthTable;
   }
-  return this.source;
-};
 
-Condition.prototype.getTruthTable = function () {
-  if (!this.truthTable) {
-    this.truthTable = new TruthTable(
-      this.getExpression().replace(/(\n| +)/g, " ")
-    );
+  onConditions(pluginFunction, cb) {
+    pluginFunction(this, cb);
   }
-  return this.truthTable;
-};
 
-Condition.prototype.addMessage = function (msg) {
-  if (!msg.hasOwnProperty("entity")) {
-    msg.entity = this;
+  summarize() {
+    const summary = {
+      type: "Condition",
+      condition: this.getExpression(),
+    };
+    try {
+      summary.truthTable = this.getTruthTable();
+    } catch (e) {
+      //just swallow it
+    }
+    return summary;
   }
-  this.parent.addMessage(msg);
-};
-
-Condition.prototype.onConditions = function (pluginFunction, cb) {
-  pluginFunction(this, cb);
-};
-
-Condition.prototype.summarize = function () {
-  const summary = {};
-  summary.type = "Condition";
-  summary.condition = this.getExpression();
-  try {
-    summary.truthTable = this.getTruthTable();
-  } catch (e) {
-    //just swallow it
-  }
-  return summary;
-};
+}
 
 //Public
 module.exports = Condition;

lib/package/Condition.js

@@ -0,0 +1,84 @@
+/*
+  Copyright © 2025 Google LLC
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      https://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/
+
+const xpath = require("xpath"),
+  debug = require("debug")("apigeelint:ConfigElement");
+
+class ConfigElement {
+  constructor(element, parent) {
+    this.parent = parent;
+    this.element = element;
+    this.bundle = false;
+  }
+
+  select(xs) {
+    return xpath.select(xs, this.element);
+  }
+
+  getElement() {
+    return this.element;
+  }
+  getName() {
+    return "unset";
+  }
+
+  getParent() {
+    debug(`> getParent name=${this.getName()}`);
+    return this.parent;
+  }
+
+  getSource() {
+    if (!this.source) {
+      var start = this.element.lineNumber - 1,
+        stop =
+          (this.element.nextSibling &&
+            this.element.nextSibling.lineNumber - 1) ||
+          this.element.lastChild.lineNumber;
+      this.source = this.getLines(start, stop);
+    }
+    return this.source;
+  }
+
+  getLines(start, stop) {
+    return this.parent.getLines(start, stop);
+  }
+
+  addMessage(msg) {
+    if (!msg.hasOwnProperty("entity")) {
+      msg.entity = this;
+    }
+    this.parent.addMessage(msg);
+  }
+
+  // // TODO: determine if this is necessary
+  // getMessages() {
+  //   return this.parent.getMessages();
+  // }
+
+  getBundle() {
+    if (this.bundle === false) {
+      let antecedent = this.parent;
+      while (antecedent && antecedent.constructor.name != "Bundle") {
+        antecedent = antecedent.getParent();
+      }
+      this.bundle = antecedent;
+    }
+    return this.bundle;
+  }
+}
+
+//Public
+module.exports = ConfigElement;