Test for settings api

Author: neumond

computercraft/rproc.py

@@ -89,18 +89,23 @@ def proc(result):
     return proc
 
 
-def fact_scheme_dict(components):
+def fact_scheme_dict(required, optional):
+    required_keys = set(required.keys())
+    optional_keys = set(optional.keys())
+    assert required_keys & optional_keys == set()
+    all_keys = required_keys | optional_keys
+    all_fns = required.copy()
+    all_fns.update(optional)
+
     def proc(result):
         result = any_dict(result)
-        assert set(result.keys()) == set(components.keys())
-        return {key: component(result[key]) for key, component in components.items()}
+        result_keys = set(result.keys())
+        assert result_keys.issubset(all_keys)
+        assert required_keys.issubset(result_keys)
+        return {key: all_fns[key](value) for key, value in result.items()}
     return proc
 
 
-def fact_scheme_dict_kw(**components):
-    return fact_scheme_dict(components)
-
-
 def fact_mono_dict(key, value):
     def proc(result):
         result = any_dict(result)

computercraft/subapis/fs.py

@@ -2,15 +2,15 @@
 from typing import Optional, List
 
 from .base import BaseSubAPI, lua_string
-from ..rproc import boolean, string, integer, nil, array_string, option_string, fact_scheme_dict_kw
+from ..rproc import boolean, string, integer, nil, array_string, option_string, fact_scheme_dict
 
 
-attribute = fact_scheme_dict_kw(
-    created=integer,
-    modification=integer,
-    isDir=boolean,
-    size=integer,
-)
+attribute = fact_scheme_dict({
+    'created': integer,
+    'modification': integer,
+    'isDir': boolean,
+    'size': integer,
+}, {})
 
 
 class BaseHandle(BaseSubAPI):

computercraft/subapis/settings.py

@@ -1,17 +1,43 @@
 from typing import Any, List
 
 from .base import BaseSubAPI
-from ..rproc import nil, boolean, array_string
+from ..rproc import nil, boolean, string, array_string, fact_scheme_dict
+
+
+setting = fact_scheme_dict({
+    'changed': boolean,
+}, {
+    'description': string,
+    'default': lambda v: v,
+    'type': string,
+    'value': lambda v: v,
+})
 
 
 class SettingsAPI(BaseSubAPI):
     _API = 'settings'
 
+    async def define(self, name: str, description: str = None, default: Any = None, type: str = None):
+        options = {}
+        if description is not None:
+            options['description'] = description
+        if default is not None:
+            options['default'] = default
+        if type is not None:
+            options['type'] = type
+        return nil(await self._send('define', name, options))
+
+    async def undefine(self, name: str):
+        return nil(await self._send('undefine', name))
+
+    async def getDetails(self, name: str) -> dict:
+        return setting(await self._send('getDetails', name))
+
     async def set(self, name: str, value: Any):
         return nil(await self._send('set', name, value))
 
-    async def get(self, name: str, value=None) -> Any:
-        return await self._send('get', name, value)
+    async def get(self, name: str, default: Any = None) -> Any:
+        return await self._send('get', name, default)
 
     async def unset(self, name: str):
         return nil(await self._send('unset', name))
@@ -22,8 +48,8 @@ async def clear(self):
     async def getNames(self) -> List[str]:
         return array_string(await self._send('getNames'))
 
-    async def load(self, path: str) -> bool:
+    async def load(self, path: str = None) -> bool:
         return boolean(await self._send('load', path))
 
-    async def save(self, path: str) -> bool:
+    async def save(self, path: str = None) -> bool:
         return boolean(await self._send('save', path))

testmod.py

@@ -752,3 +752,102 @@ async def test_term_api(api):
     await term_step(api, 'You must have seen different shades of red made using palettes')
 
     await api.print('Test finished successfully')
+
+
+async def test_settings_api(api):
+    tbl = await get_object_table(api, 'settings')
+    assert get_class_table(api.settings.__class__) == tbl
+
+    await step(api, 'Settings will be cleared')
+
+    assert await api.settings.clear() is None
+    # names are not empty, there are system settings
+    assert isinstance(await api.settings.getNames(), list)
+
+    assert await api.settings.define('test.a') is None
+    assert await api.settings.define('test.b', description='b') is None
+    assert await api.settings.define('test.c', type='string') is None
+    assert await api.settings.define('test.d', default=42) is None
+
+    assert await api.settings.getDetails('test.a') == {
+        'changed': False,
+    }
+    assert await api.settings.getDetails('test.b') == {
+        'changed': False,
+        'description': 'b',
+    }
+    assert await api.settings.getDetails('test.c') == {
+        'changed': False,
+        'type': 'string',
+    }
+    assert await api.settings.getDetails('test.d') == {
+        'changed': False,
+        'default': 42,
+        'value': 42,
+    }
+
+    # redefining
+    assert await api.settings.define('test.a', type='number', default=11) is None
+
+    assert await api.settings.getDetails('test.a') == {
+        'changed': False,
+        'type': 'number',
+        'default': 11,
+        'value': 11,
+    }
+
+    assert await api.settings.get('test.a') == 11
+    assert await api.settings.set('test.a', 12) is None
+    assert await api.settings.get('test.a') == 12
+    with assert_raises(LuaException):
+        await api.settings.set('test.a', 'text')
+    assert await api.settings.get('test.a') == 12
+    assert await api.settings.unset('test.a') is None
+    assert await api.settings.get('test.a') == 11
+
+    assert await api.settings.set('test.c', 'hello') is None
+
+    assert {'test.a', 'test.b', 'test.c', 'test.d'}.issubset(set(await api.settings.getNames()))
+
+    assert await api.settings.undefine('test.a') is None
+    assert await api.settings.undefine('test.b') is None
+    assert await api.settings.undefine('test.c') is None
+    assert await api.settings.undefine('test.d') is None
+
+    assert 'test.c' in await api.settings.getNames()
+    assert await api.settings.get('test.c') == 'hello'
+    assert await api.settings.getDetails('test.c') == {
+        'changed': True,
+        'value': 'hello',
+    }
+
+    assert await api.settings.unset('test.c') is None
+
+    assert await api.settings.get('test.c') is None
+    assert await api.settings.getDetails('test.c') == {
+        'changed': False,
+    }
+
+    assert {'test.a', 'test.b', 'test.c', 'test.d'} & set(await api.settings.getNames()) == set()
+
+    assert await api.settings.set('test.e', [9, 'text', False]) is None
+    assert await api.settings.get('test.e') == [9, 'text', False]
+    assert await api.settings.clear() is None
+    assert await api.settings.get('test.e') is None
+
+    await api.fs.delete('.settings')
+
+    assert await api.settings.load() is False
+    assert await api.settings.save() is True
+    assert await api.settings.load() is True
+
+    await api.fs.delete('.settings')
+
+    assert await api.settings.set('key', 84) is None
+
+    assert await api.settings.save('sfile') is True
+    assert await api.settings.load('sfile') is True
+
+    await api.fs.delete('sfile')
+
+    await api.print('Test finished successfully')