feat(web) - Use native number type input for Number() and Integer().

When editing hyperdb.Number() or hyperdb.Integer() properties, use a
native number input.

For Number you can enter digits, +/-, . and e/E for exponent (1E2 =
100).

For integer we have the same keys as number, but also add step=1 to
the input. This stops submitting 23.5 suggesting 23 or 24. It does
allow 2E4 to be submitted that is rejected with an error from the
backend. However if the spinner is used with 2E4 it is turned into
20000, a pure integer and incremented/decremented by the spinner.

The upgrade happens automatically. Directions on going back to text
input provided. User guide updated to describe addition of spinner.

Tests added.

Author: rouilj

CHANGES.txt

@@ -122,7 +122,9 @@ Features:
 - Added new templating utils.set_http_response(integer) method to
   allow reporting an error to the user from a template. (John
   Rouillard)
-	
+- Use native number type input for Number() and Integer()
+  properties. Integer() uses step=1 as well. (John Rouillard)
+
 2024-07-13 2.4.0
 
 Fixed:

doc/upgrading.txt

@@ -224,8 +224,8 @@ defusedxml.
 
 .. _defusedxml: https://pypi.org/project/defusedxml/
 
-Use native date inputs (optional)
----------------------------------
+Enable use of native date inputs (optional)
+-------------------------------------------
 
 Roundup now uses native date or datetime-local inputs for Date()
 properties. These inputs take the place of the text input and
@@ -308,6 +308,8 @@ changing it to::
 will generate the input as in Roundup 2.4 or earlier without a
 popcal link.
 
+.. _revert_input_to_text:
+
 If you are using a path expression like::
 
   tal:content="context/duedate/field"
@@ -366,6 +368,22 @@ There is no support for activating text mode using the
 keyboard. Tablet/touch support is mixed. Chrome supports
 double-tap to activate text mode input. Firefox does not.
 
+Revert native number inputs for Number() and Integer() (optional)
+-----------------------------------------------------------------
+
+Roundup's field() method for properties of type Number() or
+Integer() now use a native browser number input.
+
+You can use the old style text inputs by calling the field
+method with ``type="text"``. You can :ref:`follow the example
+for setting the text argument on a Date()
+property. <revert_input_to_text>` for details.
+
+Note that the Integer() type also uses ``step="1"`` by default to
+add a stepper control and try to constrain the input to
+integers. This can be overridden by passing a new step
+(e.g. ``step="50"``) to the field() method.
+
 Change in REST response for invalid CORS requests (info)
 --------------------------------------------------------
 

doc/user_guide.txt

@@ -131,7 +131,8 @@ Integer Properties
 ~~~~~~~~~~~~~~~~~~
 
 These fields take a whole/integer number without decimal marker like
-``123``, ``+123``, ``-123``. Exponents are not supported.
+``123``, ``+123``, ``-123``. Exponents are not supported. Your browser
+may show an up/down arrow spinner to change the value. 
 
 Boolean properties
 ~~~~~~~~~~~~~~~~~~

roundup/cgi/templating.py

@@ -2066,6 +2066,7 @@ def field(self, size=30, **kwargs):
         if value is None:
             value = ''
 
+        kwargs.setdefault("type", "number")
         return self.input(name=self._formname, value=value, size=size,
                           **kwargs)
 
@@ -2104,6 +2105,9 @@ def field(self, size=30, **kwargs):
         if value is None:
             value = ''
 
+        kwargs.setdefault("type", "number")
+        if kwargs["type"] == "number":
+            kwargs.setdefault("step", "1")
         return self.input(name=self._formname, value=value, size=size,
                           **kwargs)
 

test/test_templating.py

@@ -1253,6 +1253,118 @@ def test_string_rst(self):
         p = StringHTMLProperty(self.client, 'test', '1', None, 'test', u2s(u'A string with [email protected] *embedded* \u00df'))
         self.assertEqual(p.rst(), u2s(u'A string with <a href="mailto:[email protected]">[email protected]</a> *embedded* \u00df'))
 
+class NumberIntegerHTMLPropertyTestCase(HTMLPropertyTestClass):
+
+    def setUp(self):
+        super(NumberIntegerHTMLPropertyTestCase, self).setUp()
+
+        db = self.client.db
+        db.issue.addprop(numberval=hyperdb.Number())
+        db.issue.addprop(intval=hyperdb.Integer())
+
+        self.client.db.issue.create(title="title",
+                                    numberval = "3.14",
+                                    intval="314")
+
+    def tearDown(self):
+        self.client.db.close()
+        memorydb.db_nuke('')
+
+    def test_IntegerHTML(self):
+        test_hyperdbInteger = self.client.db.issue.getprops("1")['intval']
+        test_Integer = test_hyperdbInteger.from_raw(
+            self.client.db.issue.get("1", 'intval')
+        )
+
+        # client, classname, nodeid, prop, name, value,
+        #    anonymous=0, offset=None
+        d = IntegerHTMLProperty(self.client, 'issue', '1',
+                                test_hyperdbInteger,
+                                'intval', test_Integer)
+
+        self.assertIsInstance(d._value, int)
+
+        self.assertEqual(d.plain(), "314")
+
+        input_expected = """<input id="issue1@intval" name="issue1@intval" size="30" step="1" type="number" value="314">"""
+        self.assertEqual(d.field(), input_expected)
+
+        input_expected = """<input id="issue1@intval" name="issue1@intval" size="30" step="50" type="number" value="314">"""
+        self.assertEqual(d.field(step="50"), input_expected)
+
+        input_expected = """<input id="issue1@intval" name="issue1@intval" size="30" type="text" value="314">"""
+        self.assertEqual(d.field(type="text"), input_expected)
+
+
+        # check permissions return
+        is_view_ok_orig = d.is_view_ok
+        is_edit_ok_orig = d.is_edit_ok
+        no_access = lambda : False
+
+        d.is_view_ok = no_access
+        self.assertEqual(d.plain(), "[hidden]")
+
+        d.is_edit_ok = no_access
+        self.assertEqual(d.field(), "[hidden]")
+
+        d.is_view_ok = is_view_ok_orig
+        self.assertEqual(d.field(), "314")
+        d.is_edit_ok = is_edit_ok_orig
+
+    def test_NumberHTML(self):
+        test_hyperdbNumber = self.client.db.issue.getprops("1")['numberval']
+        test_Number = test_hyperdbNumber.from_raw(
+            self.client.db.issue.get("1", 'numberval')
+        )
+
+        # client, classname, nodeid, prop, name, value,
+        #    anonymous=0, offset=None
+        d = NumberHTMLProperty(self.client, 'issue', '1',
+                                test_hyperdbNumber,
+                                'numberval', test_Number)
+
+        # string needed for memorydb/anydbm backend. Float?? when
+        # running against sql backends.
+        self.assertIsInstance(d._value, float)
+
+        self.assertEqual(d._value, 3.14)
+
+        input_expected = """<input id="issue1@numberval" name="issue1@numberval" size="30" type="number" value="3.14">"""
+        self.assertEqual(d.field(), input_expected)
+
+        input_expected = """<input id="issue1@numberval" name="issue1@numberval" size="30" step="50" type="number" value="3.14">"""
+        self.assertEqual(d.field(step="50"), input_expected)
+
+        input_expected = """<input id="issue1@numberval" name="issue1@numberval" size="30" type="text" value="3.14">"""
+        self.assertEqual(d.field(type="text"), input_expected)
+
+        self.assertEqual(d.pretty("%0.3f"), "3.140")
+        self.assertEqual(d.pretty("%0.3d"), "003")
+        self.assertEqual(d.pretty("%2d"), " 3")
+
+        # see what happens if for other values
+        value = d._value
+        d._value = "1" # integer
+        self.assertEqual(d.pretty("%2d"), "1")
+        d._value = "I'mNotAFloat" # not a number
+        self.assertEqual(d.pretty("%2d"), "I'mNotAFloat")
+        d._value = value
+
+        # check permissions return
+        is_view_ok_orig = d.is_view_ok
+        is_edit_ok_orig = d.is_edit_ok
+        no_access = lambda : False
+
+        d.is_view_ok = no_access
+        self.assertEqual(d.plain(), "[hidden]")
+
+        d.is_edit_ok = no_access
+        self.assertEqual(d.field(), "[hidden]")
+
+        d.is_view_ok = is_view_ok_orig
+        self.assertEqual(d.field(), "3.14")
+        d.is_edit_ok = is_edit_ok_orig
+
 class ZUtilsTestcase(TemplatingTestCase):
 
     def test_Iterator(self):