<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title> Class: MrLogaLoga::Configuration — Documentation by YARD 0.9.27 </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 = "MrLogaLoga::Configuration"; 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"> <a href="../_index.html">Index (C)</a> » <span class='title'><span class='object_link'><a href="../MrLogaLoga.html" title="MrLogaLoga (module)">MrLogaLoga</a></span></span> » <span class="title">Configuration</span> </div> <div id="search"> <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> </div> <div class="clear"></div> </div> <div id="content"><h1>Class: MrLogaLoga::Configuration </h1> <div class="box_info"> <dl> <dt>Inherits:</dt> <dd> <span class="inheritName">Object</span> <ul class="fullTree"> <li>Object</li> <li class="next">MrLogaLoga::Configuration</li> </ul> <a href="#" class="inheritanceTree">show all</a> </dd> </dl> <dl> <dt>Defined in:</dt> <dd>lib/mr_loga_loga/configuration.rb</dd> </dl> </div> <h2>Overview</h2><div class="docstring"> <div class="discussion"> <h2 id="label-Description">Description</h2> <p>The configuration class for MrLogaLoga</p> <h2 id="label-Usage">Usage</h2> <pre class="code ruby"><code class="ruby">MrLogaLoga.configure do |configuration| configuration.logger = ... end </code></pre> </div> </div> <div class="tags"> </div> <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2> <ul class="summary"> <li class="public "> <span class="summary_signature"> <a href="#logger-instance_method" title="#logger (instance method)">#<strong>logger</strong> ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'> <p>Returns the value of attribute logger.</p> </div></span> </li> </ul> <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="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(**kwargs) ⇒ Configuration </a> </span> <span class="note title constructor">constructor</span> <span class="summary_desc"><div class='inline'> <p>Initialize the configuration by setting configuration default values.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#reset-instance_method" title="#reset (instance method)">#<strong>reset</strong> ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'> <p>Reset the configuration to default values.</p> </div></span> </li> </ul> <div id="constructor_details" class="method_details_list"> <h2>Constructor Details</h2> <div class="method_details first"> <h3 class="signature first" id="initialize-instance_method"> #<strong>initialize</strong>(**kwargs) ⇒ <tt><span class='object_link'><a href="" title="MrLogaLoga::Configuration (class)">Configuration</a></span></tt> </h3><div class="docstring"> <div class="discussion"> <p>Initialize the configuration by setting configuration default values</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 17 18 19 20</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/mr_loga_loga/configuration.rb', line 17</span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='op'>**</span><span class='id identifier rubyid_kwargs'>kwargs</span><span class='rparen'>)</span> <span class='id identifier rubyid_reset'>reset</span> <span class='id identifier rubyid_kwargs'>kwargs</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='op'>|</span> <span class='id identifier rubyid_instance_variable_set'>instance_variable_set</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>@</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_key'>key</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span> <span class='rbrace'>}</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> </div> <div id="instance_attr_details" class="attr_details"> <h2>Instance Attribute Details</h2> <span id="logger=-instance_method"></span> <div class="method_details first"> <h3 class="signature first" id="logger-instance_method"> #<strong>logger</strong> ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> <p>Returns the value of attribute logger.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 14 15 16</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/mr_loga_loga/configuration.rb', line 14</span> <span class='kw'>def</span> <span class='id identifier rubyid_logger'>logger</span> <span class='ivar'>@logger</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> </div> <div id="instance_method_details" class="method_details_list"> <h2>Instance Method Details</h2> <div class="method_details first"> <h3 class="signature first" id="reset-instance_method"> #<strong>reset</strong> ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> <p>Reset the configuration to default values</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 23 24 25</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/mr_loga_loga/configuration.rb', line 23</span> <span class='kw'>def</span> <span class='id identifier rubyid_reset'>reset</span> <span class='ivar'>@logger</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../MrLogaLoga.html" title="MrLogaLoga (module)">MrLogaLoga</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Logger.html" title="MrLogaLoga::Logger (class)">Logger</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Logger.html#initialize-instance_method" title="MrLogaLoga::Logger#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='gvar'>$stdout</span><span class='rparen'>)</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> </div> </div> <div id="footer"> Generated on Wed Jan 5 09:59:09 2022 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.27 (ruby-3.0.0). </div> </div> </body> </html>