Class: Middleman::Blog::Paginator

Inherits:
Object
  • Object
show all
Defined in:
lib/middleman-blog/paginator.rb

Overview

A sitemap plugin that splits indexes (including tag and calendar indexes) over multiple pages

Instance Method Summary collapse

Constructor Details

#initialize(app, controller = nil) ⇒ Paginator

Returns a new instance of Paginator.



7
8
9
10
 
# File 'lib/middleman-blog/paginator.rb', line 7

def initialize(app, controller=nil)
  @app = app
  @blog_controller = controller
end

Instance Method Details

#blog_data ⇒ Object 



12
13
14
15
16
17
18
 
# File 'lib/middleman-blog/paginator.rb', line 12

def blog_data
  if @blog_controller
    @blog_controller.data
  else
    @app.blog
  end
end

#blog_options ⇒ Object 



20
21
22
23
24
25
26
 
# File 'lib/middleman-blog/paginator.rb', line 20

def blog_options
  if @blog_controller
    @blog_controller.options
  else
    @app.blog.options
  end
end

#manipulate_resource_list(resources)

This method returns an undefined value.

Update the main sitemap resource list



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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/middleman-blog/paginator.rb', line 47

def manipulate_resource_list(resources)
  new_resources = []

  resources.each do |res|
    next if res.ignored?

    md = res.metadata

    # Skip other blogs' resources
    res_controller = md[:locals]["blog_controller"] || (res.respond_to?(:blog_controller) && res.blog_controller)
    next if @blog_controller && res_controller && (res_controller != @blog_controller)
    override_controller = md[:page]["blog"]
    next if @blog_controller && override_controller && override_controller != @blog_controller.uid

    if md[:page]["pageable"]
      # "articles" local variable is populated by Calendar and Tag page generators
      # If it's not set then use the complete list of articles
      # TODO: Some way to allow the frontmatter to specify the article filter?
      articles = md[:locals]["articles"] || self.blog_data.articles

      # Allow blog.per_page and blog.page_link to be overridden in the frontmatter
      per_page  = md[:page]["per_page"] || self.blog_options.per_page
      page_link = md[:page]["page_link"] || self.blog_options.page_link

      num_pages = (articles.length / per_page.to_f).ceil

      # Add the pagination metadata to the base page (page 1)
      res.add_metadata :locals => {
        # Set a flag to allow templates to be used with and without pagination
        'paginate' => true,

        # Include the numbers, useful for displaying "Page X of Y"
        'page_number' => 1,
        'num_pages' => num_pages,
        'per_page' => per_page,

        # The range of article numbers on this page
        # (1-based, for showing "Items X to Y of Z")
        'page_start' => 1,
        'page_end' => [per_page, articles.length].min,

        # These contain the next and previous page.
        # They are set to nil if there are no more pages.
        # The nils are overwritten when the later pages are generated, below.
        'next_page' => nil,
        'prev_page' => nil,

        # The list of articles for this page.
        'page_articles' => articles[0..per_page-1],

        # Include the articles so that non-proxied pages can use "articles" instead
        # of "blog.articles" for consistency with the calendar and tag templates.
        'articles' => articles,
        'blog_controller' => @blog_controller
      }

      prev_page_res = res

      # Create additional resources for the 2nd and subsequent pages.
      (2..num_pages).each do |num|
        p = ::Middleman::Sitemap::Resource.new(
          @app.sitemap,
          page_sub(res, num, page_link),
          res.source_file
        )

        # Copy the metadata from the base page.
        p.add_metadata md

        # Copy the proxy state from the base page.
        p.proxy_to(res.proxied_to) if res.proxy?

        page_start = (num-1)*per_page
        page_end   = (num*per_page)-1

        # Add pagination metadata, meanings as above.
        p.add_metadata :locals => {
          'paginate' => true,
          'page_number' => num,
          'num_pages' => num_pages,
          'per_page' => per_page,
          'page_start' => page_start+1,
          'page_end' => [page_end+1, articles.length].min,
          'next_page' => nil,
          'prev_page' => prev_page_res,
          'page_articles' => articles[page_start..page_end],
          'articles' => articles,
          'blog_controller' => @blog_controller
        }

        # Add a reference in the previous page to this page
        prev_page_res.add_metadata :locals => {
          'next_page' => p
        }

        prev_page_res = p

        new_resources << p
      end
    end
  end

  resources + new_resources
end

#page_sub(res, num, page_link) ⇒ String

Substitute the page number into the resource URL.

Returns:

  • (String) 


30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/middleman-blog/paginator.rb', line 30

def page_sub(res, num, page_link)
  if num == 1
    # First page has an unmodified URL.
    res.path
  else
    page_url = page_link.sub(":num", num.to_s)
    index_re = %r{(^|/)#{Regexp.escape(@app.index_file)}$}
    if res.path =~ index_re
      res.path.sub(index_re, "\\1#{page_url}/#{@app.index_file}")
    else
      res.path.sub(%r{(^|/)([^/]*)\.([^/]*)$}, "\\1\\2/#{page_url}.\\3")
    end
  end
end