NOTE: No longer maintained, as mongomapper is no longer maintained.

Add slugs to your fields. And use it for nice urls. Difference from other mm-sluggables: This uses regexp query for checking conflicting slugs, so you get only 2 queries even if your collection has 1000 upon 1000 of documents.

Either load it into all models, or individual models:

Add to all models

  #initializers/mongo.rb
  MongoMapper::Document.plugin(MongoMapper::Plugins::Sluggable)

Add to a specific model

  #app/models/my_model.rb
  plugin MongoMapper::Plugins::Sluggable

Then call sluggable to configure it

  sluggable :title, :scope => :account_id

NOTE: The slugs will always be updated if you change the field it creates the slugs from. see options to change behaviour

Free slugs will be reused Example: you have my-title-1 and my-title-3 creating a new slug will generate my-title-2

Why always change slugs? Feels better to have same slug as title...

This is important to get fast queries! (you will regret if you don't add it...)

Read up on indexes here: mongomapper/mongomapper#337

Easiest is to add db/indexes.rb to your app, then add this to that file:

MyModel.ensure_index(:slug_key)

Available options:

• :scope - scope to a specific field (default - nil)
• :key - what the slug key is called (default - :slug) - NOTE, don't change this one
• :method - what method to call on the field to sluggify it (default - :parameterize)
• :callback - when to trigger the slugging (default - :before_validation)
• :always_update - Always update the slug on update/save/create etc.
• :start - Which value the slugs should start with (default: 1)
• :max_length - The maxiumum length of the slug (default: 256)
• :disallowed_bare_slugs - Array of words that shouldn't be allowed as bare slugs. (default: ["new", "edit", "update", "create", "destroy"])

Eg.

  sluggable :title, scope: :account_id, key: :title_slug, method: :to_url, always_update: true, disallowed_bare_slugs: ["dragon", "unicorn", "dog"]

This will slug the title to the title_slug key, scoped to the account, will use String#to_url to slug it and won't add an index to the key

If an item with the same slug exists, it will add a version number to the slug.

IE assuming we already have an item with the slug of "monkey", the slug will be generated as "monkey-1"

• Fork the project.
• Make your feature addition or bug fix.
• Add tests for it.

Bundler: (You are most likely using bundler in your app...) gem 'mm-sluggable', :git => 'http://github.com/luuf/mm-sluggable.git'

• Richard Livsey for creating the original mm-sluggable
• John Nunemaker, Brandon Keepers & Others for MongoMapper

See LICENSE for details.