jekyll-polyglot 1.3.2 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3f7773339c45333233f02e73f7e7c96e87a6609ebdb6e6c1082b3adebf679d0
-  data.tar.gz: 5d8bdce1424b3be47d4e1dc07d1dba638436c2c65674e00845c354352b118387
+  metadata.gz: b1df66cac375456100227a3f62c2771280b12b20523650adf5aed2b0f71537a3
+  data.tar.gz: dd7c651028a836017807fdeda58600e576132b950c9b4dca17dcbeb4ab7d2af3
 SHA512:
-  metadata.gz: 154f29a20360f6db96f4be7c8584158c9d71c723ae306ad4093ab306eb6b52877bf75ebd5cf222251ebbadfada6c075d1dda06b65f0108b0eddbc8621e05b016
-  data.tar.gz: 240fdec79c5f4188d46a3ec160b17b8fc57fd5341564e105464bf877aa0d8bfe7b69d1f1bbc51c56d03c2a85499f33143ed77eb9131e62891e2c7f76147065c1
+  metadata.gz: 12562b7c0f8ab337c4195d1b664a8cfc1e93e2f53d2571dacfffc67d58958f2c262bbc74ec9aa8dc63f670f10b2381e8b1ddec07b0fe1edb88d9d532f6c4c916
+  data.tar.gz: 0c5152c2d45eead027c8a0cef88b8482f87841def83d56924d6118cb7bc157a3b6bea14a5a32f18273688a18e6cc5bf54de3b5dd078ae551c8dc6478f5dcfd41

data/README.md

@@ -1,7 +1,7 @@
-:abc: Polyglot
+🔤 Polyglot
 ---
 [![Gem Version](https://badge.fury.io/rb/jekyll-polyglot.svg)](https://badge.fury.io/rb/jekyll-polyglot)
-[![Build Status](https://travis-ci.org/untra/polyglot.svg?branch=master)](https://travis-ci.org/untra/polyglot)
+[![CircleCI](https://circleci.com/gh/untra/polyglot/tree/master.svg?style=svg)](https://circleci.com/gh/untra/polyglot/?branch=master)
 
 __Polyglot__ is a fast, painless, open-source internationalization plugin for [Jekyll](http://jekyllrb.com) blogs. Polyglot is easy to setup 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.
 
@@ -27,14 +27,14 @@ In your `_config.yml` file, add the following preferences
 ```YAML
 languages: ["en", "sv", "de", "fr"]
 default_lang: "en"
-exclude_from_localization: ["javascript", "images", "css", "README.md"]
+exclude_from_localization: ["javascript", "images", "css", "public"]
 parallel_localization: true
 ```
 These configuration preferences indicate
 - what i18n languages you wish to support
 - what is your default "fallback" language for your content
 - what root level files/folders are excluded from localization, based
-  on if their paths start with any of the excluded regexp substrings
+  on if their paths start with any of the excluded regexp substrings. (this is different than the jekyll `exclude: [ .gitignore ]` ; you should `exclude` files and directories in your repo you dont want in your built site at all, and `exclude_from_localization` files and directories you want to see in your built site, but not in your sublanguage sites.)
 - whether to run language processing in parallel or serial
 
 The optional `lang_from_path: true` option enables getting page
@@ -94,8 +94,7 @@ becomes
 ```
 Notice the link `<a href="/fr/menu/">...` directs to the french website.
 
-Even if you are falling back to `default_lang` page, relative links built on the *french* site will
-still link to *french* pages.
+Even if you are falling back to `default_lang` page, relative links built on the *french* site will still link to *french* pages.
 
 #### Relativized Absolute Urls
 If you defined a site `url` in your `_config.yaml`, polyglot will automatically relativize absolute links pointing to your website directory:
@@ -112,23 +111,34 @@ becomes
 ```
 
 #### Disabling Url Relativizing
-If you don't want a url to be relativized, you can add a space explicitly into the href to prevents a url from being relativized by polyglot.
-
-For example, the following urls will be relativized:
+_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 `{% static_href %}href="..."{% endstatic_href %}` block tag.
 
 ```html
-href="http://mywebsite.com/about"
-href="/about"
+<a {% static_href %}href="/about"{% endstatic_href %}>click this static link</a>
 ```
 
-and the following urls will be left alone:
+that will generate `<a href="/about">click this static link</a>` which is what you would normally use to create a url unmangled by invisible language relativization.
 
-```html
-href=" http://mywebsite.com/about"
-href=" /about"
+Combine with a [html minifier](https://github.com/digitalsparky/jekyll-minifier) for a polished and production ready website.
+
+#### Exclusive site language generation
+_New in 1.4.0_
+
+If you want to control which languages a document can be generated for, you can specify `lang-exclusive: [ ]` frontmatter.
+If you include this frontmatter in your post, it will only generate for the specified site languages.
+
+For Example, the following frontmatter will only generate in the `en` and `fr` site language builds:
+```
+---
+lang-exclusive: ['en', 'fr']
+---
 ```
 
-combine with a [html minifier](https://github.com/digitalsparky/jekyll-minifier) for a polished and production ready website.
+#### 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 jekll will build large sites efficiently streamlining build processes instead of overloading machines with process thrash.
 
 #### Localized site.data
 
@@ -137,7 +147,7 @@ For instance: you might need to localize `_data/navigation.yml` that holds "navi
 In order to localize it, just place language-specific files in `_data/:lang/...` folder, and Polyglot will bring those keys to the top level.
 
 ## How It Works
-This plugin makes modifications to existing Jekyll classes and modules, namely `Jekyll::StaticFile` and `Jekyll::Site`. These changes are as lightweight and slim as possible. The biggest change is in `Jekyll::Site.process`. Polyglot overwrites this method to instead spawn a separate thread for each language you intend to process the site for. Each of those threads calls the original `Jekyll::Site.process` method with its language in mind, ensuring your website scales to support any number of languages, while building all of your site languages simultaneously.
+This plugin makes modifications to existing Jekyll classes and modules, namely `Jekyll::StaticFile` and `Jekyll::Site`. These changes are as lightweight and slim as possible. The biggest change is in `Jekyll::Site.process`. Polyglot overwrites this method to instead spawn a separate process for each language you intend to process the site for. Each of those processes calls the original `Jekyll::Site.process` method with its language in mind, ensuring your website scales to support any number of languages, while building all of your site languages simultaneously.
 
 `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.
 
@@ -149,6 +159,7 @@ This plugin stands out from other I18n Jekyll plugins.
 - provides the liquid tag `{{ site.default_lang }}` to get the default_lang I18n string.
 - provides the liquid tag `{{ site.active_lang }}` to get the I18n language string the website was built for. Alternative names for `active_lang` can be configured via `config.lang_vars`.
 - provides the liquid tag `{{ I18n_Headers https://yourwebsite.com/ }}` to append SEO bonuses to your website.
+- provides the liquid tag `{{ Unrelativized_Link href="/hello" }}` to make urls that do not get influenced by url correction regexs.
 - provides `site.data` localization for efficient rich text replacement.
 - a creator that will answer all of your questions and issues.
 
@@ -156,22 +167,41 @@ This plugin stands out from other I18n Jekyll plugins.
 Jekyll-polyglot has a few spectacular [Search Engine Optimization techniques](https://untra.github.io/polyglot/seo) to ensure your Jekyll blog gets the most out of it's multilingual audience. Check them out!
 
 ### Other Websites Built with Polyglot
-let us know if you make a multilingual blog you want to share:
-* [Polyglot project website](http://polyglot.untra.io)
-* [LogRhythm Corporate Website](http://logrhythm.com)
+Feel free to open a PR and list your multilingual blog here you may want to share:
+
+* [Polyglot project website](https://polyglot.untra.io)
+* [LogRhythm Corporate Website](https://logrhythm.com)
 * [All Over Earth](https://allover.earth/)
 * [Hanare Cafe in Toshijima, Japan](https://hanarecafe.com)
 * [F-Droid](https://f-droid.org)
+* [Ubuntu MATE](https://ubuntu-mate.org)
 
 ## Compatibility
-Currently supports Jekyll 3.0 , and Jekyll 4.0 (for the most part)
+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 rhe following to your `config.yml` will disable sourcemap generation:
+* 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
 sass:
     sourcemap: never
 ```
 
+## 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!
+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**: arabic `ar`
+* [ ] - **site language**: japanese `ja`
+* [x] - **site language**: russian `ru`
+* [ ] - **site language**: korean `ko`
+* [ ] - **site language**: hebrew `he`
+* [ ] - get whitelisted as an official github-pages jekyll plugin
+* [x] - update CI provider
+
 ## Copyright
-Copyright (c) Samuel Volin 2020. License: MIT
+Copyright (c) Samuel Volin 2021. License: MIT

data/lib/jekyll/polyglot/hooks.rb

@@ -1,3 +1,2 @@
-require_relative 'hooks/assets-toggle'
 require_relative 'hooks/coordinate'
 require_relative 'hooks/process'

data/lib/jekyll/polyglot/liquid.rb

@@ -1,7 +1,8 @@
 module Jekyll
   module Polyglot
     module Liquid
-      require_relative 'liquid/tags/i18n-headers'
+      require_relative 'liquid/tags/i18n_headers'
+      require_relative 'liquid/tags/static_href'
     end
   end
 end

data/lib/jekyll/polyglot/liquid/tags/{i18n-headers.rb → i18n_headers.rb}

@@ -15,9 +15,10 @@ module Jekyll
           site_url = @url.empty? ? site.config['url'] : @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"
+          "href=\"#{site_url}#{permalink}\"/>\n"
           site.languages.each do |lang|
             next if lang == site.default_lang
+
             i18n += "<link rel=\"alternate\" hreflang=\"#{lang}\" "\
             "href=\"#{site_url}/#{lang}#{permalink}\"/>\n"
           end
@@ -29,3 +30,4 @@ module Jekyll
 end
 
 Liquid::Template.register_tag('I18n_Headers', Jekyll::Polyglot::Liquid::I18nHeadersTag)
+Liquid::Template.register_tag('i18n_headers', Jekyll::Polyglot::Liquid::I18nHeadersTag)

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

@@ -0,0 +1,27 @@
+module Jekyll
+  module Polyglot
+    module Liquid
+      class StaticHrefTag < :: Liquid::Block
+        def initialize(tag_name, params, tokens)
+          super
+        end
+
+        def render(context)
+          text = super
+          href_attrs = text.strip.split '='
+          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}"
+          end
+
+          href_value = href_attrs[1]
+          # href writes out as ferh="..." explicitly wrong, to be cauaght by seperate processor for nonrelativized links
+          "ferh=#{href_value}"
+        end
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('Static_Href', Jekyll::Polyglot::Liquid::StaticHrefTag)
+Liquid::Template.register_tag('static_href', Jekyll::Polyglot::Liquid::StaticHrefTag)

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

@@ -1,3 +1,5 @@
+require 'etc'
+
 include Process
 module Jekyll
   class Site
@@ -10,18 +12,17 @@ module Jekyll
       @parallel_localization = config.fetch('parallel_localization', true)
       @lang_from_path = config.fetch('lang_from_path', false)
       @exclude_from_localization = config.fetch('exclude_from_localization', []).map do |e|
-        if File.directory?(e) and e[-1] != '/'
+        if File.directory?(e) && e[-1] != '/'
           e + '/'
         else
           e
         end
       end
-
     end
 
     def fetch_languages
       @default_lang = config.fetch('default_lang', 'en')
-      @languages = config.fetch('languages', ['en'])
+      @languages = config.fetch('languages', ['en']).uniq
       @keep_files += (@languages - [@default_lang])
       @active_lang = @default_lang
       @lang_vars = config.fetch('lang_vars', [])
@@ -32,22 +33,27 @@ module Jekyll
       prepare
       all_langs = (@languages + [@default_lang]).uniq
       if @parallel_localization
+        nproc = Etc.nprocessors
         pids = {}
-        all_langs.each do |lang|
-          pids[lang] = fork do
-            process_language lang
+        begin
+          all_langs.each do |lang|
+            pids[lang] = fork do
+              process_language lang
+            end
+            while pids.length >= (lang == all_langs[-1] ? 1 : nproc)
+              sleep 0.1
+              pids.map do |lang, pid|
+                pids.delete lang if waitpid pid, Process::WNOHANG
+              end
+            end
           end
-        end
-        Signal.trap('INT') do
+        rescue Interrupt
           all_langs.each do |lang|
+            next unless pids.key? lang
             puts "Killing #{pids[lang]} : #{lang}"
             kill('INT', pids[lang])
           end
         end
-        all_langs.each do |lang|
-          waitpid pids[lang]
-          detach pids[lang]
-        end
       else
         all_langs.each do |lang|
           process_language lang
@@ -102,11 +108,11 @@ module Jekyll
       end
       segments = doc.relative_path.split('/')
       if doc.relative_path[0] == '_' \
-        and segments.length > 2 \
-        and segments[1] =~ /^[a-z]{2,3}(:?[_-](:?[A-Za-z]{2}){1,2}){0,2}$/
+        && segments.length > 2 \
+        && segments[1] =~ /^[a-z]{2,3}(:?[_-](:?[A-Za-z]{2}){1,2}){0,2}$/
         return segments[1]
       elsif segments.length > 1 \
-        and segments[0] =~ /^[a-z]{2,3}(:?[_-](:?[A-Za-z]{2}){1,2}){0,2}$/
+        && segments[0] =~ /^[a-z]{2,3}(:?[_-](:?[A-Za-z]{2}){1,2}){0,2}$/
         return segments[0]
       else
         return nil
@@ -122,10 +128,16 @@ module Jekyll
       approved = {}
       docs.each do |doc|
         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
+        # skip this document if it has already been processed
         next if @file_langs[url] == @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
+        # 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
       end
@@ -134,14 +146,19 @@ module Jekyll
 
     # performs any necesarry operations on the documents before rendering them
     def process_documents(docs)
-      return if @active_lang == @default_lang
+      # return if @active_lang == @default_lang
+
       url = config.fetch('url', false)
-      rel_regex = relative_url_regex
-      abs_regex = absolute_url_regex(url)
+      rel_regex = relative_url_regex(false)
+      abs_regex = absolute_url_regex(url, false)
+      non_rel_regex = relative_url_regex(true)
+      non_abs_regex = absolute_url_regex(url, true)
       docs.each do |doc|
-        relativize_urls(doc, rel_regex)
+        unless @active_lang == @default_lang then relativize_urls(doc, rel_regex) end
+        correct_nonrelativized_urls(doc, non_rel_regex)
         if url
-        then relativize_absolute_urls(doc, abs_regex, url)
+          unless @active_lang == @default_lang then relativize_absolute_urls(doc, abs_regex, url) end
+          correct_nonrelativized_absolute_urls(doc, non_abs_regex, url)
         end
       end
     end
@@ -159,37 +176,63 @@ module Jekyll
     end
 
     # a regex that matches relative urls in a html document
-    # matches href="baseurl/foo/bar-baz" and others like it
+    # matches href="baseurl/foo/bar-baz" href="/foo/bar-baz" and others like it
     # avoids matching excluded files.  prepare makes sure
     # that all @exclude dirs have a trailing slash.
-    def relative_url_regex
+    def relative_url_regex(disabled = false)
       regex = ''
-      (@exclude).each do |x|
-        regex += "(?!#{x})"
-      end
-      (@languages).each do |x|
-        regex += "(?!#{x}\/)"
+      unless disabled
+        @exclude.each do |x|
+          regex += "(?!#{x})"
+        end
+        @languages.each do |x|
+          regex += "(?!#{x}\/)"
+        end
       end
-      %r{href=\"?#{@baseurl}\/((?:#{regex}[^,'\"\s\/?\.#]+\.?)*(?:\/[^\]\[\)\(\"\'\s]*)?)\"}
+      start = disabled ? 'ferh' : 'href'
+      %r{#{start}=\"?#{@baseurl}\/((?:#{regex}[^,'\"\s\/?\.#]+\.?)*(?:\/[^\]\[\)\(\"\'\s]*)?)\"}
     end
 
-    def absolute_url_regex(url)
+    # a regex that matches absolute urls in a html document
+    # matches href="http://baseurl/foo/bar-baz" and others like it
+    # avoids matching excluded files.  prepare makes sure
+    # that all @exclude dirs have a trailing slash.
+    def absolute_url_regex(url, disabled = false)
       regex = ''
-      (@exclude).each do |x|
-        regex += "(?!#{x})"
-      end
-      (@languages).each do |x|
-        regex += "(?!#{x}\/)"
+      unless disabled
+        @exclude.each do |x|
+          regex += "(?!#{x})"
+        end
+        @languages.each do |x|
+          regex += "(?!#{x}\/)"
+        end
       end
-      %r{href=\"?#{url}#{@baseurl}\/((?:#{regex}[^,'\"\s\/?\.#]+\.?)*(?:\/[^\]\[\)\(\"\'\s]*)?)\"}
+      start = disabled ? 'ferh' : 'href'
+      %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"')
     end
 
     def relativize_absolute_urls(doc, regex, url)
+      return if doc.output.nil?
+
       doc.output.gsub!(regex, "href=\"#{url}#{@baseurl}/#{@active_lang}/" + '\1"')
     end
+
+    def correct_nonrelativized_absolute_urls(doc, regex, url)
+      return if doc.output.nil?
+
+      doc.output.gsub!(regex, "href=\"#{url}#{@baseurl}/" + '\1"')
+    end
+
+    def correct_nonrelativized_urls(doc, regex)
+      return if doc.output.nil?
+
+      doc.output.gsub!(regex, "href=\"#{@baseurl}/" + '\1"')
+    end
   end
 end

data/lib/jekyll/polyglot/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Polyglot
-    VERSION = '1.3.2'.freeze
+    VERSION = '1.3.3'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-polyglot
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.5.0
 platform: ruby
 authors:
 - Samuel Volin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-28 00:00:00.000000000 Z
+date: 2021-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -39,12 +39,13 @@ files:
 - lib/jekyll/polyglot/hooks/coordinate.rb
 - lib/jekyll/polyglot/hooks/process.rb
 - lib/jekyll/polyglot/liquid.rb
-- lib/jekyll/polyglot/liquid/tags/i18n-headers.rb
+- lib/jekyll/polyglot/liquid/tags/i18n_headers.rb
+- lib/jekyll/polyglot/liquid/tags/static_href.rb
 - lib/jekyll/polyglot/patches.rb
 - lib/jekyll/polyglot/patches/jekyll/site.rb
 - lib/jekyll/polyglot/patches/jekyll/static_file.rb
 - lib/jekyll/polyglot/version.rb
-homepage: http://untra.github.io/polyglot
+homepage: https://polyglot.untra.io/
 licenses:
 - MIT
 metadata: {}
@@ -56,14 +57,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 requirements: []
-rubygems_version: 3.1.2
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: I18n plugin for Jekyll Blogs