Make native date and number elements configurable

Now for Number() and Integer() properties the browser-native number
format can be configured with the use_browser_number_input config item
in seciont [web]. The default is 'yes'. For Date() properties the config
item is use_browser_date_input (also in section [web]) but the default
is 'no'.

In addition when defining Date() properties, these now have a parameter
'display_time' which defaults to 'yes' and a 'format' parameter which
defaults to None. These set defaults for the field() method of the
DateHTMLProperty which have the same parameters (but the display_time
parameter of field() takes a boolean, not 'yes'/'no').

Author: schlatterbeck

.hgignore

@@ -47,3 +47,4 @@ website/www/COPYING.txt
 website/www/docs
 website/www/html/
 .pytest_cache
+.hypothesis

CHANGES.txt

@@ -79,8 +79,10 @@ Fixed:
   input fields. Thinko in the code. (John Rouillard)
 - issue2551390 - Replace text input/calendar popup with native
   date input. Also add double-click and exit keyboard handlers to
-  allow copy/paste/editing the text version of the date.  (John
-  Rouillard)
+  allow copy/paste/editing the text version of the date. Configurable
+  via the use_browser_date_input setting in the [web] section of
+  config.ini. By default browser native dates are turned off.
+  (John Rouillard, Ralf Schlatterbeck)
 - issue1895197 - translated help texts in admin.py not displayed
   correctly. (Initial patch tobias-herp, John Rouillard)
 - issue2551238 - roundup-server should exit with error if -d
@@ -129,7 +131,9 @@ Features:
   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)
+  properties. Integer() uses step=1 as well. Configurable via the
+  use_browser_number_input setting in the [web] section of config.ini
+  (John Rouillard, Ralf Schlatterbeck)
 - issue2551231 - template.py-HTMLClass::classhelp doesn't merge
   user defined classes. It now merges them in. (John Rouillard)
 

doc/customizing.txt

@@ -90,11 +90,11 @@ caches the schema).
       <td tal:content="structure context/due_date/field" /> 
      </tr>
 
-   If you want to show the date and time for due_date then do this instead::
+   If you want to show only the date part of due_date then do this instead:
 
     <tr> 
      <th>Due Date</th> 
-     <td tal:content="structure context/due_date/field_time" /> 
+     <td tal:content="structure python:context.due_date.field(display_time=False)" />
     </tr>
 
 3. Add the property to the ``issue.index.html`` page::

doc/reference.txt

@@ -3070,8 +3070,11 @@ There are several methods available on these wrapper objects:
 	      tri-state yes/no/neither selection. This method may take some
 	      arguments:
 
-	      size (default 30)
-		Sets the width in characters of the edit field
+              display_time (Date properties only)
+                By default this uses the display_time paramter of the
+                Date property (which by default is True) and displays
+                date and time for Date properties. You can set this to
+                False for displaying only the date.
 
 	      format (Date properties only)
                 Sets the format of the date in the field - uses the
@@ -3083,25 +3086,33 @@ There are several methods available on these wrapper objects:
 		text edit box with the year and month part of your
 		date.
 
-              type (depends on property type)
-                Sets the type property of the input. To change a date
-                property field from a native date input to a text
-                input you would use ``type="text"``.
+	      labelfirst (Boolean properties only)
+	        place the labels before the radio buttons
 
 	      popcal (Date properties only)
 		Include a link to the JavaScript-based popup calendar
-		for date selection. Defaults to off/False since native
-		date inputs supply popup calendars.
+		for date selection. Defaults to off/False when browser
+                native dates are in use and on/True otherwise because
+                browser native dates support a date popup on most
+                browsers.
+
+	      size (default 30)
+		Sets the width in characters of the edit field
+
+              type (depends on property type)
+                Sets the type property of the input. To change a date
+                property field from a native date input to a text
+                input you would use ``type="text"``. For Date properties
+                the type cannot be set by the user and is enforced via
+                the configuration (if browser native date input should
+                be used).
 
 	      y_label, n_label, u_label (Boolean properties only)
 	        Set the labels for the true/false/undefined
 		states. If u_label is defined, it produces a
 	        tri-state radio button selector. Otherwise, it
 		allows selection of true/yes or false/no only.
 
-	      labelfirst (Boolean properties only)
-	        place the labels before the radio buttons
-
               Other arguments are added as properties directly on the
               input tag. For example::
 
@@ -3115,11 +3126,6 @@ There are several methods available on these wrapper objects:
 	      attribute without a value. This is useful for boolean
 	      properties like ``required``.
 
-  field_time  (Date properties only)
-              Create a browser native input for editing date and time.
-              The field method creates an input for editing
-              month/day/year (without time).
-
   rst         only on String properties - render the value of the property
 	      as ReStructuredText (requires the :ref:`Docutils
 	      module to be installed separately<install/docutils>`).
@@ -3179,9 +3185,10 @@ There are several methods available on these wrapper objects:
 	      is returned if the value is ``None`` otherwise it
 	      is converted to a string.
 
-  popcal      This is deprecated with Roundup 2.5 which uses the
-              native HTML5 date input. The native date input
-              includes a calendar popup on modern broswers.
+  popcal      This is deprecated with Roundup 2.5 which either uses the
+              native HTML5 date input or can generate a date popup with
+              the popcal option of the ``field`` method. The native date
+              input includes a calendar popup on modern broswers.
 
               Generate a link to a popup calendar which may be used to
 	      edit the date field, for example::
@@ -3193,6 +3200,9 @@ There are several methods available on these wrapper objects:
 
 		<span tal:replace="structure context/due/field" />
 		<span tal:replace="structure context/due/popcal" />
+              
+              Since the ``field`` by default already produces a popup
+              calendar this use is deprecated.
 
   menu        only on Link and Multilink properties - render a form select
 	      list for this property. Takes a number of optional arguments

doc/tracker_config.txt

@@ -624,6 +624,26 @@
   # Default: disabled
   jwt_secret = disabled
 
+  # HTML input elements for Date properties: This determines
+  # if we use the input type 'datetime-local' (or 'date') for
+  # date input fields. If the option is turned off (the default),
+  # the type is set to 'text'. Since the widgets generated by
+  # browsers determine the date format from the language
+  # setting (it is currently not possible to force the
+  # international date format server-side) and some browsers
+  # ignore the date format set by the operating system, the
+  # default is 'no'.
+  # Allowed values: yes, no
+  # Default: no
+  use_browser_date_input = no
+
+  # HTML input elements for Number properties: This determines
+  # if we use the input type 'number' for Number (and Integer)
+  # properties. If set to 'no' we use input type 'text'.
+  # Allowed values: yes, no
+  # Default: yes
+  use_browser_number_input = no
+
 .. index:: config.ini; sections rdbms
 .. _`config-ini-section-rdbms`:
 .. code:: ini

doc/upgrading.txt

@@ -227,71 +227,74 @@ defusedxml.
 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
-calendar popup from earlier Roundup versions. Modern browsers
-come with a built-in calendar for date selection, so the
-``(cal)`` calendar link is no longer needed. These native inputs
-show the date based on the browser's locale and translate terms
-into the local language.
-
-If you do nothing, simple uses of the field() method will
-generate date inputs to allow selection of a date.  Input fields
-for Date() properties will not have the ``(cal)`` link
-anymore. Complex uses will not be upgraded and will operate like
-earlier Roundup versions.
-
-To upgrade all date properties, there are four changes to make:
-
-  1. Replace ``field`` calls with ``field_time`` where needed.
-
-  2. Remove the format argument from field() calls on Date()
+Roundup now can use native ``date`` or ``datetime-local`` inputs for
+``Date()`` properties. These inputs take the place of the text input and
+calendar popup from earlier Roundup versions. Modern browsers come with
+a built-in calendar for date selection, so the ``(cal)`` calendar link
+is no longer needed. These native inputs show the date based on the
+browser's locale and translate terms into the local language.
+
+Note that the date format is tied to the language setting in most
+browsers, with some browsers you need special configurations to make the
+browser use the operating system date format.
+
+By default the old input mechanism (using type=text inputs) is used.
+To enable native date input you need to set the config variable ::
+
+  use_browser_date_input = yes
+
+in section ``[web]`` in the ``config.ini`` file.
+ 
+If native date input is used, simple uses of the ``field()`` method will
+generate ``datetime-local`` inputs to allow selection of a date and time.
+Input fields for ``Date()`` properties will not have the ``(cal)`` link
+anymore. If fields should only use a date (without time) you can specify
+the parameter ``display_time=no`` in ``schema.py`` for a ``Date()``
+property (the default is ``yes``). This will use ``date`` inputs in the
+generated html to select a date only. If you need this only for a single
+date, the ``field()`` method now has a boolean parameter
+``display_time`` (which by default is set to the ``display_time``
+parameter of ``Date()``)
+
+Complex uses using a ``format`` specification in ``field()`` will not be
+upgraded and will operate like earlier Roundup versions. In addition the
+``format`` can now also be specified in the ``Date()`` constructor.
+
+To upgrade all date properties, there are five changes to make:
+
+  1. Configure ``use_browser_date_input = yes`` in section ``[web]`` in
+     ``config.ini``
+
+  2. Optionally add ``display_time = no`` in the schema for Date()
+     properties that should have no time displayed
+
+  3. Remove the format argument from field() calls on Date()
      properties.
 
-  3. Remove popcal() calls.
+  4. Remove popcal() calls.
+
+  5. Include datecopy.js in page.html.
 
-  4. Include datecopy.js in page.html.
+The ``display_time`` option
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Use field_time() where needed
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Both the ``Date()`` constructor and the ``field`` call take a
+``display_time`` option which by default is ``yes`` in the ``Date()``
+constructor and ``True`` in ``field``. The ``display_time`` setting of
+``Date()`` is inherited by the html property, so it doesn't need to be
+specified in each ``field()`` call for this property.
 
-The format used by ``field`` does not include hours, minutes or
-seconds. If your users need to enter times, you should change
-these calls to use ``field_time``. The arguments are the same as
-for field.
+When ``display_time`` is off, the date field does not include hours,
+minutes or seconds.
 
 Remove format argument
 ~~~~~~~~~~~~~~~~~~~~~~
 
-Speaking of arguments, avoid setting the date format if you want
-to use native date inputs. The date value needs a specific format
-for date or datetime-local inputs. If you include the `format`
-argument in the `field` method, it should be removed.
-
-The `field` method uses the format ``%Y-%m-%d``.  The
-``field_time`` method uses the format ``%Y-%m-%dT%H:%M:%S``. If
-you use these exact formats, Roundup will accept them and use a
-native date input.
-
-.. highlight:: text
-
-If you use an format that doesn't match, you will see a text
-input and a logged warning message like::
-
-  Format '%Y-%m' prevents use of modern date input.
-  Remove format from field() call in template test.item.
-  Using text input.
-
-.. highlight:: default
+Speaking of arguments, avoid setting the date ``format`` if you want to
+use native date inputs. If you include the `format` argument in the
+`field` method, it should be removed.
 
-The log message will appear if your logging level is set to
-WARNING or lower. (Refer to your tracker's :ref:`config.ini
-logging section <config-ini-section-logging>` for details on
-logging levels.)
-
-If you want to use a text input for a specific date format, you
-can add ``type="text"`` to the field() argument list to suppress
-the warning. By default using a format argument will show the
+By default using a format argument will show the
 popup calendar link. You can disable the link by setting
 ``popcal=False`` in the field() call. If you have::
 
@@ -301,38 +304,26 @@ popup calendar link. You can disable the link by setting
 changing it to::
 
   tal:content="structure python:context.duedate.field(
-               type='text',
                placeholder='YYYY-MM, format='%Y-%m',
                popcal=False)"
 
 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"
-
-change it to::
-
-  tal:content="structure python:context.duedate.field(
-               type='text')"
-
-to get the input from before Roundup 2.5 with a popcal link.
-
 Remove popcal
 ~~~~~~~~~~~~~
 
-If you use the ``popcal()`` method directly in your templates, you
-can remove them. The browser's native date selection calendar can
+if you have enabled date input types in the configuration and you
+use the ``popcal()`` method directly in your templates, you
+should remove them. The browser's native date selection calendar should
 be used instead.
 
 Add copy/paste/edit on double-click using datecopy.js
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-There is no way to copy/paste using a native datetime-local or
-date input. With the datecopy.js file installed, double-clicking
+When using date input types,
+there is no way to copy/paste using a native ``datetime-local`` or
+``date`` input. With the ``datecopy.js`` file installed, double-clicking
 on the input turns it into a normal text input with the ability
 to copy, paste, or manually edit the date.
 
@@ -371,18 +362,19 @@ 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.
+Roundup's ``field()`` method for properties of type ``Number()`` or
+``Integer()`` now use a native browser number input by default.
+
+This is configurable for *all* ``Number()`` and ``Integer()`` properties
+with the config option ``use_browser_number_input`` in section ``[web]``.
 
-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.
+You can use the old style text inputs for individual fields
+by calling the field method with ``type="text"``.
 
-Note that the Integer() type also uses ``step="1"`` by default to
+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.
+(e.g. ``step="50"``) to the ``field()`` method.
 
 Change in REST response for invalid CORS requests (info)
 --------------------------------------------------------

doc/user_guide.txt

@@ -132,7 +132,7 @@ Integer Properties
 
 These fields take a whole/integer number without decimal marker like
 ``123``, ``+123``, ``-123``. Exponents are not supported. Your browser
-may show an up/down arrow spinner to change the value. 
+may show an up/down arrow spinner to change the value.
 
 Boolean properties
 ~~~~~~~~~~~~~~~~~~
@@ -178,9 +178,11 @@ Classhelper`_ for details.
 Date properties
 ~~~~~~~~~~~~~~~
 
-Date properties are usually shown using a native HTML date
-element. This provides a calendar button for choosing the
-date. The date is shown in the normal format for your location.
+Date properties can be shown using a native HTML date (or
+datetime-local) element by setting ``use_browser_date_input=yes`` in
+section ``[web]`` in ``config.ini``. This provides a calendar button for
+choosing the date. The date is shown in the normal format for your
+location.
 
 Native date inputs do not allow the use of partial forms as
 defined below.  For this reason, you may edit a date/time