simple-graph 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9df289cf2e820574d29a3423187552d0f41cd4be
+  data.tar.gz: 28ff78a5bc850c98b9507a13f32ee7dfb548267e
+SHA512:
+  metadata.gz: 5f87b5205d846ab77fcd96a0b004bc602088affae6ebc23be3e8eccae760e077e92402ed7fea1060f5834071748ace4335f2c469f3cd91caaedd7cc922808438
+  data.tar.gz: c0ab5acf01b7d4c436e3f3b477db72c702984294770373de8ebf77923cfe5a1c6ea86e5c8c628bf22004c2a31114b8e5d1b3ceb36d7f3b66c072f56e2b1be8d0

data/Gemfile

@@ -0,0 +1,13 @@
+source 'http://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'pry-nav'
+  gem 'rake'
+end
+
+group :test do
+  gem 'rspec'
+  gem 'rr'
+end

data/History.txt

@@ -0,0 +1,3 @@
+== 1.0.0
+
+* Birthday!

data/README.md

@@ -0,0 +1,57 @@
+
+## simple-graph [![Build Status](https://secure.travis-ci.org/camertron/simple-graph.png?branch=master)](http://travis-ci.org/camertron/simple-graph)
+
+A simple, no-frills graph implementation.
+
+## Installation
+
+`gem install simple-graph`
+
+## Usage
+
+```ruby
+require 'simple-graph'
+```
+
+### Adding Vertices
+
+Let's model an airline that flies to certain cities:
+
+```ruby
+graph = SimpleGraph::Graph.new
+graph.add_vertex('Seattle')
+graph.add_vertex('Los Angeles')
+graph.add_vertex('Denver')
+graph.add_vertex('New York')
+graph.add_vertex('Miami')
+```
+
+### Adding Edges
+
+```ruby
+graph.add_edge('Seattle', 'Los Angeles')
+graph.add_edge('Seattle', 'Denver')
+graph.add_edge('Los Angeles', 'Miami')
+graph.add_edge('Denver', 'New York')
+graph.add_edge('New York', 'Miami')
+```
+
+### Shortest Path
+
+SimpleGraph doesn't support weighted edges, so let's pretend all these cities are equidistant from each other. We could also say we're trying to find the least number of layovers:
+
+```ruby
+graph.shortest_path('Seattle', 'Miami')  # ["Seattle", "Los Angeles", "Miami"]
+```
+
+## Requirements
+
+None.
+
+## Running Tests
+
+`bundle exec rspec`
+
+## Authors
+
+* Cameron C. Dutro: http://github.com/camertron

data/Rakefile

@@ -0,0 +1,18 @@
+# encoding: UTF-8
+
+require 'rubygems' unless ENV['NO_RUBYGEMS']
+
+require 'bundler'
+require 'rspec/core/rake_task'
+require 'rubygems/package_task'
+
+require './lib/simple-graph'
+
+Bundler::GemHelper.install_tasks
+
+task :default => :spec
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = './spec/**/*_spec.rb'
+end

data/lib/simple-graph.rb

@@ -0,0 +1,90 @@
+# encoding: UTF-8
+
+module SimpleGraph
+
+  class Vertex
+    attr_reader :value, :neighbors
+
+    def initialize(value, neighbors = {})
+      @value = value
+      @neighbors = neighbors || {}
+    end
+
+    def add_neighbor(vertex)
+      neighbors[vertex.value] ||= vertex
+    end
+  end
+
+  class Graph
+    attr_reader :vertices
+
+    def initialize
+      @vertices = {}
+    end
+
+    def add_vertex(value)
+      vertices[value] ||= create_vertex(value)
+    end
+
+    def add_edge(value1, value2)
+      vertices[value1].add_neighbor(vertices[value2])
+    end
+
+    # Djikstra's shortest path algorithm, adapted from:
+    # https://gist.github.com/yaraki/1730288
+    def shortest_path(source, target = nil)
+      distances = {}
+      previouses = {}
+
+      vertices.each_pair do |key, vertex|
+        distances[key] = nil # Infinity
+        previouses[key] = nil
+      end
+
+      distances[source] = 0
+      verts = vertices.clone        
+
+      until verts.empty?
+        nearest_vertex = verts.inject(verts.first.first) do |a, (b, c)|
+          next b unless distances[a]
+          next a unless distances[b]
+          next a if distances[a] < distances[b]
+          b
+        end
+
+        break unless distances[nearest_vertex] # Infinity
+
+        if target && nearest_vertex == target
+          return compose_path(target, distances[target], previouses)
+        end
+
+        neighbors = verts[nearest_vertex].neighbors
+        neighbors.each_pair do |name, vertex|
+          alt = distances[nearest_vertex] + 1
+
+          if distances[name].nil? || alt < distances[name]
+            distances[name] = alt
+            previouses[name] = nearest_vertex
+          end
+        end
+        verts.delete(nearest_vertex)
+      end
+    end
+
+    private
+
+    def compose_path(target, distance, previouses)
+      result = Array.new(distance)
+      distance.downto(0) do |i|
+        result[i] = target
+        target = previouses[target]
+      end
+      result
+    end
+
+    def create_vertex(value, edges = nil)
+      Vertex.new(value, edges)
+    end
+  end
+
+end

data/lib/simple-graph/version.rb

@@ -0,0 +1,5 @@
+# encoding: UTF-8
+
+module SimpleGraph
+  VERSION = "1.0.0"
+end

data/simple-graph.gemspec

@@ -0,0 +1,18 @@
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+require 'simple-graph/version'
+
+Gem::Specification.new do |s|
+  s.name     = "simple-graph"
+  s.version  = ::SimpleGraph::VERSION
+  s.authors  = ["Cameron Dutro"]
+  s.email    = ["camertron@gmail.com"]
+  s.homepage = "http://github.com/camertron"
+
+  s.description = s.summary = "A simple, no-frills graph implementation."
+
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+
+  s.require_path = 'lib'
+  s.files = Dir["{lib,spec}/**/*", "Gemfile", "History.txt", "README.md", "Rakefile", "simple-graph.gemspec"]
+end

data/spec/simple-graph_spec.rb

@@ -0,0 +1,50 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+describe SimpleGraph do
+  let(:graph) { SimpleGraph::Graph.new }
+
+  describe '#add_vertex' do
+    it 'should add vertices correctly' do
+      graph.add_vertex('Seattle').tap do |vertex|
+        expect(vertex).to be_a(SimpleGraph::Vertex)
+        expect(vertex.value).to eq('Seattle')
+        expect(vertex.neighbors).to eq({})
+      end
+    end
+  end
+
+  describe '#add_edge' do
+    it 'should add edges correctly' do
+      seattle = graph.add_vertex('Seattle')
+      la = graph.add_vertex('Los Angeles')
+      graph.add_edge('Seattle', 'Los Angeles')
+      expect(seattle.neighbors).to include('Los Angeles')
+    end
+  end
+
+  context 'with a nice graph' do
+    before(:each) do
+      graph.add_vertex('Seattle')
+      graph.add_vertex('Los Angeles')
+      graph.add_vertex('Denver')
+      graph.add_vertex('New York')
+      graph.add_vertex('Miami')
+
+      graph.add_edge('Seattle', 'Los Angeles')
+      graph.add_edge('Seattle', 'Denver')
+      graph.add_edge('Los Angeles', 'Miami')
+      graph.add_edge('Denver', 'New York')
+      graph.add_edge('New York', 'Miami')
+    end
+
+    describe '#shortest_path' do
+      it 'finds the shortest path' do
+        expect(graph.shortest_path('Seattle', 'Miami')).to eq([
+          "Seattle", "Los Angeles", "Miami"
+        ])
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+# encoding: UTF-8
+
+$:.push(File.dirname(__FILE__))
+
+require 'rspec'
+require 'simple-graph'
+require 'pry-nav'
+
+RSpec.configure do |config|
+  config.mock_with :rr
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: simple-graph
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Cameron Dutro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-23 00:00:00.000000000 Z
+dependencies: []
+description: A simple, no-frills graph implementation.
+email:
+- camertron@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- History.txt
+- README.md
+- Rakefile
+- lib/simple-graph.rb
+- lib/simple-graph/version.rb
+- simple-graph.gemspec
+- spec/simple-graph_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/camertron
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A simple, no-frills graph implementation.
+test_files: []