graph.njae 0.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.6.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.2"
+  gem "rcov", ">= 0"
+  gem "rdoc"
+end

data/Gemfile.lock

@@ -0,0 +1,30 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.6.2)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2)
+    rcov (0.9.9)
+    rdoc (3.7)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.2)
+  rcov
+  rdoc
+  rspec (~> 2.6.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Neil Smith
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,19 @@
+= graph.njae
+
+A simple graph library in Ruby.
+
+== Contributing to graph.njae
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Neil Smith. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "graph.njae"
+  gem.homepage = "http://github.com/NeilNjae/graph.njae"
+  gem.license = "MIT"
+  gem.summary = %Q{A simple graph library}
+  gem.description = %Q{A simple graph library}
+  gem.email = "neil.github@njae.me.uk"
+  gem.authors = ["Neil Smith"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+# require 'rake/rdoctask'
+# Rake::RDocTask.new do |rdoc|
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "graph.njae #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/graph.njae.gemspec

@@ -0,0 +1,68 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{graph.njae}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Neil Smith"]
+  s.date = %q{2011-09-23}
+  s.description = %q{A simple graph library}
+  s.email = %q{neil.github@njae.me.uk}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "graph.njae.gemspec",
+    "lib/graph.njae.rb",
+    "lib/graph/edge.rb",
+    "lib/graph/graph.rb",
+    "lib/graph/vertex.rb",
+    "spec/graph/edge_spec.rb",
+    "spec/graph/graph_spec.rb",
+    "spec/graph/vertex_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/NeilNjae/graph.njae}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{A simple graph library}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.6.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.6.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.6.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+  end
+end
+

data/lib/graph.njae.rb

@@ -0,0 +1,3 @@
+require 'graph/graph'
+require 'graph/edge'
+require 'graph/vertex'

data/lib/graph/edge.rb

@@ -0,0 +1,46 @@
+require 'ostruct'
+
+# A simple graph library
+
+module Graph
+  
+  # An edge (or multiedge) in a graph. The edge can have arbitrary attributes,
+  # treated as method names.
+  #
+  # Each connection is handled by a Graph::Connection object, so that each end
+  # of the Edge can have it's own attributes.
+  class Edge < OpenStruct
+    def initialize
+      super
+      self.connections = []
+      self
+    end
+    
+    # Connect this edge to a vertex
+    def <<(other)
+      c = Connection.new
+      c.end = other
+      self.connections << c
+      self
+    end
+    
+    # Return the set of vertices this edge connects.
+    def vertices
+      self.connections.map {|c| c.end}
+    end
+    
+    # Return the connection object that joins this Edge to the specified Vertex
+    def connection_at(vertex)
+      self.connections.select {|c| c.end.equal?  vertex}.first
+    end
+  end
+  
+  # A connection between an Edge and a Vertex.The connection can have arbitrary attributes,
+  # treated as method names.
+  class Connection < OpenStruct
+    def initialize
+      super
+      self
+    end
+  end
+end

data/lib/graph/graph.rb

@@ -0,0 +1,27 @@
+require 'ostruct'
+
+# A simple graph library
+
+module Graph
+  
+  # A container for all the parts of a graph.  The graph can have arbitrary attributes,
+  # treated as method names.
+  class Graph < OpenStruct
+    def initialize
+      super
+      self.edges = Array.new
+      self.vertices = Array.new
+      self
+    end
+    
+    # Add a Vertex or Edge to the graph.
+    def <<(other)
+      if other.class == Vertex
+        self.vertices << other
+      elsif
+        self.edges << other
+      end
+      self
+    end
+  end
+end

data/lib/graph/vertex.rb

@@ -0,0 +1,41 @@
+require 'ostruct'
+
+# A simple graph library
+
+module Graph
+  # A vertex in a graph. The edge can have arbitrary attributes,treated as 
+  # method names.
+  class Vertex < OpenStruct
+    def initialize
+      super
+      self.edges = []
+      self
+    end
+    
+    # Connect this vertex to another, creating an Edge to do so, and returning
+    # the Edge
+    def connect(other)
+      e = Edge.new
+      e << self << other
+      self.edges << e
+      other.edges << e unless self === other
+      e
+    end
+    
+    # Connect this vertex to another, creating an Edge to do so, and returning
+    # this Vertex
+    def <<(other)
+      connect(other)
+      self
+    end
+    
+    # Return the set of neighbouring vertices
+    def neighbours
+      vertices = self.edges.map {|e| e.vertices}.flatten
+      vertices_to_me = vertices.select {|v| v == self}
+      other_vertices = vertices.select {|v| v != self}
+      (vertices_to_me[1..-1] || []) + other_vertices
+    end
+    
+  end
+end

data/spec/graph/edge_spec.rb

@@ -0,0 +1,100 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+module Graph
+  describe Edge do
+    let (:e) { Edge.new }
+    describe "#initialize" do
+      it "creates an empty edge" do
+        e = Edge.new
+        e.connections.should be_empty
+      end
+    end # #initialize
+    
+    describe "adds attribues" do
+      it "adds then reports arbitrary attributes" do
+        e.score = 15
+        e.score.should == 15
+      end
+    end # adds attributes
+    
+    describe "#<<" do
+      it "adds a new vertex to an edge (with a connection)" do
+        e.connections.should be_empty
+        v1 = Vertex.new
+        v2 = Vertex.new
+        e << v1
+        e.should have(1).connections
+        e.should have(1).vertices
+        e.vertices.should include(v1)
+        e << v2
+        e.should have(2).connections
+        e.should have(2).vertices
+        e.vertices.should include(v1)
+        e.vertices.should include(v2)
+      end
+      
+      it "adds several vertices to an edge" do
+        e.connections.should be_empty
+        v1 = Vertex.new
+        v2 = Vertex.new
+        e << v1 << v2
+        e.vertices.should include(v1)
+        e.vertices.should include(v2)
+        e.should have(2).vertices
+      end
+
+      it "adds a self-loop" do
+        e.connections.should be_empty
+        v1 = Vertex.new
+        e << v1 << v1
+        e.vertices.should include(v1)
+        e.should have(2).vertices
+        e.vertices.uniq.length.should == 1
+      end
+    end # #<<
+    
+    describe "connection_at" do
+      it "returns the connection that links to a vertex" do
+        e.connections.should be_empty
+        v1 = Vertex.new
+        v2 = Vertex.new
+        e << v1 << v2
+        
+        e.connection_at(v1).end.should be v1
+        e.connection_at(v2).end.should be v2
+      end
+      
+      it "returns nil if there is no connection to that vertex" do
+        e.connections.should be_empty
+        v1 = Vertex.new
+        v2 = Vertex.new
+        v3 = Vertex.new
+        e << v1 << v2
+        
+        e.connection_at(v3).should be nil
+      end
+      
+      it "returns the vertex for a self-loop" do
+        e.connections.should be_empty
+        v1 = Vertex.new
+        e << v1 << v1
+        
+        e.connection_at(v1).end.should be v1
+      end
+
+    
+    end # #connection_at
+  end # Edge
+  
+  describe Connection do
+    let (:c) {Connection.new }
+    
+    describe "adds attribues" do
+      it "adds then reports arbitrary attributes" do
+        c.score = 15
+        c.score.should == 15
+      end
+    end # adds attributes
+  end # Connection
+  
+end

data/spec/graph/graph_spec.rb

@@ -0,0 +1,65 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+module Graph
+  describe Graph do
+    let (:g) { Graph.new }
+    describe "#initialize" do
+      it "creates an empty graph" do
+        g = Graph.new
+        g.edges.should be_empty
+        g.vertices.should be_empty
+      end
+    end # #initialize
+      
+    describe "adds attribues" do
+      it "adds then reports arbitrary attributes" do
+        g.score = 15
+        g.score == 15
+      end
+    end # adds attributes
+    
+    describe "#<<" do
+      it "adds a set of vertices" do
+        g.vertices.should be_empty
+        v1 = Vertex.new
+        v2 = Vertex.new
+        g << v1 << v2
+        g.should have(2).vertices
+        g.vertices.should include(v1)
+        g.vertices.should include(v2)
+      end
+      
+      it "adds a set of edges" do
+        g.edges.should be_empty
+        e1 = Edge.new
+        e2 = Edge.new
+        g << e1 << e2
+        g.should have(2).edges
+        g.edges.should include(e1)
+        g.edges.should include(e2)
+      end
+      
+      it "adds a mixed set of vertices and edges" do
+        g.vertices.should be_empty
+        g.edges.should be_empty
+        v1 = Vertex.new
+        v2 = Vertex.new
+        e1 = Edge.new
+        e2 = Edge.new
+        g << v1 << e1 << v2 << e2
+        g.should have(2).vertices
+        g.vertices.should include(v1)
+        g.vertices.should include(v2)
+        g.should have(2).edges
+        g.edges.should include(e1)
+        g.edges.should include(e2)
+      end
+    end # #<<
+
+    describe "connect" do
+      it "adds and records an edge between vertices" do
+      end
+    end # #connect
+    
+  end
+end

data/spec/graph/vertex_spec.rb

@@ -0,0 +1,101 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+module Graph
+  describe Vertex do
+    let (:v) { Vertex.new }
+    
+    describe "#initialize" do
+      it "creates an empty vertex" do
+        v = Vertex.new
+        v.edges.should be_empty
+      end
+    end # #initialize
+    
+    describe "adds attribues" do
+      it "adds then reports arbitrary attributes" do
+        v.score = 15
+        v.score.should == 15
+      end
+    end # adds attributes
+    
+    describe "#<<" do
+      it "adds a single edge between vertices" do
+        v.neighbours.should be_empty
+        v.edges.should be_empty
+        
+        v1 = Vertex.new
+        v << v1
+        
+        v1.id = :v1 # Need this to ensure that v != v1
+        
+        v.should have(1).edges
+        v1.should have(1).edges
+        e = v.edges[0]
+        v1.edges.should include(e)
+        
+        v.should have(1).neighbours
+        v.neighbours.should include(v1)
+        v.neighbours.should_not include(v)
+        v1.should have(1).neighbours
+        v1.neighbours.should include(v)
+        v1.neighbours.should_not include(v1)
+      end
+
+      it "adds a single edge as a self-loop" do
+        v.neighbours.should be_empty
+        v.edges.should be_empty
+        
+        v << v
+        
+        v.should have(1).edges
+        v.should have(1).neighbours
+        v.neighbours.should include(v)
+      end
+    end # #<<
+    
+    describe "connect" do
+      it "connects two vertices" do
+        v1 = Vertex.new
+        v1.id = :v1 # Need this to ensure that v != v1
+
+        e = v.connect v1
+        
+        v.should have(1).neighbours
+        v.neighbours.should include(v1)
+        v.neighbours.should_not include(v)
+
+        v1.should have(1).neighbours
+        v1.neighbours.should include(v)
+        v1.neighbours.should_not include(v1)
+
+        v.should have(1).edges
+        v.edges.should include(e)
+        v1.should have(1).edges
+        v1.edges.should include(e)
+        
+        e.should have(2).vertices
+        e.vertices.should include(v)
+        e.vertices.should include(v1)
+
+              e.should have(2).connections
+      end
+
+      it "creates a self-connection" do
+        e = v.connect v
+        
+        v.should have(1).neighbours
+        v.neighbours.should include(v)
+
+        v.should have(1).edges
+        v.edges.should include(e)
+        
+        e.should have(2).vertices
+        e.vertices.uniq.length.should == 1
+        e.vertices.should include(v)
+
+        e.should have(2).connections
+      end
+
+    end # #connect
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'graph.njae'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: graph.njae
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Neil Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-23 00:00:00.000000000 +01:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &77209130 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *77209130
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &77208840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *77208840
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &77208540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.2
+  type: :development
+  prerelease: false
+  version_requirements: *77208540
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &77208290 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *77208290
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &77208030 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *77208030
+description: A simple graph library
+email: neil.github@njae.me.uk
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- graph.njae.gemspec
+- lib/graph.njae.rb
+- lib/graph/edge.rb
+- lib/graph/graph.rb
+- lib/graph/vertex.rb
+- spec/graph/edge_spec.rb
+- spec/graph/graph_spec.rb
+- spec/graph/vertex_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/NeilNjae/graph.njae
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -557460077
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A simple graph library
+test_files: []