nanoc-filesystem-i18n 0.1.0 → 0.2.0

data/README.rdoc

@@ -1,9 +1,11 @@
 = nanoc-filesystem-i18n
 
+{<img src="https://secure.travis-ci.org/yannlugrin/nanoc-filesystem-i18n.png" />}[http://travis-ci.org/yannlugrin/nanoc-filesystem-i18n]
+
 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 data sources {Nanoc::DataSources::FilesystemUnified} and
+{Nanoc::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
@@ -24,11 +26,15 @@ server. For more information, please see Nanoc site.
 
 === Installation
 
- gem install nanoc-filesystem-i18n --pre
+ gem install nanoc-filesystem-i18n
+
+And add following require in your `lib/default.rb` file:
+
+ require 'nanoc/data_sources/filesystem_i18n'
 
-Add following require in your `lib/default.rb` file:
+Or add following line in your `Gemfile` file:
 
- require 'nanoc3/data_sources/filesystem_i18n'
+ gem 'nanoc-filesystem-i18n', :require => 'nanoc/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`:
@@ -89,7 +95,16 @@ e.g. a `foo.fr.markdown` for locale `fr`. If default locale for site is
 the `fr` content file is used by default.
 
 The identifier is calculated by stripping the extension (part after last
-dot) and locale code.
+dot) and locale code. The locale code also be added at start of identifier
+(`foo.fr.html` => `/fr/foo/`), remember this when you configure `Rules` file.
+
+Top level key in meta file is default for all locales, but you can override a
+metadata for specific locale with following method:
+
+ title: Default Item Title
+ locale:
+   fr:
+     title: Titre en Français
 
 === Configuration
 
@@ -122,7 +137,35 @@ design images.
 
 === Manage locale meta and content
 
-soon...
+All items have an attribute `locale` now, with the item locale code. Get
+current locale code in your templates and helpers with `item[:locale]`.
+
+=== Rules file
+
+In your `Rules` file, you must remember that identifier have locale code at
+the beginning.
+
+ compile '/*/foo/' do
+   filter :erb
+   layout 'default'
+ end
+
+ compile '*' do
+   filter :erb
+   layout 'default'
+ end
+
+ route '/*/foo/' do
+   item.identifier.gsub(/\/$/, '') + '.' + item[:extension]
+ end
+
+ route '*' do
+   if item.children.size > 0 || item.identifier == '/' || item.identifier == "/#{item[:locale]}/"
+     item.identifier + 'index.html'
+   else
+     item.identifier.gsub(/\/$/, '') + '.' + item[:extension]
+   end
+ end
 
 === Locale selection according to navigator accept language
 
@@ -130,21 +173,33 @@ 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
- ---
+---
+locale: false
+---
+
+# For language content negociation, used by css images
+ Options +MultiViews
 
  RewriteEngine On
  RewriteBase /
 
+ # Set prefered language from browser preference if available or to default locale
  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 %>]
+ RewriteRule ^(.*)$ - [env=prefer-language:%1,S=1]
+ RewriteRule ^(.*)$ - [env=prefer-language:<%= I18n.default_locale.to_s %>]
+
+ # Force prefered language if present in URI
+ SetEnvIf REQUEST_URI ^/(<%= I18n.available_locales.map{|l| l.to_s }.join('|') %>)(/.+)? prefer-language=$1
 
+ # Rewrite root access to prefered language root
+ RewriteRule ^(/)?$ %{ENV:prefer-language}/ [R=303,L]
+
+ # Rewrite other uri to language scope
  RewriteCond %{REQUEST_FILENAME} !-d
  RewriteCond %{REQUEST_FILENAME} !-f
  RewriteCond %{REQUEST_FILENAME} !-l
- RewriteRule ^(.*)$ %{ENV:locale}/$1 [R=303,L]
+ RewriteCond %{REQUEST_URI} !^/(<%= I18n.available_locales.map{|l| l.to_s }.join('|') %>)
+ RewriteRule ^(.*)$ %{ENV:prefer-language}/$1 [R=303,L]
 
 Add in `Rules` file following compile and route information:
 
@@ -160,8 +215,6 @@ Add in `Rules` file following compile and route information:
 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
 
 * Fork the project.

data/lib/{nanoc3 → nanoc}/data_sources/filesystem_i18n.rb

@@ -1,43 +1,48 @@
 # encoding: utf-8
 
-require 'nanoc3'
-require 'nanoc3/extra/i18n'
+begin
+  require 'nanoc'
+rescue LoadError # fallback to nanoc3 namespace
+  require 'nanoc3'
+  Nanoc = Nanoc3
+end
+require 'nanoc/extra/i18n'
 
-module Nanoc3::DataSources
+module Nanoc::DataSources
 
   # 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}.
+  # with {Nanoc::DataSources::FilesystemUnified} and {Nanoc::DataSources::FilesystemVerbose}.
   #
   # None of the public api methods are documented in this file. See
-  # {Nanoc3::DataSource} for documentation on the overridden methods instead.
+  # {Nanoc::DataSource} for documentation on the overridden methods instead.
   #
   # For more information about this data source specifications and configuration,
   # please read the Readme file.
-  class FilesystemI18n < Nanoc3::DataSource
+  class FilesystemI18n < Nanoc::DataSource
     identifier :filesystem_i18n
 
     # The VCS that will be called when adding, deleting and moving files. If
     # no VCS has been set, or if the VCS has been set to `nil`, a dummy VCS
     # will be returned.
     #
-    # @return [Nanoc3::Extra::VCS, nil] The VCS that will be used.
+    # @return [Nanoc::Extra::VCS, nil] The VCS that will be used.
     def vcs
-      @vcs ||= Nanoc3::Extra::VCSes::Dummy.new
+      @vcs ||= Nanoc::Extra::VCSes::Dummy.new
     end
     attr_writer :vcs
 
-    # See {Nanoc3::DataSource#up}.
+    # See {Nanoc::DataSource#up}.
     def up
       load_config(@config)
     end
 
-    # See {Nanoc3::DataSource#down}.
+    # See {Nanoc::DataSource#down}.
     def down
       @config_loaded = false
     end
 
-    # See {Nanoc3::DataSource#setup}.
+    # See {Nanoc::DataSource#setup}.
     def setup
       # Create directories
       %w( content layouts lib ).each do |dir|
@@ -46,22 +51,22 @@ module Nanoc3::DataSources
       end
     end
 
-    # See {Nanoc3::DataSource#items}.
+    # See {Nanoc::DataSource#items}.
     def items
-      load_objects('content', 'item', Nanoc3::Item)
+      load_objects('content', 'item', Nanoc::Item)
     end
 
-    # See {Nanoc3::DataSource#layouts}.
+    # See {Nanoc::DataSource#layouts}.
     def layouts
-      load_objects('layouts', 'layout', Nanoc3::Layout)
+      load_objects('layouts', 'layout', Nanoc::Layout)
     end
 
-    # See {Nanoc3::DataSource#create_item}.
+    # See {Nanoc::DataSource#create_item}.
     def create_item(content, attributes, identifier, params={})
       create_object('content', content, attributes, identifier, params)
     end
 
-    # See {Nanoc3::DataSource#create_layout}.
+    # See {Nanoc::DataSource#create_layout}.
     def create_layout(content, attributes, identifier, params={})
       create_object('layouts', content, attributes, identifier, params)
     end
@@ -107,8 +112,8 @@ module Nanoc3::DataSources
       parent_path = File.dirname(meta_filename)
 
       # Notify
-      Nanoc3::NotificationCenter.post(:file_created, meta_filename)
-      Nanoc3::NotificationCenter.post(:file_created, content_filename)
+      Nanoc::NotificationCenter.post(:file_created, meta_filename)
+      Nanoc::NotificationCenter.post(:file_created, content_filename)
 
       # Create files
       FileUtils.mkdir_p(parent_path)
@@ -143,7 +148,7 @@ module Nanoc3::DataSources
         is_binary = !!(content_filename && !@site.config[:text_extensions].include?(File.extname(content_filename)[1..-1]))
 
         # Read content and metadata
-        meta, content_or_filename = parse(content_filename, meta_filename, kind, (is_binary && klass == Nanoc3::Item))
+        meta, content_or_filename = parse(content_filename, meta_filename, kind, (is_binary && klass == Nanoc::Item))
 
         # Is locale content?
         # - excluded content with locale meta IS a locale content
@@ -165,7 +170,7 @@ module Nanoc3::DataSources
             content_filename = filename_for(base_filename, content_ext)
 
             # Read content and metadata for localized content
-            meta, content_or_filename = parse(content_filename, meta_filename, kind, (is_binary && klass == Nanoc3::Item))
+            meta, content_or_filename = parse(content_filename, meta_filename, kind, (is_binary && klass == Nanoc::Item))
 
             # merge meta for current locale, default locale meta used by
             # default is meta don't have key
@@ -184,7 +189,7 @@ module Nanoc3::DataSources
             # WARNING :file is deprecated; please create a File object manually
             # using the :content_filename or :meta_filename attributes.
             # TODO [in nanoc 4.0] remove me
-            :file             => content_filename ? Nanoc3::Extra::FileProxy.new(content_filename) : nil
+            :file             => content_filename ? Nanoc::Extra::FileProxy.new(content_filename) : nil
           }.merge(meta)
 
           # Get identifier

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

@@ -0,0 +1,8 @@
+# encoding: utf-8
+
+module Nanoc
+  module DataSources
+    FilesystemI18nVersion = '0.2.0'
+  end
+end
+

data/lib/{nanoc3 → nanoc}/extra/i18n.rb

@@ -1,6 +1,11 @@
 # encoding: utf-8
 
-require 'nanoc3'
+begin
+  require 'nanoc'
+rescue LoadError # fallback to nanoc3 namespace
+  require 'nanoc3'
+  Nanoc = Nanoc3
+end
 require 'i18n'
 
 module I18n

metadata

@@ -1,141 +1,99 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: nanoc-filesystem-i18n
-version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Yann Lugrin
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-10-18 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-02-22 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: nanoc
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70305163704760 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 1
-        - 2
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 3.1.2
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: i18n
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70305163704760
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &70305163704080 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.1
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: minitest
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70305163704080
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70305163703240 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.2
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: yard
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *70305163703240
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &70305163702220 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.8
   type: :development
-  version_requirements: *id004
-description: I18n filesystem based data source for nanoc. Compatible with nanoc 3 and default filesystem based data source.
-email: yann.lugrin@sans-savoir.net
+  prerelease: false
+  version_requirements: *70305163702220
+description: I18n filesystem based data source for nanoc. Compatible with nanoc 3
+  and default filesystem based data source.
+email:
+- yann.lugrin@sans-savoir.net
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- LICENSE
-- README.rdoc
-files: 
+extra_rdoc_files: []
+files:
+- lib/nanoc/data_sources/filesystem_i18n/version.rb
+- lib/nanoc/data_sources/filesystem_i18n.rb
+- lib/nanoc/extra/i18n.rb
 - LICENSE
 - README.rdoc
-- Rakefile
-- lib/nanoc3/data_sources/filesystem_i18n.rb
-- lib/nanoc3/data_sources/filesystem_i18n/version.rb
-- lib/nanoc3/extra/i18n.rb
-- test/helper.rb
-- test/test_filesystem.rb
-- test/test_filesystem_i18n.rb
-- test/test_filesystem_unified.rb
-- test/test_filesystem_verbose.rb
-has_rdoc: true
-homepage: http://github.com/yannlugrin/nanoc-filesystem-i18n
+homepage: http://rubygems.org/gems/nanoc-filesystem-i18n
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --charset=UTF-8
-require_paths: 
+- --main=README.rdoc
+- --exclude='(lib|test|spec)|(Gem|Guard|Rake)file'
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      hash: 25
-      segments: 
-      - 1
-      - 3
-      - 1
-      version: 1.3.1
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.3.7
+rubyforge_project: nanoc-filesystem-i18n
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: I18n filesystem based data source for nanoc
-test_files: 
-- test/helper.rb
-- test/test_filesystem_unified.rb
-- test/test_filesystem_i18n.rb
-- test/test_filesystem.rb
-- test/test_filesystem_verbose.rb
+test_files: []
+has_rdoc: