extracts duplicated function and removes double empty lines

fewieden · Aug 13, 2022 · 4bb4964 · 4bb4964
1 parent 2cf26b7
commit 4bb4964
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 82 deletions.
diff --git a/README.md b/README.md
@@ -119,7 +119,6 @@ No API key required. The displayed distance is not based on your coordinates but
 | `showOpenOnly` | `false` | Not supported |
 | `showBrand` | `false` | Not supported |
 
-
 ### gasbuddy (USA and Canada only)
 
 No API key required. The displayed distance is not based on your coordinates but on the zip code.
@@ -137,7 +136,6 @@ No API key required. The displayed distance is not based on your coordinates but
 | `showOpenOnly` | `false` | Not supported |
 | `showBrand` | `false` | Not supported |
 
-
 ### nsw (Australia NSW and TAS only)
 
 This provider gives no information if the gas stations are open or closed.

diff --git a/apis/autoblog.js b/apis/autoblog.js
@@ -19,6 +19,8 @@ const fetch = require('node-fetch');
  */
 const { parse } = require('node-html-parser');
 
+const { fillMissingPrices, sortByDistance, sortByPrice } = require('./utils');
+
 const BASE_URL = 'https://www.autoblog.com';
 const MAX_PAGE = 2;
 
@@ -59,43 +61,6 @@ function mapGasStation(htmlGasStation, type) {
     };
 }
 
-/**
- * @function fillMissingPrices
- * @description Replaces missing price information with max price for type.
- *
- * @param {Object} station - Gas Station
- * @param {Object} maxPricesByType - Maximum price per fuel type.
- *
- * @returns {void}
- */
-function fillMissingPrices(station, maxPricesByType) {
-    for (const type of config.types) {
-        if (!station.prices[type]) {
-            station.prices[type] = `>${maxPricesByType[type]}`;
-        }
-    }
-}
-
-/**
- * @function sortByPrice
- * @description Helper function to sort gas stations by price.
- *
- * @param {Object} a - Gas Station
- * @param {Object} b - Gas Station
- *
- * @returns {number} Sorting weight.
- */
-function sortByPrice(a, b) {
-    const aPrice = a.prices[config.sortBy];
-    const bPrice = b.prices[config.sortBy];
-
-    if (!isNaN(aPrice) || !isNaN(bPrice)) {
-        return isNaN(aPrice) ? 1 : -1;
-    }
-
-    return 0;
-}
-
 /**
  * @function fetchPaginatedStations
  * @description Paginated API requests for specified type.
@@ -201,12 +166,12 @@ async function getData() {
 
     const { stations, maxPricesByType } = mergePrices(responses);
 
-    stations.forEach(station => fillMissingPrices(station, maxPricesByType));
+    stations.forEach(station => fillMissingPrices(config, station, maxPricesByType));
 
     const filteredStations = stations.filter(station => station.distance <= config.radius);
 
-    const stationsSortedByDistance = filteredStations.sort((a, b) => a.distance - b.distance);
-    const stationsSortedByPrice = [...stationsSortedByDistance].sort(sortByPrice);
+    const stationsSortedByDistance = filteredStations.sort(sortByDistance);
+    const stationsSortedByPrice = [...stationsSortedByDistance].sort(sortByPrice.bind(null, config));
 
     return {
         types: ['regular', 'premium', 'mid-grade', 'diesel'],

diff --git a/apis/gasbuddy.js b/apis/gasbuddy.js
@@ -25,6 +25,8 @@ const { parse } = require('node-html-parser');
  */
 const Log = require('logger');
 
+const { fillMissingPrices, sortByPrice } = require('./utils');
+
 const BASE_URL = 'https://www.gasbuddy.com';
 const TYPES = {
     regular: 1,
@@ -70,43 +72,6 @@ function mapGasStation(htmlGasStation, type) {
 
 }
 
-/**
- * @function fillMissingPrices
- * @description Replaces missing price information with max price for type.
- *
- * @param {Object} station - Gas Station
- * @param {Object} maxPricesByType - Maximum price per fuel type.
- *
- * @returns {void}
- */
-function fillMissingPrices(station, maxPricesByType) {
-    for (const type of config.types) {
-        if (!station.prices[type]) {
-            station.prices[type] = `>${maxPricesByType[type]}`;
-        }
-    }
-}
-
-/**
- * @function sortByPrice
- * @description Helper function to sort gas stations by price.
- *
- * @param {Object} a - Gas Station
- * @param {Object} b - Gas Station
- *
- * @returns {number} Sorting weight.
- */
-function sortByPrice(a, b) {
-    const aPrice = a.prices[config.sortBy];
-    const bPrice = b.prices[config.sortBy];
-
-    if (!isNaN(aPrice) || !isNaN(bPrice)) {
-        return isNaN(aPrice) ? -1 : 1;
-    }
-
-    return 0;
-}
-
 /**
  * @function fetchStations
  * @description API requests for specified type.
@@ -204,10 +169,10 @@ async function getData() {
 
     const { stations, maxPricesByType } = mergePrices(responses);
 
-    stations.forEach(station => fillMissingPrices(station, maxPricesByType));
+    stations.forEach(station => fillMissingPrices(config, station, maxPricesByType));
 
     // Webpage doesn't support distance (only zip code).
-    const stationsSortedByPrice = stations.sort(sortByPrice);
+    const stationsSortedByPrice = stations.sort(sortByPrice.bind(null, config));
     const stationsSortedByDistance = stationsSortedByPrice;
 
     return {

diff --git a/apis/utils/index.js b/apis/utils/index.js
@@ -34,11 +34,50 @@ function sortByDistance(a, b) {
     return a.distance - b.distance;
 }
 
+/**
+ * @function fillMissingPrices
+ * @description Replaces missing price information with max price for type.
+ *
+ * @param {Object} station - Gas Station
+ * @param {Object} maxPricesByType - Maximum price per fuel type.
+ *
+ * @returns {void}
+ */
+function fillMissingPrices(config, station, maxPricesByType) {
+    for (const type of config.types) {
+        if (!station.prices[type]) {
+            station.prices[type] = `>${maxPricesByType[type]}`;
+        }
+    }
+}
+
+/**
+ * @function sortByPrice
+ * @description Helper function to sort gas stations by price.
+ *
+ * @param {Object} a - Gas Station
+ * @param {Object} b - Gas Station
+ *
+ * @returns {number} Sorting weight.
+ */
+function sortByPrice(config, a, b) {
+    const aPrice = a.prices[config.sortBy];
+    const bPrice = b.prices[config.sortBy];
+
+    if (!isNaN(aPrice) || !isNaN(bPrice)) {
+        return isNaN(aPrice) ? 1 : -1;
+    }
+
+    return 0;
+}
+
 /**
  * @module apis/utils
  * @description Utility functions for API integrations.
  */
 module.exports = {
+    fillMissingPrices,
     filterStations,
-    sortByDistance
+    sortByDistance,
+    sortByPrice
 };