tla-sbuilder 0.2.2 → 0.3.4

data/lib/cli/cli-text.rb

@@ -14,11 +14,82 @@ module Sbuilder
     #            className: <class name>
     #            configuration:
     #                   <configuration-value>
+    #            objects: 
+    #                   <named-object>
+    #
+    # WHERE <named-object> is a hash
+    #
+    #                  - objectName:
+    #                    configuration:
+    #                        <configuration-value>
+    #
+    #
+    # COMMENTS:
+    # - `objects` -property is optional
+    # - `objectName` must be unique
+    # - if 'className' is used, must also give 'gem'
     #
-    # <gem-name>: gem name to require
     # <class name>: name of interface loader in 'type' property in 'interfaces' array
+    # <gem-name>: gem name to require, require only if <class name> not defined
     # <configuration-value>: a (hash) value passed to 'className'::configure' -method
+    # or `className.new#configure` method for objects
+    #
+    #
+
+    extend:
+      loaders: 
+
+         # - className: Sbuilder::SnippetLoaderSimple
+         #   configuration:
+         #        src_dir: src/pet
+
+    EOS
+
+    SBUILDER_SNIPPETS = <<-EOS.unindent    
+
+    # Load snippets to sbuilder code repository
+    #
+    # SCHEMA:
+    #
+    # 
+    # snippets:
+    # - <snippet-loader>
+    # - <snippet-loader>
+    # - <snippet-loader>
+    #
+    #   <snippet-loader>: an array element with the following mandatory properties
+    #
+    #   className:  name of the snippet loader object, 
+    #               className used in 'extend.loaders'
+    #   objectName: name of the class of snippet loader object, 
+    #               references 'objectName' in 'extend.loaders.objects',
+    #               must give either 'className' or 'objectName'
+    #   snippets:  array of snippet load definitions, 
+    #              content of the array varies for classNames
+    #
+    # 
+    #   Special metatypes:
+    #     - service_implementation: defines a macro to call for the service
+    #     - service_completion: defines a macro to call when service
+    #       finishes. Intended use is check service status, and implementation
+    #       transaction semantics.
     #
+    #  Example for className: Sbuilder::SnippetLoaderSimple 
+    # 
+    #  className: Sbuilder::SnippetLoaderSimple 
+    #  configuration:
+    #     metatypes:
+    #        code: Example code
+    #  snippets:
+    #    - metatype: service_implementation
+    #      appName: "/max2(post)"
+    #      file: max2_post.tla
+    #    - metatype: service_implementation
+    #      appName: "/dummy(post)"
+    #      file: dummy_post.tla
+    #    - metatype: code
+    #      appName: max2
+    #      file: max2.tla
     EOS
     
     SBUILDER_INVARIANTS = <<-EOS.unindent
@@ -64,24 +135,47 @@ module Sbuilder
     # SCHEMA:
     # 
     # interfaces: 
-    #  - type: <interface loader name>
+    #  - 
+    #    className: <class name>
+    #    configuration: <configuration-value>
+    #    objectName: <object name>
     # 
     #    file: <file name in cnf-dir>
     #    infrastructureServices: <is infrastructureService>
+    #    interfaceServices: <is interfaceService>
     #    url:  <path or url>
     #    cache: <cache file path>
     #
-    # <interface loader name>: name of interface loader, 
-    #                          valid values:  'swagger' and className values 
-    #                          given in 'extend.loaders' array
-    # <is infrastructureService>: true or false (default false)
+    # WHERE
+    #
+    #   <class name>:  name of the snippet loader object, 
+    #               className used in 'extend.loaders'
+    #
+    #   <object name>: name of the class of api loader object, 
+    #               references 'objectName' in 'extend.loaders.objects',
+    #               
+    #
+    # <configuration-value>: a (hash) value passed to 'className'::configure' -method
+    # or `className.new#configure` method for objects
+    #                    
+    #
+    # <is infrastructureService>: true generates the possibility for a
+    # service set return response using 'InfrastructureServiceResponse' operator, and 
+    # the caller to access response status ( operator 'InfrastructureServiceGetStatus')
+    # and response data ( operator #InfrastructureServiceGetResponse'), optional, defaults false
+    #
+    # <is interfaceService>: true generates interface process for the interface, which
+    # environment can call (see 'step-extension', optional, defaults true
+    #
     # <file name in cnf-dir> : file name in cnf-directory
     # <path or url>          : path relative to cwd, or http url, 
     #                          e.g https://cdn.rawgit.com/swagger-api/swagger-spec/master/examples/v2.0/yaml/petstore-expanded.yaml
     # <cache file path>      : path relative to cwd, where interface file is cached
     # 
     # COMMENTS:
-    # - give 'file' xor 'url' property
+    # - must give either 'className' or 'objectName'
+    # - when 'className' given 'configuration' allowed
+    # - must give either  'file' or 'url' 
     # - property 'cache' optional, useful when http access slow
     # - infrastructureServices are modelled as procedures, which may modify state
     #   or return values used in 'normal' interfaces
@@ -170,17 +264,41 @@ module Sbuilder
     #      cardinality: <cardinality>
     #      values:
     #         - <str-value>
+    #      type: <type-def>
+    #      range: <range-def>
     #
     # 
     # <domain-name>: domain name resolved
     # <cardinality>: integer value for domain, default 1
     # <str-value>: fixed value for domain
+    # <type-def>: Int|BOOLEAN
+    # <rannge-def>: [low,high]
     #
     # COMMENTS:
-    # - give 'cardinality' xor 'values' property
+    # - give one of 'cardinality',  'values','type', 'range'
     #
 
     EOS
+
+    EXTENSION_HEADER_PREFS = <<-EOS.unindent
+
+    # Modify setup preference
+    #
+    # SCHEMA:
+    # - preferences-extension:
+    #      - preferences: 
+    #           <hash-values>
+    #
+    # <hash-values>  : optional properties overriding preferences given in 'sbuilder.yaml'
+    #
+    # 
+    # Example
+    #      - preferences-extension:
+    #           preferences: 
+    #             debug-output: true
+    #
+    EOS
+
     
     EXTENSION_HEADER_IF = <<-EOS.unindent
 
@@ -235,6 +353,7 @@ module Sbuilder
 
     
     RESOLVER_HEADER = <<-EOS.unindent
+
     # Example of an YAML resolver
     #
     # Contains array of hashes

data/lib/cli/cli.rb

@@ -8,7 +8,7 @@ module Sbuilder
 
     
     include Sbuilder::Utils::MyLogger    # mix logger
-    PROGNAME = "main"                   # logger progname
+    PROGNAME = nil                       # progname for logger default class name
 
     VERSION_BANNER =  <<-EOS.unindent
     #{File.basename $0} - #{Sbuilder::version}   
@@ -50,6 +50,11 @@ module Sbuilder
                  :enum => [ "DEBUG", "INFO", "WARN", "ERROR" ],
                  :desc => "Set debug level "
 
+    class_option :parser_debug, :type =>:string, :default => "ERROR", 
+                 :enum => [ "DEBUG", "INFO", "WARN", "ERROR" ],
+                 :desc => "Set debug level for parser"
+
+    
     class_option :logfile, :type =>:string,
                  :default => File.join(Dir.getwd, Sbuilder::Constants::LOGFILE), :desc => "Set file for log output"
 
@@ -159,6 +164,7 @@ module Sbuilder
     shared_options :templates
     shared_options :default_templates    
     shared_options :verbosity
+    shared_options :src_dir
     shared_options :cnf_dir
     shared_options :cnf_file
     # shared_options :src_dir
@@ -169,14 +175,40 @@ module Sbuilder
            :desc => "Filter files TLA+ specification code, false-> no filter->include all snippets"
     
     
-    option :filter_list, :aliases => "-F", :type => :string, :default => nil,
-           :desc => "List of files to include in TLA+ specification code"
-    
     def generate( setupDirectory=nil)
       ctrl = getController( options )
       ctrl.setup( setupDirectory )
     end
 
+    # ------------------------------------------------------------------
+    # symbols
+    desc "documents symbols", "Document symbols"
+    
+    shared_options :verbosity
+    shared_options :cnf_dir
+    shared_options :verbosity
+    shared_options :default_templates    
+    shared_options :cnf_dir
+    shared_options :templates
+    def symbols( what=nil )
+
+      controller = getCtrl
+      controller.load
+      
+      validateWhats( what, getSetupNames(controller) ) if what
+      
+      controller.processSetups( what ) do |setupName, setupConf, possibilities|
+        st = controller.getSymbolTable
+        puts <<-EOS.unindent 
+            #{setupName}: #{setupConf['desc']}
+            #{st.table.keys.map { |metatype| { metatype => st.getMetaTypeDescription(metatype), :maps=>st.table[metatype] } } .to_yaml}
+        EOS
+        
+      end # processSetups
+      
+
+    end
+
     # ------------------------------------------------------------------
     # list
 
@@ -193,7 +225,9 @@ module Sbuilder
 
     desc "document [setup]", "Document configuration for all setups or for the given setup"
     shared_options :verbosity
+    shared_options :default_templates    
     shared_options :cnf_dir
+    shared_options :templates
     def document( what=nil )
       controller = getCtrl
       controller.load
@@ -207,10 +241,19 @@ module Sbuilder
           - #{invariant[:name]}: #{invariant[:desc]}
         EOS
       end
-      puts "SETUPS:"      
+      setupsOutput=false
       controller.processSetups( what ) do |setupName, setupConf, possibilities|
         assumptions = controller.getSetupAssumptionList( setupConf )
-        puts <<-EOS.unindent
+        
+        if !setupsOutput
+          # Output SETUPS -header just before outputting first setup
+          # configuration. This prevents any initialization output
+          # from mixing between SETUPS header and setups data.
+          setupsOutput =TRUE
+          puts "SETUPS:"
+        end
+        
+        puts <<-EOS.unindent 
         - #{setupName}: #{setupConf['desc']}
             - possibilities: #{(setupConf['possibilities'] || [] ).join( ' ' )}
             - assumptions: #{assumptions.join( ' ' )}

data/lib/sbuilder.rb

@@ -2,16 +2,21 @@
 require_relative "utils/hash_inject"
 require_relative "utils/string_inject"
 
+require_relative "utils/powerset"
 require_relative "utils/version"
 require_relative "utils/logger"
-require_relative "utils/cache_lines"
+require_relative "utils/fileio"
 require_relative "utils/netio"
+require_relative "utils/validate"
 
+require_relative "sbuilder/facade/facade_constants.rb"
 require_relative "sbuilder/constants.rb"
 
 require_relative "sbuilder/exception.rb"
 
 require_relative "sbuilder/domain.rb"
+require_relative "sbuilder/domain_type.rb"
+require_relative "sbuilder/domain_range.rb"
 require_relative "sbuilder/domain_value.rb"
 require_relative "sbuilder/domain_cardinality.rb"
 
@@ -21,9 +26,11 @@ require_relative "sbuilder/parameter_dom.rb"
 require_relative "sbuilder/parameter_ref.rb"
 
 
+require_relative "sbuilder/facade/param_set_root.rb"
 require_relative "sbuilder/param_set.rb"
 require_relative "sbuilder/param_set_db.rb"
 require_relative "sbuilder/param_set_def.rb"
+require_relative "sbuilder/param_set_def_func.rb"
 require_relative "sbuilder/param_set_if.rb"
 require_relative "sbuilder/param_set_step.rb"
 
@@ -37,19 +44,35 @@ require_relative "sbuilder/resolver.rb"
 require_relative "sbuilder/resolver_loader.rb"
 require_relative "sbuilder/resolver_loader_yaml.rb"
 
-
+require_relative "sbuilder/symbol_table.rb"
 require_relative "sbuilder/model.rb"
+require_relative "sbuilder/controller_utils.rb"
+
 
+require_relative "sbuilder/setup_loader.rb"
+require_relative "sbuilder/setup_loader_env.rb"
+require_relative "sbuilder/setup_loader_pref.rb"
+require_relative "sbuilder/extension_loader_step_generator.rb"
 require_relative "sbuilder/extension_loader.rb"
 
 require_relative "sbuilder/factory.rb"
 require_relative "sbuilder/controller.rb"
 
+require_relative "sbuilder/facade/loader_plugin_root.rb"
+require_relative "sbuilder/facade/snippet_loader_plugin_mixer.rb"
+require_relative "sbuilder/facade/snippet_loader_plugin.rb"
+require_relative "sbuilder/facade/api_loader_plugin_mixer.rb"
 require_relative "sbuilder/facade/api_loader_plugin.rb"
-require_relative "sbuilder/facade/api_loader.rb"
+require_relative "sbuilder/facade/api_loader_facade.rb"
+require_relative "sbuilder/facade/snippet_loader_facade.rb"
 
+# Plugin modules are loaded dynamically - and should be commented here
+# require_relative "sbuilder/snippet_loader_simple"
 require_relative "sbuilder/param_set_loader_swagger.rb"
 
+require_relative "sbuilder/parser/parser_facade.rb"
 require_relative "sbuilder/mustache/template_reader"
 require_relative "sbuilder/mustache/template_reader_context"
+require_relative "sbuilder/mustache/template_root"
+require_relative "sbuilder/mustache/template_resolve"
 require_relative "sbuilder/mustache/template"

data/lib/sbuilder/constants.rb

@@ -2,17 +2,30 @@ module Sbuilder
 
   class Constants
 
+    # some of the constans made avaible for api loaders
+    include Sbuilder::FacadeConstants
+
     # supported domain types
     TYPE_DOMAIN = "domain"
     TYPE_VALUE_DOMAIN = "value-domain"
-    TYPE_CARDINALITY_DOMAIN = "cardinality-domain"    
+    TYPE_CARDINALITY_DOMAIN = "cardinality-domain"
+    TYPE_RANGE_DOMAIN = "range-domain"
+    TYPE_DOMAIN_TYPE = "type-domain"
 
     # supported extension loader types
     EXTENSION_LOADER_YAML = "default-yaml"
+
+    # types in setup
+    SETUP_LOADER_STEP = "step-extension"
+    SETUP_PREFERENCES_EXTENSION = "preferences-extension"        
+
+    # supported extension loader types
+    SETUP_LOADER_ENVIRONMENT = "extend-environment"
     
     # supported paramter set types
     INTERFACE_OPERATION = "operation"
-    SWAGGER_DEFINITION="definition"
+    DEFINITION="definition"
+    DEFINITION_FUNCTION="definition-func"
     PARAM_SET_STEPS = "steps"
 
     # supported interfa loader
@@ -25,7 +38,7 @@ module Sbuilder
     MAPPER_RULE_MATCH = "match"
     MAPPER_RULE_REF   = "ref"
 
-    # supported paremters
+    # supported paramters
     PARAMETER                = "param"
     PARAMETER_REF            = "param-ref"
 
@@ -40,6 +53,16 @@ module Sbuilder
     
     SRC_PATH="#{SRC_DIR}/"         # i.e. src_dir with ending '/', see option --templates
 
+    # known extension points (see src/extend/extend_*.mustache)
+    EXTENSION_POINT_ASSUMPTIONS = "assumptions"
+    EXTENSION_POINT_IMPLEMENTATION = "implementation"
+    EXTENSION_POINT_INVARIANT = "invariant"
+    EXTENSION_POINT_CONST="const"
+    EXTENSION_POINT_MACRO="macros"
+    EXTENSION_POINT_OPERATIONS="operations"
+    EXTENSION_POINT_STATE="state"
+    
+
     # default log-file
     LOGFILE="sbuilder.log"
 
@@ -52,15 +75,18 @@ module Sbuilder
     # directory to cache loaded files
     CACHE_DIR = "cache"
 
+    # snippet loader sub-directory
+    SNIPPET_LOADER_DIR="snippet-loader"
+
     # direcotory where to output rendered templates
     GEN_DIR = "gen"
 
     # direcotory where to output build results
     BUILD_DIR = "build"
 
-    # namespace
-    TYPE_NAMESPACE_DOM = "d_"
-    TYPE_NAMESPACE_REF = "t_"    
+    # # namespace
+    # TYPE_NAMESPACE_DOM = "d_"
+    # TYPE_NAMESPACE_REF = "t_"    
 
     # Location of resources
     RESOURCES_DIR = File.expand_path '../../../resources/', __FILE__
@@ -70,6 +96,139 @@ module Sbuilder
     # Default options
     OPT_VERBOSITY = 1     # output leve
 
+    # Internal
+
+    # name of model template file 
+    MODEL_TEMPLATE_OUTPUT="tla/model.tla"
+
+    
+    # @!group Meta mode
+
+    # Meta model keys
+
+    # @see SymbolTable#defineMetaType for documentation
+    META_MODEL = [
+      {
+        :name =>  META_MODEL_DOMAINS,
+        :prefix => "d_",
+        :desc => "Name of a domain",
+      },
+      {
+        :name =>  META_MODEL_DEFINITIONS,
+        :desc => "Name of data type definition",
+        :prefix => "t_",        
+      },
+      {
+        :name =>  META_MODEL_INTERFACE_TYPES,
+        :desc => "Input data types for public interfaces",
+        :prefix => "t_req_",        
+      },
+      {
+        :name =>  META_MODEL_INTERFACE_RESPONSE_TYPES,
+        :desc => "Response data types for public interfaces",
+        :prefix => "t_resp_",                
+      },
+      {
+        :name =>  META_MODEL_PROCESSES,
+        :desc => "Process name for a public interface service",
+        :prefix => "p_",                
+      },
+      {
+        :name =>  META_MODEL_INFRA_SERVICES,
+        :desc => "Name of infrastructure service procedure",
+        :prefix => "s_",                        
+      },
+      {
+        :name => META_MODEL_SERVICE_IMPLEMENTATION,
+        :desc => "Name of a macro implementing public interface service",
+        :prefix => "i_",                                
+      },
+      {
+        :name => META_MODEL_SERVICE_COMPLETION,
+        :desc => "Name macro completing servie execution",
+        :prefix => "ic_",                                
+      },
+      {
+        :name => META_MODEL_FRAMEWORK_SVC, 
+        :desc => "Services provided by framework",
+        :prefix => "", # use names as provided in snippet
+      },
+      {
+        :name => META_MODEL_INVARIANT,
+        :desc => "Invariant operators",
+        :prefix => "invariant_", 
+      },
+
+    ]
+
+    # @!endgroup
+    # @!group Infrastructure domains
+
+    BASE_EXTENSIONS_DOMAIN = [
+      {
+        'domain' => "BOOLEAN",
+        'type' => 'BOOLEAN',
+      }
+    ]
+    
+    # @!endgroup    
+    # @!group Property validataion
+
+    VALIDATION = {
+      :extend_loader => {
+        :required => %w( className ),
+        :allowed => %w( configuration gem objects ),
+        :required_after_classname => %w( className gem ),        
+      },
+      :SetupLoaderPref => {
+        :required => %w( preferences ),
+        :allowed => nil,
+      },
+      :extend_loader_object => {
+        :required => %w( objectName ),
+        :allowed => %w( configuration  ),
+      },
+      :domain_extension => {
+        :required => %w( domain ),
+        :allowed => %w( cardinality values  range type ),
+        :one_of => %w( cardinality values range type ),
+        :type_required => %w( domain type ),
+        :type_allowed => %w( ),                                
+        :cardinality_required => %w( domain cardinality ),
+        :cardinality_allowed => %w( ),                                
+        :value_required => %w( domain values ),
+        :value_allowed => %w( ),                                
+      },
+      :snippet_loader_plugin => {
+        :required => %w( metatype appName ),
+        :allowed => %w( name file url),
+        :class_config_required => %w(  ),
+        :class_config_allowed => %w( src_dir ),
+        :object_config_required => %w(  ),
+        :object_config_allowed => %w( metatypes ),
+        :one_of_file_or_url => %w( url file ),        
+      },
+      :interface_extension_def => {
+        :required => %w( matcher ),
+        :allowed => %w( implementation completion ),
+      },
+      :snippet_loader_instantiate => {
+        :required => %w( snippets ),
+        :allowed => %w( className objectName configuration ),
+        :one_of => %w( className objectName ),
+      },
+      :api_loader_instantiate => {
+        :required => %w( ),
+        :allowed => %w( url file cache infrastructureServices interfaceServices namespace className objectName configuration type),
+        :one_of_class_or_object => %w( className objectName type ),
+        :one_of_file_or_url => %w( url file ),
+      }
+      
+    }
+    
+    # @!endgroup    
+    
+
   end
 
 end