Add support for an integer type to join the existing number type.

rouilj · rouilj · commit 39d368fa53fb · 2016-06-05T00:17:26.000-04:00
Commit patch supplied for issue2550886. This can be used for
properties used for ordering, counts etc. where a decimal point
isn't needed. Developed by Anthony (antmail). Doc updates written by
John Rouillard.
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -28,6 +28,11 @@ Features:
 - Allow multiple file uploads: If the html template specifies
   multiple="multiple" for a file upload the user can attach multiple
   files and the form parser now handles this. (Ralf Schlatterbeck)
+- issue2550886: Add support for an integer type to join the existing
+  number type. This can be used for properties used for ordering,
+  counts etc. where a decimal point isn't needed. Developed by
+  Anthony (antmail). Doc updates written by John Rouillard. (applied
+  by John Rouillard)
 
 Fixed:
 
diff --git a/doc/FAQ.txt b/doc/FAQ.txt
@@ -204,8 +204,9 @@ How is sorting performed, and why does it seem to fail sometimes?
 When we sort items in the hyperdb, we use one of a number of methods,
 depending on the properties being sorted on:
 
-1. If it's a String, Number, Date or Interval property, we just sort the
-   scalar value of the property. Strings are sorted case-sensitively.
+1. If it's a String, Integer, Number, Date or Interval property, we
+   just sort the scalar value of the property. Strings are sorted
+   case-sensitively.
 2. If it's a Link property, we sort by either the linked item's "order"
    property (if it has one) or the linked item's "id".
 3. Mulitlinks sort similar to #2, but we start with the first
diff --git a/doc/customizing.txt b/doc/customizing.txt
@@ -655,6 +655,7 @@ A Class is comprised of one or more properties of the following types:
   class.
 * Date properties store date-and-time stamps. Their values are Timestamp
   objects.
+* Integer properties store integer values. (Number can store real/float values.)
 * Number properties store numeric values.
 * Boolean properties store on/off, yes/no, true/false values.
 * A Link property refers to a single other item selected from a
@@ -814,8 +815,9 @@ A note about ordering
 When we sort items in the hyperdb, we use one of a number of methods,
 depending on the properties being sorted on:
 
-1. If it's a String, Number, Date or Interval property, we just sort the
-   scalar value of the property. Strings are sorted case-sensitively.
+1. If it's a String, Integer, Number, Date or Interval property, we
+   just sort the scalar value of the property. Strings are sorted
+   case-sensitively.
 2. If it's a Link property, we sort by either the linked item's "order"
    property (if it has one) or the linked item's "id".
 3. Mulitlinks sort similar to #2, but we start with the first Multilink
@@ -1660,7 +1662,7 @@ None of the above (ie. just a simple form value)
     they are valid for the class).  Otherwise, the property
     is set to the form value.
 
-    For Date(), Interval(), Boolean(), and Number()
+    For Date(), Interval(), Boolean(), Integer() and Number()
     properties, the form value is converted to the
     appropriate
 
diff --git a/doc/design.txt b/doc/design.txt
@@ -227,6 +227,8 @@ A property may be one of five basic types:
 
 - Boolean properties are for storing true/false, or yes/no values.
 
+- Integer properties are for storing Integer (non real) numeric values.
+
 - Number properties are for storing numeric values.
 
 - Date properties store date-and-time stamps. Their values are Timestamp
@@ -263,6 +265,10 @@ properties belong in classes::
         def __init__(self):
             """An object designating a Boolean property."""
 
+    class Integer:
+        def __init__(self):
+            """An object designating an Integer property."""
+
     class Number:
         def __init__(self):
             """An object designating a Number property."""
@@ -1024,7 +1030,7 @@ the printed results:
 
 - Strings are, well, strings.
 
-- Numbers are displayed the same as strings.
+- Integers/Numbers are displayed the same as strings.
 
 - Booleans are displayed as 'Yes' or 'No'.
 
@@ -1646,7 +1652,7 @@ and Dean Tribble for their assistance with the first-round submission.
 Changes to this document
 ------------------------
 
-- Added Boolean and Number types
+- Added Boolean, Integer and Number types
 - Added section Hyperdatabase Implementations
 - "Item" has been renamed to "Issue" to account for the more specific
   nature of the Class.
diff --git a/roundup/backends/back_anydbm.py b/roundup/backends/back_anydbm.py
@@ -1001,6 +1001,12 @@ def create_inner(self, **propvalues):
                 except ValueError:
                     raise TypeError('new property "%s" not numeric'%key)
 
+            elif value is not None and isinstance(prop, hyperdb.Integer):
+                try:
+                    int(value)
+                except ValueError:
+                    raise TypeError('new property "%s" not an integer'%key)
+
             elif value is not None and isinstance(prop, hyperdb.Boolean):
                 try:
                     int(value)
@@ -1342,6 +1348,13 @@ def set_inner(self, nodeid, **propvalues):
                     raise TypeError('new property "%s" not '
                         'numeric'%propname)
 
+            elif value is not None and isinstance(prop, hyperdb.Integer):
+                try:
+                    int(value)
+                except ValueError:
+                    raise TypeError('new property "%s" not '
+                        'numeric'%propname)
+
             elif value is not None and isinstance(prop, hyperdb.Boolean):
                 try:
                     int(value)
@@ -1748,6 +1761,14 @@ def _filter(self, search_matches, filterspec, proptree,
                         v = [v]
                 l.append((OTHER, k, [float(val) for val in v]))
 
+            elif isinstance(propclass, hyperdb.Integer):
+                if type(v) != type([]):
+                    try :
+                        v = v.split(',')
+                    except AttributeError :
+                        v = [v]
+                l.append((OTHER, k, [int(val) for val in v]))
+
         filterspec = l
 
         # now, find all the nodes that are active and pass filtering
diff --git a/roundup/backends/back_mysql.py b/roundup/backends/back_mysql.py
@@ -129,6 +129,7 @@ class Database(Database):
         hyperdb.Password  : 'VARCHAR(255)',
         hyperdb.Boolean   : 'BOOL',
         hyperdb.Number    : 'REAL',
+        hyperdb.Integer   : 'INTEGER',
     }
 
     hyperdb_to_sql_value = {
@@ -140,6 +141,7 @@ class Database(Database):
         hyperdb.Password  : str,
         hyperdb.Boolean   : int,
         hyperdb.Number    : lambda x: x,
+        hyperdb.Integer   : int,
         hyperdb.Multilink : lambda x: x,    # used in journal marshalling
     }
 
@@ -299,6 +301,8 @@ def add_new_columns_v2(self):
                         v = date.Interval(v)
                     elif isinstance(prop, Password) and v is not None:
                         v = password.Password(encrypted=v)
+                    elif isinstance(prop, Integer) and v is not None:
+                        v = int(v)
                     elif (isinstance(prop, Boolean) or
                             isinstance(prop, Number)) and v is not None:
                         v = float(v)
diff --git a/roundup/backends/back_sqlite.py b/roundup/backends/back_sqlite.py
@@ -51,6 +51,7 @@ class Database(rdbms_common.Database):
         hyperdb.Password  : 'VARCHAR(255)',
         hyperdb.Boolean   : 'BOOLEAN',
         hyperdb.Number    : 'REAL',
+        hyperdb.Integer   : 'INTEGER',
     }
     hyperdb_to_sql_value = {
         hyperdb.String : str,
@@ -59,6 +60,7 @@ class Database(rdbms_common.Database):
         hyperdb.Interval  : str,
         hyperdb.Password  : str,
         hyperdb.Boolean   : int,
+        hyperdb.Integer   : int,
         hyperdb.Number    : lambda x: x,
         hyperdb.Multilink : lambda x: x,    # used in journal marshalling
     }
@@ -69,6 +71,7 @@ class Database(rdbms_common.Database):
         hyperdb.Interval  : date.Interval,
         hyperdb.Password  : lambda x: password.Password(encrypted=x),
         hyperdb.Boolean   : int,
+        hyperdb.Integer   : int,
         hyperdb.Number    : rdbms_common._num_cvt,
         hyperdb.Multilink : lambda x: x,    # used in journal marshalling
     }
diff --git a/roundup/backends/rdbms_common.py b/roundup/backends/rdbms_common.py
@@ -57,7 +57,7 @@
 # roundup modules
 from roundup import hyperdb, date, password, roundupdb, security, support
 from roundup.hyperdb import String, Password, Date, Interval, Link, \
-    Multilink, DatabaseError, Boolean, Number, Node
+    Multilink, DatabaseError, Boolean, Number, Integer, Node
 from roundup.backends import locking
 from roundup.i18n import _
 
@@ -464,6 +464,7 @@ def reindex(self, classname=None, show_progress=False):
         hyperdb.Password  : 'VARCHAR(255)',
         hyperdb.Boolean   : 'BOOLEAN',
         hyperdb.Number    : 'REAL',
+        hyperdb.Integer   : 'INTEGER',
     }
 
     def hyperdb_to_sql_datatype(self, propclass):
@@ -871,6 +872,7 @@ def clear(self):
         hyperdb.Password  : str,
         hyperdb.Boolean   : lambda x: x and 'TRUE' or 'FALSE',
         hyperdb.Number    : lambda x: x,
+        hyperdb.Integer   : lambda x: x,
         hyperdb.Multilink : lambda x: x,    # used in journal marshalling
     }
 
@@ -1084,6 +1086,7 @@ def setnode(self, classname, nodeid, values, multilink_changes={}):
         hyperdb.Password  : lambda x: password.Password(encrypted=x),
         hyperdb.Boolean   : _bool_cvt,
         hyperdb.Number    : _num_cvt,
+        hyperdb.Integer   : int,
         hyperdb.Multilink : lambda x: x,    # used in journal marshalling
     }
 
@@ -1632,6 +1635,12 @@ def create_inner(self, **propvalues):
                 except ValueError:
                     raise TypeError('new property "%s" not numeric'%key)
 
+            elif value is not None and isinstance(prop, Integer):
+                try:
+                    int(value)
+                except ValueError:
+                    raise TypeError('new property "%s" not integer'%key)
+
             elif value is not None and isinstance(prop, Boolean):
                 try:
                     int(value)
@@ -1931,6 +1940,12 @@ def set_inner(self, nodeid, **propvalues):
                 except ValueError:
                     raise TypeError('new property "%s" not numeric'%propname)
 
+            elif value is not None and isinstance(prop, Integer):
+                try:
+                    int(value)
+                except ValueError:
+                    raise TypeError('new property "%s" not integer'%propname)
+
             elif value is not None and isinstance(prop, Boolean):
                 try:
                     int(value)
diff --git a/roundup/cgi/actions.py b/roundup/cgi/actions.py
@@ -363,6 +363,8 @@ def handle(self):
                         value = value.lower() in ('yes', 'true', 'on', '1')
                     elif isinstance(prop, hyperdb.Number):
                         value = float(value)
+                    elif isinstance(prop, hyperdb.Integer):
+                        value = int(value)
                     d[name] = value
                 elif exists:
                     # nuke the existing value
diff --git a/roundup/cgi/form_parser.py b/roundup/cgi/form_parser.py
@@ -135,7 +135,7 @@ def parse(self, create=0, num_re=re.compile('^\d+$')):
                 they are valid for the class).  Otherwise, the property
                 is set to the form value.
 
-                For Date(), Interval(), Boolean(), and Number()
+                For Date(), Interval(), Boolean(), and Number(), Integer()
                 properties, the form value is converted to the
                 appropriate
 
@@ -519,7 +519,7 @@ def parse(self, create=0, num_re=re.compile('^\d+$')):
                         # some backends store "missing" Strings as empty strings
                         if existing == self.db.BACKEND_MISSING_STRING:
                             existing = None
-                    elif isinstance(proptype, hyperdb.Number):
+                    elif isinstance(proptype, hyperdb.Number) or isinstance(proptype, hyperdb.Integer):
                         # some backends store "missing" Numbers as 0 :(
                         if existing == self.db.BACKEND_MISSING_NUMBER:
                             existing = None
diff --git a/roundup/cgi/templating.py b/roundup/cgi/templating.py
@@ -1201,7 +1201,7 @@ def HTMLItem(client, classname, nodeid, anonymous=0):
         return _HTMLItem(client, classname, nodeid, anonymous)
 
 class HTMLProperty(HTMLInputMixin, HTMLPermissions):
-    """ String, Number, Date, Interval HTMLProperty
+    """ String, Integer, Number, Date, Interval HTMLProperty
 
         Has useful attributes:
 
@@ -1605,6 +1605,38 @@ def __float__(self):
         """
         return float(self._value)
 
+class IntegerHTMLProperty(HTMLProperty):
+    def plain(self, escape=0):
+        """ Render a "plain" representation of the property
+        """
+        if not self.is_view_ok():
+            return self._('[hidden]')
+
+        if self._value is None:
+            return ''
+
+        return str(self._value)
+
+    def field(self, size=30, **kwargs):
+        """ Render a form edit field for the property.
+
+            If not editable, just display the value via plain().
+        """
+        if not self.is_edit_ok():
+            return self.plain(escape=1)
+
+        value = self._value
+        if value is None:
+            value = ''
+
+        return self.input(name=self._formname, value=value, size=size,
+                          **kwargs)
+
+    def __int__(self):
+        """ Return an int of me
+        """
+        return int(self._value)
+
 
 class BooleanHTMLProperty(HTMLProperty):
     def plain(self, escape=0):
@@ -2352,6 +2384,7 @@ def menu(self, size=None, height=None, showid=0, additional=[],
 propclasses = [
     (hyperdb.String, StringHTMLProperty),
     (hyperdb.Number, NumberHTMLProperty),
+    (hyperdb.Integer, IntegerHTMLProperty),
     (hyperdb.Boolean, BooleanHTMLProperty),
     (hyperdb.Date, DateHTMLProperty),
     (hyperdb.Interval, IntervalHTMLProperty),
diff --git a/roundup/hyperdb.py b/roundup/hyperdb.py
@@ -296,6 +296,17 @@ def from_raw(self, value, **kw):
             raise HyperdbValueError, _('property %s: %r is not a number')%(
                 kw['propname'], value)
         return value
+
+class Integer(_Type):
+    """An object designating an integer property"""
+    def from_raw(self, value, **kw):
+        value = value.strip()
+        try:
+            value = int(value)
+        except ValueError:
+            raise HyperdbValueError, _('property %s: %r is not an integer')%(
+                kw['propname'], value)
+        return value
 #
 # Support for splitting designators
 #
diff --git a/roundup/instance.py b/roundup/instance.py
@@ -121,6 +121,7 @@ def open(self, name=None):
             'Interval': hyperdb.Interval,
             'Boolean': hyperdb.Boolean,
             'Number': hyperdb.Number,
+            'Integer': hyperdb.Integer,
             'db': backend.Database(self.config, name)
         }
 
diff --git a/test/db_test_base.py b/test/db_test_base.py
@@ -22,7 +22,7 @@
 
 import pytest
 from roundup.hyperdb import String, Password, Link, Multilink, Date, \
-    Interval, DatabaseError, Boolean, Number, Node
+    Interval, DatabaseError, Boolean, Number, Node, Integer
 from roundup.mailer import Mailer
 from roundup import date, password, init, instance, configuration, \
     roundupdb, i18n
@@ -82,7 +82,7 @@ def setupSchema(db, create, module):
     priority.setkey("name")
     user = module.Class(db, "user", username=String(), password=Password(),
         assignable=Boolean(), age=Number(), roles=String(), address=String(),
-        supervisor=Link('user'),realname=String())
+        rating=Integer(), supervisor=Link('user'),realname=String())
     user.setkey("username")
     file = module.FileClass(db, "file", name=String(), type=String(),
         comment=String(indexme="yes"), fooz=Password())
@@ -534,6 +534,25 @@ def testNumberUnset(self):
         self.db.user.set(nid, age=None)
         self.assertEqual(self.db.user.get(nid, "age"), None)
 
+    # Integer
+    def testIntegerChange(self):
+        nid = self.db.user.create(username='foo', rating=100)
+        self.assertEqual(100, self.db.user.get(nid, 'rating'))
+        self.db.user.set(nid, rating=300)
+        self.assertNotEqual(self.db.user.get(nid, 'rating'), 100)
+        self.db.user.set(nid, rating=-1)
+        self.assertEqual(self.db.user.get(nid, 'rating'), -1)
+        self.db.user.set(nid, rating=0)
+        self.assertEqual(self.db.user.get(nid, 'rating'), 0)
+
+        nid = self.db.user.create(username='bar', rating=0)
+        self.assertEqual(self.db.user.get(nid, 'rating'), 0)
+
+    def testIntegerUnset(self):
+        nid = self.db.user.create(username='foo', rating=1)
+        self.db.user.set(nid, rating=None)
+        self.assertEqual(self.db.user.get(nid, "rating"), None)
+
     # Password
     def testPasswordChange(self):
         x = password.Password('x')
diff --git a/test/test_cgi.py b/test/test_cgi.py
diff --git a/test/test_hyperdbvals.py b/test/test_hyperdbvals.py
diff --git a/test/test_templating.py b/test/test_templating.py
