ellington 0.0.3 → 0.0.4

data/Gemfile

@@ -1,7 +1,8 @@
 source 'https://rubygems.org'
 
 gem "hero", "~> 0.1.7"
-gem "state_jacket", "~> 0.0.7"
+gem "state_jacket", "~> 0.0.9"
+gem "ruby-graphviz", "~> 1.0.8", :require => "graphviz"
 
 group :development, :test do
   gem "yell"

data/Gemfile.lock

@@ -21,8 +21,9 @@ GEM
     pry-stack_explorer (0.4.8)
       binding_of_caller (~> 0.6.8)
       pry (~> 0.9.11)
+    ruby-graphviz (1.0.8)
     slop (3.4.3)
-    state_jacket (0.0.7)
+    state_jacket (0.0.9)
     yell (1.2.3)
 
 PLATFORMS
@@ -36,5 +37,6 @@ DEPENDENCIES
   pry
   pry-exception_explorer
   pry-stack_explorer
-  state_jacket (~> 0.0.7)
+  ruby-graphviz (~> 1.0.8)
+  state_jacket (~> 0.0.9)
   yell

data/lib/ellington/has_targets.rb

@@ -17,11 +17,21 @@ module Ellington
     end
     alias_method :errored, :error_target
 
+    def state_names(states)
+      names = []
+      names << "PASS" if (states & passed).length == passed.length
+      names << "FAIL" if (states & failed).length == failed.length
+      names << "ERROR" if (states & errored).length == errored.length
+      names
+    end
+
     def state(passenger)
       case
       when passed.satisfied?(passenger) then "PASS"
       when failed.satisfied?(passenger) then "FAIL"
       when errored.satisfied?(passenger) then "ERROR"
+      else
+        nil
       end
     end
 

data/lib/ellington/line.rb

@@ -68,7 +68,10 @@ module Ellington
       @states ||= begin
         catalog = StateJacket::Catalog.new
         stations.each_with_index do |station, index|
-          catalog.merge! station.states
+          station.states.each do |state, transitions|
+            catalog[state] = transitions.nil? ? nil : transitions.dup
+          end
+
           if index < stations.length - 1
             next_station = stations[index + 1]
             catalog[station.passed] = next_station.states.keys

data/lib/ellington/line_info.rb

@@ -26,9 +26,12 @@ module Ellington
         message << "[#{station.state(passenger)}]"
         message << "[#{station_full_name}]"
       end
-      line.route.log_passenger_attrs.each do |attr|
+      line.route.log_options[:passenger].each do |attr|
         message << "[#{attr}:#{passenger.send(attr)}]"
       end
+      line.route.log_options[:options].each do |attr|
+        message << "[#{attr}:#{self.options[attr]}]"
+      end
       message.join " "
     end
   end

data/lib/ellington/route.rb

@@ -1,4 +1,5 @@
 require "delegate"
+require "fileutils"
 
 module Ellington
   class Route < SimpleDelegator
@@ -35,6 +36,17 @@ module Ellington
       include HasTargets
       attr_reader :initialized
 
+      def inherited(subclass)
+        (@subclasses ||= []) << subclass
+      end
+
+      def generate_graphs(dir)
+        FileUtils.mkdir_p(dir)
+        @subclasses.each do |subclass|
+          Ellington::Visualizer.new(subclass.new, dir).graph
+        end
+      end
+
       def initialized?
         @initialized
       end
@@ -53,7 +65,9 @@ module Ellington
           catalog.add initial_state => lines.first.stations.first.states.keys
 
           lines.each do |line|
-            catalog.merge! line.states
+            line.states.each do |state, transitions|
+              catalog[state] = transitions.nil? ? nil : transitions.dup
+            end
           end
 
           connections.each do |connection|
@@ -88,8 +102,12 @@ module Ellington
         connections << Ellington::Connection.new(line, type, states)
       end
 
-      def log_passenger_attrs(*attrs)
-        @log_passenger_attrs ||= attrs
+      def log_options(options={})
+        @log_options ||= begin
+          options[:passenger] ||= []
+          options[:options] ||= []
+          options
+        end
       end
 
       def line_completed(line_info)

data/lib/ellington/route_info.rb

@@ -15,9 +15,12 @@ module Ellington
       message << "[ROUTE COMPLETED]"
       message << "[#{route.state(passenger)}]"
       message << "[#{route.name}]"
-      line.route.log_passenger_attrs.each do |attr|
+      route.log_options[:passenger].each do |attr|
         message << "[#{attr}:#{passenger.send(attr)}]"
       end
+      route.log_options[:options].each do |attr|
+        message << "[#{attr}:#{self.options[attr]}]"
+      end
       message.join " "
     end
   end

data/lib/ellington/version.rb

@@ -1,3 +1,3 @@
 module Ellington
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/ellington/visualizer.rb

@@ -0,0 +1,254 @@
+require "delegate"
+
+# options: http://www.graphviz.org/doc/info/attrs.html
+# colors: http://www.graphviz.org/doc/info/colors.html
+module Ellington
+  class Visualizer
+
+    class Node < SimpleDelegator
+      attr_reader :base, :viz, :children
+
+      def initialize(base, viz)
+        @base = base
+        @viz = viz
+        @children = []
+        super children
+      end
+
+      def name
+        viz.id
+      end
+
+      def find(context)
+        if context.is_a?(String)
+          to_a.select{ |node| node.name == context }.first
+        else
+          to_a.select{ |node| node.base == context }.first
+        end
+      end
+    end
+
+    attr_reader :route, :dir
+
+    def initialize(route, dir)
+      @route = route
+      @dir = dir
+    end
+
+    def graph
+      graph_route_basic
+      graph_route
+      graph_lines_basic
+      graph_lines
+    end
+
+    def graph_lines_basic
+      g = Node.new(nil, GraphViz.new("G"))
+      g.viz["label"] = "#{route.name} Lines - basic"
+      g.viz["ranksep"] = 0.4
+      g.viz["fontname"] = "Helvetica"
+      g.viz.node["fontname"] = "Helvetica"
+      g.viz.node["shape"] = "box"
+      g.viz.node["style"] = "rounded"
+
+      route.lines.each_with_index do |line, index|
+        line_cluster = Node.new(line, g.viz.add_graph("cluster#{index}"))
+        line_cluster.viz["label"] = line.class.name
+        line_cluster.viz["style"] = "filled"
+        g << line_cluster
+
+        line.stations.each do |station|
+          station_node = Node.new(station, line_cluster.viz.add_nodes(station.class.name))
+          station_node.viz["style"] = "filled,rounded"
+          station_node.viz["color"] = "white"
+          line_cluster << station_node
+        end
+
+        line_cluster.each_with_index.each do |node, node_index|
+          next_node = line_cluster[node_index + 1]
+          line_cluster.viz.add_edges node.viz, next_node.viz if next_node
+        end
+      end
+
+      file_name = "#{route.name.downcase.gsub("::", "_")}-lines-basic.pdf"
+      g.viz.output(:pdf => File.join(dir, file_name))
+    end
+
+    def graph_lines
+      g = Node.new(nil, GraphViz.new("G"))
+      g.viz["label"] = "#{route.name} Lines"
+      g.viz["ranksep"] = 0.4
+      g.viz["fontname"] = "Helvetica"
+      g.viz.node["fontname"] = "Helvetica"
+      g.viz.node["shape"] = "box"
+      g.viz.node["style"] = "rounded"
+
+      route.lines.each_with_index do |line, index|
+        line_cluster = Node.new(line, g.viz.add_graph("cluster#{index}"))
+        line_cluster.viz["label"] = line.class.name
+        line_cluster.viz["style"] = "filled"
+        g << line_cluster
+
+        line.states.keys.each do |state|
+          state_node = Node.new(state, line_cluster.viz.add_nodes(state))
+          state_node.viz["style"] = "filled,rounded"
+          state_node.viz["color"] = "white"
+          if line.goal.include?(state)
+            state_node.viz["color"] = "green2"
+          end
+          if route.goal.include?(state)
+            state_node.viz["color"] = "gold"
+          end
+          line_cluster << state_node
+        end
+
+        line.states.each do |state, transitions|
+          a = line_cluster.find(state)
+          (transitions || []).each do |transition|
+            b = line_cluster.find(transition)
+            line_cluster.viz.add_edges a.viz, b.viz
+          end
+        end
+      end
+
+      file_name = "#{route.name.downcase.gsub("::", "_")}-lines.pdf"
+      g.viz.output(:pdf => File.join(dir, file_name))
+    end
+
+    def graph_route_basic
+      g = Node.new(nil, GraphViz.new("G"))
+      g.viz["label"] = "#{route.name} Route - basic"
+      g.viz["compound"] = true
+      g.viz["ranksep"] = 1.2
+      g.viz["fontname"] = "Helvetica"
+      g.viz.node["fontname"] = "Helvetica"
+      g.viz.node["shape"] = "box"
+      g.viz.node["style"] = "rounded"
+
+      route.lines.each_with_index do |line, index|
+        line_cluster = Node.new(line, g.viz.add_graph("cluster#{index}"))
+        line_cluster.viz["label"] = line.class.name
+        line_cluster.viz["style"] = "filled"
+        g << line_cluster
+
+        %w{PASS FAIL ERROR}.each do |state|
+          state_node = Node.new(state, line_cluster.viz.add_nodes("#{line.class.name}#{state}", "label" => state))
+          state_node.viz["style"] = "filled,rounded"
+          state_node.viz["color"] = "white"
+          if !(route.goal & line.stations.map{ |s| "#{state} #{s.name}" }).empty?
+            state_node.viz["color"] = "gold"
+          end
+          line_cluster << state_node
+        end
+      end
+
+      route.connections.each do |connection|
+        to_node = g.find(connection.line)
+        from_line = to_node.base
+
+        combos = {}
+        g.to_a.each do |node|
+          states = node.base.state_names(connection.states)
+          states.each do |state|
+            (combos[state] ||= []) << node
+          end
+        end
+
+        if connection.type == :if_any
+          combos.each do |state, nodes|
+            nodes.each do |node|
+              to_line = node.base
+              g.viz.add_edges(
+                node.viz.get_node("#{to_line.class.name}#{state}"),
+                to_node.viz.get_node("#{from_line.class.name}PASS"),
+                "lhead" => to_node.viz.id
+              )
+            end
+          end
+        end
+
+        if connection.type == :if_all
+          combos.each do |state, nodes|
+            node_name = nodes.map{ |n| n.base.class.name }.join + state
+            node_label = nodes.map{ |n| "#{n.base.class.name} #{state}"}.join("\n")
+            viz = g.viz.add_nodes(node_name, "label" => node_label)
+            viz["style"] = "rounded"
+            viz["color"] = "gray50"
+            viz["fontcolor"] = "gray40"
+
+            nodes.each do |node|
+              from_viz = node.viz.get_node("#{node.base.class.name}#{state}")
+              g.viz.add_edges from_viz, viz
+            end
+
+            g.viz.add_edges(
+              viz,
+              to_node.viz.get_node("#{connection.line.class.name}#{state}"),
+              "lhead" => to_node.viz.id
+            )
+          end
+        end
+      end
+
+      file_name = "#{route.name.downcase.gsub("::", "_")}-route-basic.pdf"
+      g.viz.output(:pdf => File.join(dir, file_name))
+    end
+
+    def graph_route
+      g = Node.new(nil, GraphViz.new("G"))
+      g.viz["label"] = "#{route.name} Lines"
+      g.viz["compound"] = true
+      g.viz["ranksep"] = 0.8
+      g.viz["fontname"] = "Helvetica"
+      g.viz.node["fontname"] = "Helvetica"
+      g.viz.node["shape"] = "box"
+      g.viz.node["style"] = "rounded"
+
+      route.lines.each_with_index do |line, index|
+        line_cluster = Node.new(line, g.viz.add_graph("cluster#{index}"))
+        line_cluster.viz["label"] = line.class.name
+        line_cluster.viz["style"] = "filled"
+        g << line_cluster
+
+        line.states.keys.each do |state|
+          state_node = Node.new(state, line_cluster.viz.add_nodes(state))
+          state_node.viz["style"] = "filled,rounded"
+          state_node.viz["color"] = "white"
+          if line.goal.include?(state)
+            state_node.viz["color"] = "green2"
+          end
+          if route.goal.include?(state)
+            state_node.viz["color"] = "gold"
+          end
+          line_cluster << state_node
+        end
+      end
+
+      viz = g.viz.add_nodes(route.initial_state)
+
+      route.states.each do |from_state, to_states|
+        (to_states || []).each do |to_state|
+          from_line = route.lines.to_a.select{ |l| l.states.keys.include?(from_state) }.first
+          from_node = g.find(from_line) if from_line
+          from_viz = from_node.viz.get_node(from_state) if from_node
+          from_viz ||= g.viz.get_node(from_state)
+          to_line = route.lines.to_a.select{ |l| l.states.keys.include?(to_state) }.first
+          to_node = g.find(to_line) if to_line
+          to_viz = to_node.viz.get_node(to_state) if to_node
+          to_viz ||= g.viz.get_node(to_state)
+
+          if from_viz && to_viz
+            g.viz.add_edges(
+              from_viz,
+              to_viz
+            )
+          end
+        end
+      end
+
+      file_name = "#{route.name.downcase.gsub("::", "_")}-route.pdf"
+      g.viz.output(:pdf => File.join(dir, file_name))
+    end
+
+  end
+end

data/test/example.rb

@@ -187,7 +187,7 @@ class BasicMath < Ellington::Route
   connect_to division, :if_any => addition.passed
   connect_to multiplication, :if_any => addition.failed
 
-  log_passenger_attrs :original_value, :current_value
+  log_options :passenger => [:original_value, :current_value]
 end
 
 # conductor ---------------------------------------------------------------

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ellington
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-25 00:00:00.000000000 Z
+date: 2013-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hero
@@ -72,7 +72,9 @@ files:
 - lib/ellington/transition_info.rb
 - lib/ellington/unique_type_array.rb
 - lib/ellington/version.rb
+- lib/ellington/visualizer.rb
 - lib/ellington.rb
+- Blast.pdf
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -116,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: A micro framework to ensure your projects are easy to manage, develop, &
@@ -139,4 +141,3 @@ test_files:
 - test/ticket_test.rb
 - test/transition_info_test.rb
 - test/unique_type_array_test.rb
-has_rdoc: