jekyll-gettext-plugin 0.0.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 436e3fea5b855f2cafb0f0778615ac2c170c2d9c
-  data.tar.gz: 74d014ed8dd18dd4185315a3993f130e117f9dfe
+  metadata.gz: ae5359c53ffe96b66366568f2790628519a13b71
+  data.tar.gz: ae39063b3c123f91947705d5cc2369e27bf0198b
 SHA512:
-  metadata.gz: eb344e5fad00b7cbf7bc48721d294f54bc7a236b10d3edc706511af19f23ff29e8bacd942d91fb8e8a72ec86b32992c718cb3fc75ad48eb8424f8f1450bd17f6
-  data.tar.gz: 54897ef4de7ec1aa26a2c6e280ccb97632851d0b80b7d0e0b4dac7b4b2441103ea80a0cc54aaf8db3dc95240406c0979e967e14f4702647112f06e63829279a6
+  metadata.gz: b283a7c67d9cc119e2a7a47c842edf9374a8ee8769516dfd91024a2d6c1ca8e48cc05253bd2008665f88178642b1890d38ed38046342ab6c404ab4cf0da490e2
+  data.tar.gz: e90416ea03eaf7a88021fefe10dd0be86bd36b615b8cdf996ecb4f10e017fb7f60374ad21747c4baef035af947a9750fbead8fa9255d11286eaa408a02306731

data/README.md

@@ -22,31 +22,95 @@ Or install it yourself as:
 
 ## Usage
 
+###Examples
+
+Have a look at the [examples](examples) folder.
 
 ###Configuration
+
 Add the i18n configuration to your _config.yml:
 
 ```yaml	
-languages: ["ja", "en", "ja"]
+languages: ["en", "ja"]
 ```
 
-The first language in the array will be the default language, Japanese and English will be added in to separate subfolders.
+The first language in the array will be the default language.
+
+Default configuration values:
+
+```yaml
+# the languages to look for
+languages: ["en"]
+
+# the name of the text domain.
+# This is the name of the .pot and .po files.
+text_domain: "website"
+
+# the folder relative to the _config.yml
+# where the translations are placed inside
+translations_folder: "_i18n"
+
+# the files that are ignored by jekyll.
+# This variable is automatically filled to avoid build loops
+exclude: ["_i18n/website.pot"]
+```
 
 ###i18n
+
 Create this folder structure in your Jekyll project as an example:
 
-- _i18n/ja/ja.po
-- _i18n/en/en.po
+- _i18n/ja/website.po
+- _i18n/en/website.po
 
 To add a string to your site use one of these
 
 ```liquid	
+---
+translate: true
+---
+
 {% t key %}
 or 
 {% translate key %}
 ```
 	
-Liquid tags. This will pick the correct string from the `language.po` file during compilation, or add it if no translation exists so you can fill it in later.
+These are liquid tags. They will pick the correct string from the correct `website.po` file during compilation for that language, or add it if no translation exists so you can fill it in later.
+
+All files with a `translate` field inside the yaml header are put in the folders of their languages.
+Without the `translate` field they remain where they are as usual.
+
+You can translate variables in the header like this:
+
+```liquid	
+---
+translate:
+  title: Main Page
+---
+```
+
+All translations automatically turn up in the `_i18n/website.pot` file.
+You can translate them using [Poedit](https://poedit.net/download).
+Whenever you save the po file, a `jekyll serve` rebuilds the site.
+
+Make sure all files are saved in UTF-8 encoding.
+
+All files with a `translate` field inside the yaml header are put in the folders of their languages.
+Without the `translate` field they remain where they are as usual.
+
+You can translate variables in the header like this:
+
+```liquid	
+---
+translate:
+  title: Main Page
+---
+```
+
+All translations automatically turn up in the `_i18n/website.pot` file.
+You can translate them using [Poedit](https://poedit.net/download).
+Whenever you save the po file, a `jekyll serve` rebuilds the site.
+
+Make sure all files are saved in UTF-8 encoding.
 
 ## Contributing
 

data/examples/.gitignore

@@ -0,0 +1 @@
+_plugins

data/examples/default-configuration/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+group :jekyll_plugins do
+  gem 'kramdown'
+  gem 'jekyll-watch'
+  gem 'fast_gettext'
+  gem 'get_pomo'
+  gem 'pry'
+end

data/examples/default-configuration/_config.yml

@@ -0,0 +1,10 @@
+# the languages to look for
+languages: ["en", "de"]
+
+# the name of the text domain.
+# This is the name of the .pot and .po files.
+text_domain: "website"
+
+# the folder relative to the _config.yml
+# where the translations are placed inside
+translations_folder: "_i18n"

data/examples/default-configuration/_i18n/.gitignore

@@ -0,0 +1 @@
+*.mo

data/examples/default-configuration/_i18n/de/website.po

@@ -0,0 +1,25 @@
+msgid ""
+msgstr ""
+"Project-Id-Version: \n"
+"POT-Creation-Date: \n"
+"PO-Revision-Date: \n"
+"Last-Translator: \n"
+"Language-Team: \n"
+"Language: de\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"X-Generator: Poedit 1.8.8\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+msgid "Translation Example"
+msgstr "Übersetzungsbeispiel"
+
+msgid "This file is translated into German only."
+msgstr "Diese Datei wird nur nach Deutsch übersetzt."
+
+msgid "This file is placed in the folder of the language."
+msgstr "Diese Datei wird in dem Ordner ihrer Sprache platziert."
+
+msgid "Language:"
+msgstr "Sprache:"

data/examples/default-configuration/_i18n/website.pot

@@ -0,0 +1,19 @@
+msgid ""
+msgstr ""
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Language: en\n"
+"X-Generator: Jekyll::PotLocalizationPlugin\n"
+
+msgid "Translation Example"
+msgstr ""
+
+msgid "This file is translated into German only."
+msgstr ""
+
+msgid "This file is placed in the folder of the language."
+msgstr ""
+
+msgid "Language:"
+msgstr ""

data/examples/default-configuration/_layouts/default.txt

@@ -0,0 +1,9 @@
+{% assign n = page.title | size %}
+   {{ page.title }}
+   {% for i in (0..n) %}{% cycle "=", "-" %}{% endfor %}   
+
+{{ content }}
+
+
+--------------------------------------------------------------------------------
+{% t Language: %} {{ page.language }}

data/examples/default-configuration/_site/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+group :jekyll_plugins do
+  gem 'kramdown'
+  gem 'jekyll-watch'
+  gem 'fast_gettext'
+  gem 'get_pomo'
+  gem 'pry'
+end

data/examples/default-configuration/_site/de/translated-file.txt

@@ -0,0 +1,9 @@
+
+   Übersetzungsbeispiel
+   =-=-=-=-=-=-=-=-=-=-=-   
+
+Diese Datei wird in dem Ordner ihrer Sprache platziert.
+
+
+--------------------------------------------------------------------------------
+Sprache: de

data/examples/default-configuration/_site/en/translated-file.txt

@@ -0,0 +1,9 @@
+
+   Translation Example
+   =-=-=-=-=-=-=-=-=-=-   
+
+This file is placed in the folder of the language.
+
+
+--------------------------------------------------------------------------------
+Language: en

data/examples/default-configuration/_site/file.txt

@@ -0,0 +1 @@
+This file is just there and not translated.

data/examples/default-configuration/_site/german-file.txt

@@ -0,0 +1,2 @@
+Diese Datei wird nur nach Deutsch übersetzt.
+

data/examples/default-configuration/file.txt

@@ -0,0 +1 @@
+This file is just there and not translated.

data/examples/default-configuration/german-file.txt

@@ -0,0 +1,6 @@
+---
+language: de
+---
+
+{% t This file is translated into German only. %}
+

data/examples/default-configuration/translated-file.txt

@@ -0,0 +1,7 @@
+---
+layout: default
+translate:
+  title: Translation Example
+---
+
+{% t This file is placed in the folder of the language. %}

data/lib/jekyll/gettext/plugin.rb

@@ -2,106 +2,177 @@ require "jekyll/gettext/plugin/version"
 
 require 'fast_gettext'
 require 'get_pomo'
-
 require 'pry'
 
 class TranslationLogger
+
   def initialize
     @translations = []
   end
   
-  def get_translations
-    return @translations
-  end
-  
   def call(unfound)
     @translations.push(unfound)
   end
+  
+  def translations
+      @translations.map do |msgid|
+        translation = GetPomo::Translation.new
+        translation.msgid = msgid
+        translation.msgstr = ""
+        translation
+      end
+  end
 end
 
 module Jekyll
 
+  class Page
+    attr_reader :base
+    
+    def activate
+      raise "Add 'translate: true' to " + relative_path + "."
+    end
+  end
+  
   class Site
+    attr_accessor :pot_localization_plugin
+  end
+
+  class TranslatedPage < Page
     include FastGettext::Translation
     
-    alias :process_org :process
-    attr_accessor   :dest
-    def process
-      if !self.config['baseurl']
-        self.config['baseurl'] = ""
-      end
-      
-      # variables
-      config['baseurl_root'] = self.config['baseurl']
-      baseurl_org = self.config['baseurl']
-      languages = self.config['languages']
-      dest_org = self.dest
-
-      # loop
-      self.config['lang'] = languages.first
-      puts
-      puts "Building site for default language: \"#{self.config['lang']}\" to: " + self.dest
-      self.load_translations
-      process_org
-      self.save_missing_translations
-      
-      languages.drop(1).each do |lang|
-
-        # build site for language lang
-        self.dest = self.dest + "/" + lang
-        self.config['baseurl'] = self.config['baseurl'] + "/" + lang
-        self.config['lang'] = lang
-        puts "Building site for language: \"#{self.config['lang']}\" to: " + self.dest
-        self.load_translations
-        process_org
-        self.save_missing_translations
-
-        # reset variables for next language
-        self.dest = dest_org
-        self.config['baseurl'] = baseurl_org
+    attr_reader :language, :default_language
+  
+    def initialize(page, language, default_language)
+      @language = language
+      @default_language = default_language
+      super(page.site, page.base, page.dir, page.name)
+      fill_data
+    end
+    
+    def activate
+      FastGettext.locale = language
+    end
+    
+    def fill_data
+      activate
+      data["language"]= language
+      data["default_language"]= default_language
+      translate = data["translate"]
+      if translate.is_a? Hash
+        translate.each_pair do |key, value|
+          data[key] = _(value)
+        end
       end
-      puts 'Build complete'
     end
+    
+    def url
+      "/" + language + super
+    end
+  end
 
-    def load_translations
-      @all_translations = TranslationLogger.new
-      @missing_translations = TranslationLogger.new
-
-      repos = [
-        FastGettext::TranslationRepository.build(self.config['lang'], :type=>:logger, :callback=>@all_translations),
-        FastGettext::TranslationRepository.build(self.config['lang'], :type=>:logger, :callback=>@missing_translations),
-        FastGettext::TranslationRepository.build(self.config['lang'], :path => self.source + "/_i18n", :type => :po)
-      ]
-      FastGettext.add_text_domain(self.config['lang'], :type=>:chain, :chain=>repos)
-
-      FastGettext.text_domain = self.config['lang']
-      FastGettext.locale = self.config['lang']
+  class PotLocalizationPlugin < Generator
+    safe true
+    
+    attr_reader :site, :translations
+    
+    def text_domain
+      unless site.config.include? "text_domain"
+        site.config["text_domain"] = "website"
+      end
+      site.config["text_domain"]
+    end
+    
+    def pot_file
+      translations_folder + "/" + text_domain + ".pot"
+    end
+    
+    def languages
+      unless site.config.include? "languages"
+        site.config["languages"] = ["en"]
+      end
+      site.config["languages"]
+    end
+    
+    def po_file(language)
+      translations_folder + "/" + language + "/" + text_domain + ".po"
     end
 
-    def save_missing_translations
-      self.posts.each {|post| _(post.title)}
-      filename = self.source + "/_i18n/" + self.config['lang'] + '/' + self.config['lang'] + '.po'
-      existing_translations = GetPomo.unique_translations(GetPomo::PoFile.parse(File.read(filename)))
-      
-      # ignores any keys that already exist
-      missing_translations_msgids = @missing_translations.get_translations.reject {|msgid| existing_translations.find {|trans| trans.msgid == msgid}}
-      
-      final_translations = existing_translations
+    def generate(site)
+      @site = site
+      site.pot_localization_plugin = self
+      setup_translations
+      add_translated_sites
+    end
+    
+    def setup_translations
+      @translations = TranslationLogger.new
       
-      missing_translations_msgids.each do |new_msgid|
-        new_trans = GetPomo::Translation.new
-        new_trans.msgid = new_msgid
-        new_trans.msgstr = ""
-        final_translations.push(new_trans)
+      renew_translations
+
+      Hooks.register(:site, :pre_render) do |_site, payload|
+        renew_translations
       end
       
-      # uncomment this to remove translations that were not used
-      # not_used = final_translations.reject { |trans| @all_translations.get_translations.find {|msgid| trans.msgid == msgid}}
-      # final_translations = final_translations.reject {|trans1| not_used.find {|trans2| trans1.msgid == trans2.msgid}}
-      
-      final_translations.sort_by!(&:msgid)
-      
-      File.open(filename, 'w'){|f|f.print(GetPomo::PoFile.to_text(final_translations))}
+      Hooks.register(:site, :post_write) do |_site, payload|
+        if _site == site and not translations.nil?
+          save_translations translations.translations
+        end
+      end
+    end
+    
+    def renew_translations
+      languages.each do |language|
+        repos = [
+          FastGettext::TranslationRepository.build(text_domain, :type=>:logger, :callback=>translations),
+          FastGettext::TranslationRepository.build(text_domain, :path => translations_folder, :type => :po)
+        ]
+        FastGettext.add_text_domain(text_domain, :type=>:chain, :chain=>repos)
+      end
+      FastGettext.text_domain = text_domain
+   end
+
+    
+    # use the "translations_folder" tag from the _config.yml or default "_i18n"
+    def translations_folder
+      site.in_source_dir(site.config["translations_folder"] || "_i18n")
+    end
+    
+    def add_translated_sites
+      default_language = languages.first
+      translated_pages = []
+      site.pages.reject! do |page|
+        to_translate = page.data["translate"]
+        if to_translate
+          languages.each do |language|
+            translated_pages << TranslatedPage.new(page, language, default_language)
+          end
+        end
+        to_translate
+      end
+      site.pages.concat(translated_pages)
+    end
+    
+    def save_translations(translations)
+      if translations.empty?
+        return
+      end
+      site.config["exclude"] ||= []
+      unless site.config["exclude"].include? pot_file
+        site.config["exclude"] << pot_file 
+      end
+      File.open(pot_file, 'w') do |file|
+        file.write('msgid ""
+msgstr ""
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Language: ' + languages.first + '\n"
+"X-Generator: ' + self.class.name + '\n"
+
+')
+        file.print(GetPomo::PoFile.to_text(translations))
+      end
     end
   end
 
@@ -114,6 +185,17 @@ module Jekyll
     end
 
     def render(context)
+      site = context.registers[:site]
+      page = context.registers[:page]
+      language = page["language"]
+      if language.nil?
+        default_language = page["default_language"].to_s
+        raise ("Missing language! Either put 'language: " + default_language + 
+               "' or 'translate: true' into the header")
+      end
+      add_localization_to_dependency(site, language, page["path"]) if page.key?("path")
+
+      FastGettext.locale = language
       candidate = _(@key)
 
       if candidate == ""
@@ -121,8 +203,16 @@ module Jekyll
       end
       candidate
     end
+    
+    def add_localization_to_dependency(site, language, path)
+      po_file = site.pot_localization_plugin.po_file(language)
+      site.regenerator.add_dependency(
+        site.in_source_dir(path),
+        po_file
+      )
+    end
   end
 end
 
 Liquid::Template.register_tag('t', Jekyll::LocalizeTag)
-Liquid::Template.register_tag('translate', Jekyll::LocalizeTag)
+Liquid::Template.register_tag('translate', Jekyll::LocalizeTag)

data/lib/jekyll/gettext/plugin/version.rb

@@ -1,7 +1,7 @@
 module Jekyll
   module Gettext
     module Plugin
-      VERSION = "0.0.4"
+      VERSION = "1.0.0"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-gettext-plugin
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Lucas Doyle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-28 00:00:00.000000000 Z
+date: 2016-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fast_gettext
@@ -93,6 +93,21 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/.gitignore
+- examples/default-configuration/Gemfile
+- examples/default-configuration/_config.yml
+- examples/default-configuration/_i18n/.gitignore
+- examples/default-configuration/_i18n/de/website.po
+- examples/default-configuration/_i18n/website.pot
+- examples/default-configuration/_layouts/default.txt
+- examples/default-configuration/_site/Gemfile
+- examples/default-configuration/_site/de/translated-file.txt
+- examples/default-configuration/_site/en/translated-file.txt
+- examples/default-configuration/_site/file.txt
+- examples/default-configuration/_site/german-file.txt
+- examples/default-configuration/file.txt
+- examples/default-configuration/german-file.txt
+- examples/default-configuration/translated-file.txt
 - jekyll-gettext-plugin.gemspec
 - lib/jekyll/gettext/plugin.rb
 - lib/jekyll/gettext/plugin/version.rb