dag 0.0.1 → 0.0.2

data/.yardopts

@@ -0,0 +1 @@
+--no-private

data/README.md

@@ -2,6 +2,10 @@
 
 Very simple directed acyclic graphs for Ruby.
 
+[![Build Status](https://travis-ci.org/kevinrutherford/dag.png)](https://travis-ci.org/kevinrutherford/dag)
+[![Code
+Climate](https://codeclimate.com/github/kevinrutherford/dag.png)](https://codeclimate.com/github/kevinrutherford/dag)
+
 ## Installation
 
 Install the gem

data/lib/dag/vertex.rb

@@ -1,12 +1,15 @@
 class DAG
 
   class Vertex
-    attr_reader :dag
+    attr_reader :dag, :payload
 
-    def initialize(dag)
+    def initialize(dag, payload)
       @dag = dag
+      @payload = payload
     end
 
+    private :initialize
+
     def outgoing_edges
       @dag.edges.select {|e| e.origin == self}
     end
@@ -23,11 +26,34 @@ class DAG
       outgoing_edges.map(&:destination).uniq
     end
 
+    def inspect
+      "DAG::Vertex:#{@payload.inspect}"
+    end
+
+    #
+    # Is there a path from here to +other+ following edges in the DAG?
+    #
+    # @param [DAG::Vertex] another Vertex is the same DAG
+    # @raise [ArgumentError] if +other+ is not a Vertex in the same DAG
+    # @return true iff there is a path following edges within this DAG
+    #
     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
+
+    #
+    # Retrieve a value from the vertex's payload.
+    # This is a shortcut for vertex.payload[key].
+    #
+    # @param key [Object] the payload key
+    # @return the corresponding value from the payload Hash, or nil if not found
+    #
+    def [](key)
+      @payload[key]
+    end
+
   end
 
 end

data/lib/dag.rb

@@ -11,8 +11,8 @@ class DAG
     @edges = []
   end
 
-  def add_vertex
-    Vertex.new(self).tap {|v| @vertices << v }
+  def add_vertex(payload = {})
+    Vertex.new(self, payload).tap {|v| @vertices << v }
   end
 
   def add_edge(attrs)

data/spec/lib/dag/vertex_spec.rb

@@ -3,8 +3,8 @@ 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 }
+  let(:v1) { dag.add_vertex(name: :v1) }
+  let(:v2) { dag.add_vertex(name: :v2) }
 
   describe 'an instance' do
     it 'cannot have a path to a non-vertex' do
@@ -16,6 +16,25 @@ describe DAG::Vertex do
     end
   end
 
+  describe 'with a payload' do
+    subject { dag.add_vertex(name: 'Fred', size: 34) }
+
+    it 'allows the payload to be accessed' do
+      subject[:name].should == 'Fred'
+      subject[:size].should == 34
+      subject.payload.should == {name: 'Fred', size: 34}
+    end
+
+    it 'returns nil for missing payload key' do
+      subject[56].should be_nil
+    end
+
+    it 'allows the payload to be changed' do
+      subject.payload[:another] = 'ha'
+      subject[:another].should == 'ha'
+    end
+  end
+
   context 'with predecessors' do
     before do
       dag.add_edge from: v1, to: subject

data/spec/lib/dag_spec.rb

@@ -102,9 +102,5 @@ describe DAG do
 
   end
 
-  context 'vertex attributes'
-
-  context 'edge attributes'
-
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dag
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-05 00:00:00.000000000 Z
+date: 2013-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -66,6 +66,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .rspec
+- .yardopts
 - Gemfile
 - Gemfile.lock
 - README.md