Merge pull request #5 from QuentinGruber/feature/long_break

long breaks

Author: QuentinGruber

lua/pomodoro/pomodoro.lua

@@ -9,6 +9,9 @@ local Phases = constants.Phases
 ---@class Pomodoro
 ---@field work_duration number
 ---@field break_duration number
+---@field long_break_duration number
+---@field breaks_before_long number
+---@field break_count number
 ---@field timer_duration number
 ---@field start_at_launch boolean
 ---@field timer uv_timer_t
@@ -19,8 +22,12 @@ local pomodoro = {}
 pomodoro.work_duration = 25 * MIN_IN_MS
 -- Break duration in ms
 pomodoro.break_duration = 5 * MIN_IN_MS
+-- Break duration in ms
+pomodoro.long_break_duration = 15 * MIN_IN_MS
 -- Delay duration in ms
 pomodoro.delay_duration = 1 * MIN_IN_MS
+pomodoro.break_count = 0
+pomodoro.breaks_before_long = 4
 pomodoro.timer_duration = 0
 pomodoro.start_at_launch = true
 pomodoro.timer = uv.new_timer()
@@ -56,11 +63,25 @@ function pomodoro.closePomodoroUi()
     UI.close()
 end
 
+---@return boolean
+function pomodoro.isInLongBreak()
+    return pomodoro.break_count % (pomodoro.breaks_before_long + 1) == 0
+        and pomodoro.phase == Phases.BREAK
+end
+
 function pomodoro.startBreak()
-    info("Break of " .. pomodoro.break_duration / MIN_IN_MS .. "m started!")
     pomodoro.phase = Phases.BREAK
+    pomodoro.break_count = pomodoro.break_count + 1
+    local break_duration
+    if pomodoro.isInLongBreak() then
+        break_duration = pomodoro.long_break_duration
+    else
+        break_duration = pomodoro.break_duration
+    end
+
+    info("Break of " .. break_duration / MIN_IN_MS .. "m started!")
     vim.schedule(pomodoro.displayPomodoroUI)
-    pomodoro.startTimer(pomodoro.break_duration, pomodoro.endBreak)
+    pomodoro.startTimer(break_duration, pomodoro.endBreak)
 end
 
 function pomodoro.endBreak()
@@ -79,7 +100,10 @@ end
 
 function pomodoro.delayBreak()
     if pomodoro.phase == Phases.BREAK then
+        info("Break delayed")
         pomodoro.phase = Phases.RUNNING
+        -- So if a long break is delayed the next break is still a long one
+        pomodoro.break_count = pomodoro.break_count - 1
         pomodoro.closePomodoroUi()
         pomodoro.startTimer(MIN_IN_MS, pomodoro.startBreak)
     end
@@ -117,7 +141,9 @@ end
 ---@class PomodoroOpts
 ---@field work_duration? number
 ---@field break_duration? number
+---@field long_break_duration? number
 ---@field delay_duration? number
+---@field breaks_before_long? number
 ---@field start_at_launch? boolean
 
 ---@param opts PomodoroOpts
@@ -129,9 +155,15 @@ function pomodoro.setup(opts)
         if opts.break_duration ~= nil then
             pomodoro.break_duration = opts.break_duration * MIN_IN_MS
         end
+        if opts.long_break_duration ~= nil then
+            pomodoro.long_break_duration = opts.long_break_duration * MIN_IN_MS
+        end
         if opts.delay_duration ~= nil then
             pomodoro.delay_duration = opts.delay_duration * MIN_IN_MS
         end
+        if opts.breaks_before_long ~= nil then
+            pomodoro.breaks_before_long = opts.breaks_before_long
+        end
         if opts.start_at_launch ~= nil then
             pomodoro.start_at_launch = opts.start_at_launch
         end

lua/pomodoro/tests/pomodoro_spec.lua

@@ -9,10 +9,18 @@ describe("useless tests", function()
         opts.work_duration = 10
         opts.break_duration = 10
         opts.delay_duration = 10
+        opts.long_break_duration = 15
+        opts.breaks_before_long = 4
         opts.start_at_launch = false
         pomodoro.setup(opts)
+        -- TODO: use the opts value directly
         assert(pomodoro.work_duration == 10 * MIN_IN_MS, "Opt work_duration")
         assert(pomodoro.break_duration == 10 * MIN_IN_MS, "Opt break_duration")
+        assert(pomodoro.breaks_before_long == 4, "Opt breaks_before_long")
+        assert(
+            pomodoro.long_break_duration == 15 * MIN_IN_MS,
+            "Opt long_break_duration"
+        )
         assert(pomodoro.delay_duration == 10 * MIN_IN_MS, "Opt delay_duration")
         assert(pomodoro.start_at_launch == false, "Opt start_at_launch")
     end)

lua/pomodoro/ui.lua

@@ -121,7 +121,11 @@ function UI.get_buffer_data(pomodoro)
         table.insert(data, "")
         table.insert(data, center("[B]reak  [Q]uit", width))
     elseif pomodoro.phase == Phases.BREAK then
-        table.insert(data, center("☕ BREAK TIME", width))
+        if pomodoro.isInLongBreak() then
+            table.insert(data, center("☕ LONG BREAK TIME", width))
+        else
+            table.insert(data, center("☕ BREAK TIME", width))
+        end
         table.insert(data, center(time_left_string, width))
         table.insert(
             data,

lua/pomodoro/uv.lua

@@ -6,4 +6,5 @@ else
     uv = vim.loop
 end
 
+-- TODO: need to be typed
 return uv