docs/code/Utopia/Content/SymbolicHash.html in utopia-2.5.5 vs docs/code/Utopia/Content/SymbolicHash.html in utopia-2.6.0

- old
+ new

@@ -1,419 +1,419 @@ -<!DOCTYPE html> -<html> - <head> - <meta charset="utf-8"> -<meta name="viewport" content="width=device-width, initial-scale=1.0"> -<title> - Class: Utopia::Content::SymbolicHash - - &mdash; Documentation by YARD 0.9.12 - -</title> - - <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" /> - - <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" /> - -<script type="text/javascript" charset="utf-8"> - pathId = "Utopia::Content::SymbolicHash"; - 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 (S)</a> &raquo; - <span class='title'><span class='object_link'><a href="../../Utopia.html" title="Utopia (module)">Utopia</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Content.html" title="Utopia::Content (class)">Content</a></span></span> - &raquo; - <span class="title">SymbolicHash</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: Utopia::Content::SymbolicHash - - - -</h1> -<div class="box_info"> - - <dl> - <dt>Inherits:</dt> - <dd> - <span class="inheritName">Hash</span> - - <ul class="fullTree"> - <li>Object</li> - - <li class="next">Hash</li> - - <li class="next">Utopia::Content::SymbolicHash</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - </dl> - - - - - - - - - - - - <dl> - <dt>Defined in:</dt> - <dd>lib/utopia/content/markup.rb</dd> - </dl> - -</div> - -<h2>Overview</h2><div class="docstring"> - <div class="discussion"> +<!DOCTYPE html> +<html> + <head> + <meta charset="utf-8"> +<meta name="viewport" content="width=device-width, initial-scale=1.0"> +<title> + Class: Utopia::Content::SymbolicHash + + &mdash; Documentation by YARD 0.9.18 + +</title> + + <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" /> + + <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" /> + +<script type="text/javascript" charset="utf-8"> + pathId = "Utopia::Content::SymbolicHash"; + 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 (S)</a> &raquo; + <span class='title'><span class='object_link'><a href="../../Utopia.html" title="Utopia (module)">Utopia</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Content.html" title="Utopia::Content (class)">Content</a></span></span> + &raquo; + <span class="title">SymbolicHash</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: Utopia::Content::SymbolicHash + + + +</h1> +<div class="box_info"> + + <dl> + <dt>Inherits:</dt> + <dd> + <span class="inheritName">Hash</span> + + <ul class="fullTree"> + <li>Object</li> + + <li class="next">Hash</li> + + <li class="next">Utopia::Content::SymbolicHash</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + </dl> + + + + + + + + + + + + <dl> + <dt>Defined in:</dt> + <dd>lib/utopia/content/markup.rb</dd> + </dl> + +</div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> <p>A hash which forces all keys to be symbols and fails with KeyError when strings are used.</p> - - - </div> -</div> -<div class="tags"> - - -</div> - - - - - - - - <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="#[]-instance_method" title="#[] (instance method)">#<strong>[]</strong>(key) &#x21d2; Object </a> - - - - </span> - - - - - - - - - + + + </div> +</div> +<div class="tags"> + + +</div> + + + + + + + + <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="#[]-instance_method" title="#[] (instance method)">#<strong>[]</strong>(key) &#x21d2; Object </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#[]=-instance_method" title="#[]= (instance method)">#<strong>[]=</strong>(key, value) &#x21d2; Object </a> - - - - </span> - - - - - - - - - +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#[]=-instance_method" title="#[]= (instance method)">#<strong>[]=</strong>(key, value) &#x21d2; Object </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#fetch-instance_method" title="#fetch (instance method)">#<strong>fetch</strong>(key, *args, &amp;block) &#x21d2; Object </a> - - - - </span> - - - - - - - - - +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#fetch-instance_method" title="#fetch (instance method)">#<strong>fetch</strong>(key, *args, &amp;block) &#x21d2; Object </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#include%3F-instance_method" title="#include? (instance method)">#<strong>include?</strong>(key) &#x21d2; Boolean </a> - - - - </span> - - - - - - - - - +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#include%3F-instance_method" title="#include? (instance method)">#<strong>include?</strong>(key) &#x21d2; Boolean </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'> -</div></span> - -</li> - - - </ul> - - - - - - <div id="instance_method_details" class="method_details_list"> - <h2>Instance Method Details</h2> - +</div></span> + +</li> + + + </ul> + + + + + + <div id="instance_method_details" class="method_details_list"> + <h2>Instance Method Details</h2> + + + <div class="method_details first"> + <h3 class="signature first" id="[]-instance_method"> + + #<strong>[]</strong>(key) &#x21d2; <tt>Object</tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> - <div class="method_details first"> - <h3 class="signature first" id="[]-instance_method"> - - #<strong>[]</strong>(key) &#x21d2; <tt>Object</tt> - - - - - -</h3><div class="docstring"> - <div class="discussion"> - - - - </div> -</div> -<div class="tags"> - -<p class="tag_title">Raises:</p> -<ul class="raise"> - - <li> - - - <span class='type'>(<tt>KeyError</tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> + + + </div> +</div> +<div class="tags"> + +<p class="tag_title">Raises:</p> +<ul class="raise"> + + <li> + + + <span class='type'>(<tt>KeyError</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> <pre class="lines"> 32 33 34 -35</pre> - </td> - <td> +35</pre> + </td> + <td> <pre class="code"><span class="info file"># File 'lib/utopia/content/markup.rb', line 32</span> <span class='kw'>def</span> <span class='op'>[]</span> <span class='id identifier rubyid_key'>key</span> <span class='id identifier rubyid_raise'>raise</span> <span class='const'>KeyError</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>attribute </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_key'>key</span><span class='embexpr_end'>}</span><span class='tstring_content'> is a string, prefer a symbol</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_key'>key</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>String</span> <span class='kw'>super</span> <span class='id identifier rubyid_key'>key</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span> -<span class='kw'>end</span></pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <h3 class="signature " id="[]=-instance_method"> - - #<strong>[]=</strong>(key, value) &#x21d2; <tt>Object</tt> - - - - - -</h3><table class="source_code"> - <tr> - <td> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <h3 class="signature " id="[]=-instance_method"> + + #<strong>[]=</strong>(key, value) &#x21d2; <tt>Object</tt> + + + + + +</h3><table class="source_code"> + <tr> + <td> <pre class="lines"> 37 38 -39</pre> - </td> - <td> +39</pre> + </td> + <td> <pre class="code"><span class="info file"># File 'lib/utopia/content/markup.rb', line 37</span> <span class='kw'>def</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='kw'>super</span> <span class='id identifier rubyid_key'>key</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span> -<span class='kw'>end</span></pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <h3 class="signature " id="fetch-instance_method"> - - #<strong>fetch</strong>(key, *args, &amp;block) &#x21d2; <tt>Object</tt> - - - - - -</h3><table class="source_code"> - <tr> - <td> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <h3 class="signature " id="fetch-instance_method"> + + #<strong>fetch</strong>(key, *args, &amp;block) &#x21d2; <tt>Object</tt> + + + + + +</h3><table class="source_code"> + <tr> + <td> <pre class="lines"> 41 42 43 44 -45</pre> - </td> - <td> +45</pre> + </td> + <td> <pre class="code"><span class="info file"># File 'lib/utopia/content/markup.rb', line 41</span> <span class='kw'>def</span> <span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span> <span class='id identifier rubyid_key'>key</span> <span class='op'>=</span> <span class='id identifier rubyid_key'>key</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span> <span class='kw'>super</span> -<span class='kw'>end</span></pre> - </td> - </tr> -</table> -</div> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <h3 class="signature " id="include?-instance_method"> + + #<strong>include?</strong>(key) &#x21d2; <tt>Boolean</tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> - <div class="method_details "> - <h3 class="signature " id="include?-instance_method"> - - #<strong>include?</strong>(key) &#x21d2; <tt>Boolean</tt> - - - - - -</h3><div class="docstring"> - <div class="discussion"> - - - - </div> -</div> -<div class="tags"> - -<p class="tag_title">Returns:</p> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Boolean</tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> + + + </div> +</div> +<div class="tags"> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> <pre class="lines"> 47 48 49 50 -51</pre> - </td> - <td> +51</pre> + </td> + <td> <pre class="code"><span class="info file"># File 'lib/utopia/content/markup.rb', line 47</span> <span class='kw'>def</span> <span class='id identifier rubyid_include?'>include?</span> <span class='id identifier rubyid_key'>key</span> <span class='id identifier rubyid_key'>key</span> <span class='op'>=</span> <span class='id identifier rubyid_key'>key</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span> <span class='kw'>super</span> -<span class='kw'>end</span></pre> - </td> - </tr> -</table> -</div> - - </div> - -</div> - - <div id="footer"> - Generated on Sat Mar 24 21:17:21 2018 by - <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.9.12 (ruby-2.5.0). -</div> - - </div> - </body> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sat Mar 9 12:01:54 2019 by + <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> + 0.9.18 (ruby-2.6.1). +</div> + + </div> + </body> </html> \ No newline at end of file