jekyll-localization 0.0.9 → 0.1.0

data/ChangeLog

@@ -1,5 +1,10 @@
 = Revision history for jekyll-localization
 
+== 0.1.0 [2011-03-09]
+
+* Added Jekyll::Localization::HUMAN_LANGUAGES and corresponding helper.
+* Added helpers to deal with other languages than the current one.
+
 == 0.0.9 [2010-12-21]
 
 * Set YAML data too when alternative language content will be used.

data/README

@@ -2,7 +2,7 @@
 
 == VERSION
 
-This documentation refers to jekyll-localization version 0.0.9
+This documentation refers to jekyll-localization version 0.1.0
 
 
 == DESCRIPTION
@@ -24,7 +24,9 @@ Jekyll::Localization::LANGUAGES (e.g., +en+, +de+, +fr+):
 
 You can modify Jekyll::Localization::LANGUAGES to add languages or change
 their order. The first one is the default language and will be used when a
-translation is missing (+fr+ in this example).
+translation is missing (+fr+ in this example). Note that, when you do add
+languages and in particular when you change their order, you should adjust
+Jekyll::Localization::HUMAN_LANGUAGES accordingly!
 
 
 == LINKS
@@ -43,7 +45,7 @@ RubyGem::       <http://rubygems.org/gems/jekyll-localization>
 
 == LICENSE AND COPYRIGHT
 
-Copyright (C) 2010 University of Cologne,
+Copyright (C) 2010-2011 University of Cologne,
 Albertus-Magnus-Platz, 50923 Cologne, Germany
 
 jekyll-localization is free software: you can redistribute it and/or modify it under

data/Rakefile

@@ -1,4 +1,4 @@
-require %q{lib/jekyll/localization/version}
+require File.expand_path(%q{../lib/jekyll/localization/version}, __FILE__)
 
 begin
   require 'hen'
@@ -10,9 +10,7 @@ begin
       :summary      => %q{Jekyll plugin that adds localization features to the rendering engine.},
       :authors      => ['Jens Wille', 'Arne Eilermann'],
       :email        => ['jens.wille@uni-koeln.de', 'eilermann@lavabit.com'],
-      :homepage     => 'http://github.com/blackwinter/jekyll-localization',
-      :files        => FileList['lib/**/*.rb'].to_a,
-      :extra_files  => FileList['[A-Z]*'].to_a,
+      :homepage     => :blackwinter,
       :dependencies => %w[jekyll-rendering]
     }
   }}
@@ -20,8 +18,6 @@ rescue LoadError => err
   warn "Please install the `hen' gem. (#{err})"
 end
 
-### Place your custom Rake tasks here.
-
 begin
   require 'jekyll/testtasks/rake'
 rescue LoadError => err

data/lib/jekyll/localization/version.rb

@@ -5,8 +5,8 @@ module Jekyll
     module Version
 
       MAJOR = 0
-      MINOR = 0
-      TINY  = 9
+      MINOR = 1
+      TINY  = 0
 
       class << self
 

data/lib/jekyll/localization.rb

@@ -4,9 +4,9 @@
 # jekyll-localization -- Jekyll plugin that adds localization features to the #
 #                        rendering engine                                     #
 #                                                                             #
-# Copyright (C) 2010 University of Cologne,                                   #
-#                    Albertus-Magnus-Platz,                                   #
-#                    50923 Cologne, Germany                                   #
+# Copyright (C) 2010-2011 University of Cologne,                              #
+#                         Albertus-Magnus-Platz,                              #
+#                         50923 Cologne, Germany                              #
 #                                                                             #
 # Authors:                                                                    #
 #     Jens Wille <jens.wille@uni-koeln.de>                                    #
@@ -37,9 +37,19 @@ module Jekyll
     # The language codes that will be considered for translation
     LANGUAGES = %w[en de fr]
 
+    # The language codes mapped to their human names
+    HUMAN_LANGUAGES = {
+      'en' => %w[English Englisch    Anglais],
+      'de' => %w[German  Deutsch     Allemand],
+      'fr' => %w[French  Französisch Français]
+    }
+
     # What is considered a language extension
     LANG_EXT_RE = %r{\.([a-z]{2})}
 
+    # The language extension, anchored at the end of the string
+    LANG_END_RE = %r{#{Localization::LANG_EXT_RE}\z}
+
     # Extract relevant parts from a file name
     LANG_PARTS_RE = %r{\A(.*?)#{LANG_EXT_RE}\.(\w+)\z}
 
@@ -126,30 +136,24 @@ module Jekyll
     alias_method :_localization_original_url, :url
 
     # Overwrites the original method to include the language extension.
-    def url
-      "#{_localization_original_url}#{@lang_ext}"
+    def url(lang = nil)
+      "#{_localization_original_url}#{lang ? '.' + lang : @lang_ext}"
     end
 
-    alias_method :_localization_original_write, :write
+    alias_method :_localization_original_destination, :destination
 
     # 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
-      FileUtils.mkdir_p(dest)
-
+    def destination(dest)
       # The url needs to be unescaped in order to preserve the correct filename
-      path = File.join(dest, CGI.unescape(url))
+      path = File.join(dest, @dir, CGI.unescape(url))
 
       if ext == '.html' && _localization_original_url !~ /\.html\z/
-        path.sub!(/#{Localization::LANG_EXT_RE}\z/, '')
-
-        FileUtils.mkdir_p(path)
-        path = File.join(path, "index#{ext}#{@lang_ext}")
+        path.sub!(Localization::LANG_END_RE, '')
+        File.join(path, "index#{ext}#{@lang_ext}")
+      else
+        path
       end
-
-      File.open(path, 'w') { |f| f.write(output) }
     end
 
     alias_method :_localization_original_process, :process
@@ -159,7 +163,7 @@ module Jekyll
     def process(name)
       self.ext      = File.extname(name)
       self.basename = name[0 .. -self.ext.length-1].
-        sub(/#{Localization::LANG_EXT_RE}\z/, '')
+        sub(Localization::LANG_END_RE, '')
     end
 
   end
@@ -171,7 +175,6 @@ module Jekyll
       site.posts.delete_if { |post| post.lang != lang } if lang
 
       yield
-
     ensure
       site.posts.replace(original_posts) if original_posts && page.lang
     end
@@ -203,6 +206,18 @@ module Jekyll
       end
     end
 
+    def other_langs
+      Localization::LANGUAGES - [lang]
+    end
+
+    def human_lang(lang)
+      t(*Localization::HUMAN_LANGUAGES[lang]) || lang.capitalize
+    end
+
+    def url_lang(url, lang)
+      url.sub(Localization::LANG_END_RE, '.' + lang)
+    end
+
     def local_posts
       localize_posts(@site, @page) { site.posts.dup }
     end
@@ -214,13 +229,15 @@ module Jekyll
     # 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)
+    def translate(*translations)
       translations.flatten!
 
       index = Localization::LANGUAGES.index(lang)
       index && translations[index] || translations.first
     end
 
+    alias_method :t, :translate
+
   end
 
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: jekyll-localization
 version: !ruby/object:Gem::Version 
-  hash: 13
-  prerelease: false
+  hash: 27
+  prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 9
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors: 
 - Jens Wille
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-21 00:00:00 +01:00
+date: 2011-03-09 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,31 +42,30 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
+- README
 - COPYING
 - ChangeLog
-- README
 files: 
-- lib/jekyll/localization/version.rb
 - lib/jekyll/localization.rb
+- lib/jekyll/localization/version.rb
+- README
+- ChangeLog
 - Rakefile
 - COPYING
-- ChangeLog
-- README
 has_rdoc: true
 homepage: http://github.com/blackwinter/jekyll-localization
 licenses: []
 
 post_install_message: 
 rdoc_options: 
+- --charset
+- UTF-8
 - --title
-- jekyll-localization Application documentation
+- jekyll-localization Application documentation (v0.1.0)
 - --main
 - README
-- --line-numbers
-- --inline-source
 - --all
-- --charset
-- UTF-8
+- --line-numbers
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -90,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Jekyll plugin that adds localization features to the rendering engine.