abstract_graph 1.1.0 → 1.2.1

data/lib/abstract_graph/graph/templates/complete_graph.rb

@@ -4,18 +4,20 @@ module AbstractGraph
   class Graph
     class << self
 
-      # create a variabled sized complete graph
-      #   that is, a graph where every vertex is adjacent
-      #   to every other vertex
-      # p: the number of vertices in the desired complete graph
+      # d: Create a complete graph K(n).
+      # a: It adds n vertices, named "v(i)", i=2^0..n-1. Then adds the edges, the name being sum
+      #   "e(i)" where i is sum of two connecting vertices.
+      # t: n * t(add_vertex) + C(n,2) * t(add_edge)
+      # p: n is number of vertices
+      # r: a complete graph
       def complete_graph n
         result = new
         vertexNames = n.times.collect { |i| 2**i }
         vertexNames.each do |i|
           result.add_vertex "v#{i}"
         end
-        vertexNames.combination(2).each do |i|
-          result.add_edge( "e#{i[0]+i[1]}", "v#{i[0]}", "v#{i[1]}" )
+        vertexNames.combination(2).each do |i,j|
+          result.add_edge( "e#{i+j}", "v#{i}", "v#{j}" )
         end
         result
       end

data/lib/abstract_graph/graph/templates/cycle_graph.rb

@@ -4,11 +4,12 @@ module AbstractGraph
   class Graph
     class << self
 
-      # create a variabled sized cycle graph,
-      #   ie, a connected graph such that every vertex has
-      #   exactly two distinct paths to every other vertex
-      # p: the number of vertices in the cycle graph
-      #    coincidently, also the number of edges
+      # d: Create a cycle graph
+      # a: Create the vertices and edges at the same time. The naming scheme is power of two for
+      #   vertices and the sum of vertices for edges.
+      # t: n * (t(add_vertex) + t(add_edge))
+      # p: n is the number of vertices
+      # r: a cycle graph
       def cycle_graph n
         result = new
         vertexNames = (n-1).times.collect { |i| 2**(i + 1) }

data/lib/abstract_graph/graph/templates/path_graph.rb

@@ -4,10 +4,12 @@ module AbstractGraph
   class Graph
     class << self
 
-      # create a variable sized path graph,
-      #   ie, a connected graph with 2 end vertices and n-2 connector
-      #   vertices. Each connector vertex has two adjacent vertices
-      # p: the number of vertices in the path, n-1 edges
+      # d: Returns a path.
+      # a: It creates a path.by adding vertices and edges at the same time, vertices named "v(i)"
+      #   i=2^0..n-1, and edges "e(i)" where i is sum of vertices adjacent.
+      # t: n * (t(add_vertex) + t(add_edge))
+      # p: n is the number of vertices
+      # r: a path graph
       def path_graph n
         result = new
 

data/lib/abstract_graph/graph/templates/petersen_graph.rb

@@ -4,6 +4,12 @@ module AbstractGraph
   class Graph
     class << self
 
+      # d: Create a peterson graph.
+      # a: It adds 10 vertices "v(i)", i=2^0..9. Then adds the specified edges, according to the
+      #   specified edges array.
+      # t: constant
+      # p: none
+      # r: a peterson graph
       # create a petersen graph.
       # ie, a 3 regular graph with 10 vertices and 15 edges
       def petersen_graph
@@ -24,8 +30,8 @@ module AbstractGraph
         [4, 9], [5, 8], [5, 7],
         [6, 9], [7, 9], [6, 8]]
 
-        specifiedEdges.each do |edgePair|
-          result.add_edge "e#{vertexNames[edgePair[0]] + vertexNames[edgePair[1]]}", "v#{vertexNames[edgePair[0]]}", "v#{vertexNames[edgePair[1]]}"
+        specifiedEdges.each do |edge1, edge2|
+          result.add_edge "e#{vertexNames[edge1] + vertexNames[edge2]}", "v#{vertexNames[edge1]}", "v#{vertexNames[edge2]}"
         end
 
         result

data/lib/abstract_graph/version.rb

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

data/spec/abstract_graph/composition/unique_name_collection/each_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+module AbstractGraph
+  module Composition
+    describe UniqueNameCollection do
+
+      before(:each) do
+        @collection = UniqueNameCollection.new
+        dummy = Dummy.new
+        dummy.name = "DummyName"
+        @collection.add dummy
+        dummy2 = Dummy.new
+        dummy2.name = "DummyName2"
+        @collection.add dummy2
+      end
+
+      describe "#each(&Block)" do
+
+        it "returns an object of type Enumerable" do
+          @collection.each.should be_an_instance_of(Enumerator)
+        end
+
+        it "returns an object of type Hash if passed a block" do
+          @collection.each{}.should be_an_instance_of(Hash)
+          @collection.each{|d|}.should be_an_instance_of(Hash)
+        end
+
+        it "passes each object back to the block of arity 1" do
+          @collection.each do |d|
+            d.should be_an_instance_of( Dummy )
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/spec/abstract_graph/composition/unique_name_collection/find_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+module AbstractGraph
+  module Composition
+    describe UniqueNameCollection do
+
+      before(:each) do
+        @collection = UniqueNameCollection.new
+        @dummy = Dummy.new
+        @name = "DummyName"
+        @dummy.name = @name
+        @collection.add(@dummy)
+      end
+
+      describe "#find(name)" do
+
+        it "returns an object of the right class" do
+          @collection.find(@name).should be_an_instance_of(Dummy)
+        end
+
+        it "should return the correct object" do
+          @collection.find(@name).should eql(@dummy)
+        end
+
+        it "should return nil if a name that doesn't exist is passed" do
+          @collection.find("BadName").should be_nil
+        end
+
+      end
+
+    end
+  end
+end

data/spec/abstract_graph/composition/{uniquenamecollection → unique_name_collection}/method_missing_spec.rb

@@ -24,23 +24,12 @@ module AbstractGraph
 
       end
 
-      describe "#has_key?(String)" do
+      describe "#each" do
 
-        it "should return whether the string is an included name" do
-          @collection.has_key?('d').should be_true
-          @collection.has_key?('saddy').should be_false
-        end
-
-      end
-
-      describe "#each_key" do
-
-        it "goes through every name in the collection" do
-          alphabet = ""
-          @collection.each_key do |c|
-            alphabet += c
+        it "goes through every object in the collection" do
+          @collection.each do |c|
+            c.should be_an_instance_of(Dummy)
           end
-          alphabet.should == "abcdefghijklmnopqrstuvwxyz"
         end
 
       end

data/spec/abstract_graph/composition/{uniquenamecollection → unique_name_collection}/rename_spec.rb

@@ -20,7 +20,7 @@ module AbstractGraph
 
         it "removes the original name from the hash" do
           @collection.rename @name, @newname
-          @collection[@name].should be_nil
+          @collection.collection[@name].should be_nil
         end
 
         it "renames the dummy object" do

data/spec/abstract_graph/graph/add_edge_spec.rb

@@ -37,7 +37,7 @@ module AbstractGraph
       it "returns nil if any of the vertices don't exist" do
         @graph.add_edge( "MyEdge", @vertex1, "randomString" ).should be_nil
         @graph.add_edge( "MyEdge", "randomString", @vertex1 ).should be_nil
-        @graph.edges["MyEdge"].should be_nil
+        @graph.edges.collection["MyEdge"].should be_nil
       end
 
     end

data/spec/abstract_graph/graph/connected_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+module AbstractGraph
+  describe Graph do
+
+    before :all do
+    end
+
+    before :each do
+    end
+
+    describe "#connected?" do
+
+      it "returns true for any path" do
+        Graph.path_graph( 3 ).connected?.should be_true
+        Graph.path_graph( 1 ).connected?.should be_true
+        Graph.path_graph( 10 ).connected?.should be_true
+      end
+
+      it "returns true for an empty graph" do
+        Graph.new.connected?.should be_true
+      end
+
+      it "returns true for any cycle" do
+        Graph.cycle_graph( 3 ).connected?.should be_true
+        Graph.cycle_graph( 5 ).connected?.should be_true
+      end
+
+      it "returns false after a path loses an edge" do
+        graph3path = Graph.path_graph(3)
+        graph3path.connected?.should be_true
+        graph3path.delete_edge! "e3"
+        graph3path.connected?.should be_false
+      end
+
+    end
+
+  end
+end

data/tasks/benchmark.rb

@@ -0,0 +1,47 @@
+namespace :benchmark do
+
+  desc "Test that benchmarks work"
+  task :test do
+    p "Setting up benchmarking"
+    setup_benchmark
+
+    p "Testing benchmarking"
+    Timer.start
+    AbstractGraph::Graph.petersen_graph
+  end
+
+  desc "Benchmark a file with AbstractGraph code"
+  task :run, :file_path do |t, args|
+    setup_benchmark
+    Timer.start
+    require args[:file_path]
+  end
+
+  module Timer
+    class << self
+      def start
+        @start_time = Time.now
+      end
+
+      def start_method method
+        p "start #{method} #{'%.8f' % (Time.now - @start_time)}"
+      end
+
+      def end_method method
+        p "end #{method} #{'%.8f' % (Time.now - @start_time)}"
+      end
+    end
+  end
+
+  def setup_benchmark
+    AbstractGraph::Graph.instance_methods(false).each do |method|
+      AbstractGraph::Graph.send( :alias_method, "benched_#{method}", method )
+      AbstractGraph::Graph.send( :define_method, method ) do |*args, &block|
+        Timer.start_method method
+        send( "benched_#{method}", *args, &block )
+        Timer.end_method method
+      end
+    end
+  end
+end
+

data/tasks/create_method.rb

@@ -0,0 +1,64 @@
+desc "Create a method and corresponding test - run with wanted lib file"
+task :create_method, :method_path do |t, args|
+  method_path = args[:method_path]
+  if File.extname(method_path) == ""
+    method_path << ".rb"
+  end
+  method_directories, method_name = File.split(method_path)
+  method_name = File.basename(method_name, ".rb")
+
+  lib_path = "lib/" + method_path
+  spec_path = File.join "spec/", method_directories, method_name + "_spec.rb"
+  lib_require_path = "lib/" + method_directories + ".rb"
+
+
+  if File.file?( lib_path ) || File.file?( spec_path )
+    puts "This file already exists"
+    next
+  end
+  unless File.file?( lib_require_path )
+    puts "No place to put the require"
+    next
+  end
+
+  # Create the filler
+  lib_fill = "# required in \"#{method_directories}\"\n\n"
+  spec_fill = "require 'spec_helper'\n\n"
+
+  modules = method_directories.split(/\//)
+  modules.map! do |modulez|
+    modulez.capitalize.gsub(/_./) {|s| s[1].capitalize}
+  end
+  last_module = modules.pop
+
+  modules.each do |modulez|
+    lib_fill << "module #{modulez}\n"
+    spec_fill << "module #{modulez}\n"
+  end
+
+  lib_fill << "class #{last_module}\n"
+  spec_fill << "describe #{last_module} do\n"
+
+  lib_fill << "\n# d:\n# a:\n# t:\n# p:\n# r:\ndef #{method_name}\nend\n\n"
+  spec_fill << "\ndescribe \"##{method_name}\" do\nend\n\n"
+
+  modules.size.next.times do |i|
+    lib_fill << "end\n"
+    spec_fill << "end\n"
+  end
+
+
+  puts "Adding #{lib_path}"
+  File.open( lib_path, "w" ) do |file|
+    file << lib_fill
+  end
+  puts "Adding #{spec_path}"
+  File.open( spec_path, "w" ) do |file|
+    file << spec_fill
+  end
+  puts "Updating #{lib_require_path}"
+  File.open( lib_require_path, "a" ) do |file|
+    file.write "require \"#{method_directories}/#{method_name}\""
+  end
+end
+

data/tasks/list_methods.rb

@@ -0,0 +1,5 @@
+desc "List all methods"
+task :list_methods do
+  puts Dir.glob("lib/**/*").select {|f| File.file? f}.map {|f| f[/(?<=lib\/).*/]}
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abstract_graph
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Austin Lee ~D4L
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-07 00:00:00.000000000 Z
+date: 2014-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -24,9 +24,8 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.5'
-description: |-
-  Abstract Graph is a graphing library that can create
-                           mathematical graphs and perform operatations on them.
+description: ! "Abstract Graph is a graphing library that can create\n                         mathematical
+  graphs and perform operatations on them."
 email:
 - Austin.Lee.D4L@gmail.com
 executables: []
@@ -44,15 +43,21 @@ files:
 - lib/abstract_graph/composition/edge.rb
 - lib/abstract_graph/composition/edge/initialize.rb
 - lib/abstract_graph/composition/edge/is_coincident.rb
-- lib/abstract_graph/composition/uniquenamecollection.rb
-- lib/abstract_graph/composition/uniquenamecollection/add.rb
-- lib/abstract_graph/composition/uniquenamecollection/dup.rb
-- lib/abstract_graph/composition/uniquenamecollection/initialize.rb
-- lib/abstract_graph/composition/uniquenamecollection/link.rb
-- lib/abstract_graph/composition/uniquenamecollection/method_missing.rb
-- lib/abstract_graph/composition/uniquenamecollection/rename.rb
+- lib/abstract_graph/composition/unique_name_collection.rb
+- lib/abstract_graph/composition/unique_name_collection/add.rb
+- lib/abstract_graph/composition/unique_name_collection/delete.rb
+- lib/abstract_graph/composition/unique_name_collection/dup.rb
+- lib/abstract_graph/composition/unique_name_collection/each.rb
+- lib/abstract_graph/composition/unique_name_collection/find.rb
+- lib/abstract_graph/composition/unique_name_collection/initialize.rb
+- lib/abstract_graph/composition/unique_name_collection/link.rb
+- lib/abstract_graph/composition/unique_name_collection/method_missing.rb
+- lib/abstract_graph/composition/unique_name_collection/rename.rb
+- lib/abstract_graph/composition/unique_name_collection/ticket.rb
+- lib/abstract_graph/composition/unique_name_collection/ticket/get.rb
+- lib/abstract_graph/composition/unique_name_collection/ticket/initialize.rb
+- lib/abstract_graph/composition/unique_name_collection/ticket/set.rb
 - lib/abstract_graph/composition/vertex.rb
-- lib/abstract_graph/composition/vertex/delete.rb
 - lib/abstract_graph/composition/vertex/initialize.rb
 - lib/abstract_graph/graph.rb
 - lib/abstract_graph/graph/add_edge.rb
@@ -60,6 +65,7 @@ files:
 - lib/abstract_graph/graph/adjacency_list.rb
 - lib/abstract_graph/graph/change_edge_name.rb
 - lib/abstract_graph/graph/change_vertex_name.rb
+- lib/abstract_graph/graph/connected.rb
 - lib/abstract_graph/graph/delete_edge.rb
 - lib/abstract_graph/graph/delete_vertex.rb
 - lib/abstract_graph/graph/dup.rb
@@ -82,14 +88,15 @@ files:
 - spec/abstract_graph/composition/edge/name_spec.rb
 - spec/abstract_graph/composition/edge/vertices_spec.rb
 - spec/abstract_graph/composition/edge_spec.rb
-- spec/abstract_graph/composition/uniquenamecollection/add_spec.rb
-- spec/abstract_graph/composition/uniquenamecollection/dup_spec.rb
-- spec/abstract_graph/composition/uniquenamecollection/initialize_spec.rb
-- spec/abstract_graph/composition/uniquenamecollection/link_spec.rb
-- spec/abstract_graph/composition/uniquenamecollection/method_missing_spec.rb
-- spec/abstract_graph/composition/uniquenamecollection/rename_spec.rb
-- spec/abstract_graph/composition/uniquenamecollection_spec.rb
-- spec/abstract_graph/composition/vertex/delete_spec.rb
+- spec/abstract_graph/composition/unique_name_collection/add_spec.rb
+- spec/abstract_graph/composition/unique_name_collection/dup_spec.rb
+- spec/abstract_graph/composition/unique_name_collection/each_spec.rb
+- spec/abstract_graph/composition/unique_name_collection/find_spec.rb
+- spec/abstract_graph/composition/unique_name_collection/initialize_spec.rb
+- spec/abstract_graph/composition/unique_name_collection/link_spec.rb
+- spec/abstract_graph/composition/unique_name_collection/method_missing_spec.rb
+- spec/abstract_graph/composition/unique_name_collection/rename_spec.rb
+- spec/abstract_graph/composition/unique_name_collection_spec.rb
 - spec/abstract_graph/composition/vertex/initialize_spec.rb
 - spec/abstract_graph/composition/vertex/name_spec.rb
 - spec/abstract_graph/composition/vertex/value_spec.rb
@@ -99,6 +106,7 @@ files:
 - spec/abstract_graph/graph/adjacency_list_spec.rb
 - spec/abstract_graph/graph/change_edge_name_spec.rb
 - spec/abstract_graph/graph/change_vertex_name_spec.rb
+- spec/abstract_graph/graph/connected_spec.rb
 - spec/abstract_graph/graph/delete_edge_spec.rb
 - spec/abstract_graph/graph/delete_vertex_spec.rb
 - spec/abstract_graph/graph/dup_spec.rb
@@ -118,6 +126,9 @@ files:
 - spec/abstract_graph_spec.rb
 - spec/dummy_helper.rb
 - spec/spec_helper.rb
+- tasks/benchmark.rb
+- tasks/create_method.rb
+- tasks/list_methods.rb
 homepage: https://github.com/D4L/abstractGraph
 licenses:
 - MIT
@@ -128,17 +139,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Mathmatical graph analysis software.
@@ -148,14 +159,15 @@ test_files:
 - spec/abstract_graph/composition/edge/name_spec.rb
 - spec/abstract_graph/composition/edge/vertices_spec.rb
 - spec/abstract_graph/composition/edge_spec.rb
-- spec/abstract_graph/composition/uniquenamecollection/add_spec.rb
-- spec/abstract_graph/composition/uniquenamecollection/dup_spec.rb
-- spec/abstract_graph/composition/uniquenamecollection/initialize_spec.rb
-- spec/abstract_graph/composition/uniquenamecollection/link_spec.rb
-- spec/abstract_graph/composition/uniquenamecollection/method_missing_spec.rb
-- spec/abstract_graph/composition/uniquenamecollection/rename_spec.rb
-- spec/abstract_graph/composition/uniquenamecollection_spec.rb
-- spec/abstract_graph/composition/vertex/delete_spec.rb
+- spec/abstract_graph/composition/unique_name_collection/add_spec.rb
+- spec/abstract_graph/composition/unique_name_collection/dup_spec.rb
+- spec/abstract_graph/composition/unique_name_collection/each_spec.rb
+- spec/abstract_graph/composition/unique_name_collection/find_spec.rb
+- spec/abstract_graph/composition/unique_name_collection/initialize_spec.rb
+- spec/abstract_graph/composition/unique_name_collection/link_spec.rb
+- spec/abstract_graph/composition/unique_name_collection/method_missing_spec.rb
+- spec/abstract_graph/composition/unique_name_collection/rename_spec.rb
+- spec/abstract_graph/composition/unique_name_collection_spec.rb
 - spec/abstract_graph/composition/vertex/initialize_spec.rb
 - spec/abstract_graph/composition/vertex/name_spec.rb
 - spec/abstract_graph/composition/vertex/value_spec.rb
@@ -165,6 +177,7 @@ test_files:
 - spec/abstract_graph/graph/adjacency_list_spec.rb
 - spec/abstract_graph/graph/change_edge_name_spec.rb
 - spec/abstract_graph/graph/change_vertex_name_spec.rb
+- spec/abstract_graph/graph/connected_spec.rb
 - spec/abstract_graph/graph/delete_edge_spec.rb
 - spec/abstract_graph/graph/delete_vertex_spec.rb
 - spec/abstract_graph/graph/dup_spec.rb