RubyGems - mail_engine - Versions diffs - 0.1.6 → 0.1.7 - Mend

mail_engine 0.1.6 → 0.1.7

Files changed (125) hide show

data/doc/MailEngine/MailTemplateResolver.html ADDED Viewed

@@ -0,0 +1,502 @@
+<!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>Class: MailEngine::MailTemplateResolver</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 (M)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../MailEngine.html" title="MailEngine (module)">MailEngine</a></span></span>
+     &raquo;
+    <span class="title">MailTemplateResolver</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>Class: MailEngine::MailTemplateResolver
+</h1>
+<dl class="box">
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">ActionView::Resolver</span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next">ActionView::Resolver</li>
+            <li class="next">MailEngine::MailTemplateResolver</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+      <dt class="r2">Includes:</dt>
+      <dd class="r2">Singleton</dd>
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/mail_engine/mail_template_resolver.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>
+path resolver, used for find template by provided path.
+</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+    <h2>
+      Instance Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#find_templates-instance_method" title="#find_templates (instance method)">- (Object) <strong>find_templates</strong>(name, prefix, partial, details) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'></div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#initialize_template-instance_method" title="#initialize_template (instance method)">- (Object) <strong>initialize_template</strong>(record) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>
+Initialize an ActionView::Template object based on the record found.
+</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#normalize_array-instance_method" title="#normalize_array (instance method)">- (Object) <strong>normalize_array</strong>(array) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>
+Normalize arrays by converting all symbols to strings.
+</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#normalize_path-instance_method" title="#normalize_path (instance method)">- (Object) <strong>normalize_path</strong>(name, prefix) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>
+Normalize name and prefix, so the tuple [&quot;index&quot;,
+&quot;users&quot;] becomes &quot;users/index&quot; and the tuple
+[&quot;template&quot;, nil] becomes &quot;template&quot;.
+</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#virtual_path-instance_method" title="#virtual_path (instance method)">- (Object) <strong>virtual_path</strong>(path, partial) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>
+Make paths as &quot;users/user&quot; become &quot;users/_user&quot; for
+partials.
+</p>
+</div></span>
+</li>
+    </ul>
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+      <div class="method_details first">
+  <p class="signature first" id="find_templates-instance_method">
+    - (<tt>Object</tt>) <strong>find_templates</strong>(name, prefix, partial, details)
+</p><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+9
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19
+20
+21
+22
+23</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/mail_engine/mail_template_resolver.rb', line 9</span>
+<span class='def def kw'>def</span> <span class='find_templates identifier id'>find_templates</span><span class='lparen token'>(</span><span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='prefix identifier id'>prefix</span><span class='comma token'>,</span> <span class='partial identifier id'>partial</span><span class='comma token'>,</span> <span class='details identifier id'>details</span><span class='rparen token'>)</span>
+  <span class='template_path_and_name identifier id'>template_path_and_name</span> <span class='assign token'>=</span> <span class='prefix identifier id'>prefix</span><span class='dot token'>.</span><span class='include? fid id'>include?</span><span class='lparen token'>(</span><span class='string val'>&quot;mail_engine/mail_dispatcher&quot;</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='normalize_path identifier id'>normalize_path</span><span class='lparen token'>(</span><span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='nil nil kw'>nil</span><span class='rparen token'>)</span> <span class='colon op'>:</span> <span class='normalize_path identifier id'>normalize_path</span><span class='lparen token'>(</span><span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='prefix identifier id'>prefix</span><span class='rparen token'>)</span>
+  <span class='conditions identifier id'>conditions</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span>
+    <span class='symbol val'>:path</span>    <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='template_path_and_name identifier id'>template_path_and_name</span><span class='comma token'>,</span>
+    <span class='symbol val'>:locale</span>  <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='normalize_array identifier id'>normalize_array</span><span class='lparen token'>(</span><span class='details identifier id'>details</span><span class='lbrack token'>[</span><span class='symbol val'>:locale</span><span class='rbrack token'>]</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='comma token'>,</span>
+    <span class='symbol val'>:format</span>  <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='normalize_array identifier id'>normalize_array</span><span class='lparen token'>(</span><span class='details identifier id'>details</span><span class='lbrack token'>[</span><span class='symbol val'>:formats</span><span class='rbrack token'>]</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='comma token'>,</span>
+    <span class='symbol val'>:handler</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='normalize_array identifier id'>normalize_array</span><span class='lparen token'>(</span><span class='details identifier id'>details</span><span class='lbrack token'>[</span><span class='symbol val'>:handlers</span><span class='rbrack token'>]</span><span class='rparen token'>)</span><span class='comma token'>,</span>
+    <span class='symbol val'>:partial</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='partial identifier id'>partial</span> <span class='orop op'>||</span> <span class='false false kw'>false</span>
+  <span class='rbrace token'>}</span>
+  <span class='MailTemplate constant id'>MailTemplate</span><span class='dot token'>.</span><span class='where identifier id'>where</span><span class='lparen token'>(</span><span class='conditions identifier id'>conditions</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='map identifier id'>map</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='record identifier id'>record</span><span class='bitor op'>|</span>
+    <span class='initialize_template identifier id'>initialize_template</span><span class='lparen token'>(</span><span class='record identifier id'>record</span><span class='rparen token'>)</span>
+  <span class='end end kw'>end</span>
+<span class='end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <p class="signature " id="initialize_template-instance_method">
+    - (<tt>Object</tt>) <strong>initialize_template</strong>(record)
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+Initialize an ActionView::Template object based on the record found.
+</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+37
+38
+39
+40
+41
+42
+43
+44
+45
+46
+47
+48
+49
+50</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/mail_engine/mail_template_resolver.rb', line 37</span>
+<span class='def def kw'>def</span> <span class='initialize_template identifier id'>initialize_template</span><span class='lparen token'>(</span><span class='record identifier id'>record</span><span class='rparen token'>)</span>
+  <span class='source identifier id'>source</span> <span class='assign token'>=</span> <span class='record identifier id'>record</span><span class='dot token'>.</span><span class='body identifier id'>body</span>
+  <span class='identifier identifier id'>identifier</span> <span class='assign token'>=</span> <span class='dstring node'>&quot;mail template - #{record.id} - #{record.path.inspect}&quot;</span>
+  <span class='handler identifier id'>handler</span> <span class='assign token'>=</span> <span class='ActionView constant id'>ActionView</span><span class='colon2 op'>::</span><span class='Template constant id'>Template</span><span class='dot token'>.</span><span class='registered_template_handler identifier id'>registered_template_handler</span><span class='lparen token'>(</span><span class='record identifier id'>record</span><span class='dot token'>.</span><span class='handler identifier id'>handler</span><span class='rparen token'>)</span>
+  <span class='details identifier id'>details</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span>
+    <span class='symbol val'>:format</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='Mime constant id'>Mime</span><span class='lbrack token'>[</span><span class='record identifier id'>record</span><span class='dot token'>.</span><span class='format identifier id'>format</span><span class='rbrack token'>]</span><span class='comma token'>,</span>
+    <span class='symbol val'>:updated_at</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='record identifier id'>record</span><span class='dot token'>.</span><span class='updated_at identifier id'>updated_at</span><span class='comma token'>,</span>
+    <span class='symbol val'>:virtual_path</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='virtual_path identifier id'>virtual_path</span><span class='lparen token'>(</span><span class='record identifier id'>record</span><span class='dot token'>.</span><span class='path identifier id'>path</span><span class='comma token'>,</span> <span class='record identifier id'>record</span><span class='dot token'>.</span><span class='partial identifier id'>partial</span><span class='rparen token'>)</span>
+  <span class='rbrace token'>}</span>
+  <span class='ActionView constant id'>ActionView</span><span class='colon2 op'>::</span><span class='Template constant id'>Template</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='source identifier id'>source</span><span class='comma token'>,</span> <span class='identifier identifier id'>identifier</span><span class='comma token'>,</span> <span class='handler identifier id'>handler</span><span class='comma token'>,</span> <span class='details identifier id'>details</span><span class='rparen token'>)</span>
+<span class='end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <p class="signature " id="normalize_array-instance_method">
+    - (<tt>Object</tt>) <strong>normalize_array</strong>(array)
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+Normalize arrays by converting all symbols to strings.
+</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+32
+33
+34</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/mail_engine/mail_template_resolver.rb', line 32</span>
+<span class='def def kw'>def</span> <span class='normalize_array identifier id'>normalize_array</span><span class='lparen token'>(</span><span class='array identifier id'>array</span><span class='rparen token'>)</span>
+  <span class='array identifier id'>array</span><span class='dot token'>.</span><span class='map identifier id'>map</span><span class='lparen token'>(</span><span class='bitand op'>&amp;</span><span class='symbol val'>:to_s</span><span class='rparen token'>)</span>
+<span class='end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <p class="signature " id="normalize_path-instance_method">
+    - (<tt>Object</tt>) <strong>normalize_path</strong>(name, prefix)
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+Normalize name and prefix, so the tuple [&quot;index&quot;,
+&quot;users&quot;] becomes &quot;users/index&quot; and the tuple
+[&quot;template&quot;, nil] becomes &quot;template&quot;.
+</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+27
+28
+29</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/mail_engine/mail_template_resolver.rb', line 27</span>
+<span class='def def kw'>def</span> <span class='normalize_path identifier id'>normalize_path</span><span class='lparen token'>(</span><span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='prefix identifier id'>prefix</span><span class='rparen token'>)</span>
+  <span class='prefix identifier id'>prefix</span><span class='dot token'>.</span><span class='present? fid id'>present?</span> <span class='integer val'>? </span><span class='dstring node'>&quot;#{prefix}/#{name}&quot;</span> <span class='colon op'>:</span> <span class='name identifier id'>name</span>
+<span class='end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <p class="signature " id="virtual_path-instance_method">
+    - (<tt>Object</tt>) <strong>virtual_path</strong>(path, partial)
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+Make paths as &quot;users/user&quot; become &quot;users/_user&quot; for
+partials.
+</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+53
+54
+55
+56
+57
+58
+59
+60</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/mail_engine/mail_template_resolver.rb', line 53</span>
+<span class='def def kw'>def</span> <span class='virtual_path identifier id'>virtual_path</span><span class='lparen token'>(</span><span class='path identifier id'>path</span><span class='comma token'>,</span> <span class='partial identifier id'>partial</span><span class='rparen token'>)</span>
+  <span class='return return kw'>return</span> <span class='path identifier id'>path</span> <span class='unless unless_mod kw'>unless</span> <span class='partial identifier id'>partial</span>
+  <span class='if if kw'>if</span> <span class='index identifier id'>index</span> <span class='assign token'>=</span> <span class='path identifier id'>path</span><span class='dot token'>.</span><span class='rindex identifier id'>rindex</span><span class='lparen token'>(</span><span class='string val'>&quot;/&quot;</span><span class='rparen token'>)</span>
+    <span class='path identifier id'>path</span><span class='dot token'>.</span><span class='insert identifier id'>insert</span><span class='lparen token'>(</span><span class='index identifier id'>index</span> <span class='plus op'>+</span> <span class='integer val'>1</span><span class='comma token'>,</span> <span class='string val'>&quot;_&quot;</span><span class='rparen token'>)</span>
+  <span class='else else kw'>else</span>
+    <span class='dstring node'>&quot;_#{path}&quot;</span>
+  <span class='end end kw'>end</span>
+<span class='end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Mon Mar 14 22:31:44 2011 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.6.4 (ruby-1.8.7).
+</div>
+  </body>
+</html>

data/doc/MailEngine/Sendgrid/Base/ClassMethods.html CHANGED Viewed

@@ -141,7 +141,7 @@
 </div>
     <div id="footer">
-  Generated on Fri Mar  4 17:56:26 2011 by
+  Generated on Mon Mar 14 22:31:45 2011 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.6.4 (ruby-1.8.7).
 </div>

data/doc/MailEngine/Sendgrid/Base/InstanceMethods.html CHANGED Viewed

@@ -72,7 +72,7 @@
 </div>
     <div id="footer">
-  Generated on Fri Mar  4 17:56:25 2011 by
+  Generated on Mon Mar 14 22:31:45 2011 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.6.4 (ruby-1.8.7).
 </div>

data/doc/MailEngine/Sendgrid/Base.html CHANGED Viewed

@@ -88,7 +88,7 @@
 </div>
     <div id="footer">
-  Generated on Fri Mar  4 17:56:27 2011 by
+  Generated on Mon Mar 14 22:31:45 2011 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.6.4 (ruby-1.8.7).
 </div>

data/doc/MailEngine/Sendgrid/FilterSetting.html CHANGED Viewed

@@ -248,7 +248,7 @@ Returns the value of attribute data
 </div>
     <div id="footer">
-  Generated on Fri Mar  4 17:56:26 2011 by
+  Generated on Mon Mar 14 22:31:44 2011 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.6.4 (ruby-1.8.7).
 </div>

data/doc/MailEngine/Sendgrid/RestApi.html CHANGED Viewed

@@ -467,7 +467,7 @@
 </div>
     <div id="footer">
-  Generated on Fri Mar  4 17:56:25 2011 by
+  Generated on Mon Mar 14 22:31:45 2011 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.6.4 (ruby-1.8.7).
 </div>

data/doc/MailEngine/Sendgrid/RestApiError.html CHANGED Viewed

@@ -91,7 +91,7 @@
 </div>
     <div id="footer">
-  Generated on Fri Mar  4 17:56:26 2011 by
+  Generated on Mon Mar 14 22:31:44 2011 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.6.4 (ruby-1.8.7).
 </div>