refactor: use annual instead of yearly in names

source/CMakeLists.txt

@@ -10,15 +10,15 @@ add_executable(
     ./date/date.cpp
     ./date/date.hpp
 
+    ./log/annual_log_data.cpp
+    ./log/annual_log_data.hpp
     ./log/local_log_repository.cpp
     ./log/local_log_repository.hpp
     ./log/log_file.cpp
     ./log/log_file.hpp
     ./log/log_repository_base.hpp
     ./log/log_repository_crypto_applyer.cpp
     ./log/log_repository_crypto_applyer.hpp
-    ./log/year_overview_data.cpp
-    ./log/year_overview_data.hpp
 
     ./utils/crypto.cpp
     ./utils/crypto.hpp
@@ -28,6 +28,9 @@ add_executable(
     ./utils/git_repo.cpp
     ./utils/git_repo.hpp
 
+    ./view/annual_view.cpp
+    ./view/annual_view.hpp
+    ./view/annual_view_base.hpp
     ./view/calendar_component.cpp
     ./view/calendar_component.hpp
     ./view/ftxui_ext/extended_containers.cpp
@@ -37,10 +40,9 @@ add_executable(
     ./view/preview.hpp
     ./view/promptable.cpp
     ./view/promptable.hpp
-    ./view/yearly_view.cpp
-    ./view/yearly_view.hpp
 )
 
+
 target_include_directories(caps-log PRIVATE ./ ${CMAKE_CURRENT_BINARY_DIR})
 
 target_link_libraries(caps-log

source/app.hpp

@@ -1,14 +1,14 @@
 #pragma once
 
 #include "editor/editor_base.hpp"
+#include "log/annual_log_data.hpp"
 #include "log/log_file.hpp"
 #include "log/log_repository_base.hpp"
-#include "log/year_overview_data.hpp"
 #include "utils/git_repo.hpp"
 #include "utils/string.hpp"
 #include "utils/task_executor.hpp"
+#include "view/annual_view.hpp"
 #include "view/input_handler.hpp"
-#include "view/yearly_view.hpp"
 
 #include <algorithm>
 #include <cassert>
@@ -64,10 +64,10 @@ class AsyncGitRepo {
 
 class App : public InputHandlerBase {
     unsigned m_displayedYear;
-    std::shared_ptr<YearViewBase> m_view;
+    std::shared_ptr<AnnualViewBase> m_view;
     std::shared_ptr<LogRepositoryBase> m_repo;
     std::shared_ptr<EditorBase> m_editor;
-    YearOverviewData m_data;
+    AnnualLogData m_data;
 
     std::vector<const YearMap<bool> *> m_tagMaps;
     std::vector<const YearMap<bool> *> m_sectionMaps;
@@ -92,12 +92,12 @@ class App : public InputHandlerBase {
     }
 
   public:
-    App(std::shared_ptr<YearViewBase> view, std::shared_ptr<LogRepositoryBase> repo,
+    App(std::shared_ptr<AnnualViewBase> view, std::shared_ptr<LogRepositoryBase> repo,
         std::shared_ptr<EditorBase> editor, bool skipFirstLine = true,
         std::optional<GitRepo> gitRepo = std::nullopt)
         : m_displayedYear(Date::getToday().year), m_view{std::move(view)}, m_repo{std::move(repo)},
           m_editor{std::move(editor)},
-          m_data{YearOverviewData::collect(m_repo, date::Date::getToday().year, skipFirstLine)},
+          m_data{AnnualLogData::collect(m_repo, date::Date::getToday().year, skipFirstLine)},
           m_skipFirstLine{skipFirstLine} {
         m_view->setInputHandler(this);
         // if pass not prowided and repo is encrypted
@@ -205,7 +205,7 @@ class App : public InputHandlerBase {
 
     void displayYear(int diff) {
         m_displayedYear += diff;
-        m_data = YearOverviewData::collect(m_repo, m_displayedYear, m_skipFirstLine);
+        m_data = AnnualLogData::collect(m_repo, m_displayedYear, m_skipFirstLine);
         m_view->showCalendarForYear(m_displayedYear);
         m_view->setHighlightedLogsMap(nullptr);
         updateViewSectionsAndTagsAfterLogChange(m_view->getFocusedDate());

source/log/year_overview_data.cpp → source/log/annual_log_data.cpp

@@ -1,12 +1,12 @@
-#include "year_overview_data.hpp"
+#include "annual_log_data.hpp"
 #include "date/date.hpp"
 #include <regex>
 
 namespace caps_log::log {
 
-YearOverviewData YearOverviewData::collect(const std::shared_ptr<LogRepositoryBase> &repo,
-                                           unsigned year, bool skipFirstLine) {
-    YearOverviewData data;
+AnnualLogData AnnualLogData::collect(const std::shared_ptr<LogRepositoryBase> &repo, unsigned year,
+                                     bool skipFirstLine) {
+    AnnualLogData data;
 
     for (unsigned month = date::Month::JANUARY; month <= date::Month::DECEMBER; month++) {
         for (unsigned day = 1; day <= date::getNumberOfDaysForMonth(month, year); day++) {
@@ -17,8 +17,8 @@ YearOverviewData YearOverviewData::collect(const std::shared_ptr<LogRepositoryBa
     return std::move(data);
 }
 
-void YearOverviewData::collect(const std::shared_ptr<LogRepositoryBase> &repo,
-                               const date::Date &date, bool skipFirstLine) {
+void AnnualLogData::collect(const std::shared_ptr<LogRepositoryBase> &repo, const date::Date &date,
+                            bool skipFirstLine) {
     // first remove all set mentions
     utils::mapRemoveIf(tagMap, [date](auto &tag) {
         tag.second.set(date, false);

source/log/year_overview_data.hpp → source/log/annual_log_data.hpp

@@ -9,16 +9,16 @@ namespace caps_log::log {
  * It contains data like which dates have log entries, what tags/sections/tasks were
  * mentioned in which log entries but not actual log contents.
  */
-class YearOverviewData {
+class AnnualLogData {
   public:
     date::YearMap<bool> logAvailabilityMap;
     date::StringYearMap sectionMap, tagMap;
 
     /**
      * Constructs YearOverviewData from logs in a given year.
      */
-    static YearOverviewData collect(const std::shared_ptr<LogRepositoryBase> &repo, unsigned year,
-                                    bool skipFirstLine = true);
+    static AnnualLogData collect(const std::shared_ptr<LogRepositoryBase> &repo, unsigned year,
+                                 bool skipFirstLine = true);
 
     /**
      * Injects/updates the current object with information parsed from a log entry form a specified

source/main.cpp

@@ -23,7 +23,7 @@ auto makeCapsLog(const caps_log::Config &conf) {
     using namespace caps_log;
 
     auto pathProvider = log::LocalFSLogFilePathProvider{conf.logDirPath, conf.logFilenameFormat};
-    auto view = std::make_shared<view::YearView>(date::Date::getToday(), conf.sundayStart);
+    auto view = std::make_shared<view::AnnualView>(date::Date::getToday(), conf.sundayStart);
     auto repo = std::make_shared<log::LocalLogRepository>(pathProvider, conf.password);
     auto editor = [&]() -> std::shared_ptr<editor::EditorBase> {
         if (conf.password.empty()) {

source/view/yearly_view.cpp → source/view/annual_view.cpp

@@ -1,4 +1,4 @@
-#include "yearly_view.hpp"
+#include "annual_view.hpp"
 
 #include "calendar_component.hpp"
 #include "ftxui/component/screen_interactive.hpp"
@@ -14,19 +14,19 @@
 
 namespace caps_log::view {
 
-YearView::YearView(const date::Date &today, bool sundayStart)
+AnnualView::AnnualView(const date::Date &today, bool sundayStart)
     : m_screen{ScreenInteractive::Fullscreen()},
       m_calendarButtons{Calendar::make(today, makeCalendarOptions(today, sundayStart))},
       m_tagsMenu{makeTagsMenu()}, m_sectionsMenu{makeSectionsMenu()},
       m_rootComponent{makeFullUIComponent()} {}
 
-void YearView::run() { m_screen.Loop(m_rootComponent); }
+void AnnualView::run() { m_screen.Loop(m_rootComponent); }
 
-void YearView::stop() { m_screen.ExitLoopClosure()(); }
+void AnnualView::stop() { m_screen.ExitLoopClosure()(); }
 
-void YearView::showCalendarForYear(unsigned year) { m_calendarButtons->displayYear(year); }
+void AnnualView::showCalendarForYear(unsigned year) { m_calendarButtons->displayYear(year); }
 
-std::shared_ptr<Promptable> YearView::makeFullUIComponent() {
+std::shared_ptr<Promptable> AnnualView::makeFullUIComponent() {
     auto container = ftxui_ext::CustomContainer(
         {
             m_tagsMenu,
@@ -70,7 +70,7 @@ std::shared_ptr<Promptable> YearView::makeFullUIComponent() {
     return std::make_shared<Promptable>(event_handler);
 }
 
-CalendarOption YearView::makeCalendarOptions(const Date &today, bool sundayStart) {
+CalendarOption AnnualView::makeCalendarOptions(const Date &today, bool sundayStart) {
     CalendarOption option;
     option.transform = [this, today](const auto &date, const auto &state) {
         auto element = text(state.label);
@@ -110,7 +110,7 @@ CalendarOption YearView::makeCalendarOptions(const Date &today, bool sundayStart
     return std::move(option);
 }
 
-std::shared_ptr<WindowedMenu> YearView::makeTagsMenu() {
+std::shared_ptr<WindowedMenu> AnnualView::makeTagsMenu() {
     MenuOption option{
         .entries = &m_tagMenuItems,
         .on_change =
@@ -122,7 +122,7 @@ std::shared_ptr<WindowedMenu> YearView::makeTagsMenu() {
     return WindowedMenu::make("Tags", option);
 }
 
-std::shared_ptr<WindowedMenu> YearView::makeSectionsMenu() {
+std::shared_ptr<WindowedMenu> AnnualView::makeSectionsMenu() {
     MenuOption option = {
         .entries = &m_sectionMenuItems,
         .on_change =
@@ -134,19 +134,19 @@ std::shared_ptr<WindowedMenu> YearView::makeSectionsMenu() {
     return WindowedMenu::make("Sections", option);
 }
 
-void YearView::post(Task task) {
+void AnnualView::post(Task task) {
     m_screen.Post([task, this]() { std::get<Closure>(task)(); });
     m_screen.Post(Event::Custom);
 }
-void YearView::prompt(std::string message, std::function<void()> onYesCallback) {
+void AnnualView::prompt(std::string message, std::function<void()> onYesCallback) {
     m_rootComponent->prompt(message, onYesCallback);
 }
-void YearView::promptOk(std::string message, std::function<void()> callback) {
+void AnnualView::promptOk(std::string message, std::function<void()> callback) {
     m_rootComponent->promptOk(message, callback);
 }
-void YearView::loadingScreen(const std::string &message) {
+void AnnualView::loadingScreen(const std::string &message) {
     m_rootComponent->loadingScreen(message);
 }
-void YearView::loadingScreenOff() { m_rootComponent->resetToMain(); }
+void AnnualView::loadingScreenOff() { m_rootComponent->resetToMain(); }
 
 } // namespace caps_log::view

source/view/yearly_view.hpp → source/view/annual_view.hpp

@@ -1,12 +1,12 @@
 #pragma once
 
+#include "annual_view_base.hpp"
 #include "calendar_component.hpp"
 #include "date/date.hpp"
 #include "input_handler.hpp"
 #include "preview.hpp"
 #include "promptable.hpp"
 #include "windowed_menu.hpp"
-#include "year_view_base.hpp"
 
 #include <array>
 #include <ftxui/component/captured_mouse.hpp>
@@ -22,7 +22,7 @@ using namespace ftxui;
 
 using namespace date;
 
-class YearView : public YearViewBase {
+class AnnualView : public AnnualViewBase {
     InputHandlerBase *m_handler;
     ScreenInteractive m_screen;
 
@@ -40,7 +40,7 @@ class YearView : public YearViewBase {
     std::vector<std::string> m_tagMenuItems, m_sectionMenuItems;
 
   public:
-    YearView(const Date &today, bool sundayStart);
+    AnnualView(const Date &today, bool sundayStart);
 
     void run() override;
     void stop() override;

source/view/year_view_base.hpp → source/view/annual_view_base.hpp

@@ -19,9 +19,9 @@ inline std::string makeMenuItemTitle(const std::string &title, unsigned count) {
     return std::string{"("} + std::to_string(count) + ") - " + title;
 }
 
-class YearViewBase {
+class AnnualViewBase {
   public:
-    virtual ~YearViewBase() = default;
+    virtual ~AnnualViewBase() = default;
 
     virtual void run() = 0;
     virtual void stop() = 0;

test/CMakeLists.txt

@@ -24,14 +24,14 @@ add_executable(
     ./date_test.cpp
     ./local_log_repository_test.cpp
     ./log_entry_test.cpp
-    ./year_overview_data_test.cpp
+    ./annual_log_data_test.cpp
 
     ./../source/config.cpp
     ./../source/date/date.cpp
     ./../source/log/log_file.cpp
     ./../source/log/log_repository_crypto_applyer.cpp
     ./../source/log/local_log_repository.cpp
-    ./../source/log/year_overview_data.cpp
+    ./../source/log/annual_log_data.cpp
     ./../source/utils/crypto.cpp
     ./../source/utils/git_repo.cpp
 )

test/year_overview_data_test.cpp → test/annual_log_data_test.cpp

@@ -1,16 +1,16 @@
 #include <fmt/format.h>
 #include <gtest/gtest.h>
 
+#include "log/annual_log_data.hpp"
 #include "log/log_file.hpp"
-#include "log/year_overview_data.hpp"
 
 #include "mocks.hpp"
 
 TEST(YearOverviewDataTest, Collect) {
     auto dummyDate = caps_log::date::Date{10, 10, 2020};
     auto dummyRepo = std::make_shared<DummyRepository>();
     dummyRepo->write({dummyDate, "\n# dummy section\n * dummy tag"});
-    auto data = caps_log::log::YearOverviewData::collect(dummyRepo, dummyDate.year);
+    auto data = caps_log::log::AnnualLogData::collect(dummyRepo, dummyDate.year);
 
     // inital collection
     ASSERT_EQ(data.tagMap.size(), 1);

test/controler_test.cpp

@@ -1,11 +1,10 @@
 #include "app.hpp"
 #include "mocks.hpp"
 
+#include "log/annual_log_data.hpp"
 #include "log/log_file.hpp"
 #include "log/log_repository_base.hpp"
-#include "log/year_overview_data.hpp"
 #include "view/input_handler.hpp"
-#include "view/year_view_base.hpp"
 
 #include <fstream>
 #include <ftxui/component/event.hpp>

test/local_log_repository_test.cpp

@@ -4,7 +4,6 @@
 #include "log/log_file.hpp"
 #include "log/log_repository_base.hpp"
 #include "log/log_repository_crypto_applyer.hpp"
-#include "log/year_overview_data.hpp"
 #include "mocks.hpp"
 #include <filesystem>
 #include <fstream>

test/log_entry_test.cpp

@@ -8,7 +8,6 @@
 
 #include "fmt/core.h"
 #include "log/log_file.hpp"
-#include "log/year_overview_data.hpp"
 #include "utils/string.hpp"
 
 #include "mocks.hpp"

test/mocks.hpp

@@ -1,17 +1,17 @@
 #include "date/date.hpp"
 #include "editor/editor_base.hpp"
 #include "log/log_repository_base.hpp"
+#include "view/annual_view_base.hpp"
 #include "view/calendar_component.hpp"
 #include "view/input_handler.hpp"
-#include "view/year_view_base.hpp"
 #include <gmock/gmock-actions.h>
 #include <gmock/gmock-more-actions.h>
 #include <gmock/gmock-nice-strict.h>
 #include <gmock/gmock.h>
 #include <gtest/gtest.h>
 #include <sstream>
 
-class DummyYearView : public caps_log::view::YearViewBase {
+class DummyYearView : public caps_log::view::AnnualViewBase {
   public:
     caps_log::view::InputHandlerBase *m_inputHandler = nullptr;
     int m_displayedYear;
@@ -59,7 +59,7 @@ class DummyYearView : public caps_log::view::YearViewBase {
     int &selectedSection() override { return m_selectedSection; }
 };
 
-class DMockYearView : public caps_log::view::YearViewBase {
+class DMockYearView : public caps_log::view::AnnualViewBase {
     DummyYearView view;
 
   public: