jekyll-polyglot 1.3.3 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d7425cddd591dc3592b0ff61562a3283e333b2239a56f27f1a031e3267f33b4
-  data.tar.gz: 6de2896cab126733b10f137b0a04e09bc73b1deb14e847b73012533f555fc2d2
+  metadata.gz: 37bbf459ea94dd1edd9fbef3aeb136db17a68b78b58a1b983d8bbc2cbe24727b
+  data.tar.gz: 5148941f48e63247596579130b8dbd8c407be7e326a2cc59b98725291d9f564d
 SHA512:
-  metadata.gz: b91c4e63e27ca6e7d86d0dd2fe378e976abe8b1f3b5914f52399f5f6548b3187f9fdf96fc03c3ef142949428f88b5c5d772b62d01eb62dd36ae3f1aab704bd30
-  data.tar.gz: f54dfc40d3a06ecac353b0f5225532a917d49bb5a28aca75355472d463aa9fef510f79330f6f2bfca90f04d2af5b226e0f3fa3a8702747c8a2269c64f995161a
+  metadata.gz: 303584c6688bf73fb8fc15a8c6bb160b0ae2b055744bdac4a3515455343a20dfbccff2d5713e74f2dca6235f0ed40e0b5d9a7f230a9a57f4b007ae2b0bd5fc8b
+  data.tar.gz: de6caa20d33315f63c8f7f6da8800e83aa2f77548a8d21ed8bf4e8c7529d16ee96813eaef4d46fc9885867c03ae3b48e9681af041fda8c21e645ed8fbf560aaa

data/README.md

@@ -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,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:
 
@@ -128,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
 
@@ -149,6 +171,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.
 
@@ -157,21 +180,36 @@ Jekyll-polyglot has a few spectacular [Search Engine Optimization techniques](ht
 
 ### 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)
+* [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!
+
+## Roadmap
+[ ] - **site language**: portuguese `pt_BR` `pt_PT`
+[ ] - **site language**: arabic `ar`
+[ ] - **site language**: japanese `ja`
+[ ] - **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 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}

@@ -18,6 +18,7 @@ module Jekyll
           "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

@@ -10,18 +10,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', [])
@@ -102,11 +101,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 +121,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 +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
@@ -159,29 +169,39 @@ 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{#{start}=\"?#{url}#{@baseurl}\/((?:#{regex}[^,'\"\s\/?\.#]+\.?)*(?:\/[^\]\[\)\(\"\'\s]*)?)\"}
     end
 
     def relativize_urls(doc, regex)
@@ -195,5 +215,17 @@ module Jekyll
 
       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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-polyglot
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.4.0
 platform: ruby
 authors:
 - Samuel Volin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-28 00:00:00.000000000 Z
+date: 2021-02-07 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,14 @@ 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
+rubygems_version: 3.2.7
 signing_key: 
 specification_version: 4
 summary: I18n plugin for Jekyll Blogs