Merge pull request #391 from vil02/add_to_lua

feat: add `to_lua`

Author: vil02

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "string-to-code"
-version = "0.2.15"
+version = "0.3.0"
 description = "Generates a piece of messy code in a given language displaying a given string "
 authors = ["piotr.idzik <[email protected]>"]
 readme = "./string_to_code/README.md"

string_to_code/to_lua.py

@@ -0,0 +1,74 @@
+"""
+provides string_to_lua utilities
+"""
+
+from . import core
+from . import utils
+
+
+def _get_table_name(**kwargs) -> str:
+    return kwargs.get("table_name", "main")
+
+
+def _get_function_name(in_function_id: int, **kwargs) -> str:
+    prefix = _get_table_name(**kwargs) + "."
+    return prefix + kwargs.get("function_id_to_name", core.get_function_namer("fun_"))(
+        in_function_id
+    )
+
+
+def atom_to_code(in_atom: core.Atom) -> str:
+    """
+    returns a string/piece of lua code resulting in printing the
+    in_atom.atom_char to the standard output
+    """
+    if in_atom.atom_char == "\n":
+        return "print()"
+    if in_atom.atom_char == '"':
+        return "io.write('\"')"
+    special_chars = {"\\": "\\\\", "\t": "\\t"}
+    res_char = special_chars.get(in_atom.atom_char, in_atom.atom_char)
+    write_arg = f'"{res_char}"'
+    return f"io.write({write_arg})"
+
+
+_function_call_str = utils.get_function_call_str_fun(_get_function_name, "", "()")
+
+_call_function_or_atom = utils.get_call_function_or_atom(
+    atom_to_code, _function_call_str
+)
+
+
+_body_to_str = utils.get_body_to_str("\n", "\t", _call_function_or_atom, "", "")
+
+
+def _merge_to_full_function(in_function_name, in_function_body):
+    function_body = " "
+    if in_function_body:
+        function_body = "\n" + in_function_body + "\n"
+    return f"function {in_function_name}()" + function_body + "end\n"
+
+
+_function_to_code = utils.get_function_to_code(
+    _get_function_name, _body_to_str, _merge_to_full_function
+)
+
+
+def _main_call_to_code(in_initial_call, **kwargs):
+    return (
+        _call_function_or_atom(in_initial_call, **kwargs) + "\n"
+        if in_initial_call is not None
+        else ""
+    )
+
+
+def _join_to_final(main_call, function_definitions, **kwargs):
+    res = "\n".join(function_definitions + [main_call])
+    if function_definitions:
+        res = "local " + _get_table_name(**kwargs) + " = {}\n\n" + res
+    return res
+
+
+proc_printer_program, proc = utils.get_all_proc_functions(
+    _main_call_to_code, _function_to_code, _join_to_final
+)

system_setup_scripts/setup_for_lua.sh

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+apt-get install -y --no-install-recommends luarocks
+luarocks install luacheck

tests/example_data/lua/function_used_twice.lua

@@ -0,0 +1,14 @@
+local main = {}
+
+function main.fun_0()
+	io.write("{")
+	io.write("%")
+end
+
+function main.fun_1()
+	main.fun_0()
+	print()
+	main.fun_0()
+end
+
+main.fun_1()

tests/example_data/lua/one_empty_function.lua

@@ -0,0 +1,10 @@
+local main = {}
+
+function main.fun_0() end
+
+function main.fun_1()
+	main.fun_0()
+	io.write("C")
+end
+
+main.fun_1()

…/unused_example_data/lua/single_atom.lua tests/example_data/lua/single_atom.luatests/unused_example_data/lua/single_atom.lua renamed to tests/example_data/lua/single_atom.lua tests/unused_example_data/lua/single_atom.lua renamed to tests/example_data/lua/single_atom.lua

@@ -0,0 +1,62 @@
+"""
+setup for the tests of the module string_to_lua
+"""
+
+import general_utilities as gu
+
+from string_to_code import to_lua
+
+
+def get_lua():
+    """returns the name of the lua interpreter"""
+    return "lua"
+
+
+def get_luacheck():
+    """returns the name of luacheck"""
+    return "luacheck"
+
+
+def _get_source_code_file_extension():
+    return "lua"
+
+
+def run_lua_code(in_code, tmp_folder):
+    """
+    Runs the lua code in_code.
+    Returns the output of the program.
+    """
+    source_filename = gu.get_unique_filename(
+        tmp_folder, _get_source_code_file_extension()
+    )
+    gu.save_str_to_file(tmp_folder / source_filename, in_code)
+
+    gu.subprocess_run_with_check(
+        [
+            get_luacheck(),
+            source_filename,
+        ],
+        cwd=str(tmp_folder),
+        capture_output=True,
+        text=True,
+    )
+
+    res = gu.subprocess_run_with_check(
+        [get_lua(), source_filename],
+        cwd=str(tmp_folder),
+        capture_output=True,
+        text=True,
+    )
+    return res
+
+
+def get_test_data():
+    """returns test data for the module string_to_lua"""
+    return gu.Language(
+        tool_names=[get_lua(), get_luacheck()],
+        string_to_code=to_lua.proc,
+        printer_program_to_code=to_lua.proc_printer_program,
+        run_code=run_lua_code,
+        id="lua",
+        source_code_file_extension=_get_source_code_file_extension(),
+    )