Module: Jekyll::J1Paginator::AutoPages

Defined in:
lib/j1-paginator/autopages/utils.rb,
lib/j1-paginator/autopages/defaults.rb,
lib/j1-paginator/autopages/autoPages.rb,
lib/j1-paginator/autopages/pages/tagAutoPage.rb,
lib/j1-paginator/autopages/pages/baseAutoPage.rb,
lib/j1-paginator/autopages/pages/categoryAutoPage.rb,
lib/j1-paginator/autopages/pages/collectionAutoPage.rb

Defined Under Namespace

Classes: BaseAutoPage, CategoryAutoPage, CollectionAutoPage, TagAutoPage, Utils

Constant Summary collapse

DEFAULT =

The default configuration for the AutoPages

{
  'enabled'     => false,
  'tags'        => {
    'layouts'       => ['autopage_tags.html'],
    'title'         => 'Posts tagged with :tag',
    'permalink'     => '/tag/:tag',
    'enabled'       => true,
    'slugify'       => {
                          'mode' => 'none', # [raw default pretty ascii latin], none gives back the same string
                          'cased'=> false # If cased is true, all uppercase letters in the result string are replaced with their lowercase counterparts.
                        }
  },
  'categories'  => {
    'layouts'       => ['autopage_category.html'],
    'title'         => 'Posts in category :cat',
    'permalink'     => '/category/:cat',
    'enabled'       => true,
    'slugify'       => {
                          'mode' => 'none', # [raw default pretty ascii latin], none gives back the same string
                          'cased'=> false # If cased is true, all uppercase letters in the result string are replaced with their lowercase counterparts.
                        }
  },
  'collections' => {
    'layouts'       => ['autopage_collection.html'],
    'title'         => 'Posts in collection :coll',
    'permalink'     => '/collection/:coll',
    'enabled'       => true,
    'slugify'       => {
                          'mode' => 'none', # [raw default pretty ascii latin], none gives back the same string
                          'cased'=> false # If cased is true, all uppercase letters in the result string are replaced with their lowercase counterparts.
                        }
  } 
}

Class Method Summary collapse

Class Method Details

.autopage_create(autopage_config, pagination_config, posts_to_use, configkey_name, indexkey_name, createpage_lambda) ⇒ Object

STATIC: this function actually performs the steps to generate the autopages.

It uses a lambda function to delegate the creation of the individual
page types to the calling code (this way all features can reuse the
logic).



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/j1-paginator/autopages/autoPages.rb', line 75

def self.autopage_create(autopage_config, pagination_config, posts_to_use, configkey_name, indexkey_name, createpage_lambda )
  if !autopage_config[configkey_name].nil?
    ap_sub_config = autopage_config[configkey_name]
    if ap_sub_config ['enabled']
      Jekyll.logger.info "J1 Paginator:","autopages, generating #{configkey_name} pages"

      # Roll through all documents in the posts collection and extract the tags

      # Cannot use just the posts here, must use all things.. posts, collections...

      index_keys = Utils.ap_index_posts_by(posts_to_use, indexkey_name)

      index_keys.each do |index_key, value|
        # Iterate over each layout specified in the config

        ap_sub_config ['layouts'].each do | layout_name |
          # Use site.dest here as these pages are never created in the

          # actual source but only inside the _site folder

          createpage_lambda.call(ap_sub_config, pagination_config, layout_name, index_key, value[-1]) # the last item in the value array will be the display name

        end
      end
    else
      Jekyll.logger.info "J1 Paginator:","autopages, #{configkey_name} pages are disabled|not configured"
    end
  end
end

.create_autopages(site) ⇒ Object

This function is called right after the main generator is triggered by Jekyll. This code is adapted from Stephen Crosby’s code. See: github.com/stevecrozz



7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
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
 
# File 'lib/j1-paginator/autopages/autoPages.rb', line 7

def self.create_autopages(site)

  # Retrieve and merge the pagination configuration from the plugin yml file

  pg_config_defaults = site.data['plugins']['defaults']['paginator']
  pg_config_settings = site.data['plugins']['paginator']
  pg_settings = Jekyll::Utils.deep_merge_hashes(pg_config_defaults, pg_config_settings || {})

  # Get the configuration for auto pages

  ap_config_defaults = pg_config_defaults['settings']['autopages']
  ap_config_settings = pg_config_settings['settings']['autopages']
  ap_settings = Jekyll::Utils.deep_merge_hashes(ap_config_defaults, ap_config_settings || {})

  # Merge the auto page configuration by the site default settings

  autopage_config = Jekyll::Utils.deep_merge_hashes(DEFAULT, ap_settings || {})


  # Get the configuration for the paginator

  pg_config_defaults = pg_config_defaults['settings']['pagination']
  pg_config_settings = pg_config_settings['settings']['pagination']
  pg_settings = Jekyll::Utils.deep_merge_hashes(pg_config_defaults, pg_config_settings || {})

  # Merge the pagination configuration by the GENERATOR default settings

  pagination_config = Jekyll::Utils.deep_merge_hashes(Jekyll::J1Paginator::Generator::DEFAULT, pg_settings || {})

  # If disabled then don't do anything

  if !autopage_config['enabled'] || autopage_config['enabled'].nil?
    Jekyll.logger.info "J1 Paginator:","autopages, disabled|not configured"
    return
  end

  # TODO: Should I detect here and disable if we're running the

  #       legacy paginate code???!


  # Simply gather all documents across all pages/posts/collections

  # Could be generated quite a few empty pages but the logic is just

  # vastly simpler than trying to figure out what tag/category belong

  # to which collection.

  posts_to_use = Utils.collect_all_docs(site.collections)

  ###############################################

  # Generate the Tag pages if enabled

  createtagpage_lambda = lambda do | autopage_tag_config, pagination_config, layout_name, tag, tag_original_name |
    site.pages << TagAutoPage.new(site, site.dest, autopage_tag_config, pagination_config, layout_name, tag, tag_original_name)
  end
  autopage_create(autopage_config, pagination_config, posts_to_use, 'tags', 'tags', createtagpage_lambda) # Call the actual function

  

  ###############################################

  # Generate the category pages if enabled

  createcatpage_lambda = lambda do | autopage_cat_config, pagination_config, layout_name, category, category_original_name |
    site.pages << CategoryAutoPage.new(site, site.dest, autopage_cat_config, pagination_config, layout_name, category, category_original_name)
  end
  autopage_create(autopage_config, pagination_config,posts_to_use, 'categories', 'categories', createcatpage_lambda) # Call the actual function

  
  ###############################################

  # Generate the Collection pages if enabled

  createcolpage_lambda = lambda do | autopage_col_config, pagination_config, layout_name, coll_name, coll_original_name |
    site.pages << CollectionAutoPage.new(site, site.dest, autopage_col_config, pagination_config, layout_name, coll_name, coll_original_name)
  end
  autopage_create(autopage_config, pagination_config,posts_to_use, 'collections', '__coll', createcolpage_lambda) # Call the actual function


end