directed_graph 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 19be1d44522c23cea508cee9c7355fddbf94f2b7
+  data.tar.gz: 3113b3809f3bc9871456410a5a698403739ec631
+SHA512:
+  metadata.gz: cf44cda6bb1e05a6e40adf34ca14b58c2ca49f5d935b28ab10b8451365b1ca354c74e8c6b1d57f5aa2ea61ca8eddd6e8858c52e768707e19d305a3a7ad046fe3
+  data.tar.gz: 0a7178c9650e3d2908cb3b2185248c9cbbfbad2e0c88f75d695e8ed7111305aa6a8909e9f8fb3b4a745c6d11f31c8543bef187b83793a6da2be12c014e8fbe17

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 MrPowers
+
+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,52 @@
+# directed_graph
+
+The directed_graph gem is useful for modeling directed, acyclic, unweighted graphs.  It provides methods to topologically sort graphs, find the shortest path between two vertices, and render the graphs and json for client-side graphing.
+
+The following graph will be used to demonstrate the functionality of the directed_graph gem.
+
+![graph_example](https://github.com/MrPowers/directed_graph/blob/master/example/simple_directed_graph.png)
+
+The `Graph` class should be instantiated with an array of edges:
+
+```ruby
+# The first argument is the origin_vertex
+# and the second is the destination_vertex
+@ra = Edge.new("root", "a")
+@ab = Edge.new("a", "b")
+@bc = Edge.new("b", "c")
+@bd = Edge.new("b", "d")
+@ae = Edge.new("a", "e")
+@de = Edge.new("d", "e")
+@edges = [@ra, @ab, @bc, @bd, @ae, @de]
+@graph = Graph.new(@edges)
+```
+
+The `@graph` object can be used to get a topological sorted array of the vertices:
+
+```ruby
+@graph.sorted_vertices # ["root", "a", "b", "d", "e", "c"]
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'directed_graph'
+```
+
+Require the gem in your code:
+
+```ruby
+require 'directed_graph'
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/MrPowers/directed_graph.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "directed_graph"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/directed_graph.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'directed_graph/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "directed_graph"
+  spec.version       = DirectedGraph::VERSION
+  spec.authors       = ["MrPowers"]
+  spec.email         = ["matthewkevinpowers@gmail.com"]
+
+  spec.summary       = %q{Modeling directed acyclic graphs}
+  spec.description   = %q{Topological sorting, shortest path, and json exports for directed acyclic graphs}
+  spec.homepage      = "https://github.com/MrPowers/directed_graph"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+
+  spec.add_dependency 'pry'
+end

data/lib/directed_graph/edge.rb

@@ -0,0 +1,17 @@
+module DirectedGraph
+
+  class Edge
+
+    attr_reader :origin_vertex, :destination_vertex, :value
+
+    def initialize(origin_vertex, destination_vertex, value = nil)
+      @origin_vertex = origin_vertex
+      @destination_vertex = destination_vertex
+      @value = value
+    end
+
+  end
+
+
+end
+

data/lib/directed_graph/graph.rb

@@ -0,0 +1,40 @@
+module DirectedGraph
+
+  class Graph
+
+    attr_reader :edges
+
+    def initialize(edges)
+      @edges = edges
+    end
+
+    def vertices
+      r = []
+      edges.each {|e| r.push(e.origin_vertex, e.destination_vertex)}
+      r.uniq
+    end
+
+    def ordered_edges
+      sorted_vertices.inject([]) do |memo, v|
+        edge = edges.select {|e| e.destination_vertex == v}
+        memo.push(*edge) if edge
+        memo
+      end
+    end
+
+    def sorted_vertices
+      JobRunner.sorted_vertices(vertices_and_children)
+    end
+
+    def children(vertex)
+      edges.select {|e| e.origin_vertex == vertex}.map{|e| e.destination_vertex}
+    end
+
+    def vertices_and_children
+      vertices.map {|v| [v, children(v)]}
+    end
+
+  end
+
+end
+

data/lib/directed_graph/job_runner.rb

@@ -0,0 +1,30 @@
+require 'tsort'
+
+module DirectedGraph; class JobRunner
+
+  def self.sorted_vertices(vertices_and_children)
+    runner = JobRunner.new
+    vertices_and_children.each { |v, c| runner.add(v, c) }
+    runner.tsort.reverse
+  end
+
+  include TSort
+
+  def initialize
+    @jobs = Hash.new{|h,k| h[k] = []}
+  end
+
+  def add(name, dependencies=[])
+    @jobs[name] = dependencies
+  end
+
+  def tsort_each_node(&block)
+    @jobs.each_key(&block)
+  end
+
+  def tsort_each_child(node, &block)
+    @jobs[node].each(&block) if @jobs.has_key?(node)
+  end
+
+end; end
+

data/lib/directed_graph/version.rb

@@ -0,0 +1,3 @@
+module DirectedGraph
+  VERSION = "0.1.0"
+end

data/lib/directed_graph.rb

@@ -0,0 +1,7 @@
+require "directed_graph/version"
+require_relative "./directed_graph/job_runner.rb"
+require_relative "./directed_graph/edge.rb"
+require_relative "./directed_graph/graph.rb"
+
+module DirectedGraph
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: directed_graph
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- MrPowers
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Topological sorting, shortest path, and json exports for directed acyclic
+  graphs
+email:
+- matthewkevinpowers@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- directed_graph.gemspec
+- example/simple_directed_graph.png
+- lib/directed_graph.rb
+- lib/directed_graph/edge.rb
+- lib/directed_graph/graph.rb
+- lib/directed_graph/job_runner.rb
+- lib/directed_graph/version.rb
+homepage: https://github.com/MrPowers/directed_graph
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Modeling directed acyclic graphs
+test_files: []