Hopiu/django-uuslug
1
0
Fork 0
mirror of https://github.com/Hopiu/django-uuslug.git synced 2026-03-16 20:10:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

add github action badge

Browse source
This commit is contained in:
Val Neekman (AvidCoder) 2022-01-31 16:29:12 -05:00
parent 2d820df3a6
commit c9ed4b5e80
2 changed files with 144 additions and 154 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

296
README.md
View file

@ -1,5 +1,4 @@
Django Uuslug # Django Uuslug
====================
**A Django slugify application that guarantees `Uniqueness` and handles `Unicode`** **A Django slugify application that guarantees `Uniqueness` and handles `Unicode`**
@ -7,13 +6,11 @@ Django Uuslug
[![version-image]][version-link] [![version-image]][version-link]
[![coverage-image]][coverage-link] [![coverage-image]][coverage-link]
Overview # Overview
========
In short: UUSlug == (``U``nique + ``U``nicode) Slug In short: UUSlug == (`U`nique + `U`nicode) Slug
How to install # How to install
==================
1. easy_install django-uuslug 1. easy_install django-uuslug
2. pip install django-uuslug 2. pip install django-uuslug
@ -26,221 +23,212 @@ How to install
c. run python setup.py c. run python setup.py
5. pip install -e git+https://github.com/un33k/django-uuslug#egg=django-uuslug 5. pip install -e git+https://github.com/un33k/django-uuslug#egg=django-uuslug
How to use # How to use
=================
```python ```python
####### Unicode Test ####### ####### Unicode Test #######
from uuslug import slugify from uuslug import slugify
txt = "This is a test ---" txt = "This is a test ---"
r = slugify(txt) r = slugify(txt)
self.assertEqual(r, "this-is-a-test") self.assertEqual(r, "this-is-a-test")
txt = "___This is a test ---" txt = "___This is a test ---"
r = slugify(txt) r = slugify(txt)
self.assertEqual(r, "this-is-a-test") self.assertEqual(r, "this-is-a-test")
txt = "___This is a test___" txt = "___This is a test___"
r = slugify(txt) r = slugify(txt)
self.assertEqual(r, "this-is-a-test") self.assertEqual(r, "this-is-a-test")
txt = "This -- is a ## test ---" txt = "This -- is a ## test ---"
r = slugify(txt) r = slugify(txt)
self.assertEqual(r, "this-is-a-test") self.assertEqual(r, "this-is-a-test")
txt = '影師嗎' txt = '影師嗎'
r = slugify(txt) r = slugify(txt)
self.assertEqual(r, "ying-shi-ma") self.assertEqual(r, "ying-shi-ma")
txt = 'C\'est déjà l\'été.' txt = 'C\'est déjà l\'été.'
r = slugify(txt) r = slugify(txt)
self.assertEqual(r, "c-est-deja-l-ete") self.assertEqual(r, "c-est-deja-l-ete")
txt = 'Nín hǎo. Wǒ shì zhōng guó rén' txt = 'Nín hǎo. Wǒ shì zhōng guó rén'
r = slugify(txt) r = slugify(txt)
self.assertEqual(r, "nin-hao-wo-shi-zhong-guo-ren") self.assertEqual(r, "nin-hao-wo-shi-zhong-guo-ren")
txt = 'jaja---lol-méméméoo--a' txt = 'jaja---lol-méméméoo--a'
r = slugify(txt) r = slugify(txt)
self.assertEqual(r, "jaja-lol-mememeoo-a") self.assertEqual(r, "jaja-lol-mememeoo-a")
txt = 'Компьютер' txt = 'Компьютер'
r = slugify(txt) r = slugify(txt)
self.assertEqual(r, "kompiuter") self.assertEqual(r, "kompiuter")
txt = 'jaja---lol-méméméoo--a' txt = 'jaja---lol-méméméoo--a'
r = slugify(txt, max_length=9) r = slugify(txt, max_length=9)
self.assertEqual(r, "jaja-lol") self.assertEqual(r, "jaja-lol")
txt = 'jaja---lol-méméméoo--a' txt = 'jaja---lol-méméméoo--a'
r = slugify(txt, max_length=15) r = slugify(txt, max_length=15)
self.assertEqual(r, "jaja-lol-mememe") self.assertEqual(r, "jaja-lol-mememe")
txt = 'jaja---lol-méméméoo--a' txt = 'jaja---lol-méméméoo--a'
r = slugify(txt, max_length=50) r = slugify(txt, max_length=50)
self.assertEqual(r, "jaja-lol-mememeoo-a") self.assertEqual(r, "jaja-lol-mememeoo-a")
txt = 'jaja---lol-méméméoo--a' txt = 'jaja---lol-méméméoo--a'
r = slugify(txt, max_length=15, word_boundary=True) r = slugify(txt, max_length=15, word_boundary=True)
self.assertEqual(r, "jaja-lol-a") self.assertEqual(r, "jaja-lol-a")
txt = 'jaja---lol-méméméoo--a' txt = 'jaja---lol-méméméoo--a'
r = slugify(txt, max_length=17, word_boundary=True) r = slugify(txt, max_length=17, word_boundary=True)
self.assertEqual(r, "jaja-lol-mememeoo") self.assertEqual(r, "jaja-lol-mememeoo")
txt = 'jaja---lol-méméméoo--a' txt = 'jaja---lol-méméméoo--a'
r = slugify(txt, max_length=18, word_boundary=True) r = slugify(txt, max_length=18, word_boundary=True)
self.assertEqual(r, "jaja-lol-mememeoo") self.assertEqual(r, "jaja-lol-mememeoo")
txt = 'jaja---lol-méméméoo--a' txt = 'jaja---lol-méméméoo--a'
r = slugify(txt, max_length=19, word_boundary=True) r = slugify(txt, max_length=19, word_boundary=True)
self.assertEqual(r, "jaja-lol-mememeoo-a") self.assertEqual(r, "jaja-lol-mememeoo-a")
txt = 'jaja---lol-méméméoo--a' txt = 'jaja---lol-méméméoo--a'
r = slugify(txt, max_length=20, word_boundary=True, separator=".") r = slugify(txt, max_length=20, word_boundary=True, separator=".")
self.assertEqual(r, "jaja.lol.mememeoo.a") self.assertEqual(r, "jaja.lol.mememeoo.a")
txt = 'jaja---lol-méméméoo--a' txt = 'jaja---lol-méméméoo--a'
r = slugify(txt, max_length=20, word_boundary=True, separator="ZZZZZZ") r = slugify(txt, max_length=20, word_boundary=True, separator="ZZZZZZ")
self.assertEqual(r, "jajaZZZZZZlolZZZZZZmememeooZZZZZZa") self.assertEqual(r, "jajaZZZZZZlolZZZZZZmememeooZZZZZZa")
txt = 'one two three four five' txt = 'one two three four five'
r = slugify(txt, max_length=13, word_boundary=True, save_order=True) r = slugify(txt, max_length=13, word_boundary=True, save_order=True)
self.assertEqual(r, "one-two-three") self.assertEqual(r, "one-two-three")
txt = 'one two three four five' txt = 'one two three four five'
r = slugify(txt, max_length=13, word_boundary=True, save_order=False) r = slugify(txt, max_length=13, word_boundary=True, save_order=False)
self.assertEqual(r, "one-two-three") self.assertEqual(r, "one-two-three")
txt = 'one two three four five' txt = 'one two three four five'
r = slugify(txt, max_length=12, word_boundary=True, save_order=False) r = slugify(txt, max_length=12, word_boundary=True, save_order=False)
self.assertEqual(r, "one-two-four") self.assertEqual(r, "one-two-four")
txt = 'one two three four five' txt = 'one two three four five'
r = slugify(txt, max_length=12, word_boundary=True, save_order=True) r = slugify(txt, max_length=12, word_boundary=True, save_order=True)
self.assertEqual(r, "one-two") self.assertEqual(r, "one-two")
txt = 'this has a stopword' txt = 'this has a stopword'
r = slugify(txt, stopwords=['stopword']) r = slugify(txt, stopwords=['stopword'])
self.assertEqual(r, 'this-has-a') self.assertEqual(r, 'this-has-a')
txt = 'the quick brown fox jumps over the lazy dog' txt = 'the quick brown fox jumps over the lazy dog'
r = slugify(txt, stopwords=['the']) r = slugify(txt, stopwords=['the'])
self.assertEqual(r, 'quick-brown-fox-jumps-over-lazy-dog') self.assertEqual(r, 'quick-brown-fox-jumps-over-lazy-dog')
txt = 'Foo A FOO B foo C' txt = 'Foo A FOO B foo C'
r = slugify(txt, stopwords=['foo']) r = slugify(txt, stopwords=['foo'])
self.assertEqual(r, 'a-b-c') self.assertEqual(r, 'a-b-c')
txt = 'Foo A FOO B foo C' txt = 'Foo A FOO B foo C'
r = slugify(txt, stopwords=['FOO']) r = slugify(txt, stopwords=['FOO'])
self.assertEqual(r, 'a-b-c') self.assertEqual(r, 'a-b-c')
txt = 'the quick brown fox jumps over the lazy dog in a hurry' txt = 'the quick brown fox jumps over the lazy dog in a hurry'
r = slugify(txt, stopwords=['the', 'in', 'a', 'hurry']) r = slugify(txt, stopwords=['the', 'in', 'a', 'hurry'])
self.assertEqual(r, 'quick-brown-fox-jumps-over-lazy-dog') self.assertEqual(r, 'quick-brown-fox-jumps-over-lazy-dog')
####### Uniqueness Test ####### ####### Uniqueness Test #######
from django.db import models from django.db import models
from uuslug import uuslug from uuslug import uuslug
# Override your object's save method with something like this (models.py) # Override your object's save method with something like this (models.py)
class CoolSlug(models.Model): class CoolSlug(models.Model):
name = models.CharField(max_length=100) name = models.CharField(max_length=100)
slug = models.CharField(max_length=200) slug = models.CharField(max_length=200)
def __unicode__(self): def __unicode__(self):
return self.name return self.name
def save(self, *args, **kwargs): def save(self, *args, **kwargs):
self.slug = uuslug(self.name, instance=self) self.slug = uuslug(self.name, instance=self)
super(CoolSlug, self).save(*args, **kwargs) super(CoolSlug, self).save(*args, **kwargs)
# Note: You can also specify the start number. # Note: You can also specify the start number.
# Example: # Example:
self.slug = uuslug(self.name, instance=self, start_no=2) self.slug = uuslug(self.name, instance=self, start_no=2)
# the second slug should start with "-2" instead of "-1" # the second slug should start with "-2" instead of "-1"
name = "john" name = "john"
c = CoolSlug.objects.create(name=name) c = CoolSlug.objects.create(name=name)
c.save() c.save()
print(c.slug) # => "john" print(c.slug) # => "john"
c1 = CoolSlug.objects.create(name=name) c1 = CoolSlug.objects.create(name=name)
c1.save() c1.save()
print(c1.slug) # => "john-1" print(c1.slug) # => "john-1"
c2 = CoolSlug.objects.create(name=name) c2 = CoolSlug.objects.create(name=name)
c2.save() c2.save()
print(c2.slug) # => "john-2" print(c2.slug) # => "john-2"
# If you need truncation of your slug to exact length, here is an example # If you need truncation of your slug to exact length, here is an example
class SmartTruncatedSlug(models.Model): class SmartTruncatedSlug(models.Model):
name = models.CharField(max_length=19) name = models.CharField(max_length=19)
slug = models.CharField(max_length=10) slug = models.CharField(max_length=10)
def __unicode__(self): def __unicode__(self):
return self.name return self.name
def save(self, *args, **kwargs): def save(self, *args, **kwargs):
self.slug = uuslug(self.name, instance=self, max_length=10) self.slug = uuslug(self.name, instance=self, max_length=10)
super(SmartTruncatedSlug, self).save(*args, **kwargs) super(SmartTruncatedSlug, self).save(*args, **kwargs)
# If you need automatic truncation of your slug, here is an example # If you need automatic truncation of your slug, here is an example
class AutoTruncatedSlug(models.Model): class AutoTruncatedSlug(models.Model):
name = models.CharField(max_length=19) name = models.CharField(max_length=19)
slug = models.CharField(max_length=19) slug = models.CharField(max_length=19)
def __unicode__(self): def __unicode__(self):
return self.name return self.name
def save(self, *args, **kwargs): def save(self, *args, **kwargs):
self.slug = uuslug(self.name, instance=self) self.slug = uuslug(self.name, instance=self)
super(SmartTruncatedSlug, self).save(*args, **kwargs) super(SmartTruncatedSlug, self).save(*args, **kwargs)
``` ```
Running the tests # Running the tests
=================
To run the tests against the current environment: To run the tests against the current environment:
python manage.py test python manage.py test
# License
License
====================
Released under a ([BSD](LICENSE.md)) license. Released under a ([BSD](LICENSE.md)) license.
# Version
Version
====================
X.Y.Z Version X.Y.Z Version
`MAJOR` version -- when you make incompatible API changes, `MAJOR` version -- when you make incompatible API changes,
`MINOR` version -- when you add functionality in a backwards-compatible manner, and `MINOR` version -- when you add functionality in a backwards-compatible manner, and
`PATCH` version -- when you make backwards-compatible bug fixes. `PATCH` version -- when you make backwards-compatible bug fixes.
[status-image]: https://secure.travis-ci.org/un33k/django-uuslug.png?branch=master [status-image]: https://github.com/un33k/django-uuslug/actions/workflows/main.yml/badge.svg
[status-link]: http://travis-ci.org/un33k/django-uuslug?branch=master [status-link]: https://github.com/un33k/django-uuslug/actions/workflows/main.yml
[status-image]: https://github.com/un33k/django-uuslug/actions/workflows/main.yml/badge.svg
[version-image]: https://img.shields.io/pypi/v/django-uuslug.svg [version-image]: https://img.shields.io/pypi/v/django-uuslug.svg
[version-link]: https://pypi.python.org/pypi/django-uuslug [version-link]: https://pypi.python.org/pypi/django-uuslug
[coverage-image]: https://coveralls.io/repos/un33k/django-uuslug/badge.svg [coverage-image]: https://coveralls.io/repos/un33k/django-uuslug/badge.svg
[coverage-link]: https://coveralls.io/r/un33k/django-uuslug [coverage-link]: https://coveralls.io/r/un33k/django-uuslug
[download-image]: https://img.shields.io/pypi/dm/django-uuslug.svg [download-image]: https://img.shields.io/pypi/dm/django-uuslug.svg
[download-link]: https://pypi.python.org/pypi/django-uuslug [download-link]: https://pypi.python.org/pypi/django-uuslug
# Sponsors
Sponsors [Neekware Inc.](https://github.com/neekware)
====================
[Neekware Inc.](https://github.com/neekware)

2
requirements.txt Normal file
View file

@ -0,0 +1,2 @@
Django>=2.2
python-slugify>=5.0.1