isola 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae141ebf3510995229e7bc854c3c43a566deb7f74b47f5c28c64840c1f25db18
-  data.tar.gz: 458948286fb8f457a77e5a7d9e9ed7805258ea53a9c6cb5ee3e4640a35d9f41e
+  metadata.gz: 507fdf7f262bfde7e67d143cc6d5b09b0c7b7939dfbc1c7aaf6dbcc9f1a5cf38
+  data.tar.gz: f39703fba0476b6cd38f5877111d2e3a9abf06cffe6cdc73341487085ff631fc
 SHA512:
-  metadata.gz: 7909154b135a3667a4289d5e9e91ddcf3e79029801e17b103ddebe906789561ea6a11499de3cb7e090bb83e38339c166786f8b05f1053a536464f3ec6f6843fa
-  data.tar.gz: '083de5dffb0186058bd30f4edf7d41e7b9a3472ea09b5b661654a4456585b74062cbf5ab11069af43c4994cf16e80626b5b5a90834effa2f59854c6091e0b246'
+  metadata.gz: 1f85fd79af5a9bea7886312fede020b672514f111be326758b6c36797bc8c449a37d294a6db5d2c38215be855447e4a9d56135526bcafe767c0de6d45280a3f2
+  data.tar.gz: ee38afab7cd7bf59701503651928773202de085f6e2d84be8e081429c4692ca9da069764ab1c36c9399006591f535c64a0653371d8a77abb6616bcf1267e0a0e

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,30 +2,41 @@ require "tilt"
 
 module Isola
   class Context
-    attr_reader :site, :content, :layout
-    def initialize(page, site)
-      @page_source = page
-      @meta = {lang: site[:lang]}.merge(page.meta).freeze
+    attr_reader :content, :layout
+    def initialize(source, site, languages: {})
+      @source = source
+      @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 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
 
     def render
-      @current = @page_source
-      @content, path = @page_source.render(self, @site)
+      @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/file_handler.rb

@@ -1,19 +1,20 @@
 module Isola
   class FileHandler
-    attr_reader :pages, :layouts, :includes, :root_dir
+    attr_reader :entries, :layouts, :includes, :root_dir
     DEFAULT_EXCLUDES = [
       ".sass-cache", "gemfiles",
       "Gemfile", "Gemfile.lock", "node_modules",
       "vendor/bundle/", "vendor/cache/",
       "vendor/gems/", "vendor/ruby/"
     ]
-    def initialize(root_dir, excludes: [])
+    def initialize(root_dir, output_path_func: nil, excludes: [])
       @excludes = DEFAULT_EXCLUDES.union(excludes)
       @rejects = Regexp.union(%r{(?:^|/)[._]}, %r{~$})
       @root_dir = File.absolute_path(root_dir)
-      @pages = {}
+      @entries = {}
       @layouts = {}
       @includes = {}
+      @output_path_func = output_path_func || method(:remove_exts)
       collect(@root_dir)
     end
 
@@ -36,7 +37,7 @@ module Isola
           elsif path.start_with?("_includes/")
             @includes[remove_exts(path).delete_prefix("_includes/")] = path
           else
-            @pages[remove_exts(path)] = path
+            @entries[@output_path_func.call(path)] = path
           end
         end
       end

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,48 +1,67 @@
 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"]
-    EXT_MAP = {".md" => ".html", ".mkd" => ".html", ".markdown" => ".html", "" => ".html"}
+    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 supported_ext? ext
+    def default_language
+      @config[:default_language]
+    end
+
+    def languages
+      @config[:languages]
+    end
+
+    def ext_to_process_with_tilt? ext
       SUPPORTED_TILT_EXT.include? ext
     end
 
-    def result_ext_for ext
-      EXT_MAP[ext]
+    def process_extensions(path)
+      path = path.dup
+      last_ext = nil
+      while ext_to_process_with_tilt?(ext = File.extname(path))
+        yield(path, ext) if block_given?
+        path.delete_suffix!(ext)
+        last_ext = ext
+      end
+      ext.empty? ? path + result_ext_for(last_ext) : path
+    end
+
+    def output_path_for path
+      process_extensions path
     end
 
     def build
-      dest_dir = File.join(@file_handler.root_dir, @config[:destination])
       FileUtils.rm_rf(dest_dir)
-      @file_handler.pages.each do |name, path|
-        page = Source.new(path, read_in_site(path))
-        puts "building #{path}..."
-        rendered, path = Context.new(page, self).render
-        dest_path = File.join(dest_dir, path)
-        FileUtils.mkdir_p(File.dirname(dest_path))
-        File.write(dest_path, rendered)
+      entries.each do |name, entry|
+        puts "building #{name}..."
+        render_to_dest entry
       end
       puts "done."
     end
@@ -52,35 +71,100 @@ module Isola
       build
     end
 
+    def url_path_for(path)
+      # will support base_url for the future.
+      File.join("/", path)
+    end
+
     def ignore?(path)
       @file_handler.ignore?(path)
     end
 
-    def layout name
-      find_source(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_source(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
+      find_entry(name, @parsed_entries, @file_handler.entries)
+    end
+
+    def entries
+      Enumerator.new do |yielder|
+        @file_handler.entries.each_key do |name|
+          yielder.yield name, entry(name)
+        end
+      end
     end
 
     private
 
+    def dest_dir
+      File.join(@file_handler.root_dir, @config[:destination])
+    end
+
+    def render_to_dest entry
+      if entry.instance_of? Source
+        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)
+      elsif entry.instance_of? StaticFile
+        path = entry.path
+        src_path = File.join(config[:root_dir], path)
+        dest_path = File.join(dest_dir, path)
+        FileUtils.mkdir_p(File.dirname(dest_path))
+        FileUtils.copy(src_path, dest_path)
+      else
+        raise "can't render class #{entry.class}"
+      end
+    end
+
+    def result_ext_for ext
+      return "" if ext.nil?
+      EXT_MAP[ext]
+    end
+
     def collect_files
-      @file_handler = FileHandler.new(config[:root_dir], excludes: @config[:excludes])
+      @file_handler = FileHandler.new(config[:root_dir], output_path_func: method(:output_path_for), excludes: @config[:excludes])
       @parsed_layouts = {}
       @parsed_includes = {}
+      @parsed_entries = {}
     end
 
-    def find_source(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
-          Source.new(p, read_in_site(p))
+          if ext_to_process_with_tilt?(File.extname(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
@@ -17,20 +19,11 @@ module Isola
     end
 
     def render(context, site, params = {})
-      path = @filepath.dup
       rendered = @content.dup
-      last_ext = ""
-      while !(ext = File.extname(path)).empty? && site.supported_ext?(ext)
-        rendered = Tilt.new(path) { rendered }.render(context, params)
-        path.delete_suffix! ext
-        last_ext = ext
-      end
-
-      if ext.empty?
-        [rendered, path + site.result_ext_for(last_ext)]
-      else
-        [rendered, path]
+      output_path = site.process_extensions(@filepath) do |current_path, _ext|
+        rendered = Tilt.new(current_path) { rendered }.render(context, params)
       end
+      [rendered, output_path]
     end
   end
 end

data/lib/isola/static_file.rb

@@ -0,0 +1,8 @@
+module Isola
+  class StaticFile
+    attr_reader :path
+    def initialize(path)
+      @path = path
+    end
+  end
+end

data/lib/isola/version.rb

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

data/lib/isola.rb

@@ -2,8 +2,10 @@
 
 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"
 require_relative "isola/context"
 require_relative "isola/watcher"
 require_relative "isola/dev_server"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: isola
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Satoshi Kojima
@@ -87,6 +87,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rubocop.yml"
 - LICENSE
 - README.md
 - Rakefile
@@ -97,8 +98,10 @@ 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
 - lib/isola/version.rb
 - lib/isola/watcher.rb
 homepage: https://github.com/skoji/isola