/usr/share/doc/ruby-kramdown/rdoc/Kramdown/Options.html is in ruby-kramdown 1.15.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 | <!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module Kramdown::Options - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
</script>
<script src="../js/jquery.js"></script>
<script src="../js/darkfish.js"></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="module">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<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 id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</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>
<!-- Method Quickref -->
<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">
<p>This module defines all options that are used by parsers and/or converters
as well as providing methods to deal with the options.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
</section>
<section id="Option+Definitions" class="documentation-section">
<header class="documentation-section-title">
<h2>
Option Definitions
</h2>
<span class="section-click-top">
<a href="#top">↑ top</a>
</span>
</header>
</section>
<section id="Option+Validators" class="documentation-section">
<header class="documentation-section-title">
<h2>
Option Validators
</h2>
<span class="section-click-top">
<a href="#top">↑ top</a>
</span>
</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">
<span class="method-name">simple_array_validator</span><span
class="method-args">(val, name, size = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>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</p>
<ul><li>
<p>a comma separated string which is split into an array of values</p>
</li><li>
<p>or an array.</p>
</li></ul>
<p>Optionally, the array is checked for the correct size.</p>
<div class="method-source-code" id="simple_array_validator-source">
<pre><span class="ruby-comment"># File lib/kramdown/options.rb, line 136</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">simple_array_validator</span>(<span class="ruby-identifier">val</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">size</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-keyword">if</span> <span class="ruby-constant">String</span> <span class="ruby-operator">===</span> <span class="ruby-identifier">val</span>
<span class="ruby-identifier">val</span> = <span class="ruby-identifier">val</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp">/,/</span>)
<span class="ruby-keyword">elsif</span> <span class="ruby-operator">!</span>(<span class="ruby-constant">Array</span> <span class="ruby-operator">===</span> <span class="ruby-identifier">val</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Kramdown</span><span class="ruby-operator">::</span><span class="ruby-constant">Error</span>, <span class="ruby-node">"Invalid type #{val.class} for option #{name}"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">size</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">size</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Kramdown</span><span class="ruby-operator">::</span><span class="ruby-constant">Error</span>, <span class="ruby-node">"Option #{name} needs exactly #{size} values"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">val</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-simple_hash_validator" class="method-detail ">
<div class="method-heading">
<span class="method-name">simple_hash_validator</span><span
class="method-args">(val, name)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>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</p>
<ul><li>
<p>a hash in YAML format</p>
</li><li>
<p>or a Ruby Hash object.</p>
</li></ul>
<div class="method-source-code" id="simple_hash_validator-source">
<pre><span class="ruby-comment"># File lib/kramdown/options.rb, line 153</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">simple_hash_validator</span>(<span class="ruby-identifier">val</span>, <span class="ruby-identifier">name</span>)
<span class="ruby-keyword">if</span> <span class="ruby-constant">String</span> <span class="ruby-operator">===</span> <span class="ruby-identifier">val</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">val</span> = <span class="ruby-constant">YAML</span>.<span class="ruby-identifier">load</span>(<span class="ruby-identifier">val</span>)
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">RuntimeError</span>, <span class="ruby-constant">ArgumentError</span>, <span class="ruby-constant">SyntaxError</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Kramdown</span><span class="ruby-operator">::</span><span class="ruby-constant">Error</span>, <span class="ruby-node">"Invalid YAML value for option #{name}"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Kramdown</span><span class="ruby-operator">::</span><span class="ruby-constant">Error</span>, <span class="ruby-node">"Invalid type #{val.class} for option #{name}"</span> <span class="ruby-keyword">if</span> <span class="ruby-operator">!</span>(<span class="ruby-constant">Hash</span> <span class="ruby-operator">===</span> <span class="ruby-identifier">val</span>)
<span class="ruby-identifier">val</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
<section id="Option+definitions" class="documentation-section">
<header class="documentation-section-title">
<h2>
Option definitions
</h2>
<span class="section-click-top">
<a href="#top">↑ top</a>
</span>
</header>
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="ALLOWED_TYPES">ALLOWED_TYPES
<dd><p>Allowed option types.</p>
<dt id="Definition">Definition
<dd><p>Struct class for storing the definition of an option.</p>
</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">
<span class="method-name">defaults</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Return a Hash with the default values for all options.</p>
<div class="method-source-code" id="defaults-source">
<pre><span class="ruby-comment"># File lib/kramdown/options.rb, line 69</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">defaults</span>
<span class="ruby-identifier">temp</span> = {}
<span class="ruby-ivar">@options</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">n</span>, <span class="ruby-identifier">o</span><span class="ruby-operator">|</span> <span class="ruby-identifier">temp</span>[<span class="ruby-identifier">o</span>.<span class="ruby-identifier">name</span>] = <span class="ruby-identifier">o</span>.<span class="ruby-identifier">default</span>}
<span class="ruby-identifier">temp</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-define" class="method-detail ">
<div class="method-heading">
<span class="method-name">define</span><span
class="method-args">(name, type, default, desc, &block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>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.</p>
<p>The type 'Object' should only be used for complex types for which
none of the other types suffices. A block needs to be specified when using
type 'Object' and it has to cope with a value given as string and
as the opaque type.</p>
<div class="method-source-code" id="define-source">
<pre><span class="ruby-comment"># File lib/kramdown/options.rb, line 49</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">define</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">type</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">desc</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">name</span> = <span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_sym</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">"Option name #{name} is already used"</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@options</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">"Invalid option type #{type} specified"</span> <span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-constant">ALLOWED_TYPES</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">type</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"Invalid type for default value"</span> <span class="ruby-keyword">if</span> <span class="ruby-operator">!</span>(<span class="ruby-identifier">type</span> <span class="ruby-operator">===</span> <span class="ruby-identifier">default</span>) <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-identifier">default</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"Missing validator block"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">type</span> <span class="ruby-operator">==</span> <span class="ruby-constant">Object</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">block</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-ivar">@options</span>[<span class="ruby-identifier">name</span>] = <span class="ruby-constant">Definition</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">type</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">desc</span>, <span class="ruby-identifier">block</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-defined-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">defined?</span><span
class="method-args">(name)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Return <code>true</code> if an option called <code>name</code> is defined.</p>
<div class="method-source-code" id="defined-3F-source">
<pre><span class="ruby-comment"># File lib/kramdown/options.rb, line 64</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-keyword">defined?</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-ivar">@options</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_sym</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-definitions" class="method-detail ">
<div class="method-heading">
<span class="method-name">definitions</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Return all option definitions.</p>
<div class="method-source-code" id="definitions-source">
<pre><span class="ruby-comment"># File lib/kramdown/options.rb, line 59</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">definitions</span>
<span class="ruby-ivar">@options</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-merge" class="method-detail ">
<div class="method-heading">
<span class="method-name">merge</span><span
class="method-args">(hash)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Merge the defaults Hash with the <strong>parsed</strong> options from the
given Hash, i.e. only valid option names are considered and their value is
run through the parse method.</p>
<div class="method-source-code" id="merge-source">
<pre><span class="ruby-comment"># File lib/kramdown/options.rb, line 77</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">hash</span>)
<span class="ruby-identifier">temp</span> = <span class="ruby-identifier">defaults</span>
<span class="ruby-identifier">hash</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>,<span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">k</span> = <span class="ruby-identifier">k</span>.<span class="ruby-identifier">to_sym</span>
<span class="ruby-ivar">@options</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-identifier">k</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">temp</span>[<span class="ruby-identifier">k</span>] = <span class="ruby-identifier">parse</span>(<span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span>) <span class="ruby-operator">:</span> <span class="ruby-identifier">temp</span>[<span class="ruby-identifier">k</span>] = <span class="ruby-identifier">v</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">temp</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-parse" class="method-detail ">
<div class="method-heading">
<span class="method-name">parse</span><span
class="method-args">(name, data)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>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.</p>
<p>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.</p>
<div class="method-source-code" id="parse-source">
<pre><span class="ruby-comment"># File lib/kramdown/options.rb, line 91</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">data</span>)
<span class="ruby-identifier">name</span> = <span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_sym</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">"No option named #{name} defined"</span> <span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-ivar">@options</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-keyword">if</span> <span class="ruby-operator">!</span>(<span class="ruby-ivar">@options</span>[<span class="ruby-identifier">name</span>].<span class="ruby-identifier">type</span> <span class="ruby-operator">===</span> <span class="ruby-identifier">data</span>)
<span class="ruby-identifier">data</span> = <span class="ruby-identifier">data</span>.<span class="ruby-identifier">to_s</span>
<span class="ruby-identifier">data</span> = <span class="ruby-keyword">if</span> <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">name</span>].<span class="ruby-identifier">type</span> <span class="ruby-operator">==</span> <span class="ruby-constant">String</span>
<span class="ruby-identifier">data</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">name</span>].<span class="ruby-identifier">type</span> <span class="ruby-operator">==</span> <span class="ruby-constant">Integer</span>
<span class="ruby-constant">Integer</span>(<span class="ruby-identifier">data</span>) <span class="ruby-keyword">rescue</span> <span class="ruby-identifier">raise</span> <span class="ruby-constant">Kramdown</span><span class="ruby-operator">::</span><span class="ruby-constant">Error</span>, <span class="ruby-node">"Invalid integer value for option '#{name}': '#{data}'"</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">name</span>].<span class="ruby-identifier">type</span> <span class="ruby-operator">==</span> <span class="ruby-constant">Float</span>
<span class="ruby-constant">Float</span>(<span class="ruby-identifier">data</span>) <span class="ruby-keyword">rescue</span> <span class="ruby-identifier">raise</span> <span class="ruby-constant">Kramdown</span><span class="ruby-operator">::</span><span class="ruby-constant">Error</span>, <span class="ruby-node">"Invalid float value for option '#{name}': '#{data}'"</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">name</span>].<span class="ruby-identifier">type</span> <span class="ruby-operator">==</span> <span class="ruby-constant">Symbol</span>
<span class="ruby-identifier">str_to_sym</span>(<span class="ruby-identifier">data</span>)
<span class="ruby-keyword">elsif</span> <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">name</span>].<span class="ruby-identifier">type</span> <span class="ruby-operator">==</span> <span class="ruby-constant">Boolean</span>
<span class="ruby-identifier">data</span>.<span class="ruby-identifier">downcase</span>.<span class="ruby-identifier">strip</span> <span class="ruby-operator">!=</span> <span class="ruby-string">'false'</span> <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-identifier">data</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">data</span> = <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">name</span>].<span class="ruby-identifier">validator</span>[<span class="ruby-identifier">data</span>] <span class="ruby-keyword">if</span> <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">name</span>].<span class="ruby-identifier">validator</span>
<span class="ruby-identifier">data</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-str_to_sym" class="method-detail ">
<div class="method-heading">
<span class="method-name">str_to_sym</span><span
class="method-args">(data)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Converts the given String <code>data</code> into a Symbol or
<code>nil</code> with the following provisions:</p>
<ul><li>
<p>A leading colon is stripped from the string.</p>
</li><li>
<p>An empty value or a value equal to “nil” results in <code>nil</code>.</p>
</li></ul>
<div class="method-source-code" id="str_to_sym-source">
<pre><span class="ruby-comment"># File lib/kramdown/options.rb, line 117</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">str_to_sym</span>(<span class="ruby-identifier">data</span>)
<span class="ruby-identifier">data</span> = <span class="ruby-identifier">data</span>.<span class="ruby-identifier">strip</span>
<span class="ruby-identifier">data</span> = <span class="ruby-identifier">data</span>[<span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>] <span class="ruby-keyword">if</span> <span class="ruby-identifier">data</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-value">?:</span>
(<span class="ruby-identifier">data</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">data</span> <span class="ruby-operator">==</span> <span class="ruby-string">'nil'</span> <span class="ruby-operator">?</span> <span class="ruby-keyword">nil</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">data</span>.<span class="ruby-identifier">to_sym</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="http://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>
|