File: C:/Ruby27-x64/share/doc/ruby/html/Bundler/GemHelper.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Bundler::GemHelper - 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-gemspec">::gemspec</a>
<li ><a href="#method-c-install_tasks">::install_tasks</a>
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-allowed_push_host">#allowed_push_host</a>
<li ><a href="#method-i-already_tagged-3F">#already_tagged?</a>
<li ><a href="#method-i-build_gem">#build_gem</a>
<li ><a href="#method-i-built_gem_path">#built_gem_path</a>
<li ><a href="#method-i-clean-3F">#clean?</a>
<li ><a href="#method-i-committed-3F">#committed?</a>
<li ><a href="#method-i-gem_command">#gem_command</a>
<li ><a href="#method-i-gem_key">#gem_key</a>
<li ><a href="#method-i-gem_push-3F">#gem_push?</a>
<li ><a href="#method-i-gem_push_host">#gem_push_host</a>
<li ><a href="#method-i-git_push">#git_push</a>
<li ><a href="#method-i-guard_clean">#guard_clean</a>
<li ><a href="#method-i-install">#install</a>
<li ><a href="#method-i-install_gem">#install_gem</a>
<li ><a href="#method-i-name">#name</a>
<li ><a href="#method-i-perform_git_push">#perform_git_push</a>
<li ><a href="#method-i-rubygem_push">#rubygem_push</a>
<li ><a href="#method-i-sh">#sh</a>
<li ><a href="#method-i-sh_with_input">#sh_with_input</a>
<li ><a href="#method-i-sh_with_status">#sh_with_status</a>
<li ><a href="#method-i-tag_version">#tag_version</a>
<li ><a href="#method-i-version">#version</a>
<li ><a href="#method-i-version_tag">#version_tag</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Bundler::GemHelper">
<h1 id="class-Bundler::GemHelper" class="class">
class Bundler::GemHelper
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-c-instance" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">instance</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>set when install'd.</p>
</div>
</div>
<div id="attribute-i-base" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">base</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-gemspec" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">gemspec</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-spec_path" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">spec_path</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</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-gemspec" class="method-detail ">
<div class="method-heading">
<span class="method-name">gemspec</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="gemspec-source">
<pre><span class="ruby-comment"># File lib/bundler/gem_helper.rb, line 18</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">gemspec</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">gemspec</span> = <span class="ruby-identifier">instance</span>.<span class="ruby-identifier">gemspec</span>
<span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">gemspec</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">block</span>
<span class="ruby-identifier">gemspec</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-install_tasks" class="method-detail ">
<div class="method-heading">
<span class="method-name">install_tasks</span><span
class="method-args">(opts = {})</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="install_tasks-source">
<pre><span class="ruby-comment"># File lib/bundler/gem_helper.rb, line 14</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">install_tasks</span>(<span class="ruby-identifier">opts</span> = {})
<span class="ruby-identifier">new</span>(<span class="ruby-identifier">opts</span>[<span class="ruby-value">:dir</span>], <span class="ruby-identifier">opts</span>[<span class="ruby-value">:name</span>]).<span class="ruby-identifier">install</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(base = nil, name = nil)</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/bundler/gem_helper.rb, line 27</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">base</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">name</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-ivar">@base</span> = (<span class="ruby-identifier">base</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">SharedHelpers</span>.<span class="ruby-identifier">pwd</span>)
<span class="ruby-identifier">gemspecs</span> = <span class="ruby-identifier">name</span> <span class="ruby-operator">?</span> [<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">base</span>, <span class="ruby-node">"#{name}.gemspec"</span>)] <span class="ruby-operator">:</span> <span class="ruby-constant">Dir</span>[<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">base</span>, <span class="ruby-string">"{,*}.gemspec"</span>)]
<span class="ruby-identifier">raise</span> <span class="ruby-string">"Unable to determine name from existing gemspec. Use :name => 'gemname' in #install_tasks to manually set it."</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">gemspecs</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span>
<span class="ruby-ivar">@spec_path</span> = <span class="ruby-identifier">gemspecs</span>.<span class="ruby-identifier">first</span>
<span class="ruby-ivar">@gemspec</span> = <span class="ruby-constant">Bundler</span>.<span class="ruby-identifier">load_gemspec</span>(<span class="ruby-ivar">@spec_path</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-build_gem" class="method-detail ">
<div class="method-heading">
<span class="method-name">build_gem</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="build_gem-source">
<pre><span class="ruby-comment"># File lib/bundler/gem_helper.rb, line 74</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">build_gem</span>
<span class="ruby-identifier">file_name</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-identifier">sh</span>(<span class="ruby-node">"#{gem_command} build -V #{spec_path.shellescape}"</span>.<span class="ruby-identifier">shellsplit</span>) <span class="ruby-keyword">do</span>
<span class="ruby-identifier">file_name</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-identifier">built_gem_path</span>)
<span class="ruby-constant">SharedHelpers</span>.<span class="ruby-identifier">filesystem_access</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">base</span>, <span class="ruby-string">"pkg"</span>)) {<span class="ruby-operator">|</span><span class="ruby-identifier">p</span><span class="ruby-operator">|</span> <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span>(<span class="ruby-identifier">p</span>) }
<span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mv</span>(<span class="ruby-identifier">built_gem_path</span>, <span class="ruby-string">"pkg"</span>)
<span class="ruby-constant">Bundler</span>.<span class="ruby-identifier">ui</span>.<span class="ruby-identifier">confirm</span> <span class="ruby-node">"#{name} #{version} built to pkg/#{file_name}."</span>
<span class="ruby-keyword">end</span>
<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">base</span>, <span class="ruby-string">"pkg"</span>, <span class="ruby-identifier">file_name</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-install" class="method-detail ">
<div class="method-heading">
<span class="method-name">install</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="install-source">
<pre><span class="ruby-comment"># File lib/bundler/gem_helper.rb, line 35</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">install</span>
<span class="ruby-identifier">built_gem_path</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-identifier">desc</span> <span class="ruby-node">"Build #{name}-#{version}.gem into the pkg directory."</span>
<span class="ruby-identifier">task</span> <span class="ruby-string">"build"</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">built_gem_path</span> = <span class="ruby-identifier">build_gem</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">desc</span> <span class="ruby-node">"Build and install #{name}-#{version}.gem into system gems."</span>
<span class="ruby-identifier">task</span> <span class="ruby-string">"install"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"build"</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">install_gem</span>(<span class="ruby-identifier">built_gem_path</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">desc</span> <span class="ruby-node">"Build and install #{name}-#{version}.gem into system gems without network access."</span>
<span class="ruby-identifier">task</span> <span class="ruby-string">"install:local"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"build"</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">install_gem</span>(<span class="ruby-identifier">built_gem_path</span>, <span class="ruby-value">:local</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">desc</span> <span class="ruby-node">"Create tag #{version_tag} and build and push #{name}-#{version}.gem to #{gem_push_host}\n"</span> \
<span class="ruby-string">"To prevent publishing in RubyGems use `gem_push=no rake release`"</span>
<span class="ruby-identifier">task</span> <span class="ruby-string">"release"</span>, [<span class="ruby-value">:remote</span>] <span class="ruby-operator">=></span> [<span class="ruby-string">"build"</span>, <span class="ruby-string">"release:guard_clean"</span>,
<span class="ruby-string">"release:source_control_push"</span>, <span class="ruby-string">"release:rubygem_push"</span>] <span class="ruby-keyword">do</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">task</span> <span class="ruby-string">"release:guard_clean"</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">guard_clean</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">task</span> <span class="ruby-string">"release:source_control_push"</span>, [<span class="ruby-value">:remote</span>] <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">_</span>, <span class="ruby-identifier">args</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">tag_version</span> { <span class="ruby-identifier">git_push</span>(<span class="ruby-identifier">args</span>[<span class="ruby-value">:remote</span>]) } <span class="ruby-keyword">unless</span> <span class="ruby-identifier">already_tagged?</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">task</span> <span class="ruby-string">"release:rubygem_push"</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">rubygem_push</span>(<span class="ruby-identifier">built_gem_path</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">gem_push?</span>
<span class="ruby-keyword">end</span>
<span class="ruby-constant">GemHelper</span>.<span class="ruby-identifier">instance</span> = <span class="ruby-keyword">self</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-install_gem" class="method-detail ">
<div class="method-heading">
<span class="method-name">install_gem</span><span
class="method-args">(built_gem_path = nil, local = false)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="install_gem-source">
<pre><span class="ruby-comment"># File lib/bundler/gem_helper.rb, line 85</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">install_gem</span>(<span class="ruby-identifier">built_gem_path</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">local</span> = <span class="ruby-keyword">false</span>)
<span class="ruby-identifier">built_gem_path</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">build_gem</span>
<span class="ruby-identifier">cmd</span> = <span class="ruby-node">"#{gem_command} install #{built_gem_path}"</span>
<span class="ruby-identifier">cmd</span> <span class="ruby-operator">+=</span> <span class="ruby-string">" --local"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">local</span>
<span class="ruby-identifier">_</span>, <span class="ruby-identifier">status</span> = <span class="ruby-identifier">sh_with_status</span>(<span class="ruby-identifier">cmd</span>.<span class="ruby-identifier">shellsplit</span>)
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">status</span>.<span class="ruby-identifier">success?</span>
<span class="ruby-identifier">raise</span> <span class="ruby-node">"Couldn't install gem, run `gem install #{built_gem_path}' for more detailed output"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-constant">Bundler</span>.<span class="ruby-identifier">ui</span>.<span class="ruby-identifier">confirm</span> <span class="ruby-node">"#{name} (#{version}) installed."</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="protected-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Protected Instance Methods</h3>
</header>
<div id="method-i-allowed_push_host" class="method-detail ">
<div class="method-heading">
<span class="method-name">allowed_push_host</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="allowed_push_host-source">
<pre><span class="ruby-comment"># File lib/bundler/gem_helper.rb, line 119</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">allowed_push_host</span>
<span class="ruby-ivar">@gemspec</span>.<span class="ruby-identifier">metadata</span>[<span class="ruby-string">"allowed_push_host"</span>] <span class="ruby-keyword">if</span> <span class="ruby-ivar">@gemspec</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:metadata</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-already_tagged-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">already_tagged?</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="already_tagged-3F-source">
<pre><span class="ruby-comment"># File lib/bundler/gem_helper.rb, line 138</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">already_tagged?</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">sh</span>(<span class="ruby-node">%w[git tag]</span>).<span class="ruby-identifier">split</span>(<span class="ruby-regexp">/\n/</span>).<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">version_tag</span>)
<span class="ruby-constant">Bundler</span>.<span class="ruby-identifier">ui</span>.<span class="ruby-identifier">confirm</span> <span class="ruby-node">"Tag #{version_tag} has already been created."</span>
<span class="ruby-keyword">true</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-built_gem_path" class="method-detail ">
<div class="method-heading">
<span class="method-name">built_gem_path</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="built_gem_path-source">
<pre><span class="ruby-comment"># File lib/bundler/gem_helper.rb, line 109</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">built_gem_path</span>
<span class="ruby-constant">Dir</span>[<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">base</span>, <span class="ruby-node">"#{name}-*.gem"</span>)].<span class="ruby-identifier">sort_by</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">mtime</span>(<span class="ruby-identifier">f</span>) }.<span class="ruby-identifier">last</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-clean-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">clean?</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="clean-3F-source">
<pre><span class="ruby-comment"># File lib/bundler/gem_helper.rb, line 148</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">clean?</span>
<span class="ruby-identifier">sh_with_status</span>(<span class="ruby-node">%w[git diff --exit-code]</span>)[<span class="ruby-value">1</span>].<span class="ruby-identifier">success?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-committed-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">committed?</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="committed-3F-source">
<pre><span class="ruby-comment"># File lib/bundler/gem_helper.rb, line 152</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">committed?</span>
<span class="ruby-identifier">sh_with_status</span>(<span class="ruby-node">%w[git diff-index --quiet --cached HEAD]</span>)[<span class="ruby-value">1</span>].<span class="ruby-identifier">success?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-gem_command" class="method-detail ">
<div class="method-heading">
<span class="method-name">gem_command</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="gem_command-source">
<pre><span class="ruby-comment"># File lib/bundler/gem_helper.rb, line 212</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">gem_command</span>
<span class="ruby-constant">ENV</span>[<span class="ruby-string">"GEM_COMMAND"</span>] <span class="ruby-operator">?</span> <span class="ruby-constant">ENV</span>[<span class="ruby-string">"GEM_COMMAND"</span>] <span class="ruby-operator">:</span> <span class="ruby-string">"gem"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-gem_key" class="method-detail ">
<div class="method-heading">
<span class="method-name">gem_key</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="gem_key-source">
<pre><span class="ruby-comment"># File lib/bundler/gem_helper.rb, line 204</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">gem_key</span>
<span class="ruby-constant">Bundler</span>.<span class="ruby-identifier">settings</span>[<span class="ruby-string">"gem.push_key"</span>].<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">downcase</span> <span class="ruby-keyword">if</span> <span class="ruby-constant">Bundler</span>.<span class="ruby-identifier">settings</span>[<span class="ruby-string">"gem.push_key"</span>]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-gem_push-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">gem_push?</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="gem_push-3F-source">
<pre><span class="ruby-comment"># File lib/bundler/gem_helper.rb, line 208</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">gem_push?</span>
<span class="ruby-operator">!</span><span class="ruby-node">%w[n no nil false off 0]</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-constant">ENV</span>[<span class="ruby-string">"gem_push"</span>].<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">downcase</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-gem_push_host" class="method-detail ">
<div class="method-heading">
<span class="method-name">gem_push_host</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="gem_push_host-source">
<pre><span class="ruby-comment"># File lib/bundler/gem_helper.rb, line 123</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">gem_push_host</span>
<span class="ruby-identifier">env_rubygems_host</span> = <span class="ruby-constant">ENV</span>[<span class="ruby-string">"RUBYGEMS_HOST"</span>]
<span class="ruby-identifier">env_rubygems_host</span> = <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span>
<span class="ruby-identifier">env_rubygems_host</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">env_rubygems_host</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-identifier">allowed_push_host</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">env_rubygems_host</span> <span class="ruby-operator">||</span> <span class="ruby-string">"rubygems.org"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-git_push" class="method-detail ">
<div class="method-heading">
<span class="method-name">git_push</span><span
class="method-args">(remote = "")</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="git_push-source">
<pre><span class="ruby-comment"># File lib/bundler/gem_helper.rb, line 113</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">git_push</span>(<span class="ruby-identifier">remote</span> = <span class="ruby-string">""</span>)
<span class="ruby-identifier">perform_git_push</span> <span class="ruby-identifier">remote</span>
<span class="ruby-identifier">perform_git_push</span> <span class="ruby-node">"#{remote} --tags"</span>
<span class="ruby-constant">Bundler</span>.<span class="ruby-identifier">ui</span>.<span class="ruby-identifier">confirm</span> <span class="ruby-string">"Pushed git commits and tags."</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-guard_clean" class="method-detail ">
<div class="method-heading">
<span class="method-name">guard_clean</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="guard_clean-source">
<pre><span class="ruby-comment"># File lib/bundler/gem_helper.rb, line 144</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">guard_clean</span>
<span class="ruby-identifier">clean?</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">committed?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">raise</span>(<span class="ruby-string">"There are files that need to be committed first."</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-name" class="method-detail ">
<div class="method-heading">
<span class="method-name">name</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="name-source">
<pre><span class="ruby-comment"># File lib/bundler/gem_helper.rb, line 174</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">name</span>
<span class="ruby-identifier">gemspec</span>.<span class="ruby-identifier">name</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-perform_git_push" class="method-detail ">
<div class="method-heading">
<span class="method-name">perform_git_push</span><span
class="method-args">(options = "")</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="perform_git_push-source">
<pre><span class="ruby-comment"># File lib/bundler/gem_helper.rb, line 131</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">perform_git_push</span>(<span class="ruby-identifier">options</span> = <span class="ruby-string">""</span>)
<span class="ruby-identifier">cmd</span> = <span class="ruby-node">"git push #{options}"</span>
<span class="ruby-identifier">out</span>, <span class="ruby-identifier">status</span> = <span class="ruby-identifier">sh_with_status</span>(<span class="ruby-identifier">cmd</span>.<span class="ruby-identifier">shellsplit</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">status</span>.<span class="ruby-identifier">success?</span>
<span class="ruby-identifier">raise</span> <span class="ruby-node">"Couldn't git push. `#{cmd}' failed with the following output:\n\n#{out}\n"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-rubygem_push" class="method-detail ">
<div class="method-heading">
<span class="method-name">rubygem_push</span><span
class="method-args">(path)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="rubygem_push-source">
<pre><span class="ruby-comment"># File lib/bundler/gem_helper.rb, line 98</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">rubygem_push</span>(<span class="ruby-identifier">path</span>)
<span class="ruby-identifier">cmd</span> = <span class="ruby-node">%W[#{gem_command} push #{path}]</span>
<span class="ruby-identifier">cmd</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"--key"</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">gem_key</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">gem_key</span>
<span class="ruby-identifier">cmd</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"--host"</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">allowed_push_host</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">allowed_push_host</span>
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">allowed_push_host</span> <span class="ruby-operator">||</span> <span class="ruby-constant">Bundler</span>.<span class="ruby-identifier">user_home</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">".gem/credentials"</span>).<span class="ruby-identifier">file?</span>
<span class="ruby-identifier">raise</span> <span class="ruby-string">"Your rubygems.org credentials aren't set. Run `gem push` to set them."</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">sh_with_input</span>(<span class="ruby-identifier">cmd</span>)
<span class="ruby-constant">Bundler</span>.<span class="ruby-identifier">ui</span>.<span class="ruby-identifier">confirm</span> <span class="ruby-node">"Pushed #{name} #{version} to #{gem_push_host}"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-sh" class="method-detail ">
<div class="method-heading">
<span class="method-name">sh</span><span
class="method-args">(cmd, &block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="sh-source">
<pre><span class="ruby-comment"># File lib/bundler/gem_helper.rb, line 185</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sh</span>(<span class="ruby-identifier">cmd</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">out</span>, <span class="ruby-identifier">status</span> = <span class="ruby-identifier">sh_with_status</span>(<span class="ruby-identifier">cmd</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">status</span>.<span class="ruby-identifier">success?</span>
<span class="ruby-identifier">cmd</span> = <span class="ruby-identifier">cmd</span>.<span class="ruby-identifier">shelljoin</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">cmd</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:shelljoin</span>)
<span class="ruby-identifier">raise</span>(<span class="ruby-identifier">out</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-operator">?</span> <span class="ruby-node">"Running `#{cmd}` failed. Run this command directly for more detailed output."</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">out</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">out</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-sh_with_input" class="method-detail ">
<div class="method-heading">
<span class="method-name">sh_with_input</span><span
class="method-args">(cmd)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="sh_with_input-source">
<pre><span class="ruby-comment"># File lib/bundler/gem_helper.rb, line 178</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sh_with_input</span>(<span class="ruby-identifier">cmd</span>)
<span class="ruby-constant">Bundler</span>.<span class="ruby-identifier">ui</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-identifier">cmd</span>)
<span class="ruby-constant">SharedHelpers</span>.<span class="ruby-identifier">chdir</span>(<span class="ruby-identifier">base</span>) <span class="ruby-keyword">do</span>
<span class="ruby-identifier">abort</span> <span class="ruby-keyword">unless</span> <span class="ruby-constant">Kernel</span>.<span class="ruby-identifier">system</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">cmd</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-sh_with_status" class="method-detail ">
<div class="method-heading">
<span class="method-name">sh_with_status</span><span
class="method-args">(cmd, &block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="sh_with_status-source">
<pre><span class="ruby-comment"># File lib/bundler/gem_helper.rb, line 194</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sh_with_status</span>(<span class="ruby-identifier">cmd</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-constant">Bundler</span>.<span class="ruby-identifier">ui</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-identifier">cmd</span>)
<span class="ruby-constant">SharedHelpers</span>.<span class="ruby-identifier">chdir</span>(<span class="ruby-identifier">base</span>) <span class="ruby-keyword">do</span>
<span class="ruby-identifier">outbuf</span> = <span class="ruby-constant">IO</span>.<span class="ruby-identifier">popen</span>(<span class="ruby-identifier">cmd</span>, <span class="ruby-value">:err</span> <span class="ruby-operator">=></span> [<span class="ruby-value">:child</span>, <span class="ruby-value">:out</span>], <span class="ruby-operator">&</span><span class="ruby-value">:read</span>)
<span class="ruby-identifier">status</span> = <span class="ruby-identifier">$?</span>
<span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">outbuf</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">status</span>.<span class="ruby-identifier">success?</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">block</span>
[<span class="ruby-identifier">outbuf</span>, <span class="ruby-identifier">status</span>]
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-tag_version" class="method-detail ">
<div class="method-heading">
<span class="method-name">tag_version</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="tag_version-source">
<pre><span class="ruby-comment"># File lib/bundler/gem_helper.rb, line 156</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">tag_version</span>
<span class="ruby-identifier">sh</span> <span class="ruby-node">%W[git tag -m Version\ #{version} #{version_tag}]</span>
<span class="ruby-constant">Bundler</span>.<span class="ruby-identifier">ui</span>.<span class="ruby-identifier">confirm</span> <span class="ruby-node">"Tagged #{version_tag}."</span>
<span class="ruby-keyword">yield</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">RuntimeError</span>
<span class="ruby-constant">Bundler</span>.<span class="ruby-identifier">ui</span>.<span class="ruby-identifier">error</span> <span class="ruby-node">"Untagging #{version_tag} due to error."</span>
<span class="ruby-identifier">sh_with_status</span> <span class="ruby-node">%W[git tag -d #{version_tag}]</span>
<span class="ruby-identifier">raise</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-version" class="method-detail ">
<div class="method-heading">
<span class="method-name">version</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="version-source">
<pre><span class="ruby-comment"># File lib/bundler/gem_helper.rb, line 166</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">version</span>
<span class="ruby-identifier">gemspec</span>.<span class="ruby-identifier">version</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-version_tag" class="method-detail ">
<div class="method-heading">
<span class="method-name">version_tag</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="version_tag-source">
<pre><span class="ruby-comment"># File lib/bundler/gem_helper.rb, line 170</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">version_tag</span>
<span class="ruby-node">"v#{version}"</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>