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/Formatter.html ADDED Viewed

@@ -0,0 +1,392 @@
+<?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::Formatter</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::Formatter</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../../files/lib/mack-localization/formatter_rb.html">
+                lib/mack-localization/formatter.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="#M000080">currency_format</a>&nbsp;&nbsp;
+      <a href="#M000082">currency_format_registry_key</a>&nbsp;&nbsp;
+      <a href="#M000078">date_format</a>&nbsp;&nbsp;
+      <a href="#M000081">date_format_registry_key</a>&nbsp;&nbsp;
+      <a href="#M000077">new</a>&nbsp;&nbsp;
+      <a href="#M000079">number_format</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 Class methods</h3>
+      <div id="method-M000077" class="method-detail">
+        <a name="M000077"></a>
+        <div class="method-heading">
+          <a href="#M000077" class="method-signature">
+          <span class="method-name">new</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Initialize the formatter object. Out of the box it will register 5 language
+supports for both the date and currency format
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000077-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000077-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/mack-localization/formatter.rb, line 12</span>
+12:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
+13:         <span class="ruby-ivar">@reg</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">FormatEngineRegistry</span>.<span class="ruby-identifier">instance</span>
+14:
+15:         [<span class="ruby-identifier">:en</span>, <span class="ruby-identifier">:bp</span>, <span class="ruby-identifier">:fr</span>, <span class="ruby-identifier">:it</span>, <span class="ruby-identifier">:de</span>, <span class="ruby-identifier">:es</span>].<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">lang</span><span class="ruby-operator">|</span>
+16:           <span class="ruby-identifier">klass</span> = <span class="ruby-node">&quot;Mack::Localization::DateFormatEngine::#{lang.to_s.upcase}&quot;</span>
+17:           <span class="ruby-ivar">@reg</span>.<span class="ruby-identifier">register</span>(<span class="ruby-identifier">lang</span>, <span class="ruby-identifier">date_format_registry_key</span>, <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">constantize</span>.<span class="ruby-identifier">new</span>)
+18:         <span class="ruby-keyword kw">end</span>
+19:
+20:         [<span class="ruby-identifier">:en</span>, <span class="ruby-identifier">:bp</span>, <span class="ruby-identifier">:fr</span>, <span class="ruby-identifier">:it</span>, <span class="ruby-identifier">:de</span>, <span class="ruby-identifier">:es</span>].<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">lang</span><span class="ruby-operator">|</span>
+21:           <span class="ruby-identifier">klass</span> = <span class="ruby-node">&quot;Mack::Localization::NumberAndCurrencyFormatEngine::#{lang.to_s.upcase}&quot;</span>
+22:           <span class="ruby-ivar">@reg</span>.<span class="ruby-identifier">register</span>(<span class="ruby-identifier">lang</span>, <span class="ruby-identifier">currency_format_registry_key</span>, <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">constantize</span>.<span class="ruby-identifier">new</span>)
+23:         <span class="ruby-keyword kw">end</span>
+24:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <h3 class="section-bar">Public Instance methods</h3>
+      <div id="method-M000080" class="method-detail">
+        <a name="M000080"></a>
+        <div class="method-heading">
+          <a href="#M000080" class="method-signature">
+          <span class="method-name">currency_format</span><span class="method-args">(num, lang)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Given a currency, format it according to the specified language
+</p>
+<p>
+params:
+</p>
+<pre>
+  num - the amount of money to be formatted
+  lang - the language
+</pre>
+<p>
+returns:
+</p>
+<pre>
+  the multibyte version of the formatted string
+</pre>
+<p>
+see also:
+</p>
+<pre>
+  l10n_currency in view_helpers
+</pre>
+<p>
+examples:
+</p>
+<pre>
+  currency_format(10000.00, :en) will produce &quot;$10,000.00&quot;
+</pre>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000080-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000080-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/mack-localization/formatter.rb, line 91</span>
+91:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">currency_format</span>(<span class="ruby-identifier">num</span>, <span class="ruby-identifier">lang</span>)
+92:         <span class="ruby-identifier">engine</span> = <span class="ruby-ivar">@reg</span>.<span class="ruby-identifier">get_engine</span>(<span class="ruby-identifier">lang</span>, <span class="ruby-identifier">currency_format_registry_key</span>)
+93:         <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">FormatEngineNotFound</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">lang</span>.<span class="ruby-identifier">to_s</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">engine</span>.<span class="ruby-identifier">nil?</span>
+94:         <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">u</span>(<span class="ruby-identifier">engine</span>.<span class="ruby-identifier">format_currency</span>(<span class="ruby-identifier">num</span>, <span class="ruby-identifier">lang</span>))
+95:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000082" class="method-detail">
+        <a name="M000082"></a>
+        <div class="method-heading">
+          <a href="#M000082" class="method-signature">
+          <span class="method-name">currency_format_registry_key</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Return the registry key for currency formatter
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000082-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000082-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/mack-localization/formatter.rb, line 107</span>
+107:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">currency_format_registry_key</span>
+108:         <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">:currency_format</span>
+109:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000078" class="method-detail">
+        <a name="M000078"></a>
+        <div class="method-heading">
+          <a href="#M000078" class="method-signature">
+          <span class="method-name">date_format</span><span class="method-args">(time, type, lang)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Given a time, format according to the specified type (:short, :medium,
+:long) and language.
+</p>
+<p>
+params:
+</p>
+<pre>
+  time - the instance of time to be formatted
+  type - what's the format? short, medium, or long
+  lang - the language
+</pre>
+<p>
+returns:
+</p>
+<pre>
+  the multibyte version of the formatted string
+</pre>
+<p>
+see also:
+</p>
+<pre>
+  l10n_date in view_helpers
+</pre>
+<p>
+examples:
+</p>
+<pre>
+  time = Time.local(2008, &quot;dec&quot;, 1)
+  date_format(time, :short, :en) will produce &quot;12/01/2008&quot;
+  date_format(time, :medium, :en) will produce &quot;Tue, Dec 01, 2008&quot;
+  date_format(time, :long, :en) will produce &quot;Tuesday, December 01, 2008&quot;
+</pre>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000078-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000078-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/mack-localization/formatter.rb, line 47</span>
+47:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">date_format</span>(<span class="ruby-identifier">time</span>, <span class="ruby-identifier">type</span>, <span class="ruby-identifier">lang</span>)
+48:         <span class="ruby-identifier">engine</span> = <span class="ruby-ivar">@reg</span>.<span class="ruby-identifier">get_engine</span>(<span class="ruby-identifier">lang</span>, <span class="ruby-identifier">date_format_registry_key</span>)
+49:         <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">FormatEngineNotFound</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">lang</span>.<span class="ruby-identifier">to_s</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">engine</span>.<span class="ruby-identifier">nil?</span>
+50:         <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">u</span>(<span class="ruby-identifier">engine</span>.<span class="ruby-identifier">format</span>(<span class="ruby-identifier">time</span>, <span class="ruby-identifier">type</span>))
+51:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000081" class="method-detail">
+        <a name="M000081"></a>
+        <div class="method-heading">
+          <a href="#M000081" class="method-signature">
+          <span class="method-name">date_format_registry_key</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Return the registry key for date formatter
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000081-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000081-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/mack-localization/formatter.rb, line 100</span>
+100:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">date_format_registry_key</span>
+101:         <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">:date_format</span>
+102:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000079" class="method-detail">
+        <a name="M000079"></a>
+        <div class="method-heading">
+          <a href="#M000079" class="method-signature">
+          <span class="method-name">number_format</span><span class="method-args">(num, lang)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Given a number, format it according to the specified language
+</p>
+<p>
+params:
+</p>
+<pre>
+  num - the number to be formatted
+  lang - the language
+</pre>
+<p>
+returns:
+</p>
+<pre>
+  the multibyte version of the formatted string
+</pre>
+<p>
+see also:
+</p>
+<pre>
+  l10n_number in view_helpers
+</pre>
+<p>
+examples:
+</p>
+<pre>
+  number_format(10000.00, :en) will produce &quot;10,000.00&quot;
+</pre>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000079-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000079-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/mack-localization/formatter.rb, line 69</span>
+69:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">number_format</span>(<span class="ruby-identifier">num</span>, <span class="ruby-identifier">lang</span>)
+70:         <span class="ruby-identifier">engine</span> = <span class="ruby-ivar">@reg</span>.<span class="ruby-identifier">get_engine</span>(<span class="ruby-identifier">lang</span>, <span class="ruby-identifier">currency_format_registry_key</span>)
+71:         <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">FormatEngineNotFound</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">lang</span>.<span class="ruby-identifier">to_s</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">engine</span>.<span class="ruby-identifier">nil?</span>
+72:         <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">u</span>(<span class="ruby-identifier">engine</span>.<span class="ruby-identifier">format_number</span>(<span class="ruby-identifier">num</span>, <span class="ruby-identifier">lang</span>))
+73:       <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/Localization/NumberAndCurrencyFormatEngine/BP.html ADDED Viewed

@@ -0,0 +1,196 @@
+<?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::NumberAndCurrencyFormatEngine::BP</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::NumberAndCurrencyFormatEngine::BP</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../../../files/lib/mack-localization/format_engine/nc_engines/bp_rb.html">
+                lib/mack-localization/format_engine/nc_engines/bp.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                <a href="Base.html">
+                Base
+               </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="#M000059">delimiter</a>&nbsp;&nbsp;
+      <a href="#M000061">separator</a>&nbsp;&nbsp;
+      <a href="#M000060">unit</a>&nbsp;&nbsp;
+      </div>
+    </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Instance methods</h3>
+      <div id="method-M000059" class="method-detail">
+        <a name="M000059"></a>
+        <div class="method-heading">
+          <a href="#M000059" class="method-signature">
+          <span class="method-name">delimiter</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000059-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000059-source">
+<pre>
+   <span class="ruby-comment cmt"># File lib/mack-localization/format_engine/nc_engines/bp.rb, line 5</span>
+5:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">delimiter</span>
+6:           <span class="ruby-keyword kw">return</span> <span class="ruby-value str">&quot;,&quot;</span>
+7:         <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000061" class="method-detail">
+        <a name="M000061"></a>
+        <div class="method-heading">
+          <a href="#M000061" class="method-signature">
+          <span class="method-name">separator</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000061-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000061-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/mack-localization/format_engine/nc_engines/bp.rb, line 13</span>
+13:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">separator</span>
+14:           <span class="ruby-keyword kw">return</span> <span class="ruby-value str">&quot;.&quot;</span>
+15:         <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000060" class="method-detail">
+        <a name="M000060"></a>
+        <div class="method-heading">
+          <a href="#M000060" class="method-signature">
+          <span class="method-name">unit</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000060-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000060-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/mack-localization/format_engine/nc_engines/bp.rb, line 9</span>
+ 9:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">unit</span>
+10:           <span class="ruby-keyword kw">return</span> <span class="ruby-value str">&quot;R$&quot;</span>
+11:         <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>