tla-sbuilder 0.3.4 → 0.3.7

data/lib/sbuilder/factory.rb

@@ -169,7 +169,7 @@ module Sbuilder
     # return 'objectName' plugin instance, or create new plugin object
     # with 'className.new'.configure( configuration )
     #
-    # @param [String] className name of the plugin, if nil objectName
+    # @param [String, Class] className name of the plugin, if nil objectName
     # must be nil
     #
     # @param [Object] configuration to pass to className.new 
@@ -210,7 +210,7 @@ module Sbuilder
 
         # create new 'unnamed object'
         
-        if loaderPlugins[className].nil? then
+        if className.is_a?(String) && loaderPlugins[className].nil? then
           msg = <<-EOS
         Unknown parameter className #{className}"
 
@@ -220,8 +220,13 @@ module Sbuilder
           @logger.error( "#{__method__} #{msg}" )
           raise NameError.new( msg  ) 
         end
-        newObject = loaderPlugins[className].new( options )
-        newObject.configure( configuration ) if configuration
+
+        klass = className.is_a?( String ) ? loaderPlugins[className] : className
+
+        # newObject = loaderPlugins[className].new( options )
+        newObject = klass.new( options )
+        # newObject.configure( configuration ) if configuration # 
+        newObject.configure( configuration ) 
         return newObject
       end
     end

data/lib/sbuilder/model.rb

@@ -114,7 +114,7 @@ module Sbuilder
     
     def getDomain( domainName )
       ret = domains[domainName]
-      raise ModelException.new  "Could not locate domain set #{domainName}" unless ret
+      raise ModelException.new  "Could not locate domain set #{domainName}, known domains #{domains.keys.join(",")}" unless ret
       return ret
     end
 
@@ -369,8 +369,25 @@ module Sbuilder
               # :interface_id => step.interfaceReference.getId,              
               '_comma' => (i< steps.length-1 ? "," : ""),                                         
               :bindRule => step.bindExact == false ? step.inputs : false,
-              # :bindSets  => step.bindExact ?  step.inputs.map.with_index { |input,i| input['_comma'] = i<step.inputs.length-1 ? ',' : ''; input }  : false,               
-              :bindSets  => step.bindExact ?  step.inputs : false, 
+              :bindRules => step.bindExact == false ?
+                              # for bindRules i.e. when bindSets== false:
+                              # mustache  iterates set with  these elements
+                              step.inputs.map.with_index do |input,index|
+                                {
+                                  :process => step.getName,
+                                  :interface_name => step.interfaceReference.getName,
+                                  :interface_operation => step.interfaceReference.getId,
+                                  :interface_path => step.interfaceReference.path,
+                                  :bindRule => input,
+                                  "_comma" => (index<step.inputs.length-1 ? "," : ""),
+                                }
+                              end :
+                              false,
+              # :bindSets  => step.bindExact ?  step.inputs.map.with_index { |input,i| input['_comma'] = i<step.inputs.length-1 ? ',' : ''; input }  : false,
+              # for 'bindSets' bindRules == false mustache step is 
+              # one entry with set for 'bindSets' elements
+              :bindSets  => step.bindExact ?  step.inputs : false,
+              :noBinds => step.inputs.length == 0,
             }
           },
         }
@@ -455,6 +472,11 @@ module Sbuilder
             :interface_name => iface.getName,          # e.g._pet_post_
             :interface_operation => iface.getId,       # e.g /pet(post)
             :implementation => getImplementationExtension( iface ),
+            :source => {
+              :sourceModule => iface.sourceModule,
+              :sourceLine => iface.sourceLine,
+              :sourceColumn => iface.sourceColumn,              
+            },
             :completion => getCompletionExtension( iface ),            
             '_comma' => ',',
             :parameter_definitions => iface.parameter_definitions( self ),

data/lib/sbuilder/param_set.rb

@@ -103,13 +103,14 @@ module Sbuilder
 
     # getId with invalid-caharacters as underscpce
     def getName
-      return getId.
-              gsub( /\//, "_" ).   # / --> _
-              gsub( /\(/, "_" ).   # ( --> _
-              gsub( /\{/, "_" ).   # { --> _
-              gsub( /\}/, "_" ).   # } --> _
-              gsub( /\./, "_" ).   # . --> _              
-              gsub( /\)/, "_" )    # ) --> _
+      self.class.id2name(getId)
+      # return getId.
+      #         gsub( /\//, "_" ).   # / --> _
+      #         gsub( /\(/, "_" ).   # ( --> _
+      #         gsub( /\{/, "_" ).   # { --> _
+      #         gsub( /\}/, "_" ).   # } --> _
+      #         gsub( /\./, "_" ).   # . --> _              
+      #         gsub( /\)/, "_" )    # ) --> _
       
     end
 

data/mustache/cfg/const_def.mustache

@@ -8,3 +8,5 @@ CONSTANT Abort = Abort
 (* Pluscal sets 'defaultInitValue' for unitialized variables *)
 CONSTANT defaultInitValue <- Nil
 
+(* Defined in extending modules  *)
+CONSTANT SetStepInput <- Run_SetStepInput

data/mustache/config/module_footer.mustache

@@ -0,0 +1 @@
+=============================================================================

data/mustache/config/module_header.mustache

@@ -0,0 +1,10 @@
+Model version: {{META.model_version}}
+Generator version: {{META.version}}
+Generation timestemp: {{META.timestamp}}
+
+------------------------------ MODULE config ------------------------------
+(* Common configuration module for various setup run configuration *)
+
+EXTENDS model, TLC
+
+

data/mustache/config/steps_run.mustache

@@ -0,0 +1,43 @@
+
+(******************************************************************
+ Environment model running the steps
+ 
+ {{META.desc}}
+ - modelData {{META.modelData}}
+ - template  {{META.template}}
+ ******************************************************************)
+
+
+RunSteps == <<
+{{#steps}} {{!
+
+   Start set {
+
+}} {
+{{!
+      Generate noBinds (!bindExact && !bindRules)
+}}{{#noBinds}} [  process  |-> "p_{{process}}"
+     , bindRule |-> WildCard
+     , bindSet  |-> Nil
+     , ctx      |-> Nil
+  ] {{/noBinds}}{{^noBinds}}{{!
+  
+       Generate for bindExact
+       
+}}{{#bindSets.length}} [  process  |-> "p_{{process}}"
+     , bindRule |-> {{>config/steps_run_bind_rule.mustache }}
+     , bindSet  |-> {{>config/steps_run_bind_set.mustache }}
+     , ctx      |-> Nil
+  ]{{/bindSets.length}}{{!
+
+       Generat for bindRules
+}}{{^bindSets}}{{#bindRules}}[  process  |-> "p_{{process}}"
+     , bindRule |-> {{>config/steps_run_bind_rule.mustache }}
+     , bindSet  |-> {{>config/steps_run_bind_set.mustache }}
+     , ctx      |-> Nil
+  ]{{_comma}}{{/bindRules}}{{/bindSets}}{{/noBinds}}
+ } {{_comma}}  (* interface/process : {{process}} *)
+{{/steps}}
+
+>>
+

data/mustache/{setup → config}/steps_run_bind_rule.mustache

@@ -17,7 +17,7 @@
 
     Iterate 'bindRule' for each column
 
-}}{{/columns.length}}{{#columns}}{{>setup/steps_run_parameterBind.mustache}}{{/columns}}{{!
+}}{{/columns.length}}{{#columns}}{{>config/steps_run_parameterBind.mustache}}{{/columns}}{{!
 
     end of some columns defined
 
@@ -48,4 +48,7 @@
 }}{{^bindRule}}WildCard{{/bindRule}}{{!
 
    No new line --> outputs on one line
-}}
+Local Variables:
+require-final-newline: nil
+End:
+}}

data/mustache/{setup → config}/steps_run_bind_set.mustache

@@ -3,7 +3,8 @@
 
     - open with {
     
-}}{{#bindSets.length}} {  {{/bindSets.length}}{{#bindSets}}{{!
+}}{{#bindSets.length}} {
+{{/bindSets.length}}{{#bindSets}}{{!
 
 
 
@@ -11,13 +12,14 @@
     - iterate each input as an record
 
 
-}} {{#columns.length}}[ {{/columns.length}}{{>setup/steps_run_parameterExact.mustache}}{{#columns.length}} ] {{/columns.length}}{{!
+}} {{#columns.length}}[ {{/columns.length}}{{>config/steps_run_parameterExact.mustache}}{{#columns.length}} ] {{/columns.length}}{{!
 
    End of bind set iteration
    
    output _comma (to separate bind sets
 
-}}{{_comma}}{{/bindSets}}{{!
+}}{{_comma}}
+{{/bindSets}}{{!
 
 
    End of bind set
@@ -33,5 +35,9 @@
 
 
 }}Nil{{/bindSets}}{{!
- No new line --> output to one line
-}}
+No new line --> output to one line
+
+Local Variables:
+require-final-newline: nil
+End:
+}}

data/mustache/{setup → config}/steps_run_parameterBind.mustache

@@ -60,7 +60,7 @@
    Here recurse columns
 
 
-}}{{#columns}}{{>setup/steps_run_parameterBind.mustache}}{{/columns}}{{!
+}}{{#columns}}{{>config/steps_run_parameterBind.mustache}}{{/columns}}{{!
 
    end of columsn iteration
 
@@ -77,14 +77,20 @@ Start array parameter
 
 }}{{#rows}}{{!
       row with singleton elements (i.e. columns: false )
-}}{{^columns.length}}{{>setup/steps_run_parameterBind.mustache}} {{/columns.length}}{{!
+}}{{^columns.length}}{{>config/steps_run_parameterBind.mustache}} {{/columns.length}}{{!
 
    row with hash element starts (i.e. columns.length defined )
    
-}}{{#columns.length}}[ {{/columns.length}}{{#columns}}{{>setup/steps_run_parameterBind.mustache}} {{/columns}} {{!
+}}{{#columns.length}}[ {{/columns.length}}{{#columns}}{{>config/steps_run_parameterBind.mustache}} {{/columns}} {{!
       row with hash element ends
 }}{{#columns.length}} ]{{_comma}}{{/columns.length}} {{/rows}}{{!
 
    End of rows
 
-}}{{#rows.length}} } ]}{{_comma}} {{/rows.length}}
+}}{{#rows.length}} } ]}{{_comma}} {{/rows.length}}{{!
+
+   No new line --> outputs on one line
+Local Variables:
+require-final-newline: nil
+End:
+}}

data/mustache/{setup → config}/steps_run_parameterExact.mustache

@@ -69,15 +69,23 @@
 
        when iterating rows check if row defines columns (i.e. columns.length given ) --> surround with  [ ... ]
        
-}}{{#columns.length}}[ {{/columns.length}} {{>setup/steps_run_parameterExact.mustache}} {{#columns.length}} ]{{/columns.length}}{{_comma}}{{/rows}}{{#rows.length}} }{{/rows.length}}{{!
+}}{{#columns.length}}[ {{/columns.length}} {{>config/steps_run_parameterExact.mustache}} {{#columns.length}} ]{{/columns.length}}{{_comma}}
+{{/rows}}{{#rows.length}} }{{/rows.length}}{{!
 
    Case 5: columns
    - output [
      <recursion>
    - output ]
 
-}}{{#columns.length}}[ {{>setup/steps_run_parameterExact.mustache}} ] {{/columns.length}}{{!
+}}{{#columns.length}}[ {{>config/steps_run_parameterExact.mustache}} ] {{/columns.length}}{{!
 
   End of columns (add comma)
 
-}}{{_comma}}{{/columns}}{{! no new line }}
+}}{{_comma}}{{/columns}}{{!
+
+no new line
+
+Local Variables:
+require-final-newline: nil
+End:
+}}

data/mustache/inherit/inherit_config.mustache

@@ -0,0 +1,29 @@
+(* 
+
+   Model version: {{META.model_version}}
+   Generator version: {{META.version}}
+   Generation timestemp: {{META.timestamp}}
+
+*)
+
+\* Configuration included from {{META.setup}}/config.cfg
+
+
+\* !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+\* Start here
+
+{{!
+
+      Concatenate content of config.cfg for current setup 'META.setup'
+      generated under directory 'CONFIG.gen_dir'.
+
+}}
+{{#ACTIONS.cat}}
+{{CONFIG.gen_dir}}/{{META.setup}}/tla/config.cfg
+{{/ACTIONS.cat}}
+
+
+\* End here
+\* !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+\* Possible configs on top of 'config.cfg' follow this line

data/mustache/interface_processes.mustache

@@ -19,8 +19,12 @@ fair process ({{#SPEC_NAME}}processes.{{interface_operation}}{{/SPEC_NAME}}="{{i
 	 (* enable next process to run parallel *)
 	 \* process_done( "{{interface_operation}}" );
 	 with ( _input \in { t \in ProcessParameterInput( {{#SPEC_NAME}}interface_types.{{interface_operation}}{{/SPEC_NAME}} ) : ProcessParameterBind( t ) } ) {
+	    \* step_input allows extracting input from error trace - at the cost of creating extra state
+	    if ( SetStepInput ) {
+	       step_input := _input;
+	    };
 	    \* PREFERENCES.debug-output: {{PREFERENCES.debug-output}}
-	    {{^PREFERENCES.debug-output}}\* {{/PREFERENCES.debug-output}}print <<"Default process {{#SPEC_NAME}}processes.{{interface_operation}}{{/SPEC_NAME}} for operation '{{interface_operation}}',tick=", currentTime>>;
+	    {{^PREFERENCES.debug-output}}\* {{/PREFERENCES.debug-output}}print <<"Default process {{#SPEC_NAME}}processes.{{interface_operation}}{{/SPEC_NAME}} for operation '{{interface_operation}}',tick=", currentTime, "input=", step_input >>;
 	    {{^implementation}}
 	    {{^PREFERENCES.debug-output}}\* {{/PREFERENCES.debug-output}}print <<"   - input=>", _input >>;	    
 	    (* print <<"   - {{#SPEC_NAME}}interface_types.{{interface_operation}}{{/SPEC_NAME}} =>", {{#SPEC_NAME}}interface_types.{{interface_operation}}{{/SPEC_NAME}} >>; *)
@@ -38,7 +42,7 @@ fair process ({{#SPEC_NAME}}processes.{{interface_operation}}{{/SPEC_NAME}}="{{i
 	 }; \* with _input
 	 (* enable next process - after current process *)
 	 {{#SPEC_NAME}}processes.{{interface_operation}}{{/SPEC_NAME}}_exit:
-	     {{#completion}}{{completion}}( "{{interface_operation}}" );
+	     {{#completion}}{{#SPEC_NAME}}{{completion}}{{/SPEC_NAME}}( "{{interface_operation}}" );
 	     {{/completion}}{{!
 
 	       above adds call to completion macro (to simulate transactions) 

data/mustache/interfaces/interface_mapper.mustache

@@ -0,0 +1,12 @@
+{{!
+
+   Reverse map interfaces
+
+
+
+}}
+# Interfaces {{META.desc}}
+#  - modelData {{META.modelData}}
+#  - template  {{META.template}}
+{{{dump}}}
+

data/mustache/possibility/module_extends.mustache

@@ -1 +1 @@
-EXTENDS setup
+EXTENDS config

data/mustache/possibility/operator_set_step_input.mustache

@@ -0,0 +1,8 @@
+
+(* Save process input to variable 'step_input' at start?
+** Setting this variable allows presenting process input
+** in error trace, however, at the cost of possibly generating 
+** an extra state (in a case, where different input bindings
+** would result otherwise to identical states).
+*)
+Run_SetStepInput == TRUE

data/mustache/possibility/possibility_definition.mustache

@@ -1,10 +1,10 @@
 
 (*
-   Define possibility for operator {{possibility}}
+   Define possibility for operator '{{possibility}}'.
 
-   We require that {{META.outputModule}} is false allways.
-   Interpreat violation of this property that it is possible
-   to reach a state where the property holds.
+   We require that '{{META.outputModule}}' is false always.
+   Interpret violation of this property to mean that it is
+   possible to reach a state where the operator holds.
 
 *)
 

data/mustache/possibility/possility_setup.mustache

@@ -6,7 +6,7 @@
 
 *)
 
-\* Configuration taken from {{META.setup}}/setup.cfg
+\* Configuration included from {{META.setup}}/config.cfg
 
 
 \* !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
@@ -14,15 +14,16 @@
 
 {{!
 
-      Concatenate content of setup.cfg for current setup 'META.setup'
+      Concatenate content of config.cfg for current setup 'META.setup'
       generated under directory 'CONFIG.gen_dir'.
 
 }}
 {{#ACTIONS.cat}}
-{{CONFIG.gen_dir}}/{{META.setup}}/tla/setup.cfg
+{{CONFIG.gen_dir}}/{{META.setup}}/tla/config.cfg
 {{/ACTIONS.cat}}
 
 
 \* End here
 \* !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 
+\* Possible configs on top of 'config.cfg' follow this line

data/mustache/setup/module_header.mustache

@@ -4,6 +4,8 @@ Generation timestemp: {{META.timestamp}}
 
 ------------------------------ MODULE setup ------------------------------
 
-EXTENDS model, TLC
+(* Module to check correctness  *)
+
+EXTENDS config
 
 

data/mustache/setup/operator_set_step_input.mustache

@@ -0,0 +1,8 @@
+
+(* Save process input to variable 'step_input' at start?
+** Setting this variable allows presenting process input
+** in error trace, however, at the cost of possibly generating 
+** an extra state (in a case, where different input bindings
+** would result otherwise to identical states).
+*)
+Run_SetStepInput == FALSE

data/mustache/state_type_invariant-infrastructure-service.mustache

@@ -24,13 +24,13 @@
 
     iterate response definitions
     
-}}{{#response_definitions}}{{!
+}}{{#response_definitions.length}}{{!
 
         end of response definitions
 
         add ???
 	
-}} \union {{#SPEC_NAME}}{{metatype}}.{{type}}{{/SPEC_NAME}}{{/response_definitions}}{{!
+}} \union {{#SPEC_NAME}}interface_response_types.{{interface_operation}}{{/SPEC_NAME}}{{/response_definitions.length}} {{!
 
     end of intefaces