File: C:/Ruby27-x64/share/doc/ruby/html/Bundler/Molinillo/VersionConflict.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Bundler::Molinillo::VersionConflict - 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="ResolverError.html">Bundler::Molinillo::ResolverError</a>
</div>
<div id="includes-section" class="nav-section">
<h3>Included Modules</h3>
<ul class="link-list">
<li><a class="include" href="Delegates/SpecificationProvider.html">Bundler::Molinillo::Delegates::SpecificationProvider</a>
</ul>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li class="calls-super" ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-message_with_trees">#message_with_trees</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Bundler::Molinillo::VersionConflict">
<h1 id="class-Bundler::Molinillo::VersionConflict" class="class">
class Bundler::Molinillo::VersionConflict
</h1>
<section class="description">
<p>An error caused by conflicts in version</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-conflicts" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">conflicts</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>@return [{String => Resolution::Conflict}] the conflicts that caused</p>
<pre class="ruby"><span class="ruby-identifier">resolution</span> <span class="ruby-identifier">to</span> <span class="ruby-identifier">fail</span>
</pre>
</div>
</div>
<div id="attribute-i-specification_provider" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">specification_provider</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>@return [SpecificationProvider] the specification provider used during</p>
<pre class="ruby"><span class="ruby-identifier">resolution</span>
</pre>
</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">(conflicts, specification_provider)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Initializes a new error with the given version conflicts. @param [{String => Resolution::Conflict}] conflicts see {#conflicts} @param [SpecificationProvider] <a href="VersionConflict.html#attribute-i-specification_provider"><code>specification_provider</code></a> see {#specification_provider}</p>
<div class="method-calls-super">
Calls superclass method
<a href="../../Exception.html#method-c-new"><code>Exception::new</code></a>
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/molinillo/lib/molinillo/errors.rb, line 66</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">conflicts</span>, <span class="ruby-identifier">specification_provider</span>)
<span class="ruby-identifier">pairs</span> = []
<span class="ruby-constant">Compatibility</span>.<span class="ruby-identifier">flat_map</span>(<span class="ruby-identifier">conflicts</span>.<span class="ruby-identifier">values</span>.<span class="ruby-identifier">flatten</span>, <span class="ruby-operator">&</span><span class="ruby-value">:requirements</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">conflicting</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">conflicting</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">source</span>, <span class="ruby-identifier">conflict_requirements</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">conflict_requirements</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">pairs</span> <span class="ruby-operator"><<</span> [<span class="ruby-identifier">c</span>, <span class="ruby-identifier">source</span>]
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">super</span> <span class="ruby-string">"Unable to satisfy the following requirements:\n\n"</span> \
<span class="ruby-node">"#{pairs.map { |r, d| "- `#{r}` required by `#{d}`" }.join("\n")}"</span>
<span class="ruby-ivar">@conflicts</span> = <span class="ruby-identifier">conflicts</span>
<span class="ruby-ivar">@specification_provider</span> = <span class="ruby-identifier">specification_provider</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-message_with_trees" class="method-detail ">
<div class="method-heading">
<span class="method-name">message_with_trees</span><span
class="method-args">(opts = {})</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>@return [String] An error message that includes requirement trees,</p>
<pre>which is much more detailed & customizable than the default message</pre>
<p>@param [Hash] opts the options to create a message with. @option opts [String] :solver_name The user-facing name of the solver @option opts [String] :possibility_type The generic name of a possibility @option opts [Proc] :reduce_trees A proc that reduced the list of requirement trees @option opts [Proc] :printable_requirement A proc that pretty-prints requirements @option opts [Proc] :additional_message_for_conflict A proc that appends additional</p>
<pre>messages for each conflict</pre>
<p>@option opts [Proc] :version_for_spec A proc that returns the version number for a</p>
<pre class="ruby"><span class="ruby-identifier">possibility</span>
</pre>
<div class="method-source-code" id="message_with_trees-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/molinillo/lib/molinillo/errors.rb, line 97</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">message_with_trees</span>(<span class="ruby-identifier">opts</span> = {})
<span class="ruby-identifier">solver_name</span> = <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-value">:solver_name</span>) { <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">name</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">'::'</span>).<span class="ruby-identifier">first</span> }
<span class="ruby-identifier">possibility_type</span> = <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-value">:possibility_type</span>) { <span class="ruby-string">'possibility named'</span> }
<span class="ruby-identifier">reduce_trees</span> = <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-value">:reduce_trees</span>) { <span class="ruby-identifier">proc</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">trees</span><span class="ruby-operator">|</span> <span class="ruby-identifier">trees</span>.<span class="ruby-identifier">uniq</span>.<span class="ruby-identifier">sort_by</span>(<span class="ruby-operator">&</span><span class="ruby-value">:to_s</span>) } }
<span class="ruby-identifier">printable_requirement</span> = <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-value">:printable_requirement</span>) { <span class="ruby-identifier">proc</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">req</span><span class="ruby-operator">|</span> <span class="ruby-identifier">req</span>.<span class="ruby-identifier">to_s</span> } }
<span class="ruby-identifier">additional_message_for_conflict</span> = <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-value">:additional_message_for_conflict</span>) { <span class="ruby-identifier">proc</span> {} }
<span class="ruby-identifier">version_for_spec</span> = <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-value">:version_for_spec</span>) { <span class="ruby-identifier">proc</span>(<span class="ruby-operator">&</span><span class="ruby-value">:to_s</span>) }
<span class="ruby-identifier">incompatible_version_message_for_conflict</span> = <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-value">:incompatible_version_message_for_conflict</span>) <span class="ruby-keyword">do</span>
<span class="ruby-identifier">proc</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">name</span>, <span class="ruby-identifier">_conflict</span><span class="ruby-operator">|</span>
<span class="ruby-node">%(#{solver_name} could not find compatible versions for #{possibility_type} "#{name}":)</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">conflicts</span>.<span class="ruby-identifier">sort</span>.<span class="ruby-identifier">reduce</span>(<span class="ruby-string">''</span>.<span class="ruby-identifier">dup</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">o</span>, (<span class="ruby-identifier">name</span>, <span class="ruby-identifier">conflict</span>)<span class="ruby-operator">|</span>
<span class="ruby-identifier">o</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"\n"</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">incompatible_version_message_for_conflict</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">conflict</span>) <span class="ruby-operator"><<</span> <span class="ruby-string">"\n"</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">conflict</span>.<span class="ruby-identifier">locked_requirement</span>
<span class="ruby-identifier">o</span> <span class="ruby-operator"><<</span> <span class="ruby-node">%( In snapshot (#{name_for_locking_dependency_source}):\n)</span>
<span class="ruby-identifier">o</span> <span class="ruby-operator"><<</span> <span class="ruby-node">%( #{printable_requirement.call(conflict.locked_requirement)}\n)</span>
<span class="ruby-identifier">o</span> <span class="ruby-operator"><<</span> <span class="ruby-string">%(\n)</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">o</span> <span class="ruby-operator"><<</span> <span class="ruby-node">%( In #{name_for_explicit_dependency_source}:\n)</span>
<span class="ruby-identifier">trees</span> = <span class="ruby-identifier">reduce_trees</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">conflict</span>.<span class="ruby-identifier">requirement_trees</span>)
<span class="ruby-identifier">o</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">trees</span>.<span class="ruby-identifier">map</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">tree</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">t</span> = <span class="ruby-string">''</span>.<span class="ruby-identifier">dup</span>
<span class="ruby-identifier">depth</span> = <span class="ruby-value">2</span>
<span class="ruby-identifier">tree</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">req</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">t</span> <span class="ruby-operator"><<</span> <span class="ruby-string">' '</span> <span class="ruby-operator">*</span> <span class="ruby-identifier">depth</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">req</span>.<span class="ruby-identifier">to_s</span>
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">tree</span>.<span class="ruby-identifier">last</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">req</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">spec</span> = <span class="ruby-identifier">conflict</span>.<span class="ruby-identifier">activated_by_name</span>[<span class="ruby-identifier">name_for</span>(<span class="ruby-identifier">req</span>)]
<span class="ruby-identifier">t</span> <span class="ruby-operator"><<</span> <span class="ruby-node">%( was resolved to #{version_for_spec.call(spec)}, which)</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">t</span> <span class="ruby-operator"><<</span> <span class="ruby-string">%( depends on)</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">t</span> <span class="ruby-operator"><<</span> <span class="ruby-string">%(\n)</span>
<span class="ruby-identifier">depth</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">t</span>
<span class="ruby-keyword">end</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">"\n"</span>)
<span class="ruby-identifier">additional_message_for_conflict</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">o</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">conflict</span>)
<span class="ruby-identifier">o</span>
<span class="ruby-keyword">end</span>.<span class="ruby-identifier">strip</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>