jekyll-polyglot 1.5.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 575ea909b15958d5cddafc881fb4342326f205bf9fafbce8a79981133c4a15e5
-  data.tar.gz: 1e881bdd502d11c0b3c171b7a4db7670d314f32ea0fe192a9a3fffbd47b1e1c2
+  metadata.gz: ab5c70c038d85dbe9936e2a3bd021d75f860a01c272c2650eb6f77e8b386d141
+  data.tar.gz: 8d4e4656cbd532277bf708f71fabc3c2b63ee042110862c3aea64ea570434b78
 SHA512:
-  metadata.gz: 15cd5d7b397550143957d9ebf7404c35c241bf4357f75f6fa7f44bde56034d631a3ea6ee0e7e3d80a53a9f8abcb99a5ee5b8685d125b63e08369db9cae28c1d7
-  data.tar.gz: f837a8c341809322d210a90098d9016d6303865a665a832abf38443912f61c969a1e5c08dc4b2206f0ef47712ce24e208202b6c46e2d34ceaa1066c6ff19aeef
+  metadata.gz: 508f349097b516f5d4d7f5e794e1e367ba1a64035191793b184314da8f3b35708047df73bc469a740a6042571b97d91802149f259e81581d741ff88a44bcd389
+  data.tar.gz: e88b634466df95b6b11c7cc04c8a3b5e1b157bfa1740094e1f2bfae14f1797c1e6d1d40cf80d787a5c8070874f6bf929aa3b86c0607a10811cc09017cd424908

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2015 - 2022 Samuel Volin
+Copyright (c) 2015 - 2023 Samuel Volin
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

data/README.md

@@ -50,6 +50,8 @@ or whatever appropriate [I18n language code](https://developer.chrome.com/websto
 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).
+
 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:
 ```
 _posts/2010-03-01-salad-recipes-en.md
@@ -66,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!
@@ -142,7 +175,7 @@ lang-exclusive: ['en', 'fr']
 #### Machine-aware site building
 _New in 1.5.0_
 
-Polyglot will only start builds after it confirms there is a cpu core ready to accept the build thread. This ensures that jekyll will build large sites efficiently streamlining build processes instead of overloading machines with process thrash.
+Polyglot will only start builds after it confirms there is a cpu core ready to accept the build thread. This ensures that jekyll will build large sites efficiently, streamlining build processes instead of overloading machines with process thrash.
 
 #### Localized site.data
 
@@ -155,6 +188,13 @@ This plugin makes modifications to existing Jekyll classes and modules, namely `
 
 `Jekyll::Site.process` is the entry point for the Jekyll build process. Take care whatever other plugins you use do not also attempt to overwrite this method. You may have problems.
 
+
+### 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.
+
+
 ## Features
 This plugin stands out from other I18n Jekyll plugins.
 - automatically corrects your relative links, keeping your *french* visitors on your *french* website, even when content has to fallback to the `default_lang`.
@@ -180,10 +220,11 @@ Feel free to open a PR and list your multilingual blog here you may want to shar
 * [F-Droid](https://f-droid.org)
 * [Ubuntu MATE](https://ubuntu-mate.org)
 * [Leo3418 blog](https://leo3418.github.io/)
+* [Gaphor](https://gaphor.org)
+* [Yi Yunseok's personal blog website](https://Yi-Yunseok.GitHub.io)
 
 ## Compatibility
 Currently supports Jekyll 3.0 , and Jekyll 4.0
-
 * Windows users will need to disable parallel_localization on their machines by setting `parallel_localization: false` in the `_config.yml`
 * In Jekyll 4.0 , SCSS source maps will generate improperly due to how Polyglot operates. The workaround is to disable the CSS sourcemaps. Adding the following to your `config.yml` will disable sourcemap generation:
 ```yaml
@@ -194,20 +235,23 @@ sass:
 ## Contributions
 Please! I need all the support I can get! 🙏
 
-But for real I would appreciate any contributions and support. This started as an open-source side-project and has gotten bigger than I'd ever imagine!
+But for real I would appreciate any code contributions and support. This started as an open-source side-project and has gotten bigger than I'd ever imagine!
 If you have something you'd like to contribute to jekyll-polyglot, please open a PR!
 
 
 ## 2.0 Roadmap
-* [ ] - **site language**: portuguese `pt_BR` `pt_PT`
+* [ ] - **site language**: portuguese Brazil `pt-BR` `pt-PT`
+* [ ] - **site language**: portuguese Portugal `pt-BR` `pt-PT`
 * [ ] - **site language**: arabic `ar`
 * [ ] - **site language**: japanese `ja`
 * [x] - **site language**: russian `ru`
 * [x] - **site language**: dutch `nl`
-* [ ] - **site language**: korean `ko`
+* [x] - **site language**: korean `ko`
 * [x] - **site language**: hebrew `he`
+* [x] - **site language**: chinese China `zh-CN`
+* [ ] - **site language**: chinese Taiwan `zh_TW`
 * [ ] - get whitelisted as an official github-pages jekyll plugin
 * [x] - update CI provider
 
 ## Copyright
-Copyright (c) Samuel Volin 2022. License: MIT
+Copyright (c) Samuel Volin 2023. License: MIT

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,31 +230,39 @@ 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?
 
-      doc.output.gsub!(regex, "href=\"#{@baseurl}/#{@active_lang}/" + '\1"')
+      modified_output = doc.output.dup
+      modified_output.gsub!(regex, "href=\"#{@baseurl}/#{@active_lang}/" + '\1"')
+      doc.output = modified_output
     end
 
     def relativize_absolute_urls(doc, regex, url)
       return if doc.output.nil?
 
-      doc.output.gsub!(regex, "href=\"#{url}#{@baseurl}/#{@active_lang}/" + '\1"')
+      modified_output = doc.output.dup
+      modified_output.gsub!(regex, "href=\"#{url}#{@baseurl}/#{@active_lang}/" + '\1"')
+      doc.output = modified_output
     end
 
     def correct_nonrelativized_absolute_urls(doc, regex, url)
       return if doc.output.nil?
 
-      doc.output.gsub!(regex, "href=\"#{url}#{@baseurl}/" + '\1"')
+      modified_output = doc.output.dup
+      modified_output.gsub!(regex, "href=\"#{url}#{@baseurl}/" + '\1"')
+      doc.output = modified_output
     end
 
     def correct_nonrelativized_urls(doc, regex)
       return if doc.output.nil?
 
-      doc.output.gsub!(regex, "href=\"#{@baseurl}/" + '\1"')
+      modified_output = doc.output.dup
+      modified_output.gsub!(regex, "href=\"#{@baseurl}/" + '\1"')
+      doc.output = modified_output
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-polyglot
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.7.0
 platform: ruby
 authors:
 - Samuel Volin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-01 00:00:00.000000000 Z
+date: 2023-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -17,6 +17,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
 description: Fast open source i18n plugin for Jekyll blogs.
 email: untra.sam@gmail.com
 executables: []