tla-trace-filter 0.0.3 → 0.0.6

data/mustache/api-call-after-state-post.mustache

@@ -0,0 +1,9 @@
+{{!
+
+ api-call-output-post.mustache: Override this template to change wrapping around api-calls
+
+}}{{!
+Local Variables:
+require-final-newline: nil
+End:
+}}

data/mustache/api-call-after-state-pre.mustache

@@ -0,0 +1,9 @@
+{{!
+
+ api-call-output-pre.mustache: Override this template to change wrapping around api-calls
+
+}}{{!
+Local Variables:
+require-final-newline: nil
+End:
+}}

data/mustache/api-call-before-state-post.mustache

@@ -0,0 +1,9 @@
+{{!
+
+ api-call-input-post.mustache: Override this template to change wrapping around api-calls
+
+}}{{!
+Local Variables:
+require-final-newline: nil
+End:
+}}

data/mustache/api-call-before-state-pre.mustache

@@ -0,0 +1,9 @@
+{{!
+
+ api-call-pre.mustache: Override this template to change wrapping around api-calls
+
+}}{{!
+Local Variables:
+require-final-newline: nil
+End:
+}}

data/mustache/api-call-call-post.mustache

@@ -0,0 +1,9 @@
+{{!
+
+ api-call-call-post.mustache: this template to change wrapping around api-calls
+
+}}{{!
+Local Variables:
+require-final-newline: nil
+End:
+}}

data/mustache/api-call-call-pre.mustache

@@ -0,0 +1,9 @@
+{{!
+
+    api-call-call-pre.mustache: Override this template to change wrapping around api-calls
+
+}}{{!
+Local Variables:
+require-final-newline: nil
+End:
+}}

data/mustache/{api-call-output.mustache → api-call-default-afterState.mustache}

@@ -7,9 +7,9 @@
   
 }}
 
-# <OUTPUT-BLOCKCHAIN now="{{inputState.now}}">
-eth_accounts: {{{outputState.eth_accounts.to_yaml}}}
-eth_storageRoot: {{{outputState.eth_storageRoot.to_yaml}}}
+# <OUTPUT-BLOCKCHAIN now="{{afterState.now}}">
+eth_accounts: {{{afterState.eth_accounts.to_yaml}}}
+eth_storageRoot: {{{afterState.eth_storageRoot.to_yaml}}}
 # </OUTPUT-BLOCKCHAIN>
 {{!
 Local Variables:

data/mustache/{api-call-input.mustache → api-call-default-beforeState.mustache}

@@ -9,9 +9,9 @@
 
 }}
 
-# <INPUT-BLOCKCHAIN now="{{inputState.now}}">
-eth_accounts: {{{inputState.eth_accounts.to_yaml}}}
-eth_storageRoot: {{{inputState.eth_storageRoot.pretty_generate}}}
+# <INPUT-BLOCKCHAIN now="{{beforeState.now}}">
+eth_accounts: {{{beforeState.eth_accounts.to_yaml}}}
+eth_storageRoot: {{{beforeState.eth_storageRoot.pretty_generate}}}
 # </INPUT-BLOCKCHAIN>
 {{!
 Local Variables:

data/mustache/api-call-header.mustache

@@ -0,0 +1,4 @@
+{{!
+api-call-header.mustache : output header for step, override to change
+}}
+{{interface.interface_operation}}: at tick '{{parsed.state_space.now}}' for step '{{{parsed.state_space.step }}}'

data/mustache/api-call-init.mustache

@@ -1,66 +1,83 @@
 {{!
 
-  api-call-init.mustache: define rendering for 'api-call' command
-  
+  api-call-init.mustache:
+
+  Configure name of template to dispatch for 'interface_operation' in
+  tla-trace-filter.rb api-call -command.
+    
   Override this template to use other than default rendering.
 
   This template is called once for a 'tla-trace-filter.rb api-call'.
-  It initialize four mappings: 
+  
+  It initializes four mappings: 
 
-  - API_INPUT_INIT : render state before API call
-  - API_CALL_INIT : render API interface and API input parameters
-  - API_RETURN_INIT : render API interface and API return parameters
-  - API_OUTPUT_INIT : render state after API call
+  - API_BEFORE_STATE_INIT  : define template to render before state for interface operation
+  - API_CALL_INIT          : define template to render API call for interface operation
+  - API_RETURN_INIT        : define template to render API return for interface operation
+  - API_AFTER_STATE_INIT   : define template to render after state for interface operation
 
   These mappings wrap mustache lambda sections, which contain a YAML
   formatted hash mapping interface operation to a name of mustache
-  partial template. Two special keys are used: 1) 'default'
-  (=template to use if no other found), and 2) 'empty' (=template to
-  use if 'interface.interface_operation' is nil).
+  partial template.
+
+  Two special keys are used: 1) 'default' (=template to use if no
+  other found), and 2) 'empty' (=template to use if
+  'interface.interface_operation' is nil).
 
   Example:
 
   Demo(): solidity-constructor
   Demo(execute): solidity-message
   empty: api-call-empty
-  default: api-call-input
+  default: api-call-default-beforeState
 
   Which reads:
   - inteface operation "Demo()" uses mustache partial 'solidity-constructor.mustache'
   - interface Demo(execute) use partial 'solidity-message.mustache
   - undedefined interface operation (initial state) use partial 'api-call-empty.mustache'
-  - all other interface operations use  template 'api-call-input.mustache'
+  - all other interface operations use  template 'api-call-default-beforeState.mustache'
+
+  Search parth of these template files is configured using command line option --mustache.
 
-  Search parth of these template files is configured using command line option --mustache
+  Extension instructions:
+
+  - create extension directory e.g. `mkdir mymustache`
+  - copy this file to extension directory e.g.  `cp $(bundle show tla-trace-filter)/mustache/api-call-init.mustache mymustache/`
+  - modify file `mymustache/api-call-init.mustache`
+  - pass extension directory as --mustache paramter `bundle exec tla-trace-filter.rb api-calls --mustache mymustache/`
+    NOTICE directory names must end with slash '/' -character. Parameter not ending with slash are interpreted as GEM names 
+    with template directory `mustache`.
+    
   
 }}{{!
 
    Configure templates to render state before API call
 
-}}{{#API_INPUT_STATE_INIT}}
-default: api-call-input
-empty: api-call-input
-{{/API_INPUT_STATE_INIT}}{{!
+}}{{#API_BEFORE_STATE_INIT}}
+default: api-call-default-beforeState
+empty: api-call-default-beforeState
+{{/API_BEFORE_STATE_INIT}}{{!
 
  Configure templates to render API CALL
  
 }}{{#API_CALL_INIT}}
-default: api-call-default
+default: api-call-default-api_input
+empty: api-call-default-api_input
 {{/API_CALL_INIT}}{{!
 
  Configure templates to render API_RETURN
  
 }}{{#API_RETURN_INIT}}
-default: api-call-return
-empty: api-call-return
+default: api-call-default-api_return
+empty: api-call-default-api_return
 {{/API_RETURN_INIT}}{{!
 
     Configure templates to render state after API call
     
-}}{{#API_OUTPUT_STATE_INIT}}
-default: api-call-output
-empty: api-call-output
-{{/API_OUTPUT_STATE_INIT}}{{!
+}}{{#API_AFTER_STATE_INIT}}
+default: api-call-default-afterState
+empty: api-call-default-afterState
+{{/API_AFTER_STATE_INIT}}{{!
 
   Do not output new-line
 

data/mustache/api-call-link.mustache

@@ -1,2 +1,6 @@
-{{options.src_dir}}/{{interface.source.sourceModule}}:{{^options.solc_line}}{{interface.source.sourceLine}}{{/options.solc_line}}{{#options.solc_line}}{{SOLC_LINE}}{{/options.solc_line}}:1: {{interface.interface_operation}} at tick {{now}}
+{{!
+
+ api-call-link.mustache: Override this template to change link output
+
+}}{{options.src_dir}}/{{interface.source.sourceModule}}:{{^options.solc_line}}{{interface.source.sourceLine}}{{/options.solc_line}}{{#options.solc_line}}{{SOLC_LINE}}{{/options.solc_line}}:1: {{interface.interface_operation}} at tick {{now}}
 {{options.tla_dir}}/model.tla:{{parsed.actionLine}}: {{{parsed.line}}}

data/mustache/api-call-main.mustache

@@ -1,85 +1,65 @@
 {{!
 
-  api-call-main.mustache: template calling API_INPUT, API_CALL, API_OUTPUT templates
+  api-call-main.mustache: output one step in api-call
+    
+  IF interface_started THEN call templates 
+    - api-call-step-pre, api-call-header,
+    - API_INPUT, API_CALL, API_OUTPUT (dynamic dispatch)
+    - api-call-link
+    - api-call-step-post
   
-  Output API call for interface.interface_operation
 
-}}{{!
+  Output API step call for interface.interface_operation
 
-  IF #interface.source.sourceModule - interface known
+}}{{!
 
-}}{{#interface.source.sourceModule}}{{!
+  Start of step == 'interface_started'
+  
+   - output preamble
 
-  - start interface
+}}{{#interface_started}}{{>api-call-step-pre}}{{!
 
-}}{{#interface_started}}
-------------------------------------------------------------------
-{{interface.interface_operation}}: at tick '{{parsed.state_space.now}}' for step '{{{parsed.state_space.step }}}'{{!
+   -  output step header
+  
+}}{{>api-call-header}}{{!
 
-   - input state: dispatched dynamically trough API_INPUT_STATE, which maps
+   - input state: dispatched dynamically trough API_BEFORE_STATE, which maps
      [:interface][:interface_operation] to partial name set in 'api-call-init'
-     using API_INPUT_STATE_INIT
+     using API_BEFORE_STATE_INIT
 
-}}{{{API_INPUT_STATE}}}{{!
+}}{{>api-call-before-state-pre}}{{{API_BEFORE_STATE}}}{{>api-call-before-state-post}}{{!
 
    - API call: dispatched dynamically trough API_CALL, which maps
      [:interface][:interface_operation] to partial name set in 'api-call-init'
      using API_CALL_INIT
    
-}}{{{API_CALL}}}{{!
+}}{{>api-call-call-pre}}{{{API_CALL}}}{{>api-call-call-post}}{{!
 
    - API_RETURN: dispatched dynamically trough API_RETURN, which maps
      [:interface][:interface_operation] to partial name set in 'api-call-init'
      using API_RETURN_INIT
    
-}}{{{API_RETURN}}}{{!
+}}{{>api-call-ret-pre}}{{{API_RETURN}}}{{>api-call-ret-post}}{{!
 
-   - output state: dispatched dynamically trough API_OUTPUT_STATE, which maps
+   - output state: dispatched dynamically trough API_AFTER_STATE, which maps
      [:interface][:interface_operation] to partial name set in 'api-call-init'
    
-}}{{{API_OUTPUT_STATE}}}{{!
+}}{{>api-call-after-state-pre}}{{{API_AFTER_STATE}}}{{>api-call-after-state-post}}{{!
 
    - link to source line
-}}{{>api-call-link}}{{!
-
- END IF - interface.source.sourceModule
-
-}}{{/interface_started}}{{#interface_executing}}{{/interface_executing}}{{/interface.source.sourceModule}}{{!
-    
-    ELSE ^interface.source.sourceModule : when no source module identified
-    - interface started
-
-}}{{^interface.source.sourceModule}}{{#interface_started}}
-------------------------------------------------------------------
-{{interface.interface_operation}}: at tick '{{parsed.state_space.now}}' for step '{{{parsed.state_space.step }}}'{{!
-
-   - input state
    
-}}{{{API_INPUT_STATE}}}{{!
-
-    - API call
-    
-}}{{{API_CALL}}}{{!
-
-    - API return
-    
-}}{{{API_RETURN}}}{{!
+}}{{>api-call-link}}{{!
 
-    - output state + some extra lines to separate different api-calls
-    
-}}{{{API_OUTPUT_STATE}}}{{!
+    - output postamble
 
-    - link to source file
-    
-}}{{>api-call-link}}{{!
+}}{{>api-call-step-post}}{{!
 
-     - end interface_started
+  end of 'interface_started' 
 
 }}{{/interface_started}}{{!
 
-    END : ^interface.source.sourceModule
+No ouput here - all output generated by called partials
 
-}}{{/interface.source.sourceModule}}{{!
 Local Variables:
 require-final-newline: nil
 End:

data/mustache/api-call-post.mustache

@@ -0,0 +1,13 @@
+{{!
+
+ api-call-post.mustache: Override this template to change wrapping around api-calls
+
+ This template may access value sha1, which counts sha1sum upto (but
+ not including) this template
+
+
+}}{{!
+Local Variables:
+require-final-newline: nil
+End:
+}}

data/mustache/api-call-pre.mustache

@@ -0,0 +1,9 @@
+{{!
+
+ api-call-pre.mustache: Override this template to change wrapping around api-calls
+
+}}{{!
+Local Variables:
+require-final-newline: nil
+End:
+}}

data/mustache/api-call-ret-post.mustache

@@ -0,0 +1,9 @@
+{{!
+
+ api-call-ret-post.mustache: Override this template to change wrapping around api-calls
+
+}}{{!
+Local Variables:
+require-final-newline: nil
+End:
+}}

data/mustache/api-call-ret-pre.mustache

@@ -0,0 +1,9 @@
+{{!
+
+ api-call-ret-pre.mustache: Override this template to change wrapping around api-calls
+
+}}{{!
+Local Variables:
+require-final-newline: nil
+End:
+}}

data/mustache/api-call-step-post.mustache

@@ -0,0 +1,9 @@
+{{!
+
+ api-call-step-post.mustache: Override this template to change wrapping around api-calls
+
+}}{{!
+Local Variables:
+require-final-newline: nil
+End:
+}}

data/mustache/api-call-step-pre.mustache

@@ -0,0 +1,10 @@
+{{!
+
+ api-call-step-pre.mustache: Override this template to change wrapping around api-calls
+
+}}------------------------------------------------------------------
+{{!
+Local Variables:
+require-final-newline: nil
+End:
+}}

data/mustache/api-call.mustache

@@ -23,8 +23,8 @@
 
   API call releated stuff
   
-  :inputState : state space parsed before making API-call
-  :outputState : state space parsed after making API-call
+  :beforeState : state space parsed before making API-call
+  :afterState : state space parsed after making API-call
   :now : time when making :interface -call
 
 }}{{>api-call-main}}{{!

data/spec/cli/cli_spec.rb

@@ -51,7 +51,7 @@ describe TlaTraceFilter::Cli do
 
     describe "instance-methods" do
       subject { described_class.new }
-      %i[ add_links api_calls  ].each do |op|
+      %i[ add_links api_calls outputRendered  ].each do |op|
         specify { is_expected.to respond_to(op) }
       end
     end
@@ -68,6 +68,31 @@ describe TlaTraceFilter::Cli do
         it { expect( help ).to match /#{cmd}.*#/ }
       end 
     end
+  end
+
+  # ------------------------------------------------------------------
+  # start
+  describe ".new" do
+    let ( :start ) { described_class.new  }
+    it { expect( start ).to be_a Thor }
+    it { expect( start ).to be_a TlaTraceFilter::Cli }
+
+    describe "#outputRendered" do
+      let ( :outputRendered ) { start.outputRendered( line )  }
+      context "line not empty" do
+        let ( :line ) { "line"  }
+        before( :each )  do
+          expect( STDOUT).to receive( :puts ).with( line )
+          # expect( start).to receive( :sha1Update ).with( "#{line}\n" )          
+          expect( start).to receive( :sha1Update ).with(  line )          
+        end
+        it { outputRendered }
+      end 
+      context "line empty" do
+        let ( :line ) { ""  }
+        it { outputRendered }
+      end 
+    end 
   end 
 
 end