jekyll-locale 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7711d55551114d2ff94841695d72b0db57e5101
-  data.tar.gz: afa5ee87a7bb1a70fa8af07eb4d258b0f53a6cc3
+  metadata.gz: a6aa5bfa8934b5488a01509fcc5edc532e218b7a
+  data.tar.gz: 896e029d6388b5c7c71f7864f5dce874916dad10
 SHA512:
-  metadata.gz: cdd9f7566119e15ed95fa2c92aef41bda3e474a45585b0872c1e9584d30fbc40f6dfe61ff5406c8caebdb6034386da2c6b6f806944cb713a8b7eeb72c4056d91
-  data.tar.gz: 719fb8949ff087f5684de77b5c6aaf9f2ed25200a8d8b95c4e6ed2c073a85b428102ed4c9285c1332282cb51bc184f9fcf0b8cc0617c742084f23593e3e18ab6
+  metadata.gz: bd03beca23149b7a9d5518c8213185faa8c6b89361133a24bf4add596211fd2628797096fb99b30a7b235679eaa61d5469c2f8ceef8be7ff459d1a6ddea248fd
+  data.tar.gz: 80ef5c1b31991f96a3a6b8d26130039badeb93390285e80efff436920af1b9da086c7b4da123cc6525c569d4ab811e1492351da3717f3a20156be7872230cb97

data/README.md

@@ -236,3 +236,34 @@ Instead filter out the canonical url from the for-loop, and render the canonical
 {% endfor %}
   <link rel="alternate" hreflang="x-default" href="{{ page.url | absolute_url }}" />
 ```
+
+## Liquid Filters
+
+### `localize_date`
+
+This plugin provides a `localize_date` filter to aid in localizing valid date strings. It takes an optional parameter to specify the format
+of the output string.
+
+The filter technically delegates to the `I18n` module and therefore requires the translation data to follow a certain convention to pass through without errors.
+
+```yaml
+date:
+  day_names        : # Array of Day names in full. e.g. "Sunday", "Monday", ...
+  month_names      : # Array of Month names in full. e.g. "January", "February", ...
+  abbr_day_names   : # Array of abbreviations of above Day names. e.g. "Sun", "Mon", ...
+  abbr_month_names : # Array of abbreviations of above Month names. e.g. "Jan", "Feb", ...
+time:
+  am: "am"                              # Placeholder for Ante-Meridian
+  pm: "pm"                              # Placeholder for Post-Meridian
+  formats:                              # A set of predefined strftime formats
+    default: "%B %d, %Y %l:%M:%S %p %z" # Used by default if no other `format` has been specified.
+    # my_format:                        # A valid strftime format of your choice.
+```
+
+#### Requirements
+
+The plugin also places a few conventions to streamline usage:
+* All datetime data should be encompassed under a `locale_date` key for each locale except the default locale, for which, the datetime data has been set by default. But you're free to *redefine* it when necessary.
+* The array of names are filled in by default using values defined in Ruby's `Date` class.
+* The array of full day names and full month names have `nil` as the first entry. So locales for non-English languages should have `nil` as the first entry. (In YAML, null list item can be written as simply `~`)
+* The optional parameter for the filter, `format` should either be a string that corresponds to the symbol of the `formats` subkey (e.g. `":default"`) or a valid `strftime` format.

data/lib/jekyll/locale/date_time_handler.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Locale::DateTimeHandler
+    DATETIME_DEFAULTS = {
+      :date => {
+        :day_names        => Date::DAYNAMES,
+        :month_names      => Date::MONTHNAMES,
+        :abbr_day_names   => Date::ABBR_DAYNAMES,
+        :abbr_month_names => Date::ABBR_MONTHNAMES,
+      },
+      :time => {
+        :am      => "am",
+        :pm      => "pm",
+        :formats => {
+          :default => "%B %d, %Y %l:%M:%S %p %z",
+        },
+      },
+    }.freeze
+
+    class << self
+      extend Forwardable
+      [:config, :backend].each do |method|
+        private def_delegator I18n, method
+      end
+
+      def bootstrap(handler)
+        @handler = handler
+        config.available_locales = @handler.available_locales
+      end
+
+      def localize(input, format)
+        object = date_cache(input)
+        locale = @handler.current_locale.to_sym
+        data   = @handler.locale_dates[locale.to_s] || {}
+        store_translations(locale, data) unless translations.key?(locale)
+        backend.localize(locale, object, format)
+      end
+
+      def store_translations(locale, data)
+        backend.store_translations(
+          locale,
+          Utils.deep_merge_hashes(
+            DATETIME_DEFAULTS, Utils.recursive_symbolize_hash_keys(data)
+          )
+        )
+      end
+
+      private
+
+      def translations
+        backend.send(:translations)
+      end
+
+      def date_cache(input)
+        @date_cache ||= {}
+        @date_cache[input] ||= Liquid::Utils.to_date(input)
+      end
+    end
+  end
+end

data/lib/jekyll/locale/filters.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Locale
+    module Filters
+      def localize_date(input, format = :default)
+        format = symbol_or_strftime(format)
+        DateTimeHandler.localize(time(input), format)
+      end
+
+      private
+
+      def symbol_or_strftime(format)
+        return format if format.is_a?(Symbol)
+
+        format = format.to_s
+        if format.start_with?(":")
+          format.sub(":", "").to_sym
+        elsif format.start_with?("%")
+          format
+        else
+          :default
+        end
+      end
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::Locale::Filters)

data/lib/jekyll/locale/generator.rb

@@ -8,9 +8,9 @@ module Jekyll
     def generate(site)
       @site   = site
       handler = site.locale_handler
-      return if handler.available_locales.empty?
+      return if handler.user_locales.empty?
 
-      handler.available_locales.each do |locale|
+      handler.user_locales.each do |locale|
         handler.filtered_portfolio.each do |canon_doc|
           handler.append_document(Locale::AutoPage, canon_doc, locale, site.pages)
         end

data/lib/jekyll/locale/handler.rb

@@ -2,6 +2,7 @@
 
 module Jekyll
   class Locale::Handler
+    attr_reader :locale_dates
     attr_writer :current_locale
 
     DEFAULT_CONFIG = {
@@ -25,8 +26,9 @@ module Jekyll
     end
 
     def reset
-      @locale_data = nil
-      @portfolio   = nil
+      @portfolio    = nil
+      @locale_data  = {}
+      @locale_dates = {}
     end
 
     def data
@@ -50,7 +52,7 @@ module Jekyll
     end
 
     def read
-      available_locales.each do |locale|
+      user_locales.each do |locale|
         portfolio.each do |canon_doc|
           # consider only instances of class that include `Jekyll::Locale::Support` mixin
           next unless canon_doc.is_a?(Jekyll::Locale::Support)
@@ -75,14 +77,18 @@ module Jekyll
       base_array << locale_page
     end
 
-    def available_locales
-      @available_locales ||= begin
+    def user_locales
+      @user_locales ||= begin
         locales = Array(config["locales_set"]) - [default_locale]
         locales.compact!
         locales
       end
     end
 
+    def available_locales
+      @available_locales ||= user_locales + [default_locale]
+    end
+
     def current_locale
       @current_locale ||= default_locale
     end
@@ -106,13 +112,20 @@ module Jekyll
       end
     end
 
+    def setup
+      @date_handler = Locale::DateTimeHandler
+      @date_handler.bootstrap(self)
+      @locale_data = setup_data if @locale_data.empty?
+      nil
+    end
+
     def inspect
       "#<#{self.class} @site=#{site}>"
     end
 
     private
 
-    attr_reader :site, :config
+    attr_reader :site, :config, :locale_data
 
     def html_pages
       @html_pages ||= begin
@@ -125,26 +138,28 @@ module Jekyll
       @locales_dir ||= fetch("data_dir")
     end
 
-    def locale_data
-      @locale_data ||= begin
-        ldata  = site.site_data[locales_dir]
-        result = {}
-        return result unless ldata.is_a?(Hash)
-
-        ldata.each do |loc, loc_data|
-          locale = Utils.snakeify(loc)
-          result[locale] = {}
-          next unless loc_data.is_a?(Hash)
+    def setup_data
+      ldata  = site.site_data[locales_dir]
+      result = {}
+      return result unless ldata.is_a?(Hash)
 
-          loc_data.each do |key, value|
-            next if key == "locale_date"
+      ldata.each do |loc, loc_data|
+        locale = Utils.snakeify(loc)
+        result[locale] = {}
+        next unless loc_data.is_a?(Hash)
 
-            result[locale][Utils.snakeify(key)] = value.to_s
+        date_data = @date_handler::DATETIME_DEFAULTS
+        loc_data.each do |key, value|
+          if key == "locale_date"
+            date_data = Utils.recursive_symbolize_hash_keys(value) if value.is_a?(Hash)
+          elsif value.is_a?(String)
+            result[locale][Utils.snakeify(key)] = value
           end
         end
-
-        result
+        @locale_dates[loc] = date_data
       end
+
+      result
     end
 
     def fetch(key)

data/lib/jekyll/locale/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Locale
-    VERSION = "0.3.1"
+    VERSION = "0.4.0"
   end
 end

data/lib/jekyll/patches/utils.rb

@@ -26,6 +26,15 @@ module Jekyll
       slugify(input.to_s, :mode => "latin", :replacement => "_")
     end
 
+    def recursive_symbolize_hash_keys(hash)
+      result = {}
+      hash.each do |key, value|
+        new_key = key.to_s.to_sym
+        result[new_key] = value.is_a?(Hash) ? recursive_symbolize_hash_keys(value) : value
+      end
+      result
+    end
+
     def slugify(string, mode: nil, cased: false, replacement: "-")
       mode ||= "default"
       return nil if string.nil?

data/lib/jekyll-locale.rb

@@ -13,6 +13,9 @@ end
 require_relative "jekyll/patches/site"
 require_relative "jekyll/patches/utils"
 
+require_relative "jekyll/locale/date_time_handler"
+require_relative "jekyll/locale/filters"
+
 require_relative "jekyll/locale/mixins/support"
 require_relative "jekyll/locale/mixins/helper"
 
@@ -25,11 +28,13 @@ end
 Jekyll::Hooks.register :site, :after_reset do |site|
   handler = site.locale_handler
   handler.reset
+  I18n.config.enforce_available_locales = false
   require_relative "jekyll/locale/generator" if handler.mode == "auto"
 end
 
 Jekyll::Hooks.register :site, :post_read do |site|
   handler = site.locale_handler
+  handler.setup
   handler.read unless handler.mode == "auto"
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-locale
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Ashwin Maroli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-05 00:00:00.000000000 Z
+date: 2018-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -35,8 +35,10 @@ files:
 - README.md
 - lib/jekyll-locale.rb
 - lib/jekyll/locale/auto_page.rb
+- lib/jekyll/locale/date_time_handler.rb
 - lib/jekyll/locale/document.rb
 - lib/jekyll/locale/drop.rb
+- lib/jekyll/locale/filters.rb
 - lib/jekyll/locale/generator.rb
 - lib/jekyll/locale/handler.rb
 - lib/jekyll/locale/mixins/helper.rb