File: C:/Ruby27-x64/share/doc/ruby/html/CSV/FieldsConverter.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class CSV::FieldsConverter - 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="class">
<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="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="../Object.html">Object</a>
</div>
<div id="includes-section" class="nav-section">
<h3>Included Modules</h3>
<ul class="link-list">
<li><a class="include" href="../Enumerable.html">Enumerable</a>
</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-new">::new</a>
<li ><a href="#method-i-add_converter">#add_converter</a>
<li ><a href="#method-i-convert">#convert</a>
<li ><a href="#method-i-each">#each</a>
<li ><a href="#method-i-empty-3F">#empty?</a>
<li ><a href="#method-i-need_convert-3F">#need_convert?</a>
<li ><a href="#method-i-need_static_convert-3F">#need_static_convert?</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-CSV::FieldsConverter">
<h1 id="class-CSV::FieldsConverter" class="class">
class CSV::FieldsConverter
</h1>
<section class="description">
<p>Note: Don't use this class directly. This is an internal class.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(options={})</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>A <a href="FieldsConverter.html"><code>CSV::FieldsConverter</code></a> is a data structure for storing the fields converter properties to be passed as a parameter when parsing a new file (e.g. <a href="Parser.html#method-c-new"><code>CSV::Parser.new</code></a>(@io, parser_options))</p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/csv/fields_converter.rb, line 13</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">options</span>={})
<span class="ruby-ivar">@converters</span> = []
<span class="ruby-ivar">@nil_value</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:nil_value</span>]
<span class="ruby-ivar">@empty_value</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:empty_value</span>]
<span class="ruby-ivar">@empty_value_is_empty_string</span> = (<span class="ruby-ivar">@empty_value</span> <span class="ruby-operator">==</span> <span class="ruby-string">""</span>)
<span class="ruby-ivar">@accept_nil</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:accept_nil</span>]
<span class="ruby-ivar">@builtin_converters</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:builtin_converters</span>]
<span class="ruby-ivar">@need_static_convert</span> = <span class="ruby-identifier">need_static_convert?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-add_converter" class="method-detail ">
<div class="method-heading">
<span class="method-name">add_converter</span><span
class="method-args">(name=nil, &converter)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="add_converter-source">
<pre><span class="ruby-comment"># File lib/csv/fields_converter.rb, line 23</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">add_converter</span>(<span class="ruby-identifier">name</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">converter</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">name</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-comment"># custom converter</span>
<span class="ruby-ivar">@converters</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">converter</span>
<span class="ruby-keyword">else</span> <span class="ruby-comment"># named converter</span>
<span class="ruby-identifier">combo</span> = <span class="ruby-ivar">@builtin_converters</span>[<span class="ruby-identifier">name</span>]
<span class="ruby-keyword">case</span> <span class="ruby-identifier">combo</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">Array</span> <span class="ruby-comment"># combo converter</span>
<span class="ruby-identifier">combo</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">sub_name</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">add_converter</span>(<span class="ruby-identifier">sub_name</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">else</span> <span class="ruby-comment"># individual named converter</span>
<span class="ruby-ivar">@converters</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">combo</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-convert" class="method-detail ">
<div class="method-heading">
<span class="method-name">convert</span><span
class="method-args">(fields, headers, lineno)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="convert-source">
<pre><span class="ruby-comment"># File lib/csv/fields_converter.rb, line 47</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">convert</span>(<span class="ruby-identifier">fields</span>, <span class="ruby-identifier">headers</span>, <span class="ruby-identifier">lineno</span>)
<span class="ruby-keyword">return</span> <span class="ruby-identifier">fields</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">need_convert?</span>
<span class="ruby-identifier">fields</span>.<span class="ruby-identifier">collect</span>.<span class="ruby-identifier">with_index</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">field</span>, <span class="ruby-identifier">index</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">field</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-identifier">field</span> = <span class="ruby-ivar">@nil_value</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">field</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-identifier">field</span> = <span class="ruby-ivar">@empty_value</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@empty_value_is_empty_string</span>
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@converters</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">converter</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">break</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">field</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-keyword">and</span> <span class="ruby-ivar">@accept_nil</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">converter</span>.<span class="ruby-identifier">arity</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span> <span class="ruby-comment"># straight field converter</span>
<span class="ruby-identifier">field</span> = <span class="ruby-identifier">converter</span>[<span class="ruby-identifier">field</span>]
<span class="ruby-keyword">else</span> <span class="ruby-comment"># FieldInfo converter</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">headers</span>
<span class="ruby-identifier">header</span> = <span class="ruby-identifier">headers</span>[<span class="ruby-identifier">index</span>]
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">header</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">field</span> = <span class="ruby-identifier">converter</span>[<span class="ruby-identifier">field</span>, <span class="ruby-constant">FieldInfo</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">index</span>, <span class="ruby-identifier">lineno</span>, <span class="ruby-identifier">header</span>)]
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">break</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">field</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">String</span>) <span class="ruby-comment"># short-circuit pipeline for speed</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">field</span> <span class="ruby-comment"># final state of each field, converted or original</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-each" class="method-detail ">
<div class="method-heading">
<span class="method-name">each</span><span
class="method-args">(&block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="each-source">
<pre><span class="ruby-comment"># File lib/csv/fields_converter.rb, line 39</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">each</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-ivar">@converters</span>.<span class="ruby-identifier">each</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-empty-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">empty?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="empty-3F-source">
<pre><span class="ruby-comment"># File lib/csv/fields_converter.rb, line 43</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">empty?</span>
<span class="ruby-ivar">@converters</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="private-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Private Instance Methods</h3>
</header>
<div id="method-i-need_convert-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">need_convert?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="need_convert-3F-source">
<pre><span class="ruby-comment"># File lib/csv/fields_converter.rb, line 79</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">need_convert?</span>
<span class="ruby-ivar">@need_static_convert</span> <span class="ruby-keyword">or</span>
(<span class="ruby-keyword">not</span> <span class="ruby-ivar">@converters</span>.<span class="ruby-identifier">empty?</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-need_static_convert-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">need_static_convert?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="need_static_convert-3F-source">
<pre><span class="ruby-comment"># File lib/csv/fields_converter.rb, line 75</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">need_static_convert?</span>
<span class="ruby-keyword">not</span> (<span class="ruby-ivar">@nil_value</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-keyword">and</span> <span class="ruby-ivar">@empty_value_is_empty_string</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>