Merge pull request #50 from whitemech/develop

Release 0.1.0

Author: marfvr

CONTRIBUTING.md

@@ -3,7 +3,7 @@
 Contributions are welcome, and greatly appreciated! Every little bit helps, and credit will always be given.
 
 If you need support, want to report/fix a bug, ask for/implement features, you can check the
-[Issues page](https://github.com/marcofavorito/logaut/issues)
-or [submit a Pull request](https://github.com/marcofavorito/logaut/pulls).
+[Issues page](https://github.com/whitemech/logaut/issues)
+or [submit a Pull request](https://github.com/whitemech/logaut/pulls).
 
 For other kinds of feedback, you can contact one of the [authors](./authors.md) by email.

HISTORY.md

@@ -1,5 +1,12 @@
 # History
 
+# 0.1.0
+
+First release. 
+
+- Synchronize with [`pylogics==0.1.0`](https://github.com/whitemech/pylogics) 
+  and [Lydia](https://github.com/whitemech/lydia) backend at version `0.1.1`.
+
 # 0.1.0a0
 
 First alpha release.

README.md

@@ -18,19 +18,19 @@
   <a href="">
     <img alt="PyPI - Wheel" src="https://img.shields.io/pypi/wheel/logaut">
   </a>
-  <a href="https://github.com/marcofavorito/logaut/blob/master/LICENSE">
+  <a href="https://github.com/whitemech/logaut/blob/master/LICENSE">
     <img alt="GitHub" src="https://img.shields.io/github/license/marcofavorito/logaut">
   </a>
 </p>
 <p align="center">
   <a href="">
-    <img alt="test" src="https://github.com/marcofavorito/logaut/workflows/test/badge.svg">
+    <img alt="test" src="https://github.com/whitemech/logaut/workflows/test/badge.svg">
   </a>
   <a href="">
-    <img alt="lint" src="https://github.com/marcofavorito/logaut/workflows/lint/badge.svg">
+    <img alt="lint" src="https://github.com/whitemech/logaut/workflows/lint/badge.svg">
   </a>
   <a href="">
-    <img alt="docs" src="https://github.com/marcofavorito/logaut/workflows/docs/badge.svg">
+    <img alt="docs" src="https://github.com/whitemech/logaut/workflows/docs/badge.svg">
   </a>
   <a href="https://codecov.io/gh/marcofavorito/logaut">
     <img alt="codecov" src="https://codecov.io/gh/marcofavorito/logaut/branch/master/graph/badge.svg?token=FG3ATGP5P5">
@@ -65,7 +65,7 @@ but with human-friendly APIs.
 
 To install the package from PyPI:
 ```
-pip install logaut==0.1.0a0
+pip install logaut==0.1.0
 ```
 
 Make sure to have [Lydia](https://github.com/whitemech/lydia) 
@@ -77,9 +77,11 @@ We suggest the following setup:
 ```
 docker pull whitemech/lydia:latest
 ```
-- Run the following commands:
+- Make the Docker image executable under the name `lydia`.
+  On Linux and MacOS machines, the following commands should work:
 ```
-echo 'docker run -v$(pwd):/home/default -it whitemech/lydia lydia $@' > lydia
+echo '#!/usr/bin/env sh' > lydia
+echo 'docker run -v$(pwd):/home/default whitemech/lydia lydia $@' >> lydia
 sudo chmod u+x lydia
 sudo mv lydia /usr/local/bin/
 ```

logaut/__init__.py

@@ -22,6 +22,6 @@
 
 """From LOGics to AUTomata"""
 
-__version__ = "0.1.0a0"
+__version__ = "0.1.0"
 
 from .core import fol2dfa, ldl2dfa, ltl2dfa, mso2dfa, pldl2dfa, pltl2dfa

logaut/backends/lydia/_lydia_utils.py

@@ -25,13 +25,24 @@
 import subprocess
 from typing import Match, cast
 
+from pylogics.helpers.misc import enforce
+
+from logaut.exceptions import LogautException
+
 
 def call_lydia(*args) -> str:
     """Call the Lydia CLI tool with the arguments provided."""
+    command = ["lydia", *args]
     try:
-        result = subprocess.run(["lydia", *args], stdout=subprocess.PIPE, check=True)
+        result = subprocess.run(command, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
         output = result.stdout.decode()
+        stderr = result.stderr.decode()
+        enforce(result.returncode == 0, exception_cls=LogautException)
         return output
+    except LogautException:
+        raise Exception(  # type: ignore
+            f"the Lydia command {' '.join(command)} failed.\nstdout={output}\nstderr={stderr}"  # type: ignore
+        )
     except Exception as e:
         raise Exception(f"an error occurred while running lydia: {str(e)}") from e
 

logaut/backends/lydia/to_lydia_grammar.py

@@ -32,21 +32,12 @@
     FalseFormula,
     Formula,
     Implies,
+    Logic,
     Not,
     Or,
     TrueFormula,
 )
-from pylogics.syntax.ldl import (
-    Box,
-    Diamond,
-    LDLFalse,
-    LDLTrue,
-    Prop,
-    Seq,
-    Star,
-    Test,
-    Union,
-)
+from pylogics.syntax.ldl import Box, Diamond, Prop, Seq, Star, Test, Union
 from pylogics.syntax.ltl import (
     Always,
     Eventually,
@@ -111,28 +102,16 @@ def to_string_atomic(formula: AbstractAtomic) -> str:
     return formula.name
 
 
-@to_string.register(TrueFormula)
-def to_string_true(_formula: TrueFormula) -> str:
-    """Transform the "true" formula into string."""
-    return "true"
-
-
-@to_string.register(FalseFormula)
-def to_string_false(_formula: FalseFormula) -> str:
-    """Transform the "false" formula into string."""
-    return "false"
-
-
 @to_string.register(Next)
 def to_string_next(formula: Next) -> str:
     """Transform a next formula into string."""
-    return f"X({to_string(formula.argument)})"
+    return f"X[!]({to_string(formula.argument)})"
 
 
 @to_string.register(WeakNext)
 def to_string_weak_next(formula: WeakNext):
     """Transform the weak next formula."""
-    return f"W({to_string(formula.argument)})"
+    return f"X({to_string(formula.argument)})"
 
 
 @to_string.register(Until)
@@ -208,16 +187,16 @@ def to_string_pltl_historically(formula: Historically) -> str:
     return f"H({to_string(formula.argument)})"
 
 
-@to_string.register(LDLTrue)
-def to_string_ldl_true(_formula: LDLTrue) -> str:
-    """Transform an LDL true into string."""
-    return "tt"
+@to_string.register(TrueFormula)
+def to_string_ldl_true(formula: TrueFormula) -> str:
+    """Transform a true into string."""
+    return "tt" if formula.logic != Logic.PL else "true"
 
 
-@to_string.register(LDLFalse)
-def to_string_ldl_false(_formula: LDLFalse) -> str:
-    """Transform an LDL false into string."""
-    return "ff"
+@to_string.register(FalseFormula)
+def to_string_ldl_false(formula: FalseFormula) -> str:
+    """Transform a false into string."""
+    return "ff" if formula.logic != Logic.PL else "false"
 
 
 @to_string.register(Diamond)

mkdocs.yml

@@ -1,6 +1,7 @@
-site_name: My Docs
-repo_name: 'marcofavorito/logaut'
-repo_url: https://github.com/marcofavorito/logaut
+site_name: Logaut Docs
+site_url: "https://whitemech.github.io/logaut/" 
+repo_name: 'whitemech/logaut'
+repo_url: "https://github.com/whitemech/logaut"
 
 nav:
 - Home: index.md
@@ -14,6 +15,11 @@ theme:
 markdown_extensions:
 - codehilite
 - pymdownx.arithmatex
+- pymdownx.highlight
+- pymdownx.superfences
+- pymdownx.emoji:
+    emoji_index: !!python/name:materialx.emoji.twemoji
+    emoji_generator: !!python/name:materialx.emoji.to_svg
 - markdown_include.include:
     base_path: docs