Skip to content
This repository


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Generates a URL slug/permalink based on fields in a Mongoid-based model

This branch is 0 commits ahead and 0 commits behind master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Mongoid Slug

Mongoid Slug generates a URL slug or permalink based on one or more fields in a Mongoid model. It sits idly on top of stringex and works with non-Latin characters.


Quick Start

Add mongoid_slug to your Gemfile:

gem 'mongoid_slug'

Set up some slugs:

class Book
  include Mongoid::Document
  include Mongoid::Slug

  field :title
  embeds_many :authors

  slug :title

class Author
  include Mongoid::Document
  include Mongoid::Slug

  field :first
  field :last
  embedded_in :book, :inverse_of => :authors

  slug :first, :last, :as => :name

In your controller, use available finders:

# GET /books/a-thousand-plateaus/authors/gilles-deleuze
author = Book.find_by_slug(params[:book_id]).

Read here for all available options.


To scope a slug by a reference association, pass :scope:

class Company
  include Mongoid::Document
  references_many :employees

class Employee
 include Mongoid::Document
 include Mongoid::Slug
 field :name
 slug  :name, :scope => :company
 referenced_in :company

In this example, if you create an employee without associating it with any company, the scope will fall back to the root employees collection.

Currently, if you have an irregular association name, you must specify the :inverse_of option on the other side of the assocation.

Embedded objects are automatically scoped by their parent.

Something went wrong with that request. Please try again.