mirror of
https://github.com/Hopiu/django-uuslug.git
synced 2026-05-05 17:24:42 +00:00
216 lines
6.4 KiB
Markdown
216 lines
6.4 KiB
Markdown
Django Uuslug
|
|
====================
|
|
|
|
**A Django slugify application that guarantees `Uniqueness` and handles `Unicode`**
|
|
|
|
[![build-status-image-fury]][fury]
|
|
[![build-status-image-travis]][travis]
|
|
[![build-status-image-coverage]][coverage]
|
|
[![build-status-image-pypi]][pypi]
|
|
|
|
|
|
Overview
|
|
========
|
|
|
|
In short: UUSlug == (``U``nique + ``U``nicode) Slug
|
|
|
|
How to install
|
|
==================
|
|
|
|
1. easy_install django-uuslug
|
|
2. pip install django-uuslug
|
|
3. git clone http://github.com/un33k/django-uuslug
|
|
a. cd django-uuslug
|
|
b. run python setup.py
|
|
4. wget https://github.com/un33k/django-uuslug/zipball/master
|
|
a. unzip the downloaded file
|
|
b. cd into django-uuslug-* directory
|
|
c. run python setup.py
|
|
5. pip install -e git+https://github.com/un33k/django-uuslug#egg=django-uuslug
|
|
|
|
How to use
|
|
=================
|
|
|
|
Unicode Test
|
|
|
|
from uuslug import slugify
|
|
|
|
txt = "This is a test ---"
|
|
r = slugify(txt)
|
|
self.assertEqual(r, "this-is-a-test")
|
|
|
|
txt = "This -- is a ## test ---"
|
|
r = slugify(txt)
|
|
self.assertEqual(r, "this-is-a-test")
|
|
|
|
txt = '影師嗎'
|
|
r = slugify(txt)
|
|
self.assertEqual(r, "ying-shi-ma")
|
|
|
|
txt = 'C\'est déjà l\'été.'
|
|
r = slugify(txt)
|
|
self.assertEqual(r, "cest-deja-lete")
|
|
|
|
txt = 'Nín hǎo. Wǒ shì zhōng guó rén'
|
|
r = slugify(txt)
|
|
self.assertEqual(r, "nin-hao-wo-shi-zhong-guo-ren")
|
|
|
|
txt = 'Компьютер'
|
|
r = slugify(txt)
|
|
self.assertEqual(r, "kompiuter")
|
|
|
|
txt = 'jaja---lol-méméméoo--a'
|
|
r = slugify(txt)
|
|
self.assertEqual(r, "jaja-lol-mememeoo-a")
|
|
|
|
txt = 'jaja---lol-méméméoo--a'
|
|
r = slugify(txt, max_length=9)
|
|
self.assertEqual(r, "jaja-lol")
|
|
|
|
txt = 'jaja---lol-méméméoo--a'
|
|
r = slugify(txt, max_length=15)
|
|
self.assertEqual(r, "jaja-lol-mememe")
|
|
|
|
txt = 'jaja---lol-méméméoo--a'
|
|
r = slugify(txt, max_length=50)
|
|
self.assertEqual(r, "jaja-lol-mememeoo-a")
|
|
|
|
txt = 'jaja---lol-méméméoo--a'
|
|
r = slugify(txt, max_length=15, word_boundary=True)
|
|
self.assertEqual(r, "jaja-lol-a")
|
|
|
|
txt = 'jaja---lol-méméméoo--a'
|
|
r = slugify(txt, max_length=17, word_boundary=True)
|
|
self.assertEqual(r, "jaja-lol-mememeoo")
|
|
|
|
txt = 'jaja---lol-méméméoo--a'
|
|
r = slugify(txt, max_length=18, word_boundary=True)
|
|
self.assertEqual(r, "jaja-lol-mememeoo")
|
|
|
|
txt = 'jaja---lol-méméméoo--a'
|
|
r = slugify(txt, max_length=19, word_boundary=True)
|
|
self.assertEqual(r, "jaja-lol-mememeoo-a")
|
|
|
|
txt = 'jaja---lol-méméméoo--a'
|
|
r = slugify(txt, max_length=20, word_boundary=True, separator=".")
|
|
self.assertEqual(r, "jaja.lol.mememeoo.a")
|
|
|
|
txt = 'jaja---lol-méméméoo--a'
|
|
r = slugify(txt, max_length=20, word_boundary=True, separator="ZZZZZZ")
|
|
self.assertEqual(r, "jajaZZZZZZlolZZZZZZmememeooZZZZZZa")
|
|
|
|
txt = "___This is a test ---"
|
|
r = slugify(txt)
|
|
self.assertEqual(r, "this-is-a-test")
|
|
|
|
txt = "___This is a test___"
|
|
r = slugify(txt)
|
|
self.assertEqual(r, "this-is-a-test")
|
|
|
|
txt = 'one two three four five'
|
|
r = slugify(txt, max_length=13, word_boundary=True, save_order=True)
|
|
self.assertEqual(r, "one-two-three")
|
|
|
|
txt = 'one two three four five'
|
|
r = slugify(txt, max_length=13, word_boundary=True, save_order=False)
|
|
self.assertEqual(r, "one-two-three")
|
|
|
|
txt = 'one two three four five'
|
|
r = slugify(txt, max_length=12, word_boundary=True, save_order=False)
|
|
self.assertEqual(r, "one-two-four")
|
|
|
|
txt = 'one two three four five'
|
|
r = slugify(txt, max_length=12, word_boundary=True, save_order=True)
|
|
self.assertEqual(r, "one-two")
|
|
|
|
|
|
Uniqueness Test
|
|
|
|
Override your object's save method with something like this (models.py)
|
|
|
|
from django.db import models
|
|
from uuslug import uuslug
|
|
|
|
class CoolSlug(models.Model):
|
|
name = models.CharField(max_length=100)
|
|
slug = models.CharField(max_length=200)
|
|
|
|
def __unicode__(self):
|
|
return self.name
|
|
|
|
def save(self, *args, **kwargs):
|
|
# self.slug = uuslug(self.name, instance=self, separator="_") # optional non-dash separator
|
|
self.slug = uuslug(self.name, instance=self)
|
|
super(CoolSlug, self).save(*args, **kwargs)
|
|
|
|
|
|
Note: You can also specify the start number.
|
|
Example:
|
|
self.slug = uuslug(self.name, instance=self, start_no=2)
|
|
# the second slug should start with "-2" instead of "-1"
|
|
|
|
name = "john"
|
|
c = CoolSlug.objects.create(name=name)
|
|
c.save()
|
|
print c.slug # => "john"
|
|
|
|
c1 = CoolSlug.objects.create(name=name)
|
|
c1.save()
|
|
print c1.slug # => "john-1"
|
|
|
|
c2 = CoolSlug.objects.create(name=name)
|
|
c2.save()
|
|
print c2.slug # => "john-2"
|
|
|
|
|
|
# If you need truncation of your slug, here is an example
|
|
class SmartTruncatedSlug(models.Model):
|
|
name = models.CharField(max_length=19)
|
|
slug = models.CharField(max_length=19)
|
|
|
|
def __unicode__(self):
|
|
return self.name
|
|
|
|
def save(self, *args, **kwargs):
|
|
self.slug = uuslug(self.name, instance=self, start_no=9, max_length=19, word_boundary=True)
|
|
super(SmartTruncatedSlug, self).save(*args, **kwargs)
|
|
|
|
# Let's test it
|
|
name = 'jaja---lol-méméméoo--a'
|
|
|
|
obj = SmartTruncatedExactWordBoundrySlug.objects.create(name=name)
|
|
self.assertEqual(obj.slug, "jaja-lol-mememeoo-a") # 19 is max_length
|
|
|
|
obj = SmartTruncatedExactWordBoundrySlug.objects.create(name=name)
|
|
self.assertEqual(obj.slug, "jaja-lol-mememeoo-9") # 19 is max_length, start_no = 9
|
|
|
|
obj = SmartTruncatedExactWordBoundrySlug.objects.create(name=name)
|
|
self.assertEqual(obj.slug, "jaja-lol-mememeo-10") # 19 is max_length, readjust for "-10"
|
|
|
|
|
|
Running the tests
|
|
=================
|
|
|
|
To run the tests against the current environment:
|
|
|
|
python manage.py test
|
|
|
|
|
|
License
|
|
====================
|
|
|
|
Released under a ([BSD](LICENSE.md)) license.
|
|
|
|
|
|
[build-status-image-travis]: https://secure.travis-ci.org/un33k/django-uuslug.png?branch=master
|
|
[travis]: http://travis-ci.org/un33k/django-uuslug?branch=master
|
|
|
|
[build-status-image-fury]: https://badge.fury.io/py/django-uuslug.png
|
|
[fury]: http://badge.fury.io/py/django-uuslug
|
|
|
|
[build-status-image-pypi]: https://pypip.in/d/django-uuslug/badge.png
|
|
[pypi]: https://crate.io/packages/django-uuslug?version=latest
|
|
|
|
[build-status-image-coverage]: https://coveralls.io/repos/un33k/django-uuslug/badge.svg
|
|
[coverage]: https://coveralls.io/r/un33k/django-uuslug
|
|
|