diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..8ec7327 --- /dev/null +++ b/.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 \ No newline at end of file diff --git a/README.md b/README.md index e3ac9ef..67eaefb 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,60 @@ Stakeholder 3 ``` ## Автор решения +Самсонов Савелий Артёмович (email: savelij_samsonov@mail.ru) ## Описание реализации +В начале программа с помощью метода getStakeholderList класса StakeholderDataReader отдельно считывает данные из +входных файлов. Файл с матрицей интереса должен лежать по пути src/main/resources/matrix/interest.txt от корня проекта, +файл с матрицей влияния - по пути src/main/resources/matrix/influence.txt от корня проекта. + +При чтении файла с матрицей интереса/влияния методом readMatrix считывается первая строка, являющаяся шапкой таблицы. +Подстроки этой строки, разделённые между собой " | ", сохраняются в список как имена стейкхолдеров. Далее считывается n строк +(n - длина списка имён), каждая разделяется на подстроки, следующие через пробел, и если подстрока не равна "_", +она преобразовывается в число типа double. Все такие числа, полученные из i-ой строки матрицы после шапки, суммируются +и записываются в мапу в качестве значения для ключа, равного i-ому элементу в списке имёен стейкхолдеров. +Если во время работы с файлом прозошла ошибка IOException, то выбросится исключение FileInteractionException, в сообщении +которого будет указано, при работе с каким файлом возникла ошибка. Предполагается, что каждый из файлов с матрицами +интереса/влияния имеет корректный вид, описанный в задании. + +Таким образом, для матриц интереса и влияния будут получены отдельные мапы вида +<имя стейкхолдера - значение его интереса/влияния>. После этого наборы ключей этих мап сравниваются методом +checkStakeholdersSetsEquality, и если они не совпадают, то выбрасывается исключение IncorrectDataException с сообщением +о том, что матрицы не соотвествуют друг другу. Стейкхоледеры могут быть записаны в матрицах в разном порядке, и +такой случай будет обработан корректно. + +Далее данные из этих мап собираются в единый список объектов класса Stakeholder, в которых сохранено имя стейкхолдера, +значение его интереса и влияния. Метод getStakeholderList класса StakeholderDataReader возращает этот список. + +Методом getMostImportantStakeholders класса StakeholderFinder на основе полученного списка ЗС производится поиск самых +важных стейкхолдеров. Сначала список проверяется методом validateStakeholderList на недоспутимое на равенсто null или +содержание null как элемента, и если какое-либо из этих условий выполняется, то выбрасывается исключение +IncorrectDataException с соотвествующим сообщением. Далее вычисляется длина списка стейкхоледеров. Все его элементы, +удовлетворяющие условию checkIfStakeholderIsMostImportant, которое, учитывая количество стейкхолдеров, проверяет, что +по координатам интереса и влияния ЗС находится в правом верхнем квадрате (в том числе на его границах с остальными +квадратами), собираются в новый список. Вновь созданный список возвращается, и метод getMostImportantStakeholders +завершает работу. + +С помощью метода writeStakeholderNames класса StakeholderDataWriter имена стейкхолдеров из составленного списка самых +важных ЗС записываются в файл ответа, располагющийся по пути src/main/resources/result.txt от корня проекта. Если файл +по такому пути уже существует, то он удаляется и создаётся новый, в который по одному на строке записываются имена ЗС +из предоставленного списка самых важных ЗС. Если во время работы с файлом произошла ошибка IOException, то выбросится +исключение FileInteractionException, в сообщении которого будет указано, при работе с каким файлом возникла ошибка. + +Если во время работы выбросится исключение FileInteractionException или IncorrectDataException, то программа завершит +работу, выведя его сообщение в консоль. + +Для тестирования работы программы написаны тесты, расположенные в src/test/java/ru/croc. GetStakeholderListTest +тестирует чтение списка ЗС из файлов, StakeholderFinderTest тестирует нахождение самых важных ЗС из общего списка ЗС. ## Инструкция по сборке и запуску решения +Необходимая версия джавы: 17+. + +Склонировать репозиторий, заполнить файлы src/main/resources/matrix/interest.txt и +src/main/resources/matrix/influence.txt нужными данными. +Запустить программу в ОС Windows можно 2 способами: +1. С использованием IntelliJ Idea: открыть проект в IDE, запустить класс Main +2. Через командную строку: \ +Установить jdk17 (https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html) \ +Удостовериться, что в переменных среды в JAVA_HOME задан путь к jdk17 \ +Через командную строку в корневой папке проекта выполнить команды gradlew clean build, gradlew run. diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..09c813c --- /dev/null +++ b/build.gradle @@ -0,0 +1,24 @@ +plugins { + id 'java' + id 'application' +} + +application { + mainClass = 'ru.croc.Main' +} + +group = 'ru.croc' +version = '1.0-SNAPSHOT' + +repositories { + mavenCentral() +} + +dependencies { + testImplementation platform('org.junit:junit-bom:5.9.1') + testImplementation 'org.junit.jupiter:junit-jupiter' +} + +test { + useJUnitPlatform() +} \ No newline at end of file diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..7f93135 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..3fa8f86 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.4-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100644 index 0000000..1aa94a4 --- /dev/null +++ b/gradlew @@ -0,0 +1,249 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..93e3f59 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,92 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/src/main/java/ru/croc/Main.java b/src/main/java/ru/croc/Main.java new file mode 100644 index 0000000..5cc898f --- /dev/null +++ b/src/main/java/ru/croc/Main.java @@ -0,0 +1,35 @@ +package ru.croc; + +import ru.croc.exception.FileInteractionException; +import ru.croc.exception.IncorrectDataException; +import ru.croc.stakeholder.Stakeholder; + +import java.util.List; + +import static ru.croc.files.StakeholderDataReader.getStakeholderList; +import static ru.croc.files.StakeholderDataWriter.writeStakeholderNames; +import static ru.croc.stakeholder.StakeholderFinder.getMostImportantStakeholders; + +/** + * Основной класс для решения задачи о ЗС. + */ +public class Main { + //путь к файлу с матрицей интереса + private final static String INTEREST_FILE_PATH = "src/main/resources/matrix/interest.txt"; + + //путь к файлу с матрицей влияния + private final static String INFLUENCE_FILE_PATH = "src/main/resources/matrix/influence.txt"; + + //путь к файлу с ответом + private final static String MOST_IMPORTANT_STAKEHOLDERS_FILE_PATH = "src/main/resources/result.txt"; + + public static void main(String[] args) { + try { + List stakeholderList = getStakeholderList(INTEREST_FILE_PATH, INFLUENCE_FILE_PATH); + writeStakeholderNames(getMostImportantStakeholders(stakeholderList), MOST_IMPORTANT_STAKEHOLDERS_FILE_PATH); + } + catch (FileInteractionException | IncorrectDataException e) { + System.out.println(e.getMessage()); + } + } +} \ No newline at end of file diff --git a/src/main/java/ru/croc/exception/FileInteractionException.java b/src/main/java/ru/croc/exception/FileInteractionException.java new file mode 100644 index 0000000..58f00dc --- /dev/null +++ b/src/main/java/ru/croc/exception/FileInteractionException.java @@ -0,0 +1,11 @@ +package ru.croc.exception; + +/** + * Исключение, выбрасываемое в случае, если при работе с файлом произошла ошибка. + * В сообщении содержит информацию о том, при работе с каким файлом произошла ошибка. + */ +public class FileInteractionException extends RuntimeException { + public FileInteractionException(String message, Throwable e) { + super(message, e); + } +} diff --git a/src/main/java/ru/croc/exception/IncorrectDataException.java b/src/main/java/ru/croc/exception/IncorrectDataException.java new file mode 100644 index 0000000..cba9f7d --- /dev/null +++ b/src/main/java/ru/croc/exception/IncorrectDataException.java @@ -0,0 +1,11 @@ +package ru.croc.exception; + +/** + * Исключение, выбрасываемое в случае, когда полученные данные некорректны и дальнейшая работа невозможна. + * + */ +public class IncorrectDataException extends RuntimeException { + public IncorrectDataException(String message) { + super(message); + } +} diff --git a/src/main/java/ru/croc/files/StakeholderDataReader.java b/src/main/java/ru/croc/files/StakeholderDataReader.java new file mode 100644 index 0000000..26f041d --- /dev/null +++ b/src/main/java/ru/croc/files/StakeholderDataReader.java @@ -0,0 +1,76 @@ +package ru.croc.files; + +import ru.croc.exception.FileInteractionException; +import ru.croc.exception.IncorrectDataException; +import ru.croc.stakeholder.Stakeholder; + +import java.io.BufferedReader; +import java.io.FileReader; +import java.io.IOException; +import java.util.*; + +/** + * Класс считывания данных о заинтересованных сторонах из файлов. + */ +public class StakeholderDataReader { + /** + * Метод формирования полных данных о ЗС. + * + * @param interestFilePath Путь к файлу с матрицей интереса + * @param influenceFilePath Путь к файлу с матрицей влияния + * @return список объектов ЗС + */ + public static List getStakeholderList(String interestFilePath, String influenceFilePath) { + Map interestsMap; + Map influencesMap; + interestsMap = readMatrix(interestFilePath); + influencesMap = readMatrix(influenceFilePath); + + if (!checkStakeholdersSetsEquality(interestsMap.keySet(), influencesMap.keySet())) { + throw new IncorrectDataException( + "Матрицы интереса и влияния содержат несовпадающие наборы заинтересованных сторон"); + } + + List stakeholderList = new ArrayList<>(); + influencesMap.keySet().forEach(name -> + stakeholderList.add(new Stakeholder(name, interestsMap.get(name), influencesMap.get(name))) + ); + return stakeholderList; + } + + /** + * Метод сравнения множеств имён ЗС, полученных из файлов. + * + * @param a первое множество имён ЗС + * @param b второе множество имён ЗС + * @return логическое значение, показывающее, равны ли множества имён ЗС + */ + private static boolean checkStakeholdersSetsEquality(Set a, Set b) { + return b.containsAll(a) && a.containsAll(b); + } + + /** + * Метод получения данных о значениях интереса/влияния из файла. + * + * @param filePath Путь к файлу матрицей интереса/влияния + * @return словарь <имя ЗС - значение интереса/влияния> + */ + public static Map readMatrix(String filePath) { + Map ratingMap = new HashMap<>(); + List stakeholderNames = new ArrayList<>(); + try (BufferedReader reader = new BufferedReader(new FileReader(filePath))) { + String[] parsedFileString = reader.readLine().split(" \\| "); + stakeholderNames.addAll(Arrays.asList(parsedFileString)); + for (String stakeholderName : stakeholderNames) { + double stakeholderRating = Arrays.stream(reader.readLine().split(" ")) + .filter(string -> !Objects.equals(string, "_")) + .mapToDouble(Double::parseDouble) + .sum(); + ratingMap.put(stakeholderName, stakeholderRating); + } + } catch (IOException e) { + throw new FileInteractionException("Ошибка при чтении файла: " + filePath, e); + } + return ratingMap; + } +} diff --git a/src/main/java/ru/croc/files/StakeholderDataWriter.java b/src/main/java/ru/croc/files/StakeholderDataWriter.java new file mode 100644 index 0000000..252ab60 --- /dev/null +++ b/src/main/java/ru/croc/files/StakeholderDataWriter.java @@ -0,0 +1,43 @@ +package ru.croc.files; + +import ru.croc.exception.FileInteractionException; +import ru.croc.stakeholder.Stakeholder; + +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.nio.file.StandardOpenOption; +import java.util.List; + +/** + * Класс записи в файл. + */ +public class StakeholderDataWriter { + /** + * Метод записи имён заинтересованных сторон в файл. + * + * @param stakeholderList список объектов ЗС + * @param filePath путь к файлу с ответом + */ + public static void writeStakeholderNames(List stakeholderList, String filePath) { + Path path = Paths.get(filePath); + try { + Files.deleteIfExists(path); + stakeholderList.forEach(stakeholder -> + { + try { + Files.writeString(path, stakeholder.name() + "\n", + StandardOpenOption.CREATE, + StandardOpenOption.WRITE, + StandardOpenOption.APPEND); + } catch (IOException e) { + throw new RuntimeException(e); + } + } + ); + } catch (IOException e) { + throw new FileInteractionException("Ошибка при записи в файл: " + filePath, e); + } + } +} diff --git a/src/main/java/ru/croc/stakeholder/Stakeholder.java b/src/main/java/ru/croc/stakeholder/Stakeholder.java new file mode 100644 index 0000000..43ba593 --- /dev/null +++ b/src/main/java/ru/croc/stakeholder/Stakeholder.java @@ -0,0 +1,8 @@ +package ru.croc.stakeholder; + +/** + * Класс представления заинтересованной стороны с полями: + * Имя; Значение интереса; Значение влияния. + */ +public record Stakeholder(String name, double interest, double influence) { +} diff --git a/src/main/java/ru/croc/stakeholder/StakeholderFinder.java b/src/main/java/ru/croc/stakeholder/StakeholderFinder.java new file mode 100644 index 0000000..18fadcf --- /dev/null +++ b/src/main/java/ru/croc/stakeholder/StakeholderFinder.java @@ -0,0 +1,52 @@ +package ru.croc.stakeholder; + +import ru.croc.exception.IncorrectDataException; + +import java.util.List; +import java.util.Objects; +import java.util.stream.Collectors; + +/** + * Класс поиска нужных стейкхолдеров в общем списке. + */ +public class StakeholderFinder { + /** + * Метод поиска самых важных ЗС из всех. + * + * @param stakeholderList общий список ЗС + * @return список самых важных ЗС + */ + public static List getMostImportantStakeholders(List stakeholderList) { + validateStakeholderList(stakeholderList); + int stakeholdersNumber = stakeholderList.size(); + return stakeholderList.stream() + .filter(stakeholder -> checkIfStakeholderIsMostImportant(stakeholder, stakeholdersNumber)) + .collect(Collectors.toList()); + } + + /** + * Метод проверки, является ли ЗС одним из самых важных. + * + * @param stakeholder объект ЗС + * @param stakeholdersNumber общее количество ЗС + * @return булевское значение, показывающее, является ли ЗС одной из самых важных + */ + private static boolean checkIfStakeholderIsMostImportant(Stakeholder stakeholder, int stakeholdersNumber) { + return stakeholder.interest() >= (double) stakeholdersNumber / 2 && + stakeholder.influence() >= (double) stakeholdersNumber / 2; + } + + /** + * Метод валидации списка ЗС. + * + * @throws IncorrectDataException если список ЗС некорректен + */ + private static void validateStakeholderList(List stakeholderList) { + if (stakeholderList == null) { + throw new IncorrectDataException("Лист ЗС равен null"); + } + if (stakeholderList.stream().anyMatch(Objects::isNull)) { + throw new IncorrectDataException("Лист ЗС содержит null"); + } + } +} diff --git a/src/main/resources/matrix/influence.txt b/src/main/resources/matrix/influence.txt new file mode 100644 index 0000000..15e1fce --- /dev/null +++ b/src/main/resources/matrix/influence.txt @@ -0,0 +1,6 @@ +Stakeholder 1 | Stakeholder 2 | Stakeholder 3 | Stakeholder 4 | Stakeholder 5 +_ 0 1 0 0 +1 _ 0.5 1 1 +0 0.5 _ 0 0.5 +1 0 1 _ 1 +1 0 0.5 0 _ \ No newline at end of file diff --git a/src/main/resources/matrix/interest.txt b/src/main/resources/matrix/interest.txt new file mode 100644 index 0000000..15e1fce --- /dev/null +++ b/src/main/resources/matrix/interest.txt @@ -0,0 +1,6 @@ +Stakeholder 1 | Stakeholder 2 | Stakeholder 3 | Stakeholder 4 | Stakeholder 5 +_ 0 1 0 0 +1 _ 0.5 1 1 +0 0.5 _ 0 0.5 +1 0 1 _ 1 +1 0 0.5 0 _ \ No newline at end of file diff --git a/src/test/java/ru/croc/GetStakeholderListTest.java b/src/test/java/ru/croc/GetStakeholderListTest.java new file mode 100644 index 0000000..78b8928 --- /dev/null +++ b/src/test/java/ru/croc/GetStakeholderListTest.java @@ -0,0 +1,53 @@ +package ru.croc; + +import org.junit.jupiter.api.Assertions; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; +import ru.croc.exception.FileInteractionException; +import ru.croc.exception.IncorrectDataException; +import ru.croc.stakeholder.Stakeholder; + +import java.util.List; + +import static ru.croc.files.StakeholderDataReader.getStakeholderList; + + +public class GetStakeholderListTest { + @Test + @DisplayName("Тестирование метода составления списка ЗС") + void getStakeholderListTest() { + String interestFilePath = "src/test/resources/test1/interest.txt"; + String influenceFilePath = "src/test/resources/test1/influence.txt"; + + List expectedAnswer = List.of( + new Stakeholder("Stakeholder 1", 1.0, 1.0), + new Stakeholder("Stakeholder 2", 3.5, 3.5), + new Stakeholder("Stakeholder 3", 1.0, 1.0), + new Stakeholder("Stakeholder 4", 3.0, 3.0), + new Stakeholder("Stakeholder 5", 1.5, 1.5) + ); + List actualAnswer = getStakeholderList(interestFilePath, influenceFilePath); + Assertions.assertTrue( + expectedAnswer.containsAll(actualAnswer) && actualAnswer.containsAll(expectedAnswer)); + } + + @Test + @DisplayName("Тестирование метода составления списка ЗС при не соответсвующих друг другу матрицах") + void getStakeholderListOnIncorrectMatricesTest() { + String interestFilePath = "src/test/resources/test2/interest.txt"; + String influenceFilePath = "src/test/resources/test2/influence.txt"; + + Assertions.assertThrows(IncorrectDataException.class, + () -> getStakeholderList(interestFilePath, influenceFilePath)); + } + + @Test + @DisplayName("Тестирование метода составления списка ЗС при некорректном пути файла") + void getStakeholderListOnIncorrectPathTest() { + String interestFilePath = "wrongPath1"; + String influenceFilePath = "wrongPath2"; + + Assertions.assertThrows(FileInteractionException.class, + () -> getStakeholderList(interestFilePath, influenceFilePath)); + } +} diff --git a/src/test/java/ru/croc/StakeholderFinderTest.java b/src/test/java/ru/croc/StakeholderFinderTest.java new file mode 100644 index 0000000..0a1b531 --- /dev/null +++ b/src/test/java/ru/croc/StakeholderFinderTest.java @@ -0,0 +1,80 @@ +package ru.croc; + +import org.junit.jupiter.api.Assertions; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; +import ru.croc.exception.IncorrectDataException; +import ru.croc.stakeholder.Stakeholder; + +import java.util.ArrayList; +import java.util.List; + +import static ru.croc.stakeholder.StakeholderFinder.getMostImportantStakeholders; + +public class StakeholderFinderTest { + List emptyList = new ArrayList<>(); + + @Test + @DisplayName("Тестирование метода поиска самых важных ЗС") + void findMostImportantStakeholdersTest() { + List stakeholderList = List.of( + new Stakeholder("stakeholder1", 1.0, 1.5), + new Stakeholder("stakeholder2", 3.5, 4.0), + new Stakeholder("stakeholder3", 2.0, 1.0), + new Stakeholder("stakeholder4", 3.0, 3.5), + new Stakeholder("stakeholder5", 1.5, 1.0) + ); + List expectedAnswer = List.of( + new Stakeholder("stakeholder2", 3.5, 4.0), + new Stakeholder("stakeholder4", 3.0, 3.5) + ); + Assertions.assertEquals(expectedAnswer, getMostImportantStakeholders(stakeholderList)); + } + + @Test + @DisplayName("Тестирование метода поиска самых важных ЗС в случае попадания ЗС на границы квадратов") + void findMostImportantStakeholdersOnBorderTest() { + List stakeholderList = List.of( + new Stakeholder("stakeholder1", 2.0, 3.0), + new Stakeholder("stakeholder2", 3.0, 2.0), + new Stakeholder("stakeholder3", 2.0, 2.0), + new Stakeholder("stakeholder4", 1.0, 2.0) + ); + List expectedAnswer = List.of( + new Stakeholder("stakeholder1", 2.0, 3.0), + new Stakeholder("stakeholder2", 3.0, 2.0), + new Stakeholder("stakeholder3", 2.0, 2.0) + ); + Assertions.assertEquals(expectedAnswer, getMostImportantStakeholders(stakeholderList)); + } + + @Test + @DisplayName("Тестирование метода поиска самых важных ЗС в случае отсуствия самых важных ЗС") + void findMostImportantStakeholdersWithoutRightAnswerTest() { + List stakeholderList = List.of( + new Stakeholder("stakeholder1", 0.5, 2.0), + new Stakeholder("stakeholder2", 2.0, 0.5) + ); + Assertions.assertEquals(emptyList, getMostImportantStakeholders(stakeholderList)); + } + + @Test + @DisplayName("Тестирование метода поиска самых важных ЗС в случае пустого списка ЗС") + void findMostImportantStakeholdersOnEmptyListTest() { + Assertions.assertEquals(emptyList, getMostImportantStakeholders(emptyList)); + } + + @Test + @DisplayName("Тестирование метода поиска самых важных ЗС в случае незаданного списка ЗС") + void findMostImportantStakeholdersOnNullListTest() { + Assertions.assertThrows(IncorrectDataException.class, () -> getMostImportantStakeholders(null)); + } + + @Test + @DisplayName("Тестирование метода поиска самых важных ЗС в случае списка с незаданными ЗС") + void findMostImportantStakeholdersOnNullElementsListTest() { + List stakeholderList = new ArrayList<>(); + stakeholderList.add(null); + Assertions.assertThrows(IncorrectDataException.class, () -> getMostImportantStakeholders(stakeholderList)); + } +} diff --git a/src/test/resources/test1/influence.txt b/src/test/resources/test1/influence.txt new file mode 100644 index 0000000..15e1fce --- /dev/null +++ b/src/test/resources/test1/influence.txt @@ -0,0 +1,6 @@ +Stakeholder 1 | Stakeholder 2 | Stakeholder 3 | Stakeholder 4 | Stakeholder 5 +_ 0 1 0 0 +1 _ 0.5 1 1 +0 0.5 _ 0 0.5 +1 0 1 _ 1 +1 0 0.5 0 _ \ No newline at end of file diff --git a/src/test/resources/test1/interest.txt b/src/test/resources/test1/interest.txt new file mode 100644 index 0000000..15e1fce --- /dev/null +++ b/src/test/resources/test1/interest.txt @@ -0,0 +1,6 @@ +Stakeholder 1 | Stakeholder 2 | Stakeholder 3 | Stakeholder 4 | Stakeholder 5 +_ 0 1 0 0 +1 _ 0.5 1 1 +0 0.5 _ 0 0.5 +1 0 1 _ 1 +1 0 0.5 0 _ \ No newline at end of file diff --git a/src/test/resources/test2/influence.txt b/src/test/resources/test2/influence.txt new file mode 100644 index 0000000..487eb2f --- /dev/null +++ b/src/test/resources/test2/influence.txt @@ -0,0 +1,6 @@ +a | b | c | d | f +_ 0 1 0 0 +1 _ 0.5 1 1 +0 0.5 _ 0 0.5 +1 0 1 _ 1 +1 0 0.5 0 _ \ No newline at end of file diff --git a/src/test/resources/test2/interest.txt b/src/test/resources/test2/interest.txt new file mode 100644 index 0000000..e890f24 --- /dev/null +++ b/src/test/resources/test2/interest.txt @@ -0,0 +1,6 @@ +a | b | c | d | e +_ 0 1 0 0 +1 _ 0.5 1 1 +0 0.5 _ 0 0.5 +1 0 1 _ 1 +1 0 0.5 0 _ \ No newline at end of file