j1-paginator 2020.0.1

data/lib/j1-paginator/generator/paginationModel.rb

@@ -0,0 +1,407 @@
+module Jekyll
+  module J1Paginator::Generator
+
+    #
+    # The main model for the pagination, handles the orchestration of the
+    # pagination and calling all the necessary bits and bobs needed :)
+    #
+    class PaginationModel
+
+      @debug = false # is debug output enabled?
+      @logging_lambda = nil # The lambda to use for logging
+      @page_add_lambda = nil # The lambda used to create pages and add them to the site
+      @page_remove_lambda = nil # Lambda to remove a page from the site.pages collection
+      @collection_by_name_lambda = nil # Lambda to get all documents/posts in a particular collection (by name)
+
+      # ctor
+      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
+
+      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 # function run
+
+      # This function is here to retain the old compatability logic with the
+      # jekyll-paginate gem no changes should be made to this function and
+      # it should be retired and deleted after 2018-01-01
+      #
+      # def run_compatability(legacy_config, site_pages, site_title, all_posts)
+      #
+      #   # Decomissioning error
+      #   if( date = Date.strptime("20180101","%Y%m%d") <= Date.today )
+      #     raise ArgumentError.new("Legacy jekyll-paginate configuration compatibility mode has expired. Please upgrade to j1-paginator configuration.")
+      #   end
+      #
+      #   # Two month warning or general notification
+      #   if( date = Date.strptime("20171101","%Y%m%d") <= Date.today )
+      #     @logging_lambda.call "Legacy pagination logic will stop working on Jan 1st 2018, update your configs before that time.", "warn"
+      #   else
+      #     @logging_lambda.call "Detected legacy jekyll-paginate logic running. "+
+      #     "Please update your configs to use the j1-paginator logic. This compatibility function "+
+      #     "will stop working after Jan 1st 2018 and your site build will throw an error.", "warn"
+      #   end
+      #
+      #   if template = CompatibilityUtils.template_page(site_pages, legacy_config['legacy_source'], legacy_config['permalink'])
+      #     CompatibilityUtils.paginate(legacy_config, all_posts, template, @page_add_lambda)
+      #   else
+      #     @logging_lambda.call "Legacy pagination is enabled, but I couldn't find " +
+      #     "an index.html page to use as the pagination page. Skipping pagination.", "warn"
+      #   end
+      # end # function run_compatability (REMOVE AFTER 2018-01-01)
+
+      # 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
+      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
+
+      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
+
+      LOG_KEY = 'J1 Paginator: '.rjust(20).freeze
+      DIVIDER = ('-' * 80).freeze
+      NOT_SET = '[Not set]'.freeze
+
+      # Debug print the config
+      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 the config
+      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 the config
+      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
+      
+      #
+      # 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
+      #
+      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 # function discover_paginate_templates
+            
+      # 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
+      #
+      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)
+
+          # 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 # function paginate
+
+    end # class PaginationV2
+
+  end # module J1Paginator
+end # module Jekyll

data/lib/j1-paginator/generator/paginationPage.rb

@@ -0,0 +1,70 @@
+module Jekyll
+  module J1Paginator::Generator
+
+    #
+    # This page handles the creation of the fake pagination pages based
+    # on the original page configuration. The code does the same things as
+    # the default Jekyll/page.rb code but just forces the code to look
+    # into the template instead of the (currently non-existing)
+    # pagination page.
+    #
+    # NOTE: This page exists purely in memory and is not read from disk
+    #
+    class PaginationPage < Page
+      attr_reader :relative_path
+
+      def initialize(page_to_copy, cur_page_nr, total_pages, index_pageandext)
+        @site = page_to_copy.site
+        @base = ''
+        @url  = ''
+        @relative_path = page_to_copy.relative_path
+
+        if cur_page_nr == 1
+          @dir = File.dirname(page_to_copy.dir)
+          @name = page_to_copy.name
+        else
+          @name = index_pageandext.nil? ? 'index.html' : index_pageandext
+        end
+
+        self.process(@name) # Creates the basename and ext member values
+
+        # Copy page data over site defaults
+        defaults = @site.frontmatter_defaults.all(page_to_copy.relative_path, type)
+        self.data = Jekyll::Utils.deep_merge_hashes(defaults, page_to_copy.data)
+
+        if defaults.has_key?('permalink')
+          self.data['permalink'] = Jekyll::URL.new(:template => defaults['permalink'], :placeholders => self.url_placeholders).to_s
+          @use_permalink_for_url = true
+        end
+
+        if !page_to_copy.data['autopage']
+          self.content = page_to_copy.content
+        else
+          # If the page is an auto page then migrate the necessary autopage
+          # info across into the new pagination page (so that users can get
+          # the correct keys etc)
+          if( page_to_copy.data['autopage'].has_key?('display_name') )
+            self.data['autopages'] = Jekyll::Utils.deep_merge_hashes( page_to_copy.data['autopage'], {} )
+          end
+        end
+
+        # Store the current page and total page numbers in the pagination_info
+        # construct
+        self.data['pagination_info'] = {"curr_page" => cur_page_nr, 'total_pages' => total_pages }       
+
+        # Perform some validation that is also performed in Jekyll::Page
+        validate_data! page_to_copy.path
+        validate_permalink! page_to_copy.path
+
+        # Trigger a page event
+        #Jekyll::Hooks.trigger :pages, :post_init, self
+      end
+
+      def url=(url_value)
+        @url = @use_permalink_for_url ? self.data['permalink'] : url_value
+      end
+      alias_method :set_url, :url=
+    end # class PaginationPage
+
+  end # module J1Paginator
+end # module Jekyll