Gecko [ lorencats.com ]

Name	Size	Permission
Converter	[ DIR ]	drwxr-xr-x
Options	[ DIR ]	drwxr-xr-x
Parser	[ DIR ]	drwxr-xr-x
Utils	[ DIR ]	drwxr-xr-x
Converter.html	3.31 KB	-rw-r--r--
Document.html	13.8 KB	-rw-r--r--
Element.html	34.86 KB	-rw-r--r--
Error.html	2.52 KB	-rw-r--r--
Options.html	27.26 KB	-rw-r--r--
Parser.html	2.55 KB	-rw-r--r--
Utils.html	7.73 KB	-rw-r--r--

Code Editor : Options.html

<!DOCTYPE html>

<title>module Kramdown::Options - 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="sections-section" class="nav-section">
 <h3>Sections</h3>

<ul class="link-list" role="directory">
 
 <li><a href="#5Buntitled-5D"></a></li>
 
 <li><a href="#Option+Definitions">Option Definitions</a></li>
 
 <li><a href="#Option+Validators">Option Validators</a></li>
 
 <li><a href="#Option+definitions">Option definitions</a></li>
 
 </ul>
</div>

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

<ul class="link-list" role="directory">
 
 <li ><a href="#method-c-defaults">::defaults</a>
 
 <li ><a href="#method-c-define">::define</a>
 
 <li ><a href="#method-c-defined-3F">::defined?</a>
 
 <li ><a href="#method-c-definitions">::definitions</a>
 
 <li ><a href="#method-c-merge">::merge</a>
 
 <li ><a href="#method-c-parse">::parse</a>
 
 <li ><a href="#method-c-simple_array_validator">::simple_array_validator</a>
 
 <li ><a href="#method-c-simple_hash_validator">::simple_hash_validator</a>
 
 <li ><a href="#method-c-str_to_sym">::str_to_sym</a>
 
 </ul>
</div>

</div>
</nav>

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

<section class="description">
 
This module defines all options that are used by parsers and/or converters
as well as providing methods to deal with the options.

</section>

</section>

<section id="Option+Definitions" class="documentation-section">
 
 <header class="documentation-section-title">
 <h2>
 Option Definitions
 </h2>
 
 <a href="#top">&uarr; top</a>
 
 </header>

</section>

<section id="Option+Validators" class="documentation-section">
 
 <header class="documentation-section-title">
 <h2>
 Option Validators
 </h2>
 
 <a href="#top">&uarr; top</a>
 
 </header>

<section id="public-class-Option+Validators-method-details" class="method-section">
 <header>
 <h3>Public Class Methods</h3>
 </header>

<div id="method-c-simple_array_validator" class="method-detail ">
 
 <div class="method-heading">
 simple_array_validator(val, name, size = nil)
 
 click to toggle source
 
 </div>

<div class="method-description">
 
 Ensures that the option value <code>val</code> for the option called
<code>name</code> is a valid array. The parameter <code>val</code> can be
<ul><li>
a comma separated string which is split into an array of values
</li><li>
or an array.
</li></ul>

Optionally, the array is checked for the correct size.

<div class="method-source-code" id="simple_array_validator-source">
 <pre># File lib/kramdown/options.rb, line 136
def self.simple_array_validator(val, name, size = nil)
 if String === val
 val = val.split(/,/)
 elsif !(Array === val)
 raise Kramdown::Error, &quot;Invalid type #{val.class} for option #{name}&quot;
 end
 if size &amp;&amp; val.size != size
 raise Kramdown::Error, &quot;Option #{name} needs exactly #{size} values&quot;
 end
 val
end</pre>
 </div>
 
 </div>

</div>

<div id="method-c-simple_hash_validator" class="method-detail ">
 
 <div class="method-heading">
 simple_hash_validator(val, name)
 
 click to toggle source
 
 </div>

<div class="method-description">
 
 Ensures that the option value <code>val</code> for the option called
<code>name</code> is a valid hash. The parameter <code>val</code> can be
<ul><li>
a hash in YAML format
</li><li>
or a Ruby Hash object.
</li></ul>

<div class="method-source-code" id="simple_hash_validator-source">
 <pre># File lib/kramdown/options.rb, line 153
def self.simple_hash_validator(val, name)
 if String === val
 begin
 val = YAML.load(val)
 rescue RuntimeError, ArgumentError, SyntaxError
 raise Kramdown::Error, &quot;Invalid YAML value for option #{name}&quot;
 end
 end
 raise Kramdown::Error, &quot;Invalid type #{val.class} for option #{name}&quot; if !(Hash === val)
 val
end</pre>
 </div>
 
 </div>

</div>

</section>
 
 </section>

<section id="Option+definitions" class="documentation-section">
 
 <header class="documentation-section-title">
 <h2>
 Option definitions
 </h2>
 
 <a href="#top">&uarr; top</a>
 
 </header>

<section class="constants-list">
 <header>
 <h3>Constants</h3>
 </header>
 <dl>
 
 <dt id="ALLOWED_TYPES">ALLOWED_TYPES
 
 <dd>Allowed option types.
 
 
 <dt id="Definition">Definition
 
 <dd>Struct class for storing the definition of an option.
 
 
 </dl>
 </section>

<section id="public-class-Option+definitions-method-details" class="method-section">
 <header>
 <h3>Public Class Methods</h3>
 </header>

<div id="method-c-defaults" class="method-detail ">
 
 <div class="method-heading">
 defaults()
 
 click to toggle source
 
 </div>

<div class="method-description">
 
 Return a Hash with the default values for all options.

<div class="method-source-code" id="defaults-source">
 <pre># File lib/kramdown/options.rb, line 69
def self.defaults
 temp = {}
 @options.each {|n, o| temp[o.name] = o.default}
 temp
end</pre>
 </div>
 
 </div>

</div>

<div id="method-c-define" class="method-detail ">
 
 <div class="method-heading">
 define(name, type, default, desc, &amp;block)
 
 click to toggle source
 
 </div>

<div class="method-description">
 
 Define a new option called <code>name</code> (a Symbol) with the given
<code>type</code> (String, Integer, Float, Symbol, <a
href="Options/Boolean.html">Boolean</a>, Object), default value
<code>default</code> and the description <code>desc</code>. If a block is
specified, it should validate the value and either raise an error or return
a valid value.

The type &#39;Object&#39; should only be used for complex types for which
none of the other types suffices. A block needs to be specified when using
type &#39;Object&#39; and it has to cope with a value given as string and
as the opaque type.

<div class="method-source-code" id="define-source">
 <pre># File lib/kramdown/options.rb, line 49
def self.define(name, type, default, desc, &amp;block)
 name = name.to_sym
 raise ArgumentError, &quot;Option name #{name} is already used&quot; if @options.has_key?(name)
 raise ArgumentError, &quot;Invalid option type #{type} specified&quot; if !ALLOWED_TYPES.include?(type)
 raise ArgumentError, &quot;Invalid type for default value&quot; if !(type === default) &amp;&amp; !default.nil?
 raise ArgumentError, &quot;Missing validator block&quot; if type == Object &amp;&amp; block.nil?
 @options[name] = Definition.new(name, type, default, desc, block)
end</pre>
 </div>
 
 </div>

</div>

<div id="method-c-defined-3F" class="method-detail ">
 
 <div class="method-heading">
 defined?(name)
 
 click to toggle source
 
 </div>

<div class="method-description">
 
 Return <code>true</code> if an option called <code>name</code> is defined.

<div class="method-source-code" id="defined-3F-source">
 <pre># File lib/kramdown/options.rb, line 64
def self.defined?(name)
 @options.has_key?(name.to_sym)
end</pre>
 </div>
 
 </div>

</div>

<div id="method-c-definitions" class="method-detail ">
 
 <div class="method-heading">
 definitions()
 
 click to toggle source
 
 </div>

<div class="method-description">
 
 Return all option definitions.

<div class="method-source-code" id="definitions-source">
 <pre># File lib/kramdown/options.rb, line 59
def self.definitions
 @options
end</pre>
 </div>
 
 </div>

</div>

<div id="method-c-merge" class="method-detail ">
 
 <div class="method-heading">
 merge(hash)
 
 click to toggle source
 
 </div>

<div class="method-description">
 
 Merge the defaults Hash with the parsed options from the
given Hash, i.e. only valid option names are considered and their value is
run through the parse method.

<div class="method-source-code" id="merge-source">
 <pre># File lib/kramdown/options.rb, line 77
def self.merge(hash)
 temp = defaults
 hash.each do |k,v|
 k = k.to_sym
 @options.has_key?(k) ? temp[k] = parse(k, v) : temp[k] = v
 end
 temp
end</pre>
 </div>
 
 </div>

</div>

<div id="method-c-parse" class="method-detail ">
 
 <div class="method-heading">
 parse(name, data)
 
 click to toggle source
 
 </div>

<div class="method-description">
 
 Parse the given value <code>data</code> as if it was a value for the option
<code>name</code> and return the parsed value with the correct type.

If <code>data</code> already has the correct type, it is just returned.
Otherwise it is converted to a String and then to the correct type.

<div class="method-source-code" id="parse-source">
 <pre># File lib/kramdown/options.rb, line 91
def self.parse(name, data)
 name = name.to_sym
 raise ArgumentError, &quot;No option named #{name} defined&quot; if !@options.has_key?(name)
 if !(@options[name].type === data)
 data = data.to_s
 data = if @options[name].type == String
 data
 elsif @options[name].type == Integer
 Integer(data) rescue raise Kramdown::Error, &quot;Invalid integer value for option &#39;#{name}&#39;: &#39;#{data}&#39;&quot;
 elsif @options[name].type == Float
 Float(data) rescue raise Kramdown::Error, &quot;Invalid float value for option &#39;#{name}&#39;: &#39;#{data}&#39;&quot;
 elsif @options[name].type == Symbol
 str_to_sym(data)
 elsif @options[name].type == Boolean
 data.downcase.strip != &#39;false&#39; &amp;&amp; !data.empty?
 end
 end
 data = @options[name].validator[data] if @options[name].validator
 data
end</pre>
 </div>
 
 </div>

</div>

<div id="method-c-str_to_sym" class="method-detail ">
 
 <div class="method-heading">
 str_to_sym(data)
 
 click to toggle source
 
 </div>

<div class="method-description">
 
 Converts the given String <code>data</code> into a Symbol or
<code>nil</code> with the following provisions:
<ul><li>
A leading colon is stripped from the string.
</li><li>
An empty value or a value equal to “nil” results in <code>nil</code>.
</li></ul>

<div class="method-source-code" id="str_to_sym-source">
 <pre># File lib/kramdown/options.rb, line 117
def self.str_to_sym(data)
 data = data.strip
 data = data[1..-1] if data[0] == ?:
 (data.empty? || data == &#39;nil&#39; ? nil : data.to_sym)
end</pre>
 </div>
 
 </div>

</div>

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

<footer id="validator-badges" role="contentinfo">
 <a href="https://validator.w3.org/check/referer">Validate</a>
 Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.0.1.
 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 : Options.html