djikstra 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c8e3e25342dbb274d1b4670ff4a80c3cf04c70a8
+  data.tar.gz: 2a4917c41f3e2dfc54f30eaa0af1863d13c8f0fc
+SHA512:
+  metadata.gz: 1e351f1acc0212724009b204a52da6678ad76c72347af45baadb894f1bc80290474eaee44cae1ed58eb6ad680ca6b78239927937ecd19fcce9b52508ea31bb58
+  data.tar.gz: 82790ff6a781b819a782f80c5e6af887abcc89c48e49f429c6c77b562841473d29292b4feea1b1ec62d64726f6b812569535266a6d10f937c568e40840ac0a4a

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/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.0

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - "1.9.2"
+  - "1.9.3"
+  - "2.0.0"
+  - "2.1.0"

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 John Kamenik
+
+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,62 @@
+# Djikstra
+
+[![Build Status](https://travis-ci.org/jkamenik/djikstra.svg?branch=master)](https://travis-ci.org/jkamenik/djikstra)
+
+Djikstra's algorithm is a graph-based technique for finding the globally shortest path between a starting node and a target node in a non-negative weighted Directed Acyclic Graph (DAG). It is a DAG in that edges are one way and there are no cycles in the graph; it is weighted in that each traversal of the graph has a certain cost. It is used often in graph-based applications such as social, network routing, and logistics supply modeling.
+In its simplest form, the algorithm performs in O(v2) where |v| is the number of vertices in the graph.
+
+Details of the algorithm may be found here:
+
+* [Wikipedia](http://en.wikipedia.org/wiki/Dijkstra%27s_algorithm)
+* [YouTube](http://www.youtube.com/watch?v=gdmfOwyQlcI)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'djikstra'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install djikstra
+
+## Usage
+
+Use the `djikstra` command and pass it a graph file, a starting node, and an ending node.
+
+    $ djikstra my_graph.txt A G
+		Shortest path is [A,B,E,G] with total cost 6
+
+### graph file
+
+A graph file is a txt file containing lines and weights.  A line consists of two nodes.
+
+		[A,B,1]
+		[B,C,3]
+		[C,D,1]
+		[D,F,3]
+		[E,G,3]
+		[F,G,1]
+		[A,C,2]
+		[B,D,3]
+		[B,E,2]
+		[D,E,3]
+
+This file must be a Direct Acyclic Graph (DAG):
+
+1. Lines are one way
+1. Lines are always weighted
+1. There are no cycles
+
+## Contributing
+
+1. Fork it ( http://github.com/jkamenik/djikstra/fork )
+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

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/djikstra

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+LIB_DIR = File.expand_path('../../lib',__FILE__)
+$LOAD_PATH.unshift LIB_DIR
+
+require 'djikstra'
+Djikstra::Cli.new(*ARGV).run

data/djikstra.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'djikstra/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "djikstra"
+  spec.version       = Djikstra::VERSION
+  spec.authors       = ["John Kamenik"]
+  spec.email         = ["jkamenik@gmail.com"]
+  spec.summary       = %Q{djikstra-#{Djikstra::VERSION}}
+  spec.description   = %q{Runs the Djikstra algorithm against a graph file.}
+  spec.homepage      = "http://github.com/jkamenik/djikstra"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/djikstra.rb

@@ -0,0 +1,10 @@
+require "djikstra/version"
+require 'djikstra/cli'
+require 'djikstra/graph'
+require 'djikstra/node'
+require 'djikstra/edge'
+
+module Djikstra
+  class ParseError < RuntimeError; end
+  class GraphError < RuntimeError; end
+end

data/lib/djikstra/cli.rb

@@ -0,0 +1,52 @@
+module Djikstra
+  class Cli
+    def initialize(*args)
+      @file  = args[0]
+      @start = args[1].to_s.upcase
+      @stop  = args[2].to_s.upcase
+    end
+    
+    def usage
+      puts "#{$0} <file> <start> <end>"
+      puts "  file  - a DAG graph file"
+      puts "  start - the name of starting node"
+      puts "  end   - the name of the ending node"
+      puts
+      puts " DAG graph file contains lines (between two nodes) and weights in the following format"
+      puts "     [A,B,1]"
+      puts "     [B,C,3]"
+      puts
+      puts "Example:"
+      puts " $ #{$0} graph.txt A C"
+      puts " Shortest path is [A,B,C] with total cost 4"
+      
+      exit 1
+    end
+    
+    def parse
+      edges = []
+      open(@file) do |f|
+        f.readlines.each_with_index do |line,idx|
+          items = line.split /\[(\w+),(\w+),(\d+)\]/
+          
+          # only care about the center matches
+          edges.push [items[1],items[2],items[3],idx+1]
+        end
+      end
+      edges
+    end
+    
+    def run
+      return usage unless @file && @start && @stop
+      
+      graph = Graph.new(parse)
+      path  = graph.shortest_path_between(@start,@stop)
+      dist  = graph.shortest_path_distance
+      
+      puts "Shortest path is [#{path.join(',')}] with a total cost of #{dist}"
+    rescue ParseError, GraphError => e
+      puts e.to_s
+      exit 1
+    end
+  end
+end

data/lib/djikstra/edge.rb

@@ -0,0 +1,21 @@
+module Djikstra
+  class Edge
+    attr_accessor :graph, :start, :stop, :weight
+    
+    def initialize(graph,start,stop,weight,line=0)
+      raise ParseError, "Invalid edge on line #{line}" unless start && stop && weight
+      
+      @graph  = graph
+      @start  = graph.find_node(start.to_s.upcase)
+      @stop   = graph.find_node(stop.to_s.upcase)
+      @weight = Integer(weight)
+      
+      @start.neighbor_of(@stop, @weight)
+      @stop.neighbor_of(@start, @weight)
+    rescue TypeError, ArgumentError
+      # Integer may raise this, so reraise as a ParseError
+      raise ParseError, "Invalid weight on line #{line}"
+    end
+  end
+end
+      

data/lib/djikstra/graph.rb

@@ -0,0 +1,88 @@
+module Djikstra
+  class Graph
+    attr_reader :nodes, :edges, :shortest_path_distance
+    
+    def initialize(edges=[])
+      @nodes = {}
+      @edges = []
+      
+      edges.each do |e|
+        args = e.unshift self
+        
+        @edges.push Edge.new(*args)
+      end
+    end
+    
+    def find_node(name,raise_if_note_found=false)
+      node = @nodes[name]
+      return node if node
+      
+      raise GraphError, %Q(Node "#{name}" not found!) if raise_if_note_found
+      
+      node = Node.new name
+      @nodes[name] = node
+      node
+    end
+
+    def shortest_path_between(start,stop)
+      universe = []
+      
+      @nodes.each do |key,node|
+        node.reset
+        
+        universe.push node
+      end
+      
+      start_node = find_node(start, true)
+      start_node.distance = 0
+      
+      while universe.size > 0
+        start_node.neighbors.each do |neighbor|
+          next unless universe.include? neighbor #skip visited nodes
+          
+          # untraversable branch
+          raise GraphError, %Q(Node "#{start_node.name}" is not reachable) if start_node.infinite?
+          
+          dist = start_node.distance + start_node.distance_to(neighbor)
+          
+          if neighbor > dist
+            neighbor.distance = dist
+            neighbor.previous_node = start_node # collect the shortest path back
+          end
+        end
+        
+        universe.delete start_node
+        
+        start_node = closest(universe)
+      end
+      
+      # walk backwards
+      start_node = find_node(start, true)
+      stop_node  = find_node(stop, true)
+      collect_shortest_path_between(start_node,stop_node)
+    end
+    
+    def collect_shortest_path_between(start_node,end_node)
+      # artifact, the distance is the end_node distance
+      @shortest_path_distance = end_node.distance
+
+      # walk from the end node down the previous_node list
+      node = end_node
+      path = [node.name]
+      while node && node != start_node
+        node = node.previous_node
+        path.insert 0, node.name
+      end
+      path
+    end
+    
+    def closest(universe)
+      u = universe.first
+      
+      universe.each do |node|
+        u = node if u > node.distance
+      end
+      u
+    end
+  end
+end

data/lib/djikstra/node.rb

@@ -0,0 +1,42 @@
+module Djikstra
+  class Node
+    attr_accessor :name, :distance, :neighbors, :previous_node
+    
+    def initialize(name)
+      @name      = name
+      @neighbors = []
+      @weights   = {}
+      reset
+    end
+    
+    def reset
+      @distance      = :infinity
+      @previous_node = nil
+    end
+    
+    def neighbor_of(node, weight)
+      @neighbors.push node
+      @weights[node.name] = weight
+    end
+    
+    def distance_to(node)
+      @weights[node.name]
+    end
+    
+    def infinite?
+      @distance == :infinity
+    end
+    
+    def >(number)
+      return true if infinite?
+      return false if number == :infinity
+      
+      distance > number
+    end
+    
+    def inspect
+      %Q(#<Djikstra::Node name="#{name}" distance=#{distance}>)
+    end
+    alias_method :to_s, :inspect
+  end
+end

data/lib/djikstra/version.rb

@@ -0,0 +1,3 @@
+module Djikstra
+  VERSION = "0.0.1"
+end

data/spec/bin/djikstra_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+class Output
+  attr_reader :output, :exitcode
+  
+  def initialize(output,exitcode)
+    @output = output
+    @exitcode = exitcode
+  end
+  
+  def to_s
+    @output
+  end
+  
+  def to_i
+    @exitcode
+  end
+end
+
+
+describe 'CLI' do
+  def djikstra(*args)
+    command = File.expand_path("../../../bin/djikstra",__FILE__)
+    args[0] = File.expand_path("../../files/#{args[0]}",__FILE__) if args[0]
+    output  = `ruby #{command} #{args.join ' '}`
+    
+    Output.new output.chop, $?.exitstatus
+  end
+  
+  it 'requires three arguments' do
+    expect(djikstra.exitcode).to eq 1
+  end
+  
+  it 'states the shortest path' do
+    expect(djikstra('example.txt','A','G').output).to eq 'Shortest path is [A,B,E,G] with a total cost of 6'
+  end
+  
+  it 'works for the simple case' do
+    expect(djikstra('simple.txt','A','B').output).to eq 'Shortest path is [A,B] with a total cost of 1'
+  end
+  
+  it 'works for a linear case' do
+    expect(djikstra('linear.txt','A','C').output).to eq 'Shortest path is [A,B,C] with a total cost of 2'
+  end
+  
+  it 'shows an error if the end node doesn\'t exist' do
+    # "E" doesn't exist as a node.
+    expect(djikstra('linear.txt','A','E').output).to eq 'Node "E" not found!'
+  end
+  
+  it 'shows an error if the end node doesn\'t exist' do
+    # "E" doesn't exist as a node.
+    expect(djikstra('linear.txt','E','C').output).to eq 'Node "E" not found!'
+  end
+end

data/spec/djikstra/cli_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Djikstra::Cli do
+  def spec_file(file)
+    File.expand_path("../../files/#{file}",__FILE__)
+  end
+  
+  it 'prints usage if args is less then 3' do
+    cli = Djikstra::Cli.new()
+    
+    expect(cli).to receive :usage
+    
+    cli.run
+  end
+  
+  context 'parse' do
+    it 'returns an array of weighted edges' do
+      items = Djikstra::Cli.new(spec_file('simple.txt'),'A','B').parse
+      
+      expect(items).to be_an Array
+      expect(items[0]).to eq ['A','B','1',1]
+    end
+  end
+end

data/spec/djikstra/edge_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe Djikstra::Edge do
+  let(:graph) { Djikstra::Graph.new }
+  
+  it 'errors if start is not provided' do
+    expect {
+      Djikstra::Edge.new(graph,nil,'B',1)
+    }.to raise_error Djikstra::ParseError
+  end
+  
+  it 'errors if stop is not provided' do
+    expect {
+      Djikstra::Edge.new(graph,'A',nil,1)
+    }.to raise_error Djikstra::ParseError
+  end
+  
+  it 'errors if weight is not provided' do
+    expect {
+      Djikstra::Edge.new(graph,'A','B',nil)
+    }.to raise_error Djikstra::ParseError
+  end
+  
+  it 'errors if weight is not an integer' do
+    expect {
+      Djikstra::Edge.new(graph,'A','B','G')
+    }.to raise_error Djikstra::ParseError
+  end
+  
+  context 'start' do
+    it 'is a Node' do
+      edge = Djikstra::Edge.new(graph,'A','B',1)
+      expect(edge.start).to be_a Djikstra::Node
+    end
+    
+    it 'has stop as a neighbor' do
+      edge = Djikstra::Edge.new(graph,'A','B',1)
+      
+      expect(edge.start.neighbors).to include edge.stop
+    end
+  end
+  
+  context 'stop' do
+    it 'is a Node' do
+      edge = Djikstra::Edge.new(graph,'A','B',1)
+      expect(edge.stop).to be_a Djikstra::Node
+    end
+    
+    it 'has start as a neighbor' do
+      edge = Djikstra::Edge.new(graph,'A','B',1)
+      
+      expect(edge.stop.neighbors).to include edge.start
+    end
+  end
+end

data/spec/djikstra/graph_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Djikstra::Graph do
+  context '.new' do
+    it 'takes edge tupples and creates edges' do
+      graph = Djikstra::Graph.new [['A','B','1',1]]
+      
+      expect(graph.edges).to be_an Array
+      expect(graph.edges[0]).to be_a Djikstra::Edge
+    end
+  end
+  
+  context '.find_node' do
+    it 'returns the found node' do
+      graph = Djikstra::Graph.new
+      node1  = graph.find_node('strange')
+      node2  = graph.find_node('strange')
+      
+      expect(node1.object_id).to eq node2.object_id
+    end
+    
+    it 'creates a new node if one does not exist' do
+      graph = Djikstra::Graph.new
+      node  = graph.find_node('strange')
+      
+      expect(node).to be_a Djikstra::Node
+      expect(node.name).to eq 'strange'
+    end
+  end
+  
+  context '.shortest_path_between' do
+    it 'returns that path' do
+      graph = Djikstra::Graph.new [['A','B','1',1]]
+      
+      expect(graph.shortest_path_between('A','B')).to eq ['A','B']
+    end
+  end
+end

data/spec/djikstra/node_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Djikstra::Node do
+  let(:node) { Djikstra::Node.new 'A' }
+  
+  context '.reset' do
+    it 'resets distance to infinity' do
+      node.distance = 1
+      
+      node.reset
+      expect(node.distance).to eq :infinity
+    end
+    
+    it 'removes any previous nodes' do
+      node.previous_node = node
+      
+      node.reset
+      expect(node.reset).to eq nil
+    end
+  end
+  
+  context ">" do
+    it 'returns true if my distance is infinity' do
+      node.distance = :infinity
+      
+      expect(node > 1_000_000_000_000).to be_true
+    end
+    
+    it 'returns false if the number is infinity' do
+      node.distance = 1_000_000_000_000
+      
+      expect(node > :infinity).to be_false
+    end
+    
+    it 'compares distance to number' do
+      node.distance = 1
+      
+      expect(node > 2).to be_false
+    end
+  end
+end

data/spec/files/bad.txt

@@ -0,0 +1,2 @@
+[A,B,1]
+[C,D,1]

data/spec/files/example.txt

@@ -0,0 +1,10 @@
+[A,B,1]
+[B,C,3]
+[C,D,1]
+[D,F,3]
+[E,G,3]
+[F,G,1]
+[A,C,2]
+[B,D,3]
+[B,E,2]
+[D,E,3]

data/spec/files/invalid.txt

@@ -0,0 +1,3 @@
+[A,B,1]
+[B,D,4]
+not right

data/spec/files/linear.txt

@@ -0,0 +1,2 @@
+[A,B,1]
+[B,C,1]

data/spec/files/simple.txt

@@ -0,0 +1 @@
+[A,B,1]

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'djikstra'
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: djikstra
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John Kamenik
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: Runs the Djikstra algorithm against a graph file.
+email:
+- jkamenik@gmail.com
+executables:
+- djikstra
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/djikstra
+- djikstra.gemspec
+- lib/djikstra.rb
+- lib/djikstra/cli.rb
+- lib/djikstra/edge.rb
+- lib/djikstra/graph.rb
+- lib/djikstra/node.rb
+- lib/djikstra/version.rb
+- spec/bin/djikstra_spec.rb
+- spec/djikstra/cli_spec.rb
+- spec/djikstra/edge_spec.rb
+- spec/djikstra/graph_spec.rb
+- spec/djikstra/node_spec.rb
+- spec/files/bad.txt
+- spec/files/example.txt
+- spec/files/invalid.txt
+- spec/files/linear.txt
+- spec/files/simple.txt
+- spec/spec_helper.rb
+homepage: http://github.com/jkamenik/djikstra
+licenses:
+- MIT
+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: djikstra-0.0.1
+test_files:
+- spec/bin/djikstra_spec.rb
+- spec/djikstra/cli_spec.rb
+- spec/djikstra/edge_spec.rb
+- spec/djikstra/graph_spec.rb
+- spec/djikstra/node_spec.rb
+- spec/files/bad.txt
+- spec/files/example.txt
+- spec/files/invalid.txt
+- spec/files/linear.txt
+- spec/files/simple.txt
+- spec/spec_helper.rb