tla-trace-filter 0.0.3

data/spec/render/render_spec.rb

@@ -0,0 +1,177 @@
+require_relative "../spec_helper.rb"
+
+describe TlaTraceFilter::Render do
+
+  # Name defined
+  it { expect( described_class ).to be_a Class }
+
+
+  # ------------------------------------------------------------------
+  # @!group Interface
+
+  describe "module interface" do
+    describe "class-methods" do
+      subject { described_class }
+      %i[  ].each do |op|
+        specify { is_expected.to respond_to(op) }
+      end
+    end
+
+    describe "instance-methods" do
+      subject { described_class.new }
+      %i[ render render_str SOLC_LINE read_partial read_partial_file gem_location ].each do |op|
+        specify { is_expected.to respond_to(op) }
+      end
+      %i[ API_OUTPUT_STATE_INIT API_INPUT_STATE_INIT API_CALL_INIT API_RETURN_INIT API_OUTPUT_STATE API_INPUT_STATE API_CALL API_RETURN ].each do |op|
+        specify { is_expected.to respond_to(op) }
+      end
+    end
+  end
+
+  # @!endgroup
+
+  # ------------------------------------------------------------------
+  # @!group Start
+
+  describe ".start" do
+    let( :start ) { described_class.new  }
+    it { expect( start ).to be_a described_class }
+    it { expect( start ).to be_a Mustache }
+
+    describe "#returnPartials" do
+      let ( :returnPartials ) { start.returnPartials  }
+      context "default" do
+        it { expect( returnPartials ).to be_a Hash }
+        it { expect( returnPartials ).to have_key( TlaTraceFilter::Render::API_EMPTY_KEY ) }         
+        it { expect( returnPartials ).to have_key( TlaTraceFilter::Render::API_DEFAULT_KEY ) }
+        it { expect( returnPartials[TlaTraceFilter::Render::API_DEFAULT_KEY] ).to eql TlaTraceFilter::Render::API_RETURN_DEFAULT_PARTIAL}
+      end 
+    end 
+
+
+    describe "#gem_location" do
+      let ( :gem_location ) { start.gem_location(gemName)  }
+      context "no-such-gem error" do
+        let ( :gemName ) { "nosushc-gem"  }
+        it { expect{ gem_location }.to raise_error( /Unknown gemName #{gemName}/ ) } 
+      end
+      context "thor - in gemspec" do
+        let ( :gemName ) { "thor"  }
+        it { expect( gem_location ).to match /#{gemName}/ }
+      end
+      context "rspec - in Gemfile" do
+        let ( :gemName ) { "rspec"  }
+        it { expect( gem_location ).to match /#{gemName}/ }
+      end
+      context "sbuilder-eth - NOT in Gemfile - but should be installed" do
+        let ( :gemName ) { "sbuilder-eth"  }
+        it { expect{ gem_location }.to raise_error( /Unknown gemName #{gemName}/)  }         
+      end
+    end # gem_location
+
+    describe "read_gem_partial_file" do
+      let ( :read_gem_partial_file ) { start.read_gem_partial_file(gemName, templateName)  }
+      context "no-such-gem error" do
+        let ( :gemName ) { "nosushc-gem"  }
+        let ( :templateName ) { "nosuc-h-tempalte" }
+        it { expect{ read_gem_partial_file }.to raise_error( /Unknown gemName #{gemName}/ ) } 
+      end
+      context "tla-trace-filter@no-such-emplate" do
+        let ( :gemName ) { "tla-trace-filter"  }
+        let ( :templateName ) { "nosuc-h-tempalte" }
+        it { expect( read_gem_partial_file ).to eql nil }
+      end
+      context "tla-trace-filter@api-call-init.mustache" do
+        let ( :gemName ) { "tla-trace-filter"  }
+        let ( :templateName ) { "api-call-init.mustache" }
+        it { expect( read_gem_partial_file ).to be_a String }
+      end
+      context "tla-sbuilder@domains.mustache" do
+        let ( :gemName ) { "tla-sbuilder"  }
+        let ( :templateName ) { "domains.mustache" }
+        it { expect( read_gem_partial_file ).to be_a String }
+      end
+    end 
+
+    
+    describe "#render_str" do
+      let( :template ) { "data"  }
+      let( :data ) { { :val => "yksi" }  }
+      let( :render_str ) { start.render_str(template, data)  }
+      context "template=string" do
+        it { expect( render_str ).to eql template } 
+      end 
+      context "template={{:val}}" do
+        let( :template ) { "val={{val}}"  }
+        it { expect( render_str ).to eql "val=yksi" } 
+      end
+    end # render_str
+
+    describe "#read_partial_file" do
+      let ( :templateName ) { "templateName" }
+      let ( :read_partial_file ) { start.read_partial_file( path, templateName)  }
+
+      context "path not directory" do
+        let ( :path ) { "gemName"  }
+        it { expect{  read_partial_file }.to raise_error TlaTraceFilter::RenderException, /Expected '#{path}' to end/ }
+      end 
+      context "path directory not found" do
+        let ( :path ) { "dirname/"  }
+        it { expect( read_partial_file ).to eql nil }
+      end 
+      
+    end 
+
+    describe "#SOLC_LINE" do
+      
+      let ( :solc_line ) { start.render_str( "solc_line={{SOLC_LINE}}", data)}
+      context "solidity source not defined" do
+        let( :data ) {   {}   }
+        it { expect( solc_line ).to eql "solc_line=0" }
+      end
+
+
+      context "accessesing file" do
+        
+        before :each do
+          expect( File ).to receive( :exists? ).with( "src").and_return( true )
+          expect( File ).to receive( :exists? ).with( "src/file.sol").and_return( true )
+          expect( File ).to receive( :open ).with( "src/file.sol").and_return( lines )
+        end
+        
+        let( :lines ) { [ "line1\n", "line2", "line3" ]  }
+        let( :data ) do
+          {
+            :options => { "src_dir" => "src"},
+            :interface => { :source => {
+                              :sourceModule => "file.sol",
+                              :sourceLine => sourceLine,
+                            }
+                          },
+          }
+        end # let :data
+
+        context "on first line" do
+          let ( :sourceLine ) { 4  }
+          it { expect( solc_line  ).to eql "solc_line=1" }
+        end
+        context "on second line" do
+          let ( :sourceLine ) { 7  }
+          it { expect( solc_line  ).to eql "solc_line=2" }
+        end
+        context "on last line" do
+          let ( :sourceLine ) { 999  }
+          it { expect( solc_line  ).to eql "solc_line=3" }
+        end
+        
+      end
+    end
+    
+  end 
+
+  # @!endgroup
+
+  
+
+  
+end 

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+
+FIXTURE_ROOT =  File.join(File.dirname(__FILE__), "fixtures")
+
+require_relative "../lib/tla-trace-filter.rb"
+
+
+

data/spec/test_spec.rb

@@ -0,0 +1,8 @@
+require_relative './spec_helper.rb'
+
+
+describe "Rspec" do
+
+  specify { expect(1).to eql(1) }
+  
+end

data/tla-trace-filter.gemspec

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8; mode: ruby -*-
+
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+ 
+
+# http://guides.rubygems.org/make-your-own-gem/
+
+Gem::Specification.new do |s|
+
+  # version           = "0.0.1.pre"
+  version           = File.open( "VERSION", "r" ) { |f| f.read }.strip.gsub( "-SNAPSHOT", ".pre" )
+
+  s.name            = 'tla-trace-filter'
+  s.version         = version
+  s.date            = Time.now.strftime( "%Y-%m-%d" )  #'2014-09-10'
+  s.summary         = "Post process tla+tools model checker trace output"
+  s.description     = <<EOF
+
+
+   A command line filter utility for processing
+   [[http://research.microsoft.com/en-us/um/people/lamport/tla/tools.html][TLA+
+   Tools]] output resulting created when model checking
+   [[[http://research.microsoft.com/en-us/um/people/lamport/tla/book.html][TLA+
+   language]]] formal model generated using
+   [[https://github.com/jarjuk/tla-sbuilder][sbuilder]] -tool.
+
+
+EOF
+
+  s.authors         = ["jarjuk"]
+  s.files           = ["README.org", "VERSION", "#{s.name}.gemspec" ]  | Dir.glob("lib/**/*") |Dir.glob("mustache/**/*") | Dir.glob("spec/**/*")  
+  s.require_paths   = [ "lib" ]
+  s.executables     = [ "tla-trace-filter.rb" ]
+  s.license         = 'MIT'
+
+  s.required_ruby_version = '~> 2', ">=2.3"
+
+  s.add_runtime_dependency 'tla-sbuilder', '~>0.3', ">0.3.7"  
+  s.add_runtime_dependency 'thor', '~>0.19', ">=0.19.1"
+  s.add_runtime_dependency 'treetop', '~>1.6', ">=1.6.3"  
+  s.add_runtime_dependency 'mustache', '~>1.0', ">=1.0.3"
+
+
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: tla-trace-filter
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- jarjuk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tla-sbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 0.3.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 0.3.7
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: treetop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.3
+- !ruby/object:Gem::Dependency
+  name: mustache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+description: |2+
+
+
+     A command line filter utility for processing
+     [[http://research.microsoft.com/en-us/um/people/lamport/tla/tools.html][TLA+
+     Tools]] output resulting created when model checking
+     [[[http://research.microsoft.com/en-us/um/people/lamport/tla/book.html][TLA+
+     language]]] formal model generated using
+     [[https://github.com/jarjuk/tla-sbuilder][sbuilder]] -tool.
+
+
+email: 
+executables:
+- tla-trace-filter.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- README.org
+- VERSION
+- bin/tla-trace-filter.rb
+- lib/cli/cli.rb
+- lib/filter/filter.rb
+- lib/parser/grammar.treetop
+- lib/parser/node_extensions.rb
+- lib/parser/parser.rb
+- lib/render/render.rb
+- lib/tla-trace-filter.rb
+- lib/util/logger.rb
+- mustache/add-links-interface.mustache
+- mustache/add-links-state-dump.mustache
+- mustache/add-links-transition.mustache
+- mustache/add-links.mustache
+- mustache/api-call-default.mustache
+- mustache/api-call-init.mustache
+- mustache/api-call-input.mustache
+- mustache/api-call-link.mustache
+- mustache/api-call-main.mustache
+- mustache/api-call-output.mustache
+- mustache/api-call-return.mustache
+- mustache/api-call.mustache
+- spec/cli/cli_spec.rb
+- spec/filter/filter_spec.rb
+- spec/fixtures/interfaces.yaml
+- spec/fixtures/model.tla
+- spec/fixtures/trace.txt
+- spec/parser/node_extensions_spec.rb
+- spec/parser/parser_spec.rb
+- spec/render/render_spec.rb
+- spec/spec_helper.rb
+- spec/test_spec.rb
+- tla-trace-filter.gemspec
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2'
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Post process tla+tools model checker trace output
+test_files: []