spbu-coding-2022 · github-classroom · Mar 20, 2023 · Mar 23, 2023 · Mar 23, 2023 · Mar 24, 2023
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,9 @@
+#
+# https://help.github.com/articles/dealing-with-line-endings/
+#
+# Linux start script should use lf
+/gradlew        text eol=lf
+
+# These are Windows script files and should use crlf
+*.bat           text eol=crlf
+
diff --git a/.github/mergeable.yml b/.github/mergeable.yml
@@ -0,0 +1,30 @@
+version: 2
+mergeable:
+  - when: pull_request.*, pull_request_review.*
+    filter:
+      # ignore 'Feedback' PR
+      - do: payload
+        pull_request:
+          title:
+            must_exclude:
+              regex: ^Feedback$
+              regex_flag: none
+    validate:
+      - do: description
+        no_empty:
+          enabled: true
+          message: "Description matter and should not be empty. Provide detail with **what** was changed, **why** it was changed, and **how** it was changed."
+      - do: approvals
+        min:
+          count: 1
+        required:
+          assignees: true
+
+  - when: pull_request.opened
+    name: "Remind about contributing guidelines"
+    validate: [ ]
+    pass:
+      - do: comment
+        payload:
+          body: >
+            Thanks for creating a pull request! Please, check that your pull request meets the [CONTRIBUTING](./CONTRIBUTING.md) requirements.
diff --git a/.github/workflows/github-actions.yml b/.github/workflows/github-actions.yml
@@ -0,0 +1,30 @@
+name: Build CI
+
+on:
+  pull_request:
+    branches:
+      - main
+      - release
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os: [ macos-latest, ubuntu-latest, windows-latest ]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: zulu
+      - name: Build & test with Gradle
+        uses: gradle/gradle-build-action@v2
+        with:
+          arguments: build
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,51 @@
+.gradle
+build/
+!gradle/wrapper/gradle-wrapper.jar
+!**/src/main/**/build/
+!**/src/test/**/build/
+### IntelliJ IDEA ###
+.idea/modules.xml
+.idea/jarRepositories.xml
+.idea/compiler.xml
+.idea/libraries/
+*.iws
+*.iml
+*.ipr
+out/
+!**/src/main/**/out/
+!**/src/test/**/out/
+
+### Eclipse ###
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+.sts4-cache
+bin/
+!**/src/main/**/bin/
+!**/src/test/**/bin/
+
+### NetBeans ###
+/nbproject/private/
+/nbbuild/
+/dist/
+/nbdist/
+/.nb-gradle/
+
+### VS Code ###
+.vscode/
+
+### Mac OS ###
+.DS_Store
+/.idea/.name
+/.idea/gradle.xml
+/.idea/kotlinc.xml
+/.idea/misc.xml
+/.idea/vcs.xml
+/.idea/
+
+# Ignore Gradle build output directory
+build
+/app/build
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,39 @@
+# Making edits
+
+## Basic Tips
+
+1. Don't use merge, only rebase (to keep a linear commit history)
+2. Do not change other people's branches unless absolutely necessary
+3. Recheck your commit history before creating a pull request
+4. **Check you're on the right branch**, never commit directly in main
+
+## Rules for adding commits
+
+Commits are added according to conventional commits. Those
+`<type>(<scope>): <body>`.
+
+The `<type>` field must take one of these values:
+
+* `feat` to add new functionality
+* `fix` to fix a bug in the program
+* `refactor` for code refactoring, such as renaming a variable
+* `test` to add tests, refactor them
+* `struct` for changes related to a change in the structure of the project (BUT NOT CODE), for example, changing
+  folder locations
+* `ci` for various ci/cd tasks
+
+The `<body>` field contains the gist of the changes in the present imperative in English without the dot in
+at the end, the first word is a verb with a small letter.
+Examples:
+
+* Good: "feat: Add module for future BST implementations"
+* Bad: "Added module for future BST implementations."
+
+## Rules for pull requests
+
+**Forbidden** to merge your pull request into the branch yourself.
+
+If you click on the green button, then **make sure** that it says `REBASE AND MERGE`
+
+The review takes place in the form of comments to pull requests, discussions in the team chat and personal
+communication.
diff --git a/DOCS.md b/DOCS.md
@@ -0,0 +1,111 @@
+## Getting started
+
+To build the library run
+
+```bash
+  ./gradlew build
+```
+
+## Using Trees
+
+Any `Comparable` data can be stored in trees.
+We also provide access to the `KeyValue` class, which allows you to store a key-value pair in the nodes of the tree.
+
+```kotlin
+import lib.trees.AVLTree
+import lib.trees.RBTree
+import lib.trees.BSTree
+import lib.trees.KeyValue
+
+val alvTree = AVLTree<Int>() // instantiate empty AVL tree
+val bsTree = BSTree<String>() // instantiate empty simple tree
+val rbTree = RBTree<KeyValue<Int, String>>() // instantiate empty red-black tree with key-value
+```
+
+Each tree supports 3 basic operations: `add`, `contain`, `delete` and `get` (if you need to get value by key using
+KeyValue)
+
+```kotlin
+avlTree.add(42)
+bsTree.add("42")
+rbTree.add(KeyValue(42, "42"))
+bsTree.contain("42") // returns true
+avlTree.contain(1) // returns false
+rbTree.get(KeyValue(42, null))?.getValue() // returns "42"
+```
+
+Trees' nodes can be read-only accessed by `root` property.
+
+```kotlin
+avlTree.add(10)
+avlTree.add(5)
+avlTree.add(20)
+avlTree.add(30)
+avlTree.add(42)
+// avlTree after balancing:
+//             10
+//    ┌─────────┴─────────┐
+//    5                  30
+//                     ┌──┴──┐
+//                    20     42
+
+avlTree.root?.data // 10
+avlTree.root?.left?.data // 5
+avlTree.root?.right?.data // 30
+avlTree.root?.right?.right?.data // 42
+avlTree.root?.right?.left?.data // 20
+```
+
+## Storing Trees
+
+`teemEight` provides `JsonRepository`, `SqlRepository` and `Neo4jRepository` to save & load trees.
+
+Each instance of repository is used to store exactly 1 tree type. To store different tree types several repositories can
+be instantiated.
+Repository must be provided with `Serialization` which describes how to serialize & deserialize any particular
+type of tree.
+
+`bstrees` is shipped with `AVLStrategy`, `RBStrategy` and `SimpleStrategy` to serialize & deserialize AVL trees,
+Red-black trees and Simple BSTs respectively. As these strategies don't know anything about the data type stored in
+trees' nodes, user must provide `serializeData` and `deserializeData` functions to them.
+
+Different tree types can be stored in the same database (directory) by creating several repositories and passing them
+same databases (directory paths).
+
+### Using Neo4j
+
+Before using this, you must have [Docker](https://www.docker.com/) (also see [docs](https://docs.docker.com/))
+
+#### Before started
+
+1. Run docker container with `docker-compose.yml`
+2. Open http://localhost:7474
+3. Create new user (default password: neo4j)
+4. Change the password
+5. You got this
+
+#### Example
+
+```kotlin
+val username = "neo4j"
+val password = "" // insert password to database here
+val conf = Configuration.Builder()
+    .uri("bolt://localhost")
+    .credentials(username, password)
+    .build()
+
+fun serializeInt(data: Int) = SerializableValue(data.toString())
+
+fun deserializeInt(data: SerializableValue) = data.value.toInt()
+
+val avlRepo = Neo4jRepo(AVLStrategy(::serializeInt, ::deserializeInt), conf)
+
+
+val tree = AVLTree<Int>()
+val randomizer = Random(42)
+val lst = List(15) { randomizer.nextInt(1000) }
+lst.forEach { tree.add(it) }
+avlRepo.save("test", tree)
+val testTree = avlRepo.loadByName("test")
+println(testTree.preOrder()) // output pre-order traversal of tree
+```