molinillo 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f860bde0bd4aed39aadb78bce1dd854bedf9d34e
-  data.tar.gz: eaebd8e7e9070425f2c4c80b65fc562ff8fe210a
+  metadata.gz: 5ea85c0037f78e6763d19bf7d8144c33eccb1a28
+  data.tar.gz: da1f09939f213f0e93bc644a8ba021000c79db9e
 SHA512:
-  metadata.gz: 2ede3f0f7aecfdf3aab7be57f3bf23f2c23e2fe440aa8c470bcfd5bdd212941aa4ad52dd5a958886448c64fd515af63ce9342dd343912d8f8213cfbc5ff6ddbf
-  data.tar.gz: 82b5e19bb50aa3db372c838fca16a8b61628ca7bd9cfd9aa525d9cd7af4218768bf48e21b9801232959993cd258207e4deeb4356fd6b575d781af9ba2ebd7065
+  metadata.gz: a84d8bde06c58dcf77fe69d9128c964a35077226a8cb5b9f9af6d4aa78592426491b35e62371565d2654f035302a7797deda05584c778e6d58e4575291bc5c5e
+  data.tar.gz: 40f4b4b9282474acee27715541f6d2f3c5153b1e333c1ed84f42d04aa09f8aeb4e024f6010abae83d958c41baa7c596002a2457c69ec008573efccac9824cf93

data/lib/molinillo.rb

@@ -3,3 +3,7 @@ require 'molinillo/errors'
 require 'molinillo/resolver'
 require 'molinillo/modules/ui'
 require 'molinillo/modules/specification_provider'
+
+# Molinillo is a generic dependency resolution algorithm.
+module Molinillo
+end

data/lib/molinillo/dependency_graph.rb

@@ -14,8 +14,10 @@ module Molinillo
 
     include TSort
 
+    # @visibility private
     alias_method :tsort_each_node, :each
 
+    # @visibility private
     def tsort_each_child(vertex, &block)
       vertex.successors.each(&block)
     end
@@ -41,12 +43,14 @@ module Molinillo
     #   by {Vertex#name}
     attr_reader :vertices
 
+    # Initializes an empty dependency graph
     def initialize
       @vertices = {}
     end
 
     # Initializes a copy of a {DependencyGraph}, ensuring that all {#vertices}
     # are properly copied.
+    # @param [DependencyGraph] other the graph to copy.
     def initialize_copy(other)
       super
       @vertices = {}
@@ -100,6 +104,7 @@ module Molinillo
       vertex
     end
 
+    # Adds a vertex with the given name, or updates the existing one.
     # @param [String] name
     # @param [Object] payload
     # @return [Vertex] the vertex that was added to `self`
@@ -150,6 +155,8 @@ module Molinillo
 
     private
 
+    # Adds a new {Edge} to the dependency graph without checking for
+    # circularity.
     def add_edge_no_circular(origin, destination, requirement)
       edge = Edge.new(origin, destination, requirement)
       origin.outgoing_edges << edge
@@ -174,6 +181,7 @@ module Molinillo
       attr_accessor :root
       alias_method :root?, :root
 
+      # Initializes a vertex with the given name and payload.
       # @param [String] name see {#name}
       # @param [Object] payload see {#payload}
       def initialize(name, payload)
@@ -240,6 +248,7 @@ module Molinillo
           successors.to_set == other.successors.to_set
       end
 
+      # @param  [Vertex] other the other vertex to compare to
       # @return [Boolean] whether the two vertices are equal, determined
       #   solely by {#name} and {#payload} equality
       def shallow_eql?(other)

data/lib/molinillo/errors.rb

@@ -11,6 +11,7 @@ module Molinillo
     # @return [Array<Object>] the specifications that depended upon {#dependency}
     attr_accessor :required_by
 
+    # Initializes a new error with the given missing dependency.
     # @param [Object] dependency @see {#dependency}
     # @param [Array<Object>] required_by @see {#required_by}
     def initialize(dependency, required_by = [])
@@ -19,6 +20,8 @@ module Molinillo
       super()
     end
 
+    # The error message for the missing dependency, including the specifications
+    # that had this dependency.
     def message
       sources = required_by.map { |r| "`#{r}`" }.join(' and ')
       message = "Unable to find a specification for `#{dependency}`"
@@ -36,6 +39,7 @@ module Molinillo
     # [Set<Object>] the dependencies responsible for causing the error
     attr_reader :dependencies
 
+    # Initializes a new error with the given circular vertices.
     # @param [Array<DependencyGraph::Vertex>] nodes the nodes in the dependency
     #   that caused the error
     def initialize(nodes)
@@ -50,6 +54,7 @@ module Molinillo
     #   resolution to fail
     attr_reader :conflicts
 
+    # Initializes a new error with the given version conflicts.
     # @param [{String => Resolution::Conflict}] conflicts see {#conflicts}
     def initialize(conflicts)
       pairs = []

data/lib/molinillo/gem_metadata.rb

@@ -1,3 +1,4 @@
 module Molinillo
-  VERSION = '0.4.0'
+  # The version of Molinillo.
+  VERSION = '0.4.1'.freeze
 end

data/lib/molinillo/resolution.rb

@@ -38,6 +38,7 @@ module Molinillo
       # @return [Array] the dependencies that were explicitly required
       attr_reader :original_requested
 
+      # Initializes a new resolution.
       # @param [SpecificationProvider] specification_provider
       #   see {#specification_provider}
       # @param [UI] resolver_ui see {#resolver_ui}

data/lib/molinillo/resolver.rb

@@ -3,7 +3,7 @@ require 'molinillo/dependency_graph'
 module Molinillo
   # This class encapsulates a dependency resolver.
   # The resolver is responsible for determining which set of dependencies to
-  # activate, with feedback from the the {#specification_provider}
+  # activate, with feedback from the {#specification_provider}
   #
   #
   class Resolver
@@ -17,6 +17,7 @@ module Molinillo
     #   during the resolution process
     attr_reader :resolver_ui
 
+    # Initializes a new resolver.
     # @param  [SpecificationProvider] specification_provider
     #   see {#specification_provider}
     # @param  [UI] resolver_ui

data/lib/molinillo/state.rb

@@ -1,12 +1,12 @@
 module Molinillo
   # A state that a {Resolution} can be in
-  # @attr [String] name
-  # @attr [Array<Object>] requirements
-  # @attr [DependencyGraph] activated
-  # @attr [Object] requirement
-  # @attr [Object] possibility
-  # @attr [Integer] depth
-  # @attr [Set<Object>] conflicts
+  # @attr [String] name the name of the current requirement
+  # @attr [Array<Object>] requirements currently unsatisfied requirements
+  # @attr [DependencyGraph] activated the graph of activated dependencies
+  # @attr [Object] requirement the current requirement
+  # @attr [Object] possibilities the possibilities to satisfy the current requirement
+  # @attr [Integer] depth the depth of the resolution
+  # @attr [Set<Object>] conflicts unresolved conflicts
   ResolutionState = Struct.new(
     :name,
     :requirements,

data/spec/dependency_graph_spec.rb

@@ -4,59 +4,49 @@ module Molinillo
   describe DependencyGraph do
     describe 'in general' do
       before do
-        @graph = DependencyGraph.new
+        @graph = described_class.new
         @root  = @graph.add_vertex('Root', 'Root', true)
         @root2 = @graph.add_vertex('Root2', 'Root2', true)
         @child = @graph.add_child_vertex('Child', 'Child', %w(Root), 'Child')
       end
 
       it 'returns root vertices by name' do
-        @graph.root_vertex_named('Root').
-          should.equal @root
+        expect(@graph.root_vertex_named('Root')).to eq(@root)
       end
 
       it 'returns vertices by name' do
-        @graph.vertex_named('Root').
-          should.equal @root
-        @graph.vertex_named('Child').
-          should.equal @child
+        expect(@graph.vertex_named('Root')).to eq(@root)
+        expect(@graph.vertex_named('Child')).to eq(@child)
       end
 
       it 'returns nil for non-existant root vertices' do
-        @graph.root_vertex_named('missing').
-          should.equal nil
+        expect(@graph.root_vertex_named('missing')).to be_nil
       end
 
       it 'returns nil for non-existant vertices' do
-        @graph.vertex_named('missing').
-          should.equal nil
+        expect(@graph.vertex_named('missing')).to be_nil
       end
     end
 
     describe 'detaching a node' do
       before do
-        @graph = DependencyGraph.new
+        @graph = described_class.new
       end
 
       it 'detaches a root vertex without successors' do
         root = @graph.add_vertex('root', 'root', true)
         @graph.detach_vertex_named(root.name)
-        @graph.vertex_named(root.name).
-          should.equal nil
-        @graph.vertices.count.
-          should.equal 0
+        expect(@graph.vertex_named(root.name)).to be_nil
+        expect(@graph.vertices).to be_empty
       end
 
       it 'detaches a root vertex with successors' do
         root = @graph.add_vertex('root', 'root', true)
         child = @graph.add_child_vertex('child', 'child', %w(root), 'child')
         @graph.detach_vertex_named(root.name)
-        @graph.vertex_named(root.name).
-          should.equal nil
-        @graph.vertex_named(child.name).
-          should.equal nil
-        @graph.vertices.count.
-          should.equal 0
+        expect(@graph.vertex_named(root.name)).to be_nil
+        expect(@graph.vertex_named(child.name)).to be_nil
+        expect(@graph.vertices).to be_empty
       end
 
       it 'detaches a root vertex with successors with other parents' do
@@ -64,14 +54,10 @@ module Molinillo
         root2 = @graph.add_vertex('root2', 'root2', true)
         child = @graph.add_child_vertex('child', 'child', %w(root root2), 'child')
         @graph.detach_vertex_named(root.name)
-        @graph.vertex_named(root.name).
-          should.equal nil
-        @graph.vertex_named(child.name).
-          should.equal child
-        child.predecessors.
-          should.equal [root2]
-        @graph.vertices.count.
-          should.equal 2
+        expect(@graph.vertex_named(root.name)).to be_nil
+        expect(@graph.vertex_named(child.name)).to eq(child)
+        expect(child.predecessors).to eq([root2])
+        expect(@graph.vertices.count).to eq(2)
       end
     end
   end

data/spec/resolver_spec.rb

@@ -14,7 +14,6 @@ module Molinillo
 
     attr_accessor :name, :requested, :base, :conflicts, :resolver, :result, :index
 
-    # rubocop:disable Metrics/MethodLength
     def initialize(fixture_path)
       File.open(fixture_path) do |fixture|
         JSON.load(fixture).tap do |test_case|
@@ -54,7 +53,6 @@ module Molinillo
 
       self.resolver = Resolver.new(index, TestUI.new)
     end
-    # rubocop:enable Metrics/MethodLength
   end
 
   describe Resolver do
@@ -65,27 +63,25 @@ module Molinillo
           resolve = lambda { test_case.resolver.resolve(test_case.requested, test_case.base) }
 
           if test_case.conflicts.any?
-            error = should.raise ResolverError do
-              resolve.call
+            expect { resolve.call }.to raise_error do |error|
+              expect(error).to be_a(ResolverError)
+              names = case error
+                      when CircularDependencyError
+                        error.dependencies.map(&:name)
+                      when VersionConflict
+                        error.conflicts.keys
+                      end.to_set
+              expect(names).to eq(test_case.conflicts)
             end
-
-            names = case error
-                    when CircularDependencyError
-                      error.dependencies.map(&:name)
-                    when VersionConflict
-                      error.conflicts.keys
-                    end.to_set
-            names.should.equal test_case.conflicts
           else
             result = resolve.call
 
             pretty_dependencies = lambda do |dg|
               dg.vertices.values.map { |v| "#{v.payload.name} (#{v.payload.version})" }.sort
             end
-            pretty_dependencies.call(result).should.
-              equal pretty_dependencies.call(test_case.result)
+            expect(pretty_dependencies.call(result)).to eq(pretty_dependencies.call(test_case.result))
 
-            result.should.equal test_case.result
+            expect(result).to eq(test_case.result)
           end
         end
       end
@@ -93,36 +89,35 @@ module Molinillo
 
     describe 'in general' do
       before do
-        @resolver = Resolver.new(TestIndex.new('awesome'), TestUI.new)
+        @resolver = described_class.new(TestIndex.new('awesome'), TestUI.new)
       end
 
       it 'can resolve a list of 0 requirements' do
-        @resolver.resolve([], DependencyGraph.new).
-          should.equal DependencyGraph.new
+        expect(@resolver.resolve([], DependencyGraph.new)).to eq(DependencyGraph.new)
       end
 
       it 'includes the source of a user-specified unsatisfied dependency' do
-        should.raise VersionConflict do
+        expect do
           @resolver.resolve([VersionKit::Dependency.new('missing', '3.0')], DependencyGraph.new)
-        end.message.should.match /required by `user-specified dependency`/
+        end.to raise_error(VersionConflict, /required by `user-specified dependency`/)
       end
 
       it 'can handle when allow_missing? returns true for the only requirement' do
         dep = VersionKit::Dependency.new('missing', '3.0')
-        @resolver.specification_provider.stubs(:allow_missing?).with(dep).returns(true)
-        @resolver.resolve([dep], DependencyGraph.new).to_a.should == []
+        allow(@resolver.specification_provider).to receive(:allow_missing?).with(dep).and_return(true)
+        expect(@resolver.resolve([dep], DependencyGraph.new).to_a).to be_empty
       end
 
       it 'can handle when allow_missing? returns true for a nested requirement' do
-        index = TestIndex.new('awesome')
         dep = VersionKit::Dependency.new('actionpack', '1.2.3')
-        @resolver.specification_provider.stubs(:allow_missing?).
-          with { |d| d.name == 'activesupport' }.returns(true)
-        @resolver.specification_provider.stubs(:search_for).
-          with { |d| d.name == 'activesupport' }.returns([])
-        @resolver.specification_provider.stubs(:search_for).
-          with { |d| d.name == 'actionpack' }.returns(index.search_for(dep))
-        @resolver.resolve([dep], DependencyGraph.new).map(&:payload).map(&:to_s).should == ['actionpack (1.2.3)']
+        allow(@resolver.specification_provider).to receive(:allow_missing?).
+          with(have_attributes(:name => 'activesupport')).and_return(true)
+        allow(@resolver.specification_provider).to receive(:search_for).
+          with(have_attributes(:name => 'activesupport')).and_return([])
+        allow(@resolver.specification_provider).to receive(:search_for).
+          with(have_attributes(:name => 'actionpack')).and_call_original
+        resolved = @resolver.resolve([dep], DependencyGraph.new)
+        expect(resolved.map(&:payload).map(&:to_s)).to eq(['actionpack (1.2.3)'])
       end
     end
   end

data/spec/spec_helper.rb

@@ -1,8 +1,9 @@
+require 'bundler/setup'
 
 # Set up coverage analysis
 #-----------------------------------------------------------------------------#
 
-if (ENV['CI'] || ENV['GENERATE_COVERAGE']) && RUBY_VERSION >= '2.0.0'
+if (ENV['CI'] || ENV['GENERATE_COVERAGE']) && RUBY_VERSION >= '2.0.0' && Bundler.current_ruby.mri?
   require 'simplecov'
   require 'codeclimate-test-reporter'
 
@@ -26,9 +27,5 @@ ROOT = Pathname.new(File.expand_path('../../', __FILE__))
 $LOAD_PATH.unshift((ROOT + 'lib').to_s)
 $LOAD_PATH.unshift((ROOT + 'spec').to_s)
 
-require 'bundler/setup'
-require 'bacon'
-require 'mocha-on-bacon'
-require 'pretty_bacon'
 require 'version_kit'
 require 'molinillo'

data/spec/state_spec.rb

@@ -4,7 +4,7 @@ module Molinillo
   describe ResolutionState do
     describe DependencyState do
       before do
-        @state = DependencyState.new(
+        @state = described_class.new(
           'name',
           %w(requirement1 requirement2 requirement3),
           DependencyGraph.new,
@@ -18,15 +18,11 @@ module Molinillo
       it 'pops a possibility state' do
         possibility_state = @state.pop_possibility_state
         %w(name requirements activated requirement conflicts).each do |attr|
-          possibility_state.send(attr).
-            should.equal @state.send(attr)
+          expect(possibility_state.send(attr)).to eq(@state.send(attr))
         end
-        possibility_state.is_a?(PossibilityState).
-          should.be.true?
-        possibility_state.depth.
-          should.equal @state.depth + 1
-        possibility_state.possibilities.
-          should.equal %w(possibility)
+        expect(possibility_state).to be_a(PossibilityState)
+        expect(possibility_state.depth).to eq(@state.depth + 1)
+        expect(possibility_state.possibilities).to eq(%w(possibility))
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: molinillo
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Samuel E. Giddins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-27 00:00:00.000000000 Z
+date: 2015-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Provides support for dependency resolution
@@ -97,3 +97,4 @@ test_files:
 - spec/spec_helper/ui.rb
 - spec/spec_helper.rb
 - spec/state_spec.rb
+has_rdoc: