tla2dot 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 355e281670cfc51d37cfc795e160ba73e3977c11
+  data.tar.gz: 3432ad2922ea1f5db216fa66c4d12cea75a9ee52
+SHA512:
+  metadata.gz: ed786e9c8da322f234935eeb761d7b7d4f654db37285f5ca6447528fd1e9e2093d0f575928dbd2c5cba40b06025759a098bb353dd000044f3c1e24d3a02a2793
+  data.tar.gz: 82990ce4e46ef527a7e23bc8369b7817812ae690d27a42e7f5252135ca6f3efcfcbc39fb04e0e19313d1e6407f810fc777ca1979210422b4559d4b0c74f610f9

data/README.md

@@ -0,0 +1,125 @@
+<link href="../site.css" rel="stylesheet"></link>
+[Up](../index.php) [Readme](README.html) [Releases](RELEASES.html) [Todo](TODO.html)
+
+
+# tladot - Utility to convert tlc/tlaplus state space to graphviz - $Release:0.0.3$
+
+A utility to convert state space dump created by [patched](https://gist.github.com/4359ee94e58d25817a95) TLC tool in
+[TLA toolbox](http://research.microsoft.com/en-us/um/people/lamport/tla/toolbox.html)
+of
+[tlaplus](http://research.microsoft.com/en-us/um/people/lamport/tla/tla.html)
+to [graphviz](www.graphviz.org) dot format.
+
+
+## Usage
+
+## Obtain the patched TLC version
+
+Clone github model
+
+
+     https://github.com/jarjuk/tla2dot
+
+and change the working directory
+
+     cd tla2dot
+
+### Running the patced TLC version to create state dump
+
+Create a TLA model in directory `model` 'in files `setup.tla`,
+`setup.cfg`, and `model.tla`
+
+Set up  environment  CP to poinnt the patched tla2tools.jar in directory java
+
+	export CP=$(pwd)/java/org.lamport.tlatools-1.0.1-SNAPSHOT.jar
+
+Create a `../examples/customer1-patched.dump setup` for the TLA model using the command
+
+	(cd model; java -cp $CP tlc2.TLC -dump ../examples/customer1-patched.dump setup)
+
+The [patch](https://gist.github.com/4359ee94e58d25817a95) adds fingerprint
+and transition information to the dump file created using [`-dump` option](http://research.microsoft.com/en-us/um/people/lamport/tla/current-tools.pdf).
+
+
+For example, difference of [non-patched dump file](examples/customer1-orig.dump), and
+the [patched dump file](examples/customer1-patched.dump) for a TLA model may show
+
+```
+1c1
+< State 1:
+---
+> State 1/-2710668386619955114:
+25c25
+< State 2:
+---
+> State 2/-2906287262858016143:
+60c60,62
+< State 3:
+---
+> Transition -2710668386619955114 --> -2906287262858016143
+> 
+> State 3/-5306425081709262628:
+84c86,88
+< State 4:
+---
+> Transition -2906287262858016143 --> -5306425081709262628
+> 
+> State 4/3141097224850855796:
+95a100,103
+> 
+> Transition -5306425081709262628 --> 3141097224850855796
+> 
+> Transition 3141097224850855796 --> 3141097224850855796
+```
+
+### Create dot file
+
+To create a dot file for a patched state-dump in `examples/customer1-patched.dump` run
+
+    bin/tla2dot.rb graph examples/customer1-patched.dump  >tmp/dump.dot
+
+and to convert it to a graph
+
+    dot -T svg tmp/dump.dot >tmp/dump.svg
+
+Command `graph` takes in a list of variables to include in state
+nodes. For example, in the example model show variables `now,step` use the command
+
+    bin/tla2dot.rb graph examples/customer1-patched.dump now,step  >tmp/dump.dot
+
+State identity is referenced using variable name `ID`.
+
+
+	bin/tla2dot.rb graph examples/customer1-patched.dump ID,now,step  >tmp/dump.dot
+
+and all variables can be show using value `TRUE`
+
+	bin/tla2dot.rb graph examples/customer1-patched.dump TRUE  >tmp/dump.dot
+
+
+ 
+## <a id="INSTALLATION">Installation</a>
+
+Add following lines to `Gemfile`
+
+    source 'https://rubygems.org'
+	gem 'tla2dot'
+
+and to get help on using tla2tools
+
+	bundle exec tla2dot.rb help
+
+	
+## Development
+
+See [RELEASES](RELEASES.md)
+
+	
+## License 
+
+MIT
+
+
+
+
+

data/bin/tla2dot.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/cli/cli.rb"
+
+TLA2DOT::Cli.start

data/lib/cli/cli.rb

@@ -0,0 +1,114 @@
+
+require 'thor'
+require_relative '../tla2dot'
+
+module TLA2DOT 
+
+  class Cli < Thor
+
+    
+    include TLA2DOT::Utils::MyLogger    # mix logger
+    PROGNAME = "main"                   # logger progname
+
+    TEMPLATES= [ "mustache/" ]          # default locations for templates
+    DEAFAULT_TEMPLATE="root"            # default starting point for template rendering
+
+
+    # ------------------------------------------------------------------
+    # make two thor tasks share options?
+    # http://stackoverflow.com/questions/14346285/how-to-make-two-thor-tasks-share-options
+
+    class << self
+      def add_shared_option(name, options = {})
+        @shared_options = {} if @shared_options.nil?
+        @shared_options[name] =  options
+      end
+
+      def shared_options(*option_names)
+        option_names.each do |option_name|
+          opt =  @shared_options[option_name]
+          raise "Tried to access shared option '#{option_name}' but it was not previously defined" if opt.nil?
+          option option_name, opt
+        end
+      end
+    end
+
+    def initialize(*args)
+      super
+      @logger = getLogger( PROGNAME, options )
+    end
+
+    # ------------------------------------------------------------------
+
+    class_option :log, :aliases => "-l", :type =>:string, :default => nil, 
+                 :enum => [ "DEBUG", "INFO", "WARN", "ERROR" ],
+                 :desc => "Set debug level "
+
+    class_option :log_file, :type =>:string, :default => "tla2dot.log",
+                 :desc => "Set file for log output"
+
+    # ------------------------------------------------------------------
+    # shared options
+
+    add_shared_option :templates,
+                      :aliases => "-t",
+                      :type => :array,
+                      :default =>  TEMPLATES,
+                      :desc => "Array of directory paths (ending with slash '/' char e.g. 'mustache/') of Gem names (optionally with version constraint e.g. 'tla2dot,~>0.0.1') holding mustache templates"
+
+
+
+    # ------------------------------------------------------------------
+    # actionp 'test'
+    desc :test, "demo remove"
+    def test()
+      puts "testing works"
+    end
+
+    # ------------------------------------------------------------------
+    # action 'graph'
+
+    desc "graph <state-dump> <variables>", "Create graph for <state-dump> showing variables"
+
+    long_desc <<-LONGDESC
+
+    <variables>   : TRUE    => show all variables
+                    FALSE   => show no variables
+                    comma-serated-list => show variables, special value ID shows 
+                    node identifier
+    LONGDESC
+    
+
+    shared_options :templates
+    
+    def graph( state_dump, variables=[] )
+      @logger.info( "#{__method__} starting" )
+
+      @logger.debug( "#{__method__} variables=#{variables}" )
+      if ( variables == "TRUE" )
+        variables = true
+      elsif ( variables == "FALSE" )
+        variables = false
+      elsif variables.kind_of?( String )
+        variables = variables.split( "," )
+      end
+
+      # Read files && parse to graph
+      dump_lines =  File.readlines( state_dump ).each{ |l| l.chomp! }
+      graph = Tla2DotParser.new( options ).parse( dump_lines, variables )
+      @logger.info( "#{__method__} parsed #{graph.nodes.size} nodes" )
+            
+
+      # Cretae dot source
+      template_file = DEAFAULT_TEMPLATE
+      dot_source = TLA2DOT::Template.new( options ).to_str( template_file, graph )
+
+      # Ouptut dot source to stdout
+      puts dot_source
+
+    end
+    
+    
+  end # class Thor
+  
+end