Class: ApiPagination::Hooks

Inherits:
Object
  • Object
show all
Defined in:
lib/api-pagination/hooks.rb

Class Method Summary collapse

Class Method Details

.init! ⇒ Object 



3
4
5
6
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
 
# File 'lib/api-pagination/hooks.rb', line 3

def self.init!
  begin; require 'rails'; rescue LoadError; end
  if defined?(ActionController::Base)
    require 'rails/pagination'
    ActionController::Base.send(:include, Rails::Pagination)
  end

  begin; require 'rails-api'; rescue LoadError; end
  if defined?(ActionController::API)
    require 'rails/pagination'
    ActionController::API.send(:include, Rails::Pagination)
  end

  begin; require 'grape'; rescue LoadError; end
  if defined?(Grape::API)
    require 'grape/pagination'
    Grape::API.send(:include, Grape::Pagination)
  end

  # Kaminari and will_paginate conflict with each other, so we should check
  # to see if either is already active before attempting to load them.
  if defined?(Kaminari) && defined?(WillPaginate::CollectionMethods)
    STDERR.puts <<-EOC
Warning: api-pagination relies on either Kaminari or WillPaginate, but these
gems conflict.  Please ensure only one of them is active at any given time.

EOC
    return
  elsif defined?(Kaminari)
    initialize_kaminari! and return
  elsif defined?(WillPaginate::CollectionMethods)
    initialize_will_paginate! and return
  end
  # If neither is loaded, we can safely attempt these requires.
  unless ApiPagination.paginator == :will_paginate
    begin
      require 'kaminari'
      initialize_kaminari! and return
    rescue LoadError
    end
  end

  begin
    require 'will_paginate'
    initialize_will_paginate! and return
  rescue LoadError
  end

  STDERR.puts <<-EOC
Warning: api-pagination relies on either Kaminari or WillPaginate. Please
install either dependency by adding one of the following to your Gemfile:

gem 'kaminari'
gem 'will_paginate'

EOC
end

.initialize_kaminari! ⇒ Object 



61
62
63
64
 
# File 'lib/api-pagination/hooks.rb', line 61

def self.initialize_kaminari!
  require 'kaminari/models/array_extension'
  ApiPagination.instance_variable_set(:@paginator, :kaminari)
end

.initialize_will_paginate! ⇒ Object 



66
67
68
69
70
71
72
73
 
# File 'lib/api-pagination/hooks.rb', line 66

def self.initialize_will_paginate!
  WillPaginate::CollectionMethods.module_eval do
    def first_page?() !previous_page end
    def last_page?() !next_page end
  end

  ApiPagination.instance_variable_set(:@paginator, :will_paginate)
end