Feedback

.github/formatter.yml

@@ -0,0 +1,13 @@
+name: formatter
+on: [push, pull_request]
+jobs:
+  check-formatted:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v4
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v3
+      - name: Check formatter
+        run: ./gradlew ktfmtCheck
+

.github/mergeable.yml

@@ -0,0 +1,27 @@
+version: 2
+mergeable:
+  - when: 'pull_request.*, pull_request_review.*'
+    name: Approvals check
+    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
+        block:
+          changes_requested: true
+        limit:
+          users:
+            - DronShock
+            - suvorovrain
+            - Sem4kok

.run/desktop.run.xml

@@ -1,21 +1,24 @@
 <component name="ProjectRunConfigurationManager">
-    <configuration default="false" name="desktop" type="GradleRunConfiguration" factoryName="Gradle">
-        <ExternalSystemSettings>
-            <option name="executionName"/>
-            <option name="externalProjectPath" value="$PROJECT_DIR$"/>
-            <option name="externalSystemIdString" value="GRADLE"/>
-            <option name="scriptParameters" value=""/>
-            <option name="taskDescriptions">
-                <list/>
-            </option>
-            <option name="taskNames">
-                <list>
-                    <option value="run"/>
-                </list>
-            </option>
-            <option name="vmOptions" value=""/>
-        </ExternalSystemSettings>
-        <GradleScriptDebugEnabled>true</GradleScriptDebugEnabled>
-        <method v="2"/>
-    </configuration>
+  <configuration default="false" name="desktop" type="GradleRunConfiguration" factoryName="Gradle">
+    <ExternalSystemSettings>
+      <option name="executionName" />
+      <option name="externalProjectPath" value="$PROJECT_DIR$" />
+      <option name="externalSystemIdString" value="GRADLE" />
+      <option name="scriptParameters" value="--stacktrace" />
+      <option name="taskDescriptions">
+        <list />
+      </option>
+      <option name="taskNames">
+        <list>
+          <option value="run" />
+        </list>
+      </option>
+      <option name="vmOptions" value="" />
+    </ExternalSystemSettings>
+    <ExternalSystemDebugServerProcess>true</ExternalSystemDebugServerProcess>
+    <ExternalSystemReattachDebugProcess>true</ExternalSystemReattachDebugProcess>
+    <DebugAllEnabled>false</DebugAllEnabled>
+    <RunAsTest>false</RunAsTest>
+    <method v="2" />
+  </configuration>
 </component>

README.md

@@ -0,0 +1,83 @@
+
+# ZeitNot - Graph Analyzer App
+ Это приложение позволяет выделять сообщества, находить ключевые вершины и делать раскладку направленных и ненаправленных, взвешенных и не взвешенных графов. Также поддерживается набор алгоритмов для анализа графа, в него входят алгоритм Форда-Беллмана, алгоритм Дейкстры и другие.
+ Приложение поддерживает сохранение в хранилища `SQL`, `CSV`, И `Neo4J`
+
+
+## Установка и запуск
+ Приложение работает на Java SDK 21 версии. 
+
+- Установка:
+
+```
+git@github.com:spbu-coding-2023/graphs-graph-7.git
+```
+- Запуск:
+
+
+#### Linux
+
+```
+./gradlew run
+```
+
+## Раскладка графа
+ Для раскладки графа используется алгоритм [ForceAtlas2](https://journals.plos.org/plosone/article?id=10.1371/journal.pone.0098679).     
+
+
+## SQLite
+ Приложение может читать два типа баз данных.
+ При этом сохраняются все базы данных во второй тип
+
+ 1) Необработанный граф. Две таблицы -- на ребра и вершины графа
+
+
+### Vertices
+
+|  id | data | community |
+|--|--|--|
+| *integer* | *text* | -1 |
+
+`id` - уникальный идентификационный номер
+`data` - информация, хранимая в вершине
+`community` - информация о том, находится ли вершина в сообществе. Изначально равняется `-1`, после выполнения алгоритма кластеризации, равняется номеру сообщества
+### Edges
+
+|  id  | first | second | weight | 
+|--|--|--| -- |
+| *integer*  | *int* | *int* |*Long* |
+
+ `id` - уникальный идентификационный номер
+ `first` - **id** первой вершины, в случае направленного графа, считается началом ребра
+ `second` -**id** второй вершины, в случае направленного графа, считается концом ребра
+ `weight` - вес ребра. В случае не взвешенного графа, у всех ребер он равен единице
+
+2. Обработанный граф. В таком случае должна быть третья таблица, а в таблице **Vertices** в поле **community** вместо -1 могут стоять непосредственно номера community
+
+### _**VerticesView**_
+
+|  id| vertex | x | y| color |
+|--|--|--|--|--|
+| *integer* | *int* | *double*| *double*| *text*|
+
+ `id` -  уникальный идентификационный номер
+
+ `vertex`- **id** вершины из таблицы **Vertices**
+
+ `x, y` - координаты вершины
+
+ `color` - цвет формата RGB в следующем виде "r:g:b",  где r,g,b - float.
+
+ ### Как открыть граф? (SQL)
+
+Cохраненные графы находятся в `/saves/sqlite/`
+Для загрузки базы данных из данной директории, выберите в меню загрузки формат SQL и укажите название графа. Для запуска примера напишите
+```
+Shelbiks.db
+```
+
+### Как сохранить граф? (SQL)
+Сохранение происходит в меню сохранения. Достаточно выбрать формать SQL и указать название графа в формате `name.db`. Граф будет сохранен в `/saves/sqlite/`
+
+---------
+[WIP]

build.gradle.kts

@@ -3,23 +3,41 @@ import org.jetbrains.compose.desktop.application.dsl.TargetFormat
 plugins {
     kotlin("jvm")
     id("org.jetbrains.compose")
+    id("com.ncorti.ktfmt.gradle") version "0.18.0"
+}
+
+ktfmt {
+    // KotlinLang style - 4 space indentation - From kotlinlang.org/docs/coding-conventions.html
+    kotlinLangStyle()
 }
 
 group = "com.graph"
 version = "1.0-SNAPSHOT"
 
 repositories {
     mavenCentral()
+    maven("https://raw.github.com/gephi/gephi/mvn-thirdparty-repo/")
     maven("https://maven.pkg.jetbrains.space/public/p/compose/dev")
     google()
 }
-
+val exposedVersion: String by project
+val neo4jDriverVersion = "4.4.5"
 dependencies {
-    // Note, if you develop a library, you should use compose.desktop.common.
-    // compose.desktop.currentOs should be used in launcher-sourceSet
-    // (in a separate module for demo project and in testMain).
-    // With compose.desktop.common you will also lose @Preview functionality
+    implementation("org.gephi", "gephi-toolkit", "0.10.1", classifier = "all")
+    testImplementation("org.junit.jupiter:junit-jupiter-api:5.7.0")
+    testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:5.7.0")
+    implementation("org.jetbrains.exposed:exposed-core:$exposedVersion")
+    implementation("org.jetbrains.exposed:exposed-dao:$exposedVersion")
+    implementation("org.jetbrains.exposed:exposed-jdbc:$exposedVersion")
     implementation(compose.desktop.currentOs)
+    implementation(compose.material3)
+    implementation(compose.foundation)
+    implementation("org.slf4j:slf4j-nop:latest.release")
+    implementation("com.github.doyaaaaaken:kotlin-csv-jvm:0.15.2")
+    implementation("io.github.blackmo18:kotlin-grass-jvm:0.7.1")
+    implementation("org.neo4j.driver:neo4j-java-driver:$neo4jDriverVersion")
+    testRuntimeOnly("org.junit.platform:junit-platform-launcher")
+    testImplementation("org.jetbrains.kotlin:kotlin-test-junit5")
 }
 
 compose.desktop {
@@ -33,3 +51,24 @@ compose.desktop {
         }
     }
 }
+
+tasks.named<Test>("test") {
+    // Use JUnit Platform for unit tests.
+    useJUnitPlatform()
+}
+tasks.withType<Test> {
+    testLogging {
+        events("PASSED", "SKIPPED", "FAILED")
+    }
+
+    tasks.register<Copy>("copyPreCommitHook") {
+        description = "Copy pre-commit git hook from the scripts to the .git/hooks folder."
+        group = "git hooks"
+        outputs.upToDateWhen { false }
+        from("$rootDir/scripts/pre-commit")
+        into("$rootDir/.git/hooks/")
+    }
+    tasks.build {
+        dependsOn("copyPreCommitHook")
+    }
+}

gradle.properties

@@ -2,3 +2,4 @@ org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8
 kotlin.code.style=official
 kotlin.version=1.9.22
 compose.version=1.6.0
+exposedVersion=0.50.1

saves/csv/Example.csv

@@ -0,0 +1,44 @@
+isNode,name,id,x,y,color,radius,community,from,to,weight
+
+true,13,Sniper,457.3282.dp,342.71585.dp,0.0/0.0/0.0,25.0.dp,-1,,,
+true,14,Roshan,433.53894.dp,660.1613.dp,0.0/0.0/0.0,25.0.dp,-1,,,
+true,7,Ryan,421.50995.dp,499.64575.dp,0.0/0.0/0.0,25.0.dp,-1,,,
+true,12,Lion,725.70276.dp,1026.5232.dp,0.0/0.0/0.0,25.0.dp,-1,,,
+true,5,Tristan,800.8322.dp,23.990685.dp,0.0/0.0/0.0,25.0.dp,-1,,,
+true,10,Lycan,592.7067.dp,935.848.dp,0.0/0.0/0.0,25.0.dp,-1,,,
+true,20,6,1498.49.dp,499.64575.dp,0.0/0.0/0.0,25.0.dp,-1,,,
+true,17,3,1264.1929.dp,93.83106.dp,0.0/0.0/0.0,25.0.dp,-1,,,
+true,11,Io,1040.4828.dp,1073.9686.dp,0.0/0.0/0.0,25.0.dp,-1,,,
+true,15,1,960.0.dp,0.0.dp,0.53333336/0.53333336/0.53333336,25.0.dp,-1,,,
+true,2,Andrew,1427.6537.dp,810.0.dp,0.0/0.0/0.0,25.0.dp,-1,,,
+true,19,5,1462.6719.dp,342.71585.dp,0.0/0.0/0.0,25.0.dp,-1,,,
+true,4,John,879.51715.dp,1073.9686.dp,0.0/0.0/0.0,25.0.dp,-1,,,
+true,16,2,1119.1678.dp,23.990685.dp,0.0/0.0/0.0,25.0.dp,-1,,,
+true,21,7,1486.461.dp,660.1613.dp,0.0/0.0/0.0,25.0.dp,-1,,,
+true,1,Thomas,537.811.dp,203.3155.dp,0.0/0.0/0.0,25.0.dp,-1,,,
+true,3,Iakov,1194.2972.dp,1026.5232.dp,0.0/0.0/0.0,25.0.dp,-1,,,
+true,8,Pudge,492.34628.dp,810.0.dp,0.0/0.0/0.0,25.0.dp,-1,,,
+true,18,4,1382.189.dp,203.3155.dp,0.0/0.0/0.0,25.0.dp,-1,,,
+true,6,Arthur,1327.2933.dp,935.848.dp,0.0/0.0/0.0,25.0.dp,-1,,,
+true,9,Tiny,655.8072.dp,93.83106.dp,0.0/0.0/0.0,25.0.dp,-1,,,
+false,19,,,,,,,20,15,5.0
+false,21,,,,,,,14,20,0.0
+false,10,,,,,,,14,11,6.0
+false,20,,,,,,,17,20,0.0
+false,3,,,,,,,1,3,3.0
+false,4,,,,,,,2,3,4.0
+false,6,,,,,,,3,7,6.0
+false,15,,,,,,,15,17,1.0
+false,14,,,,,,,16,15,22.0
+false,16,,,,,,,15,18,6.0
+false,9,,,,,,,14,10,6.0
+false,12,,,,,,,14,13,5.0
+false,5,,,,,,,5,3,5.0
+false,2,,,,,,,3,4,2.0
+false,18,,,,,,,15,21,3.0
+false,8,,,,,,,14,9,6.0
+false,1,,,,,,,1,2,1.0
+false,11,,,,,,,14,12,6.0
+false,7,,,,,,,14,8,6.0
+false,13,,,,,,,14,3,0.0
+false,17,,,,,,,19,15,2.0

scripts/pre-commit

@@ -0,0 +1,14 @@
+#!/bin/sh
+
+echo "> Task: ktfmtFormat"
+
+./gradlew ktfmtFormat
+
+echo "> Task: ktfmtCheck"
+
+./gradlew --no-daemon ktfmtCheck
+
+ ktfmtCheckStatus=$?
+
+[ $ktfmtCheckStatus -ne 0 ] && exit 1
+exit 0