nanoc-filesystem-i18n 0.1.0.pre1 → 0.1.0.pre2

data/README.rdoc

@@ -1,15 +1,24 @@
 = nanoc-filesystem-i18n
 
-The filesystem_i18n data source is a localized data source for a nanoc
-site. It stores all data as files on the hard disk and is fully compatible
-with {Nanoc3::DataSources::FilesystemUnified} and {Nanoc3::DataSources::FilesystemVerbose}.
+filesystem_i18n is a localized data source for a nanoc site. It stores
+all data as files on the hard disk and is fully compatible with default
+nanoc data sources {Nanoc3::DataSources::FilesystemUnified} and
+{Nanoc3::DataSources::FilesystemVerbose}.
+
+Nanoc is a Ruby web publishing system for building small to medium-sized
+websites. It is a tool that runs on your local computer and compiles documents
+written in formats such as Markdown, Textile, Haml, Erb, ... into a static
+web site consisting of simple HTML files, ready for uploading to any web
+server. For more information, please see Nanoc site.
 
 == Resources
 
 - FilesystemI18n (http://github.com/yannlugrin/nanoc-filesystem-i18n)
 - Nanoc (http://nanoc.stoneship.org)
 - Nanoc on Github (http://github.com/ddfreyne/nanoc)
-- Ruby I18n (http://github.com/svenfuchs/i18n)
+- Nanoc discussion group (http://groups.google.com/group/nanoc)
+- Nanoc irc channel (irc://chat.freenode.net/#nanoc)
+- Ruby I18n on Github (http://github.com/svenfuchs/i18n)
 
 == Documentation
 
@@ -19,7 +28,7 @@ with {Nanoc3::DataSources::FilesystemUnified} and {Nanoc3::DataSources::Filesyst
 
 Add following require in your `lib/default.rb` file:
 
-  require 'nanoc3/data_sources/filesystem_i18n'
+ require 'nanoc3/data_sources/filesystem_i18n'
 
 Edit `config.yaml` file of your nanoc site and change data_sources type
 from `filesystem_unified` or `filesystem_verbose` to `filesystem_i18n`:
@@ -28,21 +37,21 @@ from `filesystem_unified` or `filesystem_verbose` to `filesystem_i18n`:
     -
       type: filesystem_i18n
 
-In the data source section of `config.yaml` file, add following information:
+In the data source section of `config.yaml` file, add following informations:
 
       config:
         locale:
           # list of availables locale, ser default to true to select default
           # locale.
           availables:
-            fr:
-              name: Francais
             en:
-              name: English
+              name: "English"
               default: true
+            fr:
+              name: "Francais"
           # objects should be not localized
           exclude:
-            item: ['/css*', '/js*']
+            item: ['/css*', '/js*', '/images*']
             layout: ['*']
 
 See following configuration section for more information.
@@ -57,7 +66,7 @@ directory.
 
 Every object (item or layout) is represented by a meta file and one or
 more content files with a minimum of one file. The content file contains
-he actual item content or layout, while the meta file contains the item’s
+the actual item content or layout, while the meta file contains the item’s
 or the layout’s metadata, formatted as YAML.
 
 Both meta files and content files are named after its parent directory
@@ -79,20 +88,79 @@ e.g. a `foo.fr.markdown` for locale `fr`. If default locale for site is
 `fr` and the `foo.fr.markdown` file is present but `foo.markdow` file not,
 the `fr` content file is used by default.
 
-The identifier is calculated by stripping the extension (part after last dot)
-and locale code.
+The identifier is calculated by stripping the extension (part after last
+dot) and locale code.
 
 === Configuration
 
-soon...
+You need to configure available locales in config data source section of
+`config.yaml` file. The I18n configuration is a hash with `locale` key,
+and have a `availables` section containing each locale information. If
+`availables` is set to nil, empty hash or false, the site is not localized
+and data source work normaly. A locale have it code has key and contain a
+`name` key and optional `default` key. Set only one locale has default.
+
+ config:
+   locale:
+     availables:
+       en:
+         name: "English"
+         default: true
+       fr:
+         name: "Francais"
+
+Items and layout can be excluded from localize process by set `exclude`
+list. It is recommanded to exclude all layouts, css, javascript and
+design images.
+
+ config:
+   locale:
+     ...
+     exclude:
+       item: ['/css*', '/js*', '/images*']
+       layout: ['*']
 
 === Manage locale meta and content
 
 soon...
 
-=== Deployement
+=== Locale selection according to navigator accept language
 
-soon...
+If you deploy your site with Apache server, you can use mod_rewrite to select
+default locale according to navigator accept language configuration. Create an
+item named `htaccess.erb` in `content` directory with following content:
+
+ ---
+ locale: false
+ ---
+
+ RewriteEngine On
+ RewriteBase /
+
+ RewriteCond %{HTTP:Accept-Language} ^.*?(<%= I18n.available_locales.map{|l| l.to_s }.join('|') %>).*$ [NC]
+ RewriteRule ^(.*)$ - [env=locale:%1,S=1]
+ RewriteRule ^(.*)$ - [env=locale:<%= I18n.default_locale.to_s %>]
+
+ RewriteCond %{REQUEST_FILENAME} !-d
+ RewriteCond %{REQUEST_FILENAME} !-f
+ RewriteCond %{REQUEST_FILENAME} !-l
+ RewriteRule ^(.*)$ %{ENV:locale}/$1 [R=303,L]
+
+Add in `Rules` file following compile and route information:
+
+ compile '/htaccess*' do
+   filter :erb
+   # don’t layout
+ end
+
+ route '/htaccess*' do
+   '/.htaccess'
+ end
+
+With this method, visitor on root of your site is redirected to is/her prefered
+language or default language.
+
+Another methods comming soon.
 
 == Note on Patches/Pull Requests
 

data/lib/nanoc3/data_sources/filesystem_i18n.rb

@@ -29,11 +29,12 @@ module Nanoc3::DataSources
 
     # See {Nanoc3::DataSource#up}.
     def up
-      I18n.load_config(@config ? @config[:locale] : nil)
+      load_config(@config)
     end
 
     # See {Nanoc3::DataSource#down}.
     def down
+      @config_loaded = false
     end
 
     # See {Nanoc3::DataSource#setup}.
@@ -67,6 +68,28 @@ module Nanoc3::DataSources
 
   private
 
+    # Load data source configuration and configure I18n
+    def load_config(config)
+      unless @config_loaded
+        config = config.symbolize_keys if config
+        @exclude_objects = {}
+
+        if config && config[:locale]
+          I18n.available_locales = config[:locale][:availables] ? config[:locale][:availables].map {|code, data| code.to_sym } : []
+          if I18n.localized_site?
+            I18n.default_locale = I18n.available_locales.find{|code, data| data[:default] }[0] rescue I18n.available_locales.first
+            @exclude_objects = config[:locale][:exclude] if config[:locale][:exclude]
+          end
+        end
+
+        # By default, exclude object Hash return empty array, or if site
+        # is not localized (no available locale), all objects is excluded.
+        @exclude_objects.default = I18n.localized_site? ? [] : ['*']
+      end
+
+      @config_loaded = true
+    end
+
     # Creates a new object (item or layout) on disk in dir_name according to
     # the given identifier. The file will have its attributes taken from the
     # attributes hash argument and its content from the content argument.
@@ -339,7 +362,7 @@ module Nanoc3::DataSources
     #     layout: ['*']
     #
     def locale_exclude_regex(kind)
-      Regexp.union(I18n.exclude_list(kind.to_sym).map do |identifier|
+      Regexp.union(@exclude_objects[kind.to_sym].map do |identifier|
         if identifier.is_a? String
           # Add leading/trailing slashes if necessary
           new_identifier = identifier.dup

data/lib/nanoc3/data_sources/filesystem_i18n/version.rb

@@ -5,7 +5,7 @@ require 'nanoc3'
 module Nanoc3
   module DataSources
     class FilesystemI18n < Nanoc3::DataSource
-      Version = '0.1.0.pre1'
+      Version = '0.1.0.pre2'
     end
   end
 end

data/lib/nanoc3/extra/i18n.rb

@@ -6,43 +6,14 @@ require 'i18n'
 module I18n
   class Config
 
+    # A site is note localized if available locale is empty
     def localized_site?
       !available_locales.empty?
     end
 
-    def exclude_list(kind)
-      @exclude ||= {}
-      @exclude[kind] ||= localized_site? ? [] : ['*']
-    end
-
-    def exclude_list=(exclude)
-      @exclude = exclude
-    end
-
   end
 
   class << self
-    def load_config(dir_or_config_hash)
-      if dir_or_config_hash.is_a? String
-        # Read config from config.yaml in given dir
-        config_path = File.join(dir_or_config_hash, 'config.yaml')
-        config_data = YAML.load_file(config_path).symbolize_keys[:locale] rescue {}
-      else
-        # Use passed config hash
-        config_data = dir_or_config_hash || {}
-      end
-
-      config.available_locales = config_data[:availables] ? config_data[:availables].map {|code, data| code.to_sym } : []
-      if I18n.localized_site?
-        config.default_locale = begin config_data[:availables].find{|code, data| data[:default] }[0] rescue config_data[:availables].first[0] end
-        config.exclude_list = config_data[:exclude]
-      end
-    end
-
-    def exclude_list(kind)
-      config.exclude_list(kind)
-    end
-
     def localized_site?
       config.localized_site?
     end

metadata

@@ -6,8 +6,8 @@ version: !ruby/object:Gem::Version
   - 0
   - 1
   - 0
-  - pre1
-  version: 0.1.0.pre1
+  - pre2
+  version: 0.1.0.pre2
 platform: ruby
 authors: 
 - Yann Lugrin
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-08 00:00:00 +02:00
+date: 2010-04-09 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency