slim 2.0.3 → 2.1.0

data/Rakefile

@@ -1,5 +1,5 @@
 begin
-  require 'bundler'
+  require 'bundler/setup'
   Bundler::GemHelper.install_tasks
 rescue Exception
 end
@@ -14,7 +14,7 @@ end
 task 'test' => %w(test:core_and_plugins)
 
 namespace 'test' do
-  task 'core_and_plugins' => %w(core literate logic_less translator)
+  task 'core_and_plugins' => %w(core literate logic_less translator smart include)
 
   Rake::TestTask.new('core') do |t|
     t.libs << 'lib' << 'test/core'
@@ -41,6 +41,18 @@ namespace 'test' do
     t.verbose = true
   end
 
+  Rake::TestTask.new('smart') do |t|
+    t.libs << 'lib' << 'test/core'
+    t.test_files = FileList['test/smart/test_*.rb']
+    t.verbose = true
+  end
+
+  Rake::TestTask.new('include') do |t|
+    t.libs << 'lib' << 'test/core'
+    t.test_files = FileList['test/include/test_*.rb']
+    t.verbose = true
+  end
+
   Rake::TestTask.new('rails') do |t|
     t.libs << 'lib'
     t.test_files = FileList['test/rails/test/test_*.rb']

data/benchmarks/view.haml

@@ -1,6 +1,6 @@
 !!! html
 
-%body
+%html
   %head
     %title Simple Benchmark
   %body
@@ -15,4 +15,4 @@
             %li
               %a{:href => i[:url]}= i[:name]
     - else
-      %p The list is empty.
+      %p The list is empty.

data/doc/include.md

@@ -0,0 +1,20 @@
+# Include
+
+The include plugin allows Slim templates to include other files. The .slim extension is appended automatically to the
+filename. If the included file is not a Slim file, it is interpreted as a text file with `#{interpolation}`.
+
+Example:
+
+    include partial.slim
+    include partial
+    include partial.txt
+
+Enable the include plugin with
+
+    require 'slim/include'
+
+# Options
+
+| Type | Name | Default | Purpose |
+| ---- | ---- | ------- | ------- |
+| Boolean | :include_dirs | [Dir.pwd, '.'] | Directories where to look for the files |

data/doc/jp/include.md

@@ -0,0 +1,20 @@
+# インクルード
+
+インクルードプラグインを使うことで, Slim テンプレートに他の Slim ファイルを読み込むことができます。.slim 拡張子はファイル名に自動的に付加されます。
+読み込まれたファイルが Slim でない場合は `#{文字列展開}` を含んだテキストファイルとして扱われます。
+
+例:
+
+    include partial.slim
+    include partial
+    include partial.txt
+
+インクルードプラグンを有効化
+
+    require 'slim/include'
+
+# オプション
+
+| タイプ | 名前 | デフォルト値 | 目的 |
+| ------ | ---- | ------------ | ---- |
+| Boolean | :include_dirs | [Dir.pwd, '.'] | ファイルを検索するディレクトリ |

data/doc/jp/logic_less.md

@@ -0,0 +1,137 @@
+# ロジックレスモード
+
+ロジックレスモードは [Mustache](https://github.com/defunkt/mustache) にインスパイアされています。ロジックレスモードは
+例えば動的コンテンツを含む再帰的ハッシュツリーのような辞書オブジェクトを使います。
+
+## 条件付き
+
+オブジェクトが false または empty? ではない場合, コンテンツが表示されます。
+
+    - article
+      h1 = title
+
+## 反転条件付き
+
+オブジェクトが false または empty? の場合, コンテンツが表示されます。
+
+    -! article
+      p Sorry, article not found
+
+## 繰り返し
+
+オブジェクトが配列の場合, この部分は繰り返されます。
+
+    - articles
+      tr: td = title
+
+## ラムダ式
+
+Mustache のように, Slim はラムダ式をサポートします。
+
+    = person
+      = name
+
+ラムダ式は次のように定義できます:
+
+    def lambda_method
+      "<div class='person'>#{yield(:name => 'Andrew')}</div>"
+    end
+
+任意に 1 つ以上のハッシュを `yield` に渡すことができます。複数のハッシュを渡した場合, 先述したようにブロックが繰り返されます。
+
+## 辞書アクセス
+
+サンプルコード:
+
+    - article
+      h1 = title
+
+辞書オブジェクトは `:dictionary_access` オプションによって設定された順序でアクセスされます。デフォルトの順序:
+
+1. `シンボル` - `article.respond_to?(:has_key?)` 且つ `article.has_key?(:title)` の場合, Slim は `article[:title]` を実行します。
+2. `文字列` - `article.respond_to?(:has_key?)` 且つ `article.has_key?('title')` の場合, Slim は `article['title']` を実行します。
+3. `メソッド` - `article.respond_to?(:title)` の場合, Slim は `article.send(:title)` を実行します。
+4. `インスタンス変数` - `article.instance_variable_defined?(@title)` の場合, Slim は `article.instance_variable_get @title` を実行します。
+
+すべて失敗した場合, Slim は親オブジェクトに対して同じ順序で title の参照を解決しようとします。この例では, 親オブジェクトはレンダリングしているテンプレートに対する辞書オブジェクトになります。
+
+ご想像のとおり, article への参照は辞書オブジェクトに対して同じ手順で行われます。インスタンス変数はビューのコードでは利用を許されていませんが, Slim はそれを見つけて使います。基本的には, テンプレートの中で @ プレフィックスを落として使っています。パラメータ付きメソッドの呼び出しは許可されません。
+
+
+## 文字列
+
+`self` キーワードは検討中の要素を `.to_s` した値を返します。
+
+辞書オブジェクトを与え,
+
+    {
+      :article => [
+        'Article 1',
+        'Article 2'
+      ]
+    }
+
+ビューで次のように
+
+    - article
+      tr: td = self
+
+これは次のようになります。
+
+    <tr>
+      <td>Article 1</td>
+    </>
+    <tr>
+      <td>Article 2</td>
+    </tr>
+
+
+## Rails でロジックレスモード
+
+インストール:
+
+    $ gem install slim
+
+require で指定:
+
+    gem 'slim', :require => 'slim/logic_less'
+
+特定のアクションでのみロジックレスモードを有効化したい場合, まず設定でロジックレスモードを global に無効化します。
+
+    Slim::Engine.set_default_options :logic_less => false
+
+さらに, アクションの中でレンダリングする度にロジックレスモードを有効化します。
+
+    class Controller
+      def action
+        Slim::Engine.with_options(:logic_less => true) do
+          render
+        end
+      end
+    end
+
+## Sinatra でロジックレスモード
+
+Sinatra には Slim のビルトインサポートがあります。しなければならないのはロジックレス Slim プラグインを require することです。config.ru で require できます:
+
+    require 'slim/logic_less'
+
+これで準備は整いました!
+
+特定のアクションでのみロジックレスモードを有効化したい場合, まず設定でロジックレスモードを global に無効化します。
+
+    Slim::Engine.set_default_options :logic_less => false
+
+さらに, アクションの中でレンダリングする度にロジックレスモードを有効化します。
+
+    get '/page'
+      slim :page, :logic_less => true
+    end
+
+## オプション
+
+| 種類 | 名前 | デフォルト | 用途 |
+| ---- | ---- | ------- | ------- |
+| 真偽値 | :logic_less | true | ロジックレスモードを有効化 ('slim/logic_less' の required が必要) |
+| 文字列 | :dictionary | "self" | 変数が検索される辞書への参照 |
+| シンボル/配列&lt;シンボル&gt; | :dictionary_access | [:symbol, :string, :method, :instance_variable] | 辞書のアクセス順序 (:symbol, :string, :method, :instance_variable) |

data/doc/jp/smart.md

@@ -0,0 +1,102 @@
+# スマートテキスト
+
+テキストとマークアップを組み合わせる最も簡単な方法は <a name="smarttext">スマートテキストモード</a> を使うことです。
+
+スマートテキストプラグインを有効化します。
+
+    require 'slim/smart'
+
+自動的に `:implicit_text` オプションが有効になることで,
+次のように簡単にテキストを入力できるようになります:
+
+    p
+      This is text.
+
+小文字のタグ名や暗黙的なテキスト行などの特殊文字で始まっていない行を
+Slim に自動的に処理させることができます。
+テキストが複数行にわたる場合, 単にそれらをインデントします。
+
+    p
+      This is text,
+        and it spans
+        several lines.
+
+`>` を使って明示的にテキストをマークすることもできます。
+例えば, 小文字や特殊文字で始まっている場合,
+テキストが複数行にわたる場合,
+単に見た目の一貫性のために,
+タグ名に大文字を使いたい場合,
+`:implicit_text` オプションを無効にしたままにする必要がある場合です。
+
+    p
+      > 'This is text, too.'
+    p
+      >
+        This is text
+        which spans
+        several lines.
+
+`:smart_text_escaping` が有効化されている限り,
+エスケープされるべきテキストは自動的にエスケープされます。
+しかし, 不便にならないように検出された HTML エンティティはそのまま使われます。
+この方法はいつでも HTML のエスケープを気にすることのない,
+最も理想的な方法です。
+
+    h1 Questions & Answers
+    footer
+      Copyright &copy; #{Time.now.year}
+
+スマートテキストの素晴らしいところの 1 つはマークアップとよくミックスしているところです。
+スマートテキストの行は通常改行を維持するので,
+強調やリンクのような他のタグを簡単に混ぜ合わせて使うことができます:
+
+    p
+      Your credit card
+      strong will not
+      > be charged now.
+    p
+      Check
+      a href=r(:faq) our FAQ
+      > for more info.
+
+(タグから小文字のテキストを区別する場合明示的なテキストを示すインジケーター `>` の使用には注意してください)。
+
+インラインタグのまわりにスペースを入れたくない場合があります。
+幸いなことにスマートテキストはこの一般的なケースを処理できます。
+スマートテキストのブロックが `:smart_text_begin_chars` で指定 (デフォルトは `,.;:!?)]}`)
+された文字で始まる場合には先頭の改行が行われません。
+同様に, スマートテキストのブロックが `:smart_text_begin_chars` で指定 (デフォルトは `,.;:!?)]}`)
+された文字で終わる場合には改行されません。
+これによって通常のテキストとリンクや span タグを混在させることがとても容易になります:
+
+    p
+      Please proceed to
+      a href="/" our homepage
+      .
+    p
+      Status: failed (
+      a href="#1" details
+      ).
+
+スマートテキストはタグのショートカットをも把握しているので,
+次のような場合にも正しく対応します:
+
+    .class
+      #id
+        #{'More'}
+        i text
+        ...
+
+当然のことながら, これは短いテキストのスニペットでより便利に作業できることを意味しています。
+ほとんどがテキストのコンテンツの場合, Markdown や Textile のような
+ビルトインの埋め込みエンジンを使う方が良いでしょう。
+
+## オプション
+
+| 種類 | 名前 | デフォルト | 用途 |
+| ---- | ---- | ---------- | ---- |
+| 真偽値 | :implicit_text | true | 暗黙的テキストの判別を有効化 |
+| 真偽値 | :smart_text | true | スマートテキストによる処理を有効化 |
+| 文字列 | :smart_text_begin_chars | ',.;:!?)]}' | スマートテキストで先頭の改行を抑制する文字 |
+| 文字列 | :smart_text_end_chars | '([{' | スマートテキストで末尾の改行を抑制する文字 |
+| 真偽値 | :smart_text_escaping | true | 設定すると, スマートテキスト中のエスケープが必要な HTML 文字は自動的にエスケープされる |

data/doc/jp/translator.md

@@ -0,0 +1,28 @@
+# 翻訳/I18n
+
+翻訳プラグインは Gettext, Fast-Gettext または Rails I18n を使ったテンプレートの自動翻訳機能を提供します。
+テンプレート内の静的テキストを翻訳版に変換します。
+
+例:
+
+    h1 Welcome to #{url}!
+
+Gettext は文字列を英語からドイツ語に変換し, 文字列が展開される部分は %1, %2, ... の順に変換されます。
+
+    "Welcome to %1!" -> "Willkommen auf %1!"
+
+次のようにレンダリングされます。
+
+    <h1>Willkommen auf slim-lang.com!</h1>
+
+翻訳プラグインを有効化します。
+
+    require 'slim/translator'
+
+# オプション
+
+| 種類 | 名前 | デフォルト | 用途 |
+| ---- | ---- | ---------- | ---- |
+| 真偽値   | :tr      | true     | 翻訳の有効化 ('slim/translator' の required が必要) |
+| シンボル | :tr_mode | :dynamic | 翻訳を :static = コンパイル時に実施, :dynamic = ランタイムで実施 |
+| 文字列   | :tr_fn   | インストールされた翻訳ライブラリに依存 | 翻訳用ヘルパ, gettext の場合 '_' |

data/doc/smart.md

@@ -0,0 +1,102 @@
+# Smart text
+
+The easiest way to combine text and markup is to use the <a name="smarttext">smart text mode</a>.
+
+Enable the smart text plugin with
+
+    require 'slim/smart'
+
+This automatically enables the `:implicit_text` option as well,
+so you can easily type text like this:
+
+    p
+      This is text.
+
+Slim will automatically treat any line which doesn't start
+with a lowercase tag name or any of the special characters as an implicit text line.
+If the text spans several lines, simply indent them.
+
+    p
+      This is text,
+        and it spans
+        several lines.
+
+You can also mark the text explicitly with `>`,
+for example when it starts with lowercase letter or unusual character,
+or when the text spans several lines,
+or merely for aesthetic consistency,
+or if you want to use uppercase tag names
+and therefore need to keep the `:implicit_text` option disabled.
+
+    p
+      > 'This is text, too.'
+    p
+      >
+        This is text
+        which spans
+        several lines.
+
+As long as you leave the `:smart_text_escaping` enabled,
+any non-verbatim text is automatically escaped for you.
+However, for your convenience, any HTML entities detected are still used verbatim.
+This way you are most likely to get what you really wanted,
+without having to worry about HTML escaping all the time.
+
+    h1 Questions & Answers
+    footer
+      Copyright &copy; #{Time.now.year}
+
+Another cool thing about smart text is that it mixes fairly well with markup.
+Smart text lines normally preserve newlines,
+so it is easy to mix them with other tags, like emphasis or links:
+
+    p
+      Your credit card
+      strong will not
+      > be charged now.
+    p
+      Check
+      a href=r(:faq) our FAQ
+      > for more info.
+
+(Note the use of the explicit text indicator `>` to distinguish lowercase text from tags).
+
+However, sometimes you do not want the whitespace around the inline tag.
+Fortunately smart text takes care of the most common cases for you as well.
+The leading newline is suppressed if the smart text block begins
+with a character from the `:smart_text_begin_chars` set (`,.;:!?)]}` by default).
+Similarly, trailing newline is suppressed if the smart text block ends
+with a character from the `:smart_text_end_chars` set (`([{` by default).
+This makes it quite easy to mix normal text with links or spans like this:
+
+    p
+      Please proceed to
+      a href="/" our homepage
+      .
+    p
+      Status: failed (
+      a href="#1" details
+      ).
+
+Note that smart text is smart enough to know about tag shortcuts, too,
+so it will correctly deal even with cases like this:
+
+    .class
+      #id
+        #{'More'}
+        i text
+        ...
+
+Of course, all this is meant only to make working with short text snippets more convenient.
+For bulk text content, you are more than welcome to use one of the builtin embedded engines,
+such as Markdown or Textile.
+
+## Options
+
+| Type | Name | Default | Purpose |
+| ---- | ---- | ------- | ------- |
+| Boolean | :implicit_text | true | Enable implicit text recognition |
+| Boolean | :smart_text | true | Enable smart text mode newline processing |
+| String | :smart_text_begin_chars | ',.;:!?)]}' | Characters suppressing leading newline in smart text |
+| String | :smart_text_end_chars | '([{' | Characters suppressing trailing newline in smart text |
+| Boolean | :smart_text_escaping | true | When set, HTML characters which need escaping are automatically escaped in smart text |