jekyll-language-plugin 1.1.7 → 1.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 76a39471fe7e6ad748b7ddf255a6c254e4cb11c4
-  data.tar.gz: 7a1af5612ba9cc46c054bc19344bbefdcf1b2b0e
+  metadata.gz: 9f68ac9191d9f6cb48cf3543c56a77b7e4feab60
+  data.tar.gz: 361f0c76aaba69215a66c1aed0137cee6224e25c
 SHA512:
-  metadata.gz: 88d6e2795d11668a803166accdc6b167f290464ffd94202ccbc5bd96f7671d289b05607c051a574706205ae26e059256d60788764ec35f9cc20ba6200ed54fcb
-  data.tar.gz: 1e9cdec599cf6801c27446668424b9893f0250b3d924298c4f04aafadbc7e72ccd26b17747beb0bf1cb2efad13e98b04cdf7f3b2f67e2b3ba3bb799c233e8041
+  metadata.gz: 4221a4fda1d0042a4af2ac0a7be3a78214e0ee80571470425dc9813fd4f33e3a66d5c0026d17a3c3ca38793421b00413bd17ab5f79e5c81da51b2ced57144728
+  data.tar.gz: 8337952640d00526dd6f98421a05943f1676586535145ba9667bccf384c90296fd634e37fca823ecf4a25f80d4aa65df36966eba4d5bd31565aabb6da051a080

data/README.md

@@ -2,6 +2,8 @@
 
 > Jekyll 3.0-compatible multi-language plugin for posts, pages and includes
 
+<div align="center"><img src="https://raw.githubusercontent.com/vwochnik/jekyll-language-plugin/master/images/jekyll-i18n-logo.png" width="480" height="143" alt="Jekll Language Plugin"></div>
+
 Jekyll Language Plugin is an internationalization plugin for [Jekyll][jekyll]. It diversifies pages, posts and includes that have been optimized for the use with this plugin into different languages which are organized into subdirectories named after the language name.
 
 This plugin has been developed with user-simplicity in mind. It does not require a complex setup process unlike some other internationalization plugins.
@@ -12,6 +14,7 @@ This plugin has been developed with user-simplicity in mind. It does not require
 * Supports all template languages that your Liquid pipeline supports.
 * Uses liquid tags in your HTML for including translated strings and language-specific includes.
 * Supports localized dates via liquid filter
+* Supports localized URLs
 * Works with `jekyll serve --watch`
 * Supports includes translated into multiple languages
 

data/lib/jekyll-language-plugin.rb

@@ -11,6 +11,7 @@ module Jekyll
 
     # plugin requires
     autoload :PluginError,        'jekyll/language-plugin/plugin_error.rb'
+    autoload :LanguageData,       'jekyll/language-plugin/language_data.rb'
     autoload :LiquidContext,      'jekyll/language-plugin/liquid_context.rb'
     autoload :DateLocalizer,      'jekyll/language-plugin/date_localizer.rb'
     autoload :VERSION,            'jekyll/language-plugin/version'

data/lib/jekyll/language-plugin/date_localizer.rb

@@ -2,39 +2,27 @@ module Jekyll
   module LanguagePlugin
     module DateLocalizer
       def self.localize_date(date, format, context)
-        translation = Jekyll::LanguagePlugin::LiquidContext.get_language_data(context, 'date')
+        language_data = Jekyll::LanguagePlugin::LiquidContext.get_language_data(context)
+        translation = language_data.get('date')
 
         # validate language translation
-        raise Jekyll::LanguagePlugin::PluginError.new('Localized date is missing translation.') if translation.nil? ||
-          !['abbr_daynames', 'daynames', 'abbr_monthnames', 'monthnames'].all? {|s| translation.key?(s) && translation[s].is_a?(Array) } ||
-          translation['abbr_daynames'].size < 7 || translation['daynames'].size < 7 ||
-          translation['abbr_monthnames'].size < 12 || translation['monthnames'].size < 12
-
-        #convert to extended Time class
-        date2 = JLPTime.at(date.to_i)
-        date2.strftime_translate(format, translation)
-      end
-
-      class JLPTime < Time
-        def strftime_translate(format = '%F', translation)
-          result = self.strftime(
-            #...you replaced the language dependent parts.
-            format.gsub(/%([aAbB])/){ |m|
-                case $1
-                  when 'a'; translation['abbr_daynames'][self.wday]
-                  when 'A'; translation['daynames'][self.wday]
-                  when 'b'; translation['abbr_monthnames'][self.mon-1]
-                  when 'B'; translation['monthnames'][self.mon-1]
-                  else
-                    raise Jekyll::LanguagePlugin::PluginError.new('Internal error.')
-                end
-              })
-          if defined? @@encoding_converter
-            @@encoding_converter.iconv(result)
-          else
-            result
-          end
+        if !['abbr_daynames', 'daynames', 'abbr_monthnames', 'monthnames'].all? {|s| translation.key?(s) && translation[s].is_a?(Array) } ||
+           translation['abbr_daynames'].size < 7 || translation['daynames'].size < 7 ||
+           translation['abbr_monthnames'].size < 12 || translation['monthnames'].size < 12
+          raise Jekyll::LanguagePlugin::PluginError.new('Localized date is missing translation.')
         end
+
+        date.strftime(
+          format.gsub(/%([aAbB])/){ |m|
+              case $1
+                when 'a'; translation['abbr_daynames'][date.wday]
+                when 'A'; translation['daynames'][date.wday]
+                when 'b'; translation['abbr_monthnames'][date.mon-1]
+                when 'B'; translation['monthnames'][date.mon-1]
+                else
+                  raise Jekyll::LanguagePlugin::PluginError.new('Internal error.')
+              end
+            })
       end
     end
   end

data/lib/jekyll/language-plugin/language_data.rb

@@ -0,0 +1,58 @@
+module Jekyll
+  module LanguagePlugin
+    class LanguageData
+      attr_reader :site, :Language
+
+      def initialize(site, language)
+        @site = site
+        @language = language
+      end
+
+      def get(keys)
+        obj = retrieve_obj(keys)
+        raise Jekyll::LanguagePlugin::PluginError.new("Invalid language data configuration. #{keys.join('.')} not found.") if language_data.nil?
+        obj
+      end
+
+      def has?(keys)
+        !retrieve_obj(keys).nil?
+      end
+
+      def retrieve_obj(keys)
+        return nil if @language.to_s.empty?
+        keys = resolve_dot_notation([language_data, keys])
+
+        obj = site.send(keys.shift)
+        traverse_hash(obj, keys)
+      end
+
+      def language_data()
+        @language_data ||= site.config['language_data'].to_s || 'data.lang.%%'
+        @language_data.gsub("%%", @language)
+      end
+
+      def traverse_hash(hash, keys)
+        return nil if hash.nil?
+
+        for key in keys
+          if !hash.is_a?(Hash)
+            return hash
+          elsif !hash.key?(key)
+            return nil
+          end
+          hash = hash[key]
+        end
+        hash
+      end
+
+      def resolve_dot_notation(keys)
+        return keys.split('.') if keys.is_a?(String)
+        return [] if !keys.is_a?(Enumerable)
+
+        keys.flat_map do |key|
+          resolve_dot_notation(key)
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/language-plugin/liquid_context.rb

@@ -1,62 +1,43 @@
 module Jekyll
   module LanguagePlugin
     module LiquidContext
-      def self.get_language_data(context, keys = nil)
-        site = context.registers[:site]
-        language_data = site.config['language_data'].to_s || 'data.lang.%%'
-
-        page_language = context.registers[:page]['language']
-        return nil if page_language.to_s.empty?
-
-        keys2 = language_data.gsub("%%", page_language).split('.')
-        language_data = site.send(keys2.shift)
-        language_data = self.traverse_hash(language_data, keys2)
-        raise Jekyll::LanguagePlugin::PluginError.new('Invalid language data configuration.') if language_data.nil?
+      def self.get_language_data(context)
+        if !context.registers[:language_data].nil?
+          return context.registers[:language_data]
+        end
 
-        return language_data if keys.to_s.empty? # can also return nil
+        language = context.registers[:page]['language']
+        if language.to_s.empty?
+          raise Jekyll::LanguagePlugin::PluginError.new('No language specified for current page or post.')
+        end
 
-        language_data = self.traverse_hash(language_data, keys)
-        raise Jekyll::LanguagePlugin::PluginError.new("Language subset #{keys.to_s} not found.") if language_data.nil?
-        language_data
+        site = context.registers[:site]
+        context.registers[:language_data] = LanguageData.new(site, language)
       end
 
       def self.get_language_string(context, key)
-        data = self.get_language_data(context)
-        return "" if data.nil?
-
-        language_subset = context.registers[:page]['subset']
-        if (!language_subset.to_s.empty? &&
-            !(str = traverse_hash(traverse_hash(data, language_subset), key)).to_s.empty?) ||
-           !(str = traverse_hash(data, key)).to_s.empty?
-          return str
+        language_data = self.get_language_data(context)
+
+        if language_data.nil?
+          $stdout.puts("language data is nil")
+        end
+        subset = context.registers[:page]['subset']
+        if !subset.to_s.empty? && language_data.has?([subset, key])
+          return language_data.get([subset, key])
         end
 
-        raise Jekyll::LanguagePlugin::PluginError.new("Language string #{key} not found.")
+        language_data.get(key)
       end
 
       def self.get_language_name(context, name)
-        translation = self.get_language_data(context, 'lang')
+        language_data = self.get_language_data(context)
+        translation = language_data.get('lang')
 
         raise Jekyll::LanguagePlugin::PluginError.new('Language name not found in translation.') if translation.nil? ||
           !translation.key?(name)
 
         translation[name]
       end
-
-      def self.traverse_hash(hash, keys)
-        return nil if hash.nil? || keys.to_s.empty?
-        keys = keys.split('.') if keys.is_a?(String)
-
-        for key in keys
-          if !hash.is_a?(Hash)
-            return hash
-          elsif !hash.key?(key)
-            return nil
-          end
-          hash = hash[key]
-        end
-        hash
-      end
     end
   end
 end

data/lib/jekyll/language-plugin/tags/language_include.rb

@@ -7,7 +7,10 @@ module Jekyll
         end
 
         def page_language(context)
-            context.registers[:page].nil? ? "." : context.registers[:page]["language"]
+          if context.registers[:page].nil? || context.registers[:page]['language'].to_s.empty?
+            raise Jekyll::LanguagePlugin::PluginError.new('No language specified for current page or post.')
+          end
+          context.registers[:page].nil? ? "." : context.registers[:page]["language"]
         end
 
         def resolved_includes_dir(context)

data/lib/jekyll/language-plugin/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module LanguagePlugin
-    VERSION = '1.1.7'
+    VERSION = '1.1.8'
   end
 end

data/lib/jekyll/language_document.rb

@@ -13,6 +13,11 @@ module Jekyll
       data['languages']
     end
 
+    def subset
+      return nil if data.nil? || data['subset'].nil?
+      data['subset']
+    end
+
     def url_template
       return "/:language" + url_template_orig if !language.nil?
       url_template_orig
@@ -20,7 +25,8 @@ module Jekyll
 
     def url_placeholders
       url_placeholders_orig.merge!({
-        language: language
+        language: language,
+        subset: subset
       })
     end
   end

data/lib/jekyll/language_page.rb

@@ -13,15 +13,30 @@ module Jekyll
       data['languages']
     end
 
+    def subset
+      return nil if data.nil? || data['subset'].nil?
+      data['subset']
+    end
+
     def template
       return "/:language" + template_orig if !language.nil?
       template_orig
     end
 
     def url_placeholders
-      url_placeholders_orig.merge!({
-        language: language
+      result = url_placeholders_orig.merge!({
+        language: language,
+        subset: subset
       })
+
+      if !language.nil? && !subset.nil?
+        @language_data ||= LanguagePlugin::LanguageData.new(@site, language)
+
+        data = @language_data.get(subset).reject{ |k, v| v.is_a?(Enumerable) }
+        result.merge!(Hash[data.map{ |k, v| ["t.#{k}", v] }])
+      end
+
+      result
     end
   end
 end

data/lib/jekyll/readers/language_page_reader.rb

@@ -5,7 +5,9 @@ module Jekyll
     def read(files)
       read_orig(files).flat_map do |page|
         lpages = []
-        lpage = LanguagePage.new(@site, @site.source, page.dir, page.name)
+        #TODO: this is a bit hacky. It would be better to directly have access to @dir instance variable
+        path = page.url_placeholders[:path]
+        lpage = LanguagePage.new(@site, @site.source, path, page.name)
         if lpage.languages
           for language in lpage.languages do
             if lpage.language == language
@@ -14,7 +16,7 @@ module Jekyll
               lpage.data['language'] = language
               lpages << lpage
             else
-              lpage2 = LanguagePage.new(@site, @site.source, page.dir, page.name)
+              lpage2 = LanguagePage.new(@site, @site.source, path, page.name)
               lpage2.data['language'] = language
               lpages << lpage2
             end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-language-plugin
 version: !ruby/object:Gem::Version
-  version: 1.1.7
+  version: 1.1.8
 platform: ruby
 authors:
 - Vincent Wochnik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-23 00:00:00.000000000 Z
+date: 2015-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -76,6 +76,7 @@ files:
 - lib/jekyll-language-plugin.rb
 - lib/jekyll/language-plugin/date_localizer.rb
 - lib/jekyll/language-plugin/filters/language_date.rb
+- lib/jekyll/language-plugin/language_data.rb
 - lib/jekyll/language-plugin/liquid_context.rb
 - lib/jekyll/language-plugin/plugin_error.rb
 - lib/jekyll/language-plugin/tags/language.rb