Module: AlphabeticalPaginate::ControllerHelpers

Defined in:
lib/alphabetical_paginate/controller_helper.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object



3
4
5
# File 'lib/alphabetical_paginate/controller_helper.rb', line 3

def self.included(base)
  base.extend(self)
end

Instance Method Details

#alpha_paginate(current_field, params = {enumerate:false, default_field: "a", paginate_all: false, numbers: true, others: true, pagination_class: "pagination-centered", batch_size: 500, db_mode: false, db_field: "id", include_all: true, js: true, support_language: :en, bootstrap3: false, slugged_link: false, slug_field: "slug"}) ⇒ Object



7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
# File 'lib/alphabetical_paginate/controller_helper.rb', line 7

def alpha_paginate current_field, params = {enumerate:false, default_field: "a", 
                                            paginate_all: false, numbers: true,
                                            others: true, pagination_class: "pagination-centered",
                                            batch_size: 500, db_mode: false, 
                                            db_field: "id", include_all: true,
                                            js: true, support_language: :en,
                                            bootstrap3: false, slugged_link: false,
                                            slug_field: "slug"}
  params[:paginate_all] ||= false
  params[:support_language] ||= :en
  params[:language] = AlphabeticalPaginate::Language.new(params[:support_language])
  params[:include_all] = true if !params.has_key? :include_all
  params[:numbers] = true if !params.has_key? :numbers
  params[:others] = true if !params.has_key? :others
  params[:js] = true if !params.has_key? :js
  params[:pagination_class] ||= "pagination-centered"
  params[:batch_size] ||= 500
  params[:db_mode] ||= false
  params[:db_field] ||= "id"
  params[:slugged_link] ||= false
  params[:slugged_link] = params[:slugged_link] && defined?(Babosa)
  params[:slug_field] ||= "slug"

  output = []
  
  if params[:db_mode]
    letters = nil
    if !params[:paginate_all]
      letters = filter_by_cardinality( find_available_letters(params[:db_field]) )
      set_default_field letters, params
    end
    params[:availableLetters] = letters.nil? ? [] : letters
  end

  if params[:include_all]
    current_field ||= 'all'
    all = current_field == "all"
  end

  current_field ||= params[:default_field]
  current_field = current_field.mb_chars.downcase.to_s
  all = params[:include_all] && current_field == "all"

  if params[:db_mode]
    if !ActiveRecord::Base.connection.adapter_name.downcase.include? "mysql"
      raise "You need a mysql database to use db_mode with alphabetical_paginate"
    end

    if all
      output = self
    else
      
      # In this case we can speed up the search taking advantage of the indices
      can_go_quicker = (current_field =~ params[:language].letters_regexp) || (current_field =~ /[0-9]/ && params[:enumerate])

      
      # Use LIKE the most as you can to take advantage of indeces on the field when available
      # REGEXP runs always a full scan of the table!
      # For more information about LIKE and indeces have a look at
      # http://myitforum.com/cs2/blogs/jnelson/archive/2007/11/16/108354.aspx

      # Also use some sanitization from ActiveRecord for the current field passed
      if can_go_quicker
        output = self.where("LOWER(%s) LIKE ?" % params[:db_field], current_field+'%')
      else
        regexp_to_check = current_field =~ /[0-9]/ ? '^[0-9]' : '^[^a-z0-9]'
        output = self.where("LOWER(%s) REGEXP '%s.*'" % [params[:db_field], regexp_to_check])
      end
    end
  else
    availableLetters = {}
    self.find_each({batch_size: params[:batch_size]}) do |x|
      slug = eval("x.#{params[:slug_field]}") if params[:slugged_link]

      field_val = block_given? ? yield(x).to_s : x.id.to_s
      field_letter = field_val[0].mb_chars.downcase.to_s

      case field_letter
        when params[:language].letters_regexp
          availableLetters[field_letter] = true if !availableLetters.has_key? field_letter
          regexp = params[:slugged_link] ? params[:language].slugged_regexp : params[:language].letters_regexp
          field = params[:slugged_link] ? slug : field_letter
          output << x if all || (current_field =~ regexp && current_field == field)
        when /[0-9]/
          if params[:enumerate]
            availableLetters[field_letter] = true if !availableLetters.has_key? field_letter
            output << x if all || (current_field =~ /[0-9]/ && field_letter == current_field) 
          else
            availableLetters['0-9'] = true if !availableLetters.has_key? 'numbers'
            output << x if all || current_field == "0-9"
          end
        else
          availableLetters['*'] = true if !availableLetters.has_key? 'other'
          output << x if all || current_field == "*"
      end
    end
    params[:availableLetters] = availableLetters.collect{ |k,v| k.mb_chars.capitalize.to_s }
    output.sort! {|x, y| block_given? ? (yield(x).to_s <=> yield(y).to_s) : (x.id.to_s <=> y.id.to_s) }
  end
  params[:currentField] = current_field.mb_chars.capitalize.to_s
  return ((params[:db_mode] && params[:db_field]) ? output.order("#{params[:db_field]} ASC") : output), params
end