abstract_graph 1.0.0

data/lib/abstract_graph/graph/add_vertex.rb

@@ -0,0 +1,16 @@
+# required in "abstract_graph/graph"
+
+module AbstractGraph
+  class Graph
+
+    # add a vertex named s to the graph
+    # p: String s represents the name of the wanted vertex
+    def add_vertex( s )
+      # create the vertex
+      vertex = Vertex.new s
+      @vertices.add vertex
+      self
+    end
+
+  end
+end

data/lib/abstract_graph/graph/delete_edge.rb

@@ -0,0 +1,21 @@
+# required in "abstract_graph/graph"
+
+module AbstractGraph
+  class Graph
+
+    # delete an edge in a replicated graph
+    # p: String s represents the name of the edge
+    def delete_edge( s )
+      other = self.dup
+      other.delete_edge! s
+    end
+
+    # delete an edge in a current graph
+    # p: String s represents the name of the edge
+    def delete_edge!( s )
+      @edges.delete s
+      self
+    end
+
+  end
+end

data/lib/abstract_graph/graph/delete_vertex.rb

@@ -0,0 +1,21 @@
+# required in "abstract_graph/graph"
+
+module AbstractGraph
+  class Graph
+
+    # delete a vertex in a new graph
+    # p: String s represents the name of the vertex
+    def delete_vertex( s )
+      other = self.dup
+      other.delete_vertex! s
+    end
+
+    # delete a vertex in a current graph
+    # p: String s represents the name of the vertex
+    def delete_vertex!( s )
+      @vertices.delete s
+      self
+    end
+
+  end
+end

data/lib/abstract_graph/graph/dup.rb

@@ -0,0 +1,14 @@
+# required in "abstract_graph/graph"
+
+module AbstractGraph
+  class Graph
+
+    # does a deep copy of the graph
+    def dup
+      other = Graph.new
+      other.vertices = @vertices.dup
+      other
+    end
+
+  end
+end

data/lib/abstract_graph/graph/has_edge.rb

@@ -0,0 +1,13 @@
+# required in "abstract_graph/graph"
+
+module AbstractGraph
+  class Graph
+
+    # returns whether there exists a edge with name string
+    # p: String s represents name of edge
+    def has_edge?( s )
+      @edges.has_key? s || false
+    end
+
+  end
+end

data/lib/abstract_graph/graph/has_vertex.rb

@@ -0,0 +1,13 @@
+# required in "abstract_graph/graph"
+
+module AbstractGraph
+  class Graph
+
+    # returns whether there exists a vertex with name string
+    # p: String s represents name of query vertex
+    def has_vertex?( s )
+      @vertices.has_key? s || false
+    end
+
+  end
+end

data/lib/abstract_graph/graph/initialize.rb

@@ -0,0 +1,16 @@
+# required in "abstract_graph/graph"
+
+module AbstractGraph
+  class Graph
+
+    # public constructor
+    def initialize
+
+      @vertices = UniqueNameCollection.new
+      @edges = UniqueNameCollection.new
+      @vertices.link @edges
+
+    end
+
+  end
+end

data/lib/abstract_graph/version.rb

@@ -0,0 +1,5 @@
+# required in "abstract_graph"
+
+module AbstractGraph
+  VERSION = "1.0.0"
+end

data/spec/abstract_graph/composition/edge/initialize_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+module AbstractGraph
+  module Composition
+    describe Edge do
+
+      before :all do
+        @v1 = Vertex.new "v1"
+        @v2 = Vertex.new "v2"
+      end
+
+      describe "#new(Vertex, Vertex)" do
+
+        before :each do
+          @edge = Edge.new( @v1, @v2 )
+        end
+
+        it "returns an object of class Edge" do
+          @edge.should be_an_instance_of(Edge)
+        end
+
+      end
+
+      describe "#new(String, Vertex, Vertex)" do
+
+        before :each do
+          @edge = Edge.new("e1", @v1, @v2)
+        end
+
+        it "allows vertices to be initiated with a string name" do
+          @edge.should_not be_nil
+        end
+
+      end
+
+    end
+  end
+end

data/spec/abstract_graph/composition/edge/is_coincident_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+module AbstractGraph
+  module Composition
+    describe Edge do
+
+      before :all do
+        @v1 = Vertex.new "v1"
+        @v2 = Vertex.new "v2"
+        @v3 = Vertex.new "v3"
+      end
+
+      before :each do
+        @edge = Edge.new( "e1", @v1, @v2 )
+      end
+
+      describe "#is_coincident?(Edge)" do
+
+        it "returns true if it joins the same two vertices" do
+          edge2 = Edge.new( "e2", @v1, @v2 )
+          @edge.is_coincident?( edge2 ).should be_true
+        end
+
+        it "returns false if the two edges span >= 3 vertices" do
+          edge2 = Edge.new( "e2", @v1, @v3 )
+          @edge.is_coincident?( edge2 ).should be_false
+        end
+
+      end
+
+    end
+  end
+end

data/spec/abstract_graph/composition/edge/name_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+module AbstractGraph
+  module Composition
+    describe Edge do
+
+      before :all do
+        @v1 = Vertex.new "v1"
+        @v2 = Vertex.new "v2"
+      end
+
+      describe "#name" do
+
+        before :each do
+          @arbitraryString = "arbitraryString"
+          @edge = Edge.new @arbitraryString, @v1, @v2
+        end
+
+        it "returns a String (Always)" do
+          @edge.name.should be_an_instance_of(String)
+        end
+
+        it "equals to the String in #new(String)" do
+          @edge.name.should eql(@arbitraryString)
+        end
+
+        it "equals to empty string if no string was passed in" do
+          edge1 = Edge.new @v1, @v2
+          edge1.name.should eql("")
+        end
+
+      end
+
+      describe "#name=" do
+
+        before :each do
+          @edge = Edge.new @v1, @v2
+        end
+
+        it "names the edge and retrieved by #name" do
+          @edge.name = "Hello World"
+          @edge.name.should eql("Hello World")
+        end
+
+        it "doesn't allow a non-String input" do
+          expect { @edge.name = 100 }.to raise_error
+        end
+
+      end
+
+    end
+  end
+end

data/spec/abstract_graph/composition/edge/vertices_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+module AbstractGraph
+  module Composition
+    describe Edge do
+
+      before :all do
+        @v1 = Vertex.new "v1"
+        @v2 = Vertex.new "v2"
+        @edge = Edge.new( @v1, @v2 )
+      end
+
+      describe "#vertices" do
+
+        it "should be an enumerable" do
+          @edge.vertices.should be_an_instance_of(Array)
+        end
+
+        it "must be two vertices" do
+          @edge.vertices.should have(2).vertices
+        end
+
+        it "is the vertices passed from constructor" do
+          @edge.vertices.should include( @v1 )
+          @edge.vertices.should include( @v2 )
+        end
+
+      end
+
+    end
+  end
+end

data/spec/abstract_graph/composition/edge_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+module AbstractGraph
+  module Composition
+    describe Edge do
+    end
+  end
+end

data/spec/abstract_graph/composition/uniquenamecollection/add_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+module AbstractGraph
+  module Composition
+    describe UniqueNameCollection do
+
+      before(:each) do
+        @collection = UniqueNameCollection.new
+        @dummy = Dummy.new
+        @dummy.name = "DummyName"
+      end
+
+      describe "#add(Object)" do
+
+        it "tracks an object that has implemented #name" do
+          @collection.add @dummy
+        end
+
+        it "doesn't allow us to add the same object twice" do
+          @collection.add @dummy
+          expect { @collection.add @dummy }.to raise_error
+        end
+
+        it "doesn't allow two objects to have the same name" do
+          dummy2 = Dummy.new
+          dummy2.name = "DummyName"
+          @collection.add @dummy
+          expect { @collection.add dummy2 }.to raise_error
+        end
+
+        it "allows a same named object after deleting it" do
+          @collection.add @dummy
+          @collection.delete @dummy.name
+          expect { @collection.add @dummy }.to_not raise_error
+        end
+
+      end
+
+    end
+  end
+end

data/spec/abstract_graph/composition/uniquenamecollection/dup_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+module AbstractGraph
+  module Composition
+    describe UniqueNameCollection do
+
+      before :each do
+        @collection = UniqueNameCollection.new
+      end
+
+      describe "#dup" do
+
+        it "doesn't have the same id as the original" do
+          @collection.object_id.should_not == @collection.dup.object_id
+        end
+
+        it "creates a duplicate of every item in the collection" do
+          secondCollection = @collection.dup
+          dummy = Dummy.new
+          dummy.name = "Dummy"
+          @collection.add dummy
+          secondCollection.collection.size.should == 0
+        end
+
+      end
+
+    end
+  end
+end

data/spec/abstract_graph/composition/uniquenamecollection/initialize_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+module AbstractGraph
+  module Composition
+    describe UniqueNameCollection do
+
+      before (:each) do
+        @collection = UniqueNameCollection.new
+      end
+
+      describe "#new" do
+
+        it "returns an object of class UniqueNameCollection" do
+          @collection.should be_an_instance_of(UniqueNameCollection)
+        end
+
+      end
+
+    end
+  end
+end

data/spec/abstract_graph/composition/uniquenamecollection/link_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+module AbstractGraph
+  module Composition
+    describe UniqueNameCollection do
+
+      before :each do
+        @collection1 = UniqueNameCollection.new
+        @collection2 = UniqueNameCollection.new
+        @dummy = Dummy.new
+        @dummy.name = "DummyName"
+        @dummy2 = Dummy.new
+        @dummy2.name = "DummyName"
+      end
+
+      describe "#link(UniqueNameCollection)" do
+
+        it "doesn't allow first collection to add object of same name" do
+          @collection1.link @collection2
+          @collection2.add @dummy
+          expect { @collection1.add @dummy2 }.to raise_error
+        end
+
+        it "doesn't allow second collection to add object of same name" do
+          @collection1.link @collection2
+          @collection1.add @dummy
+          expect { @collection2.add @dummy2 }.to raise_error
+        end
+
+        it "doesn't allow second collection to re-add objects that already existed" do
+          @collection1.add @dummy
+          @collection1.link @collection2
+          expect { @collection2.add @dummy2 }.to raise_error
+        end
+
+        it "doesn't allow first collection to re-add objects that already existed" do
+          @collection2.add @dummy
+          @collection1.link @collection2
+          expect { @collection1.add @dummy2 }.to raise_error
+        end
+
+        it "returns nil if the intersection during link isn't nil" do
+          @collection1.add @dummy
+          @collection2.add @dummy2
+          @collection1.link(@collection2).should be_nil
+        end
+
+        it "allows a same object ofter deletion" do
+          @collection1.add @dummy
+          @collection1.link @collection2
+          @collection1.delete @dummy.name
+          expect { @collection2.add @dummy2 }.to_not raise_error
+        end
+
+        it "can link more than 2 collections together" do
+          collection3 = UniqueNameCollection.new
+          @collection1.link @collection2
+          @collection2.link collection3
+          @collection1.add @dummy
+          expect { collection3.add @dummy2 }.to raise_error
+        end
+
+      end
+
+    end
+  end
+end