File: C:/Ruby27-x64/share/doc/ruby/html/Gem/UriFormatter.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Gem::UriFormatter - 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-escape">#escape</a>
<li ><a href="#method-i-normalize">#normalize</a>
<li ><a href="#method-i-unescape">#unescape</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Gem::UriFormatter">
<h1 id="class-Gem::UriFormatter" class="class">
class Gem::UriFormatter
</h1>
<section class="description">
<p>The <a href="UriFormatter.html"><code>UriFormatter</code></a> handles URIs from user-input and escaping.</p>
<pre class="ruby"><span class="ruby-identifier">uf</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">UriFormatter</span>.<span class="ruby-identifier">new</span> <span class="ruby-string">'example.com'</span>
<span class="ruby-identifier">p</span> <span class="ruby-identifier">uf</span>.<span class="ruby-identifier">normalize</span> <span class="ruby-comment">#=> 'http://example.com'</span>
</pre>
</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-uri" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">uri</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The <a href="../URI.html"><code>URI</code></a> to be formatted.</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">(uri)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a new <a href="../URI.html"><code>URI</code></a> formatter for <code>uri</code>.</p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rubygems/uri_formatter.rb, line 21</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">uri</span>)
<span class="ruby-ivar">@uri</span> = <span class="ruby-identifier">uri</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-escape" class="method-detail ">
<div class="method-heading">
<span class="method-name">escape</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Escapes the <a href="UriFormatter.html#attribute-i-uri"><code>uri</code></a> for use as a <a href="../CGI.html"><code>CGI</code></a> parameter</p>
<div class="method-source-code" id="escape-source">
<pre><span class="ruby-comment"># File lib/rubygems/uri_formatter.rb, line 28</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">escape</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@uri</span>
<span class="ruby-constant">CGI</span>.<span class="ruby-identifier">escape</span> <span class="ruby-ivar">@uri</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-normalize" class="method-detail ">
<div class="method-heading">
<span class="method-name">normalize</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Normalize the <a href="../URI.html"><code>URI</code></a> by adding “http://” if it is missing.</p>
<div class="method-source-code" id="normalize-source">
<pre><span class="ruby-comment"># File lib/rubygems/uri_formatter.rb, line 36</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">normalize</span>
(<span class="ruby-ivar">@uri</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/^(https?|ftp|file):/i</span>) <span class="ruby-operator">?</span> <span class="ruby-ivar">@uri</span> <span class="ruby-operator">:</span> <span class="ruby-node">"http://#{@uri}"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-unescape" class="method-detail ">
<div class="method-heading">
<span class="method-name">unescape</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Unescapes the <a href="UriFormatter.html#attribute-i-uri"><code>uri</code></a> which came from a <a href="../CGI.html"><code>CGI</code></a> parameter</p>
<div class="method-source-code" id="unescape-source">
<pre><span class="ruby-comment"># File lib/rubygems/uri_formatter.rb, line 43</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">unescape</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@uri</span>
<span class="ruby-constant">CGI</span>.<span class="ruby-identifier">unescape</span> <span class="ruby-ivar">@uri</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>