RubyGems - zen - Versions diffs - 0.1a → 0.2 - Mend

zen 0.1a → 0.2

Files changed (414) hide show

@@ -1,660 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-  <head>
-    <meta name="Content-Type" content="text/html; charset=utf-8" />
-<title>Module: Zen::Language</title>
-<link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
-<link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
-<script type="text/javascript" charset="utf-8">
-  relpath = '..';
-  if (relpath != '') relpath += '/';
-</script>
-<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
-<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
-  </head>
-  <body>
-    <script type="text/javascript" charset="utf-8">
-      if (window.top.frames.main) document.body.className = 'frames';
-    </script>
-    <div id="header">
-      <div id="menu">
-    <a href="../_index.html">Index (L)</a> &raquo;
-    <span class='title'><span class='object_link'><a href="../Zen.html" title="Zen (module)">Zen</a></span></span>
-     &raquo;
-    <span class="title">Language</span>
-  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
-</div>
-      <div id="search">
-  <a id="class_list_link" href="#">Class List</a>
-  <a id="method_list_link" href="#">Method List</a>
-  <a id ="file_list_link" href="#">File List</a>
-</div>
-      <div class="clear"></div>
-    </div>
-    <iframe id="search_frame"></iframe>
-    <div id="content"><h1>Module: Zen::Language
-</h1>
-<dl class="box">
-    <dt class="r1 last">Defined in:</dt>
-    <dd class="r1 last">/Applications/MAMP/htdocs/ruby/zen/zen/lib/zen/base/language.rb</dd>
-</dl>
-<div class="clear"></div>
-<h2>Overview</h2><div class="docstring">
-  <div class="discussion">
-    <p>The Language module enables developers to create multi-lingual applications/extensions using
-nothing more than Ruby. While Ramaze already ships with multi-language support it relies on <span class="caps">YAML</span>
-for it&#8217;s language files. While <span class="caps">YAML</span> is nice for config/language files my aim is to keep everything in Ruby
-as much as possible. Another problem with the language class provided by Ramaze is that at the time of writing
-(October 2011) it was completely undocumented and didn&#8217;t make much sense.</p>
-<h2>Usage</h2>
-<p>Using the language system provided by Zen is fairly straight forward. Create a directory named &#8220;language&#8221;
-and create a sub directory for each language. For example, if you&#8217;re adding an English language pack this directory would be named &#8220;en&#8221;.
-Language files can be named whatever you like as long as they contain the following block:</p>
-<pre class="code"><span class='const'>Zen</span><span class='op'>::</span><span class='const'>Language</span><span class='period'>.</span><span class='id translation'>translation</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>translation_name</span><span class='tstring_end'>'</span></span> <span class='kw'>do</span> <span class='op'>|</span><span class='id item'>item</span><span class='op'>|</span>
-  <span class='comment'># ...
-</span><span class='kw'>end</span></pre>
-<p>Inside this block you&#8217;ll define your language items. For example, if we want a localized username and password we could
-do something like the following:</p>
-<pre class="code"><span class='const'>Zen</span><span class='op'>::</span><span class='const'>Language</span><span class='period'>.</span><span class='id translation'>translation</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>example</span><span class='tstring_end'>'</span></span> <span class='kw'>do</span> <span class='op'>|</span><span class='id item'>item</span><span class='op'>|</span>
-  <span class='id item'>item</span><span class='period'>.</span><span class='id username'>username</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Username</span><span class='tstring_end'>'</span></span>
-  <span class='id item'>item</span><span class='period'>.</span><span class='id passowrd'>passowrd</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Password</span><span class='tstring_end'>'</span></span>
-<span class='kw'>end</span></pre>
-<p>This language file can then be loaded as following (assuming it&#8217;s named &#8220;example.rb&#8221;):</p>
-<pre class="code"><span class='id lang'>lang</span> <span class='op'>=</span> <span class='const'>Zen</span><span class='op'>::</span><span class='const'>Language</span><span class='period'>.</span><span class='id load'>load</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>example</span><span class='tstring_end'>'</span></span>
-<span class='comment'># We can now access our translation items from the lang variable
-</span><span class='id lang'>lang</span><span class='period'>.</span><span class='id username'>username</span>
-<span class='id lang'>lang</span><span class='period'>.</span><span class='id password'>password</span></pre>
-<p>Zen will use the setting Zen.options.language to determine what language should be loaded.</p>
-<h2>Sub Items</h2>
-<p>Since language files are nothing more than Ruby blocks you can do everything you normally can. This makes
-it extremely easy to retrieve dynamic data for your language files (a list of installed extensions for example).
-Sub items are generally specified as a hash:</p>
-<pre class="code"><span class='id item'>item</span><span class='period'>.</span><span class='id sub_items'>sub_items</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='symbol'>:name</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Name</span><span class='tstring_end'>'</span></span><span class='rbrace'>}</span></pre>
-<p>Note that Zen won&#8217;t convert the keys from format A to B, if you specify a symbol it will stay a symbol.</p>
-  </div>
-</div>
-<div class="tags">
-  <h3>Author:</h3>
-<ul class="author">
-    <li>
-        <div class='inline'><p>Yorick Peterse</p></div>
-    </li>
-</ul>
-<h3>Since:</h3>
-<ul class="since">
-    <li>
-        <div class='inline'><p>0.1</p></div>
-    </li>
-</ul>
-</div>
-  <h2>Class Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
-  <ul class="summary">
-      <li class="public ">
-  <span class="summary_signature">
-      <a href="#language_keys-class_method" title="language_keys (class method)">+ (Object) <strong>language_keys</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'><p>Returns the value of attribute language_keys.</p></div></span>
-</li>
-      <li class="public ">
-  <span class="summary_signature">
-      <a href="#language_paths-class_method" title="language_paths (class method)">+ (Object) <strong>language_paths</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'><p>Returns the value of attribute language_paths.</p></div></span>
-</li>
-  </ul>
-    <h2>
-      Class Method Summary
-      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
-    </h2>
-    <ul class="summary">
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#load-class_method" title="load (class method)">+ (Object) <strong>load</strong>(lang_name) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'><p>Tries to load the specified language file from each directory specified in Ramaze.options.roots.</p></div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#translation-class_method" title="translation (class method)">+ (Object) <strong>translation</strong>(lang_name) {|@language_keys[hash_key]| ... }</a>
-  </span>
-    <span class="summary_desc"><div class='inline'><p>Given a block this method will store all the keys in the language_keys instance variable.</p></div></span>
-</li>
-    </ul>
-  <div id="class_attr_details" class="attr_details">
-    <h2>Class Attribute Details</h2>
-      <span id="language_keys=-class_method"></span>
-      <span id="language_keys-class_method"></span>
-      <div class="method_details first">
-  <p class="signature first" id="language_keys-class_method">
-    + (<tt>Object</tt>) <strong>language_keys</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    <p>Returns the value of attribute language_keys</p>
-  </div>
-</div>
-<div class="tags">
-  <h3>Since:</h3>
-<ul class="since">
-    <li>
-        <div class='inline'><p>0.1</p></div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-56
-57
-58</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File '/Applications/MAMP/htdocs/ruby/zen/zen/lib/zen/base/language.rb', line 56</span>
-<span class='kw'>def</span> <span class='id language_keys'>language_keys</span>
-  <span class='ivar'>@language_keys</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <span id="language_paths=-class_method"></span>
-      <span id="language_paths-class_method"></span>
-      <div class="method_details ">
-  <p class="signature " id="language_paths-class_method">
-    + (<tt>Object</tt>) <strong>language_paths</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    <p>Returns the value of attribute language_paths</p>
-  </div>
-</div>
-<div class="tags">
-  <h3>Since:</h3>
-<ul class="since">
-    <li>
-        <div class='inline'><p>0.1</p></div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-57
-58
-59</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File '/Applications/MAMP/htdocs/ruby/zen/zen/lib/zen/base/language.rb', line 57</span>
-<span class='kw'>def</span> <span class='id language_paths'>language_paths</span>
-  <span class='ivar'>@language_paths</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-  <div id="class_method_details" class="method_details_list">
-    <h2>Class Method Details</h2>
-      <div class="method_details first">
-  <p class="signature first" id="load-class_method">
-    + (<tt>Object</tt>) <strong>load</strong>(lang_name)
-</p><div class="docstring">
-  <div class="discussion">
-    <p>Tries to load the specified language file from each directory specified in Ramaze.options.roots.
-After a language file has been loaded the OpenStruct object will be stored in a hash and returned
-in case the same language file is loaded multiple times.</p>
-<p>the filename and the name defined in Zen::Language.translation().</p>
-  </div>
-</div>
-<div class="tags">
-  <div class="examples">
-    <h3>Examples:</h3>
-      <h4><div class='inline'></div></h4>
-      <pre class="example code"><span class='ivar'>@user_lang</span> <span class='op'>=</span> <span class='const'>Zen</span><span class='op'>::</span><span class='const'>Language</span><span class='period'>.</span><span class='id load'>load</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>user</span><span class='tstring_end'>'</span></span>
-<span class='ivar'>@user_lang</span><span class='period'>.</span><span class='id username'>username</span></pre>
-  </div>
-<h3>Parameters:</h3>
-<ul class="param">
-    <li>
-        <span class='type'>(<tt>String</tt>)</span>
-        <span class='name'>lang_name</span>
-        &mdash;
-        <div class='inline'><p>The name of the language file to load. This name should match both</p></div>
-    </li>
-</ul>
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Object</tt>)</span>
-        &mdash;
-        <div class='inline'><p>An OpenStruct object containing all the language keys and their values.</p></div>
-    </li>
-</ul>
-<h3>Author:</h3>
-<ul class="author">
-    <li>
-        <div class='inline'><p>Yorick Peterse</p></div>
-    </li>
-</ul>
-<h3>Since:</h3>
-<ul class="since">
-    <li>
-        <div class='inline'><p>0.1</p></div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-74
-75
-76
-77
-78
-79
-80
-81
-82
-83
-84
-85
-86
-87
-88
-89
-90
-91
-92
-93
-94
-95
-96
-97
-98
-99
-100</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File '/Applications/MAMP/htdocs/ruby/zen/zen/lib/zen/base/language.rb', line 74</span>
-<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id load'>load</span> <span class='id lang_name'>lang_name</span>
-  <span class='comment'># Each language file is stored in the hash using a key with the following format:
-</span>  <span class='comment'># language-name_language-file
-</span>  <span class='id hash_key'>hash_key</span> <span class='op'>=</span> <span class='const'>Zen</span><span class='period'>.</span><span class='id options'>options</span><span class='period'>.</span><span class='id language'>language</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>_</span><span class='tstring_end'>'</span></span> <span class='op'>+</span> <span class='id lang_name'>lang_name</span>
-  <span class='id hash_key'>hash_key</span> <span class='op'>=</span> <span class='id hash_key'>hash_key</span><span class='period'>.</span><span class='id to_sym'>to_sym</span>
-  <span class='comment'># Let's see if the language file is already loaded
-</span>  <span class='kw'>if</span> <span class='ivar'>@language_keys</span><span class='period'>.</span><span class='id key?'>key?</span><span class='lparen'>(</span><span class='id hash_key'>hash_key</span><span class='rparen'>)</span>
-    <span class='kw'>return</span> <span class='ivar'>@language_keys</span><span class='lbracket'>[</span><span class='id hash_key'>hash_key</span><span class='rbracket'>]</span>
-  <span class='kw'>end</span>
-  <span class='comment'># Time to load the file
-</span>  <span class='id paths'>paths</span> <span class='op'>=</span> <span class='ivar'>@language_paths</span> <span class='op'>+</span> <span class='const'>Ramaze</span><span class='period'>.</span><span class='id options'>options</span><span class='period'>.</span><span class='id roots'>roots</span>
-  <span class='id paths'>paths</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id dir'>dir</span><span class='op'>|</span>
-    <span class='id lang_path'>lang_path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id dir'>dir</span><span class='rbrace'>}</span><span class='tstring_content'>/language/</span><span class='embexpr_beg'>#{</span><span class='const'>Zen</span><span class='period'>.</span><span class='id options'>options</span><span class='period'>.</span><span class='id language'>language</span><span class='rbrace'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id lang_name'>lang_name</span><span class='rbrace'>}</span><span class='tstring_content'>.rb</span><span class='tstring_end'>&quot;</span></span>
-    <span class='comment'># Load the file if it exists
-</span>    <span class='kw'>if</span> <span class='const'>File</span><span class='period'>.</span><span class='id exist?'>exist?</span><span class='lparen'>(</span><span class='id lang_path'>lang_path</span><span class='rparen'>)</span>
-      <span class='id require'>require</span> <span class='id lang_path'>lang_path</span>
-      <span class='kw'>return</span> <span class='ivar'>@language_keys</span><span class='lbracket'>[</span><span class='id hash_key'>hash_key</span><span class='rbracket'>]</span>
-    <span class='kw'>end</span>
-  <span class='kw'>end</span>
-  <span class='comment'># No language file found
-</span>  <span class='kw'>return</span> <span class='kw'>false</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="translation-class_method">
-    + (<tt>Object</tt>) <strong>translation</strong>(lang_name) {|@language_keys[hash_key]| ... }
-</p><div class="docstring">
-  <div class="discussion">
-    <p>Given a block this method will store all the keys in the language_keys instance variable.
-Using Zen::Language.load these variables will be returned as an OpenStruct object.</p>
-  </div>
-</div>
-<div class="tags">
-  <div class="examples">
-    <h3>Examples:</h3>
-      <h4><div class='inline'></div></h4>
-      <pre class="example code"><span class='const'>Zen</span><span class='op'>::</span><span class='const'>Language</span><span class='period'>.</span><span class='id translation'>translation</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>example</span><span class='tstring_end'>'</span></span> <span class='kw'>do</span> <span class='op'>|</span><span class='id lang'>lang</span><span class='op'>|</span>
-  <span class='id lang'>lang</span><span class='period'>.</span><span class='id username'>username</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Username</span><span class='tstring_end'>'</span></span>
-  <span class='id lang'>lang</span><span class='period'>.</span><span class='id password'>password</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Password</span><span class='tstring_end'>'</span></span>
-<span class='kw'>end</span></pre>
-  </div>
-<h3>Parameters:</h3>
-<ul class="param">
-    <li>
-        <span class='type'>(<tt>Block</tt>)</span>
-        <span class='name'>Block</span>
-        &mdash;
-        <div class='inline'><p>containing all the language items.</p></div>
-    </li>
-</ul>
-<h3>Yields:</h3>
-<ul class="yield">
-    <li>
-        <span class='type'>(<tt>@<span class='object_link'><a href="#language_keys-class_method" title="Zen::Language.language_keys (method)">language_keys</a></span>[hash_key]</tt>)</span>
-    </li>
-</ul>
-<h3>Author:</h3>
-<ul class="author">
-    <li>
-        <div class='inline'><p>Yorick Peterse</p></div>
-    </li>
-</ul>
-<h3>Since:</h3>
-<ul class="since">
-    <li>
-        <div class='inline'><p>0.1</p></div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-115
-116
-117
-118
-119
-120
-121
-122
-123
-124
-125
-126
-127
-128
-129
-130</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File '/Applications/MAMP/htdocs/ruby/zen/zen/lib/zen/base/language.rb', line 115</span>
-<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id translation'>translation</span> <span class='id lang_name'>lang_name</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id block'>block</span>
-  <span class='comment'># Each language file is stored in the hash using a key with the following format:
-</span>  <span class='comment'># language-name_language-file
-</span>  <span class='id hash_key'>hash_key</span> <span class='op'>=</span> <span class='const'>Zen</span><span class='period'>.</span><span class='id options'>options</span><span class='period'>.</span><span class='id language'>language</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>_</span><span class='tstring_end'>'</span></span> <span class='op'>+</span> <span class='id lang_name'>lang_name</span>
-  <span class='id hash_key'>hash_key</span> <span class='op'>=</span> <span class='id hash_key'>hash_key</span><span class='period'>.</span><span class='id to_sym'>to_sym</span>
-  <span class='comment'># Does the language key already exist?
-</span>  <span class='kw'>if</span> <span class='ivar'>@language_keys</span><span class='period'>.</span><span class='id key?'>key?</span><span class='lparen'>(</span><span class='id hash_key'>hash_key</span><span class='rparen'>)</span>
-    <span class='id raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>There already is a language file named \&quot;</span><span class='embexpr_beg'>#{</span><span class='id lang_name'>lang_name</span><span class='rbrace'>}</span><span class='tstring_content'>\&quot; for the language \&quot;</span><span class='embexpr_beg'>#{</span><span class='const'>Zen</span><span class='period'>.</span><span class='id options'>options</span><span class='period'>.</span><span class='id language'>language</span><span class='rbrace'>}</span><span class='tstring_content'>\&quot;.</span><span class='tstring_end'>&quot;</span></span>
-  <span class='kw'>end</span>
-  <span class='comment'># Process the language file
-</span>  <span class='ivar'>@language_keys</span><span class='lbracket'>[</span><span class='id hash_key'>hash_key</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'>OpenStruct</span><span class='period'>.</span><span class='id new'>new</span>
-  <span class='kw'>yield</span> <span class='ivar'>@language_keys</span><span class='lbracket'>[</span><span class='id hash_key'>hash_key</span><span class='rbracket'>]</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-</div>
-    <div id="footer">
-  Generated on Sun Feb  6 21:24:00 2011 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.6.4 (ruby-1.9.2).
-</div>
-  </body>
-</html>