zwirec / travelmate Goto Github PK

Критерий качества: удобство сопровождения

Следующие классы не имеют какой-либо документации:

• managers
• dbConfig
• UserModel
• UserManager

Критерий качества: удобство сопровождения

1. Макрос sql_create_3, литералы 2 и 3
   https://github.com/zwirec/TravelMate/blob/dev_nd-r/managers/models/userPrototype.h#L17

2. Макрос sql_create_4, литералы 2 и 4
   https://github.com/zwirec/TravelMate/blob/dev_nd-r/managers/models/user/userPrototype.h#L17

3. Размер по-умолчанию для поля vector структуры Master, литерал 8
   https://github.com/zwirec/TravelMate/blob/dev_nd-r/data/tmpl_master.h#L39

4. Сумма литералов 64 и 9 сравнивается с password.size(),
   https://github.com/zwirec/TravelMate/blob/dev_nd-r/managers/models/user/UserModel.cpp#L14
   https://github.com/zwirec/TravelMate/blob/dev_nd-r/managers/models/user/UserModel.cpp#L20
   https://github.com/zwirec/TravelMate/blob/dev_nd-r/managers/models/user/UserModel.cpp#L25

5. Cтроковый литерал ":sha256::" как аргумент для password.find()
   https://github.com/zwirec/TravelMate/blob/dev_nd-r/managers/models/user/UserModel.cpp#L14
   https://github.com/zwirec/TravelMate/blob/dev_nd-r/managers/models/user/UserModel.cpp#L20
   https://github.com/zwirec/TravelMate/blob/dev_nd-r/managers/models/user/UserModel.cpp#L25

Критерий качества: надежность

Конструкторы следующих классов принимают один аргумент и не объявлены как explicit:

• UserModel
• manager
• WebSite

Критерий качества: удобство сопровождения

1. Параметры конструктора класса UserModel
   https://github.com/zwirec/TravelMate/blob/dev_nd-r/managers/models/user/UserModel.h#L17
   https://github.com/zwirec/TravelMate/blob/dev_nd-r/managers/models/user/UserModel.cpp#L13

2. Название единственного метода класса manager (временное название?)
   https://github.com/zwirec/TravelMate/blob/dev_nd-r/managers/managers/manager.h#L11

3. Неиформативное (несодержательное) название namespace Data
   https://github.com/zwirec/TravelMate/blob/dev_nd-r/data/tmpl_news.h

4. Несодержательное название атрибута Master::vector
   https://github.com/zwirec/TravelMate/blob/dev_nd-r/data/tmpl_master.h#L39

Критерий качества: надежность, производительность

1. Метод managers::getManager() может быть объявлен как const
   https://github.com/zwirec/TravelMate/blob/dev_nd-r/managers/managers.h#L25
   2. loginEquality::operator() может быть объявлен как const
   https://github.com/zwirec/TravelMate/blob/dev_nd-r/managers/managers/userManager.cpp
2. WebSite::print() может быть объявлен как const
   https://github.com/zwirec/TravelMate/blob/dev_nd-r/main.cpp#L38

Критерий качества: безопасность, удобство сопровождения
В метод класса manager<>::authenticate(...) сообщения об ошибках содержат текст как на русском, так и на английском языках.

Критерийрий качества: удобство сопровождения

1. Конструкторы класса UserModel имеют одинаковое тело
   https://github.com/zwirec/TravelMate/blob/dev_nd-r/managers/models/user/UserModel.cpp#L13
   https://github.com/zwirec/TravelMate/blob/dev_nd-r/managers/models/user/UserModel.cpp#L18
   https://github.com/zwirec/TravelMate/blob/dev_nd-r/managers/models/user/UserModel.cpp#L24

2. Перегрузки метода manager<>::create(...) почти идентичны в реализации
   https://github.com/zwirec/TravelMate/blob/dev_nd-r/managers/managers/userManager.cpp#L65
   https://github.com/zwirec/TravelMate/blob/dev_nd-r/managers/managers/userManager.cpp#L73
   https://github.com/zwirec/TravelMate/blob/dev_nd-r/managers/managers/userManager.cpp#L88

3. Перегрузки методаmanager<>::authenticate(...) почти идентичны в реализации
   https://github.com/zwirec/TravelMate/blob/dev_nd-r/managers/managers/userManager.cpp#L45
   https://github.com/zwirec/TravelMate/blob/dev_nd-r/managers/managers/userManager.cpp#L23

Критерий качества: эффективность

Следующие методы класса WebSite принимают в качестве параметра копию строки:
WebSite::news(std::string)
WebSite::master(std::string)
WebSite::main(std::string)

Критерий качества: удобство сопровождения (очень сильно усложняется code review)

1. файлы UserModel.h
   https://github.com/zwirec/TravelMate/blob/dev_nd-r/managers/models/UserModel.h
   https://github.com/zwirec/TravelMate/blob/dev_nd-r/managers/models/user/UserModel.h

2. файлы UserModel.cpp
   https://github.com/zwirec/TravelMate/blob/dev_nd-r/managers/models/user/UserModel.cpp
   https://github.com/zwirec/TravelMate/blob/dev_nd-r/managers/models/UserModel.cpp

3. каталог managers
   https://github.com/zwirec/TravelMate/tree/dev_nd-r/managers
   https://github.com/zwirec/TravelMate/tree/dev_nd-r/managers/managers

4. Файлы userPrototype.h
   https://github.com/zwirec/TravelMate/blob/dev_nd-r/managers/models/userPrototype.h
   https://github.com/zwirec/TravelMate/blob/dev_nd-r/managers/models/user/userPrototype.h

Критерий качества: безопасность
Добавление информации в базу данных осуществляется без проверки входных данных

• userManager::authenticate()
• userManager::create()

Конструкторы UserModel так же не проверяют входные данные
https://github.com/zwirec/TravelMate/blob/dev_nd-r/managers/models/user/UserModel.cpp#L13
https://github.com/zwirec/TravelMate/blob/dev_nd-r/managers/models/user/UserModel.cpp#L18
https://github.com/zwirec/TravelMate/blob/dev_nd-r/managers/models/user/UserModel.cpp#L13

Критерий качества: надежность

1. На методы класса userManager можно наложить ограничения на типы генерируемых исключений:
   https://github.com/zwirec/TravelMate/blob/dev_nd-r/managers/managers/userManager.h
2. На методы класса UserModel.h можно наложить ограничения на типы генерируемых исключений:
   https://github.com/zwirec/TravelMate/blob/dev_nd-r/managers/models/UserModel.h