Merge pull request #158 from n8rzz/feature/ATC-151

feature/ATC-151

CHANGELOG.md

@@ -29,7 +29,7 @@
 
 ### Bugfixes
 - Moves `_comment` blocks in airport json file to be within object the are describing [#145](https://github.com/n8rzz/atc/issues/145)
-
+- Streamlines flight number generation and adds new method to add new callsigns to the existing list [#151](https://github.com/n8rzz/atc/issues/151)
 
 
 

src/assets/scripts/aircraft/AircraftController.js

@@ -33,45 +33,39 @@ export default class AircraftController {
 
     /**
      * @for AircraftController
-     * @method aircraft_generate_callsign
-     * @param airlineName
+     * @method aircraft_auto_toggle
      */
-    aircraft_generate_callsign(airlineName) {
-        // TODO: this should live in the AirlineModel
-        const airline = window.airlineController.airline_get(airlineName);
-
-        if (!airline) {
-            console.warn(`Airline not found: ${airlineName}`);
-
-            return `airline-${airlineName}-not-found`;
-        }
-
-        return airline.generateFlightNumber();
+    aircraft_auto_toggle() {
+        prop.aircraft.auto.enabled = !this.aircraft.auto.enabled;
     }
 
     /**
      * @for AircraftController
-     * @method aircraft_auto_toggle
+     * @method isCallsignInList
+     * @param callsign {string}
+     * return {boolean}
      */
-    aircraft_auto_toggle() {
-        prop.aircraft.auto.enabled = !this.aircraft.auto.enabled;
+    isCallsignInList(callsign) {
+        return this.aircraft.callsigns.indexOf(callsign) !== -1;
     }
 
     /**
+     * Add a new callsign to `aircraft.callsigns`
+     *
      * @for AircraftController
-     * @method aircraft_callsign_new
-     * @param airline {string}
+     * @method addCallsignToList
+     * @param callsign {string}
      */
-    aircraft_callsign_new(airline) {
-        // TODO: the logic needs work here. if `callsign` is always initialized as null, one would imagine that
-        // this function would always result in the creation of a callsign?
-        let callsign = this.aircraft_generate_callsign(airline);
+    addCallsignToList(callsign) {
+        if (this.isCallsignInList(callsign)) {
+            // if you've made it here something has gone very wrong. generation of a callsign/flightNumber should
+            // also include verification that the callsign/flightNumber is unique
+            console.warn(`${callsign} already exists within the callsigns list!`);
 
-        if (this.aircraft.callsigns.indexOf(callsign) === -1) {
-            this.aircraft.callsigns.push(callsign);
+            return;
         }
 
-        return callsign;
+        this.aircraft.callsigns.push(callsign);
     }
 
     /**
@@ -359,6 +353,7 @@ export default class AircraftController {
         return this.aircraft.models[icao];
     }
 
+    // TODO: what is an `eid` and why would it beed to be updated?
     /**
      * Adjust all aircraft's eid values
      *

src/assets/scripts/airline/AirlineModel.js

@@ -1,7 +1,6 @@
 import _get from 'lodash/get';
 import _has from 'lodash/has';
 import _forEach from 'lodash/forEach';
-import _map from 'lodash/map';
 import { choose, choose_weight } from '../utilities/generalUtilities';
 
 /**
@@ -82,7 +81,7 @@ export default class AirlineModel {
         _forEach(this.fleets, (fleet) => {
             _forEach(fleet, (aircraftInFleet) => {
                 const NAME_INDEX = 0;
-                aircraftInFleet[NAME_INDEX] = aircraftInFleet[NAME_INDEX].toLowerCase()
+                aircraftInFleet[NAME_INDEX] = aircraftInFleet[NAME_INDEX].toLowerCase();
             });
         });
     }
@@ -148,7 +147,7 @@ export default class AirlineModel {
      */
     chooseAircraft(fleet) {
         if (!fleet) {
-             fleet = 'default'
+            fleet = 'default';
         }
 
         // TODO: why is this a try/catch?
@@ -227,6 +226,11 @@ export default class AirlineModel {
             }
         }
 
+        // if this flightNumber already exists, repeat the process of generating a new flightNumber
+        if (window.aircraftController.isCallsignInList(flightNumber)) {
+            return this.generateFlightNumber();
+        }
+
         return flightNumber;
     }
 
@@ -273,9 +277,9 @@ export default class AirlineModel {
      */
     _generateAircraft(options) {
         if (!options.callsign) {
-            // TODO: Why is the `AircraftController` repsonsible for generating a callsign, but this is responsible for
-            // generating the flight number? callsign generation logi should live in this class.
-            options.callsign = window.aircraftController.aircraft_callsign_new(options.airline);
+            options.callsign = this.generateFlightNumber();
+
+            window.aircraftController.addCallsignToList(options.callsign);
         }
 
         if (!options.icao) {
@@ -285,7 +289,5 @@ export default class AirlineModel {
         const model = window.aircraftController.aircraft_model_get(options.icao.toLowerCase());
 
         return model.generateAircraft(options);
-        // FIXME: this block is unreachable, is it needed?
-        // var icao = options.icao.toLowerCase();
     }
 }