GPII-4226 Renaming JAWS settings handler option keys to be more meani…

…ngful
javihernandez · May 14, 2020 · 6f3edbc · 6f3edbc
1 parent 09a36cc
commit 6f3edbc
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 27 deletions.
diff --git a/gpii/node_modules/settingsHandlers/src/JawsSettingsHandler.js b/gpii/node_modules/settingsHandlers/src/JawsSettingsHandler.js
@@ -23,11 +23,11 @@ require("./INISettingsHandler.js");
 
 fluid.registerNamespace("gpii.settingsHandlers.JAWSSettingsHandler.parser");
 
-gpii.settingsHandlers.JAWSSettingsHandler.getProfileFileName = function (options) {
+gpii.settingsHandlers.JAWSSettingsHandler.getVoiceProfileFileName = function (options) {
     var iniPayload = {
         "com.freedomscientific.jaws": [{
             options: {
-                "filename": options.filename
+                "defaultSettingsFilePath": options.defaultSettingsFilePath
             },
             settings: {
                 "Voice Profiles.ActiveVoiceProfileName": null
@@ -36,28 +36,28 @@ gpii.settingsHandlers.JAWSSettingsHandler.getProfileFileName = function (options
     };
     var response = gpii.settingsHandlers.INISettingsHandler.get(iniPayload);
     var solutions = response["com.freedomscientific.jaws"];
-    var filename = undefined;
+    var voiceProfileFileName = undefined;
 
     if (Array.isArray(solutions) && solutions.length) {
         var solution = solutions[0];
         var settingValue = fluid.get(solution, ["settings", "Voice Profiles.ActiveVoiceProfileName"]);
 
         if (settingValue) {
-            filename = path.join(options.foldername, settingValue + ".VPF");
+            voiceProfileFileName = path.join(options.voiceProfilesDirPath, settingValue + ".VPF");
         } else {
-            filename = path.join(options.foldername, "Eloquence.VPF");
+            voiceProfileFileName = path.join(options.voiceProfilesDirPath, "Eloquence.VPF");
         }
     }
 
-    return filename;
+    return voiceProfileFileName;
 };
 
 gpii.settingsHandlers.JAWSSettingsHandler.parser.parse = function (content, options) {
     return gpii.iniFile.read(content, options);
 };
 
 gpii.settingsHandlers.JAWSSettingsHandler.parser.stringify = function (content, options) {
-    return gpii.iniFile.writeFromFile(options.filename, content, options);
+    return gpii.iniFile.writeFromFile(options.defaultSettingsFilePath, content, options);
 };
 
 /* PUBLIC API FUNCTIONS */

diff --git a/gpii/node_modules/settingsHandlers/test/JawsSettingsHandlerTests.js b/gpii/node_modules/settingsHandlers/test/JawsSettingsHandlerTests.js
@@ -16,8 +16,8 @@ var test = {
     payload: {
         "com.freedomscientific.jaws": [{
             options: {
-                "filename": "C:\\Users\\vagrant\\AppData\\Roaming\\Freedom Scientific\\JAWS\\2019\\Settings\\enu\\DEFAULT.JCF",
-                "foldername": "C:\\Users\\vagrant\\AppData\\Roaming\\Freedom Scientific\\JAWS\\2019\\Settings\\VoiceProfiles"
+                "defaultSettingsFilePath": "C:\\Users\\vagrant\\AppData\\Roaming\\Freedom Scientific\\JAWS\\2019\\Settings\\enu\\DEFAULT.JCF",
+                "voiceProfilesDirPath": "C:\\Users\\vagrant\\AppData\\Roaming\\Freedom Scientific\\JAWS\\2019\\Settings\\VoiceProfiles"
             },
             settings: {
                 "ENU-Global.Pitch": 90
@@ -27,8 +27,8 @@ var test = {
     expectedResult: {
         "com.freedomscientific.jaws": [{
             options: {
-                "filename": "C:\\Users\\vagrant\\AppData\\Roaming\\Freedom Scientific\\JAWS\\2019\\Settings\\enu\\DEFAULT.JCF",
-                "foldername": "C:\\Users\\vagrant\\AppData\\Roaming\\Freedom Scientific\\JAWS\\2019\\Settings\\VoiceProfiles"
+                "defaultSettingsFilePath": "C:\\Users\\vagrant\\AppData\\Roaming\\Freedom Scientific\\JAWS\\2019\\Settings\\enu\\DEFAULT.JCF",
+                "voiceProfilesDirPath": "C:\\Users\\vagrant\\AppData\\Roaming\\Freedom Scientific\\JAWS\\2019\\Settings\\VoiceProfiles"
             },
             settings: {
                 "ENU-Global.Pitch": {

diff --git a/testData/solutions/win32.json5 b/testData/solutions/win32.json5
@@ -5867,8 +5867,8 @@
                 "liveness": "manualRestart",
                 "options": {
                     // TODO: Create a base grade for JAWS and version-specific variations.  Make JAWS 2019 the default.  Restart version-detection discussions and "capability" discussions.
-                    "filename": "${{environment}.APPDATA}\\Freedom Scientific\\JAWS\\2019\\Settings\\enu\\DEFAULT.JCF",
-                    "foldername": "${{environment}.APPDATA}\\Freedom Scientific\\JAWS\\2019\\Settings\\VoiceProfiles"
+                    "defaultSettingsFilePath": "${{environment}.APPDATA}\\Freedom Scientific\\JAWS\\2019\\Settings\\enu\\DEFAULT.JCF",
+                    "voiceProfilesDirPath": "${{environment}.APPDATA}\\Freedom Scientific\\JAWS\\2019\\Settings\\VoiceProfiles"
                 },
                 "supportedSettings": {
                     // -------- Options ----------

diff --git a/tests/CloseConflictingAppsTests.js b/tests/CloseConflictingAppsTests.js
@@ -142,8 +142,8 @@ gpii.tests.conflictingApps.testDefs = [
                             // "ENU-MenuAndDialog.Pitch": 11
                         },
                         "options": {
-                            "filename": "${{environment}.APPDATA}\\Freedom Scientific\\JAWS\\2019\\Settings\\enu\\DEFAULT.JCF",
-                            "foldername": "${{environment}.APPDATA}\\Freedom Scientific\\JAWS\\2019\\Settings\\VoiceProfiles"
+                            "defaultSettingsFilePath": "${{environment}.APPDATA}\\Freedom Scientific\\JAWS\\2019\\Settings\\enu\\DEFAULT.JCF",
+                            "voiceProfilesDirPath": "${{environment}.APPDATA}\\Freedom Scientific\\JAWS\\2019\\Settings\\VoiceProfiles"
                         }
                     }
                 ]
@@ -201,8 +201,8 @@ gpii.tests.conflictingApps.testDefs = [
                             // "ENU-MenuAndDialog.Pitch": 11
                         },
                         "options": {
-                            "filename": "${{environment}.APPDATA}\\Freedom Scientific\\JAWS\\2019\\Settings\\enu\\DEFAULT.JCF",
-                            "foldername": "${{environment}.APPDATA}\\Freedom Scientific\\JAWS\\2019\\Settings\\VoiceProfiles"
+                            "defaultSettingsFilePath": "${{environment}.APPDATA}\\Freedom Scientific\\JAWS\\2019\\Settings\\enu\\DEFAULT.JCF",
+                            "voiceProfilesDirPath": "${{environment}.APPDATA}\\Freedom Scientific\\JAWS\\2019\\Settings\\VoiceProfiles"
                         }
                     }
                 ]

diff --git a/tests/platform/windows/windows-jaws-testSpec.js b/tests/platform/windows/windows-jaws-testSpec.js
@@ -129,8 +129,8 @@ gpii.tests.windows.jaws.testDefs = [
                             // "ENU-PCCursor.SynthLangString": "Italian"
                         },
                         "options": {
-                            "filename": "${{environment}.APPDATA}\\Freedom Scientific\\JAWS\\2019\\Settings\\enu\\DEFAULT.JCF",
-                            "foldername": "${{environment}.APPDATA}\\Freedom Scientific\\JAWS\\2019\\Settings\\VoiceProfiles"
+                            "defaultSettingsFilePath": "${{environment}.APPDATA}\\Freedom Scientific\\JAWS\\2019\\Settings\\enu\\DEFAULT.JCF",
+                            "voiceProfilesDirPath": "${{environment}.APPDATA}\\Freedom Scientific\\JAWS\\2019\\Settings\\VoiceProfiles"
                         }
                     }
                 ]
@@ -199,8 +199,8 @@ gpii.tests.windows.jaws.testDefs = [
                             // "ENU-PCCursor.SynthLangString": "Italian"
                         },
                         "options": {
-                            "filename": "${{environment}.APPDATA}\\Freedom Scientific\\JAWS\\2019\\Settings\\enu\\DEFAULT.JCF",
-                            "foldername": "${{environment}.APPDATA}\\Freedom Scientific\\JAWS\\2019\\Settings\\VoiceProfiles"
+                            "defaultSettingsFilePath": "${{environment}.APPDATA}\\Freedom Scientific\\JAWS\\2019\\Settings\\enu\\DEFAULT.JCF",
+                            "voiceProfilesDirPath": "${{environment}.APPDATA}\\Freedom Scientific\\JAWS\\2019\\Settings\\VoiceProfiles"
                         }
                     }
                 ]
@@ -268,8 +268,8 @@ gpii.tests.windows.jaws.testDefs = [
                             // "ENU-MenuAndDialog.SynthLangString": "French"
                         },
                         "options": {
-                            "filename": "${{environment}.APPDATA}\\Freedom Scientific\\JAWS\\2019\\Settings\\enu\\DEFAULT.JCF",
-                            "foldername": "${{environment}.APPDATA}\\Freedom Scientific\\JAWS\\2019\\Settings\\VoiceProfiles"
+                            "defaultSettingsFilePath": "${{environment}.APPDATA}\\Freedom Scientific\\JAWS\\2019\\Settings\\enu\\DEFAULT.JCF",
+                            "voiceProfilesDirPath": "${{environment}.APPDATA}\\Freedom Scientific\\JAWS\\2019\\Settings\\VoiceProfiles"
                         }
                     }
                 ]
@@ -336,8 +336,8 @@ gpii.tests.windows.jaws.testDefs = [
                             // "ENU-MenuAndDialog.SynthLangString": "Italian"
                         },
                         "options": {
-                            "filename": "${{environment}.APPDATA}\\Freedom Scientific\\JAWS\\2019\\Settings\\enu\\DEFAULT.JCF",
-                            "foldername": "${{environment}.APPDATA}\\Freedom Scientific\\JAWS\\2019\\Settings\\VoiceProfiles"
+                            "defaultSettingsFilePath": "${{environment}.APPDATA}\\Freedom Scientific\\JAWS\\2019\\Settings\\enu\\DEFAULT.JCF",
+                            "voiceProfilesDirPath": "${{environment}.APPDATA}\\Freedom Scientific\\JAWS\\2019\\Settings\\VoiceProfiles"
                         }
                     }
                 ]
@@ -405,8 +405,8 @@ gpii.tests.windows.jaws.testDefs = [
                             // "ENU-MenuAndDialog.SynthLangString": "French Canadian"
                         },
                         "options": {
-                            "filename": "${{environment}.APPDATA}\\Freedom Scientific\\JAWS\\2019\\Settings\\enu\\DEFAULT.JCF",
-                            "foldername": "${{environment}.APPDATA}\\Freedom Scientific\\JAWS\\2019\\Settings\\VoiceProfiles"
+                            "defaultSettingsFilePath": "${{environment}.APPDATA}\\Freedom Scientific\\JAWS\\2019\\Settings\\enu\\DEFAULT.JCF",
+                            "voiceProfilesDirPath": "${{environment}.APPDATA}\\Freedom Scientific\\JAWS\\2019\\Settings\\VoiceProfiles"
                         }
                     }
                 ]