rubygems-update 2.6.4 → 2.6.5

data/bundler/lib/bundler/vendor/molinillo/lib/molinillo/dependency_graph.rb

@@ -0,0 +1,203 @@
+# frozen_string_literal: true
+require 'set'
+require 'tsort'
+
+require 'bundler/vendor/molinillo/lib/molinillo/dependency_graph/log'
+require 'bundler/vendor/molinillo/lib/molinillo/dependency_graph/vertex'
+
+module Bundler::Molinillo
+  # A directed acyclic graph that is tuned to hold named dependencies
+  class DependencyGraph
+    include Enumerable
+
+    # Enumerates through the vertices of the graph.
+    # @return [Array<Vertex>] The graph's vertices.
+    def each
+      return vertices.values.each unless block_given?
+      vertices.values.each { |v| yield v }
+    end
+
+    include TSort
+
+    # @!visibility private
+    alias tsort_each_node each
+
+    # @!visibility private
+    def tsort_each_child(vertex, &block)
+      vertex.successors.each(&block)
+    end
+
+    # Topologically sorts the given vertices.
+    # @param [Enumerable<Vertex>] vertices the vertices to be sorted, which must
+    #   all belong to the same graph.
+    # @return [Array<Vertex>] The sorted vertices.
+    def self.tsort(vertices)
+      TSort.tsort(
+        lambda { |b| vertices.each(&b) },
+        lambda { |v, &b| (v.successors & vertices).each(&b) }
+      )
+    end
+
+    # A directed edge of a {DependencyGraph}
+    # @attr [Vertex] origin The origin of the directed edge
+    # @attr [Vertex] destination The destination of the directed edge
+    # @attr [Object] requirement The requirement the directed edge represents
+    Edge = Struct.new(:origin, :destination, :requirement)
+
+    # @return [{String => Vertex}] the vertices of the dependency graph, keyed
+    #   by {Vertex#name}
+    attr_reader :vertices
+
+    # @return [Log] the op log for this graph
+    attr_reader :log
+
+    # Initializes an empty dependency graph
+    def initialize
+      @vertices = {}
+      @log = Log.new
+    end
+
+    # Tags the current state of the dependency as the given tag
+    # @param  [Object] tag an opaque tag for the current state of the graph
+    # @return [Void]
+    def tag(tag)
+      log.tag(self, tag)
+    end
+
+    # Rewinds the graph to the state tagged as `tag`
+    # @param  [Object] tag the tag to rewind to
+    # @return [Void]
+    def rewind_to(tag)
+      log.rewind_to(self, tag)
+    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 = {}
+      @log = other.log.dup
+      traverse = lambda do |new_v, old_v|
+        return if new_v.outgoing_edges.size == old_v.outgoing_edges.size
+        old_v.outgoing_edges.each do |edge|
+          destination = add_vertex(edge.destination.name, edge.destination.payload)
+          add_edge_no_circular(new_v, destination, edge.requirement)
+          traverse.call(destination, edge.destination)
+        end
+      end
+      other.vertices.each do |name, vertex|
+        new_vertex = add_vertex(name, vertex.payload, vertex.root?)
+        new_vertex.explicit_requirements.replace(vertex.explicit_requirements)
+        traverse.call(new_vertex, vertex)
+      end
+    end
+
+    # @return [String] a string suitable for debugging
+    def inspect
+      "#{self.class}:#{vertices.values.inspect}"
+    end
+
+    # @return [String] Returns a dot format representation of the graph
+    def to_dot
+      dot_vertices = []
+      dot_edges = []
+      vertices.each do |n, v|
+        dot_vertices << "  #{n} [label=\"{#{n}|#{v.payload}}\"]"
+        v.outgoing_edges.each do |e|
+          dot_edges << "  #{e.origin.name} -> #{e.destination.name} [label=\"#{e.requirement}\"]"
+        end
+      end
+      dot_vertices.sort!
+      dot_edges.sort!
+      dot = dot_vertices.unshift('digraph G {').push('') + dot_edges.push('}')
+      dot.join("\n")
+    end
+
+    # @return [Boolean] whether the two dependency graphs are equal, determined
+    #   by a recursive traversal of each {#root_vertices} and its
+    #   {Vertex#successors}
+    def ==(other)
+      return false unless other
+      vertices.each do |name, vertex|
+        other_vertex = other.vertex_named(name)
+        return false unless other_vertex
+        return false unless other_vertex.successors.map(&:name).to_set == vertex.successors.map(&:name).to_set
+      end
+    end
+
+    # @param [String] name
+    # @param [Object] payload
+    # @param [Array<String>] parent_names
+    # @param [Object] requirement the requirement that is requiring the child
+    # @return [void]
+    def add_child_vertex(name, payload, parent_names, requirement)
+      root = !parent_names.delete(nil) { true }
+      vertex = add_vertex(name, payload, root)
+      parent_names.each do |parent_name|
+        parent_node = vertex_named(parent_name)
+        add_edge(parent_node, vertex, requirement)
+      end
+      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`
+    def add_vertex(name, payload, root = false)
+      log.add_vertex(self, name, payload, root)
+    end
+
+    # Detaches the {#vertex_named} `name` {Vertex} from the graph, recursively
+    # removing any non-root vertices that were orphaned in the process
+    # @param [String] name
+    # @return [void]
+    def detach_vertex_named(name)
+      log.detach_vertex_named(self, name)
+    end
+
+    # @param [String] name
+    # @return [Vertex,nil] the vertex with the given name
+    def vertex_named(name)
+      vertices[name]
+    end
+
+    # @param [String] name
+    # @return [Vertex,nil] the root vertex with the given name
+    def root_vertex_named(name)
+      vertex = vertex_named(name)
+      vertex if vertex && vertex.root?
+    end
+
+    # Adds a new {Edge} to the dependency graph
+    # @param [Vertex] origin
+    # @param [Vertex] destination
+    # @param [Object] requirement the requirement that this edge represents
+    # @return [Edge] the added edge
+    def add_edge(origin, destination, requirement)
+      if destination.path_to?(origin)
+        raise CircularDependencyError.new([origin, destination])
+      end
+      add_edge_no_circular(origin, destination, requirement)
+    end
+
+    # Sets the payload of the vertex with the given name
+    # @param [String] name the name of the vertex
+    # @param [Object] payload the payload
+    # @return [Void]
+    def set_payload(name, payload)
+      log.set_payload(self, name, payload)
+    end
+
+    private
+
+    # Adds a new {Edge} to the dependency graph without checking for
+    # circularity.
+    # @param (see #add_edge)
+    # @return (see #add_edge)
+    def add_edge_no_circular(origin, destination, requirement)
+      log.add_edge_no_circular(self, origin.name, destination.name, requirement)
+    end
+  end
+end

data/bundler/lib/bundler/vendor/molinillo/lib/molinillo/dependency_graph/action.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+module Bundler::Molinillo
+  class DependencyGraph
+    # An action that modifies a {DependencyGraph} that is reversible.
+    # @abstract
+    class Action
+      # rubocop:disable Lint/UnusedMethodArgument
+
+      # @return [Symbol] The name of the action.
+      def self.name
+        raise 'Abstract'
+      end
+
+      # Performs the action on the given graph.
+      # @param  [DependencyGraph] graph the graph to perform the action on.
+      # @return [Void]
+      def up(graph)
+        raise 'Abstract'
+      end
+
+      # Reverses the action on the given graph.
+      # @param  [DependencyGraph] graph the graph to reverse the action on.
+      # @return [Void]
+      def down(graph)
+        raise 'Abstract'
+      end
+
+      # @return [Action,Nil] The previous action
+      attr_accessor :previous
+
+      # @return [Action,Nil] The next action
+      attr_accessor :next
+    end
+  end
+end

data/bundler/lib/bundler/vendor/molinillo/lib/molinillo/dependency_graph/add_edge_no_circular.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+require 'bundler/vendor/molinillo/lib/molinillo/dependency_graph/action'
+module Bundler::Molinillo
+  class DependencyGraph
+    # @!visibility private
+    # (see DependencyGraph#add_edge_no_circular)
+    class AddEdgeNoCircular < Action
+      # @!group Action
+
+      # (see Action.name)
+      def self.name
+        :add_vertex
+      end
+
+      # (see Action#up)
+      def up(graph)
+        edge = make_edge(graph)
+        edge.origin.outgoing_edges << edge
+        edge.destination.incoming_edges << edge
+        edge
+      end
+
+      # (see Action#down)
+      def down(graph)
+        edge = make_edge(graph)
+        edge.origin.outgoing_edges.delete(edge)
+        edge.destination.incoming_edges.delete(edge)
+      end
+
+      # @!group AddEdgeNoCircular
+
+      # @return [String] the name of the origin of the edge
+      attr_reader :origin
+
+      # @return [String] the name of the destination of the edge
+      attr_reader :destination
+
+      # @return [Object] the requirement that the edge represents
+      attr_reader :requirement
+
+      # @param  [DependencyGraph] graph the graph to find vertices from
+      # @return [Edge] The edge this action adds
+      def make_edge(graph)
+        Edge.new(graph.vertex_named(origin), graph.vertex_named(destination), requirement)
+      end
+
+      # Initialize an action to add an edge to a dependency graph
+      # @param [String] origin the name of the origin of the edge
+      # @param [String] destination the name of the destination of the edge
+      # @param [Object] requirement the requirement that the edge represents
+      def initialize(origin, destination, requirement)
+        @origin = origin
+        @destination = destination
+        @requirement = requirement
+      end
+    end
+  end
+end

data/bundler/lib/bundler/vendor/molinillo/lib/molinillo/dependency_graph/add_vertex.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+require 'bundler/vendor/molinillo/lib/molinillo/dependency_graph/action'
+module Bundler::Molinillo
+  class DependencyGraph
+    # @!visibility private
+    # (see DependencyGraph#add_vertex)
+    class AddVertex < Action # :nodoc:
+      # @!group Action
+
+      # (see Action.name)
+      def self.name
+        :add_vertex
+      end
+
+      # (see Action#up)
+      def up(graph)
+        if existing = graph.vertices[name]
+          @existing_payload = existing.payload
+          @existing_root = existing.root
+        end
+        vertex = existing || Vertex.new(name, payload)
+        graph.vertices[vertex.name] = vertex
+        vertex.payload ||= payload
+        vertex.root ||= root
+        vertex
+      end
+
+      # (see Action#down)
+      def down(graph)
+        if defined?(@existing_payload)
+          vertex = graph.vertices[name]
+          vertex.payload = @existing_payload
+          vertex.root = @existing_root
+        else
+          graph.vertices.delete(name)
+        end
+      end
+
+      # @!group AddVertex
+
+      # @return [String] the name of the vertex
+      attr_reader :name
+
+      # @return [Object] the payload for the vertex
+      attr_reader :payload
+
+      # @return [Boolean] whether the vertex is root or not
+      attr_reader :root
+
+      # Initialize an action to add a vertex to a dependency graph
+      # @param [String] name the name of the vertex
+      # @param [Object] payload the payload for the vertex
+      # @param [Boolean] root whether the vertex is root or not
+      def initialize(name, payload, root)
+        @name = name
+        @payload = payload
+        @root = root
+      end
+    end
+  end
+end

data/bundler/lib/bundler/vendor/molinillo/lib/molinillo/dependency_graph/detach_vertex_named.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+require 'bundler/vendor/molinillo/lib/molinillo/dependency_graph/action'
+module Bundler::Molinillo
+  class DependencyGraph
+    # @!visibility private
+    # @see DependencyGraph#detach_vertex_named
+    class DetachVertexNamed < Action
+      # @!group Action
+
+      # (see Action#name)
+      def self.name
+        :add_vertex
+      end
+
+      # (see Action#up)
+      def up(graph)
+        return unless @vertex = graph.vertices.delete(name)
+        @vertex.outgoing_edges.each do |e|
+          v = e.destination
+          v.incoming_edges.delete(e)
+          graph.detach_vertex_named(v.name) unless v.root? || v.predecessors.any?
+        end
+        @vertex.incoming_edges.each do |e|
+          v = e.origin
+          v.outgoing_edges.delete(e)
+        end
+      end
+
+      # (see Action#down)
+      def down(graph)
+        return unless @vertex
+        graph.vertices[@vertex.name] = @vertex
+        @vertex.outgoing_edges.each do |e|
+          e.destination.incoming_edges << e
+        end
+        @vertex.incoming_edges.each do |e|
+          e.origin.outgoing_edges << e
+        end
+      end
+
+      # @!group DetachVertexNamed
+
+      # @return [String] the name of the vertex to detach
+      attr_reader :name
+
+      # Initialize an action to detach a vertex from a dependency graph
+      # @param [String] name the name of the vertex to detach
+      def initialize(name)
+        @name = name
+      end
+    end
+  end
+end

data/bundler/lib/bundler/vendor/molinillo/lib/molinillo/dependency_graph/log.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+require 'bundler/vendor/molinillo/lib/molinillo/dependency_graph/add_edge_no_circular'
+require 'bundler/vendor/molinillo/lib/molinillo/dependency_graph/add_vertex'
+require 'bundler/vendor/molinillo/lib/molinillo/dependency_graph/detach_vertex_named'
+require 'bundler/vendor/molinillo/lib/molinillo/dependency_graph/set_payload'
+require 'bundler/vendor/molinillo/lib/molinillo/dependency_graph/tag'
+
+module Bundler::Molinillo
+  class DependencyGraph
+    # A log for dependency graph actions
+    class Log
+      # Initializes an empty log
+      def initialize
+        @current_action = @first_action = nil
+      end
+
+      # @!macro [new] action
+      #   {include:DependencyGraph#$0}
+      #   @param [Graph] graph the graph to perform the action on
+      #   @param (see DependencyGraph#$0)
+      #   @return (see DependencyGraph#$0)
+
+      # @macro action
+      def tag(graph, tag)
+        push_action(graph, Tag.new(tag))
+      end
+
+      # @macro action
+      def add_vertex(graph, name, payload, root)
+        push_action(graph, AddVertex.new(name, payload, root))
+      end
+
+      # @macro action
+      def detach_vertex_named(graph, name)
+        push_action(graph, DetachVertexNamed.new(name))
+      end
+
+      # @macro action
+      def add_edge_no_circular(graph, origin, destination, requirement)
+        push_action(graph, AddEdgeNoCircular.new(origin, destination, requirement))
+      end
+
+      # @macro action
+      def set_payload(graph, name, payload)
+        push_action(graph, SetPayload.new(name, payload))
+      end
+
+      # Pops the most recent action from the log and undoes the action
+      # @param [DependencyGraph] graph
+      # @return [Action] the action that was popped off the log
+      def pop!(graph)
+        return unless action = @current_action
+        unless @current_action = action.previous
+          @first_action = nil
+        end
+        action.down(graph)
+        action
+      end
+
+      extend Enumerable
+
+      # @!visibility private
+      # Enumerates each action in the log
+      # @yield [Action]
+      def each
+        return enum_for unless block_given?
+        action = @first_action
+        loop do
+          break unless action
+          yield action
+          action = action.next
+        end
+        self
+      end
+
+      # @!visibility private
+      # Enumerates each action in the log in reverse order
+      # @yield [Action]
+      def reverse_each
+        return enum_for(:reverse_each) unless block_given?
+        action = @current_action
+        loop do
+          break unless action
+          yield action
+          action = action.previous
+        end
+        self
+      end
+
+      # @macro action
+      def rewind_to(graph, tag)
+        loop do
+          action = pop!(graph)
+          raise "No tag #{tag.inspect} found" unless action
+          break if action.class.name == :tag && action.tag == tag
+        end
+      end
+
+      private
+
+      # Adds the given action to the log, running the action
+      # @param [DependencyGraph] graph
+      # @param [Action] action
+      # @return The value returned by `action.up`
+      def push_action(graph, action)
+        action.previous = @current_action
+        @current_action.next = action if @current_action
+        @current_action = action
+        @first_action ||= action
+        action.up(graph)
+      end
+    end
+  end
+end