sfplanner 0.1.2 → 0.1.3

data/README.md

@@ -1,10 +1,12 @@
-SFP Planner for Ruby
-====================
+SFPlanner
+=========
 - Author: Herry (herry13@gmail.com)
 - [Version](https://github.com/herry13/sfplanner/blob/master/VERSION)
 - License: [BSD](https://github.com/herry13/sfp-ruby/blob/master/LICENSE)
 
-A Ruby gem that provides a Ruby API to SFP planner that solves a planning task written in [SFP language](https://github.com/herry13/nuri/wiki/SFP-language).
+[![Gem Version](https://badge.fury.io/rb/sfplanner.png)](http://badge.fury.io/rb/sfplanner)
+
+A Ruby script and library of SFP planner, which solves a planning task written in [SFP language](https://github.com/herry13/nuri/wiki/SFP-language).
 
 Click [here](https://github.com/herry13/nuri/wiki/SFP-language), for more details about SFP language.
 
@@ -22,13 +24,11 @@ Requirements
 - Ruby (>= 1.8.7)
 - Rubygems
 	- sfp (>= 0.3.0)
-	- antlr3
-	- json
 
 Tested on:
 - Ubuntu 12.04
 - Debian Squeeze
-- Scientific Linux 6.
+- Scientific Linux 6
 - MacOS X 10.8
 
 
@@ -43,53 +43,59 @@ To use as Ruby library
 ----------------------
 - parse an SFP file, and then generate the plan (if found) in Hash:
 
-		# include sfplanner library
-		require 'sfplanner'
+	```ruby
+	# include sfplanner library
+	require 'sfplanner'
 
-		# solve and return the plan in Hash
-		planner.solve({:file => file_path})
+	# solve and return the plan in Hash
+	planner.solve({:file => file_path})
+	```
 
 - parse an SFP file, and then generate the plan in JSON:
 
-		# include sfplanner library
-		require 'sfplanner'
+	```ruby
+	# include sfplanner library
+	require 'sfplanner'
 
-		# solve and return the plan in JSON
-		planner.solve({:file => file_path, :json => true})
+	# solve and return the plan in Hash
+	planner.solve({:file => file_path, :json => true})
+	```
 
 
 Example of Planning Task
 ------------------------
 - Create file **types.sfp** to hold required schemas:
 
-		schema Service {
-			running is false
-			procedure start {
-				conditions {
-					this.running is false
-				}
-				effects {
-					this.running is true
-				}
+	```javascript
+	schema Service {
+		running is false
+		procedure start {
+			conditions {
+				this.running is false
 			}
-			procedure stop {
-				conditions {
-					this.running is true
-				}
-				effects {
-					this.running is false
-				}
+			effects {
+				this.running is true
 			}
 		}
-		schema Client {
-			refer isref Service
-			procedure redirect(s isref Service) {
-				conditions { }
-				effects {
-					this.refer is s
-				}
+		procedure stop {
+			conditions {
+				this.running is true
+			}
+			effects {
+				this.running is false
 			}
 		}
+	}
+	schema Client {
+		refer isref Service
+		procedure redirect(s isref Service) {
+			conditions { }
+			effects {
+				this.refer is s
+			}
+		}
+	}
+	```
 
   In this file, we have two schemas that model our domain. First, schema
   **Service** with an attribute **running**, procedure **start** that
@@ -103,28 +109,30 @@ Example of Planning Task
 
 - Create file **task.sfp** to hold the task:
 
-		include "types.sfp"
-		
-		initial state {
-			a isa Service {
-				running is true
-			}
+	```javascript
+	include "types.sfp"
+	
+	initial state {
+		a isa Service {
+			running is true
+		}
 
-			b isa Service // with "running" is false
+		b isa Service // with "running" is false
 
-			pc isa Client {
-				refer is a
-			}
+		pc isa Client {
+			refer is a
 		}
+	}
 
-		goal constraint {
-			pc.refer is b
-			a.running is false
-		}
+	goal constraint {
+		pc.refer is b
+		a.running is false
+	}
 
-		global constraint {
-			pc.refer.running is true
-		}
+	global constraint {
+		pc.refer.running is true
+	}
+	```
 
   In this file, we specify a task where in the initial state of our domain,
   we have two services **a** and **b**, and a client **pc**. **a** is
@@ -140,46 +148,48 @@ Example of Planning Task
 
   Which will generate a workflow in JSON
 
-		{
-		  "type": "sequential",
-		  "workflow": [
-		    {
-		      "name": "$.b.start",
-		      "parameters": {
-		      },
-		      "condition": {
-		        "$.b.running": false
-		      },
-		      "effect": {
-		        "$.b.running": true
-		      }
-		    },
-		    {
-		      "name": "$.pc.redirect",
-		      "parameters": {
-		        "$.s": "$.b"
-		      },
-		      "condition": {
-		      },
-		      "effect": {
-		        "$.pc.refer": "$.b"
-		      }
-		    },
-		    {
-		      "name": "$.a.stop",
-		      "parameters": {
-		      },
-		      "condition": {
-		        "$.a.running": true
-		      },
-		      "effect": {
-		        "$.a.running": false
-		      }
-		    }
-		  ],
-		  "version": "1",
-		  "total": 3
-		}
+	```javascript
+	{
+	  "type": "sequential",
+	  "workflow": [
+	    {
+	      "name": "$.b.start",
+	      "parameters": {
+	      },
+	      "condition": {
+	        "$.b.running": false
+	      },
+	      "effect": {
+	        "$.b.running": true
+	      }
+	    },
+	    {
+	      "name": "$.pc.redirect",
+	      "parameters": {
+	        "$.s": "$.b"
+	      },
+	      "condition": {
+	      },
+	      "effect": {
+	        "$.pc.refer": "$.b"
+	      }
+	    },
+	    {
+	      "name": "$.a.stop",
+	      "parameters": {
+	      },
+	      "condition": {
+	        "$.a.running": true
+	      },
+	      "effect": {
+	        "$.a.running": false
+	      }
+	    }
+	  ],
+	  "version": "1",
+	  "total": 3
+	}
+	```
 
   This workflow is sequential that has 3 procedures. If you executes
   the workflow in given order, it will achieves the goal state as well
@@ -189,16 +199,18 @@ Example of Planning Task
 Planner Options
 ---------------
 You could set particular environment variable to change the planner settings:
-- to activate debug-mode
+- To activate debug-mode
 
-	SFPLANNER_DEBUG=1
+	$ export SFPLANNER_DEBUG=1
+	
+  This will disable automated deletion of temporary files in temporary directory (/tmp/nuri_****/).
 
-- to use multiple heuristic on finding the solution, and then pick the best result
+- To use multiple heuristic on finding the solution, and then pick the best result
 
-	SFPLANNER_MIXED_CONTINUE=1
+	$ export SFPLANNER_MIXED_CONTINUE=1
 
-- to set heuristics which are used in searching
+- To set heuristics which are used in searching
 
-	SFPLANNER_MIXED_HEURISTICS=ff2,cea2
+	$ export SFPLANNER_MIXED_HEURISTICS=ff2,cea2
 
 

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.3

data/lib/sfplanner/planner.rb

@@ -39,6 +39,7 @@ module Sfp
 		#                        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
 		#
 		def solve(params={})
 			if params[:string].is_a?(String)
@@ -75,6 +76,7 @@ module Sfp
 			raise Exception, "Conformant task is not supported yet" if @parser.conformant
 
 			bsig = (params[:parallel] ? self.to_parallel_bsig : self.to_sequential_bsig)
+
 			return (params[:json] ? JSON.generate(bsig) :
 			        (params[:pretty_json] ? JSON.pretty_generate(bsig) : bsig))
 		end
@@ -107,7 +109,8 @@ module Sfp
 		end
 
 		def solve_conformant_task(params={})
-			# TODO
+			raise Exception, "Conformant task is not supported yet" if params[:bsig]
+
 			# 1) generate all possible initial states
 			#    remove states that do not satisfy the global constraint
 			def get_possible_partial_initial_states(init)
@@ -171,49 +174,74 @@ module Sfp
 
 			return @plan if params[:sas_plan]
 
+			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))
 		end
 
 		def bsig_template
-			return {'version' => 1, 'operators' => [], 'id' => Time.now.getutc.to_i, 'goal' => []}
+			return {'version' => 1, 'operators' => [], 'id' => Time.now.getutc.to_i, 'goal' => {}, 'goal_operator' => {}}
 		end
 
 		def to_sequential_bsig
 			bsig = self.bsig_template
 			return bsig if @plan.length <= 0
+
 			plan = self.get_sequential_plan
 			bsig['operators'] = workflow = plan['workflow']
+
 			(workflow.length-1).downto(1) do |i|
 				op = workflow[i]
 				prev_op = workflow[i-1]
 				prev_op['effect'].each { |k,v| op['condition'][k] = v }
 			end
 			bsig['goal'], _ = self.bsig_goal_operator(workflow)
+
 			return bsig
 		end
 
 		def to_parallel_bsig
+			def set_priority_index(operator, operators)
+				pi = 1 
+				operator['successors'].each { |i| 
+					set_priority_index(operators[i], operators)
+					pi = operators[i]['pi'] + 1 if pi <= operators[i]['pi']
+				}   
+				operator['pi'] = pi
+			end 
+
 			return nil if @plan.nil?
+
 			bsig = self.bsig_template
 			return bsig if @plan.length <= 0
+
+			# generate parallel plan
 			plan = self.get_parallel_plan
-			# foreach operator's predecessors, add its effects to operator's conditions
-			bsig['operators'] = workflow = plan['workflow']
-			workflow.each do |op|
+
+			# set BSig operators
+			bsig['operators'] = operators = plan['workflow']
+
+			# set priority index
+			operators.each { |op| set_priority_index(op, operators) if op['predecessors'].length <= 0 }
+
+			# foreach operator
+			# - for each operator's predecessors, add its effects to operator's conditions
+			# - remove unnecessary data
+			operators.each do |op|
 				op['predecessors'].each do |pred|
-					pred_op = workflow[pred]
+					pred_op = operators[pred]
 					pred_op['effect'].each { |k,v| op['condition'][k] = v }
 				end
-			end
-			# remove unnecessary information
-			workflow.each do |op|
 				op.delete('id')
 				op.delete('predecessors')
 				op.delete('successors')
 			end
-			bsig['goal'], bsig['goal_operator'] = self.bsig_goal_operator(workflow)
+
+			# set goals
+			bsig['goal'], bsig['goal_operator'] = self.bsig_goal_operator(operators)
+
 			return bsig
 		end
 
@@ -255,7 +283,13 @@ module Sfp
 
 		def get_parallel_plan
 			json = {'type'=>'parallel', 'workflow'=>nil, 'init'=>nil, 'version'=>'1', 'total'=>0}
-			return json if @plan == nil
+			if @plan.nil?
+				return json
+			elsif @plan.length <= 0
+				json['workflow'] = []
+				return json
+			end
+			
 			json['workflow'], json['init'], json['total'] = @sas_task.get_partial_order_workflow(@parser)
 			return json
 		end

data/lib/sfplanner/sas.rb

@@ -99,7 +99,6 @@ module Nuri
 					raise Exception, 'Cannot find operator: ' + op_name if operator.nil?
 					op_sfw = operator.to_sfw
 					op_sfw['id'] = i
-					op_sfw['distance'] = distance
 					op_sfw['successors'] = []
 					op_sfw['predecessors'] = []
 					sfw << op_sfw
@@ -116,6 +115,7 @@ module Nuri
 						sfw[i]['predecessors'] << j
 					end
 				end
+
 				return sfw, init, sfw.length
 			end
 

data/sfplanner.gemspec

@@ -16,5 +16,5 @@ Gem::Specification.new do |s|
 	s.homepage		= 'https://github.com/herry13/sfplanner'
 	s.rubyforge_project = 'sfplanner'
 
-	s.add_dependency 'sfp', '~> 0.3.11'
+	s.add_dependency 'sfp', '~> 0.3.12'
 end	

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sfplanner
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -13,15 +13,15 @@ date: 2013-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sfp
-  requirement: &8735620 !ruby/object:Gem::Requirement
+  requirement: &20029340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.3.11
+        version: 0.3.12
   type: :runtime
   prerelease: false
-  version_requirements: *8735620
+  version_requirements: *20029340
 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.