Added bidimensional_separator setting/kwarg (#29)

* Added bidimensional_seperator kwarg

Added bidimensional_seperator kwarg to MeasurementField. This changes the option label upon rendering.

This can be defined two ways-
1. Add a setting "BIDIMENSIONAL_SEPERATOR" to settings.py, which will be default unless kwarg is supplied.
2. Passing kwarg bidimensional_seperator to instantiation of a particular MeasurementField.
Example- if kwarg bidimensional_seperator=' per ' you would get a label of 'kg per s'. Otherwise, a default of "/" will be used.

Using this project for large-scale engineering applications, I had a need for each level of complexity provided, so hopefully it's useful to others.

* Added BIDIMENSIONAL_SEPERATOR setting

Added BIDIMENSIONAL_SEPERATOR setting

* Corrected spelling of BIDIMENSIONAL_SEPARATOR

* Updated test_unicode_labels

Updated test_unicode_labels to reflect new bidimensional_separator functionality

* Corrected spelling of BIDIMENSIONAL_SEPARATOR

* Updated bidimensional_separator assertion

* Update forms.py

* Update forms.py

* Update forms.py

* Added bidimensional_seperator kwarg explanation

* Update forms.rst

* Update forms.rst

* Update forms.rst

* Added BIDIMENSIONAL_SEPERATOR setting to appconf

New conf.py file for Measurement

* Updated to use conf.py

Now uses conf.py to fetch BIDIMENSIONAL_SEPARATOR

* Added django-appconf

Added django-appconf>=1.0.2 for handling of app settings

* Added django-appconf

Added django-appconf>=1.0.2

* Flake tests and import updates

* whitespace cleanup for pep257

* whitespace cleanup for pep257

Author: iansprice

django_measurement/conf.py

@@ -0,0 +1,21 @@
+# -*- coding: utf-8 -*-
+"""Settings for django-measurement."""
+from __future__ import absolute_import, unicode_literals
+
+from appconf import AppConf
+from django.conf import settings
+
+__all__ = ('settings', 'DjangoMeasurementConf')
+
+
+class DjangoMeasurementConf(AppConf):
+
+    """Settings for django-measurement."""
+
+    BIDIMENSIONAL_SEPARATOR = '/'
+    """
+    For measurement classes subclassing a BidimensionalMeasure, this .
+    """
+
+    class Meta:
+        prefix = 'measurement'

django_measurement/forms.py

@@ -6,8 +6,10 @@
 from django import forms
 from django.core.validators import MaxValueValidator, MinValueValidator
 from measurement.base import BidimensionalMeasure, MeasureBase
+from six import string_types
 
-from . import utils
+from django_measurement import utils
+from django_measurement.conf import settings
 
 
 class MeasurementWidget(forms.MultiWidget):
@@ -47,7 +49,9 @@ def decompress(self, value):
 
 class MeasurementField(forms.MultiValueField):
     def __init__(self, measurement, max_value=None, min_value=None,
-                 unit_choices=None, validators=None, *args, **kwargs):
+                 unit_choices=None, validators=None,
+                 bidimensional_separator=settings.MEASUREMENT_BIDIMENSIONAL_SEPARATOR,
+                 *args, **kwargs):
 
         if not issubclass(measurement, (MeasureBase, BidimensionalMeasure)):
             raise ValueError(
@@ -57,12 +61,16 @@ def __init__(self, measurement, max_value=None, min_value=None,
         self.measurement_class = measurement
         if not unit_choices:
             if issubclass(measurement, BidimensionalMeasure):
+                assert isinstance(bidimensional_separator, string_types), \
+                    "Supplied bidimensional_separator for %s must be of string/unicode type;" \
+                    " Instead got type %s" % (measurement, str(type(bidimensional_separator)),)
                 unit_choices = tuple((
                     (
                         '{0}__{1}'.format(primary, reference),
-                        '{0}__{1}'.format(
+                        '{0}{1}{2}'.format(
                             getattr(measurement.PRIMARY_DIMENSION, 'LABELS', {}).get(
                                 primary, primary),
+                            bidimensional_separator,
                             getattr(measurement.REFERENCE_DIMENSION, 'LABELS', {}).get(
                                 reference, reference)),
                     )

docs/topics/forms.rst

@@ -40,3 +40,12 @@ If unicode symbols are needed in the labels for a MeasurementField, define a LAB
             'f':u'°F',
             'k':u'°K',
         }
+        
+For a `MeasurementField` that represents a `BidimensionalMeasure`, you can set the separator either in settings.py (`MEASUREMENT_BIDIMENSIONAL_SEPARATOR is '/'` by default, add setting to override for all BiDimensionalMeasure subclasses) or override for an individual field with the kwarg bidimensional_separator::
+
+        speed = MeasurementField(
+            measurement=Speed,
+            bidimensional_separator=' per '
+        )
+        
+        # Rendered option labels will now be in the format "ft per s", "m per hr", etc

docs/topics/settings.rst

@@ -2,15 +2,11 @@
 Settings
 ========
 
-``MEASURE_OVERRIDES``
----------------------
 
-If you have your own measures to add, 
-you can specify a name for your measure and a string class path to allow
-for your custom measure to be properly stored and resurrected.::
+``MEASUREMENT_BIDIMENSIONAL_SEPARATOR``
+---------------------
+For any BidimensionalMeasure, what is placed between the primary and reference dimensions on rendered label
 
-    MEASURE_OVERRIDES = {
-        'IU': 'path.to.my.class.IUMeasure'
-    }
+    MEASUREMENT_BIDIMENSIONAL_SEPARATOR = " per "
 
-You can also override existing measure classes this way.
+Defaults to "/". Can be overriden as kwarg `bidimensional_separator` for a given MeasurementField.

requirements-dev.txt

@@ -5,6 +5,7 @@
 #    pip-compile requirements-dev.in
 #
 -e .
+django-appconf>=1.0.2
 flake8==2.5.0
 isort==4.2.2
 mccabe==0.3.1             # via flake8

requirements.txt

@@ -1 +1,2 @@
+django-appconf>=1.0.2
 measurement>=1.6

setup.py

@@ -9,7 +9,7 @@
 
 setup(
     name='django-measurement',
-    version='2.3.0',
+    version='2.4.0',
     url='http://github.com/coddingtonbear/django-measurement/',
     description='Convenient fields and classes for handling measurements',
     author='Adam Coddington',

tests/test_fields.py

@@ -273,5 +273,5 @@ def test_unicode_labels(self):
         assert ('Ps', 'Ps') in si_form.fields['simple'].fields[1].choices
 
         bi_dim_form = BiDimensionalLabelTestForm()
-        assert ('c__ms', u'°C__ms') in bi_dim_form.fields['simple'].fields[1].choices
-        assert ('c__Ps', u'°C__Ps') in bi_dim_form.fields['simple'].fields[1].choices
+        assert ('c__ms', u'°C/ms') in bi_dim_form.fields['simple'].fields[1].choices
+        assert ('c__Ps', u'°C/Ps') in bi_dim_form.fields['simple'].fields[1].choices