File: C:/Ruby27-x64/share/doc/ruby/html/CSV/Writer.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class CSV::Writer - 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>
<!-- 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-3C-3C">#<<</a>
<li ><a href="#method-i-prepare">#prepare</a>
<li ><a href="#method-i-prepare_format">#prepare_format</a>
<li ><a href="#method-i-prepare_header">#prepare_header</a>
<li ><a href="#method-i-prepare_output">#prepare_output</a>
<li ><a href="#method-i-quote">#quote</a>
<li ><a href="#method-i-quote_field">#quote_field</a>
<li ><a href="#method-i-rewind">#rewind</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-CSV::Writer">
<h1 id="class-CSV::Writer" class="class">
class CSV::Writer
</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 class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-headers" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">headers</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-lineno" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">lineno</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>A <a href="Writer.html"><code>CSV::Writer</code></a> receives an output, prepares the header, format and output. It allows us to write new rows in the object and rewind it.</p>
</div>
</div>
</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">(output, options)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/csv/writer.rb, line 18</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">output</span>, <span class="ruby-identifier">options</span>)
<span class="ruby-ivar">@output</span> = <span class="ruby-identifier">output</span>
<span class="ruby-ivar">@options</span> = <span class="ruby-identifier">options</span>
<span class="ruby-ivar">@lineno</span> = <span class="ruby-value">0</span>
<span class="ruby-ivar">@fields_converter</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-identifier">prepare</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@options</span>[<span class="ruby-value">:write_headers</span>] <span class="ruby-keyword">and</span> <span class="ruby-ivar">@headers</span>
<span class="ruby-keyword">self</span> <span class="ruby-operator"><<</span> <span class="ruby-ivar">@headers</span>
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@fields_converter</span> = <span class="ruby-ivar">@options</span>[<span class="ruby-value">:fields_converter</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-3C-3C" class="method-detail ">
<div class="method-heading">
<span class="method-name"><<</span><span
class="method-args">(row)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Adds a new row</p>
<div class="method-source-code" id="3C-3C-source">
<pre><span class="ruby-comment"># File lib/csv/writer.rb, line 33</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title"><<</span>(<span class="ruby-identifier">row</span>)
<span class="ruby-keyword">case</span> <span class="ruby-identifier">row</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">Row</span>
<span class="ruby-identifier">row</span> = <span class="ruby-identifier">row</span>.<span class="ruby-identifier">fields</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">Hash</span>
<span class="ruby-identifier">row</span> = <span class="ruby-ivar">@headers</span>.<span class="ruby-identifier">collect</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">header</span><span class="ruby-operator">|</span> <span class="ruby-identifier">row</span>[<span class="ruby-identifier">header</span>]}
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@headers</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">row</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@use_headers</span>
<span class="ruby-ivar">@lineno</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
<span class="ruby-identifier">row</span> = <span class="ruby-ivar">@fields_converter</span>.<span class="ruby-identifier">convert</span>(<span class="ruby-identifier">row</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">lineno</span>) <span class="ruby-keyword">if</span> <span class="ruby-ivar">@fields_converter</span>
<span class="ruby-identifier">converted_row</span> = <span class="ruby-identifier">row</span>.<span class="ruby-identifier">collect</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">field</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">quote</span>(<span class="ruby-identifier">field</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">line</span> = <span class="ruby-identifier">converted_row</span>.<span class="ruby-identifier">join</span>(<span class="ruby-ivar">@column_separator</span>) <span class="ruby-operator">+</span> <span class="ruby-ivar">@row_separator</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@output_encoding</span>
<span class="ruby-identifier">line</span> = <span class="ruby-identifier">line</span>.<span class="ruby-identifier">encode</span>(<span class="ruby-ivar">@output_encoding</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@output</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">line</span>
<span class="ruby-keyword">self</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-rewind" class="method-detail ">
<div class="method-heading">
<span class="method-name">rewind</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Winds back to the beginning</p>
<div class="method-source-code" id="rewind-source">
<pre><span class="ruby-comment"># File lib/csv/writer.rb, line 61</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">rewind</span>
<span class="ruby-ivar">@lineno</span> = <span class="ruby-value">0</span>
<span class="ruby-ivar">@headers</span> = <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@options</span>[<span class="ruby-value">:headers</span>].<span class="ruby-identifier">nil?</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-prepare" class="method-detail ">
<div class="method-heading">
<span class="method-name">prepare</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="prepare-source">
<pre><span class="ruby-comment"># File lib/csv/writer.rb, line 67</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">prepare</span>
<span class="ruby-ivar">@encoding</span> = <span class="ruby-ivar">@options</span>[<span class="ruby-value">:encoding</span>]
<span class="ruby-identifier">prepare_header</span>
<span class="ruby-identifier">prepare_format</span>
<span class="ruby-identifier">prepare_output</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-prepare_format" class="method-detail ">
<div class="method-heading">
<span class="method-name">prepare_format</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="prepare_format-source">
<pre><span class="ruby-comment"># File lib/csv/writer.rb, line 103</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">prepare_format</span>
<span class="ruby-ivar">@column_separator</span> = <span class="ruby-ivar">@options</span>[<span class="ruby-value">:column_separator</span>].<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">encode</span>(<span class="ruby-ivar">@encoding</span>)
<span class="ruby-identifier">row_separator</span> = <span class="ruby-ivar">@options</span>[<span class="ruby-value">:row_separator</span>]
<span class="ruby-keyword">if</span> <span class="ruby-identifier">row_separator</span> <span class="ruby-operator">==</span> <span class="ruby-value">:auto</span>
<span class="ruby-ivar">@row_separator</span> = <span class="ruby-identifier">$INPUT_RECORD_SEPARATOR</span>.<span class="ruby-identifier">encode</span>(<span class="ruby-ivar">@encoding</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-ivar">@row_separator</span> = <span class="ruby-identifier">row_separator</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">encode</span>(<span class="ruby-ivar">@encoding</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@quote_character</span> = <span class="ruby-ivar">@options</span>[<span class="ruby-value">:quote_character</span>]
<span class="ruby-ivar">@force_quotes</span> = <span class="ruby-ivar">@options</span>[<span class="ruby-value">:force_quotes</span>]
<span class="ruby-keyword">unless</span> <span class="ruby-ivar">@force_quotes</span>
<span class="ruby-ivar">@quotable_pattern</span> =
<span class="ruby-constant">Regexp</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"[\r\n"</span>.<span class="ruby-identifier">encode</span>(<span class="ruby-ivar">@encoding</span>) <span class="ruby-operator">+</span>
<span class="ruby-constant">Regexp</span>.<span class="ruby-identifier">escape</span>(<span class="ruby-ivar">@column_separator</span>) <span class="ruby-operator">+</span>
<span class="ruby-constant">Regexp</span>.<span class="ruby-identifier">escape</span>(<span class="ruby-ivar">@quote_character</span>.<span class="ruby-identifier">encode</span>(<span class="ruby-ivar">@encoding</span>)) <span class="ruby-operator">+</span>
<span class="ruby-string">"]"</span>.<span class="ruby-identifier">encode</span>(<span class="ruby-ivar">@encoding</span>))
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@quote_empty</span> = <span class="ruby-ivar">@options</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-value">:quote_empty</span>, <span class="ruby-keyword">true</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-prepare_header" class="method-detail ">
<div class="method-heading">
<span class="method-name">prepare_header</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="prepare_header-source">
<pre><span class="ruby-comment"># File lib/csv/writer.rb, line 75</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">prepare_header</span>
<span class="ruby-identifier">headers</span> = <span class="ruby-ivar">@options</span>[<span class="ruby-value">:headers</span>]
<span class="ruby-keyword">case</span> <span class="ruby-identifier">headers</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">Array</span>
<span class="ruby-ivar">@headers</span> = <span class="ruby-identifier">headers</span>
<span class="ruby-ivar">@use_headers</span> = <span class="ruby-keyword">true</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">String</span>
<span class="ruby-ivar">@headers</span> = <span class="ruby-constant">CSV</span>.<span class="ruby-identifier">parse_line</span>(<span class="ruby-identifier">headers</span>,
<span class="ruby-value">col_sep:</span> <span class="ruby-ivar">@options</span>[<span class="ruby-value">:column_separator</span>],
<span class="ruby-value">row_sep:</span> <span class="ruby-ivar">@options</span>[<span class="ruby-value">:row_separator</span>],
<span class="ruby-value">quote_char:</span> <span class="ruby-ivar">@options</span>[<span class="ruby-value">:quote_character</span>])
<span class="ruby-ivar">@use_headers</span> = <span class="ruby-keyword">true</span>
<span class="ruby-keyword">when</span> <span class="ruby-keyword">true</span>
<span class="ruby-ivar">@headers</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@use_headers</span> = <span class="ruby-keyword">true</span>
<span class="ruby-keyword">else</span>
<span class="ruby-ivar">@headers</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@use_headers</span> = <span class="ruby-keyword">false</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@headers</span>
<span class="ruby-identifier">converter</span> = <span class="ruby-ivar">@options</span>[<span class="ruby-value">:header_fields_converter</span>]
<span class="ruby-ivar">@headers</span> = <span class="ruby-identifier">converter</span>.<span class="ruby-identifier">convert</span>(<span class="ruby-ivar">@headers</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-value">0</span>)
<span class="ruby-ivar">@headers</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">header</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">header</span>.<span class="ruby-identifier">freeze</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">header</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">String</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-prepare_output" class="method-detail ">
<div class="method-heading">
<span class="method-name">prepare_output</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="prepare_output-source">
<pre><span class="ruby-comment"># File lib/csv/writer.rb, line 123</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">prepare_output</span>
<span class="ruby-ivar">@output_encoding</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@output</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">StringIO</span>)
<span class="ruby-identifier">output_encoding</span> = <span class="ruby-ivar">@output</span>.<span class="ruby-identifier">internal_encoding</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@output</span>.<span class="ruby-identifier">external_encoding</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@encoding</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">output_encoding</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@options</span>[<span class="ruby-value">:force_encoding</span>]
<span class="ruby-ivar">@output_encoding</span> = <span class="ruby-identifier">output_encoding</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">compatible_encoding</span> = <span class="ruby-constant">Encoding</span>.<span class="ruby-identifier">compatible?</span>(<span class="ruby-ivar">@encoding</span>, <span class="ruby-identifier">output_encoding</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">compatible_encoding</span>
<span class="ruby-ivar">@output</span>.<span class="ruby-identifier">set_encoding</span>(<span class="ruby-identifier">compatible_encoding</span>)
<span class="ruby-ivar">@output</span>.<span class="ruby-identifier">seek</span>(<span class="ruby-value">0</span>, <span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">SEEK_END</span>)
<span class="ruby-keyword">end</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-quote" class="method-detail ">
<div class="method-heading">
<span class="method-name">quote</span><span
class="method-args">(field)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="quote-source">
<pre><span class="ruby-comment"># File lib/csv/writer.rb, line 150</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">quote</span>(<span class="ruby-identifier">field</span>)
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@force_quotes</span>
<span class="ruby-identifier">quote_field</span>(<span class="ruby-identifier">field</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">field</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-comment"># represent +nil+ fields as empty unquoted fields</span>
<span class="ruby-string">""</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">field</span> = <span class="ruby-constant">String</span>(<span class="ruby-identifier">field</span>) <span class="ruby-comment"># Stringify fields</span>
<span class="ruby-comment"># represent empty fields as empty quoted fields</span>
<span class="ruby-keyword">if</span> (<span class="ruby-ivar">@quote_empty</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">field</span>.<span class="ruby-identifier">empty?</span>) <span class="ruby-keyword">or</span> <span class="ruby-ivar">@quotable_pattern</span>.<span class="ruby-identifier">match?</span>(<span class="ruby-identifier">field</span>)
<span class="ruby-identifier">quote_field</span>(<span class="ruby-identifier">field</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">field</span> <span class="ruby-comment"># unquoted field</span>
<span class="ruby-keyword">end</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-quote_field" class="method-detail ">
<div class="method-heading">
<span class="method-name">quote_field</span><span
class="method-args">(field)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="quote_field-source">
<pre><span class="ruby-comment"># File lib/csv/writer.rb, line 141</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">quote_field</span>(<span class="ruby-identifier">field</span>)
<span class="ruby-identifier">field</span> = <span class="ruby-constant">String</span>(<span class="ruby-identifier">field</span>)
<span class="ruby-identifier">encoded_quote_character</span> = <span class="ruby-ivar">@quote_character</span>.<span class="ruby-identifier">encode</span>(<span class="ruby-identifier">field</span>.<span class="ruby-identifier">encoding</span>)
<span class="ruby-identifier">encoded_quote_character</span> <span class="ruby-operator">+</span>
<span class="ruby-identifier">field</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-identifier">encoded_quote_character</span>,
<span class="ruby-identifier">encoded_quote_character</span> <span class="ruby-operator">*</span> <span class="ruby-value">2</span>) <span class="ruby-operator">+</span>
<span class="ruby-identifier">encoded_quote_character</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>