Merge pull request #269 from novafloss/add-json-migrations

Add JSON migrations

Author: wo0dyn

CHANGELOG.rst

@@ -10,6 +10,7 @@ master (unreleased)
 - Added perf rec tests
 - Add configuration for py.test
 - Reactivate accidentally skipped ``test_validations.py`` tests
+- Add JSON migrations
 
 Release 1.0.2 (2017-10-10)
 ==========================

demo/tests/test_json_migrations.py

@@ -1,6 +1,5 @@
 import mock
 import os
-from copy import deepcopy
 
 from django.test import TestCase
 
@@ -12,18 +11,21 @@
 @mock.patch('formidable.json_migrations.package',
             'tests.json_migrations')
 class JSONMigrationTestCase(TestCase):
-    def setUp(self):
-        super(JSONMigrationTestCase, self).setUp()
-
-        self.data = deepcopy({
+    def _fixtures(self, version=None):
+        data = {
             'fields': [
                 {'foo': 'bar', 'help_text': 'SOS'},
                 {'foo': 'baz', 'help_text': 'SAS'},
             ]
-        })
+        }
+        if version:
+            data['version'] = version
+
+        return data
 
     def test_migration_from_scratch(self):
-        updated_data = migrate(self.data)
+        data = self._fixtures()
+        updated_data = migrate(data)
 
         self.assertEqual(updated_data, {
             'version': 2,
@@ -32,9 +34,11 @@ def test_migration_from_scratch(self):
                 {'foo': 'baz', 'description': 'SAS'},
             ]
         })
+        self.assertEqual(updated_data['version'], 2)
 
     def test_migration_from_version_1(self):
-        updated_data = migrate(self.data, 1)
+        data = self._fixtures(version=1)
+        updated_data = migrate(data, 1)
 
         self.assertEqual(updated_data, {
             'version': 2,
@@ -43,28 +47,33 @@ def test_migration_from_version_1(self):
                 {'foo': 'baz', 'help_text': 'SAS'},
             ],
         })
+        self.assertEqual(updated_data['version'], 2)
 
     def test_migration_from_version_2(self):
-        updated_data = migrate(self.data, 2)
-        self.assertEqual(updated_data, self.data)
+        data = self._fixtures(version=2)
+        updated_data = migrate(data, 2)
+        self.assertEqual(updated_data, data)
 
     @mock.patch('tests.json_migrations.0002_add_version.migrate')
     @mock.patch('tests.json_migrations.0001_rename_helptext.migrate')
     def test_migration_from_scratch_call_count(self, migrate_1, migrate_2):
-        migrate(self.data)
+        data = self._fixtures()
+        migrate(data)
         self.assertEqual(migrate_1.call_count, 1)
         self.assertEqual(migrate_2.call_count, 1)
 
     @mock.patch('tests.json_migrations.0002_add_version.migrate')
     @mock.patch('tests.json_migrations.0001_rename_helptext.migrate')
     def test_migration_from_version_1_call_count(self, migrate_1, migrate_2):
-        migrate(self.data, 1)
+        data = self._fixtures(version=1)
+        migrate(data, 1)
         self.assertEqual(migrate_1.call_count, 0)
         self.assertEqual(migrate_2.call_count, 1)
 
     @mock.patch('tests.json_migrations.0002_add_version.migrate')
     @mock.patch('tests.json_migrations.0001_rename_helptext.migrate')
     def test_migration_from_version_2_call_count(self, migrate_1, migrate_2):
-        migrate(self.data, 2)
+        data = self._fixtures(version=2)
+        migrate(data, 2)
         self.assertEqual(migrate_1.call_count, 0)
         self.assertEqual(migrate_2.call_count, 0)

formidable/__init__.py

@@ -1,2 +1,8 @@
+from __future__ import absolute_import
+
+from .json_migrations import latest_version
+
+
 default_app_config = 'formidable.app.FormidableConfig'
 version = '1.1.0.dev0'
+json_version = latest_version

formidable/forms/conditions.py

@@ -99,11 +99,12 @@ def __call__(self, cleaned_data):
 
         try:
             ref_value = cleaned_data[self.field_id]
-            return meth(ref_value, self.values)
-        except:
+        except KeyError:
             # KeyError if self.field_id not in cleaned_data
             # TODO XXX add log ?
             return False
+        else:
+            return meth(ref_value, self.values)
 
 
 class Condition(six.with_metaclass(ConditionsMetaClass)):

formidable/json_migrations/0001_add_version.py

@@ -0,0 +1,11 @@
+"""
+The field help_text has been renamed into description.
+
+"""
+
+
+def migrate(data):
+    if 'version' not in data:
+        data['version'] = 0
+
+    return data

formidable/json_migrations/0001_rename_helptext_to_description.py renamed to formidable/json_migrations/0002_rename_helptext_to_description.py

@@ -0,0 +1,10 @@
+"""
+Uncontextualize forms.
+
+"""
+
+from formidable.json_migrations.utils import merge_context_forms
+
+
+def migrate(data):
+    return merge_context_forms(data)

formidable/json_migrations/0003_uncontextualize_schema.py

@@ -0,0 +1,15 @@
+"""
+Add conditions as an empty list if it doesn't exist in the form.
+
+This JSON migration is related to:
+  * 0004_formidable_conditions
+  * 0005_conditions_default
+
+"""
+
+
+def migrate(data):
+    if 'conditions' not in data:
+        data.setdefault('conditions', [])
+
+    return data

formidable/json_migrations/0004_add_conditions.py

@@ -0,0 +1,15 @@
+"""
+The presets attribute must be removed.
+
+This JSON migration is related to:
+  * 0006_drop_preset_fields
+  * 0007_drop_preset_tables
+
+"""
+
+
+def migrate(data):
+    if 'presets' in data:
+        data.pop('presets')
+
+    return data

formidable/json_migrations/0005_drop_presets.py

@@ -3,14 +3,23 @@
 from glob import glob
 from importlib import import_module
 
-__all__ = ['migrate', 'get_migrations']
+__all__ = ['latest_version', 'migrate']
 
 HERE = os.path.dirname(__file__)
 
 package = sys.modules[__name__].__name__
 
 
-def get_migrations():
+def _get_migrations():
+    """
+    Return a generator with all JSON migrations sorted.
+
+    Each item is a tuple with:
+      - the version number (int)
+      - the label of the migration
+      - the reference to the migrate() function
+
+    """
     for module in sorted(glob(os.path.join(HERE, '[0-9]*.py'))):
         module_name, _ = os.path.basename(module).rsplit('.', 1)
         mod = import_module('.' + module_name, package=package)
@@ -21,8 +30,18 @@ def get_migrations():
 
 
 def migrate(data, version_src=0):
-    for version, label, func in list(get_migrations()):
+    """
+    Apply all migrations from ``version_src`` to the latest found on
+    ``data``.
+
+    """
+    for version, label, func in list(_get_migrations()):
         if version_src < version:
             data = func(data)
+            data['version'] = version
             version_src = version
+
     return data
+
+
+latest_version = max(migration[0] for migration in list(_get_migrations()))

formidable/json_migrations/__init__.py

@@ -40,9 +40,14 @@ def add_fields(ref_fields, new_fields):
 
 
 def merge_context_forms(forms):
-    # forms : role => ContextForm
+    # forms: role => ContextForm
     roles = list(forms.keys())
 
+    if {'description', 'fields', 'label', 'id'}.issubset(roles):
+        # If these keys are in the forms, the form is already
+        # uncontextualized.
+        return forms
+
     # Formidable and ContextForm JSON formats only differs by the field
     # attribute (and some missing attributes in ContextForm). We can copy
     # everything and overwrite `fields`.
@@ -61,4 +66,5 @@ def merge_context_forms(forms):
                     {'access_id': role, 'level': constants.HIDDEN}
                 )
     form['fields'] = fields
+
     return form