jekyll-uj-powertools 1.5.2 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c546d3b5f77c67bf33fdcdbecfeb0c741760a89fdcf508f05caf7943b19b197
-  data.tar.gz: 2612f6dae15afb265e3193bccdaf038421eb1ad51e3bdd955c0ce610b324e441
+  metadata.gz: 4457cc2876947bfe080aa15d492f502208e3dd64573c71e11eb3735cf6a6a6b7
+  data.tar.gz: d8cbd12fcdccc5aedad51ded42d41d03a86cbc92610b722705b16ceafffc50c9
 SHA512:
-  metadata.gz: e95b14dd432df58e934bb9cab3c77eb8bb577cc6e917475692753ec95b9d78ed8759e4310c6560fa6bb5da350519eb3e3fe97fc3278c78c2b345e021a53fc256
-  data.tar.gz: 54646abcd5832dabb835cdfff9dfb71d80aebe28df1727381497beb7af057ef594a05231cc9327ddf87f74484c1c6035d440a394b5fd97568943e641999f9af8
+  metadata.gz: 9e6058f9e42984ad01939d759cc706daaf1af6a88bea81d33fd30815ca34ba05a48e2491f5b40abb8548990f11122f60bf190b1cdc6daae8b2a2a0d4d9d526b3
+  data.tar.gz: 80348c6d1d507ae4301cf48e4b862e8687d404260edd9c0fbeb34633c7c23993a18dbde89d54e5d3dcf83052fd88563cec6b76a7e1637bb6573c5647f469f48a

data/README.md

@@ -70,6 +70,33 @@ Convert a string to title case.
 {{ "hello world" | uj_title_case }}
 ```
 
+### `uj_content_format` Filter
+Process content with Liquid templating and Markdown conversion, automatically transforming markdown images to responsive `uj_image` tags.
+
+```liquid
+{{ post.content | uj_content_format }}
+```
+
+This filter:
+- Transforms markdown images `![alt](url)` to `{% uj_image "url", alt="alt", class="..." %}`
+- Automatically pulls image class from `page.resolved.theme.blog.image.class`
+- Processes Liquid tags in the content
+- Converts Markdown to HTML (for .md files)
+
+If no class is specified in frontmatter, the `uj_image` tag will be rendered without a class attribute.
+
+#### Frontmatter Configuration Example
+```yaml
+---
+theme:
+  blog:
+    image:
+      class: "img-fluid rounded-3 shadow"
+---
+```
+
+With this frontmatter, all markdown images in the post will automatically use the specified class.
+
 ## Global Variables
 ### `site.uj.cache_breaker` Variable
 Use the `site.uj.cache_breaker` variable to append a cache-busting query parameter to your assets.
@@ -78,7 +105,7 @@ Use the `site.uj.cache_breaker` variable to append a cache-busting query paramet
 <link rel="stylesheet" href="{{ "/assets/css/style.css" | prepend: site.baseurl }}?v={{ site.uj.cache_breaker }}">
 ```
 
-### Page Variables
+## Page Variables
 ### `page.random_id` Variable
 Generate a random ID for each page, useful for sorting randomly or for unique identifiers.
 
@@ -126,6 +153,91 @@ Resolves the site, layout, and page data into a single object, which can be usef
 {{ page.my.variable | default: layout.my.variable | default: site.my.variable }}
 ```
 
+## Tags
+### `iftruthy` Tag
+A custom Liquid tag that checks if a variable is truthy (not nil, not false, not empty string, not 0) and renders the content inside the tag if it is truthy.
+```liquid
+{% iftruthy my_variable %}
+  <p>This content will only be rendered if my_variable is truthy.</p>
+{% endiftruthy %}
+```
+
+### `iffalsy` Tag
+A custom Liquid tag that checks if a variable is falsy (nil, false, empty string, or 0) and renders the content inside the tag if it is falsy.
+```liquid
+{% iffalsy my_variable %}
+  <p>This content will only be rendered if my_variable is falsy.</p>
+{% endifalsy %}
+```
+
+### `uj_icon` Tag
+A custom Liquid tag that renders a Font Awesome icon with the specified style and name. It supports `name` and `class` parameters.
+```liquid
+{% uj_icon "rocket", "fa-lg me-2" %}
+```
+
+### `uj_fake_comments` Tag
+Generates a fake comment count based on content word count for demonstration purposes.
+```liquid
+{% uj_fake_comments %}
+{% uj_fake_comments page.content %}
+```
+
+### `uj_image` Tag
+Renders responsive images with WebP support and lazy loading.
+```liquid
+{% uj_image "/assets/images/hero.jpg", max_width="1024", alt="Hero image" %}
+{% uj_image page.featured_image, class="img-fluid", webp="false" %}
+```
+
+### `uj_language` Tag
+Converts ISO language codes to language names in English or native format.
+```liquid
+{% uj_language "es" %}
+{% uj_language page.language, "native" %}
+```
+
+### `uj_member` Tag
+Retrieves member information from site team collection.
+```liquid
+{% uj_member "john-doe", "name" %}
+{% uj_member page.author, "url" %}
+{% uj_member member_id, "image" %}
+{% uj_member "john-doe", "image-tag", max_width="640", class="team-photo" %}
+```
+
+The `image-tag` property renders a responsive image using the `uj_image` tag with all its features (WebP, lazy loading, responsive sizes). You can pass any `uj_image` options as additional parameters.
+
+### `uj_post` Tag
+Fetches post data from site collections.
+```liquid
+{% uj_post "my-post-slug", "title" %}
+{% uj_post post.id, "description" %}
+{% uj_post current_post, "image-url" %}
+```
+
+### `uj_readtime` Tag
+Calculates estimated reading time based on content (200 words per minute).
+```liquid
+{% uj_readtime %}
+{% uj_readtime page.content %}
+```
+
+### `uj_social` Tag
+Generates social media URLs from platform handles.
+```liquid
+{% uj_social "twitter" %}
+{% uj_social "github" %}
+```
+
+### `uj_translation_url` Tag
+Creates language-specific URLs for multilingual sites.
+```liquid
+{% uj_translation_url "es", page.url %}
+{% uj_translation_url target_lang, "/pricing" %}
+```
+
+## Final notes
 These examples show how you can use the features of `jekyll-uj-powertools` in your Jekyll site.
 
 ## 🔧 Development
@@ -133,9 +245,6 @@ After checking out the repo, run `bin/setup` to install dependencies. You can al
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 
-
-
-
 ## ⚠️ Testing
 Run the tests
 ```shell

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.5.2"
+  spec.version = "1.6.1"
 
   # Author info
   spec.authors = ["ITW Creative Works"]
@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
 
   # Translation and HTML manipulation requires Nokogiri
   spec.add_runtime_dependency 'nokogiri', '>= 1.17'

data/lib/filters/main.rb

@@ -1,11 +1,12 @@
 # Libraries
 require "jekyll"
+require "json"
 
-# Module
+# Filters
 module Jekyll
   module UJPowertools
-    # Initialize a timestamp that will remain consistent across calls
-    @cache_timestamp = Time.now.to_i.to_s
+    # Initialize a timestamp that will remain consistent across calls (with milliseconds)
+    @cache_timestamp = (Time.now.to_f * 1000).to_i.to_s
 
     # Strip ads from the input
     def uj_strip_ads(input)
@@ -48,11 +49,6 @@ module Jekyll
       rand(input)
     end
 
-    # Return the current year
-    def uj_year(input)
-      Time.now.year
-    end
-
     # Title case
     def uj_title_case(input)
       input.split(' ').map(&:capitalize).join(' ')
@@ -79,11 +75,18 @@ module Jekyll
 
     # Format content based on file extension - apply liquify and markdownify for .md files
     def uj_content_format(input)
+      # Return empty string if input is nil
+      return '' unless input
+      
       # Get the current page from context
       page = @context.registers[:page] if @context.respond_to?(:registers)
       page ||= @context[:registers][:page] if @context.is_a?(Hash)
+      
+      # Get site from context
+      site = @context.registers[:site] if @context.respond_to?(:registers)
+      site ||= @context[:registers][:site] if @context.is_a?(Hash)
 
-      # Apply liquify first
+      # Simply apply liquify first (markdown images are already converted to uj_image tags by the hook)
       liquified = if @context.respond_to?(:registers)
         Liquid::Template.parse(input).render(@context)
       else
@@ -91,22 +94,37 @@ module Jekyll
       end
 
       # Check if the page extension is .md
-      if page && page['extension'] == '.md'
+      if page && page['extension'] == '.md' && site
         # Apply markdownify for markdown files
-        site = @context.registers[:site] if @context.respond_to?(:registers)
-        site ||= @context[:registers][:site] if @context.is_a?(Hash)
-
-        if site
-          converter = site.find_converter_instance(Jekyll::Converters::Markdown)
-          converter.convert(liquified)
-        else
-          liquified
-        end
+        converter = site.find_converter_instance(Jekyll::Converters::Markdown)
+        converter.convert(liquified)
       else
         # Return just liquified content for non-markdown files
         liquified
       end
     end
+
+    # Pretty print JSON with configurable indentation (default 2 spaces)
+    def uj_jsonify(input, indent_size = 2)
+      indent_string = ' ' * indent_size.to_i
+      JSON.pretty_generate(input, indent: indent_string)
+    end
+    
+    private
+    
+    # Helper method to safely dig through nested hashes
+    def dig_value(hash, *keys)
+      return nil unless hash
+      
+      value = hash
+      keys.each do |key|
+        return nil unless value.is_a?(Hash)
+        value = value[key]
+        return nil if value.nil?
+      end
+      
+      value
+    end
   end
 end
 

data/lib/generators/inject-properties.rb

@@ -1,9 +1,9 @@
 # Libraries
 # ...
 
-# Module
+# Generator
 module Jekyll
-  class InjectData < Generator
+  class InjectProperties < Generator
     safe true
     priority :low
 
@@ -75,16 +75,16 @@ module Jekyll
     def get_layout_chain(layout_name, site)
       chain = []
       current_layout_name = layout_name
-      
+
       # Traverse up the layout hierarchy
       while current_layout_name
         layout = site.layouts[current_layout_name]
         break unless layout
-        
+
         chain.unshift(layout)  # Add to beginning to maintain parent->child order
         current_layout_name = layout.data['layout']
       end
-      
+
       chain
     end
 
@@ -95,13 +95,13 @@ module Jekyll
         'path', 'relative_path', 'collection', 'type', 'id', 'url',
         'next', 'previous', 'draft', 'ext', 'excerpt', 'output'
       ]
-      
+
       filtered = {}
       data.each do |key, value|
         next if jekyll_internals.include?(key)
         filtered[key] = value
       end
-      
+
       filtered
     end
 
@@ -114,6 +114,27 @@ module Jekyll
         item.data['extension'] = File.extname(item.path)
       end
 
+
+      # Inject canonical URL
+      if item.respond_to?(:url)
+        page_url_stripped = item.url.sub(/index\.html$/, '')
+        page_url_stripped = '' if page_url_stripped == '/'
+        site_url = site.config['url'] || ''
+        item.data['canonical'] = {
+          'url' => site_url + page_url_stripped,
+          'path' => page_url_stripped.empty? ? '/' : page_url_stripped
+        }
+      end
+
+      # Inject page type based on post or member properties
+      if item.data['post']
+        item.data['type'] = 'post'
+      elsif item.data['member']
+        item.data['type'] = 'member'
+      else
+        item.data['type'] = 'basic'
+      end
+
       # Set resolved data for site, layout, and page
       # Create a deep merge of site -> child layouts -> parent layouts -> page data
       # Priority: page (highest) -> parent layouts -> child layouts -> site (lowest)
@@ -155,5 +176,6 @@ module Jekyll
       # Add the resolved data to the item
       item.data['resolved'] = resolved
     end
+
   end
 end

data/lib/hooks/inject-properties.rb

@@ -3,6 +3,16 @@
 
 # Hook
 Jekyll::Hooks.register :site, :pre_render do |site|
+  # Ensure uj config exists
   site.config['uj'] ||= {}
+
+  # Set cache breaker
   site.config['uj']['cache_breaker'] = Jekyll::UJPowertools.cache_timestamp
+
+  # Add date properties
+  site.config['uj']['date'] ||= {}
+  now = Time.now
+  site.config['uj']['date']['year'] = now.year
+  site.config['uj']['date']['month'] = now.month
+  site.config['uj']['date']['day'] = now.day
 end

data/lib/hooks/markdown-images.rb

@@ -0,0 +1,40 @@
+# Libraries
+require "jekyll"
+
+module Jekyll
+  # Hook into the pre_render phase to transform markdown images before conversion
+  Jekyll::Hooks.register [:posts, :pages, :documents], :pre_render do |doc|
+    # Only process markdown files
+    if doc.extname == ".md"
+      # Get image class from resolved data if available
+      image_class = nil
+      if doc.data['resolved'] && doc.data['resolved']['theme']
+        theme = doc.data['resolved']['theme']
+        if theme['post'] && theme['post']['image'] && theme['post']['image']['class']
+          image_class = theme['post']['image']['class']
+        end
+      end
+
+      # Transform markdown images by parsing and rendering Liquid template
+      doc.content = doc.content.gsub(/!\[([^\]]*)\]\(([^)]+)\)/) do
+        alt_text = $1
+        image_path = $2
+
+        # Build the Liquid tag string
+        if image_class
+          liquid_tag = "{% uj_image \"#{image_path}\", alt=\"#{alt_text}\", class=\"#{image_class}\" %}"
+        else
+          liquid_tag = "{% uj_image \"#{image_path}\", alt=\"#{alt_text}\" %}"
+        end
+
+        # Parse and render the Liquid template immediately
+        template = Liquid::Template.parse(liquid_tag)
+        context = doc.site.site_payload.merge({'page' => doc.to_liquid})
+        result = template.render(Liquid::Context.new(context))
+
+        # Return the HTML with blank lines to ensure markdown treats it as raw HTML
+        "\n\n#{result}\n\n"
+      end
+    end
+  end
+end

data/lib/jekyll-uj-powertools.rb

@@ -10,7 +10,18 @@ module Jekyll
 
   # Load Hooks
   require_relative "hooks/inject-properties"
+  require_relative "hooks/markdown-images"
 
   # Load Tags
-  # require_relative "tags/ifistruthy"
+  require_relative "tags/iftruthy"
+  require_relative "tags/iffalsy"
+  require_relative "tags/icon"
+  require_relative "tags/social"
+  require_relative "tags/readtime"
+  require_relative "tags/fake_comments"
+  require_relative "tags/member"
+  require_relative "tags/image"
+  require_relative "tags/post"
+  require_relative "tags/language"
+  require_relative "tags/translation_url"
 end

data/lib/tags/fake_comments.rb

@@ -0,0 +1,72 @@
+# Libraries
+require "jekyll"
+
+module Jekyll
+  class UJCommentsTag < Liquid::Tag
+    def initialize(tag_name, markup, tokens)
+      super
+      @markup = markup.strip
+    end
+
+    def render(context)
+      # Get the content to analyze
+      content = resolve_content(context)
+      return '0' unless content
+      
+      # Strip HTML tags
+      stripped_content = strip_html(content)
+      
+      # Count words
+      words = count_words(stripped_content)
+      
+      # Generate comment count based on word count modulo 13
+      comments = words % 13
+      
+      comments.to_s
+    end
+    
+    private
+    
+    def resolve_content(context)
+      if @markup.empty?
+        # No argument, use page content
+        page = context['page']
+        return nil unless page
+        page['content']
+      else
+        # Resolve the variable name
+        resolve_variable(context, @markup)
+      end
+    end
+    
+    def resolve_variable(context, variable_name)
+      # Handle nested variable access like page.content or include.content
+      parts = variable_name.split('.')
+      current = context
+      
+      parts.each do |part|
+        return nil unless current.respond_to?(:[]) || current.is_a?(Hash)
+        current = current[part]
+        return nil if current.nil?
+      end
+      
+      current
+    end
+    
+    def strip_html(content)
+      # Remove HTML tags
+      content = content.to_s.gsub(/<script.*?<\/script>/m, '')
+      content = content.gsub(/<style.*?<\/style>/m, '')
+      content = content.gsub(/<[^>]+>/, ' ')
+      content = content.gsub(/\s+/, ' ')
+      content.strip
+    end
+    
+    def count_words(text)
+      # Count words (split by whitespace)
+      text.split(/\s+/).length
+    end
+  end
+end
+
+Liquid::Template.register_tag('uj_fake_comments', Jekyll::UJCommentsTag)