Class: FriendlyId::Candidates

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/friendly_id/candidates.rb

Overview

This class provides the slug candidate functionality.

See Also:

Instance Method Summary collapse

Constructor Details

#initialize(object, *array) ⇒ Candidates

Returns a new instance of Candidates.


11
12
13
14
# File 'lib/friendly_id/candidates.rb', line 11

def initialize(object, *array)
  @object = object
  @raw_candidates = to_candidate_array(object, array.flatten(1))
end

Instance Method Details

#candidatesObject (private)


23
24
25
26
27
28
# File 'lib/friendly_id/candidates.rb', line 23

def candidates
  @candidates ||= begin
    candidates = normalize(@raw_candidates)
    filter(candidates)
  end
end

#each(*args, &block) ⇒ Object


16
17
18
19
# File 'lib/friendly_id/candidates.rb', line 16

def each(*args, &block)
  return candidates unless block_given?
  candidates.each{ |candidate| yield candidate }
end

#filter(candidates) ⇒ Object (private)


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

def filter(candidates)
  unless candidates.all? {|x| reserved?(x)}
    candidates.reject! {|x| reserved?(x)}
  end
  candidates
end

#normalize(candidates) ⇒ Object (private)


30
31
32
33
34
# File 'lib/friendly_id/candidates.rb', line 30

def normalize(candidates)
  candidates.map do |candidate|
    @object.normalize_friendly_id(candidate.map(&:call).join(' '))
  end.select {|x| wanted?(x)}
end

#reserved?(slug) ⇒ Boolean (private)

Returns:

  • (Boolean)

66
67
68
69
70
71
# File 'lib/friendly_id/candidates.rb', line 66

def reserved?(slug)
  config = @object.friendly_id_config
  return false unless config.uses? ::FriendlyId::Reserved
  return false unless config.reserved_words
  config.reserved_words.include?(slug)
end

#to_candidate_array(object, array) ⇒ Object (private)


43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
# File 'lib/friendly_id/candidates.rb', line 43

def to_candidate_array(object, array)
  array.map do |candidate|
    case candidate
    when String
      [->{candidate}]
    when Array
      to_candidate_array(object, candidate).flatten
    when Symbol
      [object.method(candidate)]
    else
      if candidate.respond_to?(:call)
        [candidate]
      else
        [->{candidate.to_s}]
      end
    end
  end
end

#wanted?(slug) ⇒ Boolean (private)

Returns:

  • (Boolean)

62
63
64
# File 'lib/friendly_id/candidates.rb', line 62

def wanted?(slug)
  slug.present?
end