Ticket #20998: refactor-gis-widgets-WIP.diff

django/contrib/gis/admin/widgets.py

@@ -25 +25 @@
         # Defaulting the WKT value to a blank string -- this
         # will be tested in the JavaScript and the appropriate
         # interface will be constructed.
-        self.params['wkt'] = ''
+        self.params['serialized'] = ''
 
         # If a string reaches here (via a validation error on another
         # field) then just reconstruct the Geometry.
         if isinstance(value, six.string_types):
-            try:
-                value = GEOSGeometry(value)
-            except (GEOSException, ValueError) as err:
-                logger.error(
-                    "Error creating geometry from value '%s' (%s)" % (
-                    value, err)
-                )
-                value = None
+            value = self._deserialize(value)
 
         if (value and value.geom_type.upper() != self.geom_type and
                 self.geom_type != 'GEOMETRY'):
@@ -56 +49 @@
         self.params['module'] = 'geodjango_%s' % js_safe_name
 
         if value:
-            # Transforming the geometry to the projection used on the
-            # OpenLayers map.
-            srid = self.params['srid']
-            if value.srid != srid:
-                try:
-                    ogr = value.ogr
-                    ogr.transform(srid)
-                    wkt = ogr.wkt
-                except OGRException as err:
-                    logger.error(
-                        "Error transforming geometry from srid '%s' to srid '%s' (%s)" % (
-                        value.srid, srid, err)
-                    )
-                    wkt = ''
-            else:
-                wkt = value.wkt
-
-            # Setting the parameter WKT with that of the transformed
-            # geometry.
-            self.params['wkt'] = wkt
+            value = self._transform(value)
+            serialized = self._serialize(value)
+            self.params['serialized'] = serialized
 
         return loader.render_to_string(self.template, self.params,
                                        context_instance=geo_context)
 
+    def _deserialize(self, value):
+        try:
+            return GEOSGeometry(value)
+        except (GEOSException, ValueError) as err:
+            logger.error(
+                "Error creating geometry from value '%s' (%s)" % (
+                value, err)
+            )
+        return None
+
+    def _transform(self, value):
+        # Transforming the geometry to the projection used on the
+        # OpenLayers map.
+        srid = self.params['srid']
+        if value.srid != srid:
+            try:
+                ogr = value.ogr
+                ogr.transform(srid)
+                value = ogr
+            except OGRException as err:
+                logger.error(
+                    "Error transforming geometry from srid '%s' to srid '%s' (%s)" % (
+                    value.srid, srid, err)
+                )
+                return None
+        return value
+
+    def _serialize(self, value):
+        # Returning the parameter WKT with that of the transformed
+        # geometry.
+        return value.wkt if value else ''
+
     def map_options(self):
         "Builds the map options hash for the OpenLayers template."
 

django/contrib/gis/forms/widgets.py

@@ -38 +38 @@
         # If a string reaches here (via a validation error on another
         # field) then just reconstruct the Geometry.
         if isinstance(value, six.string_types):
-            try:
-                value = GEOSGeometry(value)
-            except (GEOSException, ValueError) as err:
-                logger.error(
-                    "Error creating geometry from value '%s' (%s)" % (
-                    value, err)
-                )
-                value = None
+            value = self._deserialize(value)
 
-        wkt = ''
+        serialized = ''
         if value:
-            # Check that srid of value and map match
-            if value.srid != self.map_srid:
-                try:
-                    ogr = value.ogr
-                    ogr.transform(self.map_srid)
-                    wkt = ogr.wkt
-                except gdal.OGRException as err:
-                    logger.error(
-                        "Error transforming geometry from srid '%s' to srid '%s' (%s)" % (
-                        value.srid, self.map_srid, err)
-                    )
-            else:
-                wkt = value.wkt
+            value = self._transform(value)
+            serialized = self._serialize(value)
 
         context = self.build_attrs(attrs,
             name=name,
             module='geodjango_%s' % name.replace('-','_'),  # JS-safe
-            wkt=wkt,
+            serialized=serialized,
             geom_type=gdal.OGRGeomType(self.attrs['geom_type']),
             STATIC_URL=settings.STATIC_URL,
             LANGUAGE_BIDI=translation.get_language_bidi(),
         )
         return loader.render_to_string(self.template_name, context)
 
+    def _deserialize(self, value):
+        try:
+            return GEOSGeometry(value)
+        except (GEOSException, ValueError) as err:
+            logger.error(
+                "Error creating geometry from value '%s' (%s)" % (
+                value, err)
+            )
+        return None
+
+    def _transform(self, value):
+        # Check that srid of value and map match
+        if value.srid != self.map_srid:
+            try:
+                ogr = value.ogr
+                ogr.transform(self.map_srid)
+                value = ogr
+            except gdal.OGRException as err:
+                logger.error(
+                    "Error transforming geometry from srid '%s' to srid '%s' (%s)" % (
+                    value.srid, self.map_srid, err)
+                )
+        return value
+
+    def _serialize(self, value):
+        return value.wkt
+
 
 class OpenLayersWidget(BaseGeometryWidget):
     template_name = 'gis/openlayers.html'

django/contrib/gis/templates/gis/admin/openlayers.html

@@ -33 +33 @@
 <div id="{{ id }}_map"{% if LANGUAGE_BIDI %} dir="ltr"{% endif %}></div>
 <a href="javascript:{{ module }}.clearFeatures()">Delete all Features</a>
 {% if display_wkt %}<p> WKT debugging window:</p>{% endif %}
-<textarea id="{{ id }}" class="vWKTField required" cols="150" rows="10" name="{{ name }}">{{ wkt }}</textarea>
+<textarea id="{{ id }}" class="vWKTField required" cols="150" rows="10" name="{{ name }}">{{ serialized }}</textarea>
 <script type="text/javascript">{% block init_function %}{{ module }}.init();{% endblock %}</script>
 </span>

django/contrib/gis/templates/gis/openlayers.html

@@ -17 +17 @@
     <div id="{{ id }}_map"></div>
     <span class="clear_features"><a href="javascript:{{ module }}.clearFeatures()">Delete all Features</a></span>
     {% if display_wkt %}<p> WKT debugging window:</p>{% endif %}
-    <textarea id="{{ id }}" class="vWKTField required" cols="150" rows="10" name="{{ name }}">{{ wkt }}</textarea>
+    <textarea id="{{ id }}" class="vWKTField required" cols="150" rows="10" name="{{ name }}">{{ serialized }}</textarea>
     <script type="text/javascript">
         {% block map_options %}var map_options = {};{% endblock %}
         {% block options %}var options = {