jekyll-localization 0.0.1 → 0.0.2

data/ChangeLog

@@ -1,5 +1,14 @@
 = Revision history for jekyll-localization
 
+== 0.0.2 [2010-07-01]
+
+* Refactoring and documentation.
+	* Jekyll::LANGUAGES now lives in Jekyll::Localization::LANGUAGES
+	* New constant Jekyll::Localization::LANG_EXT_RE
+	* Directory name should *NOT* contain language extension
+	* Turned #t method into a filter (should work for Liquid, too?)
+* Credits.
+
 == 0.0.1 [2010-06-30]
 
 * Birthday :-)

data/README

@@ -2,7 +2,7 @@
 
 == VERSION
 
-This documentation refers to jekyll-localization version 0.0.1
+This documentation refers to jekyll-localization version 0.0.2
 
 
 == DESCRIPTION
@@ -13,15 +13,17 @@ Add the following to your <tt>_plugins/ext.rb</tt> file:
 
   require 'jekyll-localization'
 
-Then start using Engine::Erb#t in your templates, which will extract the target
-language from the file extension. The order of the arguments corresponds to the
-order of the languages defined in Jekyll::LANGUAGES:
+Then start using Jekyll::Filters#t in your templates, which will extract
+the target language from the file name (<tt><NAME>.<LANG>.<EXT></tt>,
+where +LANG+ is supposed to be a two-letter language code). The order
+of the arguments corresponds to the order of the languages defined in
+Localization::LANGUAGES (e.g., +en+, +de+, +fr+):
 
   Some <%= t 'translated', 'übersetzter' %> text.
 
 You can modify Jekyll::LANGUAGES to add languages or change their order.
 The first one is the default language and will be used when a translation
-is missing.
+is missing (+fr+ in this example).
 
 
 == LINKS
@@ -37,6 +39,12 @@ RubyGem::       <http://rubygems.org/gems/jekyll-localization>
 * Jens Wille <mailto:jens.wille@uni-koeln.de>
 
 
+== CREDITS
+
+* Arne Eilermann <mailto:arne.eilermann@uni-koeln.de> for the original idea
+  and implementation.
+
+
 == LICENSE AND COPYRIGHT
 
 Copyright (C) 2010 University of Cologne,

data/lib/jekyll/localization.rb

@@ -32,29 +32,39 @@ require 'jekyll/rendering'
 
 module Jekyll
 
-  LANGUAGES = %w[en de fr]
-
   module Localization
+
+    # The language codes that will be considered for translation
+    LANGUAGES = %w[en de fr]
+
+    # What is considered a language extension
+    LANG_EXT_RE = %r{\.([a-z]{2})}
+
   end
 
   class Page
 
     alias_method :_localization_original_initialize, :initialize
 
+    # Overwrites the original method to extract the language extension.
     def initialize(site, base, dir, name)
       _localization_original_initialize(site, base, dir, name)
 
-      @lang = data['lang'] = @name[/\.([a-z]{2})\.\w+\z/, 1]
+      @lang = data['lang'] = @name[/#{Localization::LANG_EXT_RE}\.\w+\z/, 1]
+      @lang_ext = ".#{@lang}" if @lang
     end
 
     alias_method :_localization_original_url, :url
 
+    # Overwrites the original method to include the language extension.
     def url
-      @lang ? "#{_localization_original_url}.#{@lang}" : _localization_original_url
+      "#{_localization_original_url}#{@lang_ext}"
     end
 
     alias_method :_localization_original_write, :write
 
+    # Overwrites the original method to cater for language extension in output
+    # file name.
     def write(dest_prefix, dest_suffix = nil)
       dest = File.join(dest_prefix, @dir)
       dest = File.join(dest, dest_suffix) if dest_suffix
@@ -62,45 +72,35 @@ module Jekyll
 
       # The url needs to be unescaped in order to preserve the correct filename
       path = File.join(dest, CGI.unescape(url))
-      if ext == '.html' && url !~ /\.html(?:\.[a-z]{2})?\z/
-        FileUtils.mkdir_p(path)
-        path = File.join(path, "index#{@lang ? "#{ext}.#{@lang}" : ext}")
-      end
 
-      File.open(path, 'w') { |f| f.write(output) }
-    end
+      if ext == '.html' && _localization_original_url !~ /\.html\z/
+        path.sub!(/#{Localization::LANG_EXT_RE}\z/, '')
 
-  end
-
-  module Engine
-
-    class Erb
-
-      def t(*translations)
-        index = LANGUAGES.index(page.lang)
-        index && translations[index] || translations.first
+        FileUtils.mkdir_p(path)
+        path = File.join(path, "index#{ext}#{@lang_ext}")
       end
 
+      File.open(path, 'w') { |f| f.write(output) }
     end
 
   end
 
-  class TranslateTag < Liquid::Tag
-
-    # FIXME: dunno if it works...
+  module Filters
 
-    def initialize(tag_name, translations, tokens)
-      super
-      @translations = translations
-    end
+    # call-seq:
+    #   t 'default', 'translation', ... => aString (Ruby-style)
+    #   ['default', 'translation', ...] | t => aString (Liquid-style)
+    #
+    # Returns the argument whose position corresponds to the current
+    # language's position in the Localization::LANGUAGES array. If that
+    # particular argument is missing, +default+ is returned.
+    def t(*translations)
+      translations.flatten!
 
-    def render(context)
-      index = LANGUAGES.index(context.registers[:page].lang)
-      index && @translations[index] || @translations.first
+      index = Localization::LANGUAGES.index(page.lang)
+      index && translations[index] || translations.first
     end
 
-    Liquid::Template.register_tag('t', self)
-
   end
 
 end

data/lib/jekyll/localization/version.rb

@@ -6,7 +6,7 @@ module Jekyll
 
       MAJOR = 0
       MINOR = 0
-      TINY  = 1
+      TINY  = 2
 
       class << self
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: jekyll-localization
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Jens Wille
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-30 00:00:00 +02:00
+date: 2010-07-01 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency