diff --git a/README.rst b/README.rst index e14d7fd..2bf5e33 100644 --- a/README.rst +++ b/README.rst @@ -197,7 +197,7 @@ Other fields ^^^^^^^^^^^^ Besides ``LocalizedField``, there's also: -* ``LocalizedMagicSlugField`` +* ``LocalizedUniqueSlugField`` Successor of ``LocalizedAutoSlugField`` that fixes concurrency issues and enforces uniqueness of slugs on a database level. Usage is the exact same: @@ -205,11 +205,11 @@ Besides ``LocalizedField``, there's also: from localized_fields.models import LocalizedModel from localized_fields.fields import (LocalizedField, - LocalizedMagicSlugField) + LocalizedUniqueSlugField) class MyModel(LocalizedModel): title = LocalizedField() - slug = LocalizedMagicSlugField(populate_from='title') + slug = LocalizedUniqueSlugField(populate_from='title') * ``LocalizedAutoSlugField`` Automatically creates a slug for every language from the specified field. @@ -226,7 +226,7 @@ Besides ``LocalizedField``, there's also: title = LocalizedField() slug = LocalizedAutoSlugField(populate_from='title') - This implementation is **NOT** concurrency safe, prefer ``LocalizedMagicSlugField``. + This implementation is **NOT** concurrency safe, prefer ``LocalizedUniqueSlugField``. * ``LocalizedBleachField`` Automatically bleaches the content of the field. diff --git a/localized_fields/__init__.py b/localized_fields/__init__.py index 60842a2..d8c8d05 100644 --- a/localized_fields/__init__.py +++ b/localized_fields/__init__.py @@ -1,7 +1,7 @@ from .util import get_language_codes from .forms import LocalizedFieldForm, LocalizedFieldWidget from .fields import (LocalizedField, LocalizedBleachField, - LocalizedAutoSlugField, LocalizedMagicSlugField) + LocalizedAutoSlugField, LocalizedUniqueSlugField) from .localized_value import LocalizedValue from .models import LocalizedModel @@ -10,7 +10,7 @@ __all__ = [ 'LocalizedField', 'LocalizedValue', 'LocalizedAutoSlugField', - 'LocalizedMagicSlugField', + 'LocalizedUniqueSlugField', 'LocalizedBleachField', 'LocalizedFieldWidget', 'LocalizedFieldForm', diff --git a/localized_fields/fields/__init__.py b/localized_fields/fields/__init__.py index b83087c..ad916f8 100644 --- a/localized_fields/fields/__init__.py +++ b/localized_fields/fields/__init__.py @@ -1,12 +1,12 @@ from .localized_field import LocalizedField from .localized_autoslug_field import LocalizedAutoSlugField -from .localized_magicslug_field import LocalizedMagicSlugField +from .localized_uniqueslug_field import LocalizedUniqueSlugField from .localized_bleach_field import LocalizedBleachField __all__ = [ 'LocalizedField', 'LocalizedAutoSlugField', - 'LocalizedMagicSlugField', + 'LocalizedUniqueSlugField', 'LocalizedBleachField', ] diff --git a/localized_fields/fields/localized_magicslug_field.py b/localized_fields/fields/localized_uniqueslug_field.py similarity index 92% rename from localized_fields/fields/localized_magicslug_field.py rename to localized_fields/fields/localized_uniqueslug_field.py index 50d7a34..05a8c6d 100644 --- a/localized_fields/fields/localized_magicslug_field.py +++ b/localized_fields/fields/localized_uniqueslug_field.py @@ -6,7 +6,7 @@ from .localized_autoslug_field import LocalizedAutoSlugField from ..util import get_language_codes -class LocalizedMagicSlugField(LocalizedAutoSlugField): +class LocalizedUniqueSlugField(LocalizedAutoSlugField): """Automatically provides slugs for a localized field upon saving." @@ -20,7 +20,7 @@ class LocalizedMagicSlugField(LocalizedAutoSlugField): """ def __init__(self, *args, **kwargs): - """Initializes a new instance of :see:LocalizedMagicSlugField.""" + """Initializes a new instance of :see:LocalizedUniqueSlugField.""" self.populate_from = kwargs.pop('populate_from') kwargs['uniqueness'] = kwargs.pop('uniqueness', get_language_codes()) diff --git a/tests/test_localized_slug_fields.py b/tests/test_localized_slug_fields.py index 566fd98..90f345d 100644 --- a/tests/test_localized_slug_fields.py +++ b/tests/test_localized_slug_fields.py @@ -5,7 +5,7 @@ from django.db.utils import IntegrityError from django.utils.text import slugify from localized_fields import (LocalizedField, LocalizedAutoSlugField, - LocalizedMagicSlugField) + LocalizedUniqueSlugField) from .fake_model import get_fake_model @@ -31,10 +31,10 @@ class LocalizedSlugFieldTestCase(TestCase): ) cls.MagicSlugModel = get_fake_model( - 'LocalizedMagicSlugFieldTestModel', + 'LocalizedUniqueSlugFieldTestModel', { 'title': LocalizedField(), - 'slug': LocalizedMagicSlugField(populate_from='title') + 'slug': LocalizedUniqueSlugField(populate_from='title') } ) @@ -92,7 +92,7 @@ class LocalizedSlugFieldTestCase(TestCase): @classmethod def test_deconstruct_magic(cls): - cls._test_deconstruct(LocalizedMagicSlugField) + cls._test_deconstruct(LocalizedUniqueSlugField) @classmethod def test_formfield_auto(cls): @@ -100,7 +100,7 @@ class LocalizedSlugFieldTestCase(TestCase): @classmethod def test_formfield_magic(cls): - cls._test_formfield(LocalizedMagicSlugField) + cls._test_formfield(LocalizedUniqueSlugField) @staticmethod def _test_populate(model):