jekyll-polyglot 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52fcf4f09a9d96c2255ca7226c0a26d5dc7cf5e337fc03805e3e3d18ff00d7d9
-  data.tar.gz: 6a136ac3a5459c28c39ec71876e01ebee0582154f448ead285169bede86acb9f
+  metadata.gz: ab5c70c038d85dbe9936e2a3bd021d75f860a01c272c2650eb6f77e8b386d141
+  data.tar.gz: 8d4e4656cbd532277bf708f71fabc3c2b63ee042110862c3aea64ea570434b78
 SHA512:
-  metadata.gz: 9fe64a2a499c51edd8e3a861d8b2805f4283dc89301be66c942d297f44923a3a1203b58ffd5183615fa34a4d01b1a30df01c76bb29626f57258e8b5e7396cbb3
-  data.tar.gz: f22f0727628cfed097dc18845fbd44de02629909d1a4db22767b1b9d52538a1a1287103bab7e8cc85e4e611f74365a7e789515b9b807d7c85751e8a660ef6a1e
+  metadata.gz: 508f349097b516f5d4d7f5e794e1e367ba1a64035191793b184314da8f3b35708047df73bc469a740a6042571b97d91802149f259e81581d741ff88a44bcd389
+  data.tar.gz: e88b634466df95b6b11c7cc04c8a3b5e1b157bfa1740094e1f2bfae14f1797c1e6d1d40cf80d787a5c8070874f6bf929aa3b86c0607a10811cc09017cd424908

data/README.md

@@ -68,6 +68,37 @@ In short:
 * Don't overthink it, :wink:
 
 
+#### Using different permalinks per language
+_New in 1.7.0_
+
+Optionally, for those who may want different URLs on different languages, translations may be identified by specifying a `page_id` in the frontmatter.
+
+If available, polyglot will use `page_id` to identify the page, and will default to the `permalink` otherwise.
+
+As an example, you may have an about page located in `/about/` while being in `/acerca-de/` in Spanish just by changing the permalink and specifying a `page_id` that will link the files as translations:
+```md
+---
+title: About
+permalink: /about
+lang: en
+page_id: about
+---
+This is us!
+```
+
+```md
+---
+title: Acerca de
+permalink: /acerca-de
+lang: es
+page_id: about
+---
+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).
+
 #### Fallback Language Support
 Lets say you are building your website. You have an `/about/` page written in *english*, *german* and
 *swedish*. You are also supporting a *french* website, but you never designed a *french* version of your `/about/` page!

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

@@ -13,7 +13,7 @@ module Jekyll
       @lang_from_path = config.fetch('lang_from_path', false)
       @exclude_from_localization = config.fetch('exclude_from_localization', []).map do |e|
         if File.directory?(e) && e[-1] != '/'
-          e + '/'
+          "#{e}/"
         else
           e
         end
@@ -28,7 +28,7 @@ module Jekyll
       @lang_vars = config.fetch('lang_vars', [])
     end
 
-    alias_method :process_orig, :process
+    alias process_orig process
     def process
       prepare
       all_langs = (@languages + [@default_lang]).uniq
@@ -50,6 +50,7 @@ module Jekyll
         rescue Interrupt
           all_langs.each do |lang|
             next unless pids.key? lang
+
             puts "Killing #{pids[lang]} : #{lang}"
             kill('INT', pids[lang])
           end
@@ -61,7 +62,7 @@ module Jekyll
       end
     end
 
-    alias_method :site_payload_orig, :site_payload
+    alias site_payload_orig site_payload
     def site_payload
       payload = site_payload_orig
       payload['site']['default_lang'] = default_lang
@@ -81,7 +82,8 @@ module Jekyll
       end
       if @active_lang == @default_lang
       then process_default_language
-      else process_active_language
+      else
+        process_active_language
       end
     end
 
@@ -95,7 +97,7 @@ module Jekyll
       old_dest = @dest
       old_exclude = @exclude
       @file_langs = {}
-      @dest = @dest + '/' + @active_lang
+      @dest = "#{@dest}/#{@active_lang}"
       @exclude += @exclude_from_localization
       process_orig
       @dest = old_dest
@@ -103,9 +105,10 @@ module Jekyll
     end
 
     def derive_lang_from_path(doc)
-      if !@lang_from_path
+      unless @lang_from_path
         return nil
       end
+
       segments = doc.relative_path.split('/')
       if doc.relative_path[0] == '_' \
         && segments.length > 2 \
@@ -114,9 +117,9 @@ module Jekyll
       elsif segments.length > 1 \
         && segments[0] =~ /^[a-z]{2,3}(:?[_-](:?[A-Za-z]{2}){1,2}){0,2}$/
         return segments[0]
-      else
-        return nil
       end
+
+      nil
     end
 
     # assigns natural permalinks to documents and prioritizes documents with
@@ -130,20 +133,39 @@ module Jekyll
         lang = doc.data['lang'] || derive_lang_from_path(doc) || @default_lang
         lang_exclusive = doc.data['lang-exclusive'] || []
         url = doc.url.gsub(regex, '/')
-        doc.data['permalink'] = url
+        page_id = doc.data['page_id'] || url
+        doc.data['permalink'] = url unless defined?(doc.data['permalink'])
+
+        # skip entirely if nothing to check
+        next if @file_langs.nil?
         # skip this document if it has already been processed
-        next if @file_langs[url] == @active_lang
+        next if @file_langs[page_id] == @active_lang
         # skip this document if it has a fallback and it isn't assigned to the active language
-        next if @file_langs[url] == @default_lang && lang != @active_lang
+        next if @file_langs[page_id] == @default_lang && lang != @active_lang
         # skip this document if it has lang-exclusive defined and the active_lang is not included
         next if !lang_exclusive.empty? && !lang_exclusive.include?(@active_lang)
 
-        approved[url] = doc
-        @file_langs[url] = lang
+        approved[page_id] = doc
+        @file_langs[page_id] = lang
       end
+      approved.values.each {|doc| assignPageRedirects(doc, docs) }
       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']
+        end
+        redirects = redirectDocs.map { |dd| dd.data['permalink'] }
+        doc.data['redirect_from'] = redirects
+      end
+    end
+
     # performs any necesarry operations on the documents before rendering them
     def process_documents(docs)
       # return if @active_lang == @default_lang
@@ -168,11 +190,11 @@ module Jekyll
     # made by jekyll when parsing documents without explicitly set permalinks
     def document_url_regex
       regex = ''
-      @languages.each do |lang|
+      (@languages || []).each do |lang|
         regex += "([\/\.]#{lang}[\/\.])|"
       end
       regex.chomp! '|'
-      %r{#{regex}}
+      /#{regex}/
     end
 
     # a regex that matches relative urls in a html document
@@ -190,7 +212,7 @@ module Jekyll
         end
       end
       start = disabled ? 'ferh' : 'href'
-      %r{#{start}=\"?#{@baseurl}\/((?:#{regex}[^,'\"\s\/?\.]+\.?)*(?:\/[^\]\[\)\(\"\'\s]*)?)\"}
+      %r{#{start}="?#{@baseurl}/((?:#{regex}[^,'"\s/?.]+\.?)*(?:/[^\]\[)("'\s]*)?)"}
     end
 
     # a regex that matches absolute urls in a html document
@@ -208,11 +230,12 @@ module Jekyll
         end
       end
       start = disabled ? 'ferh' : 'href'
-      %r{(?<!hreflang="#{@default_lang}" )#{start}=\"?#{url}#{@baseurl}\/((?:#{regex}[^,'\"\s\/?\.]+\.?)*(?:\/[^\]\[\)\(\"\'\s]*)?)\"}
+      %r{(?<!hreflang="#{@default_lang}" )#{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"')
       doc.output = modified_output
@@ -220,6 +243,7 @@ module Jekyll
 
     def relativize_absolute_urls(doc, regex, url)
       return if doc.output.nil?
+
       modified_output = doc.output.dup
       modified_output.gsub!(regex, "href=\"#{url}#{@baseurl}/#{@active_lang}/" + '\1"')
       doc.output = modified_output
@@ -227,6 +251,7 @@ module Jekyll
 
     def correct_nonrelativized_absolute_urls(doc, regex, url)
       return if doc.output.nil?
+
       modified_output = doc.output.dup
       modified_output.gsub!(regex, "href=\"#{url}#{@baseurl}/" + '\1"')
       doc.output = modified_output
@@ -234,6 +259,7 @@ module Jekyll
 
     def correct_nonrelativized_urls(doc, regex)
       return if doc.output.nil?
+
       modified_output = doc.output.dup
       modified_output.gsub!(regex, "href=\"#{@baseurl}/" + '\1"')
       doc.output = modified_output

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-polyglot
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Samuel Volin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-08 00:00:00.000000000 Z
+date: 2023-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll