bundler-explain 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 71233be6dbcd5f33d7b78ba62fd540ab48ea6d678847f5e98c254f96771a13dd
+  data.tar.gz: 8178fbaf874bd939475a7f27fdbc0c5a61779d7a1f56867f9fd059ce7da800cf
+SHA512:
+  metadata.gz: 6ccd871f7efa7dd3f4cf4539249fc3d5703332ad774d014004f49af062616c1b08425b996496ae6dab6969cee9be280e9fb94e1b40a7915923dddec0e5abd33f
+  data.tar.gz: f1800d2772a5683d0dcacd5d4c1c891cd1e6d3e12eaf9a1834035ac6c310d2ebf8875713730666d7de2dfc40037f3a477d9a0e7cf0f5399d97a63581e3668998

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at john@hawthorn.email. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in bundler-explain.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 John Hawthorn
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,83 @@
+# bundler-explain
+
+This project aims to give better explanations conflicts on bundle install.
+
+Consider this Gemfile:
+
+```
+gem 'rails', '~> 5.0.0'
+gem 'quiet_assets'
+```
+
+Running bundle update we get this error:
+
+```
+Bundler could not find compatible versions for gem "rails":
+  In Gemfile:
+    rails (~> 5.0.0)
+
+Could not find gem 'rails (~> 5.0.0)' in any of the sources.
+
+Bundler could not find compatible versions for gem "railties":
+  In Gemfile:
+    quiet_assets was resolved to 1.0.1, which depends on
+      railties (~> 3.1)
+
+    rails (~> 5.0.0) was resolved to 5.0.0, which depends on
+      railties (= 5.0.0)
+```
+
+bundler has tried every version of `quiet_assets` and `rails`, and found that
+none are compatible. However it's a little unclear from this.
+
+Bundler can only report one of the many failed combinations it has tried (here
+`rails 5.0.0` and `quiet_assets 1.0.1`, neither of which the most recent
+version).
+
+bundler-explain aims to show the user why there are no possible solutions:
+
+```
+Because quiet_assets 1.0.1 depends on railties ~> 3.1
+  and quiet_assets <= 1.0.0 depends on rails ~> 3.1,
+  quiet_assets <= 1.0.0 OR 1.0.1 requires railties ~> 3.1 or rails ~> 3.1.
+And because quiet_assets >= 1.0.2 depends on railties < 5.0, >= 3.1,
+  either railties < 5.0, >= 3.1 or rails ~> 3.1.
+So, because rails >= 5.0.0, <= 5.0.7 depends on railties ~> 5.0.0
+  and root depends on rails ~> 5.0.0,
+  version solving has failed.
+```
+
+With more gems, bundler's output will be more verbose but bundler-explain will
+only describe relevant gems. [See a more complex example](https://gist.github.com/jhawthorn/480dab06ade950161d3bd0db0018538e).
+
+bundler-explain uses [PubGrub](https://github.com/jhawthorn/pub_grub) to
+determine the cause of the failure.
+
+## Installation and Usage
+
+```
+$ bundler plugin install bundler-explain
+```
+
+This will install the `bundler-explain` plugin and `bundle update` will now use
+bundler-explain's error messages.
+
+![](http://i.hawth.ca/s/Ln3zIDao.png)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jhawthorn/bundler-explain. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Bundler::Explain project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jhawthorn/bundler-explain/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bundler/explain"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bundler-explain.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "bundler/explain/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bundler-explain"
+  spec.version       = Bundler::Explain::VERSION
+  spec.authors       = ["John Hawthorn"]
+  spec.email         = ["john@hawthorn.email"]
+
+  spec.summary       = %q{Explains bundle update conflicts}
+  spec.description   = %q{Gives better explanations of conflicts when running bundle update.}
+  spec.homepage      = "https://github.com/jhawthorn/bundler-explain"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "bundler", "~> 1.16"
+  spec.add_dependency "pub_grub", "~> 0.2.0"
+
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/bundler/explain.rb

@@ -0,0 +1,13 @@
+require "bundler"
+require "bundler/explain/version"
+require "bundler/explain/source"
+
+module Bundler
+  module Explain
+    def self.register
+      Bundler::Plugin.add_hook('before-install-all') do |dependencies|
+        require "bundler/explain/overrides"
+      end
+    end
+  end
+end

data/lib/bundler/explain/overrides.rb

@@ -0,0 +1,39 @@
+require 'pub_grub'
+require "bundler/explain/source"
+
+Bundler::Resolver.prepend(Module.new do
+  def version_conflict_message(e)
+    definition = Bundler.definition
+    requirements = definition.send(:expanded_dependencies)
+    platform = @platforms.first # probably wrong
+
+    source = Bundler::Explain::Source.new(
+      resolver: self,
+      requirements: requirements,
+      platform: platform
+    )
+
+    solver = PubGrub::VersionSolver.new(source: source)
+
+    begin
+      solver.solve
+    rescue PubGrub::SolveFailure => e
+      # Great. PubGrub found the source of the conflict.
+      # Let's report it to the user.
+      return <<MSG
+Bundler could not find compatible versions of all gems.
+
+This explanation comes from bundler-explain, please report any issues to
+https://github.com/jhawthorn/bundler-explain/issues
+
+#{e.explanation}
+MSG
+    rescue
+      # If PubGrub fails for any reason, ignore it
+    end
+
+    # We weren't able to find the cause using PubGrub.
+    # Fall back to bundler's built-in error reporting.
+    super
+  end
+end)

data/lib/bundler/explain/source.rb

@@ -0,0 +1,168 @@
+require 'pub_grub'
+
+module Bundler
+  module Explain
+    class Source
+      def initialize(requirements:, platform:, resolver:)
+        @definition = Bundler.definition(true)
+        @requirements = requirements
+        @resolver = resolver
+
+        @specs_by_name = Hash.new do |h, name|
+          @resolver.search_for(Bundler::DepProxy.new(Gem::Dependency.new(name), platform)).reverse
+        end
+
+        @sorted_specs_by_name = Hash.new do |h, name|
+          h[name] = @specs_by_name[name].sort_by(&:version)
+        end
+
+        @package_by_name = Hash.new do |h, name|
+          h[name] =
+            PubGrub::Package.new(name) do |package|
+              @specs_by_name[name].each do |spec_group|
+                package.add_version spec_group.version.to_s
+              end
+            end
+        end
+
+        @deps_by_spec = Hash.new do |h, s|
+          h[s] = s.dependencies_for_activated_platforms.map do |dep|
+            [dep.name, dep.requirement]
+          end.to_h
+        end
+      end
+
+      def incompatibilities_for(version)
+        return enum_for(__method__, version) unless block_given?
+
+        package = version.package
+
+        if version == PubGrub::Package.root_version
+          source_constraint = PubGrub::VersionConstraint.exact(version)
+          source_term = PubGrub::Term.new(source_constraint, true)
+
+          @requirements.each do |dependency|
+            target_constraint = constraint_for_dep(dependency.name, dependency.dep.requirement)
+            target_term = PubGrub::Term.new(target_constraint, false)
+
+            yield PubGrub::Incompatibility.new([source_term, target_term], cause: :dependency)
+          end
+        else
+          specs = @specs_by_name[version.package.name]
+          spec = specs.detect { |s| s.version.to_s == version.name }
+          raise "can't find spec" unless spec
+
+          @deps_by_spec[spec].each do |dep_name, dep_requirement|
+            # Default case
+            target_constraint = constraint_for_dep(dep_name, dep_requirement)
+            source_constraint = range_constraint(spec) do |near_spec|
+              @deps_by_spec[near_spec][dep_name] == dep_requirement
+            end
+            yield dependency_incompatiblity(source_constraint, target_constraint)
+
+            # Special case: exact dependencies (like rails 5.0.7 requires)
+            # We want to add an extra loosened (semver-like) dependency in
+            # addition to the exact dependency above.
+            if dep_requirement.exact?
+              dep_version = dep_requirement.requirements[0][1]
+              if dep_version == spec.version
+                derived_requirements(dep_version).each do |new_requirement|
+                  next unless new_requirement === dep_version
+
+                  target_constraint = constraint_for_dep(dep_name, new_requirement)
+                  source_constraint = range_constraint(spec) do |near_spec|
+                    near_dep = @deps_by_spec[near_spec][dep_name]
+
+                    near_dep && near_dep.exact? && new_requirement === near_dep.requirements[0][1]
+                  end
+
+                  yield dependency_incompatiblity(source_constraint, target_constraint)
+                end
+              end
+            end
+          end
+        end
+      end
+
+      private
+
+      def derived_requirements(original_version)
+        return enum_for(__method__, original_version) unless block_given?
+
+        v = original_version
+        s = original_version.segments
+
+        return [] unless s.length == 3
+
+        yield Gem::Requirement.new(">= #{s[0]}.#{s[1]}.a", "< #{v.release}")
+        yield Gem::Requirement.new(["~> #{s[0]}.#{s[1]}.0"])
+        yield Gem::Requirement.new(["~> #{s[0]}.#{s[1]}.0.a"])
+        yield Gem::Requirement.new(["~> #{s[0]}.0.a"])
+      end
+
+      def dependency_incompatiblity(source_constraint, target_constraint)
+        source_term = PubGrub::Term.new(source_constraint, true)
+        target_term = PubGrub::Term.new(target_constraint, false)
+        PubGrub::Incompatibility.new([source_term, target_term], cause: :dependency)
+      end
+
+      def range_constraint(spec, &block)
+        sorted_specs = @sorted_specs_by_name[spec.name]
+        package = @package_by_name[spec.name]
+
+        low, high = range_matching(sorted_specs, sorted_specs.index(spec), &block)
+        constraint_between_specs(package, low && sorted_specs[low], high && sorted_specs[high])
+      end
+
+      def constraint_between_specs(package, low_spec, high_spec)
+        low_version = low_spec && low_spec.version
+        high_version = high_spec && high_spec.version
+
+        if !low_spec && !high_spec
+          PubGrub::VersionConstraint.any(package)
+        elsif low_spec == high_spec
+          PubGrub::VersionConstraint.exact(package.version(low_version.to_s))
+        else
+          low = ">= #{low_version}" if low_spec
+          high = "<= #{high_version}" if high_spec
+          PubGrub::VersionConstraint.new(package, [low, high].compact)
+        end
+      end
+
+      def range_matching(sorted_list, index)
+        low = high = index
+
+        raise "range_matching started at non-matching index" unless yield(sorted_list[index])
+
+        loop do
+          high += 1
+          if high >= sorted_list.length
+            high = nil
+            break
+          end
+          break unless yield(sorted_list[high])
+        end
+
+        loop do
+          low -= 1
+          if low < 0
+            low = nil
+            break
+          end
+          break unless yield(sorted_list[low])
+        end
+
+        [low && low + 1, high && high - 1]
+      end
+
+      def constraint_for_dep(name, requirement)
+        package = @package_by_name[name]
+
+        # This is awful. We should try to reuse Gem::Requirement
+        requirement = requirement.to_s.split(", ")
+
+        PubGrub::VersionConstraint.new(package, requirement)
+      end
+    end
+  end
+end

data/lib/bundler/explain/version.rb

@@ -0,0 +1,5 @@
+module Bundler
+  module Explain
+    VERSION = "0.1.0"
+  end
+end

data/plugins.rb

@@ -0,0 +1,2 @@
+require 'bundler/explain'
+Bundler::Explain.register

data/test.rb

@@ -0,0 +1,39 @@
+$LOAD_PATH.unshift "./lib"
+require 'bundler/explain'
+require 'pub_grub'
+
+ENV['DEBUG'] = 'true'
+
+Bundler.ui = Bundler::UI::Shell.new
+PubGrub.logger.level = Logger::DEBUG
+
+definition = Bundler.definition(true)
+requirements = definition.send(:expanded_dependencies)
+platform = definition.platforms.first # probably wrong
+resolver = definition.instance_eval do
+  @remote = true
+  sources.remote!
+
+  platforms = Set.new(platforms)
+  base = Bundler::SpecSet.new([])
+  Bundler::Resolver.new(index, source_requirements, base, gem_version_promoter, additional_base_requirements_for_resolve, platforms)
+end
+
+# Because we don't #start, we need to hack some things in
+resolver.instance_eval do
+  @prerelease_specified = {}
+  requirements.each {|dep| @prerelease_specified[dep.name] ||= dep.prerelease? }
+
+  verify_gemfile_dependencies_are_found!(requirements)
+end
+
+source = Bundler::Explain::Source.new(
+  requirements: requirements,
+  resolver: resolver,
+  platform: platform
+)
+
+solver = PubGrub::VersionSolver.new(source: source)
+result = solver.solve
+
+pp result

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: bundler-explain
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- John Hawthorn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pub_grub
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Gives better explanations of conflicts when running bundle update.
+email:
+- john@hawthorn.email
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bundler-explain.gemspec
+- lib/bundler/explain.rb
+- lib/bundler/explain/overrides.rb
+- lib/bundler/explain/source.rb
+- lib/bundler/explain/version.rb
+- plugins.rb
+- test.rb
+homepage: https://github.com/jhawthorn/bundler-explain
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Explains bundle update conflicts
+test_files: []