jekyll-uj-powertools 1.6.24 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e244425c0a57091b17d74eeb82b585314a5892bc4d2185e6dc50b5d66d7d16c
-  data.tar.gz: e999ee1ea01bee859c675e451c3d8323c984b225a7ae2438f3d06f1f43158848
+  metadata.gz: 60803db8fb2a1e2c50aea11a0f49e964fc16d3323943ce0330f4312fd6468e37
+  data.tar.gz: 05f5ac27b7651b0d5592395cc510ba5b31e77f9b5ead9f35f0de6420d5919fd9
 SHA512:
-  metadata.gz: 4042544bbfb0c7e818b9d56ab22adb617c0e5ab74f5284e03eaab1c2a5fed114b77e3d7860759cdef9d0ba9d057b542e5e916f690bda237defbf7426056fcff7
-  data.tar.gz: cd588783c0bd5b02069eb47363352d6200d03de8b4208004a34a23db7372a123dffc47b2138174e7969f4380cf39f649ac977c06a41e6dfbedd7469592732a5f
+  metadata.gz: 17bb830ad04f8be16741f99f9dcaab5f723b7c9bb58f1ffbdfa0bf9a9637c0357e829c82dd4dc13feee2e70773bde48cd71e1cface15873f7232a60ea6880f4c
+  data.tar.gz: 21c374abbaa0e43c40bf1ecda75ac52eda70dd33140c69c972bf352eca2d571c35c5d70485947275a639c46b7df8e235f496a2b678a29008722ebeadb9e4e62b

data/README.md

@@ -294,6 +294,90 @@ Creates language-specific URLs for multilingual sites.
 {% uj_translation_url target_lang, "/pricing" %}
 ```
 
+## Generators
+
+### Dynamic Pages Generator
+Automatically generate pages from collection data based on frontmatter fields. This is useful for creating category, tag, or any taxonomy pages dynamically without manually creating each page.
+
+#### Configuration
+Add to your `_config.yml`:
+
+```yaml
+generators:
+  collection_categories:
+    # Example 1: Extract category from nested frontmatter field
+    - collection: recipes
+      field: recipe.cuisine       # Dot notation for nested fields
+      layout: recipe-category
+      permalink: /recipes/:slug
+      title: ":name Recipes"
+      description: "Browse our collection of :name recipes."
+
+    # Example 2: Simple frontmatter field
+    - collection: products
+      field: category
+      layout: product-category
+      permalink: /products/:slug
+      title: ":name Products"
+      description: "Shop our :name products."
+
+    # Example 3: Minimal config (uses defaults)
+    - collection: articles
+      field: category
+      layout: article-category
+```
+
+#### Template Variables
+Use these placeholders in `title`, `description`, and `permalink`:
+- `:name` - The formatted category name (e.g., "Asian Cuisine")
+- `:slug` - The URL-safe slug (e.g., "asian-cuisine")
+
+#### Defaults
+- `permalink`: `/:collection/:slug` (e.g., `/recipes/asian`)
+- `title`: `:name`
+- `description`: `Browse our collection of :name.`
+
+#### Generated Page Data
+Each generated page includes the following data accessible in the layout:
+- `page.title` - The formatted title
+- `page.description` - The formatted description
+- `page.category_slug` - URL-safe slug (e.g., "asian-cuisine")
+- `page.category_name` - Human-readable name (e.g., "Asian Cuisine")
+- `page.collection_name` - Source collection name (e.g., "recipes")
+- `page.meta.title` - SEO title with site name appended
+- `page.meta.description` - SEO description
+
+#### Example Layout
+Create a layout file (e.g., `_layouts/recipe-category.html`) to display the category page:
+
+```liquid
+---
+layout: default
+---
+<h1>{{ page.category_name }}</h1>
+<p>{{ page.description }}</p>
+
+{% assign items = site.recipes | where_exp: "item", "item.recipe.cuisine == page.category_name" %}
+{% for item in items %}
+  <article>
+    <h2><a href="{{ item.url }}">{{ item.title }}</a></h2>
+  </article>
+{% endfor %}
+```
+
+## Development Config (`_config.dev.yml`)
+Speed up dev builds by limiting collections. Create `_config.dev.yml` in your Jekyll source:
+
+```yaml
+limit_collections:
+  recipes: 50
+  products: 20
+```
+
+Run with: `bundle exec jekyll serve --config _config.yml,_config.dev.yml`
+
+UJ auto-loads this file in dev mode.
+
 ## Final notes
 These examples show how you can use the features of `jekyll-uj-powertools` in your Jekyll site.
 

data/jekyll-uj-powertools.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 Gem::Specification.new do |spec|
   # Gem info
   spec.name = "jekyll-uj-powertools"
-  spec.version = "1.6.24"
+  spec.version = "1.7.0"
 
   # Author info
   spec.authors = ["ITW Creative Works"]

data/lib/generators/dynamic-pages.rb

@@ -0,0 +1,152 @@
+# Dynamic Pages Generator
+# Automatically generates pages from collection data based on config
+#
+# Usage in _config.yml:
+#
+#   generators:
+#     collection_categories:
+#       # Example 1: Extract category from frontmatter field
+#       - collection: recipes
+#         field: recipe.cuisine       # Dot notation for nested fields
+#         layout: recipe-category
+#         permalink: /recipes/:slug
+#         title: ":name Recipes"
+#         description: "Browse our collection of :name recipes."
+#
+#       # Example 2: Simple frontmatter field
+#       - collection: products
+#         field: category
+#         layout: product-category
+#         permalink: /products/:slug
+#         title: ":name Products"
+#         description: "Shop our :name products."
+#
+#       # Example 3: Minimal config (uses defaults)
+#       - collection: articles
+#         field: category
+#         layout: article-category
+#
+# Template variables for title/description/permalink:
+#   :name - The formatted category name (e.g., "Asian Cuisine")
+#   :slug - The URL-safe slug (e.g., "asian-cuisine")
+#
+# Defaults:
+#   permalink: /:collection/:slug (e.g., /recipes/asian)
+#   title: :name
+#   description: "Browse our collection of :name."
+
+module Jekyll
+  class DynamicPagesGenerator < Generator
+    safe true
+    priority :normal  # Run before InjectProperties (:low) so dynamic pages get resolved data
+
+    def generate(site)
+      config = site.config.dig('generators', 'collection_categories')
+      return unless config.is_a?(Array)
+
+      config.each do |category_config|
+        generate_category_pages(site, category_config)
+      end
+    end
+
+    private
+
+    def generate_category_pages(site, config)
+      collection_name = config['collection']
+      field = config['field']
+      return unless collection_name && field
+
+      collection = site.collections[collection_name]
+      return unless collection
+
+      # Configuration with defaults
+      layout = config['layout']
+      permalink_template = config['permalink'] || "/#{collection_name}/:slug"
+      title_template = config['title'] || ':name'
+      description_template = config['description'] || 'Browse our collection of :name.'
+
+      # Extract unique categories from documents
+      categories = {}
+
+      collection.docs.each do |doc|
+        category_value = dig_value(doc.data, field)
+        next unless category_value && !category_value.empty?
+
+        category_slug = slugify(category_value)
+        next if categories.key?(category_slug)
+
+        # Format category name: titleize
+        category_name = titleize(category_value)
+
+        # Apply templates
+        permalink = apply_template(permalink_template, category_name, category_slug)
+        title = apply_template(title_template, category_name, category_slug)
+        description = apply_template(description_template, category_name, category_slug)
+
+        categories[category_slug] = {
+          'slug' => category_slug,
+          'name' => category_name,
+          'title' => title,
+          'description' => description,
+          'permalink' => permalink
+        }
+      end
+
+      # Generate a page for each category
+      categories.each do |slug, data|
+        page = DynamicCategoryPage.new(site, layout, data, collection_name)
+        site.pages << page
+      end
+
+      Jekyll.logger.info "DynamicPages:", "Generated #{categories.size} category pages for '#{collection_name}'"
+    end
+
+    # Dig into nested hash using dot notation (e.g., "recipe.cuisine")
+    def dig_value(hash, field)
+      keys = field.split('.')
+      value = hash
+      keys.each do |key|
+        return nil unless value.is_a?(Hash)
+        value = value[key]
+      end
+      value.is_a?(String) ? value : nil
+    end
+
+    def slugify(str)
+      str.to_s.downcase.strip.gsub(/[^\w\s-]/, '').gsub(/[\s_]+/, '-')
+    end
+
+    def titleize(str)
+      str.to_s.split(/[\s_-]+/).map(&:capitalize).join(' ')
+    end
+
+    def apply_template(template, name, slug)
+      template.gsub(':name', name).gsub(':slug', slug)
+    end
+  end
+
+  # Custom page class for dynamically generated category pages
+  class DynamicCategoryPage < Page
+    def initialize(site, layout, data, collection_name)
+      @site = site
+      @base = site.source
+      @dir = ''
+      @name = "#{data['slug']}.html"
+
+      self.process(@name)
+      self.data = {
+        'layout' => layout,
+        'title' => data['title'],
+        'description' => data['description'],
+        'category_slug' => data['slug'],
+        'category_name' => data['name'],
+        'collection_name' => collection_name,
+        'permalink' => data['permalink'],
+        'meta' => {
+          'title' => "#{data['title']} - #{site.config.dig('brand', 'name') || site.config['title']}",
+          'description' => data['description']
+        }
+      }
+    end
+  end
+end

data/lib/generators/inject-properties.rb

@@ -5,7 +5,7 @@
 module Jekyll
   class InjectProperties < Generator
     safe true
-    priority :low
+    priority :lowest  # Run LAST so all pages from other generators exist before injecting resolved data
 
     def generate(site)
       # Define a global variable accessible in templates

data/lib/generators/limit-collections.rb

@@ -0,0 +1,56 @@
+# Limit Collections Generator
+# Limits the number of documents in collections during development for faster builds
+#
+# Usage in _config.dev.yml:
+#   limit_collections:
+#     recipes: 50
+#     products: 20
+#
+# By default, uses a seeded random sample for diverse selection across categories.
+# To disable randomization and take first N documents:
+#   limit_collections:
+#     recipes: 50
+#     products: 20
+#     randomize: false
+#
+# Run Jekyll with: bundle exec jekyll serve --config _config.yml,_config.dev.yml
+
+module Jekyll
+  class LimitCollectionsGenerator < Generator
+    safe true
+    priority :highest  # Run before other generators
+
+    def generate(site)
+      limits = site.config['limit_collections']
+      return unless limits.is_a?(Hash)
+
+      # Check if randomization is disabled (default: true)
+      randomize = limits.fetch('randomize', true)
+
+      limits.each do |collection_name, limit|
+        # Skip the 'randomize' option itself
+        next if collection_name == 'randomize'
+        next unless limit.is_a?(Integer) && limit > 0
+
+        collection = site.collections[collection_name]
+        next unless collection
+
+        original_count = collection.docs.size
+        next if original_count <= limit
+
+        if randomize
+          # Use a seeded random for repeatable but diverse sampling
+          # Seed based on collection name so it's consistent across rebuilds
+          rng = Random.new(collection_name.hash.abs)
+          sampled_docs = collection.docs.shuffle(random: rng).first(limit)
+          collection.docs.replace(sampled_docs)
+          Jekyll.logger.info "LimitCollections:", "Limited '#{collection_name}' from #{original_count} to #{limit} documents (random sample)"
+        else
+          # Take first N documents in order
+          collection.docs.replace(collection.docs.first(limit))
+          Jekyll.logger.info "LimitCollections:", "Limited '#{collection_name}' from #{original_count} to #{limit} documents"
+        end
+      end
+    end
+  end
+end

data/lib/jekyll-uj-powertools.rb

@@ -6,8 +6,10 @@ module Jekyll
   require_relative "filters/main"
 
   # Load Generators
+  require_relative "generators/limit-collections"
   require_relative "generators/inject-properties"
   require_relative "generators/blog-taxonomy"
+  require_relative "generators/dynamic-pages"
 
   # Load Hooks
   require_relative "hooks/inject-properties"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-uj-powertools
 version: !ruby/object:Gem::Version
-  version: 1.6.24
+  version: 1.7.0
 platform: ruby
 authors:
 - ITW Creative Works
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-12-17 00:00:00.000000000 Z
+date: 2025-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -115,7 +115,9 @@ files:
 - jekyll-uj-powertools.gemspec
 - lib/filters/main.rb
 - lib/generators/blog-taxonomy.rb
+- lib/generators/dynamic-pages.rb
 - lib/generators/inject-properties.rb
+- lib/generators/limit-collections.rb
 - lib/helpers/variable_resolver.rb
 - lib/hooks/inject-properties.rb
 - lib/hooks/markdown-images.rb