sfplanner 0.1.3 → 0.1.4

data/README.md

@@ -13,6 +13,13 @@ Click [here](https://github.com/herry13/nuri/wiki/SFP-language), for more detail
 This is a spin-out project from [Nuri](https://github.com/herry13/nuri).
 
 
+Features
+--------
+- Automatically generating a sequential or partial-order (parallel) plan.
+- Use JSON as the standard format of the plan.
+- Generate an image file that illustrates the graph of the plan.
+
+
 To install
 ----------
 
@@ -22,6 +29,7 @@ To install
 Requirements
 ------------
 - Ruby (>= 1.8.7)
+- Graphviz
 - Rubygems
 	- sfp (>= 0.3.0)
 

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.1.4

data/bin/sfplanner

@@ -15,9 +15,11 @@ Usage:
 where [options] are:
 EOS
 
-	opt :parallel, "Generate a parallel (partial-order) plan, instead of sequential."
-	opt :json_input, "Input is in JSON format"
-	opt :pretty, "Print the plan in pretty JSON format"
+	opt :parallel, "Generate a parallel (partial-order) plan, instead of sequential.", :short => '-l'
+	opt :json_input, "Input is in JSON format", :short => '-j'
+	opt :pretty_json, "Print the plan in pretty JSON format", :short => '-r'
+	opt :image, "Generate a graph image (PNG) of the plan"
+	opt :output, "Output file path", :default => ''
 end
 
 def parse(filepath)
@@ -27,20 +29,35 @@ def parse(filepath)
 	parser
 end
 
-filepath = ARGV[0].to_s
-
-if filepath != ''
+if ARGV[0]
 	planner = Sfp::Planner.new
-	options = {:file => ARGV[0],
-	           :json => !opts[:pretty],
-	           :pretty_json => opts[:pretty],
-	           :parallel => opts[:parallel]}
-	if opts[:json_input]
-		options[:input_json] = true
-		puts planner.solve(options)
+	opts[:file] = ARGV[0]
+	opts[:json] = (!opts[:pretty_json] and !opts[:dot])
+	opts[:dot] = true if opts[:image]
+
+	result = planner.solve(opts)
+	if !opts[:image]
+		if opts[:output].length > 0
+			File.open(opts[:output], 'w') { |f|
+				f.write(result)
+				f.flush
+			}
+		else
+			puts result
+		end
 	else
-		puts planner.solve(options)
+		if opts[:output].length <= 0
+			parts = ARGV[0].split('/')
+			src_file = parts[parts.length-1]
+			parts = src_file.split('.')
+			opts[:output] = src_file[0, src_file.length-1-parts[parts.length-1].length] if parts.length >= 2
+			opts[:output] += '.png'
+		end
+		if !Sfp::Graph.dot2image(result, opts[:output])
+			$stderr.puts "Cannot generate the image graph!"
+		end
 	end
+
 else
 	Trollop::help
 end

data/bin/sfw2graph

@@ -3,134 +3,14 @@
 require 'rubygems'
 require 'json'
 
-module Nuri
-	module Planner
-		module Graph
-			ActionColor = 'white'
-			ActionLabelWithParameters = false
-
-			def self.clean(value)
-				return value[2, value.length-2] if value[0,2] == '$.'
-				return value
-			end
-			
-			def self.get_label(action, withparameters=true)
-				label = clean(action["name"])
-				if withparameters and ActionLabelWithParameters
-					label += "("
-					if action["parameters"].length > 0
-						action["parameters"].each { |key,value|
-							label += "#{clean(key)}=#{clean(value.to_s)},"
-						}
-						label.chop!
-					end
-					label += ')'
-				end
-				return label
-			end
-			
-			def self.partial2dot(json)
-				dot = "digraph {\n"
-			
-				dot += "init_state [label=\"\", shape=doublecircle, fixedsize=true, width=0.35];\n"
-				dot += "final_state [label=\"\", shape=doublecircle, style=filled, fillcolor=black, fixedsize=true, width=0.35];\n"
-				last_actions = Hash.new
-				json["workflow"].each { |action|
-					dot += "#{action["id"]}[label=\"#{get_label(action)}\", shape=rect, style=filled, fillcolor=#{ActionColor}];\n"
-					last_actions[action["id"].to_s] = action
-				}
-			
-				json["workflow"].each { |action|
-					has_predecessor = false
-					action["predecessors"].each { |prevId|
-						dot += "#{prevId} -> #{action["id"]};\n"
-						has_predecessor = true
-						last_actions.delete(prevId.to_s)
-					}
-					if not has_predecessor
-						dot += "init_state -> #{action["id"]};\n"
-					end
-				}
-			
-				last_actions.each { |id,action|
-					dot += "#{id} -> final_state;\n"
-				}
-			
-				dot += "}"
-			
-				return dot
-			end
-			
-			def self.stage2dot(json)
-				dot = "digraph {\n"
-			
-				dot += "init_state [label=\"\", shape=doublecircle, fixedsize=true, width=0.35];\n"
-				dot += "final_state [label=\"\", shape=doublecircle, style=filled, fillcolor=black, fixedsize=true, width=0.35];\n"
-				index = 0
-				prevState = "init_state"
-				json["workflow"].each { |stage|
-					id = 0
-					stage.each { |action|
-						dot += "a" + index.to_s + "a" + id.to_s + '[label="' + get_label(action) + '", shape=rect]' + ";\n"
-						dot += prevState + " -> a" + index.to_s + "a" + id.to_s + ";\n"
-						id += 1
-					}
-					if index < json["workflow"].length-1
-						dot += "state" + index.to_s + ' [label="", shape=circle, fixedsize=true, width=0.35]' + ";\n"
-						prevState = "state" + index.to_s
-						id = 0
-						stage.each { |action|
-							dot += "a" + index.to_s + "a" + id.to_s + " -> " + prevState + ";\n"
-							id += 1
-						}
-					else
-						id = 0
-						stage.each { |action|
-							dot += "a" + index.to_s + "a" + id.to_s + " -> final_state;\n"
-							id += 1
-						}
-					end
-					index += 1
-				}
-				dot += "}"
-				return dot
-			end
-			
-			def self.sequential2dot(json)
-				dot = "digraph {\n"
-			
-				dot += "init_state [label=\"\", shape=doublecircle, fixedsize=true, width=0.35];\n"
-				dot += "final_state [label=\"\", shape=doublecircle, style=filled, fillcolor=black, fixedsize=true, width=0.35];\n"
-				id = 0
-				json["workflow"].each { |action|
-					dot += id.to_s + '[label="' + get_label(action) + '", shape=rect]' + ";\n"
-					id += 1
-				}
-			
-				id = 0
-				prevActionId = nil
-				json["workflow"].each { |action|
-					if id == 0
-						dot += "init_state -> " + id.to_s + ";\n"
-					elsif id == json["workflow"].length-1
-						dot += id.to_s + " -> final_state;\n"
-					end
-					if prevActionId != nil
-						dot += prevActionId.to_s + " -> " + id.to_s + ";\n"
-					end
-					prevActionId = id
-					id += 1
-				}
-				dot += "}"
-				return dot
-			end
-		end
-	end
+module Sfp
 end
 
+require File.expand_path('../../lib/sfplanner/graph.rb', __FILE__)
+
 def main
 	if ARGV.length < 1
-		puts "Usage: sfw2dot.rb <input-file> [output-file]\n\n"
+		puts "Convert SFP plan to an image graph with Graphviz (dot).\n\nUsage: sfw2dot.rb <input-file> [output-file]\n\n"
 		exit
 	end
 	
@@ -141,11 +21,11 @@ def main
 	dot = ""
 	case json["type"]
 	when 'partial-order', 'parallel'
-		dot = Nuri::Planner::Graph::partial2dot(json)
+		dot = Sfp::Graph::partial2dot(json)
 	when 'sequential'
-		dot = Nuri::Planner::Graph::sequential2dot(json)
+		dot = Sfp::Graph::sequential2dot(json)
 	when 'stage'
-		dot = Nuri::Planner::Graph::stage2dot(json)
+		dot = Sfp::Graph::stage2dot(json)
 	else
 		throw Exception, "Unrecognised type of workflow: #{json['type']}"
 	end

data/lib/sfplanner/graph.rb

@@ -0,0 +1,132 @@
+module Sfp::Graph
+	ActionColor = 'white'
+	ActionLabelWithParameters = false
+
+	def self.dot2image(dot, image_file)
+		dot_file = "/tmp/#{Time.now.getutc.to_i}.dot"
+		File.open(dot_file, 'w') { |f|
+			f.write(dot)
+			f.flush
+		}
+		!!system("dot -Tpng -o #{image_file} #{dot_file}")
+	ensure
+		File.delete(dot_file) if File.exist?(dot_file)
+	end
+
+	def self.clean(value)
+		return value[2, value.length-2] if value[0,2] == '$.'
+		return value
+	end
+	
+	def self.get_label(action, withparameters=true)
+		label = clean(action["name"])
+		if withparameters and ActionLabelWithParameters
+			label += "("
+			if action["parameters"].length > 0
+				action["parameters"].each { |key,value|
+					label += "#{clean(key)}=#{clean(value.to_s)},"
+				}
+				label.chop!
+			end
+			label += ')'
+		end
+		return label
+	end
+	
+	def self.partial2dot(json)
+		dot = "digraph {\n"
+	
+		dot += "init_state [label=\"\", shape=doublecircle, fixedsize=true, width=0.35];\n"
+		dot += "final_state [label=\"\", shape=doublecircle, style=filled, fillcolor=black, fixedsize=true, width=0.35];\n"
+		last_actions = Hash.new
+		json["workflow"].each { |action|
+			dot += "#{action["id"]}[label=\"#{get_label(action)}\", shape=rect, style=filled, fillcolor=#{ActionColor}];\n"
+			last_actions[action["id"].to_s] = action
+		}
+	
+		json["workflow"].each { |action|
+			has_predecessor = false
+			action["predecessors"].each { |prevId|
+				dot += "#{prevId} -> #{action["id"]};\n"
+				has_predecessor = true
+				last_actions.delete(prevId.to_s)
+			}
+			if not has_predecessor
+				dot += "init_state -> #{action["id"]};\n"
+			end
+		}
+	
+		last_actions.each { |id,action|
+			dot += "#{id} -> final_state;\n"
+		}
+	
+		dot += "}"
+	
+		return dot
+	end
+	
+	def self.stage2dot(json)
+		dot = "digraph {\n"
+	
+		dot += "init_state [label=\"\", shape=doublecircle, fixedsize=true, width=0.35];\n"
+		dot += "final_state [label=\"\", shape=doublecircle, style=filled, fillcolor=black, fixedsize=true, width=0.35];\n"
+		index = 0
+		prevState = "init_state"
+		json["workflow"].each { |stage|
+			id = 0
+			stage.each { |action|
+				dot += "a" + index.to_s + "a" + id.to_s + '[label="' + get_label(action) + '", shape=rect]' + ";\n"
+				dot += prevState + " -> a" + index.to_s + "a" + id.to_s + ";\n"
+				id += 1
+			}
+			if index < json["workflow"].length-1
+				dot += "state" + index.to_s + ' [label="", shape=circle, fixedsize=true, width=0.35]' + ";\n"
+				prevState = "state" + index.to_s
+				id = 0
+				stage.each { |action|
+					dot += "a" + index.to_s + "a" + id.to_s + " -> " + prevState + ";\n"
+					id += 1
+				}
+			else
+				id = 0
+				stage.each { |action|
+					dot += "a" + index.to_s + "a" + id.to_s + " -> final_state;\n"
+					id += 1
+				}
+			end
+			index += 1
+		}
+		dot += "}"
+		return dot
+	end
+	
+	def self.sequential2dot(json)
+		dot = "digraph {\n"
+	
+		dot += "init_state [label=\"\", shape=doublecircle, fixedsize=true, width=0.35];\n"
+		dot += "final_state [label=\"\", shape=doublecircle, style=filled, fillcolor=black, fixedsize=true, width=0.35];\n"
+		id = 0
+		json["workflow"].each { |action|
+			dot += id.to_s + '[label="' + get_label(action) + '", shape=rect]' + ";\n"
+			id += 1
+		}
+	
+		id = 0
+		prevActionId = nil
+		json["workflow"].each { |action|
+			if id == 0
+				dot += "init_state -> " + id.to_s + ";\n"
+			elsif id == json["workflow"].length-1
+				dot += id.to_s + " -> final_state;\n"
+			end
+			if prevActionId != nil
+				dot += prevActionId.to_s + " -> " + id.to_s + ";\n"
+			end
+			prevActionId = id
+			id += 1
+		}
+		dot += "}"
+		return dot
+	end
+end
+

data/lib/sfplanner/planner.rb

@@ -26,20 +26,26 @@ module Sfp
 		attr_accessor :debug
 		attr_reader :parser
 
+		# @param all parameters are passed to Sfp::Parser#initialize method
+		#
 		def initialize(params={})
 			@parser = Sfp::Parser.new(params)
 			@debug = Debug
 		end
 
-		# @param :string       : SFP task in string
-		# @param :sfp          : SFP task in Hash data structure
-		# @param :file         : SFP task in file with specified path
-		# @param :sas_plan     : if true then return a raw SAS plan
-		# @param :parallel     : if true then return a parallel (partial-order) plan,
+		# @param :string      => SFP task in string
+		#        :sfp         => SFP task in Hash data structure
+		#        :file        => SFP task in file with specified path
+		#        :json_input  => SFP task in JSON format
+		#        :sas_plan    => if true then return a raw SAS plan
+		#        :parallel    => if true then return a parallel (partial-order) plan,
 		#                        if false or nil then return a sequential plan
-		# @param :json         : if true then return the plan in JSON
-		# @param :pretty_json  : if true then return in pretty JSON
-		# @param :bsig         : if true then return the solution plan as a BSig model
+		#        :json        => if true then return the plan in JSON
+		#        :pretty_json => if true then return in pretty JSON
+		#        :bsig        => if true then return the solution plan as a BSig model
+		#
+		# @return if solution plan is found then returns a JSON or Hash
+		#         otherwise return nil
 		#
 		def solve(params={})
 			if params[:string].is_a?(String)
@@ -48,7 +54,7 @@ module Sfp
 				@parser.root = params[:sfp]
 			elsif params[:file].is_a?(String)
 				raise Exception, "File not found: #{params[:file]}" if not File.exist?(params[:file])
-				if params[:input_json]
+				if params[:json_input]
 					@parser.root = json_to_sfp(JSON[File.read(params[:file])])
 				else
 					@parser.home_dir = File.expand_path(File.dirname(params[:file]))
@@ -67,10 +73,15 @@ module Sfp
 			end
 		end
 
-		# @param :parallel : if true then return a parallel (partial-order) plan,
-		#                    if false or nil then return a sequential plan
-		# @param :json     : if true then return the plan in JSON
-		# @param :pretty_json : if true then return in pretty JSON
+		# Return Behavioural Signature (BSig) model of previously generated plan.
+		# 
+		# @param :parallel    => if true then return a parallel (partial-order) plan,
+		#                        if false or nil then return a sequential plan
+		#        :json        => if true then return the plan in JSON
+		#        :pretty_json => if true then return in pretty JSON
+		#
+		# @return if solution BSig model is found then returns a JSON or Hash,
+		#         otherwise return nil
 		#
 		def to_bsig(params={})
 			raise Exception, "Conformant task is not supported yet" if @parser.conformant
@@ -81,8 +92,12 @@ module Sfp
 			        (params[:pretty_json] ? JSON.pretty_generate(bsig) : bsig))
 		end
 
-		# @param :json         : if true then return in JSON
-		# @param :pretty_json  : if true then return in pretty JSON
+		# Return the final state if the plan is executed.
+		# 
+		# @param :json        => if true then return in JSON
+		#        :pretty_json => if true then return in pretty JSON
+		#
+		# @return [Hash]
 		#
 		def final_state(params={})
 			return nil if @plan.nil?
@@ -92,6 +107,14 @@ module Sfp
 		end
 
 		protected
+		def to_dot(plan)
+			if plan['type'] == 'parallel'
+				Sfp::Graph.partial2dot(self.get_parallel_plan)
+			else
+				Sfp::Graph.sequential2dot(self.get_sequential_plan)
+			end
+		end
+
 		def json_to_sfp(json)
 			json.accept(Sfp::Visitor::SfpGenerator.new(json))
 			json.each do |key,val|
@@ -177,8 +200,16 @@ module Sfp
 			return to_bsig(params) if params[:bsig]
 
 			plan = (params[:parallel] ? self.get_parallel_plan : self.get_sequential_plan)
-			return (params[:json] ? JSON.generate(plan) :
-			        (params[:pretty_json] ? JSON.pretty_generate(plan) : plan))
+
+			if params[:dot]
+				to_dot(plan)
+			elsif params[:json]
+				JSON.generate(plan)
+			elsif params[:pretty_json]
+				JSON.pretty_generate(plan)
+			else
+				plan
+			end
 		end
 
 		def bsig_template
@@ -494,7 +525,7 @@ module Sfp
 				@dir = dir
 				@sas_file = sas_file
 				@plan_file = plan_file
-				@heuristics_order = ['autotune12', 'autotune22', 'ff2', 'cea2']
+				@heuristics_order = ['ff2', 'cea2', 'autotune12', 'autotune22']
 				@heuristics_order = ENV['SFPLANNER_MIXED_HEURISTICS'].split(',') if ENV['SFPLANNER_MIXED_HEURISTICS']
 				@continue = continue
 				@continue = true if ENV['SFPLANNER_MIXED_CONTINUE']

data/lib/sfplanner.rb

@@ -7,4 +7,5 @@ require 'sfp'
 libdir = File.expand_path(File.dirname(__FILE__))
 
 require libdir + '/sfplanner/sas'
+require libdir + '/sfplanner/graph.rb'
 require libdir + '/sfplanner/planner'

data/sfplanner.gemspec

@@ -8,6 +8,7 @@ Gem::Specification.new do |s|
 	s.email			= 'herry13@gmail.com'
 
 	s.executables << 'sfplanner'
+	s.executables << 'sfw2graph'
 	s.files			= `git ls-files`.split("\n")
 
 	s.require_paths = ['lib']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sfplanner
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2013-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sfp
-  requirement: &20029340 !ruby/object:Gem::Requirement
+  requirement: &16262980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,13 +21,14 @@ dependencies:
         version: 0.3.12
   type: :runtime
   prerelease: false
-  version_requirements: *20029340
+  version_requirements: *16262980
 description: A Ruby gem that provides a Ruby API and a script to the SFP planner.
   This planner can automatically generate a plan that solves a planning problem written
   in SFP language.
 email: herry13@gmail.com
 executables:
 - sfplanner
+- sfw2graph
 extensions: []
 extra_rdoc_files: []
 files:
@@ -42,6 +43,7 @@ files:
 - bin/solver/macos/downward
 - bin/solver/macos/preprocess
 - lib/sfplanner.rb
+- lib/sfplanner/graph.rb
 - lib/sfplanner/planner.rb
 - lib/sfplanner/sas.rb
 - sfplanner.gemspec