mgraph 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ec4492a401e3b784164bc9c65e63469f1a9b3c4c
+  data.tar.gz: 9c724aa9dad2b3591853dbb6218377d64f1194dc
+SHA512:
+  metadata.gz: fb012711dd8631c904aaa9c80d3609073417579ae2d474aa52636f7e32b2ffdf1e7df69cb7ba892f350329a50c8289278487ed58c72facc76de9dab81949a668
+  data.tar.gz: 69a3e584931b7fa9f9cc27b4d48e6de10c8d642034dc5017d72b36a8be716f1fbe2ba0bfbfef354ea6cd2702ebef32c74cf7c5af07219352d3edf069595a0b39

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+  - rbx-19mode

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mgraph.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Andrew Marshall <http://johnandrewmarshall.com/>
+
+MIT License
+
+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.md

@@ -0,0 +1,29 @@
+# MGraph
+
+[![Build Status](https://secure.travis-ci.org/amarshall/mgraph.png?branch=master)](https://travis-ci.org/amarshall/mgraph)
+[![Code Climate rating](https://codeclimate.com/github/amarshall/mgraph.png)](https://codeclimate.com/github/amarshall/mgraph)
+[![Gem Version](https://badge.fury.io/rb/mgraph.png)](https://rubygems.org/gems/mgraph)
+
+A modern graph data structure library. Still very much a work-in-progress and in-flux.
+
+## Installation
+
+Install as usual: `gem install mgraph` or add `gem 'mgraph'` to your Gemfile
+
+## Usage
+
+TODO
+
+## Contributing
+
+Contributions are welcome. Please be sure that your pull requests are atomic so they can be considered and accepted separately.
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Credits & License
+
+Copyright © 2013 J. Andrew Marshall. License is available in the LICENSE file.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new do |t|
+  t.ruby_opts = '-w' unless ENV['TRAVIS']
+end
+
+task :default => :spec

data/lib/mgraph.rb

@@ -0,0 +1,5 @@
+require 'mgraph/version'
+
+module MGraph
+  # Your code goes here...
+end

data/lib/mgraph/builder.rb

@@ -0,0 +1,28 @@
+module MGraph
+  class Builder
+    def initialize neighbor_retriever
+      @neighbor_retriever = neighbor_retriever
+      freeze
+    end
+
+    def build root
+      graph = Graph.new
+      traverse_and_build graph, root
+    end
+
+    private
+
+    def traverse_and_build graph, vertex
+      neighbors = @neighbor_retriever.(vertex)
+
+      neighbors.reject do |neighbor|
+        graph.has_edge? vertex, neighbor
+      end.each do |neighbor|
+        graph.add_edge vertex, neighbor
+        traverse_and_build graph, neighbor
+      end
+
+      graph
+    end
+  end
+end

data/lib/mgraph/edge.rb

@@ -0,0 +1,21 @@
+require 'set'
+
+module MGraph
+  class Edge
+    attr_reader :vertices
+
+    def initialize a, b
+      @vertices = [a, b].to_set.freeze
+      freeze
+    end
+
+    def == other
+      @vertices == other.vertices
+    end
+    alias_method :eql?, :==
+
+    def hash
+      self.class.hash ^ @vertices.hash
+    end
+  end
+end

data/lib/mgraph/graph.rb

@@ -0,0 +1,57 @@
+require 'mgraph/edge'
+require 'mgraph/vertex_edge_table'
+
+require 'set'
+
+module MGraph
+  class Graph
+    def initialize graph_store = VertexEdgeTable.new
+      @graph_store = graph_store
+    end
+
+    def add_edge v1, v2
+      edge = Edge.new v1, v2
+      @graph_store.add_edge edge
+      edge
+    end
+
+    def breadth_first_traverse starting_vertex
+      return enum_for(:breadth_first_traverse, starting_vertex) unless block_given?
+
+      queue = [starting_vertex, *neighbors(starting_vertex)]
+      visited = []
+      while vertex = queue.shift
+        yield vertex
+        visited << vertex
+        queue += neighbors(vertex).to_a - visited
+        queue = queue.uniq
+      end
+    end
+
+    def each_vertex
+      return vertices.each unless block_given?
+      vertices.each { |vertex| yield vertex }
+    end
+
+    def edges
+      @graph_store.edges
+    end
+
+    def has_edge? v1, v2
+      edge = Edge.new v1, v2
+      edges.include? edge
+    end
+
+    def has_vertex? vertex
+      vertices.include? vertex
+    end
+
+    def neighbors vertex
+      @graph_store.neighbors vertex
+    end
+
+    def vertices
+      @graph_store.vertices
+    end
+  end
+end

data/lib/mgraph/version.rb

@@ -0,0 +1,3 @@
+module MGraph
+  VERSION = '0.0.1'
+end

data/lib/mgraph/vertex_edge_table.rb

@@ -0,0 +1,36 @@
+module MGraph
+  class VertexEdgeTable
+    def initialize
+      @vertex_edges = {}
+    end
+
+    def << edge
+      add_edge(edge)
+      self
+    end
+
+    def add_edge edge
+      edge.vertices.each do |vertex|
+        (@vertex_edges[vertex] ||= Set.new) << edge
+      end
+    end
+
+    def edges
+      @vertex_edges.each_value.reduce(Set.new, :+).freeze
+    end
+
+    def incident_edges vertex
+      @vertex_edges.fetch(vertex, Set.new)
+    end
+
+    def neighbors vertex
+      adjacencies = incident_edges(vertex).map(&:vertices).reduce(:+) || Set.new
+      adjacencies - [vertex]
+    end
+
+    def vertices
+      @vertex_edges.keys.to_set
+    end
+  end
+  private_constant :VertexEdgeTable
+end

data/mgraph.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mgraph/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mgraph'
+  spec.version       = MGraph::VERSION
+  spec.authors       = ['Andrew Marshall']
+  spec.email         = ['andrew@johnandrewmarshall.com']
+  spec.description   = %q{A modern graph data structure library.}
+  spec.summary       = %q{A modern graph data structure library.}
+  spec.homepage      = 'http://johnandrewmarshall.com/projects/mgraph'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/spec/mgraph/builder_spec.rb

@@ -0,0 +1,46 @@
+require 'mgraph/builder'
+
+describe MGraph::Builder do
+  it "builds a graph given a starting object and a way to get its neighbors" do
+    neighbor_get = ->(vertex) { vertex.neighbors }
+    builder = MGraph::Builder.new(neighbor_get)
+    l2_1_neighbors = [double(neighbors: [])]
+    l2_2_neighbors = [double(neighbors: [])]
+    root_neighbors = [
+      double(neighbors: l2_1_neighbors),
+      double(neighbors: l2_2_neighbors),
+    ]
+    root = double neighbors: root_neighbors
+
+    graph = builder.build root
+
+    expect(graph.vertices).to eq [
+      root,
+      *root_neighbors,
+      *l2_1_neighbors,
+      *l2_2_neighbors,
+    ].to_set
+  end
+
+  it "can handle circular graphs" do
+    neighbor_get = ->(vertex) { vertex.neighbors }
+    builder = MGraph::Builder.new(neighbor_get)
+    root = double
+    l2_1_neighbors = [double(neighbors: [root])]
+    l2_2_neighbors = [double(neighbors: [])]
+    root_neighbors = [
+      double(neighbors: l2_1_neighbors),
+      double(neighbors: l2_2_neighbors),
+    ]
+    root.stub(:neighbors).and_return root_neighbors
+
+    graph = builder.build root
+
+    expect(graph.vertices).to eq [
+      root,
+      *root_neighbors,
+      *l2_1_neighbors,
+      *l2_2_neighbors,
+    ].to_set
+  end
+end

data/spec/mgraph/edge_spec.rb

@@ -0,0 +1,63 @@
+require 'mgraph/edge'
+
+describe MGraph::Edge do
+  it "contains an undirected pair of objects" do
+    v1, v2 = double, double
+    edge = MGraph::Edge.new v1, v2
+    expect(edge.vertices).to eq [v1, v2].to_set
+  end
+
+  it "does not allow modification of its vertices" do
+    v1, v2 = double, double
+    edge = MGraph::Edge.new v1, v2
+    expect { edge.vertices << double }.to raise_error(/frozen/i)
+  end
+
+  describe "equality" do
+    it "is `equal` to itself" do
+      edge = MGraph::Edge.new double, double
+
+      expect(edge == edge).to eq true
+      expect(edge.eql?(edge)).to eq true
+      expect(edge.equal?(edge)).to eq true
+    end
+
+    it "is equal to another Edge with the same vertices" do
+      v1, v2 = double, double
+      a = MGraph::Edge.new v1, v2
+      b = MGraph::Edge.new v2, v1
+
+      expect(a == b).to eq true
+      expect(a.eql?(b)).to eq true
+      expect(a.equal?(b)).to eq false
+    end
+
+    it "is not equal to another Edge with different vertices" do
+      v1, v2, v3 = double, double, double
+      a = MGraph::Edge.new v1, v2
+      b = MGraph::Edge.new v2, v3
+
+      expect(a == b).to eq false
+      expect(a.eql?(b)).to eq false
+      expect(a.equal?(b)).to eq false
+    end
+  end
+
+  describe "#hash" do
+    it "is the same for Edges with the same vertices" do
+      v1, v2 = double, double
+      a = MGraph::Edge.new v1, v2
+      b = MGraph::Edge.new v2, v1
+
+      expect(a.hash).to eq b.hash
+    end
+
+    it "is different for Edges with different vertices" do
+      v1, v2, v3 = double, double, double
+      a = MGraph::Edge.new v1, v2
+      b = MGraph::Edge.new v2, v3
+
+      expect(a.hash).to_not eq b.hash
+    end
+  end
+end

data/spec/mgraph/graph_spec.rb

@@ -0,0 +1,157 @@
+require 'mgraph/graph'
+
+describe MGraph::Graph do
+  describe "#add_edge" do
+    it "accepts edges as two vertices, returning the Edge" do
+      v1, v2, = double, double
+      edge = double vertices: [v1, v2]
+      graph = MGraph::Graph.new
+      MGraph::Edge.stub(:new).with(v1, v2).and_return edge
+
+      returned = graph.add_edge v1, v2
+
+      expect(returned).to eq edge
+    end
+  end
+
+  describe "#breadth_first_traverse" do
+    it "yields the vertices in breadth-first order, starting at the given vertex" do
+      graph = MGraph::Graph.new
+      graph.add_edge 1, 2
+      graph.add_edge 1, 3
+      graph.add_edge 2, 4
+      graph.add_edge 2, 5
+      graph.add_edge 3, 5
+      graph.add_edge 4, 5
+
+      yielded = []
+      graph.breadth_first_traverse(1) { |vertex| yielded << vertex }
+
+      expect(yielded).to eq [1, 2, 3, 4, 5]
+    end
+
+    it "returns an Enumerator when no block is given" do
+      graph = MGraph::Graph.new
+      enumerator = graph.breadth_first_traverse(1)
+      graph.add_edge 1, 2
+      graph.add_edge 1, 3
+      graph.add_edge 2, 4
+
+      graph.breadth_first_traverse(1)
+
+      expect(enumerator).to be_a Enumerator
+      expect(enumerator.to_a).to eq [1, 2, 3, 4]
+    end
+  end
+
+  describe "#each_vertex" do
+    it "yields each vertex to the given block" do
+      vertices = [double, double, double, double]
+      graph = MGraph::Graph.new
+      vertices.each_cons(2) { |v1, v2| graph.add_edge v1, v2 }
+
+      yielded = []
+      graph.each_vertex { |v| yielded << v }
+
+      expect(yielded).to eq vertices
+    end
+
+    it "returns an Enumerator when no block is given" do
+      vertices = [double, double, double, double]
+      graph = MGraph::Graph.new
+      vertices.each_cons(2) { |v1, v2| graph.add_edge v1, v2 }
+
+      enumerator = graph.each_vertex
+
+      expect(enumerator).to be_a Enumerator
+      expect(enumerator.to_a).to eq vertices
+    end
+  end
+
+  describe "#edges" do
+    it "returns all the edges" do
+      v1, v2, v3, v4 = double, double
+      edge_1, edge_2 = double(vertices: [v1, v2]), double(vertices: [v3, v4])
+      graph = MGraph::Graph.new
+      MGraph::Edge.stub(:new).with(v1, v2).and_return edge_1
+      MGraph::Edge.stub(:new).with(v3, v4).and_return edge_2
+
+      graph.add_edge v1, v2
+      graph.add_edge v3, v4
+
+      expect(graph.edges).to eq [edge_1, edge_2].to_set
+    end
+
+    it "does not allow modification of the edges" do
+      graph = MGraph::Graph.new
+      expect{ graph.edges << double }.to raise_error(/frozen/i)
+    end
+  end
+
+  describe "#has_edge?" do
+    it "returns true if there is an edge between the given vertices" do
+      v1, v2, = double, double
+      graph = MGraph::Graph.new
+      graph.add_edge v1, v2
+
+      expect(graph.has_edge?(v1, v2)).to eq true
+      expect(graph.has_edge?(v2, v1)).to eq true
+    end
+
+    it "returns false if there is not an edge between the given vertices" do
+      v1, v2, = double, double
+      graph = MGraph::Graph.new
+      graph.add_edge v1, v2
+
+      expect(graph.has_edge?(v1, double)).to eq false
+      expect(graph.has_edge?(double, v2)).to eq false
+    end
+  end
+
+  describe "#has_vertex?" do
+    it "returns true if the vertex has been added" do
+      v1, v2, = double, double
+      graph = MGraph::Graph.new
+      graph.add_edge v1, v2
+
+      expect(graph.has_vertex?(v1)).to eq true
+      expect(graph.has_vertex?(v2)).to eq true
+    end
+
+    it "returns false if the vertex has not been added" do
+      v1, v2, = double, double
+      graph = MGraph::Graph.new
+      graph.add_edge v1, v2
+
+      expect(graph.has_vertex?(double)).to eq false
+    end
+  end
+
+  describe "#neighbors" do
+    it "returns an empty set when the vertex doesn't exist" do
+      graph = MGraph::Graph.new
+      expect(graph.neighbors(double)).to eq Set.new
+    end
+
+    it "returns the neighbors of a given vertex" do
+      neighbors = [double, double, double]
+      not_neighbors = [double, double, double]
+      vertex = [double]
+      graph = MGraph::Graph.new
+      neighbors.each { |neighbor| graph.add_edge vertex, neighbor }
+      neighbors.zip(not_neighbors) { |v1, v2| graph.add_edge v1, v2 }
+
+      expect(graph.neighbors(vertex)).to eq neighbors.to_set
+    end
+  end
+
+  describe "#vertices" do
+    it "returns a set with all the added vertices" do
+      vertices = [double, double, double, double]
+      graph = MGraph::Graph.new
+      vertices.each_cons(2) { |v1, v2| graph.add_edge v1, v2 }
+
+      expect(graph.vertices).to eq vertices.to_set
+    end
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: mgraph
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Marshall
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A modern graph data structure library.
+email:
+- andrew@johnandrewmarshall.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mgraph.rb
+- lib/mgraph/builder.rb
+- lib/mgraph/edge.rb
+- lib/mgraph/graph.rb
+- lib/mgraph/version.rb
+- lib/mgraph/vertex_edge_table.rb
+- mgraph.gemspec
+- spec/mgraph/builder_spec.rb
+- spec/mgraph/edge_spec.rb
+- spec/mgraph/graph_spec.rb
+homepage: http://johnandrewmarshall.com/projects/mgraph
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.5
+signing_key: 
+specification_version: 4
+summary: A modern graph data structure library.
+test_files:
+- spec/mgraph/builder_spec.rb
+- spec/mgraph/edge_spec.rb
+- spec/mgraph/graph_spec.rb
+has_rdoc: