jekyll-polyglot 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 289c28c81021239f036efc472756cef0fde5516d
-  data.tar.gz: 4ca06ed535b8c8d6a2ccd8c49c10d8711ea73595
+  metadata.gz: 02c8a3bf16dd0455f8c5bd7f59d6af52497841ca
+  data.tar.gz: 0cf51394151e5a6a1652891530a645bffbd43a77
 SHA512:
-  metadata.gz: 7251009d52ff1b6e86b21ebca008d1deb6ca555745e45edf69af9cf779999b180c314d8f011dd5cbed2688c4f572107253e622419231e75dffaa8f7143f7e40d
-  data.tar.gz: 211636afabf4b5868cd1a76d183e292acf93dc48428113eab1d5d0578850ac9a57d40d81f111f7d4a72503fecf714166abffa63a0c2e4efcb3c5eac2d3be0927
+  metadata.gz: 6cb846b3bac1a1cdaac5f82693e39d5c4a76ff620ef2c88129bdf7762a076951914e67ba63b658654085e33c511b385579bc981bdc2e23078bfd33299a058185
+  data.tar.gz: f81bbd4f9bfd0400a2c2f9b488538b8faca334d68aac9b8536a10700558d69b7236a849dc906f7a1bc708d54153642fc4ce2d56ce49d7992f543792d7692e6ab

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2015 - 2016 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:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,118 @@
+:abc: Polyglot
+---
+version 1.2.0 [![Build Status](https://travis-ci.org/untra/polyglot.svg?branch=master)](https://travis-ci.org/untra/polyglot)
+
+__Polyglot__ is a fast, painless, open-source internationalization plugin for [Jekyll](http://jekyllrb.com) blogs. Polyglot is easy to setup and use with any Jekyll project, and it scales to the languages you want to support. With fallback support for missing content, automatic url relativization, and powerful SEO tools, Polyglot allows any multi-language jekyll blog to focus on content without the cruft.
+
+## Why?
+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:
+  - jekyll-assets
+```
+
+## Configuration
+In your `_config.yml` file, add the following preferences
+```
+languages: ["en", "sv", "de", "fr"]
+default_lang: "en"
+exclude_from_localization: ["javascript", "images", "css"]
+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
+- whether to run language processing in parallel or serial
+
+## How To Use It
+When adding new posts and pages, add to the YAML front matter:
+```
+lang: sv
+```
+or whatever appropriate [I18n language code](https://developer.chrome.com/webstore/i18n)
+the page should build for. And you're done. Ideally, when designing your site, you should
+organize files by their relative urls.
+
+Polyglot works by associating documents with similar permalinks to the `lang` specified in their frontmatter. Files that correspond to similar routes should have identical permalinks. If you don't provide a permalink for a post, ___make sure you are consistent___ with how you place and name corresponding files:
+```
+_posts/2010-03-01-salad-recipes-en.md
+_posts/2010-03-01-salad-recipes-sv.md
+_posts/2010-03-01-salad-recipes-fr.md
+```
+
+Organized names will generate consistent permalinks when the post is rendered, and polyglot will know to build seperate language versions of
+the website using only the files with the correct `lang` variable in the front matter.
+
+In short:
+* Be consistent with how you name and place your *posts* files
+* Always give your *pages* permalinks in the frontmatter
+* Don't overthink it, :wink:
+
+
+#### Fallback Language Support
+Lets say you are building your website. You have an `/about/` page written in *english*, *german* and
+*swedish*. You are also supporting a *french* website, but you never designed a *french* version of your `/about/` page!
+
+No worries. Polyglot ensures the sitemap of your *english* site matches your *french* site, matches your *swedish* and *german* sites too. In this case, because you specified a `default_lang` variable in your `_config.yml`, all sites missing their languages' counterparts will fallback to your `default_lang`, so content is preserved across different languages of your site.
+
+#### Relativized Local Urls
+No need to meticulously manage anchor tags to link to your correct language. Polyglot modifies how pages get written to the site so your *french* links keep vistors on your *french* blog.
+```md
+---
+title: au sujet de notre entreprise
+permalink: /about/
+lang: fr
+---
+Nous sommes un restaurant situé à Paris . [Ceci est notre menu.](/menu/)
+```
+becomes
+```html
+<header class="post-header">
+  <h1 class="post-title">au sujet de notre entreprise</h1>
+</header>
+
+<article class="post-content">
+  <p>Nous sommes un restaurant situé à Paris . <a href="/fr/menu/">Ceci est notre menu.</a></p>
+</article>
+```
+Voila!
+
+Even if you are falling back to `default_lang` page, relative links built on the *french* site will
+still link to *french* pages.
+
+## 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.
+
+`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.
+
+## 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`.
+- 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.
+
+## 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)
+
+### Other Websites Built with Polyglot
+
+* [LogRhythm Corporate Website](http://logrhythm.com)
+
+## 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`
+
+## Copyright
+Copyright (c) Samuel Volin 2015. License: MIT

data/lib/jekyll-polyglot.rb

@@ -0,0 +1 @@
+require "jekyll/polyglot"

data/lib/jekyll/polyglot.rb

@@ -0,0 +1,6 @@
+require 'jekyll'
+
+require_relative 'polyglot/liquid'
+require_relative 'polyglot/patches'
+require_relative 'polyglot/hooks'
+require_relative 'polyglot/version'

data/lib/jekyll/polyglot/hooks.rb

@@ -0,0 +1,3 @@
+require_relative 'hooks/assets-toggle'
+require_relative 'hooks/coordinate'
+require_relative 'hooks/process'

data/lib/jekyll/polyglot/hooks/assets-toggle.rb

@@ -0,0 +1,7 @@
+# Jekyll::Hooks.register :site, :after_init do |site|
+#   if site.config['assets']
+#     if site.active_lang != site.default_lang
+#       then jekyll.sprockets.asset_config['autowrite'] = false
+#     end
+#   end
+# end

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

@@ -0,0 +1,6 @@
+# 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)
+  site.pages = site.coordinate_documents(site.pages)
+end

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

@@ -0,0 +1,5 @@
+# hook to make a call to process rendered documents,
+Jekyll::Hooks.register :site, :post_render do |site|
+  site.process_documents(site.posts.docs)
+  site.process_documents(site.pages)
+end

data/lib/jekyll/polyglot/liquid.rb

@@ -0,0 +1,7 @@
+module Jekyll
+  module Polyglot
+    module Liquid
+      require_relative 'liquid/tags/i18n-headers'
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+module Jekyll
+  module Polyglot
+    module Liquid
+      class I18nHeadersTag < ::Liquid::Tag
+        def initialize(tag_name, text, tokens)
+          super
+          @url = text
+          @url.strip!
+          @url.chomp! '/'
+        end
+
+        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.languages.each do |lang|
+            next if lang == site.default_lang
+            i18n += "<link rel=\"alternate\" i18n=\"#{lang}\""\
+            " href=\"#{@url}/#{lang}#{permalink}\" />\n"
+          end
+          i18n
+        end
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('I18n_Headers', Jekyll::Polyglot::Liquid::I18nHeadersTag)

data/lib/jekyll/polyglot/patches.rb

@@ -0,0 +1,2 @@
+require_relative 'patches/jekyll/site'
+require_relative 'patches/jekyll/static_file'

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

@@ -0,0 +1,118 @@
+include Process
+module Jekyll
+  class Site
+    attr_reader :default_lang, :languages, :exclude_from_localization
+    attr_accessor :file_langs, :active_lang
+
+    def prepare
+      @file_langs = {}
+      @default_lang = config['default_lang'] || 'en'
+      @languages = config['languages'] || ['en']
+      @parallel_localization = config['parallel_localization'] || true
+      (@keep_files << @languages - [@default_lang]).flatten!
+      @exclude_from_localization = config['exclude_from_localization'] || []
+      @active_lang = @default_lang
+    end
+
+    alias_method :process_orig, :process
+    def process
+      prepare
+      if @parallel_localization
+        pids = {}
+        @languages.each do |lang|
+          pids[lang] = fork do
+            process_language lang
+          end
+        end
+        Signal.trap('INT') do
+          @languages.each do |lang|
+            puts "Killing #{pids[lang]} : #{lang}"
+            kill('INT', pids[lang])
+          end
+        end
+        @languages.each do |lang|
+          waitpid pids[lang]
+          detach pids[lang]
+        end
+      else
+        @languages.each do |lang|
+          process_language lang
+        end
+      end
+    end
+
+    alias_method :site_payload_orig, :site_payload
+    def site_payload
+      payload = site_payload_orig
+      payload['site']['default_lang'] = default_lang
+      payload['site']['languages'] = languages
+      payload['site']['active_lang'] = active_lang
+      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
+    end
+
+    def process_active_language
+      @dest = @dest + '/' + @active_lang
+      @exclude += @exclude_from_localization
+      process_orig
+    end
+
+    # assigns natural permalinks to documents and prioritizes documents with
+    # active_lang languages over others
+    def coordinate_documents(docs)
+      regex = document_url_regex
+      approved = {}
+      docs.each do |doc|
+        lang = doc.data['lang'] || @default_lang
+        url = doc.url.gsub(regex, '/')
+        doc.data['permalink'] = url
+        next if @file_langs[url] == @active_lang
+        next if @file_langs[url] == @default_lang && lang != @active_lang
+        approved[url] = doc
+        @file_langs[url] = lang
+      end
+      approved.values
+    end
+
+    # performs any necesarry operations on the documents before rendering them
+    def process_documents(docs)
+      docs.each do |doc|
+        relativize_urls doc
+      end
+    end
+
+    # a regex that matches urls or permalinks with i18n prefixes or suffixes
+    # matches /en/foo , .en/foo , foo.en/ and other simmilar default urls
+    # made by jekyll when parsing documents without explicitly set permalinks
+    def document_url_regex
+      regex = ''
+      @languages.each do |lang|
+        regex += "([\/\.]#{lang}[\/\.])|"
+      end
+      regex.chomp! '|'
+      %r{#{regex}}
+    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
+      regex = ''
+      @exclude.each do |x|
+        regex += "(?!#{x}\/)"
+      end
+      %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"')
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+
+module Jekyll
+  # Alteration to Jekyll StaticFile
+  # provides aliased methods to direct write to skip files
+  # excluded from localization
+  class StaticFile
+    alias_method :write_orig, :write
+    def write(dest)
+      return false if exclude_from_localization?
+      write_orig(dest)
+    end
+
+    def exclude_from_localization?
+      return false if @site.active_lang == @site.default_lang
+      @site.exclude_from_localization.each do |e|
+        return true if relative_path[1..-1].start_with?(e)
+      end
+      false
+    end
+  end
+end

data/lib/jekyll/polyglot/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module Polyglot
+    VERSION="1.2.0.pre.alpha"
+  end
+end

data/lib/polyglot.rb

@@ -1,4 +1,4 @@
-# Jekyll Polyglot v1.1.2
+# Jekyll Polyglot v1.2.0
 # Fast, painless, open source i18n plugin for Jekyll 3.0 Blogs.
 #   author: Samuel Volin (@untra)
 #   github: https://github.com/untra/polyglot
@@ -67,88 +67,73 @@ module Jekyll
 
     def process_active_language
       @dest = @dest + '/' + @active_lang
-      @exclude += config['exclude_from_localization']
+      @exclude += @exclude_from_localization
       process_orig
     end
 
-    # hook to coordinate blog posts into distinct urls,
-    # and remove duplicate multilanguage posts
-    Jekyll::Hooks.register :site, :post_read do |site|
-      langs = {}
+    # assigns natural permalinks to documents and prioritizes documents with
+    # active_lang languages over others
+    def coordinate_documents(docs)
+      regex = document_url_regex
       approved = {}
-      n = ''
-      site.languages.each do |lang|
-        n += "([\/\.]#{lang}[\/\.])|"
-      end
-      n.chomp! '|'
-      site.posts.docs.each do |doc|
-        language = doc.data['lang'] || site.default_lang
-        url = doc.url.gsub(%r{#{n}}, '/')
+      docs.each do |doc|
+        lang = doc.data['lang'] || @default_lang
+        url = doc.url.gsub(regex, '/')
         doc.data['permalink'] = url
-        next if langs[url] == site.active_lang
-        if langs[url] == site.default_lang
-          next if language != site.active_lang
-        end
+        next if @file_langs[url] == @active_lang
+        next if @file_langs[url] == @default_lang && lang != @active_lang
         approved[url] = doc
-        langs[url] = language
+        @file_langs[url] = lang
       end
-      site.posts.docs = approved.values
+      approved.values
     end
-  end
 
-  # Alteration to Jekyll Convertible module
-  # provides aliased methods to direct Convertible to skip files for write under
-  # certain conditions
-  module Convertible
-    def lang
-      data['lang'] || site.config['default_lang']
-    end
-
-    def lang=(str)
-      data['lang'] = str
+    # performs any necesarry operations on the documents before rendering them
+    def process_documents(docs)
+      docs.each do |doc|
+        relativize_urls doc
+      end
     end
 
-    alias_method :write_orig, :write
-    def write(dest)
-      path = polypath(dest)
-      return if skip?(path)
-      output_orig = output.clone
-      relativize_urls(site.active_lang)
-      write_orig(dest)
-      self.output = output_orig
-      site.file_langs[path] = lang
+    # a regex that matches urls or permalinks with i18n prefixes or suffixes
+    # matches /en/foo , .en/foo , foo.en/ and other simmilar default urls
+    # made by jekyll when parsing documents without explicitly set permalinks
+    def document_url_regex
+      regex = ''
+      @languages.each do |lang|
+        regex += "([\/\.]#{lang}[\/\.])|"
+      end
+      regex.chomp! '|'
+      %r{#{regex}}
     end
 
-    def polypath(dest)
-      n = ''
-      site.languages.each do |lang|
-        n += "(\\\.#{lang}\\/)|"
+    # a regex that matches relative urls in a html document
+    # matches href="baseurl/foo/bar-baz" and others like it
+    def relative_url_regex
+      regex = ''
+      @exclude.each do |x|
+        regex += "(?!#{x}\/)"
       end
-      n.chomp! '|'
-      destination(dest).gsub(%r{#{n}}, '/')
+      # regex that looks for all relative urls except for excluded files
+      %r{href=\"#{@baseurl}\/((?:#{regex}[^,'\"\s\/?\.#-]+\.?)*(?:\/[^\]\[\)\(\"\'\s]*)?)\"}
     end
 
-    def skip?(path)
-      return false if site.file_langs[path].nil?
-      return false if lang == site.active_lang
-      if lang == site.default_lang
-        return site.file_langs[path] == site.active_lang
-      end
-      true
+    def relativize_urls(doc)
+      return if @active_lang == @default_lang
+      doc.output.gsub!(relative_url_regex, "href=\"#{@baseurl}/#{@active_lang}/" + '\1"')
     end
 
-    def relativize_urls(lang)
-      return if lang == site.default_lang
-      output.gsub!(relative_url_regex, "href=\"#{site.baseurl}/#{lang}/" + '\1"')
+    # 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)
+      site.pages = site.coordinate_documents(site.pages)
     end
 
-    def relative_url_regex
-      n = ''
-      site.exclude.each do |x|
-        n += "(?!#{x}\/)"
-      end
-      # regex that looks for all relative urls except for excluded files
-      %r{href=\"#{site.baseurl}\/((?:#{n}[^,'\"\s\/?\.#-]+\.?)*(?:\/[^\]\[\)\(\"\'\s]*)?)\"}
+    # hook to make a call to process rendered documents,
+    Jekyll::Hooks.register :site, :post_render do |site|
+      site.process_documents(site.posts.docs)
+      site.process_documents(site.pages)
     end
   end
 

metadata

@@ -1,21 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-polyglot
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Samuel Volin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-04 00:00:00.000000000 Z
-dependencies: []
-description: Fast open source internationalization plugin for Jekyll blogs.
+date: 2016-04-20 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: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
+- lib/jekyll-polyglot.rb
+- lib/jekyll/polyglot.rb
+- lib/jekyll/polyglot/hooks.rb
+- lib/jekyll/polyglot/hooks/assets-toggle.rb
+- 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/patches.rb
+- lib/jekyll/polyglot/patches/jekyll/site.rb
+- lib/jekyll/polyglot/patches/jekyll/static_file.rb
+- lib/jekyll/polyglot/version.rb
 - lib/polyglot.rb
 homepage: http://untra.github.io/polyglot
 licenses: