dump subjects + use properties instead side

maps/001/state1.xml

@@ -9,42 +9,120 @@
             <position>72,7</position>
             <direction>90</direction>
             <mode>standup</mode>
-            <side>URSS</side>
+            <properties>
+                <item>
+                    <key>SELECTION_COLOR_RGB</key>
+                    <value>204,0,0</value>
+                </item>
+                <item>
+                    <key>FLAG</key>
+                    <value>FLAG_URSS</value>
+                </item>
+                <item>
+                    <key>SIDE</key>
+                    <value>ALLIES</value>
+                </item>
+            </properties>
         </subject>
         <subject>
             <type>opencombat.simulation.subject.ManSubject</type>
             <position>72,9</position>
             <direction>90</direction>
             <mode>standup</mode>
-            <side>URSS</side>
+            <properties>
+                <item>
+                    <key>SELECTION_COLOR_RGB</key>
+                    <value>204,0,0</value>
+                </item>
+                <item>
+                    <key>FLAG</key>
+                    <value>FLAG_URSS</value>
+                </item>
+                <item>
+                    <key>SIDE</key>
+                    <value>ALLIES</value>
+                </item>
+            </properties>
         </subject>
         <subject>
             <type>opencombat.simulation.subject.ManSubject</type>
             <position>72,11</position>
             <direction>90</direction>
             <mode>standup</mode>
-            <side>URSS</side>
+            <properties>
+                <item>
+                    <key>SELECTION_COLOR_RGB</key>
+                    <value>204,0,0</value>
+                </item>
+                <item>
+                    <key>FLAG</key>
+                    <value>FLAG_URSS</value>
+                </item>
+                <item>
+                    <key>SIDE</key>
+                    <value>ALLIES</value>
+                </item>
+            </properties>
         </subject>
         <subject>
             <type>opencombat.simulation.subject.ManSubject</type>
             <position>58,54</position>
             <direction>270</direction>
             <mode>hiding</mode>
-            <side>DE</side>
+            <properties>
+                <item>
+                    <key>SELECTION_COLOR_RGB</key>
+                    <value>0,81,211</value>
+                </item>
+                <item>
+                    <key>FLAG</key>
+                    <value>FLAG_DE</value>
+                </item>
+                <item>
+                    <key>SIDE</key>
+                    <value>AXIS</value>
+                </item>
+            </properties>
         </subject>
         <subject>
             <type>opencombat.simulation.subject.ManSubject</type>
             <position>58,56</position>
             <direction>270</direction>
             <mode>hiding</mode>
-            <side>DE</side>
+            <properties>
+                <item>
+                    <key>SELECTION_COLOR_RGB</key>
+                    <value>0,81,211</value>
+                </item>
+                <item>
+                    <key>FLAG</key>
+                    <value>FLAG_DE</value>
+                </item>
+                <item>
+                    <key>SIDE</key>
+                    <value>AXIS</value>
+                </item>
+            </properties>
         </subject>
         <subject>
             <type>opencombat.simulation.subject.ManSubject</type>
             <position>58,58</position>
             <direction>270</direction>
             <mode>hiding</mode>
-            <side>DE</side>
+            <properties>
+                <item>
+                    <key>SELECTION_COLOR_RGB</key>
+                    <value>0,81,211</value>
+                </item>
+                <item>
+                    <key>FLAG</key>
+                    <value>FLAG_DE</value>
+                </item>
+                <item>
+                    <key>SIDE</key>
+                    <value>AXIS</value>
+                </item>
+            </properties>
         </subject>
     </subjects>
 </state>

opencombat/const.py

@@ -3,8 +3,8 @@
 COLLECTION_ALIVE = 'ALIVE'
 
 FLAG = 'FLAG'
-FLAG_DE = 'DE'
-FLAG_URSS = 'URSS'
+FLAG_DE = 'FLAG_DE'
+FLAG_URSS = 'FLAG_URSS'
 
 SIDE = 'SIDE'
 COMBAT_MODE = 'COMBAT_MODE'

opencombat/state.py

@@ -6,19 +6,14 @@ from lxml import etree
 
 from synergine2.config import Config
 from synergine2.log import get_logger
-from synergine2_cocos2d.const import SELECTION_COLOR_RGB
 
 from opencombat.exception import StateLoadError
+from opencombat.exception import NotFoundError
 from opencombat.simulation.base import TileStrategySimulation
 from opencombat.simulation.subject import TileSubject
 from opencombat.util import get_class_from_string_path
+from opencombat.util import pretty_xml
 from opencombat.util import get_text_xml_element
-from opencombat.const import FLAG
-from opencombat.const import SIDE
-from opencombat.const import FLAG_DE
-from opencombat.const import DE_COLOR
-from opencombat.const import URSS_COLOR
-from opencombat.const import FLAG_URSS
 
 
 class State(object):
@@ -75,28 +70,33 @@ class State(object):
             get_text_xml_element(subject_element, 'direction'),
         )
 
-        # FIXME BS 218-06-14: There is a confusion: don't use side but
-        # "team". It probably need change in other code.
-        side = get_text_xml_element(subject_element, 'side')
-        if side == 'DE':
-            subject_properties.update({
-                SELECTION_COLOR_RGB: DE_COLOR,
-                FLAG: FLAG_DE,
-                SIDE: 'AXIS',
-            })
-        elif side == 'URSS':
-            subject_properties.update({
-                SELECTION_COLOR_RGB: URSS_COLOR,
-                FLAG: FLAG_URSS,
-                SIDE: 'ALLIES',
-            })
-        else:
-            raise NotImplementedError('Don\'t know "{}" side'.format(
-                side,
-            ))
+        properties_element = subject_element.find('properties')
+        decode_properties_map = self._get_decode_properties_map()
+
+        for item_element in properties_element.findall('item'):
+            key_text = item_element.find('key').text
+            value_text = item_element.find('value').text
+
+            try:
+                decoded_value = decode_properties_map[key_text](value_text)
+            except KeyError:
+                raise NotFoundError(
+                    'You try to load property "{}" but it is unknown'.format(
+                        key_text,
+                    )
+                )
+
+            subject_properties[key_text] = decoded_value
 
         subject.properties = subject_properties
 
+    def _get_decode_properties_map(self) -> typing.Dict[str, typing.Callable[[str], typing.Any]]:  # nopep8
+        return {
+            'SELECTION_COLOR_RGB': lambda v: tuple(map(int, v.split(','))),
+            'FLAG': str,
+            'SIDE': str,
+        }
+
 
 class StateDumper(object):
     def __init__(
@@ -114,11 +114,64 @@ class StateDumper(object):
         )
         with open(state_template, 'r') as xml_file:
             template_str = xml_file.read()
-        self._state_root = etree.fromstring(template_str.encode('utf-8'))
 
-    def get_state_dump(self) -> Element:
-        # TODO BS 2018-06-14: Code here xml construction
-        return self._state_root
+        parser = etree.XMLParser(remove_blank_text=True)
+        self._state_root = etree.fromstring(
+            template_str.encode('utf-8'),
+            parser,
+        )
+        self._state_root_filled = False
+
+    def get_state_dump(self) -> str:
+        if not self._state_root_filled:
+            self._fill_state_root()
+
+        return pretty_xml(
+            etree.tostring(
+                self._state_root,
+            ).decode('utf-8'),
+        )
+
+    def _fill_state_root(self) -> None:
+        subjects_element = self._state_root.find('subjects')
+
+        for subject in self._simulation.subjects:
+            subject_element = etree.SubElement(subjects_element, 'subject')
+
+            position_element = etree.SubElement(subject_element, 'type')
+            position_element.text = '.'.join([
+                subject.__module__,
+                subject.__class__.__name__,
+            ])
+
+            position_element = etree.SubElement(subject_element, 'position')
+            position_element.text = ','.join(map(str, subject.position))
+
+            direction_element = etree.SubElement(subject_element, 'direction')
+            direction_element.text = str(subject.direction)
+
+            properties_element = etree.SubElement(
+                subject_element,
+                'properties',
+            )
+            encode_properties_map = self._get_encode_properties_map()
+
+            for key, value in subject.properties.items():
+                item_element = etree.SubElement(properties_element, 'item')
+                key_element = etree.SubElement(item_element, 'key')
+                value_element = etree.SubElement(item_element, 'value')
+
+                key_element.text = str(key)
+                value_element.text = encode_properties_map[key](value)
+
+        self._state_root_filled = True
+
+    def _get_encode_properties_map(self) -> typing.Dict[str, typing.Callable[[typing.Any], str]]:  # nopep8:
+        return {
+            'SELECTION_COLOR_RGB': lambda v: ','.join(map(str, v)),
+            'FLAG': str,
+            'SIDE': str,
+        }
 
 
 class StateLoader(object):

opencombat/state.xsd

@@ -10,13 +10,18 @@
         </xs:restriction>
     </xs:simpleType>
 
-    <xs:simpleType name="sidetype" final="restriction">
-        <xs:restriction base="xs:string">
-            <xs:enumeration value="DE"/>
-            <xs:enumeration value="URSS"/>
-            <xs:enumeration value="US"/>
-        </xs:restriction>
-    </xs:simpleType>
+    <xs:complexType name="propertiestype">
+        <xs:sequence>
+            <xs:element maxOccurs="unbounded" name="item">
+                <xs:complexType>
+                    <xs:sequence>
+                        <xs:element name="key" type="xs:string"  />
+                        <xs:element name="value" type="xs:string" />
+                    </xs:sequence>
+                </xs:complexType>
+            </xs:element>
+        </xs:sequence>
+    </xs:complexType>
 
     <xs:simpleType name="modetype" final="restriction">
         <xs:restriction base="xs:string">
@@ -56,7 +61,7 @@
             <xs:element name="position" type="positiontype" minOccurs="1"/>
             <xs:element name="direction" type="directiontype" minOccurs="1"/>
             <xs:element name="mode" type="modetype" minOccurs="1"/>
-            <xs:element name="side" type="sidetype" minOccurs="1"/>
+            <xs:element name="properties" type="propertiestype" minOccurs="1"/>
         </xs:sequence>
     </xs:complexType>
 

opencombat/util.py

@@ -2,6 +2,8 @@
 import importlib
 
 from _elementtree import Element
+import xml.dom.minidom as md
+from io import StringIO
 
 from opencombat.exception import NotFoundError
 
@@ -38,3 +40,18 @@ def get_text_xml_element(
         return default_value
 
     return found.text
+
+
+def pretty_xml(xml_str):
+    """
+    Return a pretty xmlstr of given xml str. Thank's to:
+        https://gist.github.com/eliask/d8517790b11edac75983d1e6fdab3cab
+    :param xml_str: ugly xml str
+    :return: pretty xml str
+    """
+    indent = ' ' * 4
+    return '\n'.join(
+        line for line in
+        md.parse(StringIO(xml_str)).toprettyxml(indent=indent).split('\n')
+        if line.strip()
+    )

tests/fixtures/state_error_schema.xml

@@ -9,14 +9,12 @@
             <position>1,1</position>
             <direction>90</direction>
             <mode>standup</mode>
-            <side>URSS</side>
         </subject>
         <subjectFOO>
             <type>opencombat.simulation.subject.ManSubject</type>
             <position>10,10</position>
             <direction>270</direction>
             <mode>hiding</mode>
-            <side>DE</side>
         </subjectFOO>
     </subjects>
 </state>

tests/fixtures/state_ok.xml

@@ -9,14 +9,40 @@
             <position>1,1</position>
             <direction>90</direction>
             <mode>standup</mode>
-            <side>URSS</side>
+            <properties>
+                <item>
+                    <key>SELECTION_COLOR_RGB</key>
+                    <value>204,0,0</value>
+                </item>
+                <item>
+                    <key>FLAG</key>
+                    <value>FLAG_URSS</value>
+                </item>
+                <item>
+                    <key>SIDE</key>
+                    <value>ALLIES</value>
+                </item>
+            </properties>
         </subject>
         <subject>
             <type>opencombat.simulation.subject.ManSubject</type>
             <position>10,10</position>
             <direction>270</direction>
             <mode>hiding</mode>
-            <side>DE</side>
+            <properties>
+                <item>
+                    <key>SELECTION_COLOR_RGB</key>
+                    <value>0,81,211</value>
+                </item>
+                <item>
+                    <key>FLAG</key>
+                    <value>FLAG_DE</value>
+                </item>
+                <item>
+                    <key>SIDE</key>
+                    <value>AXIS</value>
+                </item>
+            </properties>
         </subject>
     </subjects>
 </state>

tests/test_state.py

@@ -1,4 +1,6 @@
 # coding: utf-8
+from collections import OrderedDict
+
 import pytest
 from synergine2.config import Config
 from synergine2_cocos2d.const import SELECTION_COLOR_RGB
@@ -33,24 +35,25 @@ def simulation_for_dump(config) -> TileStrategySimulation:
         'tests/fixtures/map_a/map_a.tmx',
     )
     subjects = TileStrategySubjects(simulation=simulation)
+    simulation.subjects = subjects
 
     man1 = ManSubject(config, simulation)
     man1.position = (10, 11)
     man1.direction = 42
-    man1.properties = {
-        SELECTION_COLOR_RGB: DE_COLOR,
-        FLAG: FLAG_DE,
-        SIDE: 'AXIS',
-    }
+    man1.properties = OrderedDict([
+        (SELECTION_COLOR_RGB, DE_COLOR),
+        (FLAG, FLAG_DE),
+        (SIDE, 'AXIS'),
+    ])
 
     man2 = ManSubject(config, simulation)
     man2.position = (16, 8)
     man2.direction = 197
-    man2.properties = {
-        SELECTION_COLOR_RGB: URSS_COLOR,
-        FLAG: FLAG_URSS,
-        SIDE: 'ALLIES',
-    }
+    man2.properties = OrderedDict([
+        (SELECTION_COLOR_RGB, URSS_COLOR),
+        (FLAG, FLAG_URSS),
+        (SIDE, 'ALLIES'),
+    ])
 
     subjects.append(man1)
     subjects.append(man2)
@@ -107,11 +110,66 @@ def test_state__ok__subjects(
     assert 90.0 == state.subjects[0].direction
     assert 270.0 == state.subjects[1].direction
 
+    assert {
+               'SELECTION_COLOR_RGB': (204, 0, 0),
+               'FLAG': 'FLAG_URSS',
+               'SIDE': 'ALLIES',
+           } == state.subjects[0].properties
+    assert {
+               'SELECTION_COLOR_RGB': (0, 81, 211),
+               'FLAG': 'FLAG_DE',
+               'SIDE': 'AXIS',
+           } == state.subjects[1].properties
+
 
 def test_state__ok__dump(
     config: Config,
     simulation_for_dump: TileStrategySimulation,
 ):
     state_dumper = StateDumper(config, simulation_for_dump)
-    state_xml = state_dumper.get_state_dump()
-    assert False
+    state_xml_str = state_dumper.get_state_dump()
+    assert """<?xml version="1.0" ?>
+<state type="before_battle">
+    <map>
+    </map>
+    <subjects>
+        <subject>
+            <type>opencombat.simulation.subject.ManSubject</type>
+            <position>10,11</position>
+            <direction>42</direction>
+            <properties>
+                <item>
+                    <key>SELECTION_COLOR_RGB</key>
+                    <value>0,81,211</value>
+                </item>
+                <item>
+                    <key>FLAG</key>
+                    <value>FLAG_DE</value>
+                </item>
+                <item>
+                    <key>SIDE</key>
+                    <value>AXIS</value>
+                </item>
+            </properties>
+        </subject>
+        <subject>
+            <type>opencombat.simulation.subject.ManSubject</type>
+            <position>16,8</position>
+            <direction>197</direction>
+            <properties>
+                <item>
+                    <key>SELECTION_COLOR_RGB</key>
+                    <value>204,0,0</value>
+                </item>
+                <item>
+                    <key>FLAG</key>
+                    <value>FLAG_URSS</value>
+                </item>
+                <item>
+                    <key>SIDE</key>
+                    <value>ALLIES</value>
+                </item>
+            </properties>
+        </subject>
+    </subjects>
+</state>""" == state_xml_str