Module: FriendlyId::Reserved

Defined in:
lib/friendly_id/reserved.rb

Overview

Reserved Words

The Reserved module adds the ability to exclude a list of words from use as FriendlyId slugs.

With Ruby on Rails, FriendlyId's generator generates an initializer that reserves some words such as "new" and "edit" using FriendlyId.defaults.

Note that the error messages for fields will appear on the field :friendly_id. If you are using Rails's scaffolded form errors display, then it will have no field to highlight. If you'd like to change this so that scaffolding works as expected, one way to accomplish this is to move the error message to a different field. For example:

class Person < ActiveRecord::Base
  extend FriendlyId
  friendly_id :name, use: :slugged

  after_validation :move_friendly_id_error_to_name

  def move_friendly_id_error_to_name
    errors.add :name, *errors.delete(:friendly_id) if errors[:friendly_id].present?
  end
end

Defined Under Namespace

Modules: Configuration

Class Method Summary collapse

Class Method Details

.included(model_class) ⇒ Object

When included, this module adds configuration options to the model class's friendly_id_config.



36
37
38
39
40
41
42
43
# File 'lib/friendly_id/reserved.rb', line 36

def self.included(model_class)
  model_class.class_eval do
    friendly_id_config.class.send :include, Reserved::Configuration
    validates_exclusion_of :friendly_id, :in => ->(_) {
      friendly_id_config.reserved_words || []
    }
  end
end