isola 0.1.3 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bb22047ab87f7c563e5970881ccb38fc9efd2a2f6330dacdb6d59f7d8b45692
-  data.tar.gz: 361457eac4fe0368b586258f36b02a9a7748e64be5f31f6cc83acb4ed7bf6ee1
+  metadata.gz: c9ea7b839acee149cdc001dae2606001e8393efebafb19bcbea8852a694bc7a0
+  data.tar.gz: 95435cd787ea492043c2b8f0f62b8585e3265f4e7d5f6f315e1705e322700938
 SHA512:
-  metadata.gz: e4bc2dada021f9fddda63594d32fccbe2d9d25040340344632c1efedf9319fd13113049b95e04f29d1c1f81dee39489bbd2ea4221119af2e7f28414cb4d724a0
-  data.tar.gz: b19a681a05704dd1223e6914cdede398229e6f4b6e727169557a19ecea77f49aff0e7ea59f12718a7954e8013ec02410eb5ad8dbea0b59d5bad30d8879aef6ce
+  metadata.gz: e80d3f35ca2f20a8d449fd224e2b3f580c3d32161e3d8ec0259711fe5be6438f28d5f0c89dc663c693e42283b3d1673916c0ad7fe28620f444d7f77f9a30d297
+  data.tar.gz: 289d16edbc4e8c3e9762015e6088a15e34a88af9c4874ddeba90bee78c2457cdabf15708fcc81c1058b468732022941f0f5b99c081557f6032dc1c3ae57ab416

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_gem:
+  standard: config/base.yml

data/USAGE.ja.md

@@ -116,3 +116,67 @@ Isolaが処理するテンプレートエンジンは現在 **ERB**（`.erb`）
 | `*.css`, `*.js` など | なし | そのままコピー |
 
 `_`や`.`で始まるファイル・ディレクトリは自動的に除外されます（`_layouts/`と`_includes/`を除く）。
+
+## 多言語対応
+
+Isolaは多言語サイトの構築をサポートしています。デフォルト言語のページはサイトルートに、その他の言語は言語コード名のサブディレクトリに配置します。
+
+### 設定
+
+`_config.yaml`に`default_language`と`languages`を追加します:
+
+```yaml
+default_language: ja
+languages:
+  ja:
+    label: "日本語"
+  en:
+    label: "English"
+    title: "My Site (EN)"
+```
+
+各言語エントリでサイトレベルの設定値を上書きできます。例えば上記の設定では、英語ページのレンダリング時に`site[:title]`が`"My Site (EN)"`を返します。
+
+### ディレクトリ構成
+
+```
+my-site/
+├── _config.yaml
+├── _layouts/
+│   ├── default.html.erb       # 共有レイアウト（全言語で使用）
+│   └── en/default.html.erb    # 英語専用レイアウト（上書き）
+├── _includes/
+│   ├── head.html.erb          # 共有インクルード
+│   └── en/head.html.erb       # 英語専用インクルード（上書き）
+├── index.md                   # デフォルト言語（ja）のページ
+└── en/index.md                # 英語ページ
+```
+
+- **ページ**: デフォルト言語のページはルートに配置します。他の言語は`<lang>/`サブディレクトリに配置します（例: `en/index.md`）。
+- **レイアウトとインクルード**: 言語固有のオーバーライドは`_layouts/<lang>/`や`_includes/<lang>/`に配置します。言語固有のバージョンが見つからない場合、共有バージョンがフォールバックとして使われます。
+
+### テンプレート変数
+
+標準のテンプレート変数に加え、多言語サイトでは以下が利用できます:
+
+- `page[:lang]` — 現在のページの言語（例: `:ja`, `:en`）
+- `page[:translations]` — 現在のページの全翻訳版を`{lang: url_path}`形式のハッシュで返す（先頭が`/`のURLパスであり、`href`属性などにそのまま利用できます）
+
+#### hreflangリンクの生成
+
+`page[:translations]`を使って代替言語リンクを出力できます:
+
+```erb
+<% page[:translations].each do |lang, url| %>
+  <link rel="alternate" hreflang="<%= lang %>" href="<%= url %>">
+<% end %>
+```
+
+### 出力
+
+出力はソースの構成を反映します:
+
+| ソース | 出力 |
+|---|---|
+| `index.md` | `_site/index.html` |
+| `en/index.md` | `_site/en/index.html` |

data/USAGE.md

@@ -116,3 +116,67 @@ If an extension remains after processing, it is kept as-is. If no extension rema
 | `*.css`, `*.js` etc. | None | Copied as-is |
 
 Files and directories starting with `_` or `.` are excluded automatically (except `_layouts/` and `_includes/`).
+
+## Multi-Language Support
+
+Isola supports building multi-language sites. Pages for the default language live at the site root, while other languages are placed in subdirectories named by language code.
+
+### Configuration
+
+Add `default_language` and `languages` to `_config.yaml`:
+
+```yaml
+default_language: ja
+languages:
+  ja:
+    label: "日本語"
+  en:
+    label: "English"
+    title: "My Site (EN)"
+```
+
+Each language entry can override any site-level configuration value. For example, `site[:title]` returns `"My Site (EN)"` when rendering English pages.
+
+### Directory Structure
+
+```
+my-site/
+├── _config.yaml
+├── _layouts/
+│   ├── default.html.erb       # Shared layout (used by all languages)
+│   └── en/default.html.erb    # English-specific layout override
+├── _includes/
+│   ├── head.html.erb          # Shared include
+│   └── en/head.html.erb       # English-specific include override
+├── index.md                   # Default language (ja) page
+└── en/index.md                # English page
+```
+
+- **Pages**: Default-language pages live at the root. Other languages go in `<lang>/` subdirectories (e.g. `en/index.md`).
+- **Layouts and includes**: Place language-specific overrides under `_layouts/<lang>/` or `_includes/<lang>/`. If a language-specific version is not found, the shared version is used as a fallback.
+
+### Template Variables
+
+In addition to the standard template variables, multi-language sites provide:
+
+- `page[:lang]` — the language of the current page (e.g. `:ja`, `:en`)
+- `page[:translations]` — a hash of `{lang: url_path}` (URL paths starting with `/`, suitable for `href` attributes) for all available translations of the current page
+
+#### Generating hreflang Links
+
+Use `page[:translations]` to output alternate-language links:
+
+```erb
+<% page[:translations].each do |lang, url| %>
+  <link rel="alternate" hreflang="<%= lang %>" href="<%= url %>">
+<% end %>
+```
+
+### Output
+
+The output mirrors the source structure:
+
+| Source | Output |
+|---|---|
+| `index.md` | `_site/index.html` |
+| `en/index.md` | `_site/en/index.html` |

data/lib/isola/context.rb

@@ -2,21 +2,36 @@ require "tilt"
 
 module Isola
   class Context
-    attr_reader :site, :content, :layout
-    def initialize(source, site)
+    attr_reader :content, :layout
+    def initialize(source, site, languages: {})
       @source = source
-      @meta = {lang: site[:lang]}.merge(source.meta).freeze
+      @meta = source.meta.freeze
       @site = site
       @content = ""
       @layout = {}
+
+      site_config = @site.config.merge(languages[@source[:lang]] || {})
+      @site_proxy = SimpleDelegator.new(@site).tap do
+        it.define_singleton_method(:[]) do |key|
+          site_config[key]
+        end
+      end
     end
 
     def page
       @meta
     end
 
+    def site
+      @site_proxy
+    end
+
+    def lang_path path
+      @site_proxy.url_path_for_lang(path, @source[:lang])
+    end
+
     def include name, params = {}
-      i = @site.include name
+      i = @site.include name, lang: @source[:lang]
       raise "include #{name} not found in #{@current.filepath}" unless i
       i.render(self, @site, params)[0]
     end
@@ -25,7 +40,7 @@ module Isola
       @current = @source
       @content, path = @source.render(self, @site)
       while @current.meta[:layout]
-        layout = site.layout(@current.meta[:layout])
+        layout = site.layout(@current.meta[:layout], lang: @source[:lang])
         raise "#{@current.meta[:layout]} not found for #{@current.filepath}" unless layout
         @current = layout
         @content, _ = @current.render(self, @site)

data/lib/isola/language_path_router.rb

@@ -0,0 +1,39 @@
+module Isola
+  class LanguagePathRouter
+    def initialize(default_language:, languages:)
+      @default_language = default_language.to_s
+      @languages = languages.map(&:to_s)
+    end
+
+    def language_for(path)
+      p = Pathname(path).each_filename.to_a
+      if p.length > 1 && @languages.include?(p[0])
+        p[0].to_sym
+      else
+        @default_language.to_sym
+      end
+    end
+
+    def canonical_path(path)
+      p = Pathname(path).each_filename.to_a
+      if p.length > 1 && @languages.include?(p[0])
+        File.join(p[1..])
+      else
+        path
+      end
+    end
+
+    def localized_path(path, language)
+      canonical = canonical_path(path)
+      if language.to_s == @default_language
+        canonical
+      else
+        File.join(language.to_s, canonical)
+      end
+    end
+
+    def candidate_paths(path)
+      @languages.to_h { |lang| [lang.to_sym, localized_path(path, lang)] }
+    end
+  end
+end

data/lib/isola/site.rb

@@ -1,30 +1,47 @@
 require "yaml"
 require "fileutils"
+require "delegate"
+
 module Isola
   class Site
     attr_accessor :config
     DEFAULT_CONFIG = {url: "http://example.com",
                       title: "my awesome site",
                       destination: "_site",
-                      default_language: "en",
+                      default_language: :en,
                       host: "127.0.0.1",
+                      languages: {},
                       port: 4444}.freeze
     SUPPORTED_TILT_EXT = [".erb", ".md", ".markdown", ".mkd", ".html"]
     EXT_MAP = {".md" => ".html", ".mkd" => ".html", ".markdown" => ".html", ".html" => ".html", "" => ".html"}
     def initialize(config)
       @config = DEFAULT_CONFIG.merge(YAML.safe_load(config, symbolize_names: true) || {})
+      @config[:default_language] = @config[:default_language].to_sym
       @config[:root_dir] ||= Dir.pwd
       @config[:excludes] ||= []
+      @lang_router = LanguagePathRouter.new(
+        default_language: default_language,
+        languages: languages.keys
+      )
       collect_files
     end
 
     def [] key
-      if key == :lang
-        key = :default_language
-      end
       @config[key]
     end
 
+    def default_language
+      @config[:default_language]
+    end
+
+    def languages
+      @config[:languages]
+    end
+
+    def language_label(lang)
+      @config[:languages][lang].to_h[:label]
+    end
+
     def ext_to_process_with_tilt? ext
       SUPPORTED_TILT_EXT.include? ext
     end
@@ -58,16 +75,25 @@ module Isola
       build
     end
 
+    def url_path_for(path)
+      # will support base_url for the future.
+      File.join("/", path)
+    end
+
+    def url_path_for_lang(path, lang)
+      url_path_for(@lang_router.localized_path(path, lang))
+    end
+
     def ignore?(path)
       @file_handler.ignore?(path)
     end
 
-    def layout name
-      find_entry(name, @parsed_layouts, @file_handler.layouts)
+    def layout name, lang: nil
+      find_entry(name, @parsed_layouts, @file_handler.layouts, lang: lang)
     end
 
-    def include name
-      find_entry(name, @parsed_includes, @file_handler.includes)
+    def include name, lang: nil
+      find_entry(name, @parsed_includes, @file_handler.includes, lang: lang)
     end
 
     def entry name
@@ -90,7 +116,7 @@ module Isola
 
     def render_to_dest entry
       if entry.instance_of? Source
-        rendered, path = Context.new(entry, self).render
+        rendered, path = Context.new(entry, self, languages: languages).render
         dest_path = File.join(dest_dir, path)
         FileUtils.mkdir_p(File.dirname(dest_path))
         File.write(dest_path, rendered)
@@ -117,19 +143,36 @@ module Isola
       @parsed_entries = {}
     end
 
-    def find_entry(name, cache, store)
-      cache[name] ||=
+    def find_entry(name, cache, store, lang: nil)
+      resolved = resolve_localized(name, store, lang)
+      lang = @lang_router.language_for(resolved)
+      cache[resolved] ||=
         begin
-          p = store[name]
+          p = store[resolved]
           return nil unless p
           if ext_to_process_with_tilt?(File.extname(p))
-            Source.new(p, read_in_site(p))
+            translations = translations_for(resolved, store)
+            Source.new(p, read_in_site(p), lang: lang, translations: translations)
           else
             StaticFile.new(p)
           end
         end
     end
 
+    def resolve_localized(name, store, lang)
+      return name unless lang && @lang_router.language_for(name) != lang
+      localized = @lang_router.localized_path(name, lang)
+      store[localized] ? localized : name
+    end
+
+    def translations_for(path, store)
+      @lang_router.candidate_paths(path).select do |_, candidate|
+        store.key?(candidate)
+      end.transform_values do |candidate|
+        url_path_for(candidate)
+      end
+    end
+
     def read_in_site(p)
       File.read(File.join(config[:root_dir], p))
     end

data/lib/isola/source.rb

@@ -3,13 +3,15 @@ require "yaml"
 module Isola
   class Source
     attr_reader :filepath, :meta, :content
-    def initialize filepath, text
+    def initialize filepath, text, lang:, translations: {}
       @filepath = filepath
       @meta, @content = if (m = text.match(/\A---\s*\n(.+?)^---\s*\n(.*)\z/m))
-        [YAML.safe_load(m[1], symbolize_names: true), m[2]]
+        [YAML.safe_load(m[1], symbolize_names: true) || {}, m[2]]
       else
         [{}, text]
       end
+      @meta[:lang] = lang
+      @meta[:translations] = translations
     end
 
     def [] key

data/lib/isola/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Isola
-  VERSION = "0.1.3"
+  VERSION = "0.2.1"
 end

data/lib/isola.rb

@@ -2,6 +2,7 @@
 
 require_relative "isola/version"
 require_relative "isola/site"
+require_relative "isola/language_path_router"
 require_relative "isola/file_handler"
 require_relative "isola/source"
 require_relative "isola/static_file"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: isola
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.1
 platform: ruby
 authors:
 - Satoshi Kojima
@@ -87,6 +87,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rubocop.yml"
 - LICENSE
 - README.md
 - Rakefile
@@ -97,6 +98,7 @@ files:
 - lib/isola/context.rb
 - lib/isola/dev_server.rb
 - lib/isola/file_handler.rb
+- lib/isola/language_path_router.rb
 - lib/isola/site.rb
 - lib/isola/source.rb
 - lib/isola/static_file.rb
@@ -121,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 4.0.3
 specification_version: 4
 summary: very simple static site generator using ERB
 test_files: []