jekyll-polyglot 1.2.4 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 526e59c26e6980628a9518162f6787e3b844d012
-  data.tar.gz: 526882c53b913ff61c2cb2722897a77bbb66c9fa
+  metadata.gz: 1df6aaf664d7ec8f17ca2da2ae38232e4fe95fac
+  data.tar.gz: 223f820553ee68db46b6ef433d9c8298af737198
 SHA512:
-  metadata.gz: 0dc16249857ec6caf827301a61cfb73397ee33a45fab94697ec948da5196950eeb94161362a36caed5ecac667a6261c4a7b5dba7d5ebdd3988a31130c152a0af
-  data.tar.gz: 0f902861343803834c3c9b01aca95b9ed2969d77e076c7658de5755aa00879a147cfbf94c1f4e61fbf8c34c788418db77e22e287d80d212c551e0315cd54d164
+  metadata.gz: 617ed0583476e45cfd8ec9c41c745e2e02eaf8a52b760a767c5081c51d0d184254d6546ad585659b18c43dbdfa6a826758566f5ae7767b4472e924091494b933
+  data.tar.gz: 0ff23c46c41468bddd13a7b91622622aa47bb758f9ca07ed25763e8f4f852b8c7524823ed0dc5ba34d5b4089ce2dfa504f6fc8a70f832e0a352e155db81edd8c

data/LICENSE

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

@@ -18,7 +18,7 @@ end
 
 Or install the gem manually by doing `gem install jekyll-polyglot` and specify the plugin using `_config.yml`:
 ```YAML
-gems:
+plugins:
   - jekyll-polyglot
 ```
 
@@ -92,6 +92,39 @@ 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.
@@ -109,7 +142,7 @@ This plugin stands out from other I18n Jekyll plugins.
 - 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.
 - provides `site.data` localization for efficient rich text replacement.
 - a creator that will answer all of your questions and issues.
@@ -124,6 +157,7 @@ Check out the example project website [here](https://untra.github.io/polyglot)
 ### Other Websites Built with Polyglot
 let us know if you make a multilingual blog you want to share:
 * [LogRhythm Corporate Website](http://logrhythm.com)
+* [All Over Earth](https://allover.earth/)
 
 ## Compatibility
 Currently supports Jekyll 3.0 .

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

@@ -1,9 +1,21 @@
 # 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|
+  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])
+    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

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

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

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

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

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

@@ -1,41 +1,47 @@
 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 = {}
-      @default_lang = config.fetch('default_lang', 'en')
-      @languages = config.fetch('languages', ['en'])
+      fetch_languages
       @parallel_localization = config.fetch('parallel_localization', true)
-      (@keep_files << @languages - [@default_lang]).flatten!
       @exclude_from_localization = config.fetch('exclude_from_localization', [])
+    end
+
+    def fetch_languages
+      @default_lang = config.fetch('default_lang', 'en')
+      @languages = config.fetch('languages', ['en'])
+      @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 +53,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
@@ -87,8 +107,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
 
@@ -109,17 +136,26 @@ module Jekyll
     # avoids matching excluded files
     def relative_url_regex
       regex = ''
-      @exclude.each do |x|
+      (@exclude + @languages).each do |x|
         regex += "(?!#{x}\/)"
       end
-      url_quoted = config['url']
-      url_quoted = Regexp.quote(url_quoted) unless url_quoted.nil?
-      %r{href=\"(?:#{url_quoted})?#{@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 + @languages).each do |x|
+        regex += "(?!#{x}\/)"
+      end
+      %r{href=\"?#{url}#{@baseurl}\/((?:#{regex}[^,'\"\s\/?\.#]+\.?)*(?:\/[^\]\[\)\(\"\'\s]*)?)\"}
+    end
+
+    def relativize_urls(doc, regex)
+      doc.output.gsub!(regex, "href=\"#{@baseurl}/#{@active_lang}/" + '\1"')
+    end
+
+    def relativize_absolute_urls(doc, regex, url)
+      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.4"
+    VERSION = '1.3.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-polyglot
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.3.0
 platform: ruby
 authors:
 - Samuel Volin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-22 00:00:00.000000000 Z
+date: 2017-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -17,9 +17,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +24,6 @@ dependencies:
     - - ">="
       - !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: []
@@ -70,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: I18n plugin for Jekyll Blogs