jekyll-polyglot 1.3.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1df6aaf664d7ec8f17ca2da2ae38232e4fe95fac
-  data.tar.gz: 223f820553ee68db46b6ef433d9c8298af737198
+SHA256:
+  metadata.gz: 44004d45f57d6cd3d029fb2dd11aa4636a003648e88cbb8c0af96707379143ea
+  data.tar.gz: 944467976c70ec60171b5c8e9717d13ac844be691ab315d7937aa827eb9d42de
 SHA512:
-  metadata.gz: 617ed0583476e45cfd8ec9c41c745e2e02eaf8a52b760a767c5081c51d0d184254d6546ad585659b18c43dbdfa6a826758566f5ae7767b4472e924091494b933
-  data.tar.gz: 0ff23c46c41468bddd13a7b91622622aa47bb758f9ca07ed25763e8f4f852b8c7524823ed0dc5ba34d5b4089ce2dfa504f6fc8a70f832e0a352e155db81edd8c
+  metadata.gz: 381ec1f760288a9945c0a353b3b1cdc5ba7bcbc14a6f6b261e23d28ae6007b25770814d2b14deb8daec986271211f9b822429135449de3974b6c71041807c344
+  data.tar.gz: 8a39f63b3b72670d561299308940a76f24008d73ca84411272776767beee24c2d8a1b5dce02f99d5a490635ec8ddfaa11b0ce390a203073cc283bf13c73e378a

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2015 - 2017 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

@@ -27,15 +27,20 @@ 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", "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 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. (this is different than the jekyll `exclude: [README.md, CNAME]` ; 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 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
+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:
 ```
@@ -89,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:
@@ -107,7 +111,17 @@ 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.
+_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
+<a {% static_href %}href="/about"{% endstatic_href %}>click this static link</a>
+```
+
+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.
+
+_Previous (no longer) Recommendation:_
+If you don't want aa url to be relativized, you can add a space explicitly into the href to prevent a url from being relativized by polyglot.
 
 For example, the following urls will be relativized:
 
@@ -123,7 +137,20 @@ 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.
+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']
+---
+```
 
 #### Localized site.data
 
@@ -144,24 +171,47 @@ 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.
 
 ## SEO Recipes
 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!
 
-## 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/master/site) directory)
-
 ### Other Websites Built with Polyglot
 let us know if you make a multilingual blog you want to share:
-* [LogRhythm Corporate Website](http://logrhythm.com)
+* [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 .
-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
+
+* 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!
+
+
+## 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
 
 ## Copyright
-Copyright (c) Samuel Volin 2017. 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}

@@ -14,11 +14,12 @@ module Jekyll
           permalink = context.registers[:page]['permalink']
           site_url = @url.empty? ? site.config['url'] : @url
           i18n = "<meta http-equiv=\"Content-Language\" content=\"#{site.active_lang}\">\n"
-          i18n += "<link rel=\"alternate\" i18n=\"#{site.default_lang}\" "\
-          "href=\" #{site_url}#{permalink}\"/>\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}\" "\
+
+            i18n += "<link rel=\"alternate\" hreflang=\"#{lang}\" "\
             "href=\"#{site_url}/#{lang}#{permalink}\"/>\n"
           end
           i18n
@@ -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

@@ -8,12 +8,19 @@ module Jekyll
       @file_langs = {}
       fetch_languages
       @parallel_localization = config.fetch('parallel_localization', true)
-      @exclude_from_localization = config.fetch('exclude_from_localization', [])
+      @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 + '/'
+        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', [])
@@ -88,17 +95,42 @@ 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] == '_' \
+        && segments.length > 2 \
+        && segments[1] =~ /^[a-z]{2,3}(:?[_-](:?[A-Za-z]{2}){1,2}){0,2}$/
+        return segments[1]
+      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
+    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
+        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
@@ -107,14 +139,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
@@ -132,30 +169,63 @@ module Jekyll
     end
 
     # a regex that matches relative urls in a html document
-    # matches href="baseurl/foo/bar-baz" and others like it
-    # avoids matching excluded files
-    def relative_url_regex
+    # 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(disabled = false)
       regex = ''
-      (@exclude + @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 + @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.0'.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.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Samuel Volin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-23 00:00:00.000000000 Z
+date: 2021-04-18 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,15 +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: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: I18n plugin for Jekyll Blogs