Add schema AST, refactor lib

Author: rebecca-odonoghue

rsvp/.gitattributes .gitattributesrsvp/.gitattributes renamed to .gitattributes

@@ -1,2 +1,15 @@
+# IDE
 .vscode
 .idea
+
+# Gradle
+**/.gradle
+**/.kotlin
+
+# Build dirs
+rsvp/build
+rsvp/bin
+rsvp/app/build
+rsvp/app/bin
+rsvp/policy-ast/build
+rsvp/policy-ast/bin

.gitignore

@@ -9,21 +9,19 @@ Before building this project, you will need to build and deploy CedarJava locall
   1. Clone CedarJava somewhere on your machine:
      ```
      git clone git@github.com:rebecca-odonoghue/cedar-java.git
+     cd cedar-java
      ```
   2. Build CedarJava:
      ```
-     cd CedarJava
-     ./gradlew build
+     ./CedarJava/gradlew build -p ./CedarJava
      ```
   3. Optionally, run the Rust test suite that is not executed as part of the Gradle build:
      ```
-     cd CedarJavaFFI
-     cargo test
+     cargo test --manifest-path CedarJavaFFI/Cargo.toml
      ```
   4. Deploy CedarJava locally:
      ```
-     cd CedarJava
-     ./gradlew publishToMavenLocal
+     ./CedarJava/gradlew publishToMavenLocal -p ./CedarJava
      ```
 
 - Build:
@@ -32,13 +30,14 @@ Before building this project, you will need to build and deploy CedarJava locall
   ./gradlew build
   ```
 
-- Run tests and output coverage to `app/build/reports/jacoco/test/html/index.html`:
+- Run tests and output coverage to `**/build/reports/jacoco/test/html/index.html`:
 
   ```
   ./gradlew test
   ```
 
 - Run CLI application:
+
   ```
   ./gradlew run --args="optional string of space separated args"
   ```
@@ -48,15 +47,16 @@ Before building this project, you will need to build and deploy CedarJava locall
   ./gradlew publishToMavenLocal
   ```
 
-## Implement a new visitor
+## Implement a new policy visitor
 
-Visitor classes can be found in the `uq.pac.rsvp.ast.visitor` package. Visitors that don't need to visit every node but would still like to traverse the entire tree can extend the `PolicyVisitorImpl` class. Otherwise, interface `PolicyVisitor` can be implemented directly.
+Visitor classes can be found in the `uq.pac.rsvp.policy.ast.visitor` package. Visitors that don't need to visit every node type but would still like to traverse the entire tree can extend the `PolicyVisitorImpl` class. Otherwise, interface `PolicyVisitor` can be implemented directly.
 
-The JSON schema for the serialised Java AST defined in `app/src/main/resources/ast.schema.json`.
+The JSON schema for the serialised Java AST is defined in `lib/src/main/resources/ast.schema.json`. A schema for the Cedar JSON
+Schema syntax can be found in the [Cedar VSCode Extension repository](https://raw.githubusercontent.com/cedar-policy/vscode-cedar/refs/heads/main/schemas/cedarschema.schema.json).
 
-## Using the library in another project
+## Using the policy AST library in another project
 
-In `build.gradle` in the project:
+Include in `build.gradle`:
 
 ```
 repositories {
@@ -65,7 +65,7 @@ repositories {
 }
 
 dependencies {
-    implementation 'uq.pac.rsvp.ast:rsvp-ast-lib:1.0.0'
+    implementation 'uq.pac.rsvp:policy-ast:1.0.0'
 }
 
 ```

rsvp/.gitignore

@@ -3,7 +3,7 @@ plugins {
 }
 
 dependencies {
-    implementation project(':lib')
+    implementation project(':policy-ast')
 }
 
 jar {

rsvp/README.md

@@ -8,17 +8,18 @@ allprojects {
     }
 
     dependencies {
+        // Custom cedar-java fork (https://github.com/rebecca-odonoghue/cedar-java)
+        implementation 'com.cedarpolicy:cedar-java:3.1.2-rsvp:uber'
+
         implementation 'com.google.code.gson:gson:2.13.2'
 
+        implementation 'com.fasterxml.jackson.core:jackson-databind:2.20.0'
+
         // Use JUnit Jupiter for testing.
         testImplementation libs.junit.jupiter
-
         testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
 
-        // This dependency is used by the application.
-        implementation libs.guava
 
-        implementation 'com.cedarpolicy:cedar-java:3.1.2-rsvp:uber'
     }
 
     // Apply a specific Java toolchain to ease working on different environments.

rsvp/app/build.gradle

@@ -5,8 +5,8 @@ plugins {
 publishing {
     publications {
         mavenJava(MavenPublication) {
-            groupId "uq.pac.rsvp.ast"
-            artifactId "rsvp-ast-lib"
+            groupId "uq.pac.rsvp"
+            artifactId "policy-ast"
             version "1.0.0"
             from components.java
         }

rsvp/build.gradle

@@ -8,14 +8,27 @@
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
 
+import uq.pac.rsvp.policy.ast.expr.EntityExpression;
 import uq.pac.rsvp.policy.ast.expr.Expression;
+import uq.pac.rsvp.policy.ast.expr.EntityExpression.EntityExpressionDeserialiser;
 import uq.pac.rsvp.policy.ast.expr.Expression.ExpressionDeserialiser;
 
 public class PolicySet extends LinkedHashSet<Policy> {
 
+    /**
+     * Parse a Cedar policy file and return the corresponding AST.
+     * 
+     * @param policyFile the path to the Cedar policy file
+     * @return a new PolicySet instance corresponding to the parsed Cedar policy
+     *         file
+     * @throws InternalException If an error occurs while parsing the Cedar policy
+     *                           file
+     * @throws IOException       If an IO error occurs while reading the policy file
+     */
     public static PolicySet parseCedarPolicySet(Path policyFile) throws InternalException, IOException {
         String json = com.cedarpolicy.model.policy.PolicySet.parseToJsonAst(policyFile);
         Gson gson = new GsonBuilder().registerTypeAdapter(Expression.class, new ExpressionDeserialiser())
+                .registerTypeAdapter(EntityExpression.class, new EntityExpressionDeserialiser())
                 .create();
         return gson.fromJson(json, PolicySet.class);
     }