doc/SidekiqUniqueJobs/RedisScript/Template.html
<!DOCTYPE html><html> <head> <meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title> Class: SidekiqUniqueJobs::RedisScript::TemplateUnexpected trailing spaces found. — Documentation by YARD 0.9.34Unexpected trailing spaces found. </title> <link rel="stylesheet" href="../../css/style.css" type="text/css" /> <link rel="stylesheet" href="../../css/common.css" type="text/css" /> <script type="text/javascript"> pathId = "SidekiqUniqueJobs::RedisScript::Template"; 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> <div class="nav_wrap"> <iframe id="nav" src="../../class_list.html?1"></iframe> <div id="resizer"></div> </div> <div id="main" tabindex="-1"> <div id="header"> <div id="menu">Unexpected trailing spaces found. <a href="../../_index.html">Index (T)</a> » <span class='title'><span class='object_link'><a href="../../SidekiqUniqueJobs.html" title="SidekiqUniqueJobs (module)">SidekiqUniqueJobs</a></span></span> » <span class='title'><span class='object_link'><a href="../RedisScript.html" title="SidekiqUniqueJobs::RedisScript (module)">RedisScript</a></span></span>Expected an indentation at 6 instead of at 5.
Unexpected trailing spaces found. » <span class="title">Template</span>Unexpected trailing spaces found. </div> <div id="search">Unexpected trailing spaces found. <a class="full_list_link" id="class_list_link" href="../../class_list.html"> <svg width="24" height="24"> <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect> <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect> <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect> </svg> </a>Unexpected trailing spaces found. </div> <div class="clear"></div> </div> <div id="content"><h1>Class: SidekiqUniqueJobs::RedisScript::TemplateUnexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. </h1><div class="box_info">Unexpected trailing spaces found. <dl> <dt>Inherits:</dt> <dd> <span class="inheritName">Object</span>Unexpected trailing spaces found. <ul class="fullTree"> <li>Object</li>Unexpected trailing spaces found. <li class="next">SidekiqUniqueJobs::RedisScript::Template</li>Unexpected trailing spaces found. </ul> <a href="#" class="inheritanceTree">show all</a>Unexpected trailing spaces found. </dd> </dl>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <dl> <dt>Defined in:</dt> <dd>lib/sidekiq_unique_jobs/redis_script/template.rb</dd> </dl>Unexpected trailing spaces found. </div> <h2>Overview</h2><div class="docstring"> <div class="discussion"> <p>Class Template provides LUA script partial template rendering</p> </div></div><div class="tags">Unexpected trailing spaces found. <p class="tag_title">Author:</p><ul class="author">Unexpected trailing spaces found. <li>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <div class='inline'><p>Mikael Henriksson <a href="mailto:mikael@mhenrixon.com">mikael@mhenrixon.com</a></p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. </ul> </div> Unexpected trailing spaces found. <h2> Instance Method Summary <small><a href="#" class="summary_toggle">collapse</a></small> </h2> <ul class="summary">Unexpected trailing spaces found. <li class="public "> <span class="summary_signature">Unexpected trailing spaces found. <a href="#include_partial-instance_method" title="#include_partial (instance method)">#<strong>include_partial</strong>(relative_path) ⇒ Object </a>Unexpected trailing spaces found. Unexpected trailing spaces found. </span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <span class="summary_desc"><div class='inline'><p>helper method to include a lua partial within another lua script.</p></div></span>Unexpected trailing spaces found. </li> Unexpected trailing spaces found. <li class="public "> <span class="summary_signature">Unexpected trailing spaces found. <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(script_path) ⇒ Template </a>Unexpected trailing spaces found. Unexpected trailing spaces found. </span>Unexpected trailing spaces found. Unexpected trailing spaces found. <span class="note title constructor">constructor</span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <span class="summary_desc"><div class='inline'><p>A new instance of Template.</p></div></span>Unexpected trailing spaces found. </li> Unexpected trailing spaces found. <li class="public "> <span class="summary_signature">Unexpected trailing spaces found. <a href="#render-instance_method" title="#render (instance method)">#<strong>render</strong>(pathname) ⇒ String </a>Unexpected trailing spaces found. Unexpected trailing spaces found. </span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <span class="summary_desc"><div class='inline'><p>Renders a Lua script and includes any partials in that file all <code><%= include_partial '' %></code> replaced with the actual contents of the partial.</p></div></span>Unexpected trailing spaces found. </li> Unexpected trailing spaces found. </ul>Unexpected trailing spaces found. <div id="constructor_details" class="method_details_list"> <h2>Constructor Details</h2>Unexpected trailing spaces found. <div class="method_details first"> <h3 class="signature first" id="initialize-instance_method">Unexpected trailing spaces found. Unexpected trailing spaces found. #<strong>initialize</strong>(script_path) ⇒ <tt><span class='object_link'><a href="" title="SidekiqUniqueJobs::RedisScript::Template (class)">Template</a></span></tt> Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. </h3><div class="docstring"> <div class="discussion"> <p>Returns a new instance of Template.</p> </div></div><div class="tags">Unexpected trailing spaces found. </div><table class="source_code"> <tr> <td> <pre class="lines"> 141516</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/redis_script/template.rb', line 14</span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_script_path'>script_path</span><span class='rparen'>)</span> <span class='ivar'>@script_path</span> <span class='op'>=</span> <span class='id identifier rubyid_script_path'>script_path</span><span class='kw'>end</span></pre> </td> </tr></table></div>Unexpected trailing spaces found. </div> <div id="instance_method_details" class="method_details_list"> <h2>Instance Method Details</h2> Unexpected trailing spaces found. <div class="method_details first"> <h3 class="signature first" id="include_partial-instance_method">Unexpected trailing spaces found. Unexpected trailing spaces found. #<strong>include_partial</strong>(relative_path) ⇒ <tt>Object</tt> Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. </h3><div class="docstring"> <div class="discussion"> <p>helper method to include a lua partial within another lua script</p> </div></div><div class="tags">Unexpected trailing spaces found. </div><table class="source_code"> <tr> <td> <pre class="lines"> 333435363738</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/redis_script/template.rb', line 33</span> <span class='kw'>def</span> <span class='id identifier rubyid_include_partial'>include_partial</span><span class='lparen'>(</span><span class='id identifier rubyid_relative_path'>relative_path</span><span class='rparen'>)</span> <span class='kw'>return</span> <span class='kw'>if</span> <span class='ivar'>@partial_templates</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='id identifier rubyid_relative_path'>relative_path</span><span class='rparen'>)</span> <span class='ivar'>@partial_templates</span><span class='lbracket'>[</span><span class='id identifier rubyid_relative_path'>relative_path</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='kw'>nil</span> <span class='id identifier rubyid_render'>render</span><span class='lparen'>(</span><span class='const'>Pathname</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='ivar'>@script_path</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_relative_path'>relative_path</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='rparen'>)</span><span class='kw'>end</span></pre> </td> </tr></table></div>Unexpected trailing spaces found. <div class="method_details "> <h3 class="signature " id="render-instance_method">Unexpected trailing spaces found. Unexpected trailing spaces found. #<strong>render</strong>(pathname) ⇒ <tt>String</tt> Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. </h3><div class="docstring"> <div class="discussion"> <p>Renders a Lua script and includes any partials in that fileExpected an indentation at 2 instead of at 1. all <code><%= include_partial '' %></code> replaced with the actual contents of the partial</p> </div></div><div class="tags"> <p class="tag_title">Parameters:</p><ul class="param">Unexpected trailing spaces found. <li>Unexpected trailing spaces found. <span class='name'>pathname</span>Unexpected trailing spaces found. Unexpected trailing spaces found. <span class='type'>(<tt>Pathname</tt>)</span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. — <div class='inline'><p>the path to the</p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. </ul> <p class="tag_title">Returns:</p><ul class="return">Unexpected trailing spaces found. <li>Unexpected trailing spaces found. Unexpected trailing spaces found. <span class='type'>(<tt>String</tt>)</span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. — <div class='inline'><p>the rendered Luascript</p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 26272829</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/redis_script/template.rb', line 26</span> <span class='kw'>def</span> <span class='id identifier rubyid_render'>render</span><span class='lparen'>(</span><span class='id identifier rubyid_pathname'>pathname</span><span class='rparen'>)</span> <span class='ivar'>@partial_templates</span> <span class='op'>||=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span> <span class='op'>::</span><span class='const'>ERB</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span><span class='lparen'>(</span><span class='id identifier rubyid_pathname'>pathname</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_result'>result</span><span class='lparen'>(</span><span class='id identifier rubyid_binding'>binding</span><span class='rparen'>)</span><span class='kw'>end</span></pre> </td> </tr></table></div>Unexpected trailing spaces found. </div> </div> <div id="footer"> Generated on Wed Jan 24 10:57:26 2024 by <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.34 (ruby-3.3.0).</div> </div> </body>Expected a newline at the end of the file.</html>