Class: Dimples::Pager

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/dimples/pager.rb

Overview

A class for paginating a collection of posts.

Constant Summary collapse

DEFAULT_PER_PAGE = 
5

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(url:, posts:, per_page: DEFAULT_PER_PAGE) ⇒ Pager

Returns a new instance of Pager.



16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/dimples/pager.rb', line 16

def initialize(url:, posts:, per_page: DEFAULT_PER_PAGE)
  @url = url
  @url << '/' unless @url[-1] == '/'

  @posts = posts

  @per_page = per_page
  @page_count = (posts.length.to_f / @per_page.to_i).ceil

  step_to(1)
end

Instance Attribute Details

#current_page ⇒ Object (readonly)

Returns the value of attribute current_page.



10
11
12
 
# File 'lib/dimples/pager.rb', line 10

def current_page
  @current_page
end

#next_page ⇒ Object (readonly)

Returns the value of attribute next_page.



10
11
12
 
# File 'lib/dimples/pager.rb', line 10

def next_page
  @next_page
end

#page_count ⇒ Object (readonly)

Returns the value of attribute page_count.



10
11
12
 
# File 'lib/dimples/pager.rb', line 10

def page_count
  @page_count
end

#previous_page ⇒ Object (readonly)

Returns the value of attribute previous_page.



10
11
12
 
# File 'lib/dimples/pager.rb', line 10

def previous_page
  @previous_page
end

Class Method Details

.paginate(url:, posts:, per_page: DEFAULT_PER_PAGE, context: {}, &block) ⇒ Object 



12
13
14
 
# File 'lib/dimples/pager.rb', line 12

def self.paginate(url:, posts:, per_page: DEFAULT_PER_PAGE, context: {}, &block)
  new(url: url, posts: posts).paginate(context: context, &block)
end

Instance Method Details

#current_page_path ⇒ Object 



56
57
58
 
# File 'lib/dimples/pager.rb', line 56

def current_page_path
  @current_page == 1 ? @url : File.join(@url, "page_#{@current_page}")
end

#current_page_url ⇒ Object 



60
61
62
 
# File 'lib/dimples/pager.rb', line 60

def current_page_url
  @current_page == 1 ? @url : "#{@url}page_#{@current_page}"
end

#first_page_url ⇒ Object 



64
65
66
 
# File 'lib/dimples/pager.rb', line 64

def first_page_url
  @url
end

#last_page_url ⇒ Object 



68
69
70
 
# File 'lib/dimples/pager.rb', line 68

def last_page_url
  @page_count == 1 ? @url : "#{@url}page_#{@page_count}"
end

#metadata ⇒ Object 



92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/dimples/pager.rb', line 92

def metadata
  {
    posts: posts_at(current_page),
    pagination: {
      current_page: @current_page,
      page_count: @page_count,
      post_count: @posts.count,
      previous_page: @previous_page,
      next_page: @next_page,
      urls: urls
    }
  }
end

#next_page? ⇒ Boolean

Returns:

  • (Boolean) 


52
53
54
 
# File 'lib/dimples/pager.rb', line 52

def next_page?
  @current_page + 1 <= @page_count
end

#next_page_url ⇒ Object 



78
79
80
 
# File 'lib/dimples/pager.rb', line 78

def next_page_url
  "#{@url}page_#{@next_page}" if @next_page
end

#paginate(context: {}) ⇒ Object 



28
29
30
31
32
33
34
 
# File 'lib/dimples/pager.rb', line 28

def paginate(context: {})
  (1..@page_count).each do |index|
    step_to(index)

    yield(current_page_path, context.merge(metadata)) if block_given?
  end
end

#posts_at(page) ⇒ Object 



44
45
46
 
# File 'lib/dimples/pager.rb', line 44

def posts_at(page)
  @posts.slice((page - 1) * @per_page, @per_page)
end

#previous_page? ⇒ Boolean

Returns:

  • (Boolean) 


48
49
50
 
# File 'lib/dimples/pager.rb', line 48

def previous_page?
  (@current_page - 1).positive?
end

#previous_page_url ⇒ Object 



72
73
74
75
76
 
# File 'lib/dimples/pager.rb', line 72

def previous_page_url
  return unless @previous_page

  @previous_page == 1 ? @url : "#{@url}page_#{@previous_page}"
end

#step_to(page) ⇒ Object 



36
37
38
39
40
41
42
 
# File 'lib/dimples/pager.rb', line 36

def step_to(page)
  @current_page = page
  @previous_page = previous_page? ? @current_page - 1 : nil
  @next_page = next_page? ? @current_page + 1 : nil

  @current_page
end

#urls ⇒ Object 



82
83
84
85
86
87
88
89
90
 
# File 'lib/dimples/pager.rb', line 82

def urls
  {
    current_page: current_page_url,
    first_page: first_page_url,
    last_page: last_page_url,
    previous_page: previous_page_url,
    next_page: next_page_url
  }
end