Class: Bridgetown::Paginate::Generator::PaginationModel

Inherits:
Object
  • Object
show all
Defined in:
lib/bridgetown-paginate/pagination_model.rb

Overview

The main model for the pagination, handles the orchestration of the pagination and calling all the necessary bits and bobs needed :)

Instance Method Summary collapse

Constructor Details

#initialize(logging_lambda, page_add_lambda, page_remove_lambda, collection_by_name_lambda) ⇒ PaginationModel

Returns a new instance of PaginationModel.



21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/bridgetown-paginate/pagination_model.rb', line 21

def initialize(
  logging_lambda,
  page_add_lambda,
  page_remove_lambda,
  collection_by_name_lambda
)
  @logging_lambda = logging_lambda
  @page_add_lambda = page_add_lambda
  @page_remove_lambda = page_remove_lambda
  @collection_by_name_lambda = collection_by_name_lambda
end

Instance Method Details

#_debug_print_config_info(config, page_path) ⇒ Object

rubocop:disable Layout/LineLength



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/bridgetown-paginate/pagination_model.rb', line 122

def _debug_print_config_info(config, page_path)
  r = 20
  f = "Pagination: ".rjust(20)
  # Debug print the config
  if @debug
    puts f + "----------------------------"
    puts f + "Page: " + page_path.to_s
    puts f + " Active configuration"
    puts f + "  Enabled: ".ljust(r) + config["enabled"].to_s
    puts f + "  Items per page: ".ljust(r) + config["per_page"].to_s
    puts f + "  Permalink: ".ljust(r) + config["permalink"].to_s
    puts f + "  Title: ".ljust(r) + config["title"].to_s
    puts f + "  Limit: ".ljust(r) + config["limit"].to_s
    puts f + "  Sort by: ".ljust(r) + config["sort_field"].to_s
    puts f + "  Sort reverse: ".ljust(r) + config["sort_reverse"].to_s

    puts f + " Active Filters"
    puts f + "  Collection: ".ljust(r) + config["collection"].to_s
    puts f + "  Offset: ".ljust(r) + config["offset"].to_s
    puts f + "  Category: ".ljust(r) + (config["category"].nil? || config["category"] == "posts" ? "[Not set]" : config["category"].to_s)
    puts f + "  Tag: ".ljust(r) + (config["tag"].nil? ? "[Not set]" : config["tag"].to_s)
    puts f + "  Locale: ".ljust(r) + (config["locale"].nil? ? "[Not set]" : config["locale"].to_s)
  end
end

#_debug_print_filtering_info(filter_name, before_count, after_count) ⇒ Object

rubocop:disable Layout/LineLength



149
150
151
152
153
154
 
# File 'lib/bridgetown-paginate/pagination_model.rb', line 149

def _debug_print_filtering_info(filter_name, before_count, after_count)
  # Debug print the config
  if @debug
    puts "Pagination: ".rjust(20) + " Filtering by: " + filter_name.to_s.ljust(9) + " " + before_count.to_s.rjust(3) + " => " + after_count.to_s
  end
end

#discover_paginate_templates(site_pages) ⇒ Object

Rolls through all the pages passed in and finds all pages that have pagination enabled on them. These pages will be used as templates

site_pages - All pages in the site



164
165
166
167
168
 
# File 'lib/bridgetown-paginate/pagination_model.rb', line 164

def discover_paginate_templates(site_pages)
  site_pages.select do |page|
    page.data["pagination"].is_a?(Hash) && page.data["pagination"]["enabled"]
  end
end

#get_docs_in_collections(raw_collection_names) ⇒ Object

Returns the combination of all documents in the collections that are specified raw_collection_names can either be a list of collections separated by a ‘,’ or ‘ ’ or a single string



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/bridgetown-paginate/pagination_model.rb', line 100

def get_docs_in_collections(raw_collection_names)
  collection_names = if raw_collection_names.is_a?(String)
                       raw_collection_names.split %r!/;|,|\s/!
                     else
                       raw_collection_names
                     end

  docs = []
  # Now for each of the collections get the docs
  collection_names.each do |coll_name|
    # Request all the documents for the collection in question, and join
    # it with the total collection
    docs += @collection_by_name_lambda.call coll_name.downcase.strip
  end

  # Hidden documents should not not be processed anywhere.
  docs = docs.reject { |doc| doc["hidden"] }

  docs
end

#paginate(template, config, site_title, all_posts, all_tags, all_categories, all_locales) ⇒ Object

Paginates the blog’s posts. Renders the index.html file into paginated directories, e.g.: page2/index.html, page3/index.html, etc and adds more site-wide data.

site - The Site. template - The index.html Page that requires pagination. config - The configuration settings that should be used



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/bridgetown-paginate/pagination_model.rb', line 178

def paginate(
  template,
  config,
  site_title,
  all_posts,
  all_tags,
  all_categories,
  all_locales
)
  # By default paginate on all posts in the site
  using_posts = all_posts

  # Now start filtering out any posts that the user doesn't want included
  # in the pagination
  before = using_posts.size.to_i
  using_posts = PaginationIndexer.read_config_value_and_filter_documents(
    config,
    "category",
    using_posts,
    all_categories
  )
  _debug_print_filtering_info("Category", before, using_posts.size.to_i)
  before = using_posts.size.to_i
  using_posts = PaginationIndexer.read_config_value_and_filter_documents(
    config,
    "tag",
    using_posts,
    all_tags
  )
  _debug_print_filtering_info("Tag", before, using_posts.size.to_i)
  before = using_posts.size.to_i
  using_posts = PaginationIndexer.read_config_value_and_filter_documents(
    config,
    "locale",
    using_posts,
    all_locales
  )
  _debug_print_filtering_info("Locale", before, using_posts.size.to_i)

  # Apply sorting to the posts if configured, any field for the post is
  # available for sorting
  if config["sort_field"]
    sort_field = config["sort_field"].to_s

    # There is an issue in Bridgetown related to lazy initialized member
    # variables that causes iterators to
    # break when accessing an uninitialized value during iteration. This
    # happens for document.rb when the <=> comparison function
    # is called (as this function calls the 'date' field which for drafts
    # are not initialized.)
    # So to unblock this common issue for the date field I simply iterate
    # once over every document and initialize the .date field explicitly
    if @debug
      puts "Pagination: ".rjust(20) + "Rolling through the date fields for all documents"
    end
    using_posts.each do |u_post|
      next unless u_post.respond_to?("date")

      tmp_date = u_post.date
      if !tmp_date || tmp_date.nil?
        if @debug
          puts "Pagination: ".rjust(20) +
            "Explicitly assigning date for doc: #{u_post.data["title"]} | #{u_post.path}"
        end
        u_post.date = File.mtime(u_post.path)
      end
    end

    using_posts.sort! do |a, b|
      Utils.sort_values(
        Utils.sort_get_post_data(a.data, sort_field),
        Utils.sort_get_post_data(b.data, sort_field)
      )
    end

    # Remove the first x entries
    offset_post_count = [0, config["offset"].to_i].max
    using_posts.pop(offset_post_count)

    using_posts.reverse! if config["sort_reverse"]
  end

  # Calculate the max number of pagination-pages based on the configured per page value
  total_pages = Utils.calculate_number_of_pages(using_posts, config["per_page"])

  # If a upper limit is set on the number of total pagination pages then impose that now
  if config["limit"].to_i.positive? && config["limit"].to_i < total_pages
    total_pages = config["limit"].to_i
  end

  #### BEFORE STARTING REMOVE THE TEMPLATE PAGE FROM THE SITE LIST!
  @page_remove_lambda.call template

  # list of all newly created pages
  newpages = []

  # Consider the index page name and extension
  # By default, they will be nil and the Page object will infer
  # it from the template used
  index_page_name = config["indexpage"].split(".")[0] unless config["indexpage"].nil?
  index_page_ext = unless index_page_name.nil? || config["extension"].nil?
                     Utils.ensure_leading_dot(config["extension"])
                   end
  index_page_with_ext = index_page_name + index_page_ext if index_page_name

  # In case there are no (visible) posts, generate the index file anyway
  total_pages = 1 if total_pages.zero?

  # Now for each pagination page create it and configure the ranges for
  # the collection
  # The .pager member is a built in thing in Bridgetown and references the
  # paginator implementation
  # rubocop:disable Metrics/BlockLength
  (1..total_pages).each do |cur_page_nr|
    # 1. Create the in-memory page
    # External Proc call to create the actual page for us (this is
    # passed in when the pagination is run)
    newpage = PaginationPage.new(
      template,
      cur_page_nr,
      total_pages,
      index_page_with_ext,
      template.ext
    )

    # 2. Create the url for the in-memory page (calc permalink etc),
    # construct the title, set all page.data values needed
    paginated_page_url = config["permalink"]
    first_index_page_url = if template.data["permalink"]
                             Utils.ensure_trailing_slash(
                               template.data["permalink"]
                             )
                           else
                             Utils.ensure_trailing_slash(template.dir)
                           end
    paginated_page_url = File.join(first_index_page_url, paginated_page_url)

    # 3. Create the pager logic for this page, pass in the prev and next
    # page numbers, assign pager to in-memory page
    newpage.pager = Paginator.new(
      config["per_page"],
      first_index_page_url,
      paginated_page_url,
      using_posts,
      cur_page_nr,
      total_pages,
      index_page_name,
      index_page_ext
    )

    # Create the url for the new page, make sure we prepend any permalinks
    # that are defined in the template page before
    if newpage.pager.page_path.end_with? "/"
      newpage.set_url(File.join(newpage.pager.page_path, index_page_with_ext))
    elsif newpage.pager.page_path.end_with? index_page_ext.to_s
      # Support for direct .html files
      newpage.set_url(newpage.pager.page_path)
    else
      # Support for extensionless permalinks
      newpage.set_url(newpage.pager.page_path + index_page_ext.to_s)
    end

    newpage.data["permalink"] = newpage.pager.page_path if template.data["permalink"]

    # Transfer the title across to the new page
    tmp_title = if !template.data["title"]
                  site_title
                else
                  template.data["title"]
                end

    # If the user specified a title suffix to be added then let's add that
    # to all the pages except the first
    if cur_page_nr > 1 && config.key?("title")
      newtitle = Utils.format_page_title(
        config["title"],
        tmp_title,
        cur_page_nr,
        total_pages
      )
      newpage.data["title"] = newtitle.to_s
    else
      newpage.data["title"] = tmp_title
    end

    # Signals that this page is automatically generated by the pagination logic
    # (we don't do this for the first page as it is there to mask the one we removed)
    newpage.data["autogen"] = "bridgetown-paginate" if cur_page_nr > 1

    # Add the page to the site
    @page_add_lambda.call newpage

    # Store the page in an internal list for later referencing if we need
    # to generate a pagination number path later on
    newpages << newpage
  end
  # rubocop:enable Metrics/BlockLength

  # Now generate the pagination number path, e.g. so that the users can
  # have a prev 1 2 3 4 5 next structure on their page
  # simplest is to include all of the links to the pages preceeding the
  # current one (e.g for page 1 you get the list 2, 3, 4.... and for
  # page 2 you get the list 3,4,5...)
  if config["trail"] && !config["trail"].nil? && newpages.size.to_i.positive?
    trail_before = [config["trail"]["before"].to_i, 0].max
    trail_after = [config["trail"]["after"].to_i, 0].max
    trail_length = trail_before + trail_after + 1

    if trail_before.positive? || trail_after.positive?
      newpages.select do |npage|
        # Selecting the beginning of the trail
        idx_start = [npage.pager.page - trail_before - 1, 0].max
        # Selecting the end of the trail
        idx_end = [idx_start + trail_length, newpages.size.to_i].min

        # Always attempt to maintain the max total of <trail_length> pages
        # in the trail (it will look better if the trail doesn't shrink)
        if idx_end - idx_start < trail_length
          # Attempt to pad the beginning if we have enough pages
          # Never go beyond the zero index
          idx_start = [
            idx_start - (trail_length - (idx_end - idx_start)),
            0,
          ].max
        end

        # Convert the newpages array into a two dimensional array that has
        # [index, page_url] as items
        npage.pager.page_trail = newpages[idx_start...idx_end] \
          .each_with_index.map do |ipage, idx|
          PageTrail.new(
            idx_start + idx + 1,
            ipage.pager.page_path,
            ipage.data["title"]
          )
        end
      end
    end
  end
end

#run(default_config, site_pages, site_title) ⇒ Object 



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
 
# File 'lib/bridgetown-paginate/pagination_model.rb', line 33

def run(default_config, site_pages, site_title)
  # By default if pagination is enabled we attempt to find all index.html
  # pages in the site
  templates = discover_paginate_templates(site_pages)
  if templates.size.to_i <= 0
    @logging_lambda.call "Is enabled, but I couldn't find any pagination page." \
      " Skipping pagination. Pages must have 'pagination: enabled: true'" \
      " in their front-matter for pagination to work.", "warn"
    return
  end

  # Now for each template page generate the paginator for it
  templates.each do |template|
    # All pages that should be paginated need to include the pagination
    # config element
    if template.data["pagination"].is_a?(Hash)
      template_config = Bridgetown::Utils.deep_merge_hashes(
        default_config,
        template.data["pagination"] || {}
      )

      # Is debugging enabled on the page level
      @debug = template_config["debug"]

      _debug_print_config_info(template_config, template.path)

      # Only paginate the template if it is explicitly enabled
      # requiring this makes the logic simpler as I don't need to
      # determine which index pages were generated automatically and
      # which weren't
      if template_config["enabled"]
        @logging_lambda.call "found page: " + template.path, "debug" unless @debug

        # Request all documents in all collections that the user has requested
        all_posts = get_docs_in_collections(template_config["collection"])

        # Create the necessary indexes for the posts
        all_categories = PaginationIndexer.index_documents_by(all_posts, "categories")
        all_tags = PaginationIndexer.index_documents_by(all_posts, "tags")
        all_locales = PaginationIndexer.index_documents_by(all_posts, "locale")

        # TODO: NOTE!!! This whole request for posts and indexing results
        # could be cached to improve performance, leaving like this for
        # now during testing

        # Now construct the pagination data for this template page
        paginate(
          template,
          template_config,
          site_title,
          all_posts,
          all_tags,
          all_categories,
          all_locales
        )
      end
    end
  end

  # Return the total number of templates found
  templates.size.to_i
end