Merge pull request #41 from sp4ce-cowboy/admin/branch-refactor

Restructure Project

TowerForge/TowerForge/Commons/Constants/Constants.swift

@@ -0,0 +1,9 @@
+import Foundation
+
+/// A class to encapsulate application wide constants to ensure a single source of truth
+/// across the entire application.
+class Constants {
+
+    /// Universally declaring logging
+    static let LOGGING_IS_ACTIVE = true
+}

TowerForge/TowerForge/Protocols/Animatable.swift → TowerForge/TowerForge/Commons/Protocols/Animatable.swift

@@ -8,6 +8,8 @@
 import Foundation
 import SpriteKit
 
+/// A protocol whose conformants must encapsulate an SKAction and the means
+/// to control their own animations.
 protocol Animatable {
     var animatableAction: SKAction? { get set }
     var animatableKey: String { get set }

TowerForge/TowerForge/Commons/Utilities/Logger.swift

@@ -0,0 +1,26 @@
+import Foundation
+
+/// A utility class to provide for a universal logging function. The logger class
+/// can be set to be active if logging is required, within the Constants class.
+///
+/// Use case:
+/// Standard - print("Value is \(variable)")
+/// Alternative - Logger.log("Value is \(variable)", self)
+///
+/// Benefits:
+/// - Can universally turn off logging, so the console output can be turned off before publication
+/// - "self" argument will output the class name where the log function was invoked = easier debugging.
+class Logger {
+    static var isActive = Constants.LOGGING_IS_ACTIVE
+
+    private init() { }
+
+    static func log(_ string: String, _ caller: Any? = nil) {
+        if isActive {
+            let callerType = caller == nil ? "Unknown" : String(describing: type(of: caller!))
+            let date = Date.now.formatted(date: .omitted, time: .standard)
+            print("[\(date)] -- [\(callerType)] \(string)")
+        }
+
+    }
+}

TowerForge/TowerForge/LevelManager/Components/PlayerComponent.swift → TowerForge/TowerForge/GameModule/Components/LevelComponents/PlayerComponent.swift

@@ -8,6 +8,14 @@
 import Foundation
 import SpriteKit
 
+class PlayerComponent: TFComponent {
+    var player: Player
+    init(player: Player) {
+        self.player = player
+        super.init()
+    }
+}
+
 public enum Player: Int {
     case ownPlayer = 1
     case oppositePlayer = 2
@@ -30,11 +38,3 @@ public enum Player: Int {
         }
     }
 }
-
-class PlayerComponent: TFComponent {
-    var player: Player
-    init(player: Player) {
-        self.player = player
-        super.init()
-    }
-}

TowerForge/TowerForge/GameWorld.swift → TowerForge/TowerForge/GameModule/GameWorld.swift

@@ -27,6 +27,7 @@ class GameWorld {
         if let scene = self.scene {
             grid.generateTileMap(scene: scene)
         }
+
         renderer = Renderer(target: self, scene: scene)
         renderer?.renderMessage("Game Starts")
         self.setUpSystems()

TowerForge/TowerForge/Nodes/UnitNode.swift

@@ -7,6 +7,7 @@
 
 import SpriteKit
 
+/// TODO: Add documentation for this
 protocol UnitNodeDelegate: AnyObject {
     func unitNodeDidSelect(_ unitNode: UnitNode)
     func unitNodeDidSpawn(_ position: CGPoint)

TowerForge/TowerForge/Nodes/UnitSelectionNode.swift

@@ -31,6 +31,7 @@ class UnitSelectionNode: TFEntity, UnitNodeDelegate {
                                               position: CGPoint(x: 0, y: 0), animatableKey: "selectionNode")
         let node = spriteComponent.node
         node.isUserInteractionEnabled = true
+
         let possibleUnits: [(TFEntity & PlayerSpawnable).Type] = SpawnableEntities.playerSpawnableEntities
         var startingPoint = CGPoint(x: 400, y: 0)