Class: Sbuilder::Constants

Inherits:

Object

Object
Sbuilder::Constants

show all

Includes:: FacadeConstants

Defined in:: lib/sbuilder/constants.rb

Meta mode collapse

META_MODEL = See Also: for documentation

[
  {
    :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_", 
  },

]

Infrastructure domains collapse

BASE_EXTENSIONS_DOMAIN =

[
  {
    'domain' => "BOOLEAN",
    'type' => 'BOOLEAN',
  }
]

Property validataion collapse

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 ),
  }
  
}

Constant Summary collapse

TYPE_DOMAIN = supported domain types

"domain"

TYPE_VALUE_DOMAIN =

"value-domain"

TYPE_CARDINALITY_DOMAIN =

"cardinality-domain"

TYPE_RANGE_DOMAIN =

"range-domain"

TYPE_DOMAIN_TYPE =

"type-domain"

EXTENSION_LOADER_YAML = supported extension loader types

"default-yaml"

SETUP_LOADER_STEP = types in setup

"step-extension"

SETUP_PREFERENCES_EXTENSION =

"preferences-extension"

SETUP_LOADER_ENVIRONMENT = supported extension loader types

"extend-environment"

INTERFACE_OPERATION = supported paramter set types

"operation"

DEFINITION =

"definition"

DEFINITION_FUNCTION =

"definition-func"

PARAM_SET_STEPS =

"steps"

LOADER_SWAGGER = supported interfa loader

"swagger"

MAPPER_YAML = supported mapper types

"resolver_yaml"

MAPPER_RULE_MATCH = supported mapper_rules

"match"

MAPPER_RULE_REF =

"ref"

PARAMETER = supported paramters

"param"

PARAMETER_REF =

"param-ref"

SRC_DIR = direcotory where to manual source files are

"src"

TEMPLATE_GEM = Default template generation Notice directory names end with slash indicating that they are directories (and not gem-names)

'tla-sbuilder'

TEMPLATE_PATH =

'mustache/'

SRC_PATH = i.e. src_dir with ending ‘/’, see option –templates

"#{SRC_DIR}/"

EXTENSION_POINT_ASSUMPTIONS = known extension points (see src/extend/extend_*.mustache)

"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"

LOGFILE = default log-file

"sbuilder.log"

CNF_DIR = configurations

"cnf"

CNF_FILE = main configuration file

"sbuilder.yaml"

CACHE_DIR = directory to cache loaded files

"cache"

SNIPPET_LOADER_DIR = snippet loader sub-directory

"snippet-loader"

GEN_DIR = direcotory where to output rendered templates

"gen"

BUILD_DIR = direcotory where to output build results

"build"

RESOURCES_DIR = Location of resources

File.expand_path '../../../resources/', __FILE__

SWAGGER_SCHEMA =

File.expand_path 'schema/swagger/2.0/schema.json', RESOURCES_DIR

JSON_SCHEMA =

File.expand_path 'schema/json_schema/draft-04.json', RESOURCES_DIR

OPT_VERBOSITY = Default options

MODEL_TEMPLATE_OUTPUT = name of model template file

"tla/model.tla"

Constants included from FacadeConstants

FacadeConstants::META_MODEL_DEFINITIONS, FacadeConstants::META_MODEL_DOMAINS, FacadeConstants::META_MODEL_FRAMEWORK_SVC, FacadeConstants::META_MODEL_INFRA_SERVICES, FacadeConstants::META_MODEL_INTERFACE_RESPONSE_TYPES, FacadeConstants::META_MODEL_INTERFACE_TYPES, FacadeConstants::META_MODEL_INVARIANT, FacadeConstants::META_MODEL_PROCESSES, FacadeConstants::META_MODEL_SERVICE_COMPLETION, FacadeConstants::META_MODEL_SERVICE_IMPLEMENTATION