Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/EuAndreh/cl-slug

Small library to make slugs, mainly for URIs, from english and beyond.
https://github.com/EuAndreh/cl-slug

common-lisp quicklisp roswell

Last synced: 2 months ago
JSON representation

Small library to make slugs, mainly for URIs, from english and beyond.

Lists

README 

        
# cl-slug

[![Quicklisp](http://quickdocs.org/badge/cl-slug.svg)](http://quickdocs.org/cl-slug/)

[![Build Status](https://travis-ci.org/EuAndreh/cl-slug.svg?branch=master)](https://travis-ci.org/EuAndreh/cl-slug)

[![Circle CI](https://circleci.com/gh/EuAndreh/cl-slug.svg?style=svg)](https://circleci.com/gh/EuAndreh/cl-slug)

[![Coverage Status](https://coveralls.io/repos/EuAndreh/cl-slug/badge.svg?branch=master)](https://coveralls.io/r/EuAndreh/cl-slug?branch=master)



Easily create slugs from any string. Supports many languages alphabets. See [Supported languages](#supported-languages) to check for supported languages or to help to add one.



Inspired by [Lisp Web Tales](http://lispwebtales.ppenev.com/chap05.html#leanpub-auto-rewriting-the-routes).



## Usage

```lisp

* (ql:quickload :cl-slug)

; => (:CL-SLUG)

* (import '(slug:slugify slug:asciify slug:CamelCaseFy))

; => T

```



The main function is called `slugify`:



```lisp

* (slugify "My new cool article, for the blog (V. 2).")

; => "my-new-cool-article-for-the-blog-v-2"

* (slugify "André Miranda")

; => "andre-miranda"

```



`slugify` removes any accented character, replacing it with an unaccented equivalent, and any punctuation (a punctuation is a char that returns `NIL` for `alphanumericp`) and puts a dash (`-`) on it's place. You can change that by binding (of `setf`ing) `*slug-separator*`:



```lisp

* (let ((*slug-separator* #\_))

    (slugify "Testing the *slug-separator* var..."))

; => "testing_the_slug_separator_var"

```



`slugify` also ignores numbers:



```lisp

* (slugify "one2three4five")

; => "one2three4five"

```



If you just want to remove accents and punctuation of a given string, use `asciify`:



```lisp

* (asciify "Eu André!")

; => "Eu Andre!"

```



Or if you want a CamelCase, use `CamelCaseFy`:



```lisp

* (CamelCaseFy "My new camel case string")

; => "MyNewCamelCaseString"

```



Available languages are stored in `*available-languages*`:

```lisp

* slug:*available-languages*

((:TR . "Türkçe (Turkish)") (:SV . "Svenska (Swedish)") (:FI . "Suomi (Finnish)") 

 (:UK . "українська (Ukrainian)") (:RU . "Ру́сский (Russian)") (:RO . "Română (Romanian)")

 (:RM . "Rumàntsch (Romansh)") (:PT . "Português (Portuguese)") (:PL . "Polski (Polish)")

 (:NO . "Norsk (Norwegian)") (:LT . "Lietuvių (Lithuanian)") (:LV . "Latviešu (Latvian)")

 (:LA . "Lingua Latīna (Latin)") (:IT . "Italiano (Italian)") (:EL . "ελληνικά (Greek)")

 (:FR . "Français (French)") (:EO . "Esperanto") (:ES . "Español (Spanish)") (:EN . "English")

 (:DE . "Deutsch (German)") (:DA . "Dansk (Danish)") (:CS . "Čeština (Czech)")

 (:CURRENCY . "Currency"))

```



## Dependencies



This library depends on [CL-PPCRE](http://weitz.de/cl-ppcre). The test package uses the [prove](https://github.com/fukamachi/prove) test library.



## Installation

Available on [Quicklisp](http://quicklisp.org):

```

(ql:quickload :cl-slug)

```



## Supported languages

The languages that are supported right now are:

- english

- portuguese

- esperanto

- german

- french

- swedish

- finnish

- norwegian

- danish

- italian

- spanish

- romansh



Ported from [Django](https://code.djangoproject.com/browser/django/trunk/django/contrib/admin/media/js/urlify.js)():

- currency

- romanian

- lithuanian

- latvian

- polish

- czesh

- ukranian

- russian

- turkish

- greek

- latin



At the present moment, adding new languages is a fairly manual process:

  1. Identify non-ASCII characters in a given language's alphabet

  2. Establish equivalence between the found characters and ASCII characters

  3. Write them down in the code.



All those things can actually be done for most of the dominant Western languages, but can't be applied for minor regional languages or many other non-Latin languages from the whole world, like Chinese. It's not generic and not scalable.



I couldn't think of a solution so far for this, but if you know a solution (even a partial one) I'd be glad to hear =].



## Bugs

If you find any bug or inconsistency in the code, or if you find it too hard to use, please, feel free to open an issue.



## Tests

This library is tested under [ABCL](https://common-lisp.net/project/armedbear/), [SBCL](http://www.sbcl.org/), [CCL](http://ccl.clozure.com/), [CLISP](http://www.clisp.org/) and [ECL](https://common-lisp.net/project/ecl/) Common Lisp implementations.



To run all the defined tests, use:

```lisp

* (asdf:test-system :cl-slug)

; prints lots of (colorful) stuff...

; => T

```



Tests are ran with [Travis CI](https://travis-ci.org/EuAndreh/cl-slug) and [Circle CI](https://circleci.com/gh/EuAndreh/cl-slug) using [cl-travis](https://github.com/luismbo/cl-travis), [CIM](https://github.com/KeenS/CIM), [cl-coveralls](https://github.com/fukamachi/cl-coveralls) and [Roswell](https://github.com/snmsts/roswell). Check it out!



## Author

André Miranda.



## License

[LLGPL](https://tldrlegal.com/license/lisp-lesser-general-public-license#fulltext).