Feedback

.editorconfig

@@ -0,0 +1,97 @@
+root = true
+
+[*]
+ij_continuation_indent_size = 8
+ij_formatter_off_tag = @formatter:off
+ij_formatter_on_tag = @formatter:on
+ij_formatter_tags_enabled = true
+ij_smart_tabs = false
+ij_wrap_on_typing = false
+
+[{*.kt,*.kts}]
+ktlint_code_style = intellij_idea
+ktlint_standard_multiline-if-else = disabled
+ktlint_standard_final-newline = disabled
+ij_kotlin_align_in_columns_case_branch = false
+ij_kotlin_align_multiline_binary_operation = false
+ij_kotlin_align_multiline_extends_list = false
+ij_kotlin_align_multiline_method_parentheses = false
+ij_kotlin_align_multiline_parameters = true
+ij_kotlin_align_multiline_parameters_in_calls = false
+ij_kotlin_allow_trailing_comma = false
+ij_kotlin_allow_trailing_comma_on_call_site = false
+ij_kotlin_assignment_wrap = normal
+ij_kotlin_blank_lines_after_class_header = 0
+ij_kotlin_blank_lines_around_block_when_branches = 0
+ij_kotlin_blank_lines_before_declaration_with_comment_or_annotation_on_separate_line = 1
+ij_kotlin_block_comment_add_space = false
+ij_kotlin_block_comment_at_first_column = true
+ij_kotlin_call_parameters_new_line_after_left_paren = true
+ij_kotlin_call_parameters_right_paren_on_new_line = true
+ij_kotlin_call_parameters_wrap = on_every_item
+ij_kotlin_catch_on_new_line = false
+ij_kotlin_class_annotation_wrap = split_into_lines
+ij_kotlin_code_style_defaults = KOTLIN_OFFICIAL
+ij_kotlin_continuation_indent_for_chained_calls = false
+ij_kotlin_continuation_indent_for_expression_bodies = false
+ij_kotlin_continuation_indent_in_argument_lists = false
+ij_kotlin_continuation_indent_in_elvis = false
+ij_kotlin_continuation_indent_in_if_conditions = false
+ij_kotlin_continuation_indent_in_parameter_lists = false
+ij_kotlin_continuation_indent_in_supertype_lists = false
+ij_kotlin_else_on_new_line = false
+ij_kotlin_enum_constants_wrap = off
+ij_kotlin_extends_list_wrap = normal
+ij_kotlin_field_annotation_wrap = split_into_lines
+ij_kotlin_finally_on_new_line = false
+ij_kotlin_if_rparen_on_new_line = true
+ij_kotlin_import_nested_classes = false
+ij_kotlin_imports_layout = *,java.**,javax.**,kotlin.**,^
+ij_kotlin_insert_whitespaces_in_simple_one_line_method = true
+ij_kotlin_keep_blank_lines_before_right_brace = 2
+ij_kotlin_keep_blank_lines_in_code = 2
+ij_kotlin_keep_blank_lines_in_declarations = 2
+ij_kotlin_keep_first_column_comment = true
+ij_kotlin_keep_indents_on_empty_lines = false
+ij_kotlin_keep_line_breaks = true
+ij_kotlin_lbrace_on_next_line = false
+ij_kotlin_line_break_after_multiline_when_entry = true
+ij_kotlin_line_comment_add_space = false
+ij_kotlin_line_comment_add_space_on_reformat = false
+ij_kotlin_line_comment_at_first_column = true
+ij_kotlin_method_annotation_wrap = split_into_lines
+ij_kotlin_method_call_chain_wrap = normal
+ij_kotlin_method_parameters_new_line_after_left_paren = true
+ij_kotlin_method_parameters_right_paren_on_new_line = true
+ij_kotlin_method_parameters_wrap = on_every_item
+ij_kotlin_name_count_to_use_star_import = 5
+ij_kotlin_name_count_to_use_star_import_for_members = 3
+ij_kotlin_packages_to_use_import_on_demand = java.util.*,kotlinx.android.synthetic.**,io.ktor.**
+ij_kotlin_parameter_annotation_wrap = off
+ij_kotlin_space_after_comma = true
+ij_kotlin_space_after_extend_colon = true
+ij_kotlin_space_after_type_colon = true
+ij_kotlin_space_before_catch_parentheses = true
+ij_kotlin_space_before_comma = false
+ij_kotlin_space_before_extend_colon = true
+ij_kotlin_space_before_for_parentheses = true
+ij_kotlin_space_before_if_parentheses = true
+ij_kotlin_space_before_lambda_arrow = true
+ij_kotlin_space_before_type_colon = false
+ij_kotlin_space_before_when_parentheses = true
+ij_kotlin_space_before_while_parentheses = true
+ij_kotlin_spaces_around_additive_operators = true
+ij_kotlin_spaces_around_assignment_operators = true
+ij_kotlin_spaces_around_equality_operators = true
+ij_kotlin_spaces_around_function_type_arrow = true
+ij_kotlin_spaces_around_logical_operators = true
+ij_kotlin_spaces_around_multiplicative_operators = true
+ij_kotlin_spaces_around_range = false
+ij_kotlin_spaces_around_relational_operators = true
+ij_kotlin_spaces_around_unary_operator = false
+ij_kotlin_spaces_around_when_arrow = true
+ij_kotlin_variable_annotation_wrap = off
+ij_kotlin_while_on_new_line = false
+ij_kotlin_wrap_elvis_expressions = 1
+ij_kotlin_wrap_expression_body_functions = 1
+ij_kotlin_wrap_first_method_in_call_chain = false

.githooks/pre-commit

@@ -0,0 +1,9 @@
+#!/bin/bash
+echo "Running git pre-commit hook"
+./gradlew ktlintCheck
+ktlintCheckStatus=$?
+if [[ $ktlintCheckStatus -ne 0 ]]; then
+     exit 1
+else
+     exit 0
+fi

.github/mergeable.yml

@@ -0,0 +1,15 @@
+version: 2
+mergeable:
+  - when: pull_request.*
+    name: 'Check decoration'
+    validate:
+      - do: title
+        must_exclude:
+          regex: ^\[WIP\]
+      - do: label
+        must_exclude:
+          regex: 'wip'
+      - 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.

.github/workflows/test.yml

@@ -0,0 +1,36 @@
+name: Main
+on:
+  pull_request:
+    branches: [ main,development ]
+
+  push:
+    branches: [ main,development ]
+jobs:
+  Lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout project sources
+        uses: actions/checkout@v4
+      - name: Start lint
+        run: ./gradlew ktlintCheck
+
+  Tests:
+    name: Tests and Coverage
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout project sources
+        uses: actions/checkout@v4
+      - name: Run test
+        id : runtest
+        run: ./gradlew test
+        continue-on-error: true
+      - name : Display tests results
+        run: python3 ./scripts/test-result-printer.py --dir ./build/test-results/test --all-failures
+      - name: Run jacoco coverage report
+        run: ./gradlew jacocoTestReport
+      - name: Display info about coverage
+        run: python3 ./scripts/csv-reports-printer.py --input ./build/reports/jacoco/test/jacocoTestReport.csv
+      - name : Failure at least one test fails
+        if: steps.runtest.outcome != 'success'
+        run: exit 1

.gitignore

@@ -0,0 +1,43 @@
+.gradle
+build/
+!gradle/wrapper/gradle-wrapper.jar
+!**/src/main/**/build/
+!**/src/test/**/build/
+
+### IntelliJ IDEA ###
+.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

CONTRIBUTING.md

@@ -0,0 +1,11 @@
+# Contributing
+Rules of contributing to our project.
+1. If you want to add your own feature or fix something in our code, please create your own branch to do it.
+2. Please avoid verbs in commits' names ("project initialization" instead of "initialize project" or "initialized project")
+3. Once your branch is complete, you can make a pull request and wait for it to be reviewed.
+4. Description of pull request is required to be written.
+5. Your commits and pull requests must be named and described in English.
+6. Your naming of commits and pull requests must be logical and reasonable. Use conventional commits, please.
+7. Please use "git commit -s" option.
+8. Don't merge your pull request before your code has been reviewed.
+9. If you are in doubt what to do, it's better to text developers.

DOCS.md

@@ -0,0 +1,82 @@
+# Documentation
+
+You need to clone our repository and run the app using
+
+```
+./gradlew run
+```
+
+## How to use
+
+Firstly, you need to choose a graph
+
+![graph-choose](src/main/resources/graph-choose.png)
+
+## Undirected unweighted graph
+
+Here is the example of our graph window
+
+![graph](src/main/resources/graph.png)
+
+If you click "Reset", graph will become as it was before you started manipulating it.
+
+If you click "Algorithms", you will be suggested to use algorithms of this graph
+
+![graph-algos](src/main/resources/graph-algos.png)
+
+### Bridges
+
+Bridge edges are highlighted with red color.
+
+![bridge](src/main/resources/bridge.png)
+
+### Cycles search for given vertex
+
+You are suggested to put in a number of chosen vertex
+
+![cycles-vertex-choose.png](src/main/resources/cycle-vertex-choose.png)
+
+Then you receive highlighted cycle of this vertex, or vertex becomes highlighted with blue color if it doesn't belong to any cycle
+
+![cycle](src/main/resources/cycle.png)
+
+### Key vertices selection
+
+You receive highlighted key vertices of this graph
+
+![key-vertices](src/main/resources/key-vertices.png)
+
+## Directed unweighted graph
+
+Directed graph has some undirected graph algorithms, but also there is selection of strongly connected components.
+
+### Strongly connected components selection
+
+Each component is highlighted with its unique color.
+
+![scc](src/main/resources/scc.png)
+
+## Undirected weighted graph
+
+In weighted graph, you can see weights of edges
+
+![edges-weights](src/main/resources/edges-weights.png)
+
+### Minimal spanning tree construction
+
+Included edges are highlighted with red
+
+![mst](src/main/resources/mst.png)
+
+### Path finding
+
+To find a path, you need to pick source and destination vertices
+
+![path-vertices](src/main/resources/path-vertices.png)
+
+Path is highlighted. Notice that we don't support negative weights for path finding in undirected graph.
+
+![path](src/main/resources/path.png)
+
+## Weighted directed graph
+All its algorithms are already explained above

LICENSE.md

@@ -0,0 +1,9 @@
+# The MIT License (MIT)
+
+Copyright © 2024 Vyacheslav Kochergin, Vadim Marchenko, Dmitri Kuznetsov.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.