sbuilder-al 0.0.8

data/lib/translator/translator.rb

@@ -0,0 +1,210 @@
+require 'yaml'
+module Sbuilder
+  module Al
+    module Translator
+
+      # not catched
+      class TranslatorException < Sbuilder::Al::Util::AlException; end
+      # to be catched
+      class TranslatorError < Sbuilder::Al::Util::AlError; end
+
+
+      # Visitor implementation
+      # {Sbuilder::Al::Translator::Translator#translate} using
+      # configuration {Sbuilder::Al::Translator::Translator#rules}
+      class Translator
+
+        # Include common meta services e.g. 'attribute_accessor'
+        include Sbuilder::Al::Meta
+
+        # @!attribute rules controlling visitor and translation
+        # * key [Symbol] rule name
+        #
+        # * value [Hash] rule definition 
+        #     * :debug [Boolean] true if debug rule, optional
+        #     * :navigations [Array<Hash>] collect ctx[:navigationResults]
+        #           * :iterate [Boolean] iterate current node keys
+        #             to apply :rule, if true 
+        #           * :navigate [Symbol] if given lookup :navigate key
+        #              in current model node to appply :rule
+        #           * :rule [Symbol|lambda] rule to apply on model  node
+        #              found using :iterate or :navigate, apply to current
+        #              node if both :itarate and :navigate missing,
+        #              - symbol:  result in ctx[:navigationResults][rule]
+        #              - lambda: returns Array [key,rule] to produce result
+        #                in ctx[:navigationResults][key] using rule
+        #     * :translator [Lambda(ctx)] lambda function producing Array
+        #              result into  ctx[:navigationResults]
+        attribute_accessor :rules
+
+        # @!group Constructors
+
+        def initialize( rules={} )
+          self.rules = rules
+        end
+
+        # Default constructor to initialize functional object with
+        # default values
+        #
+        # @return [Sbuilder::Al::Translator::Translator] translator
+        # object
+        def self.start( rules )
+          Translator.new( rules )
+        end
+
+        # @!endgroup    
+
+
+        # Vistit and traslate 'node' starting with 'rules[rule]'
+        # (default rule = 'node.type').
+        #
+        # @see #rules for tranlate rules
+        #
+        # @param rule [Symbol] apply 'rules[rule]' on 'node'
+        #
+        # @param node [Array<Hash>] node to transform
+        #   Sbuilder::Al::Model::Root objects to translate
+        #
+        # @param ctx [Hash] context collected so far before visiting
+        # current 'node', default {}
+        # 
+        #
+        # @return [String] result of visiting/translating 'node' and
+        # using 'rule'
+        #
+        def translate( node, rule=node.type, ctx={} )
+
+          # @logger.debug "#{__method__}: node=#{node}, rule=#{rule}, ctx.keys=#{ctx.keys.join(',')}" if @logger.debug?
+          # @logger.debug "#{__method__}: node=#{node}, ctx=#{ctx.to_yaml}" if @logger.debug?          
+          # Lookup 'rule' from rules
+          raise TranslatorException, "Configuration error, missing rule '#{rule}' - knonwn rules: #{rules.keys}" if rules[rule].nil?
+          raise TranslatorException, "Configuration error, node empty #{node.to_s}" if node.nil? 
+          # raise TranslatorException, "Configuration error, node empty #{node.to_s}" if node.nil? or node == {}          
+
+          if rules[rule][:debug]
+            puts <<-EOS.unindent
+            ------------------------------------------------------------------
+            #{rule}: 
+
+            node=#{node}
+
+            ctx keys=#{ctx.keys.join(',')}
+
+            ctx=#{ctx.to_yaml}
+            EOS
+          end
+
+          # rule -name property in ctx holds current node, restored later
+          prev_rule = ctx[rule]
+          ctx[rule] = node;
+
+          # Collect 'navigationResults' to hash with key as
+          # 'navigation[:rule] and values with the result of
+          # translating the nodes navigated to navigation[:navigate]
+          navigationResults = {}
+          
+          # translate :navigations (before translating current node)
+          navigations = rules[rule][:navigations] ? rules[rule][:navigations] : []
+          navigations = [ navigations ] unless navigations.is_a?( Array )
+          navigations.each do |navigation|
+
+            # Validate rule configration
+            raise TranslatorException, "Error in rule #{navigation} -missing rule " if navigation[:rule].nil? 
+
+            if navigation[:navigate].nil? &&  navigation[:iterate].nil?
+              # no change in node - run a new rule on current node
+              nodesToNaviagate = [node]
+            elsif navigation[:navigate]
+              navigateSteps = navigation[:navigate].is_a?(Array ) ? navigation[:navigate] : [ navigation[:navigate] ]
+              # real navigation: nodesToNaviagate must exist
+              begin
+                # walk array of navigation[:navigate] -steps
+                currentNode = node
+                navigateSteps.each do |navigateStep|
+                  # Hash, Model: access by ':navigate' key , Struct: send message ':navigate' message
+                  # puts( "currentNode==#{currentNode}")
+                  if currentNode.respond_to?( :"[]" ) && !currentNode.is_a?( String )
+                    currentNode = currentNode[navigateStep]
+                  elsif currentNode.respond_to?( navigateStep )
+                    currentNode = currentNode.send( navigateStep )
+                  else
+                    raise TranslatorError, "Navigation '#{navigateStep}' in node '#{currentNode}' failed"
+                  end
+                  #currentNode = !currentNode.is_a?( Struct )  ? currentNode[navigateStep] : currentNode.send( navigateStep )
+                end
+                nodesToNaviagate = currentNode
+                
+              rescue NameError => err
+                raise $!, <<-EOS,
+                         #{$!}
+
+                         Error navigating to '#{navigation[:navigate]}' in node #{node}.
+
+                         EOS
+                $!.backtrace
+              end
+              raise TranslatorError, "Navigation '#{navigation[:navigate]}' in node '#{node}' failed" if nodesToNaviagate.nil?
+              nodesToNaviagate = [nodesToNaviagate] unless nodesToNaviagate.is_a?(Array)
+            elsif navigation[:iterate]
+              # NB {} -node --> no iteration
+              nodesToNaviagate = node.keys.map { |key| node[key] }
+            # raise TranslatorError, "Navigation iterator '#{navigation[:iterate]}' in node '#{node}' failed" unless nodesToNaviagate.any?
+            else
+              raise TranslatorException, "Error in rule #{navigation} " if navigation[:rule].nil? 
+            end
+            
+
+            # nextRule possibly defined using a lamdba
+            traslationKey, nextRule = navigation[:rule].respond_to?( :call ) ? navigation[:rule].call( node ).flatten : [ navigation[:rule], navigation[:rule] ]
+            navigationResults[ traslationKey ] = 
+              nodesToNaviagate.map do |nodeToNaviagate|
+              begin
+                # run translation
+                nextTranslate = nextRule ? translate( nodeToNaviagate, nextRule, ctx ) : []
+              rescue TranslatorError => e
+                msg = <<-EOS
+                #{e.message} 
+
+                within
+
+                node: #{node}
+                rule: #{rule} 
+                ctx: #{ctx.to_yaml} 
+                EOS
+
+                raise e.class.new,  msg, e.backtrace
+                
+              end
+              nextTranslate
+            end
+            # puts "navigationResults=#{navigationResults}"
+
+          end # navigations.each 
+
+          # translate current node
+          if  rules[rule][:translator] 
+            ret = rules[rule][:translator].call( ctx.merge( { :navigationResults => navigationResults  } ))
+            if rules[rule][:debug]
+              puts <<-EOS.unindent
+              
+              ----->  translation
+              
+              #{ret}
+              EOS
+
+            end
+            
+          end
+          
+          # out of scope
+          # ctx.delete(ctx[rule])
+          ctx[rule] = prev_rule
+          ret
+          
+        end
+        
+      end
+      
+    end
+  end
+end

data/lib/util/exception.rb

@@ -0,0 +1,16 @@
+module Sbuilder
+  module Al
+    module Util
+
+      # Exception class not catched
+      class AlException < Exception;
+        include Sbuilder::Al::Meta
+      end
+
+      # Application error, should be catched
+      class AlError < AlException; end      
+      
+    end
+  end
+end
+      

data/lib/util/logger.rb

@@ -0,0 +1,90 @@
+module Sbuilder
+  module Al
+    module Util
+
+      require 'logger'
+
+      # see http://hawkins.io/2013/08/using-the-ruby-logger/
+
+      module MyLogger
+
+        include Sbuilder::Al::Meta
+        addService( :hello ) do |what|
+          "Hello #{:what}"
+        end
+        
+
+        # no logging done
+
+        class NullLoger < Logger
+          def initialize(*args)
+          end
+
+          def add(*args, &block)
+          end
+
+          def debug?
+            false
+          end
+        end
+
+        @@logfile = nil                          # absolute path to log file
+        LOGFILE="sbuilder-al.log"
+
+        def logfile( options ) 
+          return @@logfile if @@logfile
+          @@logfile = options[:logfile] || File.join( Dir.getwd, LOGFILE )
+          @@logfile
+        end
+
+        def getLogger( progname=nil, options={} )
+
+
+          progname = self.class.name.split('::').last if progname.nil?
+          level = get_level( options )
+
+          if level.nil? 
+
+            return NullLoger.new 
+
+          else
+            
+            logger = Logger.new( logfile(options) )
+            logger.level=level
+            logger.progname = progname
+            return logger
+
+          end
+
+        end # getLogger
+        
+
+        # ------------------------------------------------------------------
+        private
+
+        def get_level( options ) 
+
+          level_name = options && options[:log] ? options[:log] : ENV['LOG_LEVEL']
+
+          level = case  level_name
+                  when 'warn', 'WARN'
+                    Logger::WARN
+                  when 'info', 'INFO'
+                    Logger::INFO
+                  when 'debug', 'DEBUG'
+                    Logger::DEBUG
+                  when 'error', 'ERROR'
+                    Logger::ERROR
+                  else
+                    nil
+                  end
+
+          return level
+        end
+
+      end
+      
+    end
+  end
+end
+      

data/lib/util/module.rb

@@ -0,0 +1,16 @@
+module Sbuilder
+  module Al
+
+    ## 
+    # Generic helpers and utilities for Sbuilder::Al
+    #
+    # Exception: {Sbuilder::Al::Exception} Exception hierarchy
+    # starting point to {Sbuilder::Al}
+    module Util
+    end
+  end
+end
+
+require_relative( "exception" )
+require_relative( "logger" )
+require_relative( "script_eval" )

data/lib/util/script_eval.rb

@@ -0,0 +1,41 @@
+module Sbuilder
+  module Al
+    module Util
+
+      class ScriptException < Sbuilder::Al::Util::AlException; end
+      class ScriptError < Sbuilder::Al::Util::AlException; end      
+      # Evaluate Ruby script 
+      #
+      class ScriptEval
+
+        # @param filename [String] ruby script to evaluate
+        #
+        # @param context [Object] available for the Ruby scripts being
+        # evaluated
+        #
+        # @return [Object] return from ruby script
+        def self.script_eval( filename, context=nil )
+          begin
+            # applicationConfiguration can  be accessed in 'filename' in variable 'context'
+            # context = appContext
+            proc = Proc.new {}
+            ret = eval( File.read(filename), proc.binding, filename )
+            return( ret )
+          rescue Errno::ENOENT => err
+            msg = <<-HERE
+            #{err}: when trying to evaluate Ruby script in file #{filename}
+            HERE
+            raise ScriptError,  msg, err.backtrace
+          rescue SyntaxError => err
+            msg = <<~HERE
+            #{err}: when evaluating Ruby script in file #{filename}
+            #{File.read(filename)}
+            HERE
+            raise ScriptError,  msg, err.backtrace
+          end
+        end
+      end
+    end
+  end
+end
+

data/sbuilder-al.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            = 'sbuilder-al'
+  s.version         = version
+  s.date            = Time.now.strftime( "%Y-%m-%d" )  #'2014-09-10'
+  s.summary         = "API language interface to tla-sbuilder"
+  s.description     = <<EOF
+
+  API language interface to tla-sbuilder. Uses API Loader Extension
+  Point and Snippet Loader Extension Point in tla-sbuilder tool.
+
+  tla-sbuilder is a tool to generate runnable formal models in TLA+ language
+  http://research.microsoft.com/en-us/um/people/lamport/tla/book.html
+  Generated formal models can be verified using TLA+ Tools
+  http://research.microsoft.com/en-us/um/people/lamport/tla/tools.html.
+  
+EOF
+  s.authors         = ["jarjuk"]
+  s.files           = ["README.org", "VERSION", "#{s.name}.gemspec", "design/al-language-bnf.org" ] |  Dir.glob("lib/**/*")  
+  s.require_paths   = [ "lib" ]
+  s.executables     = [ ]
+  s.license         = 'MIT'
+
+  s.homepage              = "https://github.com/jarjuk/sbuilder-al"
+  
+  s.required_ruby_version = '~> 2'
+
+  s.add_runtime_dependency      "docile", '~>1.1', ">=1.1.5"
+  s.add_runtime_dependency 'mustache', '~>1.0', ">=1.0.3"
+  s.add_runtime_dependency      "tla-sbuilder", '~>0.3', ">=0.3.5"
+  s.add_runtime_dependency      "tla-parser-s", '~>0.2', ">=0.2.5"    
+
+
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: sbuilder-al
+version: !ruby/object:Gem::Version
+  version: 0.0.8
+platform: ruby
+authors:
+- jarjuk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: docile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.5
+- !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
+- !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.5
+  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.5
+- !ruby/object:Gem::Dependency
+  name: tla-parser-s
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.5
+description: "\n  API language interface to tla-sbuilder. Uses API Loader Extension\n
+  \ Point and Snippet Loader Extension Point in tla-sbuilder tool.\n\n  tla-sbuilder
+  is a tool to generate runnable formal models in TLA+ language\n  http://research.microsoft.com/en-us/um/people/lamport/tla/book.html\n
+  \ Generated formal models can be verified using TLA+ Tools\n  http://research.microsoft.com/en-us/um/people/lamport/tla/tools.html.\n
+  \ \n"
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.org
+- VERSION
+- design/al-language-bnf.org
+- lib/meta/etc.rb
+- lib/meta/meta.rb
+- lib/model/api.rb
+- lib/model/builders.rb
+- lib/model/constants.rb
+- lib/model/model.rb
+- lib/model/module.rb
+- lib/plugin/controller.rb
+- lib/plugin/module.rb
+- lib/plugin/plugin.rb
+- lib/sbuilder-al.rb
+- lib/translator/alrules.rb
+- lib/translator/module.rb
+- lib/translator/producer.rb
+- lib/translator/renderer.rb
+- lib/translator/sexp.rb
+- lib/translator/tlagenerator.rb
+- lib/translator/translator.rb
+- lib/util/exception.rb
+- lib/util/logger.rb
+- lib/util/module.rb
+- lib/util/script_eval.rb
+- sbuilder-al.gemspec
+homepage: https://github.com/jarjuk/sbuilder-al
+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'
+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: API language interface to tla-sbuilder
+test_files: []