Rename LocalizedMagicSlugField to LocalizedUniqueSlugField

This commit is contained in:
Swen Kooij 2017-02-03 10:27:30 +02:00
parent 759d03133b
commit 5db87763fb
5 changed files with 15 additions and 15 deletions

View File

@ -197,7 +197,7 @@ Other fields
^^^^^^^^^^^^ ^^^^^^^^^^^^
Besides ``LocalizedField``, there's also: Besides ``LocalizedField``, there's also:
* ``LocalizedMagicSlugField`` * ``LocalizedUniqueSlugField``
Successor of ``LocalizedAutoSlugField`` that fixes concurrency issues and enforces Successor of ``LocalizedAutoSlugField`` that fixes concurrency issues and enforces
uniqueness of slugs on a database level. Usage is the exact same: 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.models import LocalizedModel
from localized_fields.fields import (LocalizedField, from localized_fields.fields import (LocalizedField,
LocalizedMagicSlugField) LocalizedUniqueSlugField)
class MyModel(LocalizedModel): class MyModel(LocalizedModel):
title = LocalizedField() title = LocalizedField()
slug = LocalizedMagicSlugField(populate_from='title') slug = LocalizedUniqueSlugField(populate_from='title')
* ``LocalizedAutoSlugField`` * ``LocalizedAutoSlugField``
Automatically creates a slug for every language from the specified field. Automatically creates a slug for every language from the specified field.
@ -226,7 +226,7 @@ Besides ``LocalizedField``, there's also:
title = LocalizedField() title = LocalizedField()
slug = LocalizedAutoSlugField(populate_from='title') slug = LocalizedAutoSlugField(populate_from='title')
This implementation is **NOT** concurrency safe, prefer ``LocalizedMagicSlugField``. This implementation is **NOT** concurrency safe, prefer ``LocalizedUniqueSlugField``.
* ``LocalizedBleachField`` * ``LocalizedBleachField``
Automatically bleaches the content of the field. Automatically bleaches the content of the field.

View File

@ -1,7 +1,7 @@
from .util import get_language_codes from .util import get_language_codes
from .forms import LocalizedFieldForm, LocalizedFieldWidget from .forms import LocalizedFieldForm, LocalizedFieldWidget
from .fields import (LocalizedField, LocalizedBleachField, from .fields import (LocalizedField, LocalizedBleachField,
LocalizedAutoSlugField, LocalizedMagicSlugField) LocalizedAutoSlugField, LocalizedUniqueSlugField)
from .localized_value import LocalizedValue from .localized_value import LocalizedValue
from .models import LocalizedModel from .models import LocalizedModel
@ -10,7 +10,7 @@ __all__ = [
'LocalizedField', 'LocalizedField',
'LocalizedValue', 'LocalizedValue',
'LocalizedAutoSlugField', 'LocalizedAutoSlugField',
'LocalizedMagicSlugField', 'LocalizedUniqueSlugField',
'LocalizedBleachField', 'LocalizedBleachField',
'LocalizedFieldWidget', 'LocalizedFieldWidget',
'LocalizedFieldForm', 'LocalizedFieldForm',

View File

@ -1,12 +1,12 @@
from .localized_field import LocalizedField from .localized_field import LocalizedField
from .localized_autoslug_field import LocalizedAutoSlugField from .localized_autoslug_field import LocalizedAutoSlugField
from .localized_magicslug_field import LocalizedMagicSlugField from .localized_uniqueslug_field import LocalizedUniqueSlugField
from .localized_bleach_field import LocalizedBleachField from .localized_bleach_field import LocalizedBleachField
__all__ = [ __all__ = [
'LocalizedField', 'LocalizedField',
'LocalizedAutoSlugField', 'LocalizedAutoSlugField',
'LocalizedMagicSlugField', 'LocalizedUniqueSlugField',
'LocalizedBleachField', 'LocalizedBleachField',
] ]

View File

@ -6,7 +6,7 @@ from .localized_autoslug_field import LocalizedAutoSlugField
from ..util import get_language_codes from ..util import get_language_codes
class LocalizedMagicSlugField(LocalizedAutoSlugField): class LocalizedUniqueSlugField(LocalizedAutoSlugField):
"""Automatically provides slugs for a localized """Automatically provides slugs for a localized
field upon saving." field upon saving."
@ -20,7 +20,7 @@ class LocalizedMagicSlugField(LocalizedAutoSlugField):
""" """
def __init__(self, *args, **kwargs): 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') self.populate_from = kwargs.pop('populate_from')
kwargs['uniqueness'] = kwargs.pop('uniqueness', get_language_codes()) kwargs['uniqueness'] = kwargs.pop('uniqueness', get_language_codes())

View File

@ -5,7 +5,7 @@ from django.db.utils import IntegrityError
from django.utils.text import slugify from django.utils.text import slugify
from localized_fields import (LocalizedField, LocalizedAutoSlugField, from localized_fields import (LocalizedField, LocalizedAutoSlugField,
LocalizedMagicSlugField) LocalizedUniqueSlugField)
from .fake_model import get_fake_model from .fake_model import get_fake_model
@ -31,10 +31,10 @@ class LocalizedSlugFieldTestCase(TestCase):
) )
cls.MagicSlugModel = get_fake_model( cls.MagicSlugModel = get_fake_model(
'LocalizedMagicSlugFieldTestModel', 'LocalizedUniqueSlugFieldTestModel',
{ {
'title': LocalizedField(), 'title': LocalizedField(),
'slug': LocalizedMagicSlugField(populate_from='title') 'slug': LocalizedUniqueSlugField(populate_from='title')
} }
) )
@ -92,7 +92,7 @@ class LocalizedSlugFieldTestCase(TestCase):
@classmethod @classmethod
def test_deconstruct_magic(cls): def test_deconstruct_magic(cls):
cls._test_deconstruct(LocalizedMagicSlugField) cls._test_deconstruct(LocalizedUniqueSlugField)
@classmethod @classmethod
def test_formfield_auto(cls): def test_formfield_auto(cls):
@ -100,7 +100,7 @@ class LocalizedSlugFieldTestCase(TestCase):
@classmethod @classmethod
def test_formfield_magic(cls): def test_formfield_magic(cls):
cls._test_formfield(LocalizedMagicSlugField) cls._test_formfield(LocalizedUniqueSlugField)
@staticmethod @staticmethod
def _test_populate(model): def _test_populate(model):