mongoskin-slug

A demo to show how to generate and use slugs with mongoskin

npm install mongoskin-slug
4 downloads in the last month

mongoskin-slug Build Status Dependency Status NPM version Coverage Status

A module to provide some insight into the usage of slugs with mongodb and nodejs. Right now this solution uses mongoskin, but it should be pretty easy adaptable to mongodb or monk as well.

Motivation

Slugs are a very common approach to provide urls to articles, products, etc. There are already a couple of generators for these slugs in nodejs, e.g.

These are generators and do not provide any help with storing and/or fetching these slugs in mongodb. IMHO there is a need for this, because a slug should provide a couple of features, which should be reflected by the feature set of an application using slugs:

  • uniqueness, so that one slug is used by exactly one thing (be it an article, a product, an event or ...)
  • historic, s slug should only be used by one thing and this over the whole time, so if the thing e.g. changes its name the old slug should be still there and provide a 302 or something similar to the latest slug (this is of course debateable, since a product with the same name could be established, therefor we should offer a method of offer this as well).

Note: with mongoose you should be able to use mongoose-uniqueslugs, which provides an easy way to generate and use slugs, except the history of slugs, but I could be wrong on this one.

To create nice slugs, we are right now using urlify.

Usage

This module provides basic usage example (speak: tests) to show, how to implement a slug generation and handling with mongoskin. Probably in the future we are building a framework from these ;-)

LICENSE

Copyright (c) 2013 Markus M. May

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

npm loves you