From f5549795d50178ae530a95a468aeda2b3a8e8b9f Mon Sep 17 00:00:00 2001
From: Mike Gerwitz <gerwitm@lovullo.com>
Date: Mon, 20 Jun 2016 10:52:11 -0400
Subject: [PATCH] GeneralStepUi vformat styling

* package.json (devDependencies): Add sinon

* src/ui/step/GeneralStepUi.js (answerDataUpdate): Attempt formatting with
  formatter prior to "old" answer styling.

* test/ui/step/GeneralStepUiTest.js: Added
---
 package.json.in                   |   1 +
 src/ui/step/GeneralStepUi.js      |   4 +-
 test/ui/step/GeneralStepUiTest.js | 138 ++++++++++++++++++++++++++++++
 3 files changed, 142 insertions(+), 1 deletion(-)
 create mode 100644 test/ui/step/GeneralStepUiTest.js

diff --git a/package.json.in b/package.json.in
index 3742cba..4c4cff8 100644
--- a/package.json.in
+++ b/package.json.in
@@ -20,6 +20,7 @@
   "devDependencies": {
     "chai":   ">=1.9.1",
     "mocha":  ">=1.18.2",
+    "sinon":  ">=1.17.4",
     "es6-promise": "~3"
   },
 
diff --git a/src/ui/step/GeneralStepUi.js b/src/ui/step/GeneralStepUi.js
index e4f8e7c..3500848 100644
--- a/src/ui/step/GeneralStepUi.js
+++ b/src/ui/step/GeneralStepUi.js
@@ -446,13 +446,15 @@ module.exports = Class( 'StepUi' )
     {
         var _self = this;
 
+        var data_fmt = _self._formatter.format( data );
+
         // give the UI a chance to update the DOM; otherwise, the
         // answer elements we update may no longer be used (this also
         // has performance benefits since it allows repainting before
         // potentially heavy processing)
         setTimeout( function()
         {
-            _self._updateAnswerFieldData( data );
+            _self._updateAnswerFieldData( data_fmt );
         }, 25 );
     },
 
diff --git a/test/ui/step/GeneralStepUiTest.js b/test/ui/step/GeneralStepUiTest.js
new file mode 100644
index 0000000..01796d7
--- /dev/null
+++ b/test/ui/step/GeneralStepUiTest.js
@@ -0,0 +1,138 @@
+/**
+ * Test case for GeneralStepUi
+ *
+ *  Copyright (C) 2016 LoVullo Associates, Inc.
+ *
+ *  This file is part of the Liza Data Collection Framework
+ *
+ *  Liza is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+var Sut     = require( '../../../' ).ui.step.GeneralStepUi,
+    expect  = require( 'chai' ).expect,
+    sinon   = require( 'sinon' ),
+    Class   = require( 'easejs' ).Class;
+
+
+describe( 'ui.GeneralStepUi', function()
+{
+    describe( 'on answer data change', function()
+    {
+        it( 'will attempt pre-style with formatter', function( done )
+        {
+            var orig_data = {
+                    foo: [ "orig" ],
+                },
+                fmt_data  = {
+                    foo: [ "formatted" ],
+                };
+
+            var formatter = createFormatter(),
+                mock_fmt  = sinon.mock( formatter );
+
+            mock_fmt.expects( 'format' )
+                .once()
+                .withExactArgs( orig_data )
+                .returns( fmt_data );
+
+            createSut( formatter, function( name, value )
+            {
+                // by the time the answer data makes its way to the
+                // element styler, it should have already been
+                // formatted
+                expect( name ).to.equal( 'foo' );
+                expect( value ).to.equal( fmt_data.foo[ 0 ] );
+
+                mock_fmt.verify();
+                done();
+            } ).answerDataUpdate( orig_data );
+        } );
+    } );
+} );
+
+
+
+/**
+ * Create new SUT with formatter FORMATTER and generated element
+ * styler
+ *
+ * @param {Object}             formatter      validator/formatter mock
+ * @param {function(string,*)} style_callback styler styleAnswer method dfn
+ *
+ * @return {Sut}
+ */
+function createSut( formatter, style_callback )
+{
+    return Sut.extend(
+    {
+        // visibility escalation
+        'override answerDataUpdate': function( data )
+        {
+            return this.__super( data );
+        },
+
+        'override getAnswerContext': function( name )
+        {
+            return {};
+        },
+    } )(
+        {},
+        createElementStyler( style_callback ),
+        formatter
+    );
+}
+
+
+/**
+ * Create mock ElementStyler
+ *
+ * styleAnswer method is defined by STYLE_CALLBACK
+ *
+ * @return {Object} ElementStyler mock
+ */
+function createElementStyler( style_callback )
+{
+    return {
+        getAnswerElementByName: function()
+        {
+            // jQuery element
+            return {
+                attributes: [],
+                length:     1,
+
+                text: function() {},
+            }
+        },
+
+        styleAnswer: style_callback,
+    };
+}
+
+
+/**
+ * Create mock validator/formatter
+ *
+ * The only method provided is `format', which contains no definition;
+ * it is expected to be mocked by the caller.
+ *
+ * @param {Object}
+ */
+function createFormatter( expected, return_data )
+{
+    return {
+        format: function()
+        {
+        },
+    }
+}