Class: Jekyll::J1Paginator::Generator::PaginationModel

Inherits:
Object
  • Object
show all
Defined in:
lib/j1-paginator/generator/paginationModel.rb

Overview

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

Constant Summary collapse

LOG_KEY = 
'J1 Paginator: '.rjust(20).freeze
DIVIDER = 
('-' * 80).freeze
NOT_SET = 
'[Not set]'.freeze

Instance Method Summary collapse

Constructor Details

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

ctor



17
18
19
20
21
22
 
# File 'lib/j1-paginator/generator/paginationModel.rb', line 17

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_log(topic, message = nil) ⇒ Object

Debug print the config



160
161
162
163
164
165
166
 
# File 'lib/j1-paginator/generator/paginationModel.rb', line 160

def _debug_log(topic, message = nil)
  return unless @debug

  message = message.to_s
  topic   = "#{topic.ljust(24)}: " unless message.empty?
  puts LOG_KEY + topic + message
end

#_debug_print_config_info(config, page_path) ⇒ Object

Debug print the config



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/j1-paginator/generator/paginationModel.rb', line 169

def _debug_print_config_info(config, page_path)
  return unless @debug

  puts ''
  puts LOG_KEY + "Page: #{page_path}"
  puts LOG_KEY + DIVIDER
  _debug_log '  Active configuration'
  _debug_log '    Enabled',        config['enabled']
  _debug_log '    Items per page', config['per_page']
  _debug_log '    Permalink',      config['permalink']
  _debug_log '    Title',          config['title']
  _debug_log '    Limit',          config['limit']
  _debug_log '    Sort by',        config['sort_field']
  _debug_log '    Sort reverse',   config['sort_reverse']
  _debug_log '  Active Filters'
  _debug_log '    Collection',     config['collection']
  _debug_log '    Offset',         config['offset']
  _debug_log '    Category',       (config['category'].nil? || config['category'] == 'posts' ? NOT_SET : config['category'])
  _debug_log '    Tag',            config['tag']    || NOT_SET
  _debug_log '    Locale',         config['locale'] || NOT_SET

  return unless config['legacy']

  _debug_log '  Legacy Paginate Code Enabled'
  _debug_log '    Legacy Paginate', config['per_page']
  _debug_log '    Legacy Source',   config['legacy_source']
  _debug_log '    Legacy Path',     config['paginate_path']
end

#_debug_print_filtering_info(filter_name, before_count, after_count) ⇒ Object

Debug print the config



199
200
201
202
203
204
205
 
# File 'lib/j1-paginator/generator/paginationModel.rb', line 199

def _debug_print_filtering_info(filter_name, before_count, after_count)
  return unless @debug

  filter_name  = filter_name.to_s.ljust(9)
  before_count = before_count.to_s.rjust(3)
  _debug_log "  Filtering by #{filter_name}", "#{before_count} => #{after_count}"
end

#_fix_deprecated_config_features(config) ⇒ Object 



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/j1-paginator/generator/paginationModel.rb', line 139

def _fix_deprecated_config_features(config)
  keys_to_delete = []

  # As of v1.5.1 the title_suffix is deprecated and 'title' should be used
  # but only if title has not been defined already!
  if( !config['title_suffix'].nil? )
    if( config['title'].nil? )
      config['title'] = ":title" + config['title_suffix'].to_s # Migrate the old key to title
    end
    keys_to_delete << "title_suffix" # Always remove the deprecated key if found
  end

  # Delete the depricated keys
  config.delete_if{ |k,| keys_to_delete.include? k }
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



213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/j1-paginator/generator/paginationModel.rb', line 213

def discover_paginate_templates(site_pages)
  candidates = []
  site_pages.select do |page|
    # If the page has the enabled config set, supports any type of
    # file name html or md
    if page.data['pagination'].is_a?(Hash) && page.data['pagination']['enabled']
      candidates << page
    end
  end
  return candidates
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



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/j1-paginator/generator/paginationModel.rb', line 118

def get_docs_in_collections(raw_collection_names)
  if raw_collection_names.is_a?(String)
    collection_names = raw_collection_names.split(/;|,|\s/)
  else
    collection_names = 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'] }

  return 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



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
418
419
420
421
422
423
 
# File 'lib/j1-paginator/generator/paginationModel.rb', line 233

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
  using_posts = PaginationIndexer.read_config_value_and_filter_posts(config, 'category', using_posts, all_categories)
  self._debug_print_filtering_info('Category', before, using_posts.size)
  before = using_posts.size
  using_posts = PaginationIndexer.read_config_value_and_filter_posts(config, 'tag', using_posts, all_tags)
  self._debug_print_filtering_info('Tag', before, using_posts.size)
  before = using_posts.size
  using_posts = PaginationIndexer.read_config_value_and_filter_posts(config, 'locale', using_posts, all_locales)
  self._debug_print_filtering_info('Locale', before, using_posts.size)

  # 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 Jekyll 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 <=> compaison 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
      Jekyll.logger.info "J1 Paginator:", "Rolling through the date fields for all documents"
    end
    using_posts.each do |u_post|
      if u_post.respond_to?('date')
        tmp_date = u_post.date
        if( !tmp_date || tmp_date.nil? )
          if @debug
            Jekyll.logger.info "J1 Paginator:", "Explicitly assigning date for doc: #{u_post.data['title']} | #{u_post.path}"
          end
          u_post.date = File.mtime(u_post.path)
        end
      end
    end

    using_posts.sort!{ |a,b| Utils.sort_values(Utils.sort_get_post_data(a.data, sort_field), Utils.sort_get_post_data(b.data, sort_field)) }

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

    if config['sort_reverse']
      using_posts.reverse!
    end
  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'] && config['limit'].to_i > 0 && 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 default index page name and extension
  indexPageName = config['indexpage'].nil? ? '' : config['indexpage'].split('.')[0]
  indexPageExt =  config['extension'].nil? ? '' : Utils.ensure_leading_dot(config['extension'])
  indexPageWithExt = indexPageName + indexPageExt

  # 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. This .pager member is a built in thing in Jekyll
  # and defines the paginator implementation. Simply override to use mine
  (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, indexPageWithExt )

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

    # 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, indexPageName, indexPageExt)

    # Disabled for now
    if cur_page_nr > 10000000000000
      pagination_path = newpage.instance_variable_get(:@site).instance_variable_get(:@dest)
      last_pagination_page = newpage.instance_variable_get(:@pager).instance_variable_get(:@last_page_path)
      last_pagination_file = pagination_path + last_pagination_page

      if config['rebuild'] == false
        if File.exist?(last_pagination_file)
          Jekyll.logger.info 'J1 Paginator:', 'recreate pagination pages disabled.'
          #
          # TODO: Keep the existing pager file|s from being cleaned by Jekyll
          #
          # Add the page to the site
          @page_add_lambda.call( newpage )
          newpages << newpage
          return
        end
      end
    end

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

    if( template.data['permalink'] )
      newpage.data['permalink'] = pager_path
    end

    # Transfer the title across to the new page
    #
    tmp_title = template.data['title'] || site_title
    if cur_page_nr > 1 && config.has_key?('title')
      # If the user specified a title suffix to be added then let's
      # add that to all the pages except the first
      newpage.data['title'] = "#{Utils.format_page_title(config['title'], tmp_title, cur_page_nr, total_pages)}"
    else
      newpage.data['title'] = tmp_title
    end

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

    # 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 #each.do total_pages

  # 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'] && newpages.size > 1
    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 > 0 || trail_after > 0 )
      newpages.select do | npage |
        idx_start = [ npage.pager.page - trail_before - 1, 0].max # Selecting the beginning of the trail
        idx_end = [idx_start + trail_length, newpages.size].min # Selecting the end of the trail

        # 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
          idx_start = [idx_start - ( trail_length - (idx_end - idx_start) ), 0].max # Never go beyond the zero index
        end

        # Convert the newpages array into a two dimensional array
        # that has [index, page_url] as items
        #puts( "Trail created for page #{npage.pager.page} (idx_start:#{idx_start} idx_end:#{idx_end})")
        npage.pager.page_trail = newpages[idx_start...idx_end].each_with_index.map {|ipage,idx| PageTrail.new(idx_start+idx+1, ipage.pager.page_path, ipage.data['title'])}
        #puts( npage.pager.page_trail )
      end #newpages.select
    end #if trail_before / trail_after
  end # if config['trail']

end

#run(default_config, site_pages, site_title) ⇒ Object 



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
 
# File 'lib/j1-paginator/generator/paginationModel.rb', line 24

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 = self.discover_paginate_templates(site_pages)
  if templates.size <= 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 = Jekyll::Utils.deep_merge_hashes(default_config, template.data['pagination'] || {})

      # Handling deprecation of configuration values
      self._fix_deprecated_config_features(template_config)

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

      self._debug_print_config_info(template_config, template.path)

      # Only paginate the template if it is explicitly enabled
      # This makes the logic simpler by avoiding the need to determine
      # which index pages were generated automatically and which weren't
      if template_config['enabled'].to_s == 'true'
        if !@debug
          @logging_lambda.call "found page: "+template.path, 'debug'
        end

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

        # Create the necessary indexes for the posts
        # Populate a category for all posts
        all_categories = PaginationIndexer.index_posts_by(all_posts, 'categories')

        # Populate a category for all posts (this is here for backward
        # compatibility, do not use this as it will be decommissioned 2018-01-01)
        # (this is a default and must not be used in the category system)
        # all_categories['posts'] = all_posts;

        all_tags = PaginationIndexer.index_posts_by(all_posts, 'tags')
        all_locales = PaginationIndexer.index_posts_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
        self.paginate(template, template_config, site_title, all_posts, all_tags, all_categories, all_locales)
      end
    end
  end #for

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