Gecko [ lorencats.com ]

Name	Size	Permission
Entities	[ DIR ]	drwxr-xr-x
Configurable.html	6.66 KB	-rw-r--r--
Entities.html	5.71 KB	-rw-r--r--
Html.html	10.46 KB	-rw-r--r--
LRUCache.html	7.21 KB	-rw-r--r--
StringScanner.html	12.66 KB	-rw-r--r--
Unidecoder.html	3.9 KB	-rw-r--r--

Code Editor : Configurable.html

<!DOCTYPE html>

<title>module Kramdown::Utils::Configurable - RDoc Documentation</title>

<div id="table-of-contents-navigation">
    <a href="../../table_of_contents.html#pages">Pages</a>
    <a href="../../table_of_contents.html#classes">Classes</a>
    <a href="../../table_of_contents.html#methods">Methods</a>
  </div>
</div>

</div>

<div id="class-metadata">
    
    
    
    
    
<div id="method-list-section" class="nav-section">
  <h3>Methods</h3>

<ul class="link-list" role="directory">
    
    <li ><a href="#method-i-configurable">#configurable</a>
    
  </ul>
</div>

</div>
</nav>

<main role="main" aria-labelledby="module-Kramdown::Utils::Configurable">
  <h1 id="module-Kramdown::Utils::Configurable" class="module">
    module Kramdown::Utils::Configurable
  </h1>

<section class="description">
    
<p>Methods for registering configurable extensions.</p>

</section>

<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
       <header>
         <h3>Public Instance Methods</h3>
       </header>

<div id="method-i-configurable" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">configurable</span><span
            class="method-args">(name)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>

<div class="method-description">
          
          <p>Create a new configurable extension called <code>name</code>.</p>

<p>Three methods will be defined on the calling object which allow to use this
configurable extension:</p>
<dl class="rdoc-list note-list"><dt>configurables
<dd>
<p>Returns a hash of hashes that is used to store all configurables of the
object.</p>
</dd><dt>&lt;name&gt;(ext_name)
<dd>
<p>Return the configured extension <code>ext_name</code>.</p>
</dd><dt>add_&lt;name&gt;(ext_name, data=nil, &amp;block)
<dd>
<p>Define an extension <code>ext_name</code> by specifying either the data as
argument or by using a block.</p>
</dd></dl>

<div class="method-source-code" id="configurable-source">
            <pre><span class="ruby-comment"># File lib/kramdown/utils/configurable.rb, line 27</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">configurable</span>(<span class="ruby-identifier">name</span>)
  <span class="ruby-identifier">singleton_class</span> = (<span class="ruby-keyword">class</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-keyword">self</span>; <span class="ruby-keyword">self</span>; <span class="ruby-keyword">end</span>)
  <span class="ruby-identifier">singleton_class</span>.<span class="ruby-identifier">send</span>(<span class="ruby-value">:define_method</span>, <span class="ruby-value">:configurables</span>) <span class="ruby-keyword">do</span>
    <span class="ruby-ivar">@_configurables</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">h</span>, <span class="ruby-identifier">k</span><span class="ruby-operator">|</span> <span class="ruby-identifier">h</span>[<span class="ruby-identifier">k</span>] = {}}
  <span class="ruby-keyword">end</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:configurables</span>)
  <span class="ruby-identifier">singleton_class</span>.<span class="ruby-identifier">send</span>(<span class="ruby-value">:define_method</span>, <span class="ruby-identifier">name</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">data</span><span class="ruby-operator">|</span>
    <span class="ruby-identifier">configurables</span>[<span class="ruby-identifier">name</span>][<span class="ruby-identifier">data</span>]
  <span class="ruby-keyword">end</span>
  <span class="ruby-identifier">singleton_class</span>.<span class="ruby-identifier">send</span>(<span class="ruby-value">:define_method</span>, <span class="ruby-node">&quot;add_#{name}&quot;</span>.<span class="ruby-identifier">intern</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">data</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span><span class="ruby-operator">|</span>
    <span class="ruby-identifier">configurables</span>[<span class="ruby-identifier">name</span>][<span class="ruby-identifier">data</span>] = <span class="ruby-identifier">args</span>.<span class="ruby-identifier">first</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">block</span>
  <span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

</div>

</section>
  
  </section>
</main>

<footer id="validator-badges" role="contentinfo">
  <p><a href="https://validator.w3.org/check/referer">Validate</a>
  <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.0.1.
  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>

${this.title}

Code Editor : Configurable.html