File: C:/Ruby27-x64/share/doc/ruby/html/Bundler/YAMLSerializer.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module Bundler::YAMLSerializer - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></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">
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-i-convert_to_backward_compatible_key">#convert_to_backward_compatible_key</a>
<li ><a href="#method-i-dump">#dump</a>
<li ><a href="#method-i-dump_hash">#dump_hash</a>
<li ><a href="#method-i-load">#load</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-Bundler::YAMLSerializer">
<h1 id="module-Bundler::YAMLSerializer" class="module">
module Bundler::YAMLSerializer
</h1>
<section class="description">
<p>A stub yaml serializer that can handle only hashes and strings (as of now).</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="ARRAY_REGEX">ARRAY_REGEX
<dd>
<dt id="HASH_REGEX">HASH_REGEX
<dd>
</dl>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-convert_to_backward_compatible_key" class="method-detail ">
<div class="method-heading">
<span class="method-name">convert_to_backward_compatible_key</span><span
class="method-args">(key)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>for settings' keys</p>
<div class="method-source-code" id="convert_to_backward_compatible_key-source">
<pre><span class="ruby-comment"># File lib/bundler/yaml_serializer.rb, line 79</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">convert_to_backward_compatible_key</span>(<span class="ruby-identifier">key</span>)
<span class="ruby-identifier">key</span> = <span class="ruby-node">"#{key}/"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">key</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/https?:/i</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">key</span> <span class="ruby-operator">!~</span> <span class="ruby-regexp">%r{/\Z}</span>
<span class="ruby-identifier">key</span> = <span class="ruby-identifier">key</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-string">"."</span>, <span class="ruby-string">"__"</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">key</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-string">"."</span>)
<span class="ruby-identifier">key</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-dump" class="method-detail ">
<div class="method-heading">
<span class="method-name">dump</span><span
class="method-args">(hash)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="dump-source">
<pre><span class="ruby-comment"># File lib/bundler/yaml_serializer.rb, line 8</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">dump</span>(<span class="ruby-identifier">hash</span>)
<span class="ruby-identifier">yaml</span> = <span class="ruby-constant">String</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"---"</span>)
<span class="ruby-identifier">yaml</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">dump_hash</span>(<span class="ruby-identifier">hash</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-dump_hash" class="method-detail ">
<div class="method-heading">
<span class="method-name">dump_hash</span><span
class="method-args">(hash)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="dump_hash-source">
<pre><span class="ruby-comment"># File lib/bundler/yaml_serializer.rb, line 13</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">dump_hash</span>(<span class="ruby-identifier">hash</span>)
<span class="ruby-identifier">yaml</span> = <span class="ruby-constant">String</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"\n"</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">yaml</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">k</span> <span class="ruby-operator"><<</span> <span class="ruby-string">":"</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">v</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>)
<span class="ruby-identifier">yaml</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">dump_hash</span>(<span class="ruby-identifier">v</span>).<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/^(?!$)/</span>, <span class="ruby-string">" "</span>) <span class="ruby-comment"># indent all non-empty lines</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">v</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Array</span>) <span class="ruby-comment"># Expected to be array of strings</span>
<span class="ruby-identifier">yaml</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"\n- "</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">v</span>.<span class="ruby-identifier">map</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/\s+/</span>, <span class="ruby-string">" "</span>).<span class="ruby-identifier">inspect</span> }.<span class="ruby-identifier">join</span>(<span class="ruby-string">"\n- "</span>) <span class="ruby-operator"><<</span> <span class="ruby-string">"\n"</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">yaml</span> <span class="ruby-operator"><<</span> <span class="ruby-string">" "</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">v</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/\s+/</span>, <span class="ruby-string">" "</span>).<span class="ruby-identifier">inspect</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"\n"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">yaml</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-load" class="method-detail ">
<div class="method-heading">
<span class="method-name">load</span><span
class="method-args">(str)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="load-source">
<pre><span class="ruby-comment"># File lib/bundler/yaml_serializer.rb, line 49</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">load</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-identifier">res</span> = {}
<span class="ruby-identifier">stack</span> = [<span class="ruby-identifier">res</span>]
<span class="ruby-identifier">last_hash</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-identifier">last_empty_key</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-identifier">str</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp">/\r?\n/</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">line</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">match</span> = <span class="ruby-constant">HASH_REGEX</span>.<span class="ruby-identifier">match</span>(<span class="ruby-identifier">line</span>)
<span class="ruby-identifier">indent</span>, <span class="ruby-identifier">key</span>, <span class="ruby-identifier">quote</span>, <span class="ruby-identifier">val</span> = <span class="ruby-identifier">match</span>.<span class="ruby-identifier">captures</span>
<span class="ruby-identifier">key</span> = <span class="ruby-identifier">convert_to_backward_compatible_key</span>(<span class="ruby-identifier">key</span>)
<span class="ruby-identifier">depth</span> = <span class="ruby-identifier">indent</span>.<span class="ruby-identifier">scan</span>(<span class="ruby-regexp">/ /</span>).<span class="ruby-identifier">length</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">quote</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-identifier">new_hash</span> = {}
<span class="ruby-identifier">stack</span>[<span class="ruby-identifier">depth</span>][<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">new_hash</span>
<span class="ruby-identifier">stack</span>[<span class="ruby-identifier">depth</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>] = <span class="ruby-identifier">new_hash</span>
<span class="ruby-identifier">last_empty_key</span> = <span class="ruby-identifier">key</span>
<span class="ruby-identifier">last_hash</span> = <span class="ruby-identifier">stack</span>[<span class="ruby-identifier">depth</span>]
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">stack</span>[<span class="ruby-identifier">depth</span>][<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">val</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">match</span> = <span class="ruby-constant">ARRAY_REGEX</span>.<span class="ruby-identifier">match</span>(<span class="ruby-identifier">line</span>)
<span class="ruby-identifier">_</span>, <span class="ruby-identifier">val</span> = <span class="ruby-identifier">match</span>.<span class="ruby-identifier">captures</span>
<span class="ruby-identifier">last_hash</span>[<span class="ruby-identifier">last_empty_key</span>] = [] <span class="ruby-keyword">unless</span> <span class="ruby-identifier">last_hash</span>[<span class="ruby-identifier">last_empty_key</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Array</span>)
<span class="ruby-identifier">last_hash</span>[<span class="ruby-identifier">last_empty_key</span>].<span class="ruby-identifier">push</span>(<span class="ruby-identifier">val</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">res</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.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>