jekyll-language-plugin 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18a4c1437ec41d016a655990c7dd40086db5eed3
-  data.tar.gz: 080a094139c5372c70dd659bd6e5bbae6ae5e9ed
+  metadata.gz: 09d08bc0bd9ace9e9ed14474e8f57ce0298e6779
+  data.tar.gz: a6ab1ecd54e36a03a986af23d5ee9b0f16f35af5
 SHA512:
-  metadata.gz: 01a89b8faf0b802df025daa1712b44f788eecad67029394e3cf76be8c91f3ae91df9f0c945d61a4141145eecb60d7739799fc5dce9ced3de50a27d65a47bd4bb
-  data.tar.gz: 6619b1f2f0fe8029b4c742a02ebedd1ebe4004a237746b9b75a562af2e077006a3ba9c7db61a2c62ed64e2cc30f4292e508e51642b8441a7f1c6d2a0706d1864
+  metadata.gz: 91724843ebb69d1ad67e45b3ca8937f50b2cbb2bf5f8c2f1c1caf0803c8d86ddf6d959656b293bfa755f57354b58678ed3010a9baf340270fc8cf0b657e9d26e
+  data.tar.gz: 97201c70f08003ea0426e0009202d1153660a651f5a87535dc0a1c7fc18ed7c88ec157018d6a980bd6e308f2791b7b96aa68b35f53468abe257af57988bfc7ef

data/README.md

@@ -11,6 +11,7 @@ This plugin has been developed with user-simplicity in mind. It does not require
 * Translates pages and posts into multiple languages
 * 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
 * Works with `jekyll serve --watch`
 * Supports includes translated into multiple languages
 
@@ -134,12 +135,34 @@ Currently, there are two liquid tags provided by this plugin.
 
 The `t` liquid tag provides a convenient way of accessing language-specific translations from the language data referred to in the configuration file.
 
-If an alias is given by the page's or post's front-matter, `t` will look into the language-specific alias first. Only if the key cannot be found there, it will perform another lookup without the alias. This can be useful for common translations like a copyright notice.
+If an alias is given by the page's or post's front-matter, `t` will look into the language-specific alias first. Only if the key cannot be found there, it will perform another lookup without the alias. This can be useful for common translations like a copyright notice. The key can also be a dot-notation of multiple keys which are traversed upon lookup.
+
+*Example*: `{% t homepage_welcome %}`
 
 ### Language-Specific Include Tag
 
 The `tinclude` liquid tag works just like the Jekyll-standard `include` tag. But unlike `include`, `tinclude` will not look into the `_includes` directory. Instead it will look into the directory specified by the `language_includes_dir` configuration setting, here `_i18n`. Then it travels one subdirectory down for the language name. If you `{% tinclude lorem.txt %}`, `tinclude` will look for the file in `_i18n/en/lorem.txt` if the language is English.
 
+*Example*: `{% tinclude imprint.html %}`
+
+### Language-Specific Date Filter
+
+The `tdate` liquid filter provides localized date-formatting using the day and month names specified in the language data for each language. Note that if you are using this filter, a `date` key must be present for every supported language.
+
+The `tdate` filter takes one argument, the date format language key. A lookup is performed just like the `t` tag does.
+
+The following excerpt shows the english date translation:
+
+```
+date:
+  abbr_daynames: ['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat']
+  daynames: ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday']
+  abbr_monthnames: ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
+  monthnames: ['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December']
+```
+
+*Example*: `{{ post.date | tdate: 'post_date_format' }}`
+
 # Example Site
 
 This repository contains a ready-to-use example site using this plugin in the `example` subdirectory. Check it out and run `bundle install` followed by `bundle exec jekyll build` to build the site.

data/lib/jekyll-language-plugin.rb

@@ -1,9 +1,14 @@
+# require all files in jekyll-language-plugin subdirectory
+require 'jekyll-language-plugin/liquid_context.rb'
+require 'jekyll-language-plugin/date_localizer.rb'
+
 # require all files in jekyll subdirectory
 require 'jekyll/language_reader.rb'
 require 'jekyll/language_page.rb'
 require 'jekyll/language_document.rb'
 require 'jekyll/readers/language_page_reader.rb'
 require 'jekyll/readers/language_post_reader.rb'
+require 'jekyll/filters/language_date.rb'
 require 'jekyll/tags/language.rb'
 require 'jekyll/tags/language_include.rb'
 

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

@@ -0,0 +1,39 @@
+module JekyllLanguagePlugin
+  module DateLocalizer
+    def self.localize_date(date, format, context)
+      translation = JekyllLanguagePlugin::LiquidContext.get_language_data(context, 'date')
+
+      # validate language translation
+      return nil 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 "Date#strftime: InputError"
+              end
+            })
+        if defined? @@encoding_converter
+          @@encoding_converter.iconv(result)
+        else
+          result
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+module JekyllLanguagePlugin
+  module LiquidContext
+    def self.get_language_data(context, keys = nil)
+      site = context.registers[:site]
+      language_data = site.config['language_data']
+      page_language = context.registers[:page]['language']
+      return nil if language_data.to_s.empty? || 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)
+
+      return language_data if keys.to_s.empty? # can also return nil
+      self.traverse_hash(language_data, keys)
+    end
+
+    def self.get_language_string(context, key)
+      data = self.get_language_data(context)
+      return "" if data.nil?
+
+      page_alias = context.registers[:page]['alias']
+      if (!page_alias.to_s.empty? &&
+          !(str = traverse_hash(traverse_hash(data, page_alias), key)).to_s.empty?) ||
+         !(str = traverse_hash(data, key)).to_s.empty?
+        return str
+      end
+      
+      ""
+    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

data/lib/jekyll/filters/language_date.rb

@@ -0,0 +1,30 @@
+module Jekyll
+  module Filters
+    module LanguageDate
+      def tdate(input, fkey)
+        if ((input.is_a?(String) && !/^\d+$/.match(input).nil?) || input.is_a?(Integer)) && input.to_i > 0
+          date = Time.at(input.to_i)
+        elsif input.is_a?(String)
+          case input.downcase
+          when 'now', 'today'
+            date = Time.now
+          else
+            date = Time.parse(input)
+          end
+        elsif input.is_a?(Time)
+          date = input
+        else
+          date = nil
+        end
+
+        return "" if !date.is_a?(Time)
+        format = JekyllLanguagePlugin::LiquidContext.get_language_string(@context, fkey)
+        return "" if format.nil?
+
+        JekyllLanguagePlugin::DateLocalizer.localize_date(date, format, @context).to_s
+      end
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::Filters::LanguageDate)

data/lib/jekyll/readers/language_post_reader.rb

@@ -8,7 +8,7 @@ module Jekyll
         ldocument.read
 
         languages = ldocument.languages.is_a?(Enumerable) ? ldocument.languages : []
-        if ldocument.language and not languages.include?(ldocument.language)
+        if ldocument.language && !languages.include?(ldocument.language)
           languages.push(ldocument.language)
         end
 

data/lib/jekyll/tags/language.rb

@@ -7,36 +7,10 @@ module Jekyll
         @lkey = @params.shift
       end
 
-      def get_language_data(context, language)
-        language_data = context['site']['language_data'].strip
-        traverse = language_data.gsub("%%", language).split('.')
-
-        data = context['site']
-        traverse.each { |t| data = data[t] }
-        data
-      end
-
-      def get_language_string(context, key)
-        page_language = context['page']['language']
-
-        if not page_language
-          return ""
-        end
-
-        page_alias = context['page']['alias']
-
-        data = get_language_data(context, page_language)
-        if page_alias and data.include?(page_alias) and data[page_alias].include?(key)
-          "#{data[page_alias][key]}"
-        elsif data.include?(key)
-          "#{data[key]}"
-        else
-          ""
-        end
-      end
-
       def render(context)
-        str = get_language_string(context, @lkey)
+        str = JekyllLanguagePlugin::LiquidContext.get_language_string(context, @lkey)
+        return "" if str.nil?
+
         @params.each { |p| str.sub!("%%", p) }
         str
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-language-plugin
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Vincent Wochnik
@@ -74,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/jekyll-language-plugin.rb
+- lib/jekyll/filters/language_date.rb
 - lib/jekyll/language_document.rb
 - lib/jekyll/language_page.rb
 - lib/jekyll/language_reader.rb
@@ -81,6 +82,8 @@ files:
 - lib/jekyll/readers/language_post_reader.rb
 - lib/jekyll/tags/language.rb
 - lib/jekyll/tags/language_include.rb
+- lib/jekyll-language-plugin/date_localizer.rb
+- lib/jekyll-language-plugin/liquid_context.rb
 - README.md
 - LICENSE.md
 homepage: https://github.com/vwochnik/jekyll-language-plugin