jekyll-polyglot 1.2.2 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b617e95642f5c0337a8b7dd35416aad11a5dee21
-  data.tar.gz: 83af2f5194ba33e22e9a8f77f7996af6f79fd07d
+  metadata.gz: 526e59c26e6980628a9518162f6787e3b844d012
+  data.tar.gz: 526882c53b913ff61c2cb2722897a77bbb66c9fa
 SHA512:
-  metadata.gz: 7a3f519eb89584149730065114d513f06829964d7b0a01debf42599c586250a04a8b26352e4ab099a696bc5e66bc365abaf110ae9bb411f738181fcaee07409d
-  data.tar.gz: 5844c839e5c9731782afd0323179c513d7c057d428e51d086b5bfda889ac0bf14fa2421bb3615075eabbb89d157eddfc95f4a6cc730ed443e339ce0b58d89903
+  metadata.gz: 0dc16249857ec6caf827301a61cfb73397ee33a45fab94697ec948da5196950eeb94161362a36caed5ecac667a6261c4a7b5dba7d5ebdd3988a31130c152a0af
+  data.tar.gz: 0f902861343803834c3c9b01aca95b9ed2969d77e076c7658de5755aa00879a147cfbf94c1f4e61fbf8c34c788418db77e22e287d80d212c551e0315cd54d164

data/README.md

@@ -9,15 +9,22 @@ __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
+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
 gems:
   - 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"]
@@ -80,35 +87,42 @@ 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.
 
+#### 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 `{{ 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!
+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/site) branch)
+(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)
 
 ## Compatibility
@@ -116,4 +130,4 @@ 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`
 
 ## Copyright
-Copyright (c) Samuel Volin 2015. License: MIT
+Copyright (c) Samuel Volin 2017. License: MIT

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

@@ -1,6 +1,11 @@
 # 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)
+  if site.data.include?(site.active_lang)
+    site.data = site.data.merge(site.data[site.active_lang])
+  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,7 @@
 # hook to make a call to process rendered documents,
 Jekyll::Hooks.register :site, :post_render do |site|
-  site.process_documents(site.posts.docs)
+  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']
+          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=\"#{@url}#{permalink}\" />\n"
+          " href=\"#{siteUrl}#{permalink}\" />\n"
           site.languages.each do |lang|
             next if lang == site.default_lang
             i18n += "<link rel=\"alternate\" i18n=\"#{lang}\""\
-            " href=\"#{@url}/#{lang}#{permalink}\" />\n"
+            " href=\"#{siteUrl}/#{lang}#{permalink}\" />\n"
           end
           i18n
         end

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

@@ -112,7 +112,9 @@ module Jekyll
       @exclude.each do |x|
         regex += "(?!#{x}\/)"
       end
-      %r{href=\"#{@baseurl}\/((?:#{regex}[^,'\"\s\/?\.#]+\.?)*(?:\/[^\]\[\)\(\"\'\s]*)?)\"}
+      url_quoted = config['url']
+      url_quoted = Regexp.quote(url_quoted) unless url_quoted.nil?
+      %r{href=\"(?:#{url_quoted})?#{@baseurl}\/((?:#{regex}[^,'\"\s\/?\.#]+\.?)*(?:\/[^\]\[\)\(\"\'\s]*)?)\"}
     end
 
     def relativize_urls(doc)

data/lib/jekyll/polyglot/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Polyglot
-    VERSION="1.2.2"
+    VERSION="1.2.4"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-polyglot
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.4
 platform: ruby
 authors:
 - Samuel Volin
@@ -14,20 +14,20 @@ dependencies:
   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.
@@ -60,17 +60,17 @@ 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: 2.5.2
 signing_key: 
 specification_version: 4
 summary: I18n plugin for Jekyll Blogs