tangle 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb6c6e2247f126a8309178790612215cd099aaecaf909de00f114a1fb04e5caf
-  data.tar.gz: 42386680537801bfb1be9d1f14f684f6a82fe857246fdfe492d9ae31a602d980
+  metadata.gz: 1fe724ce08f713fbe503fde9eb9705f8e2aa39df7d44a2cb1463f5404dcb8380
+  data.tar.gz: 64ac53373a7747cb68f2023bb1cf6c5a9656449c0916ae1a2f6ee856f5c67593
 SHA512:
-  metadata.gz: f231571ede13d8261d03c3a9c6410cf184ec79deb5a612aa9f655533410f296846e417aebde6a81c04bc7706253737689560b0fb0fabb52a9388314cc7514187
-  data.tar.gz: 0a52fa6c13da5c282167690c7f1fa73a70b5c9175f7e34f9d68bfcdd0036f305dfe177fb2ad2153c7722bdf4fef989b694cc68cfb56edefb52ee424c28ff98aa
+  metadata.gz: 8121539f09661bf3ff0bac14211d0cda52768d2b0a9f4ffb76fb92ea1049afacebca54aa85fce60f47cbffe194ca1f2832758d3f6f1c28acb8bb80f09ee33cec
+  data.tar.gz: 604724b372a499f6237240a9dfa3298e91f1889c7f674a733956d56a616b633af154e4a97aa9250d724b8ba7306dad7f69615e4af295e1d7705c5ccbe672b06c

data/lib/tangle.rb

@@ -1,8 +1,17 @@
 require 'tangle/version'
+require 'tangle/errors'
 require 'tangle/graph'
+require 'tangle/simple/graph'
 
-# Tangle manages graphs of things
+# Tangle manages various types of graphs
+#
+# Tangle::MultiGraph.new
+# => Undirected graph without edge constraints
+#
+# Tangle::SimpleGraph.new
+# => Undirected graph with single edges between vertices, and no loops
 #
 module Tangle
-  # Your code goes here...
+  MultiGraph = Tangle::Graph
+  SimpleGraph = Tangle::Simple::Graph
 end

data/lib/tangle/edge.rb

@@ -1,3 +1,5 @@
+require 'tangle/errors'
+
 module Tangle
   #
   # An edge in a graph, connecting two vertices
@@ -16,7 +18,7 @@ module Tangle
       @vertices = Set[vertex1, vertex2]
       @graph = graph
 
-      raise ArgumentError unless valid_edge?
+      validate_edge
     end
 
     # Follow the edge from a vertex to the other end
@@ -43,7 +45,7 @@ module Tangle
       vertices = @vertices.map do |vertex|
         graph.get_vertex(vertex.vertex_id)
       end
-      Edge.new(*vertices, graph: graph)
+      self.class.new(*vertices, graph: graph)
     rescue KeyError
       nil
     end
@@ -52,16 +54,23 @@ module Tangle
       "#<#{self.class}: #{@vertices}>"
     end
 
+    def eql?(other)
+      @graph == other.graph && @vertices == other.vertices
+    end
+    alias == eql?
+    alias === eql?
+    alias equal? eql?
+
     attr_reader :name
     attr_reader :graph
     attr_reader :vertices
 
-    def_delegators :@vertices, :include?
+    def_delegators :@vertices, :include?, :hash
 
     private
 
-    def valid_edge?
-      @vertices.all? { |vertex| vertex.graph == @graph }
+    def validate_edge
+      raise GraphError unless @vertices.all? { |vertex| vertex.graph == @graph }
     end
   end
 end

data/lib/tangle/errors.rb

@@ -0,0 +1,28 @@
+module Tangle
+  #
+  # LoopError is raised when a looped edge is disallowed.
+  #
+  class LoopError < RuntimeError
+    def initialize(reason = 'loops not allowed', *)
+      super
+    end
+  end
+
+  # MultiEdgeError is raised when multiple edges between a single pair of
+  # vertices is disallowed.
+  #
+  class MultiEdgeError < RuntimeError
+    def initialize(reason = 'multiedges not allowed', *)
+      super
+    end
+  end
+
+  # GraphError is raised when graph elements in an operation belong to
+  # different graphs.
+  #
+  class GraphError < RuntimeError
+    def initialize(reason = 'not in the same graph', *)
+      super
+    end
+  end
+end

data/lib/tangle/graph.rb

@@ -6,6 +6,8 @@ module Tangle
   # Base class for all kinds of graphs
   #
   class Graph
+    Edge = Tangle::Edge
+
     # Initialize a new graph, optionally preloading it with vertices and edges
     #
     # Graph.new() => Graph
@@ -28,7 +30,7 @@ module Tangle
     def initialize(vertices: nil, edges: nil)
       @vertices_by_id = {}
       @vertices_by_name = {}
-      @edges = []
+      @edges ||= []
 
       initialize_vertices(vertices)
       initialize_edges(edges)
@@ -42,7 +44,7 @@ module Tangle
       if block_given?
         @edges.select(&selector)
       else
-        @edges
+        @edges.to_a
       end
     end
 
@@ -52,7 +54,7 @@ module Tangle
     #
     def add_edge(*vertices, **kvargs)
       vertices = vertices.map { |v| get_vertex(v) }
-      insert_edge(Edge.new(*vertices, graph: self, **kvargs))
+      insert_edge(self.class::Edge.new(*vertices, graph: self, **kvargs))
     end
 
     # Get all vertices.
@@ -97,7 +99,7 @@ module Tangle
     # Unless a selector is provided, the subgraph contains the entire graph.
     #
     def subgraph(&selector)
-      graph = Graph.new
+      graph = self.class.new
 
       dup_vertices_into(graph, &selector)
       dup_edges_into(graph)

data/lib/tangle/simple/edge.rb

@@ -0,0 +1,18 @@
+require 'tangle/edge'
+
+module Tangle
+  module Simple
+    #
+    # An edge in a simple graph, with no loops or multiedges
+    #
+    class Edge < Tangle::Edge
+      private
+
+      def validate_edge
+        super
+        raise LoopError unless @vertices.count == 2
+        raise MultiEdgeError if @graph.edges.include? self
+      end
+    end
+  end
+end

data/lib/tangle/simple/graph.rb

@@ -0,0 +1,17 @@
+require 'tangle/graph'
+require 'tangle/simple/edge'
+
+module Tangle
+  module Simple
+    #
+    # A simple graph, without loops and multiple edges
+    class Graph < Tangle::Graph
+      Edge = Tangle::Simple::Edge
+
+      def initialize(**kvargs)
+        @edges ||= Set[]
+        super
+      end
+    end
+  end
+end

data/lib/tangle/version.rb

@@ -1,3 +1,3 @@
 module Tangle
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tangle
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Calle Englund
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-03 00:00:00.000000000 Z
+date: 2018-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,7 +86,10 @@ files:
 - bin/setup
 - lib/tangle.rb
 - lib/tangle/edge.rb
+- lib/tangle/errors.rb
 - lib/tangle/graph.rb
+- lib/tangle/simple/edge.rb
+- lib/tangle/simple/graph.rb
 - lib/tangle/version.rb
 - lib/tangle/vertex.rb
 - tangle.gemspec