Merge branch 'GPII-2429'

* jobara/GPII-2429: GPII-2429: Typo, used heads down camelCase instead of heads up. NOJIRA: Removing old TODO file GPII-2429: Update supported adaptations in README GPII-2429: Bumping version number in manifest. GPII-2429: Adding Character Spacing Preference GPII-2429: Updating to work with latest Infusion.
GPII · Apr 9, 2018 · 5f52d94 · 5f52d94
2 parents 350b941 + 05c24cf
commit 5f52d94
Show file tree

Hide file tree

Showing 14 changed files with 235 additions and 49 deletions.
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -57,7 +57,8 @@ module.exports = function (grunt) {
             "node_modules/infusion/src/framework/enhancement/js/ContextAwareness.js",
             "node_modules/infusion/src/framework/enhancement/js/ProgressiveEnhancement.js",
             "node_modules/infusion/src/components/tableOfContents/js/TableOfContents.js",
-            "node_modules/infusion/src/framework/preferences/js/Enactors.js"
+            "node_modules/infusion/src/framework/preferences/js/Enactors.js",
+            "node_modules/infusion/src/framework/preferences/js/LetterSpaceEnactor.js"
         ],
         adjustersLib: [
             // jQuery
@@ -101,7 +102,9 @@ module.exports = function (grunt) {
             "node_modules/infusion/src/framework/preferences/js/PrefsEditor.js",
             "node_modules/infusion/src/framework/preferences/js/Panels.js",
             "node_modules/infusion/src/framework/preferences/js/SelfVoicingPanel.js",
+            "node_modules/infusion/src/framework/preferences/js/LetterSpacePanel.js",
             "node_modules/infusion/src/framework/preferences/js/Enactors.js",
+            "node_modules/infusion/src/framework/preferences/js/LetterSpaceEnactor.js",
             "node_modules/infusion/src/framework/preferences/js/StarterGrades.js",
             "node_modules/infusion/src/framework/preferences/js/ArrowScrolling.js",
             "node_modules/infusion/src/framework/preferences/js/SeparatedPanelPrefsEditor.js",
@@ -110,6 +113,7 @@ module.exports = function (grunt) {
             "node_modules/infusion/src/framework/preferences/js/AuxBuilder.js",
             "node_modules/infusion/src/framework/preferences/js/StarterSchemas.js",
             "node_modules/infusion/src/framework/preferences/js/SelfVoicingSchemas.js",
+            "node_modules/infusion/src/framework/preferences/js/LetterSpaceSchemas.js",
             "node_modules/infusion/src/framework/preferences/js/Builder.js",
 
             // from extension
@@ -121,6 +125,7 @@ module.exports = function (grunt) {
             "node_modules/infusion/src/components/tableOfContents/html/TableOfContents.html",
             "node_modules/infusion/src/framework/preferences/html/PrefsEditorTemplate-textSize.html",
             "node_modules/infusion/src/framework/preferences/html/PrefsEditorTemplate-lineSpace.html",
+            "node_modules/infusion/src/framework/preferences/html/PrefsEditorTemplate-letterSpace.html",
             "node_modules/infusion/src/framework/preferences/html/PrefsEditorTemplate-contrast.html",
             "node_modules/infusion/src/framework/preferences/html/PrefsEditorTemplate-layout.html",
             "node_modules/infusion/src/framework/preferences/html/PrefsEditorTemplate-enhanceInputs.html",

diff --git a/README.md b/README.md
@@ -6,6 +6,7 @@ The following adaptations are supported:
 
 * Text Size
 * Line Space
+* Character Space
 * Contrast
 * Right-Click to Select
 * Selection Highlight

diff --git a/TODO.md b/TODO.md
diff --git a/extension/manifest.json b/extension/manifest.json
@@ -2,7 +2,7 @@
     "manifest_version": 2,
     "name": "UI Options Plus (UIO+)",
     "short_name": "UIO+",
-    "version": "0.1.0.2",
+    "version": "0.1.0.3",
     "description": "User Interface Options Plus (UIO+) allows you to customize websites to match your own personal needs and preferences.",
     "author": "Fluid Project",
     "permissions": [

diff --git a/extension/messages/charSpace.json b/extension/messages/charSpace.json
@@ -0,0 +1,6 @@
+{
+    "label": "Character Spacing",
+    "description": "Adjust the spacing between characters",
+    "increaseLabel": "increase character spacing",
+    "decreaseLabel": "decrease character spacing"
+}
diff --git a/extension/src/content_scripts/domEnactor.js b/extension/src/content_scripts/domEnactor.js
@@ -71,6 +71,14 @@
                     }
                 }
             },
+            charSpace: {
+                type: "gpii.chrome.enactor.charSpace",
+                options: {
+                    model: {
+                        value: "{domEnactor}.model.characterSpace"
+                    }
+                }
+            },
             inputsLarger: {
                 type: "gpii.chrome.enactor.inputsLarger",
                 options: {
@@ -145,6 +153,20 @@
         }
     });
 
+    // Character space
+    fluid.defaults("gpii.chrome.enactor.charSpace", {
+        gradeNames: ["fluid.prefs.enactor.letterSpace"],
+        fontSizeMap: {
+            "xx-small": "9px",
+            "x-small": "11px",
+            "small": "13px",
+            "medium": "15px",
+            "large": "18px",
+            "x-large": "23px",
+            "xx-large": "30px"
+        }
+    });
+
     // Inputs larger
     fluid.defaults("gpii.chrome.enactor.inputsLarger", {
         gradeNames: ["fluid.prefs.enactor.enhanceInputs"],

diff --git a/extension/src/lib/PrefsEditor.js b/extension/src/lib/PrefsEditor.js
@@ -25,6 +25,7 @@
             "preferences.gpii_chrome_prefs_contrast": "settings.contrastTheme",
             "preferences.fluid_prefs_enhanceInputs": "settings.inputsLargerEnabled",
             "preferences.gpii_chrome_prefs_lineSpace": "settings.lineSpace",
+            "preferences.fluid_prefs_letterSpace": "settings.characterSpace",
             "preferences.fluid_prefs_tableOfContents": "settings.tableOfContentsEnabled",
             "preferences.gpii_chrome_prefs_textSize": "settings.fontSize",
             "preferences.fluid_prefs_speak": "settings.selfVoicingEnabled",
@@ -166,7 +167,7 @@
         gradeNames: ["fluid.prefs.panel.textSize"],
         preferenceMap: {
             "gpii.chrome.prefs.textSize": {
-                "model.textSize": "default",
+                "model.value": "default",
                 "range.min": "minimum",
                 "range.max": "maximum",
                 "step": "divisibleBy"
@@ -178,7 +179,7 @@
         gradeNames: ["fluid.prefs.panel.lineSpace"],
         preferenceMap: {
             "gpii.chrome.prefs.lineSpace": {
-                "model.lineSpace": "default",
+                "model.value": "default",
                 "range.min": "minimum",
                 "range.max": "maximum",
                 "step": "divisibleBy"
@@ -276,6 +277,15 @@
                     "template": "%templatePrefix/PrefsEditorTemplate-lineSpace.html"
                 }
             },
+            "charSpace": {
+                "type": "fluid.prefs.letterSpace",
+                "panel": {
+                    "type": "fluid.prefs.panel.letterSpace",
+                    "container": ".flc-prefsEditor-char-space",
+                    "message": "%messagePrefix/charSpace.json",
+                    "template": "%templatePrefix/PrefsEditorTemplate-letterSpace.html"
+                }
+            },
             "contrast": {
                 "type": "gpii.chrome.prefs.contrast",
                 "classes": {

diff --git a/extension/src/lib/domSettingsApplier.js b/extension/src/lib/domSettingsApplier.js
@@ -34,6 +34,7 @@ fluid.defaults("gpii.chrome.domSettingsApplier", {
         // Accepted model values:
         // settings.contrastTheme: string,
         // settings.lineSpace: number,    // the multiplier to the current line space
+        // settings.characterSpace: number,
         // settings.inputsLarger: boolean,
         // settings.selectionTheme: string,
         // settings.simplifiedUiEnabled: boolean,

diff --git a/extension/templates/PrefsEditorPanel.html b/extension/templates/PrefsEditorPanel.html
@@ -3,6 +3,7 @@
         <ul class="fl-prefsEditor-panels">
             <li class="flc-prefsEditor-panel fl-prefsEditor-panel"><div class="flc-prefsEditor-text-size"></div></li>
             <li class="flc-prefsEditor-panel fl-prefsEditor-panel"><div class="flc-prefsEditor-line-space"></div></li>
+            <li class="flc-prefsEditor-panel fl-prefsEditor-panel"><div class="flc-prefsEditor-char-space"></div></li>
             <li class="flc-prefsEditor-panel fl-prefsEditor-panel"><div class="flc-prefsEditor-contrast"></div></li>
             <li class="flc-prefsEditor-panel fl-prefsEditor-panel"><div class="flc-prefsEditor-clickToSelect"></div></li>
             <li class="flc-prefsEditor-panel fl-prefsEditor-panel"><div class="flc-prefsEditor-selectionHighlight"></div></li>

diff --git a/package.json b/package.json
@@ -29,7 +29,7 @@
       "test": "node tests/node/all-tests.js"
   },
   "dependencies": {
-    "infusion": "3.0.0-dev.20180227T185528Z.08741e844",
+    "infusion": "3.0.0-dev.20180312T184056Z.e4d2974d2",
     "ws": "1.1.0"
   },
   "devDependencies": {

diff --git a/tests/browser/html/domEnactorTests.html b/tests/browser/html/domEnactorTests.html
@@ -39,6 +39,9 @@ <h2 id="qunit-userAgent"></h2>
         </div>
         <div class="gpii-test-contrast"></div>
         <div class="gpii-test-lineSpace" style="line-height: 1.2;"></div>
+        <div style="font-size: 16px;">
+            <div class="gpii-test-charSpace" style="letter-spacing: 0.2em;"></div>
+        </div>
         <div class="gpii-test-inputsLarger">
             <button></button>
         </div>

diff --git a/tests/browser/html/prefsEditorTests.html b/tests/browser/html/prefsEditorTests.html
@@ -33,6 +33,7 @@ <h2 id="qunit-userAgent"></h2>
 
         <div class="gpiic-textSize"></div>
         <div class="gpiic-lineSpace"></div>
+        <div class="gpiic-charSpace"></div>
         <div class="gpiic-contrast"></div>
         <div class="gpiic-highlight"></div>
         <div class="gpiic-simplify"></div>

diff --git a/tests/browser/js/domEnactorTests.js b/tests/browser/js/domEnactorTests.js
@@ -391,6 +391,76 @@
             }]
         });
 
+        /*************************
+         * Character Space Tests *
+         *************************/
+
+        fluid.defaults("gpii.tests.charSpaceTests", {
+            gradeNames: ["fluid.test.testEnvironment"],
+            components: {
+                charSpace: {
+                    type: "fluid.prefs.enactor.letterSpace",
+                    container: ".gpii-test-charSpace",
+                    options: {
+                        model: {
+                            value: 1
+                        }
+                    }
+                },
+                charSpaceTester: {
+                    type: "fluid.tests.charSpaceTester"
+                }
+            }
+        });
+
+        gpii.tests.charSpaceTests.assertCharSpace = function (that, expectedValue, baseCharSpace) {
+            baseCharSpace = baseCharSpace || 0;
+            var expectedUnit = fluid.roundToDecimal(expectedValue - 1, 2);
+            var expectedLetterSpacing = fluid.roundToDecimal(baseCharSpace + expectedUnit, 2) + "em";
+            jqUnit.assertEquals("The model value should be set to " + expectedValue, expectedValue, that.model.value);
+            jqUnit.assertEquals("The model unit should be set to " + expectedUnit, expectedUnit, that.model.unit);
+            jqUnit.assertEquals("The letter-spacing should be set to " + expectedLetterSpacing, "letter-spacing: " + expectedLetterSpacing + ";", that.container.attr("style"));
+        };
+
+        fluid.defaults("fluid.tests.charSpaceTester", {
+            gradeNames: ["fluid.test.testCaseHolder"],
+            modules: [{
+                name: "Character Space Tests",
+                tests: [{
+                    name: "Model Changes",
+                    expect: 12,
+                    sequence: [{
+                        func: "gpii.tests.charSpaceTests.assertCharSpace",
+                        args: ["{charSpace}", 1, 0.2]
+                    }, {
+                        func: "{charSpace}.applier.change",
+                        args: ["value", 1.3]
+                    }, {
+                        changeEvent: "{charSpace}.applier.modelChanged",
+                        path: "value",
+                        listener: "gpii.tests.charSpaceTests.assertCharSpace",
+                        args: ["{charSpace}", 1.3, 0.2]
+                    }, {
+                        func: "{charSpace}.applier.change",
+                        args: ["value", 2]
+                    }, {
+                        changeEvent: "{charSpace}.applier.modelChanged",
+                        path: "value",
+                        listener: "gpii.tests.charSpaceTests.assertCharSpace",
+                        args: ["{charSpace}", 2, 0.2]
+                    }, {
+                        func: "{charSpace}.applier.change",
+                        args: ["value", 1]
+                    }, {
+                        changeEvent: "{charSpace}.applier.modelChanged",
+                        path: "value",
+                        listener: "gpii.tests.charSpaceTests.assertCharSpace",
+                        args: ["{charSpace}", 1, 0.2]
+                    }]
+                }]
+            }]
+        });
+
         /***********************
          * Inputs Larger Tests *
          ***********************/
@@ -652,6 +722,7 @@
             "gpii.tests.selectionHighlightTests",
             "gpii.tests.contrastTests",
             "gpii.tests.lineSpaceTests",
+            "gpii.tests.charSpaceTests",
             "gpii.tests.inputsLargerTests",
             "gpii.tests.tocTests",
             "gpii.tests.domEnactorTests",