[ADD] util.invert_boolean_field

New helper for renaming and inverting the meaning of a boolean field.

closes #127

Signed-off-by: Christophe Simonis (chs) <[email protected]>

Author: KangOl

src/base/tests/test_util.py

@@ -807,6 +807,63 @@ def test_create_cron(self):
         self.assertEqual(cron.code, "answer = 42")
 
 
+class TestField(UnitTestCase):
+    def test_invert_boolean_field(self):
+        cr = self.env.cr
+
+        with self.assertRaises(ValueError):
+            util.invert_boolean_field(cr, "res.partner", "name", "nom")
+
+        fltr = self.env["ir.filters"].create(
+            {"name": "test", "model_id": "ir.model.data", "domain": "[('noupdate', '=', True)]"}
+        )
+
+        query = """
+            SELECT {0}, count(*)
+              FROM ir_model_data
+          GROUP BY {0}
+        """
+
+        cr.execute(util.format_query(cr, query, "noupdate"))
+        initial_repartition = dict(cr.fetchall())
+
+        # util.parallel_execute will `commit` the cursor and create new ones
+        # as we are in a test, we should not commit as we are in a subtransaction
+        with mock.patch.object(cr, "commit", lambda: ...):
+            util.invert_boolean_field(cr, "ir.model.data", "noupdate", "yesupdate")
+
+        util.invalidate(fltr)
+        self.assertEqual(literal_eval(fltr.domain), ["!", ("yesupdate", "=", True)])
+
+        cr.execute(util.format_query(cr, query, "yesupdate"))
+        inverted_repartition = dict(cr.fetchall())
+
+        self.assertEqual(inverted_repartition[False], initial_repartition[True])
+        self.assertEqual(inverted_repartition[True], initial_repartition[False] + initial_repartition.get(None, 0))
+        self.assertEqual(inverted_repartition.get(None, 0), 0)
+
+        # rename back
+        with mock.patch.object(cr, "commit", lambda: ...):
+            util.rename_field(cr, "ir.model.data", "yesupdate", "noupdate")
+
+        util.invalidate(fltr)
+        self.assertEqual(literal_eval(fltr.domain), ["!", ("noupdate", "=", True)])
+
+        # invert with same name; will invert domains and data
+        with mock.patch.object(cr, "commit", lambda: ...):
+            util.invert_boolean_field(cr, "ir.model.data", "noupdate", "noupdate")
+
+        util.invalidate(fltr)
+        self.assertEqual(literal_eval(fltr.domain), ["!", "!", ("noupdate", "=", True)])
+
+        cr.execute(util.format_query(cr, query, "noupdate"))
+        back_repartition = dict(cr.fetchall())
+
+        # merge None into False in the initial repartition
+        initial_repartition[False] += initial_repartition.pop(None, 0)
+        self.assertEqual(back_repartition, initial_repartition)
+
+
 class TestHelpers(UnitTestCase):
     def test_model_table_convertion(self):
         cr = self.env.cr

src/util/fields.py

@@ -48,6 +48,7 @@ def make_index_name(table_name, column_name):
     alter_column_type,
     column_exists,
     column_type,
+    explode_execute,
     explode_query_range,
     format_query,
     get_value_or_en_translation,
@@ -580,6 +581,26 @@ def rename_field(cr, model, old, new, update_references=True, domain_adapter=Non
         rename_field(cr, inh.model, old, new, update_references=update_references, skip_inherit=skip_inherit)
 
 
+def invert_boolean_field(cr, model, old, new, skip_inherit=()):
+    """Rename a boolean field and invert its value."""
+    _validate_model(model)
+    table = table_of_model(cr, model)
+    if column_type(cr, table, old) != "bool":
+        raise ValueError("Field {!r} of model {!r} is not a stored boolean field".format(old, model))
+
+    def _adapter(leaf, _or, _neg):
+        return ["!", leaf]
+
+    if old == new:
+        # same name but inverted value, just adapt domains
+        adapt_domains(cr, model, old, new, adapter=_adapter, skip_inherit=skip_inherit, force_adapt=True)
+    else:
+        rename_field(cr, model, old, new, update_references=True, domain_adapter=_adapter, skip_inherit=skip_inherit)
+
+    query = format_query(cr, "UPDATE {t} SET {c} = {c} IS NOT TRUE", t=table, c=new)
+    explode_execute(cr, query, table=table)
+
+
 def convert_field_to_html(cr, model, field, skip_inherit=()):
     _validate_model(model)
     table = table_of_model(cr, model)