File: C:/Ruby27-x64/share/doc/ruby/html/Bundler/Dsl/DSLError.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Bundler::Dsl::DSLError - 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">GemfileError
</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-contents">#contents</a>
<li ><a href="#method-i-parse_line_number_from_description">#parse_line_number_from_description</a>
<li class="calls-super" ><a href="#method-i-status_code">#status_code</a>
<li ><a href="#method-i-to_s">#to_s</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Bundler::Dsl::DSLError">
<h1 id="class-Bundler::Dsl::DSLError" class="class">
class Bundler::Dsl::DSLError
</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-i-backtrace" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">backtrace</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>@return [Exception] the backtrace of the exception raised by the</p>
<pre>evaluation of the dsl file.</pre>
</div>
</div>
<div id="attribute-i-description" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">description</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>@return [String] the description that should be presented to the user.</p>
</div>
</div>
<div id="attribute-i-dsl_path" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">dsl_path</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>@return [String] the path of the dsl file that raised the exception.</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">(description, dsl_path, backtrace, contents = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>@param [Exception] backtrace @see backtrace @param [String] <a href="DSLError.html#attribute-i-dsl_path"><code>dsl_path</code></a> @see <a href="DSLError.html#attribute-i-dsl_path"><code>dsl_path</code></a></p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/bundler/dsl.rb, line 502</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">description</span>, <span class="ruby-identifier">dsl_path</span>, <span class="ruby-identifier">backtrace</span>, <span class="ruby-identifier">contents</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-ivar">@status_code</span> = <span class="ruby-identifier">$!</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:status_code</span>) <span class="ruby-operator">&&</span> <span class="ruby-identifier">$!</span>.<span class="ruby-identifier">status_code</span>
<span class="ruby-ivar">@description</span> = <span class="ruby-identifier">description</span>
<span class="ruby-ivar">@dsl_path</span> = <span class="ruby-identifier">dsl_path</span>
<span class="ruby-ivar">@backtrace</span> = <span class="ruby-identifier">backtrace</span>
<span class="ruby-ivar">@contents</span> = <span class="ruby-identifier">contents</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-contents" class="method-detail ">
<div class="method-heading">
<span class="method-name">contents</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>@return [String] the contents of the DSL that cause the exception to</p>
<pre>be raised.</pre>
<div class="method-source-code" id="contents-source">
<pre><span class="ruby-comment"># File lib/bundler/dsl.rb, line 518</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">contents</span>
<span class="ruby-ivar">@contents</span> <span class="ruby-operator">||=</span> <span class="ruby-keyword">begin</span>
<span class="ruby-identifier">dsl_path</span> <span class="ruby-operator">&&</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-identifier">dsl_path</span>) <span class="ruby-operator">&&</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">dsl_path</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-status_code" class="method-detail ">
<div class="method-heading">
<span class="method-name">status_code</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-calls-super">
Calls superclass method
</div>
<div class="method-source-code" id="status_code-source">
<pre><span class="ruby-comment"># File lib/bundler/dsl.rb, line 511</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">status_code</span>
<span class="ruby-ivar">@status_code</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-to_s" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_s</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>The message of the exception reports the content of podspec for the line that generated the original exception.</p>
<p>@example Output</p>
<pre>Invalid podspec at `RestKit.podspec` - undefined method
`exclude_header_search_paths=' for #<Pod::Specification for
`RestKit/Network (0.9.3)`>
from spec-repos/master/RestKit/0.9.3/RestKit.podspec:36
-------------------------------------------
# because it would break: #import <CoreData/CoreData.h>
> ns.exclude_header_search_paths = 'Code/RestKit.h'
end
-------------------------------------------</pre>
<p>@return [String] the message of the exception.</p>
<div class="method-source-code" id="to_s-source">
<pre><span class="ruby-comment"># File lib/bundler/dsl.rb, line 542</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_s</span>
<span class="ruby-ivar">@to_s</span> <span class="ruby-operator">||=</span> <span class="ruby-keyword">begin</span>
<span class="ruby-identifier">trace_line</span>, <span class="ruby-identifier">description</span> = <span class="ruby-identifier">parse_line_number_from_description</span>
<span class="ruby-identifier">m</span> = <span class="ruby-constant">String</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"\n[!] "</span>)
<span class="ruby-identifier">m</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">description</span>
<span class="ruby-identifier">m</span> <span class="ruby-operator"><<</span> <span class="ruby-string">". Bundler cannot continue.\n"</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">m</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">backtrace</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">dsl_path</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">contents</span>
<span class="ruby-identifier">trace_line</span> = <span class="ruby-identifier">backtrace</span>.<span class="ruby-identifier">find</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">l</span><span class="ruby-operator">|</span> <span class="ruby-identifier">l</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">dsl_path</span>.<span class="ruby-identifier">to_s</span>) } <span class="ruby-operator">||</span> <span class="ruby-identifier">trace_line</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">m</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">trace_line</span>
<span class="ruby-identifier">line_numer</span> = <span class="ruby-identifier">trace_line</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">":"</span>)[<span class="ruby-value">1</span>].<span class="ruby-identifier">to_i</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">m</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">line_numer</span>
<span class="ruby-identifier">lines</span> = <span class="ruby-identifier">contents</span>.<span class="ruby-identifier">lines</span>.<span class="ruby-identifier">to_a</span>
<span class="ruby-identifier">indent</span> = <span class="ruby-string">" # "</span>
<span class="ruby-identifier">indicator</span> = <span class="ruby-identifier">indent</span>.<span class="ruby-identifier">tr</span>(<span class="ruby-string">"#"</span>, <span class="ruby-string">">"</span>)
<span class="ruby-identifier">first_line</span> = <span class="ruby-identifier">line_numer</span>.<span class="ruby-identifier">zero?</span>
<span class="ruby-identifier">last_line</span> = (<span class="ruby-identifier">line_numer</span> <span class="ruby-operator">==</span> (<span class="ruby-identifier">lines</span>.<span class="ruby-identifier">count</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>))
<span class="ruby-identifier">m</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"\n"</span>
<span class="ruby-identifier">m</span> <span class="ruby-operator"><<</span> <span class="ruby-node">"#{indent}from #{trace_line.gsub(/:in.*$/, "")}\n"</span>
<span class="ruby-identifier">m</span> <span class="ruby-operator"><<</span> <span class="ruby-node">"#{indent}-------------------------------------------\n"</span>
<span class="ruby-identifier">m</span> <span class="ruby-operator"><<</span> <span class="ruby-node">"#{indent}#{lines[line_numer - 1]}"</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">first_line</span>
<span class="ruby-identifier">m</span> <span class="ruby-operator"><<</span> <span class="ruby-node">"#{indicator}#{lines[line_numer]}"</span>
<span class="ruby-identifier">m</span> <span class="ruby-operator"><<</span> <span class="ruby-node">"#{indent}#{lines[line_numer + 1]}"</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">last_line</span>
<span class="ruby-identifier">m</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"\n"</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">m</span>.<span class="ruby-identifier">end_with?</span>(<span class="ruby-string">"\n"</span>)
<span class="ruby-identifier">m</span> <span class="ruby-operator"><<</span> <span class="ruby-node">"#{indent}-------------------------------------------\n"</span>
<span class="ruby-keyword">end</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-parse_line_number_from_description" class="method-detail ">
<div class="method-heading">
<span class="method-name">parse_line_number_from_description</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="parse_line_number_from_description-source">
<pre><span class="ruby-comment"># File lib/bundler/dsl.rb, line 576</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">parse_line_number_from_description</span>
<span class="ruby-identifier">description</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">description</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">dsl_path</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">description</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/((#{Regexp.quote File.expand_path(dsl_path)}|#{Regexp.quote dsl_path.to_s}):\d+)/</span>
<span class="ruby-identifier">trace_line</span> = <span class="ruby-constant">Regexp</span>.<span class="ruby-identifier">last_match</span>[<span class="ruby-value">1</span>]
<span class="ruby-identifier">description</span> = <span class="ruby-identifier">description</span>.<span class="ruby-identifier">sub</span>(<span class="ruby-regexp">/\n.*\n(\.\.\.)? *\^~+$/</span>, <span class="ruby-string">""</span>).<span class="ruby-identifier">sub</span>(<span class="ruby-regexp">/#{Regexp.quote trace_line}:\s*/</span>, <span class="ruby-string">""</span>).<span class="ruby-identifier">sub</span>(<span class="ruby-string">"\n"</span>, <span class="ruby-string">" - "</span>)
<span class="ruby-keyword">end</span>
[<span class="ruby-identifier">trace_line</span>, <span class="ruby-identifier">description</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>