Class: FriendlyId::Configuration

Inherits:

Object

• Object
• FriendlyId::Configuration

show all

Defined in:

lib/friendly_id/configuration.rb

Overview

has_friendly_id :name,
 :use_slug => true,
 :max_length => 150,
 :approximate_ascii => true,
 :ascii_approximation_options => :german,
 :sequence_separator => ":",
 :reserved_words => ["reserved", "words"],
 :scope => :country,
 :cache_column => :my_cache_column_name
 # etc.

Constant Summary

DEFAULTS =

{
  :allow_nil                   => false,
  :ascii_approximation_options => [],
  :max_length                  => 255,
  :reserved_words              => ["index", "new"],
  :reserved_message            => 'can not be "%s"',
  :sequence_separator          => "--"
}

Instance Attribute Summary (collapse)

• - (Object) allow_nil (also: #allow_nil?)

  Whether to allow friendly_id and/or slugs to be nil.

• - (Object) approximate_ascii

  Strip diacritics from Western characters.

• - (Object) ascii_approximation_options

  Locale-type options for ASCII approximations.

• - (Object) configured_class readonly

  The class that's using the configuration.

• - (Object) max_length

  The maximum allowed byte length for a friendly_id string.

• - (Object) method (also: #column) readonly

  The method or column that will be used as the basis of the friendly_id string.

• - (Object) reserved_message

  The message shown when a reserved word is used.

• - (Object) reserved_words

  Array of words that are reserved and can't be used as friendly_id strings.

• - (Object) scope

  The method or relation to use as the friendly_id's scope.

• - (Object) sequence_separator

  The string that separates slug names from slug sequences.

• - (Object) strip_non_ascii

  Strip non-ASCII characters from the friendly_id string.

• - (Object) use_slug (also: #use_slugs=)

  Use slugs for storing the friendly_id string.

Class Method Summary (collapse)

• + (Object) scopes_used=(val)

  This will be set if FriendlyId's scope feature is used in any model.

• + (Boolean) scopes_used?

  Are scoped slugs being used by any model?.

Instance Method Summary (collapse)

• - (Object) babosa_options
• - (Object) cache_column=(value)
• - (Boolean) cache_column?

  This should be overridden by adapters that implement caching.

• - (Configuration) initialize(configured_class, method, options = nil) {|_self| ... } constructor

  A new instance of Configuration.

• - (Boolean) reserved?(word)
• - (Object) reserved_error_message(word)

79
80
81
82
83
84
85
86

# File 'lib/friendly_id/configuration.rb', line 79

def initialize(configured_class, method, options = nil, &block)
  @configured_class = configured_class
  @method = method.to_sym
  DEFAULTS.merge(options || {}).each do |key, value|
    self.send "#{key}=".to_sym, value
  end
  yield self if block_given?
end

36
37
38

# File 'lib/friendly_id/configuration.rb', line 36

def allow_nil
  @allow_nil
end

40
41
42

# File 'lib/friendly_id/configuration.rb', line 40

def approximate_ascii
  @approximate_ascii
end

43
44
45

# File 'lib/friendly_id/configuration.rb', line 43

def ascii_approximation_options
  @ascii_approximation_options
end

46
47
48

# File 'lib/friendly_id/configuration.rb', line 46

def configured_class
  @configured_class
end

50
51
52

# File 'lib/friendly_id/configuration.rb', line 50

def max_length
  @max_length
end

53
54
55

# File 'lib/friendly_id/configuration.rb', line 53

def method
  @method
end

58
59
60

# File 'lib/friendly_id/configuration.rb', line 58

def reserved_message
  @reserved_message
end

64
65
66

# File 'lib/friendly_id/configuration.rb', line 64

def reserved_words
  @reserved_words
end

67
68
69

# File 'lib/friendly_id/configuration.rb', line 67

def scope
  @scope
end

70
71
72

# File 'lib/friendly_id/configuration.rb', line 70

def sequence_separator
  @sequence_separator
end

73
74
75

# File 'lib/friendly_id/configuration.rb', line 73

def strip_non_ascii
  @strip_non_ascii
end

76
77
78

# File 'lib/friendly_id/configuration.rb', line 76

def use_slug
  @use_slug
end

137
138
139

# File 'lib/friendly_id/configuration.rb', line 137

def self.scopes_used=(val)
  @scopes_used = !!val
end

143
144
145

# File 'lib/friendly_id/configuration.rb', line 143

def self.scopes_used?
  @scopes_used
end

157
158
159
160
161
162
163
164

# File 'lib/friendly_id/configuration.rb', line 157

def babosa_options
  {
    :to_ascii         => strip_non_ascii?,
    :transliterate    => approximate_ascii?,
    :transliterations => ascii_approximation_options,
    :max_length       => max_length
  }
end

88
89
90
91
92
93
94

# File 'lib/friendly_id/configuration.rb', line 88

def cache_column=(value)
  @cache_column = value.to_s.strip.to_sym
  if value =~ /\s/ || [:slug, :slugs].include?(@cache_column)
    raise ArgumentError, "FriendlyId cache column can not be named '#{value}'"
  end
  @cache_column
end

97
98
99

# File 'lib/friendly_id/configuration.rb', line 97

def cache_column?
  false
end

109
110
111
112
113
114
115
116

# File 'lib/friendly_id/configuration.rb', line 109

def reserved?(word)
  word = word.to_s
  if reserved_words.kind_of?(Regexp)
    reserved_words =~ word
  else
    reserved_words.include?(word)
  end
end

118
119
120

# File 'lib/friendly_id/configuration.rb', line 118

def reserved_error_message(word)
  [method, reserved_message % word] if reserved? word
end