Merge pull request #29 from Hayo87/release-polish

Release polish

Author: Hayo87

README.md

@@ -4,15 +4,15 @@
 
 # AutomataExplorer: visualize and compare automata
 
-The Automata Explores is a web-based tool to visualize differences and similarities between (finite) state machines. The tool is interactive and helps users to analyze, interpreted and understand the comparison results. The tool offers multiple filters and manipulations to investigate the results from different viewpoints and perspectives. To compare and merge the inputs into the difference automate the [gLTSdiff library](https://github.com/TNO/gLTSdiff) is used. The difference automata is a single combined automata where common parts, reference-only and subject-only are color coded, an example can be found below under preview. 
+The Automata Explores is a web-based tool to visualize differences and similarities between (finite) state machines. The tool is interactive and helps users to analyze, interpreted and understand the comparison results. The tool offers multiple filters and manipulations to investigate the results from different viewpoints and perspectives. To compare and merge the inputs into the difference automata the [gLTSdiff library](https://github.com/TNO/gLTSdiff) is used. The difference automata is a single combined automata where common parts, reference-only and subject-only are color coded, an example can be found below under preview. 
 
-This Automata Explores is developed in the context of automata learning and supports two kinds of automata's. A regular automata where the matching for the difference machine is based on the complete label. And the Mealy machine where the matching is based on input and output under the condition that labels are structured as *input/output*. The (backend) build and processing actions are standardized (type based) and therefore easy to extend to support new types or (gLTSDiff) build configurations.
+This Automata Explores is developed in the context of automata learning and supports two kinds of automata's. A regular automata where the matching for the difference machine is based on the complete label. And the Mealy machine where the matching is based on input and output under the condition that labels are structured as *input/output*. The (backend) build and processing actions are standardized (type based) and therefore easy to extend to support new types or difference automata  build configurations.
 
 ## Core features
 - **Input** two automata's in the [`.dot format`](https://graphviz.org/doc/info/lang.html) and visualize the difference machine. 
 - Select a **layout algorithm** that is most suitable for the visualization. 
 - Use **filters** and/or custom **processing actions** to investigate the result. 
-- Use the **context menu** options on visualization elements to work through the result or get detailed element information. 
+- Use the **context menu** options on visualization elements analyze the automata or to get detailed element information. 
 - **Export** the result as a `.pgn` or comprehensive `.pdf` report. 
 
 ## Preview

backend/src/main/java/io/github/Hayo87/controller/GlobalExceptionHandler.java

@@ -36,9 +36,6 @@ public ResponseEntity<ErrorDTO> handleBadRequest(BadRequestException e) {
             .body(new ErrorDTO("Invalid request: " + e.getMessage(), HttpStatus.BAD_REQUEST.value()));
     }
 
-
-
-
     /**
     * Handles validation failures for request DTOs annotated with {@code @Valid}
     *

backend/src/main/java/io/github/Hayo87/domain/handlers/AbstractDiffHandler.java

@@ -26,7 +26,7 @@ public static record ActionKey(Type type, SubType subtype) {}
      * Builds the action registry by associating each supported pair
      * with the corresponing processor. 
      */
-    public AbstractDiffHandler(List<DiffAutomatonProcessor<T>> processors) {
+    protected AbstractDiffHandler(List<DiffAutomatonProcessor<T>> processors) {
         this.actionRegistry = processors.stream()
             .flatMap(p -> p.keys().stream().map(key -> Map.entry(key, p)))
             .collect(Collectors.toMap(

docs/functionality.md

@@ -1,7 +1,6 @@
 # Functionality
 This page describes the functionality provide by the **AutomataExplorer** by page. 
 
-
 ## Upload Page
 <img src="img/UploadPage.png" alt="Upload Page" width="400"/>
 
@@ -44,16 +43,15 @@ Adjust the visualization using processing actions which modify the inputs or out
 - `Value`: the value(s) for the action. 
 
 #### Export
-- Export the visualization as a `.pgn`file.
-- Export the comparison result as a pfd report with the match results, image and table with transitions per type. 
+- Export the visualization as a `.pgn` image file.
+- Export the comparison result as a `.pdf` report with the match results, an image and a structured tabular with the edges. 
 
 #### About
 Display the about information.
 
 #### Exit
 Exit the visualization and return to the upload page. 
 
-
 ### Context Menu 
 On right click on nodes or edges a [context menu](https://github.com/cytoscape/cytoscape.js-cxtmenu) is presented.
 
@@ -64,4 +62,4 @@ On right click on nodes or edges a [context menu](https://github.com/cytoscape/c
 - Open info modal - display element information in a Modal.
 - Show / hide pie chart - display node as pie chart based on connected edges (node only)
 - Show neighbors - highlight connected transitions and edges.
-- Show / hide label - put label on node with a custom text (node only).
+- Show / hide label - put label on node with a custom text (node only).

docs/getting-started.md

@@ -1,6 +1,5 @@
 
 # Getting Started
-
 The application consist of a a Spring Boot backend and a React frontend. The setup is dockerized for easy deployment and usage. This guide will help you to run the Automata Explorer using Docker for regular users as well as developers.
 
 ## 👤 For Users

docs/structure-and-architecture.md

@@ -23,7 +23,6 @@ AutomataExplorer/
 └── README.md             # Root for project documentation
 ```
 
-
 ## Backend
 The Spring Boot backend exposes its functionality via a RESTfull api allowing clients to interact over HTTP using JSON. 
 
@@ -37,11 +36,9 @@ The Spring Boot backend exposes its functionality via a RESTfull api allowing cl
 
 A detailed API description for the backend services with all the endpoints and messages can be found [here](/docs/api.md).
 
-
 ### Controller
 The `restcontoller` handles all incoming HTTP request and acts as an entry point for the backend application. In the controller endpoints are mapped methods and request are orchestrated and delegated to the appropriate services. To decouple the internal (domain) model from the external API `Data Transfer Objects (DTOs)` are used. The `DTOs` define the JSON structures for the request and response messages used by the controller. 
 
-
 ### Services 
 The `service` layer contains the core logic for the Automata Explorer. The services generalized and designed with type-based components to support extensibility.
 
@@ -70,10 +67,8 @@ The `ProcessingModel` contains the enumeration types and data structures for the
 - The backend is equipped with an interactive Swagger UI for exploring and testing the REST API. The UI is available at `http://localhost:8080/swagger-ui/index.html#/`. This UI will show all available endpoints as well as all the request and response formats. The API can also be used from the browser directly. The openApi file can be downloaded via  `http://localhost:8080/v3/api-docs`. 
 - The backend the Grapviz dot tool to parse the input files. All files which conform to this specification will be parsed successfully.
 
-
 ### Tests 
 Automatic testing is part of the overall applications build pipeline using gitHub actions. About 60 test cases are crafted to validate the backend implementation. 
-
 - The controller is test using the `@webMvcTest`to validate the HTTPS request and response handling in isolation. 
 - The services are tested to validate the common business logic using `@SpringBootTest`, `Mockito` and `JUnit`. 
 - Integration test are performed to combine multiple behaviors to validate real workflows and edge cases. 
@@ -86,13 +81,12 @@ The frontend is built using React and Vite and written in typescript. The fronte
 2. The frontend sends the request to the backend and initiates the build without any processing actions.
 3. The frontend routes to the `VisualizationPage` loads the visualization and displays the build results. 
 4. The user can filter, change layout, select context menu actions and or modify the modal. 
-5. The user exits the application, the fronent sent a session close request to the backend.  
+5. The user exits the application, the frontend sent a session close request to the backend.  
 
 ### API
 - `SessionApi.tsx`: Utility for sending messages to the backend API and to enforce proper exception handling. 
 - `RequestResponse`: Contains all interfaces for the messages exchanged with the backend. 
 
-
 ### Hooks
 - `useSession`: Custom react hook that manages the state and encapsulates all communication with the backend API by leveraging the `sessionApi,tsx`. 
 - `useTransform`: Custom react hook to transform backend responses to usable data for the visualization. It decouples raw API data from rendering and visualization logic. 
@@ -103,5 +97,5 @@ The frontend is built using React and Vite and written in typescript. The fronte
 
 ### Components
 - `InfoModal`: a general Modal to be used in the application which can handle different inner contents such as `AboutContent`, `ActionContent`, `BuildContent` and `ElementContent`.  
-- `CytoscapeVisualization`: The action visualization component. To prevent the file to be bloated congifuration are implemented in the utils classes `attachContextCollapse`, `attachCytoscapeMenus`, `cytoScapeStyles` and `exportPdfs`.  
+- `CytoscapeCanvas`: The action visualization component. To prevent the file to be bloated configuration are implemented in the utils classes `attachContextCollapse`, `attachCytoscapeMenus`, `cytoScapeStyles` and `exportPdfs`.  
 - `DragAndDrop`: a drag and drop file upload element to be used in the `UploadPage`.  

frontend/README.md

@@ -9,7 +9,7 @@ server {
     }
 
     location /api/ {
-        proxy_pass http://backend:8080/;  # Match service name in docker-compose.yml
+        proxy_pass http://backend:8080/; 
         proxy_set_header Host $host;
         proxy_set_header X-Real-IP $remote_addr;
     }