pub_grub 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4199b218840d39743919d5befd111f71335aecd06d0f4f09dcc9ae168fc5f04d
+  data.tar.gz: 619cca849d88ab3173f2e71f37ff6acdd3be212d7d099c329de0685a102e85fd
+SHA512:
+  metadata.gz: d17dc7b3fb90bf613053c5eeb92893468af588a46009c3c847aab45f629eb21871cbca9a3f2a7e525cc77ab14896ad0aec8d0faee786e71cb4b9f81202b759b3
+  data.tar.gz: b76ac52d2b0b8fcdce473c4233f2873c7bd88d6ada06a70b9c610500ec338ebef2f3eea8d3b2185203282ef3acff637c2ad81fd62dee6127a32fa800d545c68b

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+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 pub_grub.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    pub_grub (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.11.3)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  pub_grub!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.1

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,28 @@
+[![Build Status](https://travis-ci.org/jhawthorn/pub_grub.svg?branch=master)](https://travis-ci.org/jhawthorn/pub_grub)
+
+# PubGrub
+
+An attempt to implement [Natalie Weizenbaum's PubGrub](https://medium.com/@nex3/pubgrub-2fb6470504f), a next-generation version solving algorithm, in Ruby.
+
+## 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/pub_grub.
+
+## 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 PubGrub project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jhawthorn/pub_grub/blob/master/CODE_OF_CONDUCT.md).
+
+## See Also
+
+* [PubGrub: Next-Generation Version Solving - Natalie Weizenbaum - Medium](https://medium.com/@nex3/pubgrub-2fb6470504f)
+* [PubGrub - doc/solver.md - github](https://github.com/dart-lang/pub/blob/master/doc/solver.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,24 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pub_grub"
+
+source =
+  PubGrub::StaticPackageSource.new do |s|
+    s.add "foo", "2.0.0", deps: { "bar" => "~> 2.0" }
+    s.add "foo", "1.1.0", deps: { "bar" => "~> 1.0" }
+    s.add "foo", "1.0.0", deps: { "bar" => "~> 1.0" }
+
+    s.add "bar", "2.0.0"
+    s.add "bar", "1.0.0"
+  end
+
+foo = source.get_package("foo")
+bar = source.get_package("bar")
+
+solver = VersionSolver.new(source: source)
+
+require 'irb'
+IRB.setup(__FILE__)
+workspace = IRB::WorkSpace.new(binding)
+IRB::Irb.new(workspace).run(IRB.conf)

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/lib/pub_grub.rb

@@ -0,0 +1,18 @@
+require "pub_grub/package"
+require "pub_grub/static_package_source"
+require "pub_grub/term"
+require "pub_grub/version_constraint"
+require "pub_grub/version_solver"
+require "pub_grub/incompatibility"
+require 'pub_grub/solve_failure'
+require 'pub_grub/failure_writer'
+
+require "logger"
+
+module PubGrub
+  class << self
+    attr_accessor :logger
+  end
+  self.logger = Logger.new(STDERR)
+  self.logger.level = Logger::WARN
+end

data/lib/pub_grub/assignment.rb

@@ -0,0 +1,20 @@
+module PubGrub
+  class Assignment
+    attr_reader :term, :cause, :decision_level, :index
+    def initialize(term, cause, decision_level, index)
+      @term = term
+      @cause = cause
+      @decision_level = decision_level
+      @index = index
+    end
+
+    def self.decision(version, decision_level, index)
+      term = Term.new(VersionConstraint.exact(version), true)
+      new(term, :decision, decision_level, index)
+    end
+
+    def decision?
+      cause == :decision
+    end
+  end
+end

data/lib/pub_grub/failure_writer.rb

@@ -0,0 +1,179 @@
+module PubGrub
+  class FailureWriter
+    def initialize(root)
+      @root = root
+
+      # { Incompatibility => Integer }
+      @derivations = {}
+
+      # [ [ String, Integer or nil ] ]
+      @lines = []
+
+      # { Incompatibility => Integer }
+      @line_numbers = {}
+
+      count_derivations(root)
+    end
+
+    def write
+      visit(@root)
+
+      padding = @line_numbers.empty? ? 0 : "(#{@line_numbers.values.last}) ".length
+
+      @lines.map do |message, number|
+        next "" if message.empty?
+
+        lead = number ? "(#{number}) " : ""
+        lead = lead.ljust(padding)
+        "#{lead}#{message}"
+      end.join("\n")
+    end
+
+    private
+
+    def write_line(incompatibility, message, numbered:)
+      if numbered
+        number = @line_numbers.length + 1
+        @line_numbers[incompatibility] = number
+      end
+
+      @lines << [message, number]
+    end
+
+    def visit(incompatibility, conclusion: false)
+      raise unless incompatibility.conflict?
+
+      numbered = conclusion || @derivations[incompatibility] > 1;
+      conjunction = conclusion || incompatibility == @root ? "So," : "And"
+
+      cause = incompatibility.cause
+
+      if cause.conflict.conflict? && cause.other.conflict?
+        conflict_line = @line_numbers[cause.conflict]
+        other_line = @line_numbers[cause.other]
+
+        if conflict_line && other_line
+          write_line(
+            incompatibility,
+            "Because #{cause.conflict} (#{conflict_line}) and #{cause.other} (#{other_line}), #{incompatibility}.",
+            numbered: numbered
+          )
+        elsif conflict_line || other_line
+          with_line    = conflict_line ? cause.conflict : cause.other
+          without_line = conflict_line ? cause.other : cause.conflict
+          line = @line_numbers[with_line]
+
+          visit(without_line);
+          write_line(
+            incompatibility,
+            "#{conjunction} because #{with_line} (#{line}), #{incompatibility}.",
+            numbered: numbered
+          )
+        else
+          single_line_conflict = single_line?(cause.conflict.cause)
+          single_line_other    = single_line?(cause.other.cause)
+
+          if single_line_conflict || single_line_other
+            first  = single_line_other ? cause.conflict : cause.other
+            second = single_line_other ? cause.other : cause.conflict
+            visit(first)
+            visit(second)
+            write_line(
+              incompatibility,
+              "Thus, #{incompatibility}.",
+              numbered: numbered
+            )
+          else
+            visit(cause.conflict, conclusion: true)
+            @lines << ["", nil]
+            visit(cause.other)
+
+            write_line(
+              incompatibility,
+              "#{conjunction} because #{cause.conflict} (#{@line_numbers[cause.conflict]}), #{incompatibility}.",
+              numbered: numbered
+            )
+          end
+        end
+      elsif cause.conflict.conflict? || cause.other.conflict?
+        derived = cause.conflict.conflict? ? cause.conflict : cause.other
+        ext     = cause.conflict.conflict? ? cause.other : cause.conflict
+
+        derived_line = @line_numbers[derived]
+        if derived_line
+          write_line(
+            incompatibility,
+            "Because #{ext} and #{derived} (#{derived_line}), #{incompatibility}.",
+            numbered: numbered
+          )
+        elsif collapsible?(derived)
+          derived_cause = derived.cause
+          if derived_cause.conflict.conflict?
+            collapsed_derived = derived_cause.conflict
+            collapsed_ext = derived_cause.other
+          else
+            collapsed_derived = derived_cause.other
+            collapsed_ext = derived_cause.conflict
+          end
+
+          visit(collapsed_derived)
+
+          write_line(
+            incompatibility,
+            "#{conjunction} because #{collapsed_ext} and #{ext}, #{incompatibility}.",
+            numbered: numbered
+          )
+        else
+          visit(derived)
+          write_line(
+            incompatibility,
+            "#{conjunction} because #{ext}, #{incompatibility}.",
+            numbered: numbered
+          )
+        end
+      else
+        write_line(
+          incompatibility,
+          "Because #{cause.conflict} and #{cause.other}, #{incompatibility}.",
+          numbered: numbered
+        )
+      end
+    end
+
+    def single_line?(cause)
+      !cause.conflict.conflict? && !cause.other.conflict?
+    end
+
+    def collapsible?(incompatibility)
+      return false if @derivations[incompatibility] > 1
+
+      cause = incompatibility.cause
+      # If incompatibility is derived from two derived incompatibilities,
+      # there are too many transitive causes to display concisely.
+      return false if cause.conflict.conflict? && cause.other.conflict?
+
+      # If incompatibility is derived from two external incompatibilities, it
+      # tends to be confusing to collapse it.
+      return false unless cause.conflict.conflict? || cause.other.conflict?
+
+      # If incompatibility's internal cause is numbered, collapsing it would
+      # get too noisy.
+      complex = cause.conflict.conflict? ? cause.conflict : cause.other
+
+      !@line_numbers.has_key?(complex)
+    end
+
+    def count_derivations(incompatibility)
+      if @derivations.has_key?(incompatibility)
+        @derivations[incompatibility] += 1
+      else
+        @derivations[incompatibility] = 1
+        if incompatibility.conflict?
+          cause = incompatibility.cause
+          count_derivations(cause.conflict)
+          count_derivations(cause.other)
+        end
+      end
+    end
+  end
+end