jekyll-polyglot 1.9.0 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58fab59c4c6aabba378edb4622f960b9ee2910c41e9b7cb329218cf4602bfaa2
-  data.tar.gz: 2a077894396baca9c8215a44abe6734abd9c1c00d0975259cf98380f77e72a10
+  metadata.gz: b3ca341e67c10066675cb10c5ded127cf9126c5db547d2f3fdfc3d545c43bd6a
+  data.tar.gz: 32315c6551ac56da248adb7d465c130d8f0ec4f03a7d589eb5e2081c1a420821
 SHA512:
-  metadata.gz: 1c90c5e30bd2703cfab18b75b0a23d6a94350709dcd4d1acfade18497f4ce7bdddeba18cc9efd1cf527e3aeb5295e422e0108da10a12f556b2a007f5e57a26b6
-  data.tar.gz: fdda50a81bbbd06e90e4b170be83f207b01f1f66eeabea7b4aff68421bc5bbcdf124e3cccf737d01cfa59f48fb914121953140cdde9ecadd6f572b31c1ba08d7
+  metadata.gz: b53d59e7090b20849d36cdfe6b54a6b0e40e40db839916f1df45c62f26b0ef541f43d30d88c3cbfcd0eb8e58ecc4e45b1f3ae1509cdd2aa0149aad4be41d9a95
+  data.tar.gz: 12a99dc155b5e4c7ba5f960e0267a90b547fa10576c9c3bf718784f139bf45b0da7554ac40e262b491aa113301eba5d1c16c2bb615fb901d26adf4cee90d0917

data/README.md

@@ -1,7 +1,8 @@
 🔤 Polyglot
 ---
 [![Gem Version](https://badge.fury.io/rb/jekyll-polyglot.svg)](https://badge.fury.io/rb/jekyll-polyglot)
-[![CircleCI](https://circleci.com/gh/untra/polyglot/tree/master.svg?style=svg)](https://circleci.com/gh/untra/polyglot/?branch=master)
+[![CircleCI](https://circleci.com/gh/untra/polyglot/tree/main.svg?style=svg)](https://circleci.com/gh/untra/polyglot/?branch=main)
+[![codecov](https://codecov.io/gh/untra/polyglot/graph/badge.svg?token=AAIYBIxdWr)](https://codecov.io/gh/untra/polyglot)
 
 __Polyglot__ is a fast, painless, open-source internationalization plugin for [Jekyll](http://jekyllrb.com) blogs. Polyglot is easy to set up and use with any Jekyll project, and it scales to the languages you want to support. With fallback support for missing content, automatic url relativization, and powerful SEO tools, Polyglot allows any multi-language jekyll blog to focus on content without the cruft.
 
@@ -38,9 +39,7 @@ These configuration preferences indicate
 - whether to run language processing in parallel or serial. Set to `false` if building on Windows hosts, or if Polyglot collides with other Jekyll plugins.
 - your jekyll website production url. Make sure this value is set; Polyglot requires this to relative site urls correctly, and to make functioning language switchers.
 
-The optional `lang_from_path: true` option enables getting page
-language from the first or second path segment, e.g `de/first-one.md`, or
-`_posts/zh_Hans_HK/use-second-segment.md` , if the lang frontmatter isn't defined.
+The optional `lang_from_path: true` option enables getting the page language from a filepath segment seperated by `/` or `.`, e.g `de/first-one.md`, or `_posts/zh_HK/use-second-segment.md` , if the lang frontmatter isn't defined.
 
 ## How To Use It
 When adding new posts and pages, add to the YAML front matter:
@@ -51,7 +50,7 @@ or whatever appropriate [I18n language code](https://developer.chrome.com/docs/e
 the page should build for. And you're done. Ideally, when designing your site, you should
 organize files by their relative urls.
 
-You can see how the live Polyglot website [configures and supports multiple languages](https://github.com/untra/polyglot/blob/master/site/_config.yml#L28-L37), and examples of [community](https://github.com/untra/polyglot/pull/155) [language](https://github.com/untra/polyglot/pull/167) [contributions](https://github.com/untra/polyglot/pull/177).
+You can see how the live Polyglot website [configures and supports multiple languages](https://github.com/untra/polyglot/blob/main/site/_config.yml#L28-L37), and examples of [community](https://github.com/untra/polyglot/pull/155) [language](https://github.com/untra/polyglot/pull/167) [contributions](https://github.com/untra/polyglot/pull/177).
 
 Polyglot works by associating documents with similar permalinks to the `lang` specified in their frontmatter. Files that correspond to similar routes should have identical permalinks. If you don't provide a permalink for a post, ___make sure you are consistent___ with how you place and name corresponding files:
 ```
@@ -113,7 +112,7 @@ Estos somos nosotros!
 ```
 
 Additionally, if you are also using the `jekyll-redirect-from` plugin, pages coordinated this way will automatically have redirects created between pages.
-So `/es/about` will automatically redirect to `/es/acerca-de` and `/acerca-de` can redirect to `/about`. If you use this approach, be sure to also employ a customized [redirect.html](https://github.com/untra/polyglot/blob/master/site/_layouts/redirect.html).
+So `/es/about` will automatically redirect to `/es/acerca-de` and `/acerca-de` can redirect to `/about`. If you use this approach, be sure to also employ a customized [redirect.html](https://github.com/untra/polyglot/blob/main/site/_layouts/redirect.html).
 
 #### Fallback Language Support
 Lets say you are building your website. You have an `/about/` page written in *english*, *german* and
@@ -161,7 +160,7 @@ becomes
 
 ### Disabling Url Relativizing
 _New in 1.4.0_
-If you dont want a href attribute to be relativized (such as for making [a language switcher](https://github.com/untra/polyglot/blob/master/site/_includes/sidebar.html#L40)), you can use the block tag:
+If you dont want a href attribute to be relativized (such as for making [a language switcher](https://github.com/untra/polyglot/blob/main/site/_includes/sidebar.html#L40)), you can use the block tag:
 
 ```html
 {% static_href %}href="..."{% endstatic_href %}
@@ -252,7 +251,7 @@ Polyglot will only start builds after it confirms there is a cpu core ready to a
 ### Writing Tests and Debugging
 _:wave: I need assistance with modern ruby best practices for test maintenance with rake and rspec. If you got the advice I have the ears._
 
-Tests are run with `bundle exec rake`. Tests are in the `/spec` directory, and test failure output detail can be examined in the `rspec.xml` file.
+Tests are run with `test.sh`. Tests are in the `/spec` directory, and test failure output detail can be examined in the `rspec.json` file. Code Coverage details are in the the `coverage` directory.
 
 ## Features
 This plugin stands out from other I18n Jekyll plugins.
@@ -332,15 +331,15 @@ Feel free to open a PR and list your multilingual blog here you may want to shar
 
 ## 2.0 Roadmap
 * [x] - **site language**: portuguese Brazil `pt-BR`
-* [ ] - **site language**: portuguese Portugal `pt-PT`
-* [ ] - **site language**: arabic `ar`
-* [ ] - **site language**: japanese `ja`
+* [x] - **site language**: arabic `ar`
+* [x] - **site language**: japanese `ja`
 * [x] - **site language**: russian `ru`
 * [x] - **site language**: dutch `nl`
 * [x] - **site language**: korean `ko`
 * [x] - **site language**: hebrew `he`
 * [x] - **site language**: chinese China `zh-CN`
 * [ ] - **site language**: chinese Taiwan `zh-TW`
+* [ ] - **site language**: portuguese Portugal `pt-PT`
 * [ ] - get whitelisted as an official github-pages jekyll plugin
 * [x] - update CI provider
 

data/lib/jekyll/polyglot/hooks/coordinate.rb

@@ -8,7 +8,7 @@ def hook_coordinate(site)
   # Copy the language specific data, by recursively merging it with the default data.
   # Favour active_lang first, then default_lang, then any non-language-specific data.
   # See: https://www.ruby-forum.com/topic/142809
-  merger = proc { |key, v1, v2| Hash === v1 && Hash === v2 ? v1.merge(v2, &merger) : v2 }
+  merger = proc { |_key, v1, v2| v1.is_a?(Hash) && v2.is_a?(Hash) ? v1.merge(v2, &merger) : v2 }
   if site.data.include?(site.default_lang)
     site.data = site.data.merge(site.data[site.default_lang], &merger)
   end
@@ -16,7 +16,7 @@ def hook_coordinate(site)
     site.data = site.data.merge(site.data[site.active_lang], &merger)
   end
 
-  site.collections.each do |_, collection|
+  site.collections.each_value do |collection|
     collection.docs = site.coordinate_documents(collection.docs)
   end
   site.pages = site.coordinate_documents(site.pages)

data/lib/jekyll/polyglot/hooks/process.rb

@@ -4,7 +4,7 @@ Jekyll::Hooks.register :site, :post_render do |site|
 end
 
 def hook_process(site)
-  site.collections.each do |_, collection|
+  site.collections.each_value do |collection|
     site.process_documents(collection.docs)
   end
   site.process_documents(site.pages)

data/lib/jekyll/polyglot/liquid/tags/i18n_headers.rb

@@ -11,18 +11,52 @@ module Jekyll
 
         def render(context)
           site = context.registers[:site]
-          permalink = context.registers[:page]['permalink']
-          permalink_lang = context.registers[:page]['permalink_lang']
-          site_url = @url.empty? ? site.config['url'] : @url
+          page = context.registers[:page]
+          permalink = page['permalink'] || page['url'] || ''
+          permalink = "/#{permalink}" unless permalink.start_with?("/")
+          page_id = page['page_id']
+          permalink_lang = page['permalink_lang']
+          baseurl = site.config['baseurl'] || ''
+          site_url = @url.empty? ? site.config['url'] + baseurl : @url
           i18n = "<meta http-equiv=\"Content-Language\" content=\"#{site.active_lang}\">\n"
-          i18n += "<link rel=\"alternate\" hreflang=\"#{site.default_lang}\" "\
-          "href=\"#{site_url}/#{permalink}\"/>\n"
-          site.languages.each do |lang|
-            next if lang == site.default_lang
 
-            url = permalink_lang && permalink_lang[lang] ? permalink_lang[lang] : permalink
-            i18n += "<link rel=\"alternate\" hreflang=\"#{lang}\" "\
-            "href=\"#{site_url}/#{lang}/#{url}\"/>\n"
+          # Find all documents with the same page_id
+          docs_with_same_id = site.collections.values
+            .flat_map(&:docs)
+            .filter { |doc| !doc.data['page_id'].nil? }
+            .select { |doc| doc.data['page_id'] == page_id }
+
+          # Build a hash of lang => permalink for all matching docs
+          lang_to_permalink = docs_with_same_id.to_h { |doc| [doc.data['lang'], doc.data['permalink']] }
+
+          # Canonical should always point to the current page's permalink (active_lang)
+          current_lang = site.active_lang
+          current_permalink = lang_to_permalink[current_lang] || (permalink_lang && permalink_lang[current_lang]) || permalink
+          current_permalink = "/#{current_permalink}" unless current_permalink.start_with?("/")
+          # Don't add language prefix if it's already in the permalink
+          canonical_permalink = if current_lang == site.default_lang
+            current_permalink
+          else
+            current_permalink.start_with?("/#{current_lang}/") ? current_permalink : "/#{current_lang}#{current_permalink}"
+          end
+          i18n += "<link rel=\"canonical\" href=\"#{site_url}#{canonical_permalink}\"/>\n"
+
+          # Get the default language permalink for x-default
+          default_lang_permalink = lang_to_permalink[site.default_lang] || (permalink_lang && permalink_lang[site.default_lang]) || permalink
+          default_lang_permalink = "/#{default_lang_permalink}" unless default_lang_permalink.start_with?("/")
+
+          site.languages.each do |lang|
+            alt_permalink = lang_to_permalink[lang] || (permalink_lang && permalink_lang[lang]) || permalink
+            alt_permalink = "/#{alt_permalink}" unless alt_permalink.start_with?("/")
+            i18n += if lang == site.default_lang
+              "<link rel=\"alternate\" hreflang=\"#{lang}\" href=\"#{site_url}#{alt_permalink}\"/>\n" \
+                "<link rel=\"alternate\" hreflang=\"x-default\" href=\"#{site_url}#{default_lang_permalink}\"/>\n"
+            else
+              # For non-default languages, use the language-specific permalink directly
+              # Don't add the language prefix if it's already in the permalink
+              lang_permalink = alt_permalink.start_with?("/#{lang}/") ? alt_permalink : "/#{lang}#{alt_permalink}"
+              "<link rel=\"alternate\" hreflang=\"#{lang}\" href=\"#{site_url}#{lang_permalink}\"/>\n"
+            end
           end
           i18n
         end

data/lib/jekyll/polyglot/liquid/tags/static_href.rb

@@ -1,21 +1,17 @@
 module Jekyll
   module Polyglot
     module Liquid
-      class StaticHrefTag < :: Liquid::Block
-        def initialize(tag_name, params, tokens)
-          super
-        end
-
+      class StaticHrefTag < ::Liquid::Block
         def render(context)
           text = super
-          href_attrs = text.strip.split '='
+          href_attrs = text.strip.split('=', 2)
           valid = (href_attrs.length == 2 && href_attrs[0] == 'href') && href_attrs[1].start_with?('"') && href_attrs[1].end_with?('"')
           unless valid
-            raise Liquid::SyntaxError, "static_href parameters must include match href=\"...\" attribute param, eg. href=\"http://example.com\, href=\"/about\", href=\"/\" , instead got:\n#{text}"
+            raise Liquid::SyntaxError, "static_href parameters must include match href=\"...\" attribute param, eg. href=\"http://example.com, href=\"/about\", href=\"/\" , instead got:\n#{text}"
           end
 
           href_value = href_attrs[1]
-          # href writes out as ferh="..." explicitly wrong, to be cauaght by seperate processor for nonrelativized links
+          # href writes out as ferh="..." explicitly wrong, to be caught by separate processor for nonrelativized links
           "ferh=#{href_value}"
         end
       end

data/lib/jekyll/polyglot/patches/jekyll/site.rb

@@ -1,3 +1,4 @@
+require 'English'
 require 'etc'
 
 include Process
@@ -31,7 +32,7 @@ module Jekyll
     alias process_orig process
     def process
       prepare
-      all_langs = (@languages + [@default_lang]).uniq
+      all_langs = ([@default_lang] + @languages).uniq
       if @parallel_localization
         nproc = Etc.nprocessors
         pids = {}
@@ -42,11 +43,11 @@ module Jekyll
             end
             while pids.length >= (lang == all_langs[-1] ? 1 : nproc)
               sleep 0.1
-              pids.map do |lang, pid|
+              pids.map do |pid_lang, pid|
                 next unless waitpid pid, Process::WNOHANG
 
-                pids.delete lang
-                raise "Polyglot subprocess #{pid} (#{lang}) failed (#{$?.exitstatus})" unless $?.success?
+                pids.delete pid_lang
+                raise "Polyglot subprocess #{pid} (#{lang}) failed (#{$CHILD_STATUS.exitstatus})" unless $CHILD_STATUS.success?
               end
             end
           end
@@ -63,7 +64,7 @@ module Jekyll
           process_language lang
         end
       end
-      Jekyll::Hooks.trigger :polyglot, :post_write
+      Jekyll::Hooks.trigger :polyglot, :post_write, self
     end
 
     alias site_payload_orig site_payload
@@ -114,6 +115,16 @@ module Jekyll
       string.split(regex)
     end
 
+    # Convert glob pattern to regex pattern
+    # * matches any characters except /
+    # ? matches any single character except /
+    def glob_to_regex(pattern)
+      # Escape special regex characters first
+      escaped = Regexp.escape(pattern)
+      # Convert glob patterns to regex patterns
+      escaped.gsub("\\*", '.*').gsub("\\?", '.')
+    end
+
     def derive_lang_from_path(doc)
       unless @lang_from_path
         return nil
@@ -127,13 +138,6 @@ module Jekyll
         end
       end
 
-      # loop through all segments and check if they match the language regex
-      segments.each do |segment|
-        if @languages.include?(segment)
-          return segment
-        end
-      end
-      
       nil
     end
 
@@ -163,21 +167,28 @@ module Jekyll
         approved[page_id] = doc
         @file_langs[page_id] = lang
       end
-      approved.values.each { |doc| assignPageRedirects(doc, docs) }
-      approved.values.each { |doc| assignPageLanguagePermalinks(doc, docs) }
+      approved.each_value do |doc|
+        assignPageRedirects(doc, docs)
+        assignPageLanguagePermalinks(doc, docs)
+      end
       approved.values
     end
 
     def assignPageRedirects(doc, docs)
       pageId = doc.data['page_id']
       if !pageId.nil? && !pageId.empty?
-        lang = doc.data['lang'] || derive_lang_from_path(doc) || @default_lang
-        langPrefix = lang === @default_lang ? '' : "#{lang}/"
-        redirectDocs = docs.select do |dd|
-          doclang = dd.data['lang'] || derive_lang_from_path(dd) || @default_lang
-          dd.data['page_id'] == pageId && doclang != lang && dd.data['permalink'] != doc.data['permalink']
+        redirects = []
+
+        docs_with_same_id = docs.select { |dd| dd.data['page_id'] == pageId }
+
+        # For each document with the same page_id
+        docs_with_same_id.each do |dd|
+          # Add redirect if it's a different permalink
+          if dd.data['permalink'] != doc.data['permalink']
+            redirects << dd.data['permalink']
+          end
         end
-        redirects = redirectDocs.map { |dd| dd.data['permalink'] }
+
         doc.data['redirect_from'] = redirects
       end
     end
@@ -221,7 +232,7 @@ module Jekyll
     def document_url_regex
       regex = ''
       (@languages || []).each do |lang|
-        regex += "([\/\.]#{lang}[\/\.])|"
+        regex += "([/.]#{lang}[/.])|"
       end
       regex.chomp! '|'
       /#{regex}/
@@ -235,10 +246,12 @@ module Jekyll
       regex = ''
       unless disabled
         @exclude.each do |x|
-          regex += "(?!#{x})"
+          escaped_x = glob_to_regex(x)
+          regex += "(?!#{escaped_x})"
         end
         @languages.each do |x|
-          regex += "(?!#{x}\/)"
+          escaped_x = Regexp.escape(x)
+          regex += "(?!#{escaped_x}/)"
         end
       end
       start = disabled ? 'ferh' : 'href'
@@ -253,21 +266,24 @@ module Jekyll
       regex = ''
       unless disabled
         @exclude.each do |x|
-          regex += "(?!#{x})"
+          escaped_x = glob_to_regex(x)
+          regex += "(?!#{escaped_x})"
         end
         @languages.each do |x|
-          regex += "(?!#{x}\/)"
+          escaped_x = Regexp.escape(x)
+          regex += "(?!#{escaped_x}/)"
         end
       end
       start = disabled ? 'ferh' : 'href'
-      %r{(?<!hreflang="#{@default_lang}" )#{start}="?#{url}#{@baseurl}/((?:#{regex}[^,'"\s/?.]+\.?)*(?:/[^\]\[)("'\s]*)?)"}
+      neglookbehind = disabled ? "" : "(?<!hreflang=\"#{@default_lang}\" |rel=\"canonical\" )"
+      %r{#{neglookbehind}#{start}="?#{url}#{@baseurl}/((?:#{regex}[^,'"\s/?.]+\.?)*(?:/[^\]\[)("'\s]*)?)"}
     end
 
     def relativize_urls(doc, regex)
       return if doc.output.nil?
 
       modified_output = doc.output.dup
-      modified_output.gsub!(regex, "href=\"#{@baseurl}/#{@active_lang}/" + '\1"')
+      modified_output.gsub!(regex, "href=\"#{@baseurl}/#{@active_lang}/\\1\"")
       doc.output = modified_output
     end
 
@@ -275,7 +291,7 @@ module Jekyll
       return if doc.output.nil?
 
       modified_output = doc.output.dup
-      modified_output.gsub!(regex, "href=\"#{url}#{@baseurl}/#{@active_lang}/" + '\1"')
+      modified_output.gsub!(regex, "href=\"#{url}#{@baseurl}/#{@active_lang}/\\1\"")
       doc.output = modified_output
     end
 
@@ -283,7 +299,7 @@ module Jekyll
       return if doc.output.nil?
 
       modified_output = doc.output.dup
-      modified_output.gsub!(regex, "href=\"#{url}#{@baseurl}/" + '\1"')
+      modified_output.gsub!(regex, "href=\"#{url}#{@baseurl}/\\1\"")
       doc.output = modified_output
     end
 
@@ -291,7 +307,7 @@ module Jekyll
       return if doc.output.nil?
 
       modified_output = doc.output.dup
-      modified_output.gsub!(regex, "href=\"#{@baseurl}/" + '\1"')
+      modified_output.gsub!(regex, "href=\"#{@baseurl}/\\1\"")
       doc.output = modified_output
     end
   end

data/lib/jekyll/polyglot/patches/jekyll/static_file.rb

@@ -1,19 +1,20 @@
-
 module Jekyll
   # Alteration to Jekyll StaticFile
   # provides aliased methods to direct write to skip files
   # excluded from localization
   class StaticFile
-    alias_method :write_orig, :write
+    alias write_orig write
     def write(dest)
       return false if exclude_from_localization?
+
       write_orig(dest)
     end
 
     def exclude_from_localization?
       return false if @site.active_lang == @site.default_lang
+
       @site.exclude_from_localization.each do |e|
-        return true if relative_path[1..-1].start_with?(e)
+        return true if relative_path[1..].start_with?(e)
       end
       false
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-polyglot
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.11.0
 platform: ruby
 authors:
 - Samuel Volin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-18 00:00:00.000000000 Z
+date: 2025-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -54,7 +54,8 @@ files:
 homepage: https://polyglot.untra.io/
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -63,12 +64,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.1.0
 requirements: []
 rubygems_version: 3.3.7
 signing_key: