mdmodels 0.2.10

A tool to generate models, code and schemas from markdown files
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158

{#
    Non-empty iff any attribute is serialized as an XML child element (truthy for {% if %}).
#}
{%- macro has_elements(attributes) -%}
    {%- for attribute in attributes -%}
        {%- if attribute.xml.is_attr is false -%}x{%- endif -%}
    {%- endfor -%}
{%- endmacro -%}

{#
    use="required" on xs:attribute (mutually exclusive with default in XSD 1.0).
#}
{%- macro is_required(attribute) -%}
    {%- if attribute.required is true %} use="required"{%- endif -%}
{%- endmacro -%}

{#
    default= only when optional; required attributes cannot carry default per XSD 1.0.
#}
{%- macro get_default(attr) -%}
    {%- if 'default' in attr and attr.required is not true %} default="{{ xml_escape(attr.default) }}"{%- endif -%}
{%- endmacro -%}

{#
    Cardinality for repeatable elements (optional 0..* vs required 1..*).
#}
{%- macro is_multiple(attribute) -%}
    {%- if attribute.multiple is true -%}
        {%- if attribute.required is true %} minOccurs="1" maxOccurs="unbounded"{%- else %} minOccurs="0" maxOccurs="unbounded"{%- endif -%}
    {%- endif -%}
{%- endmacro -%}

{#
    Attribute/element base type: user-defined vs xs: built-in.
#}
{%- macro is_reference(attribute) -%}
    {%- if attribute.dtypes[0] in object_names or attribute.dtypes[0] in enum_names -%}
        {{ attribute.dtypes[0] }}Type
    {%- else -%}
        xs:{{ attribute.dtypes[0] }}
    {%- endif -%}
{%- endmacro -%}

{%- macro create_attribute(attribute) -%}
        {%- if attribute.docstring | length > 0 %}
        <xs:attribute name="{{ attribute.name }}" type="{{ is_reference(attribute) }}"
            {%- if is_required(attribute) %} {{ is_required(attribute) }}{%- endif -%}
            {%- if get_default(attribute) %} {{ get_default(attribute) }}{%- endif -%}
            >
            <xs:annotation>
                <xs:documentation>
                    {{ wrap(xml_escape(attribute.docstring), 70, "", "                    ", None) }}
                </xs:documentation>
            </xs:annotation>
        </xs:attribute>
        {%- else -%}
        <xs:attribute name="{{ attribute.name }}" type="{{ is_reference(attribute) }}"
        {%- if is_required(attribute) %} {{ is_required(attribute) }}{%- endif -%}
        {%- if get_default(attribute) %} {{ get_default(attribute) }}{%- endif -%}
        />
        {%- endif -%}
{%- endmacro %}

{%- macro create_element(attribute) -%}
{%- if attribute.dtypes[0] in object_names or attribute.dtypes[0] in enum_names -%}

    {%- if attribute.multiple is true -%}
            <xs:element name="{{attribute.name}}">
                {%- if attribute.docstring | length > 0 %}
                <xs:annotation>
                    <xs:documentation>
                        {{ wrap(xml_escape(attribute.docstring), 70, "", "                        ", None) }}
                    </xs:documentation>
                </xs:annotation>
                {%- endif %}
                <xs:complexType>
                    <xs:sequence>
                        <xs:element name="{{attribute.dtypes[0]}}" type="{{attribute.dtypes[0]}}Type"
                        {%- if is_multiple(attribute) %}{{ is_multiple(attribute) }}{%- endif -%}
                        />
                    </xs:sequence>
                </xs:complexType>
            </xs:element>
    {%- else -%}
            {%- if attribute.docstring | length > 0 -%}
            <xs:element name="{{attribute.name}}" type="{{attribute.dtypes[0]}}Type">
                <xs:annotation>
                    <xs:documentation>
                        {{ wrap(xml_escape(attribute.docstring), 70, "", "                        ", None) }}
                    </xs:documentation>
                </xs:annotation>
            </xs:element>
            {%- else -%}
            <xs:element name="{{attribute.name}}" type="{{attribute.dtypes[0]}}Type"/>
            {%- endif -%}
    {%- endif -%}

{%- else -%}
            {%- if attribute.docstring | length > 0 -%}
            <xs:element name="{{attribute.name}}" type="xs:{{attribute.dtypes[0]}}"
            {%- if is_multiple(attribute) %} {{ is_multiple(attribute) }}{% endif -%}
            {%- if get_default(attribute) %} {{ get_default(attribute) }}{% endif -%}
            >
                <xs:annotation>
                    <xs:documentation>
                        {{ wrap(xml_escape(attribute.docstring), 70, "", "                        ", None) }}
                    </xs:documentation>
                </xs:annotation>
            </xs:element>
            {%- else -%}
            <xs:element name="{{attribute.name}}" type="xs:{{attribute.dtypes[0]}}"
            {%- if is_multiple(attribute) %} {{ is_multiple(attribute) }}{%- endif %}
            {%- if get_default(attribute) %} {{ get_default(attribute) }}{%- endif -%}
            />
            {%- endif -%}

            {%- endif -%}
{%- endmacro %}

<?xml version="1.0" encoding="UTF-8" ?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">

    <!-- Roots -->
    {%- for object in object_names %}
    <xs:element name="{{ object }}" type="{{ object }}Type"/>
    {%- endfor %}
    {% for object in objects%}
    <!-- {{ object.name }} Definition -->
    <xs:complexType name="{{ object.name }}Type">
        {%- if has_elements(object.attributes) %}
        <xs:sequence>
            {%- for attribute in object.attributes %}
            {%- if attribute.xml.is_attr is false %}
            {{ create_element(attribute) }}
            {%- endif %}
            {%- endfor %}
        </xs:sequence>
        {%- endif -%}
        {%- for attribute in object.attributes -%}
        {%- if attribute.xml.is_attr is true -%}
        {{ create_attribute(attribute) }}
        {%- endif -%}
        {%- endfor %}
    </xs:complexType>
    {% endfor %}

    {%- for enum in enums %}
    <!-- Enum {{ enum.name }} Definition -->
    <xs:simpleType name="{{ enum.name }}Type">
        <xs:restriction base="xs:string">
            {%- for key, value in enum.mappings | dictsort %}
            <xs:enumeration value="{{ xml_escape(value) }}"/>
            {%- endfor %}
        </xs:restriction>
    </xs:simpleType>
    {%- endfor %}

</xs:schema>