xuml-populate 0.1.3__tar.gz

xuml_populate-0.1.3/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Leon Starr
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

xuml_populate-0.1.3/MANIFEST.in

@@ -0,0 +1,2 @@
+include src/xuml_populate/log.conf
+include src/xuml_populate/populate/mmdb.ral

xuml_populate-0.1.3/PKG-INFO

@@ -0,0 +1,142 @@
+Metadata-Version: 2.4
+Name: xuml-populate
+Version: 0.1.3
+Summary: Populates the SM Metamodel schema with a user model and outputs this as a TclRAL *.ral database
+Author-email: Leon Starr <leon_starr@modelint.com>
+License: MIT License
+        
+        Copyright (c) Leon Starr
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: repository, https://github.com/modelint/xuml-populate
+Project-URL: documentation, https://github.com/modelint/xuml-populate/wiki
+Keywords: shlaer-mellor,metamodel,executable uml,mbse,xuml,xtuml,platform independent,sysml
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: xcm-parser
+Requires-Dist: xsm-parser
+Requires-Dist: op-parser
+Requires-Dist: mtd-parser
+Requires-Dist: mi-pyral
+Requires-Dist: scrall
+Requires-Dist: tomli; python_version < "3.11"
+Provides-Extra: build
+Requires-Dist: build; extra == "build"
+Requires-Dist: twine; extra == "build"
+Provides-Extra: dev
+Requires-Dist: bump2version; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Dynamic: license-file
+
+# Blueprint MBSE Repository Populator
+
+This package transforms human readable text files describing an Executable UML model of a system into
+a populated metamodel database. With your models loaded into this database it is now possible to produce
+a variety of useful artifacts to support model execution and verification, code generation and anything else
+that performs detailed analyis on the model components and their relationships.
+
+The text files are expressed in an easy to read markdown format so you can browse through the classes, relationships,
+states and transitions, actions and all other model components.
+
+Here we support the Shlaer-Mellor variant of Executable UML exclusively.
+
+## Command usage
+
+`% modeldb -s elevator`
+
+Assuming your system is named 'elevator' and is in the current working directory with the internal structure defined below, will output a file named `mmdb_elevator.ral`. This *.ral file is a text file serialization of a TclRAL database.
+
+Your user model is loaded into the Shlaer-Mellor Metamodel and, if there are no errors, you know you have a Shlaer-Mellor Executable Model that doesn't break any of the rules defined by the metamodel.
+
+You can load and view it using TclRAL or PyRAL or feed it to other downstream Blueprint tools such as the
+Model Executor which among its tasks will generate a user model database.
+
+
+## Input to the populator
+
+Each system is defined in a single package broken down into standard hierarchy of folders like so:
+
+    system
+        domain
+            subsystem
+                classmodel.xcm
+                types.yaml
+                methods
+                    m1.mtd
+                    m2.mtd
+                    ...
+                state-machines
+                    s1.xsm
+                    ...
+                external
+                    EE
+                        op1.op
+                        ...
+            subsystem2
+            ...
+        domain2
+        ...
+   
+Here is a partial layout for The Elevator Case Study as an example:
+
+
+    elevator-case-study // system
+        elevator-management // application domain
+            elevator // All defined in one subsystem
+                elevator.xcm // the class model
+                methods // methods for all classes in subsystem
+                    cabin // methods on 'cabin' class
+                        ping.mtd // the ping method
+                        ...
+                    ...
+                state-machines // lifecycles and assigners for this subsystem
+                    cabin.xsm // lifecycles named by class, assigners by association
+                    transfer.xsm
+                    R53.xsm // assigner state machine on association R53
+                    ...
+                external // external entities, each a proxy for some class
+                    CABIN // proxy for 'cabin' class
+                        arrived-at-floor.op // two ee operations
+                        goto-floor.op
+            types.yaml // data types for all subsystems in domain
+        transport // two more domains (not broken down yet)
+        signal io
+
+Each modeled domain has its own folder. Above we just see one for the Elevator Managment domain.
+
+Each domain requires at least one subsystem folder. Here we see only one and that is the Elevator domain.
+
+Within a subsystem folder there is one class model expressed as an .xcm (executable class model) file.
+
+The folders are optional and are:
+
+* external – external entities and their operations, one subfolder per external entity
+* methods – class methods each in a folder matching the class name with each method in a separate .mtd file
+* state-machines – each state machine, assigner or lifecycle, in its own .xsm (executable state machine) file
+
+Also within a domain you have a types.yaml file which specifies each domain specific type (Pressure, Speed, etc) and selects
+a corresponding system (database) type. This is a stop gap measure as we have not yet provided a more robust typing
+domain, so, for now we settle with what our database has to offer (int, string, float, etc). Unltimately, though,
+a full featured typing facility will support a variety of types and operations on those types as well as a type
+definition system. Note that the typing facility can be, but need not necessarily be a modeled domain.

xuml_populate-0.1.3/README.md

@@ -0,0 +1,91 @@
+# Blueprint MBSE Repository Populator
+
+This package transforms human readable text files describing an Executable UML model of a system into
+a populated metamodel database. With your models loaded into this database it is now possible to produce
+a variety of useful artifacts to support model execution and verification, code generation and anything else
+that performs detailed analyis on the model components and their relationships.
+
+The text files are expressed in an easy to read markdown format so you can browse through the classes, relationships,
+states and transitions, actions and all other model components.
+
+Here we support the Shlaer-Mellor variant of Executable UML exclusively.
+
+## Command usage
+
+`% modeldb -s elevator`
+
+Assuming your system is named 'elevator' and is in the current working directory with the internal structure defined below, will output a file named `mmdb_elevator.ral`. This *.ral file is a text file serialization of a TclRAL database.
+
+Your user model is loaded into the Shlaer-Mellor Metamodel and, if there are no errors, you know you have a Shlaer-Mellor Executable Model that doesn't break any of the rules defined by the metamodel.
+
+You can load and view it using TclRAL or PyRAL or feed it to other downstream Blueprint tools such as the
+Model Executor which among its tasks will generate a user model database.
+
+
+## Input to the populator
+
+Each system is defined in a single package broken down into standard hierarchy of folders like so:
+
+    system
+        domain
+            subsystem
+                classmodel.xcm
+                types.yaml
+                methods
+                    m1.mtd
+                    m2.mtd
+                    ...
+                state-machines
+                    s1.xsm
+                    ...
+                external
+                    EE
+                        op1.op
+                        ...
+            subsystem2
+            ...
+        domain2
+        ...
+   
+Here is a partial layout for The Elevator Case Study as an example:
+
+
+    elevator-case-study // system
+        elevator-management // application domain
+            elevator // All defined in one subsystem
+                elevator.xcm // the class model
+                methods // methods for all classes in subsystem
+                    cabin // methods on 'cabin' class
+                        ping.mtd // the ping method
+                        ...
+                    ...
+                state-machines // lifecycles and assigners for this subsystem
+                    cabin.xsm // lifecycles named by class, assigners by association
+                    transfer.xsm
+                    R53.xsm // assigner state machine on association R53
+                    ...
+                external // external entities, each a proxy for some class
+                    CABIN // proxy for 'cabin' class
+                        arrived-at-floor.op // two ee operations
+                        goto-floor.op
+            types.yaml // data types for all subsystems in domain
+        transport // two more domains (not broken down yet)
+        signal io
+
+Each modeled domain has its own folder. Above we just see one for the Elevator Managment domain.
+
+Each domain requires at least one subsystem folder. Here we see only one and that is the Elevator domain.
+
+Within a subsystem folder there is one class model expressed as an .xcm (executable class model) file.
+
+The folders are optional and are:
+
+* external – external entities and their operations, one subfolder per external entity
+* methods – class methods each in a folder matching the class name with each method in a separate .mtd file
+* state-machines – each state machine, assigner or lifecycle, in its own .xsm (executable state machine) file
+
+Also within a domain you have a types.yaml file which specifies each domain specific type (Pressure, Speed, etc) and selects
+a corresponding system (database) type. This is a stop gap measure as we have not yet provided a more robust typing
+domain, so, for now we settle with what our database has to offer (int, string, float, etc). Unltimately, though,
+a full featured typing facility will support a variety of types and operations on those types as well as a type
+definition system. Note that the typing facility can be, but need not necessarily be a modeled domain.

xuml_populate-0.1.3/pyproject.toml

@@ -0,0 +1,30 @@
+[build-system]
+requires      = ["setuptools>=61.0.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "xuml-populate"
+version = "0.1.3"
+description = "Populates the SM Metamodel schema with a user model and outputs this as a TclRAL *.ral database"
+readme = "README.md"
+authors = [{ name = "Leon Starr", email = "leon_starr@modelint.com" }]
+license = { file = "LICENSE" }
+classifiers = [
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+]
+keywords = ["shlaer-mellor", "metamodel", "executable uml", "mbse", "xuml", "xtuml", "platform independent", "sysml"]
+dependencies = ["xcm-parser", "xsm-parser", "op-parser", "mtd-parser", "mi-pyral", "scrall", 'tomli; python_version < "3.11"']
+requires-python = ">=3.11"
+
+[project.optional-dependencies]
+build = ["build", "twine"]
+dev = ["bump2version", "pytest"]
+
+[project.scripts]
+modeldb = "xuml_populate.__main__:main"
+
+[project.urls]
+repository    = "https://github.com/modelint/xuml-populate"
+documentation = "https://github.com/modelint/xuml-populate/wiki"

xuml_populate-0.1.3/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

xuml_populate-0.1.3/src/xuml_populate/__init__.py

@@ -0,0 +1 @@
+version = "0.1.3"

xuml_populate-0.1.3/src/xuml_populate/__main__.py

@@ -0,0 +1,74 @@
+"""
+Blueprint Model Repository Populator
+
+"""
+import logging
+import logging.config
+import sys
+import argparse
+from pathlib import Path
+from xuml_populate.system import System
+from xuml_populate import version
+import atexit
+
+_logpath = Path("repo_pop.log")
+_progname = 'Blueprint model repository populator'
+
+def clean_up():
+    """Normal and exception exit activities"""
+    _logpath.unlink(missing_ok=True)
+
+
+def get_logger():
+    """Initiate the logger"""
+    log_conf_path = Path(__file__).parent / 'log.conf'  # Logging configuration is in this file
+    logging.config.fileConfig(fname=log_conf_path, disable_existing_loggers=False)
+    return logging.getLogger(__name__)  # Create a logger for this module
+
+
+# Configure the expected parameters and actions for the argparse module
+def parse(cl_input):
+    parser = argparse.ArgumentParser(description=_progname)
+    parser.add_argument('-s', '--system', action='store',
+                        help='Name of the system package')
+    parser.add_argument('-D', '--debug', action='store_true',
+                        help='Debug mode'),
+    parser.add_argument('-d', '--display', action='store_true',
+                        help='Display the populated database on the console')
+    parser.add_argument('-L', '--log', action='store_true',
+                        help='Generate a diagnostic log file')
+    parser.add_argument('-A', '--actions', action='store_true',
+                        help='Parse actions'),
+    parser.add_argument('-V', '--version', action='store_true',
+                        help='Print the current version of the repo populator')
+    return parser.parse_args(cl_input)
+
+
+def main():
+    # Start logging
+    logger = get_logger()
+    logger.info(f'{_progname} version: {version}')
+
+    # Parse the command line args
+    args = parse(sys.argv[1:])
+
+    if not args.log:
+        # If no log file is requested, remove the log file before termination
+        atexit.register(clean_up)
+
+    if args.version:
+        # Just print the version and quit
+        print(f'{_progname} version: {version}')
+        sys.exit(0)
+
+    # System package specified
+    if args.system:
+        system_pkg_path = Path(args.system).resolve()
+        s = System(name=system_pkg_path.stem, system_path=system_pkg_path, parse_actions=args.actions, display=args.display)
+
+    logger.info("No problemo")  # We didn't die on an exception, basically
+    print("\nNo problemo")
+
+
+if __name__ == "__main__":
+    main()

xuml_populate-0.1.3/src/xuml_populate/config.py

@@ -0,0 +1,5 @@
+""" config.py """
+
+# The name of the database used throughout the xuml populate package
+
+mmdb = "mmdb"

xuml_populate-0.1.3/src/xuml_populate/exceptions/action_exceptions.py

@@ -0,0 +1,232 @@
+"""
+action_exceptions.py – Errors that occur while populating actions
+"""
+
+# Every error should have the same format
+# with a standard prefix and postfix defined here
+pre = "\nScrall populator: -- "
+post = " --"
+
+
+class ActionException(Exception):
+    pass
+
+class UndefinedMethod(ActionException):
+    pass
+
+class UndefinedAttribute(ActionException):
+    pass
+
+class UndefinedParameter(ActionException):
+    pass
+class UndefinedTableAttribute(ActionException):
+    pass
+
+class SwitchException(ActionException):
+    pass
+
+class BadScalarSwitchInput(SwitchException):
+    pass
+
+class FlowException(ActionException):
+    pass
+
+class ControlFlowHasNoTargetActions(FlowException):
+    pass
+
+class NonScalarFlowRequired(FlowException):
+    pass
+
+class TableExpressionException(ActionException):
+    pass
+
+class ScalarExpressionException(ActionException):
+    pass
+
+class ScalarOperationOrExpressionExpected(ScalarExpressionException):
+    pass
+
+class ScalarAssignmentfromMultipleTuples(ScalarExpressionException):
+    pass
+class ScalarAssignmentFlowMismatch(ScalarExpressionException):
+    pass
+
+class UndefinedHeaderExpressionOp(TableExpressionException):
+    pass
+
+class ProductForbidsCommonAttributes(TableExpressionException):
+    pass
+
+class SetOpRequiresSameHeaders(TableExpressionException):
+    pass
+
+class UnjoinableHeaders(TableExpressionException):
+    pass
+
+class TraversalActionException(ActionException):
+    pass
+
+class SelectActionException(ActionException):
+    pass
+
+class NoInputInstanceFlow(SelectActionException):
+    pass
+
+class ProjectedAttributeNotDefined(TableExpressionException):
+    pass
+
+class TableOperationOrExpressionExpected(TableExpressionException):
+    pass
+
+class SelectionOnScalarFlow(ActionException):
+    def __init__(self, path, text, x):
+        self.path = path
+        self.text = text[slice(*x)]
+
+    def __str__(self):
+        return f'{pre}Cannot select/restrict on a scalar flow. Verify input to selection phrase' \
+               f'{post}\n\t[{self.path}] >> {self.text}'
+
+class AssignZeroOneInstanceHasMultiple(ActionException):
+    def __init__(self, path, text, x):
+        self.path = path
+        self.text = text[slice(*x)]
+
+    def __str__(self):
+        return f'{pre}Single instance assignment operator may recieve multiple instances, try ..= operator or ' \
+               f'modify RHS to yield at most one instance{post}\n\t[{self.path}] >> {self.text}'
+
+class NoClassOrInstanceFlowForInstanceSetName(ActionException):
+    def __init__(self, path, text, x):
+        self.path = path
+        self.text = text[slice(*x)]
+
+    def __str__(self):
+        return f'{pre}Name in instance set is neither a class or an instance flow source' \
+               f'{post}\n\t[{self.path}] >> {self.text}'
+
+class ComparingNonAttributeInSelection(SelectActionException):
+    pass
+
+class NoDestinationInPath(ActionException):
+    def __init__(self, path):
+        self.path = path
+
+    def __str__(self):
+        return f'{pre}No destination class at end of path: [{self.path}].{post}'
+
+class UndefinedClass(ActionException):
+    def __init__(self, cname):
+        self.cname = cname
+
+    def __str__(self):
+        return f'{pre}Class [{self.cname}] not defined.{post}'
+
+class IncompletePath(ActionException):
+    def __init__(self, path):
+        self.path = path
+
+    def __str__(self):
+        return f'{pre}Path requires at least one hop: [{self.path}].{post}'
+
+class NoPathFromClass(ActionException):
+    def __init__(self, rnum, domain):
+        self.rnum = rnum
+        self.domain = domain
+
+    def __str__(self):
+        return f'{pre}Undefined relationship [{self.rnum}] in domain [{self.domain}].{post}'
+
+class UndefinedRelationship(ActionException):
+    def __init__(self, rnum, domain):
+        self.rnum = rnum
+        self.domain = domain
+
+    def __str__(self):
+        return f'{pre}Undefined relationship [{self.rnum}] in domain [{self.domain}].{post}'
+
+class UndefinedAssociation(ActionException):
+    def __init__(self, rnum, domain):
+        self.rnum = rnum
+        self.domain = domain
+
+    def __str__(self):
+        return f'{pre}Undefined association [{self.rnum}] in domain [{self.domain}].{post}'
+
+class PerspectiveNotDefined(TraversalActionException):
+    def __init__(self, phrase,domain):
+        self.phrase = phrase
+        self.domain = domain
+
+    def __str__(self):
+        return f'{pre}Perspective [{self.phrase}] not defined in domain [{self.domain}].{post}'
+
+class RelationshipUnreachableFromClass(TraversalActionException):
+    def __init__(self, rnum, cname, domain):
+        self.cname = cname
+        self.rnum = rnum
+        self.domain = domain
+
+    def __str__(self):
+        return f'{pre}Unreachable relationship [{self.rnum}] from [{self.cname}] in domain [{self.domain}].{post}'
+
+class NeedPerspectiveToHop(TraversalActionException):
+    def __init__(self, rnum, domain):
+        self.rnum = rnum
+        self.domain = domain
+
+    def __str__(self):
+        return f'{pre}Reflexive association [{self.rnum}] in domain [{self.domain}] cannot be resolved' \
+               f'without perspective.{post}'
+class NeedPerspectiveOrClassToHop(TraversalActionException):
+    def __init__(self, rnum, domain):
+        self.rnum = rnum
+        self.domain = domain
+
+    def __str__(self):
+        return f'{pre}Association [{self.rnum}] in domain [{self.domain}] cannot be resolved' \
+               f'without perspective or class.{post}'
+
+class HopToUnreachableClass(TraversalActionException):
+    def __init__(self, cname, rnum, domain):
+        self.cname = cname
+        self.rnum = rnum
+        self.domain = domain
+
+    def __str__(self):
+        return f'{pre}Relationship [{self.rnum}] does not reach class [{self.cname}] in domain [{self.domain}].{post}'
+
+class SubclassNotInGeneralization(TraversalActionException):
+    def __init__(self, subclass, rnum, domain):
+        self.subclass = subclass
+        self.rnum = rnum
+        self.domain = domain
+
+    def __str__(self):
+        return f'{pre}Generalization [{self.rnum}] does not include subclass [{self.subclass}] in domain' \
+               f'[{self.domain}].{post}'
+class NoSubclassInHop(TraversalActionException):
+    def __init__(self, superclass, rnum, domain):
+        self.superclass = superclass
+        self.rnum = rnum
+        self.domain = domain
+
+    def __str__(self):
+        return f'{pre}Generalization [{self.rnum}] from [{self.superclass}] does not reach a subclass in domain' \
+               f'[{self.domain}].{post}'
+class MissingTorPrefInAssociativeRel(TraversalActionException):
+    def __init__(self, rnum, domain):
+        self.rnum = rnum
+        self.domain = domain
+
+    def __str__(self):
+        return f'{pre}P or T ref not found for associative relationship [{self.rnum}] in domain [{self.domain}].{post}'
+
+class UnexpectedClassOrPerspectiveInPath(TraversalActionException):
+    def __init__(self, name, path):
+        self.name = name
+        self.path = path
+
+    def __str__(self):
+        return f'{pre}Name [{self.name}] not expected in path [{self.path}].{post}'
+

xuml_populate-0.1.3/src/xuml_populate/exceptions/class_exceptions.py

@@ -0,0 +1,22 @@
+"""
+class_exceptions.py – Exceptions encountered when loading a model
+"""
+
+# Every error should have the same format
+# with a standard prefix and postfix defined here
+pre = "\nModel loader -- "
+post = " --"
+
+# ---
+# ---
+
+class UserModel(Exception):
+    pass
+
+class ReferenceToNonIdentifier(UserModel):
+    def __str__(self):
+        return f"{pre}Attribute does not reference an identifier in target"
+
+class MixedTargetID(UserModel):
+    def __str__(self):
+        return f"{pre}Attributes from more than one ID in target reference"