RubyGems - mack-localization - Versions diffs - 0.6.1.1 → 0.6.1.2 - Mend

mack-localization 0.6.1.1 → 0.6.1.2

Files changed (62) hide show

data/doc/classes/Mack/Localization/Translator.html ADDED Viewed

@@ -0,0 +1,275 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!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>
+  <title>Class: Mack::Localization::Translator</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+    elemStyle = elem.style;
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+    return true;
+  }
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  // ]]>
+  </script>
+</head>
+<body>
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">Mack::Localization::Translator</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../../files/lib/mack-localization/translator_rb.html">
+                lib/mack-localization/translator.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                <a href="../../Object.html">
+                Object
+               </a>
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+   </div>
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+      <div class="name-list">
+      <a href="#M000074">getimg</a>&nbsp;&nbsp;
+      <a href="#M000073">gets</a>&nbsp;&nbsp;
+      <a href="#M000076">irregular</a>&nbsp;&nbsp;
+      <a href="#M000075">pluralize</a>&nbsp;&nbsp;
+      </div>
+    </div>
+  </div>
+    <!-- if includes -->
+    <div id="includes">
+      <h3 class="section-bar">Included Modules</h3>
+      <div id="includes-list">
+        <span class="include-name">Singleton</span>
+      </div>
+    </div>
+    <div id="section">
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Instance methods</h3>
+      <div id="method-M000074" class="method-detail">
+        <a name="M000074"></a>
+        <div class="method-heading">
+          <a href="#M000074" class="method-signature">
+          <span class="method-name">getimg</span><span class="method-args">(view_sym, key, lang)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000074-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000074-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/mack-localization/translator.rb, line 41</span>
+41:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">getimg</span>(<span class="ruby-identifier">view_sym</span>, <span class="ruby-identifier">key</span>, <span class="ruby-identifier">lang</span>)
+42:         <span class="ruby-identifier">raise</span> <span class="ruby-constant">Mack</span><span class="ruby-operator">::</span><span class="ruby-constant">Localization</span><span class="ruby-operator">::</span><span class="ruby-constant">Errors</span><span class="ruby-operator">::</span><span class="ruby-constant">UnsupportedFeature</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">&quot;getimg&quot;</span>)
+43:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000073" class="method-detail">
+        <a name="M000073"></a>
+        <div class="method-heading">
+          <a href="#M000073" class="method-signature">
+          <span class="method-name">gets</span><span class="method-args">(view_sym, key, lang)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Get the localized string for the specified language using the given key in
+the view_sym namespace. The view symbol is how the system knows where to
+locate the content file. By default the localization of the file is in
+[app_directory]/lang/views/[view_sym]/content_[lang].yml
+</p>
+<p>
+params:
+</p>
+<pre>
+   view_sym -- which view is the key located in?
+   key -- the lookup key
+   lang -- the language
+</pre>
+<p>
+returns:
+</p>
+<pre>
+   the multibyte version of the string
+</pre>
+<p>
+raise:
+</p>
+<pre>
+   UnsupportedLanguage if the specified language is not defined in the 'supported_languages' array
+   UnknownStringKey if the key specified is not defined in the content file
+</pre>
+<p>
+see also:
+</p>
+<pre>
+   l10n_gets in view_helpers
+</pre>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000073-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000073-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/mack-localization/translator.rb, line 26</span>
+26:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">gets</span>(<span class="ruby-identifier">view_sym</span>, <span class="ruby-identifier">key</span>, <span class="ruby-identifier">lang</span>)
+27:         <span class="ruby-identifier">view_name</span> = <span class="ruby-identifier">view_sym</span>.<span class="ruby-identifier">to_s</span>
+28:         <span class="ruby-identifier">base_lang</span> = <span class="ruby-identifier">l10n_config</span>.<span class="ruby-identifier">base_language</span>
+29:         <span class="ruby-identifier">base_lang</span> = <span class="ruby-identifier">lang</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">lang</span>.<span class="ruby-identifier">nil?</span>
+30:
+31:         <span class="ruby-identifier">raise</span> <span class="ruby-constant">Mack</span><span class="ruby-operator">::</span><span class="ruby-constant">Localization</span><span class="ruby-operator">::</span><span class="ruby-constant">Errors</span><span class="ruby-operator">::</span><span class="ruby-constant">UnsupportedLanguage</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">base_lang</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">l10n_config</span>.<span class="ruby-identifier">supported_languages</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">base_lang</span>)
+32:
+33:         <span class="ruby-identifier">cache_key</span> = <span class="ruby-node">&quot;#{view_sym}_#{base_lang}_content&quot;</span>
+34:         <span class="ruby-identifier">path</span>      = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">l10n_config</span>.<span class="ruby-identifier">base_directory</span>, <span class="ruby-value str">&quot;views&quot;</span>, <span class="ruby-node">&quot;#{view_name}&quot;</span>, <span class="ruby-node">&quot;content_#{base_lang}.yml&quot;</span>)
+35:         <span class="ruby-identifier">content_hash</span> = <span class="ruby-identifier">load_content_hash</span>(<span class="ruby-identifier">cache_key</span>, <span class="ruby-identifier">base_lang</span>, <span class="ruby-identifier">path</span>)
+36:
+37:         <span class="ruby-identifier">raise</span> <span class="ruby-constant">Mack</span><span class="ruby-operator">::</span><span class="ruby-constant">Localization</span><span class="ruby-operator">::</span><span class="ruby-constant">Errors</span><span class="ruby-operator">::</span><span class="ruby-constant">UnknownStringKey</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">key</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">content_hash</span>[<span class="ruby-identifier">key</span>] <span class="ruby-operator">==</span> <span class="ruby-keyword kw">nil</span>
+38:         <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">u</span>(<span class="ruby-identifier">content_hash</span>[<span class="ruby-identifier">key</span>])
+39:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000076" class="method-detail">
+        <a name="M000076"></a>
+        <div class="method-heading">
+          <a href="#M000076" class="method-signature">
+          <span class="method-name">irregular</span><span class="method-args">(key, lang, num)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000076-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000076-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/mack-localization/translator.rb, line 50</span>
+50:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">irregular</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">lang</span>, <span class="ruby-identifier">num</span>)
+51:         <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">u</span>(<span class="ruby-identifier">inflect</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">lang</span>, <span class="ruby-identifier">num</span>, <span class="ruby-identifier">:irregular</span>))
+52:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000075" class="method-detail">
+        <a name="M000075"></a>
+        <div class="method-heading">
+          <a href="#M000075" class="method-signature">
+          <span class="method-name">pluralize</span><span class="method-args">(key, lang, num)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+REVIEW: inflection&#8230; should localized inflection use the same
+inflection engine as the english counterpart?
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000075-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000075-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/mack-localization/translator.rb, line 46</span>
+46:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">pluralize</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">lang</span>, <span class="ruby-identifier">num</span>)
+47:         <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">u</span>(<span class="ruby-identifier">inflect</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">lang</span>, <span class="ruby-identifier">num</span>, <span class="ruby-identifier">:plural</span>))
+48:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>

data/doc/classes/Mack/ViewHelpers/L10NHelpers/Context.html ADDED Viewed

@@ -0,0 +1,278 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!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>
+  <title>Class: Mack::ViewHelpers::L10NHelpers::Context</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+    elemStyle = elem.style;
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+    return true;
+  }
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  // ]]>
+  </script>
+</head>
+<body>
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">Mack::ViewHelpers::L10NHelpers::Context</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../../../files/lib/mack-localization/helpers/view_helpers/l10n_helpers_rb.html">
+                lib/mack-localization/helpers/view_helpers/l10n_helpers.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                <a href="../../../Object.html">
+                Object
+               </a>
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+   </div>
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+      <div class="name-list">
+      <a href="#M000016">currency</a>&nbsp;&nbsp;
+      <a href="#M000014">date</a>&nbsp;&nbsp;
+      <a href="#M000013">getimg</a>&nbsp;&nbsp;
+      <a href="#M000012">gets</a>&nbsp;&nbsp;
+      <a href="#M000011">new</a>&nbsp;&nbsp;
+      <a href="#M000015">number</a>&nbsp;&nbsp;
+      </div>
+    </div>
+  </div>
+    <!-- if includes -->
+    <div id="includes">
+      <h3 class="section-bar">Included Modules</h3>
+      <div id="includes-list">
+        <span class="include-name"><a href="../L10NHelpers.html">Mack::ViewHelpers::L10NHelpers</a></span>
+      </div>
+    </div>
+    <div id="section">
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+      <div id="method-M000011" class="method-detail">
+        <a name="M000011"></a>
+        <div class="method-heading">
+          <a href="#M000011" class="method-signature">
+          <span class="method-name">new</span><span class="method-args">(view_sym, lang)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000011-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000011-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/mack-localization/helpers/view_helpers/l10n_helpers.rb, line 8</span>
+ 8:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">view_sym</span>, <span class="ruby-identifier">lang</span>)
+ 9:           <span class="ruby-ivar">@view_sym</span> = <span class="ruby-identifier">view_sym</span>
+10:           <span class="ruby-ivar">@lang</span>     = <span class="ruby-identifier">lang</span>
+11:         <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <h3 class="section-bar">Public Instance methods</h3>
+      <div id="method-M000016" class="method-detail">
+        <a name="M000016"></a>
+        <div class="method-heading">
+          <a href="#M000016" class="method-signature">
+          <span class="method-name">currency</span><span class="method-args">(amount)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000016-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000016-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/mack-localization/helpers/view_helpers/l10n_helpers.rb, line 29</span>
+29:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">currency</span>(<span class="ruby-identifier">amount</span>)
+30:           <span class="ruby-identifier">l10n_currency</span>(<span class="ruby-identifier">amount</span>, <span class="ruby-ivar">@lang</span>)
+31:         <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000014" class="method-detail">
+        <a name="M000014"></a>
+        <div class="method-heading">
+          <a href="#M000014" class="method-signature">
+          <span class="method-name">date</span><span class="method-args">(time, type)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000014-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000014-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/mack-localization/helpers/view_helpers/l10n_helpers.rb, line 21</span>
+21:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">date</span>(<span class="ruby-identifier">time</span>, <span class="ruby-identifier">type</span>)
+22:           <span class="ruby-identifier">l10n_date</span>(<span class="ruby-identifier">time</span>, <span class="ruby-identifier">type</span>, <span class="ruby-ivar">@lang</span>)
+23:         <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000013" class="method-detail">
+        <a name="M000013"></a>
+        <div class="method-heading">
+          <a href="#M000013" class="method-signature">
+          <span class="method-name">getimg</span><span class="method-args">(key)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000013-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000013-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/mack-localization/helpers/view_helpers/l10n_helpers.rb, line 17</span>
+17:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">getimg</span>(<span class="ruby-identifier">key</span>)
+18:           <span class="ruby-identifier">l10n_getimg</span>(<span class="ruby-identifier">key</span>, <span class="ruby-ivar">@view_sym</span>, <span class="ruby-ivar">@lang</span>)
+19:         <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000012" class="method-detail">
+        <a name="M000012"></a>
+        <div class="method-heading">
+          <a href="#M000012" class="method-signature">
+          <span class="method-name">gets</span><span class="method-args">(key)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000012-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000012-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/mack-localization/helpers/view_helpers/l10n_helpers.rb, line 13</span>
+13:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">gets</span>(<span class="ruby-identifier">key</span>)
+14:           <span class="ruby-identifier">l10n_gets</span>(<span class="ruby-identifier">key</span>, <span class="ruby-ivar">@view_sym</span>, <span class="ruby-ivar">@lang</span>)
+15:         <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000015" class="method-detail">
+        <a name="M000015"></a>
+        <div class="method-heading">
+          <a href="#M000015" class="method-signature">
+          <span class="method-name">number</span><span class="method-args">(num)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000015-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000015-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/mack-localization/helpers/view_helpers/l10n_helpers.rb, line 25</span>
+25:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">number</span>(<span class="ruby-identifier">num</span>)
+26:           <span class="ruby-identifier">l10n_number</span>(<span class="ruby-identifier">num</span>, <span class="ruby-ivar">@lang</span>)
+27:         <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>