tangle 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4456f429bc3e43dc2498e665b5ab50ceeba8ada36ed86fad33e477675237f53f
-  data.tar.gz: 961bfb96b98ec4bc56fc7e4feed6b36a7f5db1d5427ca636274e2799b609939a
+  metadata.gz: 46af55dc3f6a3cb2ffc754776a93209e02d647cac2aa824729b3816665b344a6
+  data.tar.gz: b128f9e8ffa5c608ffc2b9a12946c772886b4bdec661d51ac542c9e25346e890
 SHA512:
-  metadata.gz: 7388845b841906216962b5b536084518a2ec2ddd645d5f13627efb860d0073a04c59afe5e088e664528e9c55a87a0deca1e6feeeee66a047b1f3ed0204b835de
-  data.tar.gz: 23a0299a55237a37a752ea57cbc477d70cae6a95ad80c44e004ca651a4f5faab266a9022bea668e6a73b51088811e46adee6a53a41deda278f79a8191768f6e8
+  metadata.gz: 5cd121de93316e33175f8184a7092bce69e85c6865b75826da6fd741997b583004b53167679cf098e9e2cb9023809e725d7ab9528c61d32cfeef02e1a589d7a6
+  data.tar.gz: 685ce03d7f320333b527c22582a46aedddcf2ab7bd0eec1351aa49b5ec9c319130b2d3ccd4348558844ebda593ab5e8403765711f235e85730b9c4eca96fc424

data/README.md

@@ -1,4 +1,4 @@
-[![Gem Version](https://badge.fury.io/rb/tangle.svg)](https://badge.fury.io/rb/tangle)
+[![Gem Version](https://badge.fury.io/rb/tangle.svg)](https://badge.fury.io/rb/tangle) [![Maintainability](https://api.codeclimate.com/v1/badges/0d92a4d05b6bb5c06dce/maintainability)](https://codeclimate.com/github/notCalle/ruby-tangle/maintainability)
 
 # Tangle
 

data/lib/tangle/directed/edge.rb

@@ -0,0 +1,31 @@
+require 'tangle/edge'
+
+module Tangle
+  module Directed
+    #
+    # An edge in a directed graph
+    #
+    class Edge < Tangle::Edge
+      def initialize(vertex1, vertex2 = vertex1, graph: nil)
+        @child, @parent = @vertices = [vertex1, vertex2]
+        super
+      end
+
+      def parent?(vertex)
+        @parent == vertex
+      end
+
+      def parent(_vertex = nil)
+        @parent
+      end
+
+      def child?(vertex)
+        @child == vertex
+      end
+
+      def child(_vertex = nil)
+        @child
+      end
+    end
+  end
+end

data/lib/tangle/directed/graph.rb

@@ -0,0 +1,17 @@
+require 'tangle/graph'
+require 'tangle/directed/edge'
+
+module Tangle
+  module Directed
+    #
+    # A directed graph
+    class Graph < Tangle::Graph
+      Edge = Tangle::Directed::Edge
+      DEFAULT_MIXINS = [Tangle::Mixin::Ancestry].freeze
+
+      def initialize(mixins: DEFAULT_MIXINS, **kvargs)
+        super
+      end
+    end
+  end
+end

data/lib/tangle/edge.rb

@@ -16,7 +16,7 @@ module Tangle
     # End users should probably use Graph#add_edge instead.
     #
     def initialize(vertex1, vertex2 = vertex1, graph: nil)
-      @vertices = Set[vertex1, vertex2]
+      @vertices ||= Set[vertex1, vertex2]
       @graph = graph
 
       initialize_mixins
@@ -28,9 +28,16 @@ module Tangle
     #
     # walk(vertex) => Vertex
     #
-    def walk(from_vertex)
-      raise RuntimeError unless @vertices.include?(from_vertex)
-      @vertices.find { |other| other != from_vertex } || from_vertex
+    def walk(from_vertex, selector: :other)
+      send(selector, from_vertex)
+    end
+
+    # Return the other vertex for a vertex of this edge
+    #
+    def other(for_vertex)
+      raise RuntimeError unless @vertices.include?(for_vertex)
+
+      @vertices.find { |other| other != for_vertex } || for_vertex
     end
 
     # Duplicate an edge into another graph, replacing original vertices with

data/lib/tangle/mixin/ancestry.rb

@@ -0,0 +1,64 @@
+require 'tangle/mixin/connectedness'
+
+module Tangle
+  module Mixin
+    #
+    # Mixin for adding ancestry features
+    #
+    module Ancestry
+      #
+      # Mixins for adding ancestry relations to a digraph
+      #
+      module Graph
+        include Tangle::Mixin::Connectedness::Graph
+
+        def ancestor_subgraph(vertex)
+          subgraph { |other| vertex.ancestor?(other) }
+        end
+
+        def descendant_subgraph(vertex)
+          subgraph { |other| vertex.descendant?(other) }
+        end
+      end
+
+      #
+      # Mixins for adding ancestry relations to vertices in a digraph
+      #
+      module Vertex
+        include Tangle::Mixin::Connectedness::Vertex
+
+        def parent_edges
+          @graph.edges { |edge| edge.child?(self) }
+        end
+
+        def parents
+          neighbours(parent_edges)
+        end
+
+        def parent?(other)
+          @graph.edges.any? { |edge| edge.child?(self) && edge.parent?(other) }
+        end
+
+        def ancestor?(other)
+          connected?(other, test_method: :parent?)
+        end
+
+        def child_edges
+          @graph.edges { |edge| edge.parent?(self) }
+        end
+
+        def children
+          neighbours(child_edges)
+        end
+
+        def child?(other)
+          @graph.edges.any? { |edge| edge.parent?(self) && edge.child?(other) }
+        end
+
+        def descendant?(other)
+          connected?(other, test_method: :child?)
+        end
+      end
+    end
+  end
+end

data/lib/tangle/mixin/connectedness.rb

@@ -1,5 +1,8 @@
 module Tangle
   module Mixin
+    #
+    # Mixins for adding connectedness features
+    #
     module Connectedness
       #
       # Mixin for adding connectedness to a graph
@@ -50,20 +53,20 @@ module Tangle
         # Two vertices are connected if there is a path between them,
         # and a vertex is connected to itself.
         #
-        def connected?(other)
+        def connected?(other, test_method: :adjacent?)
           raise GraphError unless @graph == other.graph
           return true if self == other
 
-          connected_excluding?(other, Set[self])
+          connected_excluding?(other, test_method, Set[self])
         end
 
         protected
 
-        def connected_excluding?(other, history)
-          return true if adjacent?(other)
+        def connected_excluding?(other, test_method, history)
+          return true if send(test_method, other)
 
           (neighbours - history).any? do |vertex|
-            vertex.connected_excluding?(other, history << self)
+            vertex.connected_excluding?(other, test_method, history << self)
           end
         end
       end

data/lib/tangle/mixin.rb

@@ -1,3 +1,4 @@
+require 'tangle/mixin/ancestry'
 require 'tangle/mixin/connectedness'
 
 module Tangle

data/lib/tangle/vertex.rb

@@ -61,8 +61,8 @@ module Tangle
 
     # Return the set of adjacent vertices
     #
-    def neighbours
-      Set.new(edges.map { |edge| edge.walk(self) })
+    def neighbours(included = edges)
+      Set.new(included.map { |edge| edge.walk(self) })
     end
 
     # If two vertices have the same vertex_id, they have the same value

data/lib/tangle.rb

@@ -2,6 +2,7 @@ require 'tangle/version'
 require 'tangle/errors'
 require 'tangle/graph'
 require 'tangle/simple/graph'
+require 'tangle/directed/graph'
 
 # Tangle manages various types of graphs
 #
@@ -14,4 +15,5 @@ require 'tangle/simple/graph'
 module Tangle
   MultiGraph = Tangle::Graph
   SimpleGraph = Tangle::Simple::Graph
+  DiGraph = Tangle::Directed::Graph
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tangle
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Calle Englund
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-05 00:00:00.000000000 Z
+date: 2018-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git-version-bump
@@ -99,10 +99,13 @@ files:
 - bin/console
 - bin/setup
 - lib/tangle.rb
+- lib/tangle/directed/edge.rb
+- lib/tangle/directed/graph.rb
 - lib/tangle/edge.rb
 - lib/tangle/errors.rb
 - lib/tangle/graph.rb
 - lib/tangle/mixin.rb
+- lib/tangle/mixin/ancestry.rb
 - lib/tangle/mixin/connectedness.rb
 - lib/tangle/simple/edge.rb
 - lib/tangle/simple/graph.rb