robotframework-apex 0.0.0__py3-none-any.whl

BrowserApex/cli/apex/objects.py

@@ -0,0 +1,291 @@
+from pathlib import Path
+
+
+class ApexGroup():
+    def __init__(self, initial_data={}):
+        self.properties = {}
+        self.properties.update(initial_data)
+
+    def __setitem__(self, key, value):
+        self.properties[key] = value
+    
+    def __getitem__(self, key):
+        return self.properties.get(key, None)
+
+    def get(self, key, default=None):
+        return self.properties.get(key, default)
+
+
+class ApexObject():
+    def __init__(self, component_id=None, initial_data={}):
+        self.component_id = component_id
+        self.properties = {}
+        self.properties.update(initial_data)
+        self.groups = {}
+        self.children = []
+
+    def __setitem__(self, key, value):
+        if isinstance(value, ApexGroup):
+            self.groups[key] = value
+        elif isinstance(value, ApexObject):
+            self.children[key] = value
+        else:
+            self.properties[key] = value
+    
+    def __getitem__(self, key):
+        if key in self.groups:
+            return self.groups.get(key, None)
+        elif key in self.children:
+            return self.children.get(key, None)
+        else:
+            return self.properties.get(key, None)
+    
+    def add_property(self, key, value):
+        self.properties[key] = value
+    
+    def add_group(self, key, value):
+        self.groups[key] = value
+
+    def add_child(self, child):
+        self.children.append(child)
+
+
+class RegionLayout(ApexGroup):
+    def __init__(self, initial_data={}):
+        super().__init__(initial_data)
+
+    @property
+    def sequence(self):
+        return self.properties.get('sequence', None)
+
+    @property
+    def parentRegion(self):
+        return self.properties.get('parentRegion', None)
+
+class RegionAppearance(ApexGroup):
+    def __init__(self, initial_data={}):
+        super().__init__(initial_data)
+
+
+
+class Region(ApexObject):
+    def __init__(self, component_id=None, initial_data={}):
+        super().__init__(component_id, initial_data)
+
+    @property
+    def name(self):
+        return self.properties.get('name', None)
+
+    @property
+    def title(self):
+        return self.properties.get('title', None)
+
+    @property
+    def type(self):
+        return self.properties.get('type', None)
+
+    @property
+    def layout(self):
+        return self.groups.get('layout', RegionLayout())
+
+    @property
+    def appearance(self):
+        return self.groups.get('appearance', RegionAppearance())
+    
+
+class PageItemLabel(ApexGroup):
+    def __init__(self, initial_data={}):
+        super().__init__(initial_data)
+
+    @property
+    def label(self):
+        return self.properties.get('label', None) 
+
+
+class PageItemSettings(ApexGroup):
+    def __init__(self, initial_data={}):
+        super().__init__(initial_data)
+
+
+class PageItemLayout(ApexGroup):
+    def __init__(self, initial_data={}):
+        super().__init__(initial_data)
+
+    @property
+    def sequence(self):
+        return self.properties.get('sequence', None)
+
+    @property
+    def region(self):
+        return self.properties.get('region', None)
+
+
+class PageItemAppearance(ApexGroup):
+    def __init__(self, initial_data={}):
+        super().__init__(initial_data)
+
+class PageItemValidation(ApexGroup):
+    def __init__(self, initial_data={}):
+            super().__init__(initial_data)
+
+class PageItemAdvanced(ApexGroup):
+    def __init__(self, initial_data={}):
+            super().__init__(initial_data)
+
+class PageItemSessionState(ApexGroup):
+    def __init__(self, initial_data={}):
+            super().__init__(initial_data)
+
+class PageItemSecurity(ApexGroup):
+    def __init__(self, initial_data={}):
+            super().__init__(initial_data)
+
+
+class PageItem(ApexObject):
+    def __init__(self, component_id=None, initial_data={}):
+        super().__init__(component_id, initial_data)
+
+    @property
+    def name(self):
+        return self.properties.get('name', self.component_id)
+
+    @property
+    def type(self):
+        return self.properties.get('type', None)
+
+
+    @property
+    def layout(self):
+        return self.groups.get('layout', PageItemLayout())
+
+    @property
+    def label(self):
+        return self.groups.get('label', PageItemLabel())
+    
+
+class ButtonLayout(ApexGroup):
+    def __init__(self, initial_data={}):
+        super().__init__(initial_data)
+
+    @property
+    def sequence(self):
+        return self.properties.get('sequence', None)
+
+    @property
+    def region(self):
+        return self.properties.get('region', None)
+
+
+class ButtonAppearance(ApexGroup):
+    def __init__(self, initial_data={}):
+        super().__init__(initial_data)
+
+class ButtonBehavior(ApexGroup):
+    def __init__(self, initial_data={}):
+        super().__init__(initial_data)
+
+
+
+class Button(ApexObject):
+    def __init__(self, component_id=None, initial_data={}):
+        super().__init__(component_id, initial_data)
+
+    @property
+    def button_name(self):
+        return self.properties.get('buttonName', None)
+
+    @property
+    def label(self):
+        return self.properties.get('label', None)
+
+    @property
+    def layout(self):
+        return self.groups.get('layout', ButtonLayout({}))
+
+
+class DynamicActionExecution(ApexGroup):
+    pass
+
+class DynamicActionWhen(ApexGroup):
+    pass
+
+class DynamicActionClientSideCondition(ApexGroup):
+    pass
+
+class DynamicAction(ApexObject):
+    def __init__(self, component_id=None, initial_data={}):
+        super().__init__(component_id, initial_data)
+
+
+class ActionAffectedElements(ApexGroup):
+    pass
+
+class Action(ApexObject):
+    pass
+
+class Process(ApexObject):
+    def __init__(self, component_id=None, initial_data={}):
+        super().__init__(component_id, initial_data)
+
+
+class Page(ApexObject):
+    def __init__(self, component_id=None, initial_data={}):
+        super().__init__(component_id, initial_data)
+
+    def __str__(self):
+        return f"Page<#{self.page} name: {self.name}>"
+
+    @property
+    def page(self):
+        return self.properties.get('page', self.component_id)
+
+    @property
+    def name(self):
+        return self.properties['name']
+
+    @property
+    def title(self):
+        return self.properties['title']
+
+    @property
+    def alias(self):
+        return self.properties['alias']
+
+
+    @property
+    def appearance(self):
+        return self.groups.get('appearance', None)
+
+    @appearance.setter
+    def appearance(self, value):
+        self.groups['appearance'] = value
+
+    @property
+    def regions(self):
+        return [x for x in self.children if isinstance(x, Region)]
+    
+    @property
+    def page_items(self):
+        return [x for x in self.children if isinstance(x, PageItem)]
+
+    @property
+    def buttons(self):
+        return [x for x in self.children if isinstance(x, Button)]
+
+    @property
+    def dynamic_actions(self):
+        return [x for x in self.children if isinstance(x, DynamicAction)]
+
+    @property
+    def processes(self):
+        return [x for x in self.children if isinstance(x, Process)]
+
+
+    def get_region(self, reference_or_name):
+        regions = [x for x in self.regions if x.component_id==reference_or_name[1:] or x.name==reference_or_name]
+        if len(regions) == 1:
+            return regions[0]
+        elif len(regions) == 0:
+            return None
+
+        return regions

BrowserApex/cli/apex/reader.py

@@ -0,0 +1,189 @@
+from pathlib import Path
+from BrowserApex.cli.apex import *
+import yaml
+
+"""
+Read YAML and transform to Page object.
+
+Property names will be translated to the names used in de APEX Lang spec. (version 26.1)
+"""
+
+def make_properties(mapper, data, section, object: ApexObject):
+    for field_src, field_dest in mapper.items():
+        if field_src in data[section]:
+            object.add_property(field_dest, data[section][field_src])
+
+def make_group(mapper, data):
+    d = {}
+    for k, v in data.items():
+        if k in mapper:
+            d[mapper[k]] = v
+        else:
+            raise AttributeError(f"Unknown property '{k}'")
+    return d
+
+
+def make_region_layout(data):
+    f = {
+        'sequence': 'sequence',
+        'parent-region': 'parentRegion',
+        'slot': 'slot',
+        'start-new-layout': 'startNewLayout',
+        'start-new-row': 'startNewRow',
+        'column': 'column',
+        'new-column': 'newColumn',
+        'column-span': 'columnSpan'
+    }    
+    d = make_group(f, data)
+    return RegionLayout(d)
+
+
+
+def make_region_appearance(data):
+    f = {
+        'icon': 'icon',
+        'template': 'template',
+        'template-options': 'templateOptions',
+        'render-components': 'renderComponents',
+        'css-classes': 'cssClasses',
+    }    
+    d = make_group(f, data)
+    return RegionAppearance(d)
+
+
+def make_region(region):
+    r = Region(region['id'])
+    make_properties({
+                    'name': 'name',
+                    'title': 'title',
+                    'type': 'type'
+                }, 
+                region, 'identification', r
+                )
+
+    if 'layout' in region:
+        l = make_region_layout(region['layout'])
+        r.add_group('layout',  l)
+
+    if 'appearance' in region:
+        a = make_region_appearance(region['appearance'])
+        r.add_group('appearance', a)
+    return r
+
+
+def make_page_item_label(data):
+    f = {
+        'label': 'label',
+        'alignment': 'alignment',
+    }
+    d = make_group(f, data)
+    return PageItemLabel(d)
+
+def make_page_item_layout(data):
+    f = {
+        'sequence': 'sequence',
+        'region': 'region',
+        'alignment': 'alignment',
+        'slot': 'slot',
+        'start-new-layout': 'startNewLayout',
+        'start-new-row': 'startNewRow',
+        'column': 'column',
+        'new-column': 'newColumn',
+        'column-span': 'columnSpan',
+        'label-column-span': 'labelColumnSpan',
+    }    
+    d = make_group(f, data)
+    return PageItemLayout(d)
+
+def make_page_item_appearance(data):
+    return {}
+
+
+def make_page_item(page_item):
+    p = PageItem(page_item['id'])
+    make_properties({
+                'name': 'name',
+                'type': 'type'
+            }, 
+            page_item, 'identification', p
+            )
+
+    if 'label' in page_item:
+        l = make_page_item_label(page_item['label'])
+        p.add_group('label',  l)
+        
+    if 'layout' in page_item:
+        l = make_page_item_layout(page_item['layout'])
+        p.add_group('layout',  l)
+
+    if 'appearance' in page_item:
+        a = make_page_item_appearance(page_item['appearance'])
+        p.add_group('appearance', a)
+    return p
+
+
+def make_button_layout(data):
+    f = {
+        'sequence': 'sequence',
+        'region': 'region',
+        'slot': 'slot',
+        'column': 'column',
+        'alignment': 'alignment',
+        'new-column': 'newColumn',
+        'column-span': 'columnSpan',
+        'start-new-layout': 'startNewLayout',
+        'start-new-row': 'startNewRow',
+
+    }
+    d = make_group(f, data)
+    return ButtonLayout(d)
+
+def make_button(data):
+    b = Button(data['id'])
+    make_properties({
+        'button-name': 'buttonName',
+        'label': 'label'
+    }, data, 'identification', b)
+
+    if 'layout' in data:
+        l = make_button_layout(data['layout'])
+        b.add_group('layout', l)
+
+    return b
+
+
+def parse_yaml_file(fn: Path) -> Page:
+
+    with open(fn, 'r') as f:
+        data = yaml.safe_load(f)
+
+    
+
+    page = Page(data['id'])
+    for field in ['name', 'alias', 'title']:
+        if field in data['identification']:
+            page.add_property(field, data['identification'][field])
+
+    for region in data['regions']:
+        r = make_region(region)
+        page.add_child(r)
+
+    for page_item in data['page-items']:
+        p = make_page_item(page_item)
+        page.add_child(p)
+
+    for button in data['buttons']:
+        b = make_button(button)
+        page.add_child(b)
+
+    return page
+
+
+if __name__ == '__main__':    # pragma: no cover
+
+    page = parse_yaml_file("examples/f300_page_9999.yaml")
+
+    for r in page.regions:
+        print(r.component_id, r.name, r.type)
+    
+    print(page)

BrowserApex/cli/commands/__init__.py

@@ -0,0 +1,5 @@
+from . import config
+from . import dump
+from . import show
+from . import parse
+from . import generate

BrowserApex/cli/commands/config.py

@@ -0,0 +1,19 @@
+import typer
+from rich import print
+
+
+#from BrowserApex.cli.utils import get_template
+from BrowserApex.cli.main import app
+
+
+@app.command(name='config')
+def project_config(
+    ):
+    """
+    Show project configuration.
+
+    Search `rfapex.ini` in the current project.
+    Root of project contains `robot.toml` or `pyproject.toml`
+    """
+
+    print("CONFIG")

BrowserApex/cli/commands/dump.py

@@ -0,0 +1,23 @@
+import typer
+from typing import Annotated
+import yaml
+from rich import print
+
+#from BrowserApex.cli.utils import get_template
+from BrowserApex.cli.main import app
+
+@app.command(name='dump')
+def project_dump(
+    pagefile: Annotated[str, typer.Argument(help="The filename of exported page (yaml)")]
+    ):
+    """
+    Dump project raw yaml->dict.
+
+    """
+    data = None
+    with open(pagefile, 'r') as f:
+        data = yaml.safe_load(f)
+    # print(data)
+
+
+    print(data)

BrowserApex/cli/commands/generate.py

@@ -0,0 +1,182 @@
+import typer
+from rich import print
+from typing import Annotated
+import yaml
+from rich import print
+from rich.table import Table
+import sys
+from operator import itemgetter
+
+from BrowserApex.cli.main import app
+from BrowserApex.cli.utils import get_config_path, get_config, get_template
+from BrowserApex.cli.apex import *
+
+current_page = None
+
+
+
+def build_structure():
+    regions = {}
+    for pageitem in current_page.page_items:
+        region_name = pageitem.layout.region
+        r = current_page.get_region(region_name)
+        if type(r) is list:
+            for reg in r:
+                if reg.type in ['Static Content', 'staticContent']:
+                    region = reg
+        else:
+            region = r
+        
+        name = region.name
+
+        if name not in regions:
+            regions[name] = dict(
+                region=region,
+                name=name,
+                fields=[],
+                page_buttons=[],
+                has_classic_report=False,
+                has_form=False,
+                is_wizard=False,
+                has_tabs=False
+            )
+        regions[name]['fields'].append(pageitem)
+
+    for button in current_page.buttons:
+        region_name = button.layout.region
+        r = current_page.get_region(region_name)
+        if type(r) is list:
+            for reg in r:
+                if reg.type in ['Static Content', 'staticContent']:
+                    region = reg
+        else:
+            region = r
+        
+        name = region.name
+
+        if name not in regions:
+            regions[name] = dict(
+                region=region,
+                name=name,
+                fields=[],
+                page_buttons=[],
+                has_classic_report=False,
+                has_form=False,
+                is_wizard=False,
+                has_tabs=False
+            )
+        regions[name]['page_buttons'].append(pageitem)
+
+    for r in regions.values():
+        # For fields we only need a label, id and type, example:
+        # ...    Label=P1_NAME:TextField
+
+        # List is also sorted on sequence
+
+        newlist = [(x.label.label or x.name, x.name, x.type[0].upper() + x.type[1:]) for x in sorted(r['fields'], key=lambda d: d['layout']['sequence'])]
+        print(newlist)
+        r['fields'] = newlist
+
+    return regions
+
+@app.command(name='generate')
+def page_generate(
+    pagefile: Annotated[str, typer.Argument(help="The filename of exported page (yaml)")]
+    ):
+    """
+    Generate page object.
+
+    Existing page will be modified. Please do not remove the special comment lines!
+    Outside the special blocks existing code will be preserved.
+    Inside the special blocks existing code will be replaced.
+
+    """
+    global current_page
+
+    data = None
+    fn = Path(pagefile)
+    match fn.suffix:
+        case '.apx':
+            current_page = parse_apex_file(fn)
+        case '.yaml' | '.yml':
+            current_page = parse_yaml_file(fn)
+        case _:
+            raise RuntimeWarning("Unsupported file")
+
+    p = get_config_path()
+    if p is None:
+        print(f"No configuration found. Exitting...")
+        sys.exit(1)
+
+    print(f":beer: Reading config from: {p}")
+
+    cnf = get_config(p)
+    print(cnf)
+    template_path = p
+    main_template = get_template("pageobject", template_path)
+
+    pageobject_resource = f"{current_page.component_id}_{current_page.name.replace(' ','_')}.resource"
+    fn = p / cnf['output']['folder'] / pageobject_resource
+    if not fn.exists():
+        print(f":floppy_disk: Scaffolding resource {fn}")
+        with open(fn, 'w') as f:
+            f.write(main_template.render())
+
+        # TODO: Update main resource to include new pageobject resource
+
+    print(f":lab_coat: Processing page {current_page.component_id} - {current_page.name}")
+    
+    regions = build_structure()
+    for name, region in regions.items():
+        print(f"{name} nr fields: {len(region['fields'])} button: {len(region['page_buttons'])}")
+
+
+    print(f":floppy_disk: Reading resource {fn}")
+    with open(fn, 'r') as f:
+        lines = f.readlines()
+
+    result = []
+    inside_block = False
+    for line in lines:
+        l = line.rstrip()
+
+        if l.startswith('### PAGEGEN:BEGIN:SETTINGS'):
+            inside_block = True
+
+        elif l.startswith('### PAGEGEN:END:SETTINGS'):
+            result.append('# TODO: SETTINGS')
+
+            inside_block = False
+
+        elif l.startswith('### PAGEGEN:BEGIN:VARIABLES'):
+            inside_block = True
+
+        elif l.startswith('### PAGEGEN:END:VARIABLES'):
+            variables_template = get_template('variables', template_path)
+            variables_lines = variables_template.render(page=current_page, blocks=regions)
+            result.extend(variables_lines.split("\n"))
+            inside_block = False
+
+        elif l.startswith('### PAGEGEN:BEGIN:KEYWORDS'):
+            inside_block = True
+            
+        elif l.startswith('### PAGEGEN:END:KEYWORDS'):
+            result.append('# TODO: KEYWORDS')
+            inside_block = False
+
+        elif inside_block:
+            continue
+
+        result.append(l)
+
+    print(f":floppy_disk: Writing updated resource {fn}")
+    with open(fn, 'w') as f:
+        f.write("\n".join(result))
+
+
+
+if __name__ == '__main__':    # pragma: no cover
+
+    # page_generate('examples/test.apx')
+    # page_generate('examples/f300_page_9999.yaml')
+    page_generate('examples/f300_page_9999.yaml')