Merge pull request #38 from sillydan1/dev

Release v1.4.0

.github/resources/example-project/project.json

@@ -15,4 +15,3 @@
         []
     ]
 }
-

.github/workflows/build-pr.yml

@@ -63,4 +63,3 @@ jobs:
         gradle-version: current
     - name: build
       run: gradle build
-

.github/workflows/build-release-artifacts.yml

@@ -145,4 +145,3 @@ jobs:
         push: true
         tags: ${{ steps.meta.outputs.tags }}
         labels: ${{ steps.meta.outputs.labels }}
-

.gitignore

@@ -44,4 +44,3 @@ metadata
 
 # never commit this file
 donotcommit.txt
-

CONTRIBUTION.md

@@ -20,4 +20,3 @@ Generally, try to follow the style that is already present and try to reuse exis
 
 ### Documentation
 Ideally, any `public` thing should have a javadoc comment.
-

Dockerfile

@@ -3,4 +3,3 @@ FROM nginx:alpine
 COPY nginx.conf /etc/nginx/nginx.conf
 COPY core/build/docs/javadoc /usr/share/nginx/html
 EXPOSE 80
-

Makefile

@@ -62,4 +62,3 @@ nvimclean: # useful when adding new subprojects, or when the java plugin gets co
 	rm -rf ${WRP}
 	rm -rf .project
 	rm -rf .classpath
-

PROGRESS.md

@@ -85,8 +85,6 @@
    - [x] flatpak
    - [x] GNOME store?
    - [x] javadoc
- - [ ] CD (needs a pre-release for prototyping purposes)
-   - [ ] flathub (needs an actual binary release)
  - [x] gitignored Project cache, such as what files did you have open last etc.
  - [x] windows menubar not showing
  - [x] Migraters
@@ -110,7 +108,7 @@
    - [x] Additions (new syntactic elements), Deletions (B does not have some syntactic element), Edits (Some syntactic element's properties has been changed)
    - [x] Cut / Copy / Paste support
  - [x] Lint layer
-   - [ ] Lint protobuf specification
+   - [x] Lint protobuf specification
    - [x] Implement `ILint` / `ILinter` interfaces
  - [x] Release core as a library on ossrh
  - [x] Additional Syntaxes
@@ -120,24 +118,43 @@
  - [x] Plugin Manager
  - [x] Fix TODOs
  - [x] Polish
- - [x] Release `v1.2.0
- - [ ] Third party language plugins
-   - [ ] TIOA 
-   - [ ] NTTA
-   - [ ] HAWK
-     - [ ] expr richtextfx.CodeArea implementation
- - [ ] Trace-traverser & specification
- - [ ] Plan for git integration
- - [ ] Diff view?
- - [x] Add plugin API and 
- - [x] LSP like specification (use docusaurus, or github wiki)
-   - [ ] Protobuf specification (that way, you are language agnostic)
-   - [x] Implement `ILsp` / `ILspEngine` interfaces
- - [ ] Release `v1.3.0`
- - [ ] Planarity Embedding
- - [ ] DAP like specification
-   - [ ] Protobuf specification (that way, you are language agnostic)
-   - [ ] Implement `IDap` / `IDapEngine` interfaces
+ - [x] Release `v1.3.0
+   - [x] Third party language plugins
+     - [x] NTTA
+     - [x] HAWK
+   - [x] Model metadata editor
+   - [x] Add plugin API and 
+   - [x] LSP like specification (use docusaurus, or github wiki)
+     - [x] Protobuf specification (that way, you are language agnostic)
+     - [x] Implement `ILsp` / `ILspEngine` interfaces
  - [ ] Release `v1.4.0`
- - [ ] Example lua plugin [LuaJava](https://github.com/gudzpoz/luajava/tree/main).
- - [ ] Release `v2.0.0`
+   - [ ] HAWK / nttals usability exploration fixes
+     - [ ] Importer / Exporter interfaces
+       - [x] importer interface & tapaal example
+       - [ ] exporter interface & tapaal example
+   - [ ] Fix TODOs
+   - [ ] Javadocs
+ - [ ] Release `v1.5.0`
+   - [ ] Purge github issues
+   - [ ] CodeArea tree highlighter implementation
+   - [ ] Trace-traverser & specification
+ - [ ] Release `v1.6.0`
+   - [ ] Plan for git integration
+   - [ ] Diff view?
+ - [ ] Release `v1.7.0`
+   - [ ] Planarity Embedding
+ - [ ] Release `v1.8.0`
+   - [ ] DAP like specification
+     - [ ] Protobuf specification
+     - [ ] Implement `IDap` / `IDapEngine` interfaces
+ - [ ] Release `v1.9.0`
+   - [ ] Clean up `DI` usage
+        Create some analysis tools, maybe a dependency graph from where things are added and where they are retrived again.
+   - [ ] Lua bindings [LuaJava](https://github.com/gudzpoz/luajava/tree/main).
+ - [ ] Release `v1.11.0`
+
+## Not abandoned, but not planned
+ - [ ] TIOA syntax
+ - [ ] TA syntax
+ - [ ] CD (needs a pre-release for prototyping purposes)
+   - [ ] flathub

README.md

@@ -7,7 +7,7 @@
 </p>
 
 <p align="center">
-   Graphedit is an application for visualising, creating, editing and debugging graph-based syntaxes
+   Graphedit is an application for visualising, creating, editing and debugging graph-based languages
 </p>
 
 ------
@@ -19,7 +19,7 @@
 </div>
 
 ## Build 💾
-The project is compiled using `gradle`:
+The project is compiled using `gradle` (version 7+):
 ```shell
 # Just build the app
 gradle build
@@ -67,7 +67,7 @@ Simply [Download the .msi](https://github.com/sillydan1/graphedit/releases/lates
 
 ## Architecture 🏛️
 Graphedit is designed from the ground up to be easy to extend with an opinionated, but easy to understand and efficient architecture.
-Note that at the time of writing a plugin-system is planned, but not implemented yet. So extensions must be done via PRs at the moment.
+You can extend the editor using plugins. Take a look at the [plugin github template](https://github.com/sillydan1/graphedit-plugin-template) to get started on writing your own plugin.
 
 ### Model View Viewmodel
 This project is strongly influenced by the [MVVM (Model View ViewModel)](https://en.wikipedia.org/wiki/Model–view–viewmodel) design pattern and the classes and packages are named appropriately so.

build.gradle

@@ -62,7 +62,7 @@ def gitHeadName = { ->
 }
 
 def getVersion = { ->
-    def version = '1.3.0';
+    def version = '1.4.0';
     def headName = gitHeadName();
     if(headName.equals('v'+version))
         return version;
@@ -123,7 +123,7 @@ subprojects {
         implementation group: 'dk.yalibs', name: 'yastreamgobbler', version: '1.0.0';
         implementation group: 'dk.yalibs', name: 'yaundo', version: '1.0.0';
         implementation group: 'dk.yalibs', name: 'yafunc', version: '1.0.0';
-        implementation group: 'dk.yalibs', name: 'yalazy', version: '1.0.0';
+        implementation group: 'dk.yalibs', name: 'yalazy', version: '1.1.0';
         implementation group: 'io.github.mkpaz', name: 'atlantafx-base', version: '2.0.1';
         implementation group: 'org.apache.tika', name: 'tika-core', version: '2.9.0'
         implementation group: 'org.fxmisc.richtext', name: 'richtextfx', version: '0.11.0'
@@ -146,6 +146,7 @@ subprojects {
     }
 
     javadoc {
+        exclude 'dk/gtz/graphedit/proto/**'
         if (JavaVersion.current().isJava9Compatible()) {
             options.addBooleanOption('html5', true)
         }

core/src/main/java/dk/gtz/graphedit/exceptions/ExportException.java

@@ -0,0 +1,31 @@
+package dk.gtz.graphedit.exceptions;
+
+/**
+ * An error occurred during exporting to a non-graphedit format.
+ */
+public class ExportException extends RuntimeException {
+    /**
+     * Construct a new instance with a message
+     * @param message The detail message
+     */
+    public ExportException(String message) {
+        super(message);
+    }
+
+    /**
+     * Construct a new instance with a message and a cause
+     * @param cause The cause
+     */
+    public ExportException(Throwable cause) {
+        super(cause);
+    }
+
+    /**
+     * Construct a new instance with a message and a cause
+     * @param message The detail message
+     * @param cause The cause
+     */
+    public ExportException(String message, Throwable cause) {
+        super(message, cause);
+    }
+}

core/src/main/java/dk/gtz/graphedit/exceptions/ImportException.java

@@ -0,0 +1,31 @@
+package dk.gtz.graphedit.exceptions;
+
+/**
+ * An error occurred during importing from a non-graphedit format.
+ */
+public class ImportException extends RuntimeException {
+    /**
+     * Construct a new instance with a message
+     * @param message The detail message
+     */
+    public ImportException(String message) {
+        super(message);
+    }
+
+    /**
+     * Construct a new instance with a cause
+     * @param cause The cause
+     */
+    public ImportException(Throwable cause) {
+        super(cause);
+    }
+
+    /**
+     * Construct a new instance with a message and a cause
+     * @param message The detail message
+     * @param cause The cause
+     */
+    public ImportException(String message, Throwable cause) {
+        super(message, cause);
+    }
+}

core/src/main/java/dk/gtz/graphedit/serialization/IModelSerializer.java

@@ -119,4 +119,10 @@ public interface IModelSerializer {
      * @param loader The additional loader to use when resolving classes
      */
     void addClassLoader(ClassLoader loader);
+
+    /**
+     * Get the preferred file extension for this serializer. e.g. ".json"
+     * @return A string representing the preferred file extension
+     */
+    String getPreferedFileExtension();
 }

core/src/main/java/dk/gtz/graphedit/serialization/JacksonModelSerializer.java

@@ -59,6 +59,11 @@ private ObjectMapper getMapper() {
 	return om;
     }
 
+    @Override
+    public String getPreferedFileExtension() {
+	return ".json";
+    }
+
     @Override
     public void addClassLoader(ClassLoader loader) {
 	for(var p : loader.getDefinedPackages()) {