dag 0.0.1

data/.rspec

@@ -0,0 +1,3 @@
+--color
+-Ilib
+

data/Gemfile

@@ -0,0 +1,9 @@
+source :rubygems
+gemspec
+
+group :test do
+  gem 'rspec', '~> 2.12'
+  gem 'rake', '~> 10.0.1'
+  gem 'simplecov', :require => false
+end
+

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    dag (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.2.2)
+    multi_json (1.7.2)
+    rake (10.0.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  dag!
+  rake (~> 10.0.1)
+  rspec (~> 2.12)
+  simplecov

data/README.md

@@ -0,0 +1,72 @@
+# DAG
+
+Very simple directed acyclic graphs for Ruby.
+
+## Installation
+
+Install the gem
+
+```
+gem install dag
+```
+
+Or add it to your Gemfile and run `bundle`.
+
+``` ruby
+gem 'dag'
+```
+
+## Usage
+
+```ruby
+dag = DAG.new
+
+v1 = dag.add_vertex
+v2 = dag.add_vertex
+v3 = dag.add_vertex
+
+dag.add_edge from: v1, to: v2
+dag.add_edge from: v2, to: v3
+
+v1.has_path_to?(v3)                  # => true
+v3.has_path_to?(v1)                  # => false
+
+dag.add_edge from: v3, to: v1        # => ArgumentError: A DAG must not have cycles
+
+dag.add_edge from: v1, to: v2
+dag.add_edge from: v1, to: v3
+v1.successors                        # => [v2, v3]
+```
+
+See the specs for more detailed usage scenarios.
+
+## Compatibility
+
+Tested with Ruby 1.9.x, JRuby, Rubinius.
+See the [build status](https://travis-ci.org/kevinrutherford/dag)
+for details.
+
+## License
+
+(The MIT License)
+
+Copyright (c) 2013 Kevin Rutherford
+
+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/Rakefile

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

data/lib/dag/vertex.rb

@@ -0,0 +1,34 @@
+class DAG
+
+  class Vertex
+    attr_reader :dag
+
+    def initialize(dag)
+      @dag = dag
+    end
+
+    def outgoing_edges
+      @dag.edges.select {|e| e.origin == self}
+    end
+
+    def incoming_edges
+      @dag.edges.select {|e| e.destination == self}
+    end
+
+    def predecessors
+      incoming_edges.map(&:origin).uniq
+    end
+
+    def successors
+      outgoing_edges.map(&:destination).uniq
+    end
+
+    def has_path_to?(other)
+      raise ArgumentError.new('You must supply a vertex in this DAG') unless
+        other && Vertex === other && other.dag == self.dag
+      successors.include?(other) || successors.any? {|v| v.has_path_to?(other) }
+    end
+  end
+
+end
+

data/lib/dag.rb

@@ -0,0 +1,31 @@
+require_relative 'dag/vertex'
+
+class DAG
+
+  Edge = Struct.new(:origin, :destination)
+
+  attr_reader :vertices, :edges
+
+  def initialize
+    @vertices = []
+    @edges = []
+  end
+
+  def add_vertex
+    Vertex.new(self).tap {|v| @vertices << v }
+  end
+
+  def add_edge(attrs)
+    origin = attrs[:origin] || attrs[:source] || attrs[:from] || attrs[:start]
+    destination = attrs[:destination] || attrs[:sink] || attrs[:to] || attrs[:end]
+    raise ArgumentError.new('Origin must be a vertex in this DAG') unless
+      origin && Vertex === origin && origin.dag == self
+    raise ArgumentError.new('Destination must be a vertex in this DAG') unless
+     destination && Vertex === destination && destination.dag == self
+    raise ArgumentError.new('A DAG must not have cycles') if origin == destination
+    raise ArgumentError.new('A DAG must not have cycles') if destination.has_path_to?(origin)
+    Edge.new(origin, destination).tap {|e| @edges << e }
+  end
+
+end
+

data/spec/lib/dag/vertex_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+describe DAG::Vertex do
+  let(:dag) { DAG.new }
+  subject { dag.add_vertex }
+  let(:v1) { dag.add_vertex }
+  let(:v2) { dag.add_vertex }
+
+  describe 'an instance' do
+    it 'cannot have a path to a non-vertex' do
+      expect { subject.has_path_to?(23) }.to raise_error(ArgumentError)
+    end
+
+    it 'cannot have a path to a vertex in a different DAG' do
+      expect { subject.has_path_to?(DAG.new.add_vertex) }.to raise_error(ArgumentError)
+    end
+  end
+
+  context 'with predecessors' do
+    before do
+      dag.add_edge from: v1, to: subject
+      dag.add_edge from: v2, to: subject
+    end
+
+    its(:predecessors) { should =~ [v1, v2] }
+    its(:successors) { should == [] }
+
+    it 'has no paths to its predecessors' do
+      subject.has_path_to?(v1).should be_false
+      subject.has_path_to?(v2).should be_false
+    end
+
+    context 'with multiple paths' do
+      it 'lists each predecessor only once' do
+        dag.add_edge from: v1, to: subject
+        subject.predecessors.should == [v1, v2]
+      end
+    end
+  end
+
+  context 'with successors' do
+    before do
+      dag.add_edge from: subject, to: v1
+      dag.add_edge from: subject, to: v2
+    end
+
+    its(:predecessors) { should == [] }
+    its(:successors) { should =~ [v1, v2] }
+
+    it 'has paths to its successors' do
+      subject.has_path_to?(v1).should be_true
+      subject.has_path_to?(v2).should be_true
+    end
+
+    context 'with multiple paths' do
+      it 'lists each successor only once' do
+        dag.add_edge from: subject, to: v1
+        subject.successors.should == [v1, v2]
+      end
+    end
+  end
+
+  context 'in a deep DAG' do
+    let(:v3) { dag.add_vertex }
+
+    before do
+      dag.add_edge from: subject, to: v1
+      dag.add_edge from: v1, to: v2
+    end
+
+    it 'has a deep path to v2' do
+      subject.has_path_to?(v2).should be_true
+    end
+
+    it 'has no path to v3' do
+      subject.has_path_to?(v3).should be_false
+    end
+  end
+
+end
+

data/spec/lib/dag_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+
+describe DAG do
+
+  context 'when new' do
+    it 'starts with no vertices' do
+      subject.vertices.should be_empty
+    end
+  end
+
+  context 'with one vertex' do
+    it 'has only that vertex' do
+      v = subject.add_vertex
+      subject.vertices.should == [v]
+    end
+
+    it 'has no edges' do
+      v = subject.add_vertex
+      v.outgoing_edges.should be_empty
+      v.incoming_edges.should be_empty
+    end
+  end
+
+  context 'creating an edge' do
+    let(:v1) { subject.add_vertex }
+
+    context 'when valid' do
+      let(:v2) { subject.add_vertex }
+      let!(:e1) { subject.add_edge(origin: v1, destination: v2) }
+
+      it 'leaves the origin vertex' do
+        v1.outgoing_edges.should == [e1]
+      end
+
+      it 'arrives at the destination vertex' do
+        v2.incoming_edges.should == [e1]
+      end
+
+      it 'adds no other edges' do
+        v1.incoming_edges.should be_empty
+        v2.outgoing_edges.should be_empty
+      end
+
+      it 'allows multiple edges between a pair of vertices' do
+        expect { subject.add_edge(origin: v1, destination: v2) }.to_not raise_error
+      end
+    end
+
+    context 'when invalid' do
+      it 'requires an origin vertex' do
+        expect { subject.add_edge(to: v1) }.to raise_error(ArgumentError)
+      end
+
+      it 'requires a destination vertex' do
+        expect { subject.add_edge(from: v1) }.to raise_error(ArgumentError)
+      end
+
+      it 'requires the endpoints to be vertices' do
+        expect { subject.add_edge(from: v1, to: 23) }.to raise_error(ArgumentError)
+        expect { subject.add_edge(from: 45, to: v1) }.to raise_error(ArgumentError)
+      end
+
+      it 'requires the endpoints to be in the same DAG' do
+        v2 = DAG.new.add_vertex
+        expect { subject.add_edge(from: v1, to: v2) }.to raise_error(ArgumentError)
+        expect { subject.add_edge(from: v2, to: v1) }.to raise_error(ArgumentError)
+      end
+
+      it 'rejects an edge that would create a loop' do
+        v2 = subject.add_vertex
+        v3 = subject.add_vertex
+        v4 = subject.add_vertex
+        subject.add_edge from: v1, to: v2
+        subject.add_edge from: v2, to: v3
+        subject.add_edge from: v3, to: v4
+        expect { subject.add_edge from: v4, to: v1 }.to raise_error(ArgumentError)
+      end
+
+      it 'rejects an edge from a vertex to itself' do
+        expect { subject.add_edge from: v1, to: v1 }.to raise_error(ArgumentError)
+      end
+    end
+
+    context 'with different keywords' do
+      let(:v1) { subject.add_vertex }
+      let(:v2) { subject.add_vertex }
+      let!(:e1) { subject.add_edge(origin: v1, destination: v2) }
+
+      it 'allows :source and :sink' do
+        subject.add_edge(source: v1, sink: v2).should == e1
+      end
+
+      it 'allows :from and :to' do
+        subject.add_edge(from: v1, to: v2).should == e1
+      end
+
+      it 'allows :start and :end' do
+        subject.add_edge(start: v1, end: v2).should == e1
+      end
+
+    end
+
+  end
+
+  context 'vertex attributes'
+
+  context 'edge attributes'
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'simplecov'
+
+SimpleCov.start
+
+require 'dag'
+
+

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: dag
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kevin Rutherford
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Directed acyclic graphs
+email: kevin@rutherford-software.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .rspec
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/dag.rb
+- lib/dag/vertex.rb
+- spec/lib/dag/vertex_spec.rb
+- spec/lib/dag_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/kevinrutherford/dag
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Directed acyclic graphs
+test_files:
+- spec/lib/dag/vertex_spec.rb
+- spec/lib/dag_spec.rb
+- spec/spec_helper.rb