ITST-17897: Leading/trailing zeroes are removed - Fixes 01: Detect "general" format correctly.

- Fix misinterpreting the style id as the number format id in formatValue().
- Add basic test for general format.
- Adjust in-code doc.

Author: rfischer42

lib/NumberFormat.php

@@ -235,8 +235,7 @@ public function tryFormatValue($value, $xf_id)
             return $this->formatValue($value, $xf_id);
         }
 
-        /* Do not format value, either because quotePrefix is set ($xf_id = null),
-         * or because "general" format should be applied ($xf_id = 0), which just outputs the value as-is. */
+        /* Do not format value, no style set or quotePrefix is set. ($xf_id = null, starts at 1) */
         return $value;
     }
 
@@ -289,15 +288,17 @@ private function convertNumberToDateTime($value)
      */
     public function formatValue($value, $xf_id)
     {
+        $num_fmt_id = 0;
         if (isset($this->xf_num_fmt_ids[$xf_id]) && $this->xf_num_fmt_ids[$xf_id] !== null) {
-            $xf_id = $this->xf_num_fmt_ids[$xf_id];
-        } else {
-            // Invalid format_index or the style was explicitly declared as "don't format anything".
+            $num_fmt_id = $this->xf_num_fmt_ids[$xf_id];
+        }
+        if ($num_fmt_id === 0) {
+            // Invalid format_index or "general" format should be applied ($num_fmt_id = 0), which just outputs the value as-is.
             return $value;
         }
 
         // Get definition of format for the given format_index.
-        $section = $this->getFormatSectionForValue($value, $xf_id);
+        $section = $this->getFormatSectionForValue($value, $num_fmt_id);
 
         // If percentage values are expected, multiply value accordingly before formatting.
         if ($section->isPercentage()) {
@@ -333,7 +334,7 @@ public function formatValue($value, $xf_id)
                     break;
                 default:
                     // Note: Should never happen. Exception is just to be safe.
-                    throw new RuntimeException('Specific datetime_type for format_index [' . $xf_id . '] is unknown.');
+                    throw new RuntimeException('Specific datetime_type for format_index [' . $num_fmt_id . '] is unknown.');
             }
         }
 

tests/CustomNumberFormatTest.php

@@ -11,6 +11,41 @@
 /** Check whether number formatting works properly for all sorts of custom formats. */
 class CustomNumberFormatTest extends TestCase
 {
+    /**
+     * Tests if the "general" format is correctly identified and applied.
+     *
+     * @dataProvider provideValuesForGeneralFormat
+     *
+     * @param  string $value
+     *
+     * @throws Exception
+     */
+    public function testGeneralFormat($value)
+    {
+        $cell_format = new NumberFormat();
+        $cell_format->injectXfNumFmtIds(
+            array(456 => 0) // Fake xf
+        );
+        $actual_output = $cell_format->formatValue($value, 456); // Apply numFmt of fake xf
+        self::assertSame(
+            $value, // General format should never change anything about the input value.
+            $actual_output,
+            'Unexpected formatting result for value [' . $value . '] with general format (number format 0).'
+        );
+    }
+
+    /**
+     * @return array
+     */
+    public function provideValuesForGeneralFormat()
+    {
+        return array(
+            'number'  => array('123'),
+            'decimal' => array('123.45'),
+            'string'  => array('abc')
+        );
+    }
+
     /**
      * @dataProvider provideFormats
      *