Expand core service architecture to make way for better module management

ReplicaObscura · ReplicaObscura · commit 759a38cd2a7a · 2021-09-26T18:38:59.000-04:00
diff --git a/Lib/Shared/AppLib/App/AppBase.ahk b/Lib/Shared/AppLib/App/AppBase.ahk
@@ -117,6 +117,9 @@ class AppBase {
 
         services := (config.Has("services") && config["services"]) ? config["services"] : Map()
 
+        if (!services.Has("App") || !services["App"]) {
+            services["App"] := this
+        }
 
         if (!services.Has("Shell") || !services["Shell"]) {
              shell := ""
@@ -155,7 +158,12 @@ class AppBase {
         }
 
         this.Services := ServiceContainer(services)
-        this.Services.Set("ModuleManager", ModuleManager(this).LoadModules(config))
+
+        moduleConfigPath := this.dataDir . "\Modules.json"
+        defaultModules := this.GetDefaultModules(config)
+        moduleDirs := config.Has("moduleDirs") ? config["moduleDirs"] : []
+        this.Services.Set("ModuleManager", ModuleManager(this, moduleConfigPath, moduleDirs, defaultModules))
+        
         this.errorCallback := ObjBindMethod(this, "OnException")
         OnError(this.errorCallback)
     }
diff --git a/Lib/Shared/AppLib/BulkOperation/ComponentDiscoverer/ClassFileComponentDiscoverer.ahk b/Lib/Shared/AppLib/BulkOperation/ComponentDiscoverer/ClassFileComponentDiscoverer.ahk
@@ -0,0 +1,18 @@
+class ClassFileComponentDiscoverer extends FileComponentDiscovererBase {
+    DiscoverComponent(fileName, filePath) {
+        componentName := this.GetComponentName(fileName, filePath)
+        
+        if (!this.results.Has(componentName)) {
+            this.results[componentName] := this.GetComponentClass(fileName, filePath)
+        }
+    }
+
+    GetComponentName(fileName, filePath) {
+        parts := StrSplit(fileName, ".", " \t", 2)
+        return parts[1]
+    }
+
+    GetComponentClassName(fileName, filePath) {
+        return this.GetComponent(fileName, filePath)
+    }
+}
diff --git a/Lib/Shared/AppLib/BulkOperation/ComponentDiscoverer/ComponentDiscovererBase.ahk b/Lib/Shared/AppLib/BulkOperation/ComponentDiscoverer/ComponentDiscovererBase.ahk
@@ -0,0 +1,38 @@
+class ComponentDiscovererBase extends BulkOperationBase {
+    componentName := "component"
+    componentNamePlural := "components"
+    useProgress := false
+    shouldNotify := false
+    componentManager := ""
+
+    __New(componentManager, owner := "") {      
+        this.componentManager := componentManager
+        super.__New(componentManager.app, owner)
+    }
+
+    RunAction() {
+        this.StartItem(1, "Discovering " . this.componentNamePlural . "...")
+        this.results := this.CreateComponentInfo()
+        this.DiscoverComponents()
+        this.FinishItem(1, "Finished discovering " . this.componentNamePlural . ".")
+    }
+
+    CreateComponentInfo() {
+        componentInfo := this.componentManager.defaultComponentInfo ? this.componentManager.defaultComponentInfo : Map()
+        return componentInfo.Clone()
+    }
+
+    DiscoverComponents() {
+        if (this.componentManager.discoverEvent) {
+            event := ComponentInfoEvent(this.componentManager.discoverEvent, this.results)
+            this.app.Service("EventManager").DispatchEvent(this.componentManager.discoverEvent, event)
+            this.results := event.ComponentInfo
+        }
+
+        if (this.componentManager.discoverAlterEvent) {
+            event := ComponentInfoEvent(this.componentManager.discoverAlterEvent, this.results)
+            this.app.Service("EventManager").DispatchEvent(this.componentManager.discoverAlterEvent, event)
+            this.results := event.ComponentInfo
+        }
+    }
+}
diff --git a/Lib/Shared/AppLib/BulkOperation/ComponentDiscoverer/ConfigComponentDiscoverer.ahk b/Lib/Shared/AppLib/BulkOperation/ComponentDiscoverer/ConfigComponentDiscoverer.ahk
@@ -0,0 +1,25 @@
+class ConfigComponentDiscoverer extends ComponentDiscovererBase {
+    configObj := ""
+    parentKey := ""
+
+    __New(componentManager, configObj, parentKey := "", owner := "") {
+        this.configObj := configObj
+        this.parentKey := parentKey
+
+        super.__New(componentManager, owner)
+    }
+
+    DiscoverComponents() {
+        parentKey := this.parentKey
+
+        for componentName, componentConfig in this.configObj.%parentKey% {
+            this.DiscoverComponent(componentName, componentConfig)
+        }
+
+        super.DiscoverComponents()
+    }
+
+    DiscoverComponent(componentName, componentConfig) {
+        this.results[componentName] := componentConfig
+    }
+}
diff --git a/Lib/Shared/AppLib/BulkOperation/ComponentDiscoverer/FileComponentDiscovererBase.ahk b/Lib/Shared/AppLib/BulkOperation/ComponentDiscoverer/FileComponentDiscovererBase.ahk
@@ -0,0 +1,33 @@
+class FileComponentDiscovererBase extends ComponentDiscovererBase {
+    searchDirs := ""
+    filePattern := ""
+
+    __New(componentManager, searchDirs, filePattern := "", owner := "") {
+        if (Type(searchDirs) != "Array") {
+            searchDirs := [searchDirs]
+        }
+
+        if (!filePattern) {
+            filePattern := "*"
+        }
+
+        this.searchDirs := searchDirs
+        this.filePattern := filePattern
+
+        super.__New(componentManager, owner)
+    }
+
+    DiscoverComponents() {
+        for index, dir in this.searchDirs {
+            Loop Files dir . "\" . this.filePattern, "R" {
+                this.DiscoverComponent(A_LoopFileName, A_LoopFileFullPath)
+            }
+        }
+
+        super.DiscoverComponents()
+    }
+
+    DiscoverComponent(fileName, filePath) {
+        throw MethodNotImplementedException("FileComponentDiscovererBase", "DiscoverComponent")
+    }
+}
diff --git a/Lib/Shared/AppLib/BulkOperation/ComponentLoader/ClassComponentLoader.ahk b/Lib/Shared/AppLib/BulkOperation/ComponentLoader/ClassComponentLoader.ahk
@@ -0,0 +1,58 @@
+class ClassComponentLoader extends ComponentLoaderBase {
+    defaultClassConfig := Map()
+
+    LoadComponent(key, componentInfo) {
+        if (Type(componentInfo) == "String") {
+            componentInfo := Map("class", componentInfo)
+        }
+
+        className := this.GetComponentClass(key, componentInfo)
+        componentConfig := this.GetComponentConfig(key, componentInfo)
+
+        isEnabled := true
+
+        if (componentConfig && componentConfig.Has("enabled")) {
+            isEnabled := componentConfig["enabled"]
+        }
+
+        if (isEnabled) {
+            if (className && IsObject(%className%)) {
+                if (HasMethod(%className%, "Create")) {
+                    this.results[key] := %className%.Create(this.app.Services, componentConfig)
+                } else {
+                    this.results[key] := %className%(this.app, componentConfig)
+                }
+            }
+            
+            super.LoadComponent(key, componentInfo)
+
+            if (!this.results.Has(key)) {
+                throw AppException("Cannot load component " . key)
+            }
+        }
+    }
+
+    GetComponentClass(key, componentInfo) {
+        return componentInfo.Has("class") ? componentInfo["class"] : ""
+    }
+
+    GetComponentConfig(key, componentInfo) {
+        componentConfig := this.defaultClassConfig
+
+        if (componentInfo.Has("config")) {
+            for key, val in componentInfo["config"] {
+                componentConfig[key] := val
+            }
+        }
+
+        managerConfig := this.componentManager.GetComponentConfig(key, componentInfo)
+
+        if (managerConfig) {
+            for key, val in managerConfig {
+                componentConfig[key] := val
+            }
+        }
+
+        return componentConfig
+    }
+}
diff --git a/Lib/Shared/AppLib/BulkOperation/ComponentLoader/ComponentLoaderBase.ahk b/Lib/Shared/AppLib/BulkOperation/ComponentLoader/ComponentLoaderBase.ahk
@@ -0,0 +1,85 @@
+class ComponentLoaderBase extends BulkOperationBase {
+    componentInfo := ""
+    useProgress := false
+    shouldNotify := false
+    componentManager := ""
+
+    __New(componentManager, componentInfo, owner := "") {
+        this.componentManager := componentManager
+        this.componentInfo := componentInfo
+
+        super.__New(componentManager.app, owner)
+    }
+
+    RunAction() {
+        componentInfoType := Type(this.componentInfo)
+
+        if (this.componentManager.defaultComponents) {
+            for defaultKey, defaultComponent in this.componentManager.defaultComponents {
+                this.results[defaultKey] := defaultComponent
+            }
+        }
+        
+        if (this.useProgress) {
+            totalCount := 1
+
+            if (componentInfoType == "Map") {
+                totalCount := this.componentInfo.Count
+            } else if (componentInfoType == "Array") {
+                totalCount := this.componentInfo.Length
+            }
+
+            this.progress.SetRange(0, totalCount)
+        }
+
+        if (componentInfoType == "Map") {
+            index := 1
+
+            for key, info in this.componentInfo {
+                this.StartItem(index, "Loading " . key . "...")
+                this.LoadComponent(key, info)
+                this.FinishItem(index, "Finished loading " . key)
+                index++
+            }
+        } else if (componentInfoType == "Array") {
+            for index, info in this.componentInfo {
+                this.StartItem(index, "Loading component " . index . "...")
+                this.LoadComponent(index, info)
+                this.FinishItem(index, "Finished loading component " . index)
+            }
+        } else {
+            this.StartItem(1, "Loading component...")
+            this.LoadComponent(1, this.componentInfo)
+            this.FinishItem(1, "Finished loading component")
+        }
+    }
+
+    /*
+        This method should be called AFTER any overridden method loads the component.
+
+        It calls a load event if the component has not been loaded already.
+        Then it calls an alter event allowing the component to be modified or replaced.
+    */
+    LoadComponent(key, componentInfo) {
+        if (this.componentManager.loadEvent && (!this.results.Has(key) || !this.results[key])) {
+            event := LoadComponentEvent(this.componentManager.loadEvent, key, componentInfo)
+            this.app.Service("EventManager").DispatchEvent(this.componentManager.loadEvent, event)
+            
+            if (event.Component) {
+                this.results[key] := event.Component
+            }
+        }
+
+        if (this.componentManager.loadAlterEvent) {
+            event := LoadComponentEvent(this.componentManager.loadAlterEvent, key, componentInfo)
+            
+            if (this.results.Has(key)) {
+                event.Component := this.results[key]
+            }
+
+            this.app.Service("EventManager").DispatchEvent(this.componentManager.loadAlterEvent, event)
+
+            this.results[key] := event.Component
+        }
+    }
+}
diff --git a/Lib/Shared/AppLib/BulkOperation/ComponentLoader/SimpleComponentLoader.ahk b/Lib/Shared/AppLib/BulkOperation/ComponentLoader/SimpleComponentLoader.ahk
@@ -0,0 +1,14 @@
+class SimpleComponentLoader extends ComponentLoaderBase {
+    LoadComponent(key, componentInfo) {
+        isEnabled := true
+
+        if (componentInfo && Type(componentInfo) == "Map" && componentInfo.Has("enabled")) {
+            isEnabled := componentInfo["enabled"]
+        }
+
+        if (isEnabled) {
+            this.results[key] := componentInfo
+            super.LoadComponent(key, componentInfo)
+        }
+    }
+}
diff --git a/Lib/Shared/AppLib/Config/ModuleConfig.ahk b/Lib/Shared/AppLib/Config/ModuleConfig.ahk
@@ -0,0 +1,8 @@
+﻿class ModuleConfig extends JsonConfig {
+    primaryConfigKey := "Modules"
+
+    Modules {
+        get => this.config[this.primaryConfigKey]
+        set => this.config[this.primaryConfigKey] := value
+    }
+}
diff --git a/Lib/Shared/AppLib/Container/ContainerBase.ahk b/Lib/Shared/AppLib/Container/ContainerBase.ahk
@@ -17,7 +17,7 @@ class ContainerBase {
         if (this.Items.Has(key)) {
             result := this.Items[key]
 
-            if (IsString(result)) {
+            if (Type(result) == "String") {
                 result := this.DereferenceValue(result)
             }
         }
diff --git a/Lib/Shared/AppLib/Events/Event/ComponentEvent.ahk b/Lib/Shared/AppLib/Events/Event/ComponentEvent.ahk
@@ -0,0 +1,16 @@
+class ComponentEvent extends EventBase {
+    container := ""
+
+    Items {
+        get => this.container.Items
+    }
+
+    __New(eventName, container) {
+        this.container := container
+        super.__New(eventName)
+    }
+
+    Register(key, componentObj) {
+        this.container.Set(key, componentObj)
+    }
+}
diff --git a/Lib/Shared/AppLib/Events/Event/ComponentInfoEvent.ahk b/Lib/Shared/AppLib/Events/Event/ComponentInfoEvent.ahk
@@ -0,0 +1,15 @@
+class ComponentInfoEvent extends EventBase {
+    ComponentInfo := Map()
+
+    __New(eventName, componentInfo := "") {
+        if (componentInfo) {
+            this.ComponentInfo := componentInfo
+        }
+
+        super.__New(eventName)
+    }
+
+    Register(key, componentObj) {
+        this.ComponentInfo[key] := componentObj
+    }
+}
diff --git a/Lib/Shared/AppLib/Events/Event/DefineComponentsEvent.ahk b/Lib/Shared/AppLib/Events/Event/DefineComponentsEvent.ahk
@@ -1,16 +1,16 @@
-class RegisterComponentsEvent extends EventBase {
-    container := ""
+class DefineComponentsEvent extends EventBase {
+    components := ""
 
     Items {
-        get => this.container.Items
+        get => this.components
     }
 
-    __New(eventName, container) {
-        this.container := container
+    __New(eventName, components) {
+        this.components := components
         super.__New(eventName)
     }
 
-    Register(key, componentObj) {
-        this.container.Set(key, componentObj)
+    Define(key, className) {
+        this.components[key] := className
     }
 }
diff --git a/Lib/Shared/AppLib/Events/Event/LoadComponentEvent.ahk b/Lib/Shared/AppLib/Events/Event/LoadComponentEvent.ahk
@@ -0,0 +1,15 @@
+class LoadComponentEvent extends EventBase {
+    Component := ""
+    ComponentInfo := ""
+    ComponentKey := ""
+
+    __New(eventName, componentKey, componentInfo := "") {
+        this.componentKey := componentKey
+        this.componentInfo := componentInfo
+        super.__New(eventName)
+    }
+
+    SetComponent(component) {
+        this.Component := component
+    }
+}
diff --git a/Lib/Shared/AppLib/Events/Event/RegisterComponentsEvent.ahk b/Lib/Shared/AppLib/Events/Event/RegisterComponentsEvent.ahk
diff --git a/Lib/Shared/AppLib/Events/Events.ahk b/Lib/Shared/AppLib/Events/Events.ahk
diff --git a/Lib/Shared/AppLib/Service/ContainerService/ConfigurableContainerServiceBase.ahk b/Lib/Shared/AppLib/Service/ContainerService/ConfigurableContainerServiceBase.ahk
diff --git a/Lib/Shared/AppLib/Service/ContainerService/ContainerServiceBase.ahk b/Lib/Shared/AppLib/Service/ContainerService/ContainerServiceBase.ahk
diff --git a/Lib/Shared/AppLib/Service/ContainerService/GuiManager.ahk b/Lib/Shared/AppLib/Service/ContainerService/GuiManager.ahk
diff --git a/Lib/Shared/AppLib/Service/ModuleManager.ahk b/Lib/Shared/AppLib/Service/ModuleManager.ahk
diff --git a/Lib/Shared/Includes.ahk b/Lib/Shared/Includes.ahk

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ class ContainerBase {`
`17`	`17`	`if (this.Items.Has(key)) {`
`18`	`18`	`result := this.Items[key]`
`19`	`19`
`20`		`- if (IsString(result)) {`
	`20`	`+ if (Type(result) == "String") {`
`21`	`21`	`result := this.DereferenceValue(result)`
`22`	`22`	`}`
`23`	`23`	`}`