jekyll-polyglot 1.2.2 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b617e95642f5c0337a8b7dd35416aad11a5dee21
-  data.tar.gz: 83af2f5194ba33e22e9a8f77f7996af6f79fd07d
+SHA256:
+  metadata.gz: 8d7425cddd591dc3592b0ff61562a3283e333b2239a56f27f1a031e3267f33b4
+  data.tar.gz: 6de2896cab126733b10f137b0a04e09bc73b1deb14e847b73012533f555fc2d2
 SHA512:
-  metadata.gz: 7a3f519eb89584149730065114d513f06829964d7b0a01debf42599c586250a04a8b26352e4ab099a696bc5e66bc365abaf110ae9bb411f738181fcaee07409d
-  data.tar.gz: 5844c839e5c9731782afd0323179c513d7c057d428e51d086b5bfda889ac0bf14fa2421bb3615075eabbb89d157eddfc95f4a6cc730ed443e339ce0b58d89903
+  metadata.gz: b91c4e63e27ca6e7d86d0dd2fe378e976abe8b1f3b5914f52399f5f6548b3187f9fdf96fc03c3ef142949428f88b5c5d772b62d01eb62dd36ae3f1aab704bd30
+  data.tar.gz: f54dfc40d3a06ecac353b0f5225532a917d49bb5a28aca75355472d463aa9fef510f79330f6f2bfca90f04d2af5b226e0f3fa3a8702747c8a2269c64f995161a

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2015 - 2016 Samuel Volin
+Copyright (c) 2015 - 2020 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

@@ -9,26 +9,38 @@ __Polyglot__ is a fast, painless, open-source internationalization plugin for [J
 Jekyll doesn't provide native support for multi-language blogs. This plugin was modeled after the [jekyll-multiple-languages-plugin](https://github.com/screeninteraction/jekyll-multiple-languages-plugin), whose implementation I liked, but execution I didn't.
 
 ## Installation
-`gem install jekyll-polyglot` and add jekyll-polyglot to your `_config.yml` like the following:
-```yml
-gems:
+Add jekyll-polyglot to your `Gemfile` if you are using Bundler:
+```Ruby
+group :jekyll_plugins do
+   gem "jekyll-polyglot"
+end
+```
+
+Or install the gem manually by doing `gem install jekyll-polyglot` and specify the plugin using `_config.yml`:
+```YAML
+plugins:
   - jekyll-polyglot
 ```
 
 ## Configuration
 In your `_config.yml` file, add the following preferences
-```
+```YAML
 languages: ["en", "sv", "de", "fr"]
 default_lang: "en"
-exclude_from_localization: ["javascript", "images", "css"]
+exclude_from_localization: ["javascript", "images", "css", "README.md"]
 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 folders are you excluding from localization
+- what root level files/folders are excluded from localization, based
+  on if their paths start with any of the excluded regexp substrings
 - whether to run language processing in parallel or serial
 
+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.
+
 ## How To Use It
 When adding new posts and pages, add to the YAML front matter:
 ```
@@ -80,40 +92,86 @@ becomes
   <p>Nous sommes un restaurant situé à Paris . <a href="/fr/menu/">Ceci est notre menu.</a></p>
 </article>
 ```
-Voila!
+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.
 
+#### Relativized Absolute Urls
+If you defined a site `url` in your `_config.yaml`, polyglot will automatically relativize absolute links pointing to your website directory:
+
+```md
+---
+lang: fr
+---
+Cliquez [ici]({{site.url}}) pour aller à l'entrée du site.
+```
+becomes
+```html
+<p>Cliquez <a href="https://mywebsite.com/fr/">ici</a> pour aller à l'entrée du site.
+```
+
+#### 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:
+
+```html
+href="http://mywebsite.com/about"
+href="/about"
+```
+
+and the following urls will be left alone:
+
+```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.
+
+#### Localized site.data
+
+There are cases when `site.data` localization is required.
+For instance: you might need to localize `_data/navigation.yml` that holds "navigation menu".
+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 seperate 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 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.
 
-`Jekyll::Site.process` is the entrypoint for the Jekyll build process. Take care whatever other plugins you use do not also attempt to overwrite this method. You may have problems.
+`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.
 
 ## Features
 This plugin stands out from other I18n Jekyll plugins.
-- automatically corrects your relative links, keeping your *french* vistors on your *french* website, even when content has to fallback to the `default_lang`.
+- automatically corrects your relative links, keeping your *french* visitors on your *french* website, even when content has to fallback to the `default_lang`.
 - builds all versions of your website *simultaneously*, allowing big websites to scale efficiently.
 - provides the liquid tag `{{ site.languages }}` to get an array of your I18n strings.
 - 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.
+- 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.
-- A creator that will answer all of your questions and issues.
+- provides `site.data` localization for efficient rich text replacement.
+- a creator that will answer all of your questions and issues.
 
 ## SEO Recipes
-Jekyll-polyglot has a few spectacular [Search Engine Optimization technique](https://untra.github.io/polyglot/seo) to ensure your jekyll blog gets the most out of it's multilingual audience. Check them out!
-
-## Examples
-Check out the example project website [here](https://untra.github.io/polyglot)
-(Jekyll resources are on the project's [site](https://github.com/untra/polyglot/tree/site) branch)
+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)
+* [All Over Earth](https://allover.earth/)
+* [Hanare Cafe in Toshijima, Japan](https://hanarecafe.com)
+* [F-Droid](https://f-droid.org)
 
 ## Compatibility
-Currently supports Jekyll 3.0 .
-Windows users will need to disable parallel_localization on their machines by setting `parallel_localization: false` in the `_config.yml`
+Currently supports Jekyll 3.0 , and Jekyll 4.0 (for the most part)
+
+* *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:
+```yaml
+sass:
+    sourcemap: never
+```
 
 ## Copyright
-Copyright (c) Samuel Volin 2015. License: MIT
+Copyright (c) Samuel Volin 2020. License: MIT

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

@@ -1,6 +1,23 @@
 # hook to coordinate blog posts and pages into distinct urls,
 # and remove duplicate multilanguage posts and pages
 Jekyll::Hooks.register :site, :post_read do |site|
-  site.posts.docs = site.coordinate_documents(site.posts.docs)
+  hook_coordinate(site)
+end
+
+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 }
+  if site.data.include?(site.default_lang)
+    site.data = site.data.merge(site.data[site.default_lang], &merger)
+  end
+  if site.data.include?(site.active_lang)
+    site.data = site.data.merge(site.data[site.active_lang], &merger)
+  end
+
+  site.collections.each do |_, collection|
+    collection.docs = site.coordinate_documents(collection.docs)
+  end
   site.pages = site.coordinate_documents(site.pages)
 end

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

@@ -1,5 +1,11 @@
 # hook to make a call to process rendered documents,
 Jekyll::Hooks.register :site, :post_render do |site|
-  site.process_documents(site.posts.docs)
+  hook_process(site)
+end
+
+def hook_process(site)
+  site.collections.each do |_, collection|
+    site.process_documents(collection.docs)
+  end
   site.process_documents(site.pages)
 end

data/lib/jekyll/polyglot/liquid/tags/i18n-headers.rb

@@ -12,13 +12,14 @@ module Jekyll
         def render(context)
           site = context.registers[:site]
           permalink = context.registers[:page]['permalink']
-          i18n = "<meta http-equiv=\"Content-Language\" content=\"#{site.active_lang}\">"
-          i18n += "<link rel=\"alternate\" i18n=\"#{site.default_lang}\""\
-          " href=\"#{@url}#{permalink}\" />\n"
+          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"
           site.languages.each do |lang|
             next if lang == site.default_lang
-            i18n += "<link rel=\"alternate\" i18n=\"#{lang}\""\
-            " href=\"#{@url}/#{lang}#{permalink}\" />\n"
+            i18n += "<link rel=\"alternate\" hreflang=\"#{lang}\" "\
+            "href=\"#{site_url}/#{lang}#{permalink}\"/>\n"
           end
           i18n
         end

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

@@ -1,41 +1,55 @@
 include Process
 module Jekyll
   class Site
-    attr_reader :default_lang, :languages, :exclude_from_localization
+    attr_reader :default_lang, :languages, :exclude_from_localization, :lang_vars
     attr_accessor :file_langs, :active_lang
 
     def prepare
       @file_langs = {}
+      fetch_languages
+      @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] != '/'
+          e + '/'
+        else
+          e
+        end
+      end
+
+    end
+
+    def fetch_languages
       @default_lang = config.fetch('default_lang', 'en')
       @languages = config.fetch('languages', ['en'])
-      @parallel_localization = config.fetch('parallel_localization', true)
-      (@keep_files << @languages - [@default_lang]).flatten!
-      @exclude_from_localization = config.fetch('exclude_from_localization', [])
+      @keep_files += (@languages - [@default_lang])
       @active_lang = @default_lang
+      @lang_vars = config.fetch('lang_vars', [])
     end
 
     alias_method :process_orig, :process
     def process
       prepare
+      all_langs = (@languages + [@default_lang]).uniq
       if @parallel_localization
         pids = {}
-        @languages.each do |lang|
+        all_langs.each do |lang|
           pids[lang] = fork do
             process_language lang
           end
         end
         Signal.trap('INT') do
-          @languages.each do |lang|
+          all_langs.each do |lang|
             puts "Killing #{pids[lang]} : #{lang}"
             kill('INT', pids[lang])
           end
         end
-        @languages.each do |lang|
+        all_langs.each do |lang|
           waitpid pids[lang]
           detach pids[lang]
         end
       else
-        @languages.each do |lang|
+        all_langs.each do |lang|
           process_language lang
         end
       end
@@ -47,14 +61,28 @@ module Jekyll
       payload['site']['default_lang'] = default_lang
       payload['site']['languages'] = languages
       payload['site']['active_lang'] = active_lang
+      lang_vars.each do |v|
+        payload['site'][v] = active_lang
+      end
       payload
     end
 
     def process_language(lang)
       @active_lang = lang
       config['active_lang'] = @active_lang
-      return process_orig if @active_lang == @default_lang
-      process_active_language
+      lang_vars.each do |v|
+        config[v] = @active_lang
+      end
+      if @active_lang == @default_lang
+      then process_default_language
+      else process_active_language
+      end
+    end
+
+    def process_default_language
+      old_include = @include
+      process_orig
+      @include = old_include
     end
 
     def process_active_language
@@ -68,13 +96,32 @@ module Jekyll
       @exclude = old_exclude
     end
 
+    def derive_lang_from_path(doc)
+      if !@lang_from_path
+        return nil
+      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}$/
+        return segments[1]
+      elsif segments.length > 1 \
+        and segments[0] =~ /^[a-z]{2,3}(:?[_-](:?[A-Za-z]{2}){1,2}){0,2}$/
+        return segments[0]
+      else
+        return nil
+      end
+    end
+
     # assigns natural permalinks to documents and prioritizes documents with
-    # active_lang languages over others
+    # active_lang languages over others.  If lang is not set in front matter,
+    # then this tries to derive from the path, if the lang_from_path is set.
+    # otherwise it will assign the document to the default_lang
     def coordinate_documents(docs)
       regex = document_url_regex
       approved = {}
       docs.each do |doc|
-        lang = doc.data['lang'] || @default_lang
+        lang = doc.data['lang'] || derive_lang_from_path(doc) || @default_lang
         url = doc.url.gsub(regex, '/')
         doc.data['permalink'] = url
         next if @file_langs[url] == @active_lang
@@ -87,8 +134,15 @@ module Jekyll
 
     # performs any necesarry operations on the documents before rendering them
     def process_documents(docs)
+      return if @active_lang == @default_lang
+      url = config.fetch('url', false)
+      rel_regex = relative_url_regex
+      abs_regex = absolute_url_regex(url)
       docs.each do |doc|
-        relativize_urls doc
+        relativize_urls(doc, rel_regex)
+        if url
+        then relativize_absolute_urls(doc, abs_regex, url)
+        end
       end
     end
 
@@ -106,18 +160,40 @@ module Jekyll
 
     # a regex that matches relative urls in a html document
     # matches href="baseurl/foo/bar-baz" and others like it
-    # avoids matching excluded files
+    # avoids matching excluded files.  prepare makes sure
+    # that all @exclude dirs have a trailing slash.
     def relative_url_regex
       regex = ''
-      @exclude.each do |x|
+      (@exclude).each do |x|
+        regex += "(?!#{x})"
+      end
+      (@languages).each do |x|
         regex += "(?!#{x}\/)"
       end
-      %r{href=\"#{@baseurl}\/((?:#{regex}[^,'\"\s\/?\.#]+\.?)*(?:\/[^\]\[\)\(\"\'\s]*)?)\"}
+      %r{href=\"?#{@baseurl}\/((?:#{regex}[^,'\"\s\/?\.#]+\.?)*(?:\/[^\]\[\)\(\"\'\s]*)?)\"}
     end
 
-    def relativize_urls(doc)
-      return if @active_lang == @default_lang
-      doc.output.gsub!(relative_url_regex, "href=\"#{@baseurl}/#{@active_lang}/" + '\1"')
+    def absolute_url_regex(url)
+      regex = ''
+      (@exclude).each do |x|
+        regex += "(?!#{x})"
+      end
+      (@languages).each do |x|
+        regex += "(?!#{x}\/)"
+      end
+      %r{href=\"?#{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
   end
 end

data/lib/jekyll/polyglot/version.rb

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

metadata

@@ -1,35 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-polyglot
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.3
 platform: ruby
 authors:
 - Samuel Volin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-22 00:00:00.000000000 Z
+date: 2020-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.1'
 description: Fast open source i18n plugin for Jekyll blogs.
 email: untra.sam@gmail.com
 executables: []
@@ -60,17 +54,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: I18n plugin for Jekyll Blogs