File: C:/Ruby27-x64/share/doc/ruby/html/Bundler/Plugin/API.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Bundler::Plugin::API - 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-command">::command</a>
<li ><a href="#method-c-hook">::hook</a>
<li ><a href="#method-c-source">::source</a>
<li ><a href="#method-i-cache_dir">#cache_dir</a>
<li class="calls-super" ><a href="#method-i-method_missing">#method_missing</a>
<li class="calls-super" ><a href="#method-i-respond_to_missing-3F">#respond_to_missing?</a>
<li ><a href="#method-i-tmp">#tmp</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Bundler::Plugin::API">
<h1 id="class-Bundler::Plugin::API" class="class">
class Bundler::Plugin::API
</h1>
<section class="description">
</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-command" class="method-detail ">
<div class="method-heading">
<span class="method-name">command</span><span
class="method-args">(command, cls = self)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>The plugins should declare that they handle a command through this helper.</p>
<p>@param [String] command being handled by them @param [Class] (optional) class that handles the command. If not</p>
<pre>provided, the `self` class will be used.</pre>
<div class="method-source-code" id="command-source">
<pre><span class="ruby-comment"># File lib/bundler/plugin/api.rb, line 33</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">command</span>(<span class="ruby-identifier">command</span>, <span class="ruby-identifier">cls</span> = <span class="ruby-keyword">self</span>)
<span class="ruby-constant">Plugin</span>.<span class="ruby-identifier">add_command</span> <span class="ruby-identifier">command</span>, <span class="ruby-identifier">cls</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-hook" class="method-detail ">
<div class="method-heading">
<span class="method-name">hook</span><span
class="method-args">(event, &block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="hook-source">
<pre><span class="ruby-comment"># File lib/bundler/plugin/api.rb, line 48</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">hook</span>(<span class="ruby-identifier">event</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-constant">Plugin</span>.<span class="ruby-identifier">add_hook</span>(<span class="ruby-identifier">event</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-c-source" class="method-detail ">
<div class="method-heading">
<span class="method-name">source</span><span
class="method-args">(source, cls = self)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>The plugins should declare that they provide a installation source through this helper.</p>
<p>@param [String] the source type they provide @param [Class] (optional) class that handles the source. If not</p>
<pre>provided, the `self` class will be used.</pre>
<div class="method-source-code" id="source-source">
<pre><span class="ruby-comment"># File lib/bundler/plugin/api.rb, line 43</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">source</span>(<span class="ruby-identifier">source</span>, <span class="ruby-identifier">cls</span> = <span class="ruby-keyword">self</span>)
<span class="ruby-identifier">cls</span>.<span class="ruby-identifier">send</span> <span class="ruby-value">:include</span>, <span class="ruby-constant">Bundler</span><span class="ruby-operator">::</span><span class="ruby-constant">Plugin</span><span class="ruby-operator">::</span><span class="ruby-constant">API</span><span class="ruby-operator">::</span><span class="ruby-constant">Source</span>
<span class="ruby-constant">Plugin</span>.<span class="ruby-identifier">add_source</span> <span class="ruby-identifier">source</span>, <span class="ruby-identifier">cls</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-cache_dir" class="method-detail ">
<div class="method-heading">
<span class="method-name">cache_dir</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>The cache dir to be used by the plugins for storage</p>
<p>@return [Pathname] path of the cache dir</p>
<div class="method-source-code" id="cache_dir-source">
<pre><span class="ruby-comment"># File lib/bundler/plugin/api.rb, line 55</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">cache_dir</span>
<span class="ruby-constant">Plugin</span>.<span class="ruby-identifier">cache</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">"plugins"</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-method_missing" class="method-detail ">
<div class="method-heading">
<span class="method-name">method_missing</span><span
class="method-args">(name, *args, &blk)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-calls-super">
Calls superclass method
<a href="../../BasicObject.html#method-i-method_missing"><code>BasicObject#method_missing</code></a>
</div>
<div class="method-source-code" id="method_missing-source">
<pre><span class="ruby-comment"># File lib/bundler/plugin/api.rb, line 67</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">method_missing</span>(<span class="ruby-identifier">name</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">blk</span>)
<span class="ruby-keyword">return</span> <span class="ruby-constant">Bundler</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">name</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">blk</span>) <span class="ruby-keyword">if</span> <span class="ruby-constant">Bundler</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-keyword">return</span> <span class="ruby-constant">SharedHelpers</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">name</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">blk</span>) <span class="ruby-keyword">if</span> <span class="ruby-constant">SharedHelpers</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-keyword">super</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-respond_to_missing-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">respond_to_missing?</span><span
class="method-args">(name, include_private = false)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-calls-super">
Calls superclass method
<a href="../../Object.html#method-i-respond_to_missing-3F"><code>Object#respond_to_missing?</code></a>
</div>
<div class="method-source-code" id="respond_to_missing-3F-source">
<pre><span class="ruby-comment"># File lib/bundler/plugin/api.rb, line 75</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">respond_to_missing?</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">include_private</span> = <span class="ruby-keyword">false</span>)
<span class="ruby-constant">SharedHelpers</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">include_private</span>) <span class="ruby-operator">||</span>
<span class="ruby-constant">Bundler</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">include_private</span>) <span class="ruby-operator">||</span> <span class="ruby-keyword">super</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-tmp" class="method-detail ">
<div class="method-heading">
<span class="method-name">tmp</span><span
class="method-args">(*names)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>A tmp dir to be used by plugins Accepts names that get concatenated as suffix</p>
<p>@return [Pathname] object for the new directory created</p>
<div class="method-source-code" id="tmp-source">
<pre><span class="ruby-comment"># File lib/bundler/plugin/api.rb, line 63</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">tmp</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">names</span>)
<span class="ruby-constant">Bundler</span>.<span class="ruby-identifier">tmp</span>([<span class="ruby-string">"plugin"</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">names</span>].<span class="ruby-identifier">join</span>(<span class="ruby-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>