Feedback

.github/workflows/linter.yml

@@ -0,0 +1,25 @@
+name: Lint Codebase
+
+on:
+  push: 
+  pull_request:
+
+jobs:
+  run-lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Lint Code Base
+        uses: github/super-linter/slim@v5
+        env:
+          VALIDATE_JSCPD: false
+          VALIDATE_MARKDOWN: false
+          VALIDATE_KOTLIN_ANDROID: false
+          VALIDATE_ALL_CODEBASE: false
+          DEFAULT_BRANCH: "main"
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+

.github/workflows/test.yml

@@ -0,0 +1,40 @@
+name: test with coverage
+on:
+  push:
+  pull_request:
+jobs:
+  build:
+    name: Build and Run Tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup Gradle
+        uses: gradle/gradle-build-action@v2
+      - name: Build with Gradle
+        run: ./gradlew build
+      - name: Cache Gradle packages
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/.gradle/caches
+            ~/.gradle/wrapper
+          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
+          restore-keys: |
+            ${{ runner.os }}-gradle
+      - name: JaCoCo Coverage Report
+        env:
+          report_path: trees/build/jacoco/report.csv
+        run: |
+          awk -F"," '{ instructions += $4 + $5; covered += $5; branches += $6 + $7; branches_covered +=$7 } END { print "Instructions covered:", covered"/"instructions, "--", 100*covered/instructions"%"; print "Branches covered:", branches_covered"/"branches, "--", 100*branches_covered/branches"%" }' $report_path
+      - uses: actions/upload-artifact@v3
+        with:
+          name: test-and-coverage-reports
+          path: trees/build/reports
+          retention-days: 365
+      - name: Cleanup Gradle Cache
+
+        # Remove some files from the Gradle cache, so they aren't cached by GitHub Actions.
+        # Restoring these files from a GitHub Actions cache might cause problems for future builds.
+        run: |
+          rm -f ~/.gradle/caches/modules-2/modules-2.lock
+          rm -f ~/.gradle/caches/modules-2/gc.properties

README.md

@@ -0,0 +1,62 @@
+# Trees library.
+> An open source library written in Kotlin to work with data structures such as AVL tree, red-black tree, and binary search tree..
+## 🖍 Used technology
+![Kotlin](https://img.shields.io/badge/-Kotlin-61DAFB?logo=kotlin)
+![Junit](https://img.shields.io/badge/-Junit-525A162?&style=for-the-badge)
+## :package: Getting started
+Firstly, you need to clone repository
+
+```sh
+https://github.com/spbu-coding-2022/trees-3.git
+```
+To build the library run
+
+```sh
+  ./gradlew build
+```
+## Using BinarySearchTree
+Any `Comparable` data can be stored in trees.
+You can start from create bst by:
+
+```kotlin
+    import bst.BSTree
+    val test_data = BSTree("121", "dgs", "tree_1")
+    //also we support add and remove elements from bst. You can do this by:
+    test_data.insert("110", "dafad")
+    test_data.insert("118", "adfaf")
+    test_data.insert("124", "fggsg")
+```
+
+find or remove element from tree:
+```kotlin    
+    test_data.remove("124")
+    test_data.find("118")
+```
+Same operations support RBT and AVL trees.
+
+
+BinarySearchTree supports save tree object to json file, and up tree from json.
+For example:
+```kotlin
+    test_data.saveTreeToJson()
+    readFromJson("tree_1.json")
+```
+
+In development saving nodes to databases: neo4j and sql.
+
+To save BST in SQL database we propose you to use models in directory main/db.
+for example:
+```kotlin
+        val treeObj = Tree.new {
+            name = "Tree_1"
+        }
+        val rootNode = Node.new {
+                key = "test"
+                value = "234"
+                tree = treeObj
+            }
+        treeObj.rootNode = rootNode
+```
+
+## Storing BSTs 
+`bst` provides 

app/build.gradle.kts

@@ -0,0 +1,32 @@
+plugins {
+    // Apply the org.jetbrains.kotlin.jvm Plugin to add support for Kotlin.
+    id("org.jetbrains.kotlin.jvm") version "1.8.10"
+
+    // Apply the application plugin to add support for building a CLI application in Java.
+    application
+}
+
+repositories {
+    // Use Maven Central for resolving dependencies.
+    mavenCentral()
+}
+
+dependencies {
+    // Use the Kotlin JUnit 5 integration.
+    testImplementation("org.jetbrains.kotlin:kotlin-test-junit5")
+
+    // Use the JUnit 5 integration.
+    testImplementation("org.junit.jupiter:junit-jupiter-engine:5.9.2")
+
+    implementation(project(":trees"))
+}
+
+application {
+    // Define the main class for the application.
+    mainClass.set("app.AppKt")
+}
+
+tasks.named<Test>("test") {
+    // Use JUnit Platform for unit tests.
+    useJUnitPlatform()
+}

gradle.properties

@@ -0,0 +1,4 @@
+sqliteJdbcVersion=3.41.2.1
+kotlinVersion=1.8.10
+neo4jDriverVersion=5.6.0
+exposedVersion=0.40.1

gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,6 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.0.2-bin.zip
+networkTimeout=10000
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists