Merge pull request #56 from fewieden/develop

2.1.2

.github/CONTRIBUTING.md

@@ -4,5 +4,5 @@ Thanks for contributing to this module!
 
 Please create pull requests to the branch `develop`.
 
-To hold one code style and standard there are several linters and tools in this project set. Make sure you fullfill the requirements.
-Also there will be automatically analysis performed once you created the pull request.
+To hold one code style and standard there are several linters and tools in this project set. Make sure you fulfill the requirements.
+Also, there will be automatically analysis performed once you created the pull request.

.travis.yml

@@ -1,9 +1,9 @@
 language: node_js
 node_js:
  - "stable"
- - "8"
  - "10"
  - "12"
+ - "14"
 script:
  - npm run lint
 cache:

CHANGELOG.md

@@ -1,5 +1,20 @@
 # MMM-Fuel Changelog
 
+## [2.1.2]
+
+### Added
+
+* Config option `showDistance` https://github.com/fewieden/MMM-Fuel/pull/49
+* Missing jsdoc documentation
+
+### Changed
+
+* Dependency update
+
+### Fixed
+
+* Deinit map had a harcoded index for markers.
+
 ## [2.1.1]
 
 ### Fixed

MMM-Fuel.js

@@ -7,7 +7,7 @@
  * @see  https://github.com/fewieden/MMM-Fuel
  */
 
-/* global Module Log google */
+/* global google */
 
 /**
  * @external Module
@@ -33,7 +33,6 @@
  * @requires external:google
  */
 Module.register('MMM-Fuel', {
-
     /** @member {Object} units - Is used to determine the unit symbol of the global config option units. */
     units: {
         imperial: 'ml',
@@ -64,6 +63,7 @@ Module.register('MMM-Fuel', {
      * @property {boolean|int} shortenText - Max characters to be shown for name and address.
      * @property {boolean} showAddress - Flag to show the gas stations address.
      * @property {boolean} showOpenOnly - Flag to show only open gas stations or all.
+     * @property {boolean} showDistance - Flag to show the distance to your specified position.
      * @property {boolean} iconHeader - Flag to display the car icon in the header.
      * @property {boolean} rotate - Flag to enable/disable rotation between sort by price and distance.
      * @property {string[]} types - Fuel types to show.
@@ -85,6 +85,7 @@ Module.register('MMM-Fuel', {
         shortenText: false,
         showAddress: true,
         showOpenOnly: false,
+        showDistance: true,
         iconHeader: true,
         rotate: true,
         types: ['diesel'],
@@ -152,7 +153,7 @@ Module.register('MMM-Fuel', {
      * @description Data that gets rendered in the nunjuck template.
      * @override
      *
-     * @returns {string} Data for the nunjuck template.
+     * @returns {Object} Data for the nunjuck template.
      */
     getTemplateData() {
         let gasStations;
@@ -175,6 +176,8 @@ Module.register('MMM-Fuel', {
      * @description Appends Google Map script to the body, if the config option map_api_key is defined. Calls
      * createInterval and sends the config to the node_helper.
      * @override
+     *
+     * @returns {void}
      */
     start() {
         Log.info(`Starting module: ${this.name}`);
@@ -184,6 +187,11 @@ Module.register('MMM-Fuel', {
             this.config.sortBy = this.config.types[0];
         }
 
+        if (this.config.rotate && !this.config.showDistance) {
+            Log.error('Config option rotate does not work if distance is hidden! Falling back to no rotation.');
+            this.config.rotate = false;
+        }
+
         this.addGlobals();
         this.addFilters();
         // Add script manually, getScripts doesn't work for it!
@@ -199,6 +207,7 @@ Module.register('MMM-Fuel', {
     /**
      * @function createInterval
      * @description Creates an interval if config option rotate is set.
+     *
      * @returns {?Interval} The Interval toggles sortByPrice between true and false.
      */
     createInterval() {
@@ -304,6 +313,14 @@ Module.register('MMM-Fuel', {
         }
     },
 
+    /**
+     * @function initMap
+     * @description Initializes the map, markers and layers.
+     *
+     * @param {boolean} success - Only initialize the map if success is truthy.
+     *
+     * @returns {void}
+     */
     initMap(success) {
         if (!success || this.map) {
             return;
@@ -334,6 +351,12 @@ Module.register('MMM-Fuel', {
         }
     },
 
+    /**
+     * @function deinitMap
+     * @description Deinitializes the map, markers and layers.
+     *
+     * @returns {void}
+     */
     deinitMap() {
         if (!this.map) {
             return;
@@ -343,7 +366,7 @@ Module.register('MMM-Fuel', {
         this.trafficLayer = null;
 
         for (let i = 0; i < this.markers.length; i += 1) {
-            this.markers[1].setMap(null);
+            this.markers[i].setMap(null);
         }
 
         this.markers = [];

README.md

@@ -57,6 +57,7 @@ Gas Station Price Module for MagicMirror<sup>2</sup>
 | `shortenText` | `false` | Integer of characters to be shown for name and address. Default shows all. |
 | `showAddress` | `true` | Boolean to show the gas stations address. |
 | `showOpenOnly` | `false` | Boolean to show only open gas stations or all. |
+| `showDistance` | `true` | Boolean to show the distance to your specified position. |
 | `iconHeader` | `true` | Boolean to display the car icon in the header. |
 | `rotate` | `true` | Boolean to enable/disable rotation between sort by price and distance. |
 | `rotateInterval` | `60000` (1 min) | How fast the sorting should be switched between byPrice and byDistance. |
@@ -79,6 +80,7 @@ No API key required.
 
 | **Option** | **Default** | **Description** |
 | --- | --- | --- |
+| `provider` | `"tankerkoenig"` | Make sure you set it to `"spritpreisrechner"`. |
 | `types` | `["diesel"]` | Valid options are `diesel`, `e5` and `gas`. |
 | `radius` | `5` | Valid range not tested yet. |
 | `max` | `5` | The API provider returns maximum of 5 valid datasets. |
@@ -91,6 +93,7 @@ Config options should be set accordingly `open`: false and `showOpenOnly`: false
 | **Option** | **Default** | **Description** |
 | --- | --- | --- |
 | `api_key` | REQUIRED | Get an API key for free access to the data of [api.nsw](https://api.nsw.gov.au/). |
+| `provider` | `"tankerkoenig"` | Make sure you set it to `"nsw"`. |
 | `secret` | REQUIRED | You also need to add the secret visible in your dashboard on [api.nsw](https://api.nsw.gov.au/). |
 | `types` | `["diesel"]` | Valid options are `diesel`, `e5`. |
 | `radius` | `5` | Valid range not tested yet. |

node_helper.js

@@ -38,6 +38,8 @@ module.exports = NodeHelper.create({
      * @function start
      * @description Logs a start message to the console.
      * @override
+     *
+     * @returns {void}
      */
     start() {
         console.log(`Starting module helper: ${this.name}`);