jekyll-multiple-languages-plugin 1.6.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0b3312ac834bde327dd7fc94194998efed8074f344607ef5e7dcad99d0ed44d
-  data.tar.gz: 45f17b6bedf4e0913a15f8a7992ebefb14a6fdc5dbfc4644c9b75205544b91ff
+  metadata.gz: 9f3a2a500acf67ad5bea871232433bab2c4fee41366f0d59864e09256121eecf
+  data.tar.gz: 2c9a1a596557ecd8aea38c07e0607d5e104e4c755b1f41c01fd14b9355d75f30
 SHA512:
-  metadata.gz: 4a8a704e89521a3a3306e81c16cdf4b291141d75f5743303e42703a9040a9592029c8e06cb32ab72036127646bdb9d4959580c0e48360c85f4943e870e11aa31
-  data.tar.gz: 50036c5ea37b033f66e825f78e568b6fd011d2ebcb525b4c20e0f6cf092c6a2e4bce701a76cddd11f4aa4d0b89c53aefcb1749078192cb1b4739ec72a6e7039f
+  metadata.gz: f94a3062d46cbcfe28d878073e539ebf675494021e16d0bb96297878720a9c8b449f7d4a12b1d04bfc8a717178eb828bf7a15428842e5772412643099d5dbdfd
+  data.tar.gz: 9e11ecf14870bbf6655d0ed407d83409ce87c57880e5ceac803d0236bc56c222b7d1af9cba901861edf23303b3db8a92dcdcc3ef50e3260dfde766a757f71c39

data/README.md

@@ -19,7 +19,7 @@ Table of Contents
 -----------------
 - [Jekyll Multiple Languages Plugin](#jekyll-multiple-languages-plugin)
     - [Badges](#badges)
-  - [!! We are looking for more maintainers !!](#we-are-looking-for-more-maintainers)
+  - [!! We are looking for more maintainers !!](#-we-are-looking-for-more-maintainers-)
   - [Table of Contents](#table-of-contents)
   - [1. Current Release Notice](#1-current-release-notice)
   - [2. Features](#2-features)
@@ -28,7 +28,7 @@ Table of Contents
     - [3.2. Manually](#32-manually)
     - [3.3. As a Git Submodule](#33-as-a-git-submodule)
   - [4. Configuration](#4-configuration)
-    - [4.1. _config.yml](#41-configyml)
+    - [4.1. _config.yml](#41-_configyml)
     - [4.2. Folder structure](#42-folder-structure)
   - [5. Usage](#5-usage)
     - [5.1. Translating strings](#51-translating-strings)
@@ -141,6 +141,12 @@ In code, these specific files should be referenced via `baseurl_root`. E.g.
 <link rel="stylesheet" href="{{ "/css/bootstrap.css" | prepend: site.baseurl_root }}"/>
 ```
 
+If you wish to avoid having the default_lang built into the root of your website, use:
+
+```yaml
+default_locale_in_subfolder: true
+```
+
 ### 4.2. Folder structure
 Create a folder called `_i18n` and add sub-folders for each language, using the same names used on the `languages` setting on the `_config.yml`:
 
@@ -186,14 +192,36 @@ or
 {% translate global.english %}
 ```
 
-You can also access translated strings by accessing the `site.translations` hash, this allows you to loop through your translations within Liquid:
+You can also access translated strings by accessing the `site.translations` hash, this allows you to loop through your translations within Liquid using the translated string's index:
 
 ```liquid
-{% for item in site.translations[site.lang]["my_nested_yaml_collection"] %}
+{% for item in site.translations[site.lang].my_nested_yaml_collection %}
     <p>{{ item[0] }} -> {{ item[1] }}</p>
 {% endfor %}
 ```
 
+or the translated string's assignment:
+
+```yaml
+my_nested_yaml_collection:
+  -
+    title: First
+    message: Message
+  -
+    title: Second
+    message: Message
+
+```
+
+```liquid
+{% for item in site.translations[site.lang].my_nested_yaml_collection %}
+   <li>
+      <h2>{{ item["title"] }}</h2>
+      <p>{{ item["message"] }}</p>
+   </li>
+{% endfor %}
+```
+
 ### 5.2. Including translated files
 The plugin also supports using different markdown files for different languages using the liquid tag:
 
@@ -369,6 +397,11 @@ Then, create a file named `about.md` under `_i18n/en` with the English content.
 
 
 ## 8. Changelog
+* 1.7.0
+  * Option to build the default language into a subfolder
+  * Configurable verbosity
+  * Improved documentation
+  * Removed deprecation warning
 * 1.6.1
   * Improved testing
   * Support for Jekyll 4

data/lib/jekyll-multiple-languages-plugin.rb

@@ -24,6 +24,46 @@ module Jekyll
       puts "Loading translation from file #{site.source}/_i18n/#{lang}.yml"
       site.parsed_translations[lang] = YAML.load_file("#{site.source}/_i18n/#{lang}.yml")
   end
+
+  #*****************************************************************************
+  # :site, :post_write hook
+  #*****************************************************************************
+  Jekyll::Hooks.register :site, :post_write do |site|
+
+    # Moves excluded paths from the default lang subfolder to the root folder
+    #===========================================================================
+    default_lang = site.config["default_lang"]
+    current_lang = site.config["lang"]
+    exclude_paths = site.config["exclude_from_localizations"]
+
+    if (default_lang == current_lang && site.config["default_locale_in_subfolder"])
+      files = Dir.glob(File.join("_site/" + current_lang + "/", "*"))
+      files.each do |file_path|
+        parts = file_path.split('/')
+        f_path = parts[2..-1].join('/')
+        if (f_path == 'base.html')
+          new_path = parts[0] + "/index.html"
+          puts "Moving '" + file_path + "' to '" + new_path + "'"
+          File.rename file_path, new_path
+        else
+          exclude_paths.each do |exclude_path|
+            if (exclude_path == f_path)
+              new_path = parts[0] + "/" + f_path
+              puts "Moving '" + file_path + "' to '" + new_path + "'"
+              if (Dir.exists?(new_path))
+                FileUtils.rm_r new_path
+              end
+              File.rename file_path, new_path
+            end
+          end
+        end
+      end
+    end
+
+    #===========================================================================
+
+  end
+
   Jekyll::Hooks.register :site, :post_render do |site, payload|
     
     # Removes all static files that should not be copied to translated sites.
@@ -34,10 +74,12 @@ module Jekyll
     static_files  = payload["site"]["static_files"]
     exclude_paths = payload["site"]["exclude_from_localizations"]
     
+    default_locale_in_subfolder = site.config["default_locale_in_subfolder"]
     
     if default_lang != current_lang
       static_files.delete_if do |static_file|
-          
+        next true if (static_file.name == 'base.html' && default_locale_in_subfolder)
+
         # Remove "/" from beginning of static file relative path
         if static_file.instance_variable_get(:@relative_path) != nil
           static_file_r_path = static_file.instance_variable_get(:@relative_path).dup
@@ -81,6 +123,8 @@ module Jekyll
       self.parsed_translations ||= {}
       
       self.config['exclude_from_localizations'] ||= []
+
+      self.config['default_locale_in_subfolder'] ||= false
       
       if ( !self.config['languages']         or
             self.config['languages'].empty?  or
@@ -108,26 +152,20 @@ module Jekyll
       self.config['baseurl_root'] = baseurl_org              # Baseurl of website root (without the appended language code)
       self.config['translations'] = self.parsed_translations # Hash that stores parsed translations read from YAML files. Exposes this hash to Liquid.
       
-      
-      # Build the website for default language
-      #-------------------------------------------------------------------------
-      puts "Building site for default language: \"#{self.config['lang']}\" to: #{self.dest}"
-      
-      process_org
-      
-      
-      # Build the website for the other languages
+      # Build the website for all languages
       #-------------------------------------------------------------------------
       
       # Remove .htaccess file from included files, so it wont show up on translations folders.
       self.include -= [".htaccess"]
       
-      languages.drop(1).each do |lang|
+      languages.each do |lang|
         
         # Language specific config/variables
-        @dest                  = dest_org    + "/" + lang
-        self.config['baseurl'] = baseurl_org + "/" + lang
-        self.config['lang']    =                     lang
+        if lang != self.config['default_lang'] || self.config['default_locale_in_subfolder']
+          @dest                  = dest_org    + "/" + lang
+          self.config['baseurl'] = baseurl_org + "/" + lang
+          self.config['lang']    =                     lang
+        end
         
         puts "Building site for language: \"#{self.config['lang']}\" to: #{self.dest}"
         
@@ -324,8 +362,10 @@ module Jekyll
       if translation.nil? or translation.empty?
          translation = site.parsed_translations[site.config['default_lang']].access(key)
         
-        puts "Missing i18n key: #{lang}:#{key}"
-        puts "Using translation '%s' from default language: %s" %[translation, site.config['default_lang']]
+        if site.config["verbose"]
+          puts "Missing i18n key: #{lang}:#{key}"
+          puts "Using translation '%s' from default language: %s" %[translation, site.config['default_lang']]
+        end
       end
       
       translation
@@ -400,6 +440,25 @@ module Jekyll
         end
       end
     end
+
+    # Override of core Jekyll functionality, to get rid of deprecation
+    # warning. See https://github.com/jekyll/jekyll/pull/7117 for more
+    # details.
+    class PostComparer
+      def initialize(name)
+        @name = name
+
+        all, @path, @date, @slug = *name.sub(%r!^/!, "").match(MATCHER)
+        unless all
+          raise Jekyll::Errors::InvalidPostNameError,
+                "'#{name}' does not contain valid date and/or title."
+        end
+
+        escaped_slug = Regexp.escape(slug)
+        @name_regex = %r!_posts/#{path}#{date}-#{escaped_slug}\.[^.]+|
+          ^#{path}_posts/?#{date}-#{escaped_slug}\.[^.]+!x
+      end
+    end
   end
 
 
@@ -444,7 +503,7 @@ module Jekyll
       pages        =           site.pages
       url          = "";
       
-      if default_lang != lang
+      if default_lang != lang || site.config['default_locale_in_subfolder']
         baseurl = baseurl + "/" + lang
       end
       

data/lib/plugin/version.rb

@@ -1,6 +1,6 @@
 module Jekyll
   module MultipleLanguagesPlugin
-    VERSION = "1.6.1"
+    VERSION = "1.7.0"
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-multiple-languages-plugin
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.7.0
 platform: ruby
 authors:
 - Martin Kurtsson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-14 00:00:00.000000000 Z
+date: 2020-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -43,16 +43,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement