refactor: improve CalendarCycles API and tests based on code review
All checks were successful
continuous-integration/drone/push Build is passing
All checks were successful
continuous-integration/drone/push Build is passing
This commit is contained in:
parent
822d06ed54
commit
b257c9897f
GPG key ID:
1020A035E5DD0824
2 changed files with 127 additions and 237 deletions
|
|
@ -6,53 +6,9 @@ defmodule Mv.MembershipFees.CalendarCyclesTest do
|
|||
|
||||
alias Mv.MembershipFees.CalendarCycles
|
||||
|
||||
doctest Mv.MembershipFees.CalendarCycles
|
||||
|
||||
describe "calculate_cycle_start/3" do
|
||||
test "monthly: returns 1st of month for any date" do
|
||||
assert CalendarCycles.calculate_cycle_start(~D[2024-03-15], :monthly) == ~D[2024-03-01]
|
||||
assert CalendarCycles.calculate_cycle_start(~D[2024-03-31], :monthly) == ~D[2024-03-01]
|
||||
assert CalendarCycles.calculate_cycle_start(~D[2024-03-01], :monthly) == ~D[2024-03-01]
|
||||
end
|
||||
|
||||
test "quarterly: returns 1st of quarter (Jan/Apr/Jul/Oct)" do
|
||||
# Q1 (Jan-Mar)
|
||||
assert CalendarCycles.calculate_cycle_start(~D[2024-01-15], :quarterly) == ~D[2024-01-01]
|
||||
assert CalendarCycles.calculate_cycle_start(~D[2024-02-15], :quarterly) == ~D[2024-01-01]
|
||||
assert CalendarCycles.calculate_cycle_start(~D[2024-03-15], :quarterly) == ~D[2024-01-01]
|
||||
|
||||
# Q2 (Apr-Jun)
|
||||
assert CalendarCycles.calculate_cycle_start(~D[2024-04-15], :quarterly) == ~D[2024-04-01]
|
||||
assert CalendarCycles.calculate_cycle_start(~D[2024-05-15], :quarterly) == ~D[2024-04-01]
|
||||
assert CalendarCycles.calculate_cycle_start(~D[2024-06-15], :quarterly) == ~D[2024-04-01]
|
||||
|
||||
# Q3 (Jul-Sep)
|
||||
assert CalendarCycles.calculate_cycle_start(~D[2024-07-15], :quarterly) == ~D[2024-07-01]
|
||||
assert CalendarCycles.calculate_cycle_start(~D[2024-08-15], :quarterly) == ~D[2024-07-01]
|
||||
assert CalendarCycles.calculate_cycle_start(~D[2024-09-15], :quarterly) == ~D[2024-07-01]
|
||||
|
||||
# Q4 (Oct-Dec)
|
||||
assert CalendarCycles.calculate_cycle_start(~D[2024-10-15], :quarterly) == ~D[2024-10-01]
|
||||
assert CalendarCycles.calculate_cycle_start(~D[2024-11-15], :quarterly) == ~D[2024-10-01]
|
||||
assert CalendarCycles.calculate_cycle_start(~D[2024-12-15], :quarterly) == ~D[2024-10-01]
|
||||
end
|
||||
|
||||
test "half_yearly: returns 1st of half (Jan/Jul)" do
|
||||
# First half (Jan-Jun)
|
||||
assert CalendarCycles.calculate_cycle_start(~D[2024-01-15], :half_yearly) == ~D[2024-01-01]
|
||||
assert CalendarCycles.calculate_cycle_start(~D[2024-03-15], :half_yearly) == ~D[2024-01-01]
|
||||
assert CalendarCycles.calculate_cycle_start(~D[2024-06-15], :half_yearly) == ~D[2024-01-01]
|
||||
|
||||
# Second half (Jul-Dec)
|
||||
assert CalendarCycles.calculate_cycle_start(~D[2024-07-15], :half_yearly) == ~D[2024-07-01]
|
||||
assert CalendarCycles.calculate_cycle_start(~D[2024-09-15], :half_yearly) == ~D[2024-07-01]
|
||||
assert CalendarCycles.calculate_cycle_start(~D[2024-12-15], :half_yearly) == ~D[2024-07-01]
|
||||
end
|
||||
|
||||
test "yearly: returns 1st of January" do
|
||||
assert CalendarCycles.calculate_cycle_start(~D[2024-01-15], :yearly) == ~D[2024-01-01]
|
||||
assert CalendarCycles.calculate_cycle_start(~D[2024-06-15], :yearly) == ~D[2024-01-01]
|
||||
assert CalendarCycles.calculate_cycle_start(~D[2024-12-15], :yearly) == ~D[2024-01-01]
|
||||
end
|
||||
|
||||
test "uses reference_date when provided" do
|
||||
date = ~D[2024-03-15]
|
||||
reference = ~D[2024-05-20]
|
||||
|
|
@ -62,178 +18,76 @@ defmodule Mv.MembershipFees.CalendarCyclesTest do
|
|||
end
|
||||
end
|
||||
|
||||
describe "calculate_cycle_end/2" do
|
||||
test "monthly: returns last day of month" do
|
||||
# 31-day month
|
||||
assert CalendarCycles.calculate_cycle_end(~D[2024-03-01], :monthly) == ~D[2024-03-31]
|
||||
|
||||
# 30-day month
|
||||
assert CalendarCycles.calculate_cycle_end(~D[2024-04-01], :monthly) == ~D[2024-04-30]
|
||||
|
||||
# February in leap year
|
||||
assert CalendarCycles.calculate_cycle_end(~D[2024-02-01], :monthly) == ~D[2024-02-29]
|
||||
|
||||
# February in non-leap year
|
||||
assert CalendarCycles.calculate_cycle_end(~D[2023-02-01], :monthly) == ~D[2023-02-28]
|
||||
end
|
||||
|
||||
test "quarterly: returns last day of quarter" do
|
||||
# Q1: Jan-Mar -> Mar 31
|
||||
assert CalendarCycles.calculate_cycle_end(~D[2024-01-01], :quarterly) == ~D[2024-03-31]
|
||||
|
||||
# Q2: Apr-Jun -> Jun 30
|
||||
assert CalendarCycles.calculate_cycle_end(~D[2024-04-01], :quarterly) == ~D[2024-06-30]
|
||||
|
||||
# Q3: Jul-Sep -> Sep 30
|
||||
assert CalendarCycles.calculate_cycle_end(~D[2024-07-01], :quarterly) == ~D[2024-09-30]
|
||||
|
||||
# Q4: Oct-Dec -> Dec 31
|
||||
assert CalendarCycles.calculate_cycle_end(~D[2024-10-01], :quarterly) == ~D[2024-12-31]
|
||||
end
|
||||
|
||||
test "half_yearly: returns last day of half-year" do
|
||||
# First half: Jan-Jun -> Jun 30
|
||||
assert CalendarCycles.calculate_cycle_end(~D[2024-01-01], :half_yearly) == ~D[2024-06-30]
|
||||
|
||||
# Second half: Jul-Dec -> Dec 31
|
||||
assert CalendarCycles.calculate_cycle_end(~D[2024-07-01], :half_yearly) == ~D[2024-12-31]
|
||||
end
|
||||
|
||||
test "yearly: returns Dec 31" do
|
||||
assert CalendarCycles.calculate_cycle_end(~D[2024-01-01], :yearly) == ~D[2024-12-31]
|
||||
assert CalendarCycles.calculate_cycle_end(~D[2023-01-01], :yearly) == ~D[2023-12-31]
|
||||
end
|
||||
end
|
||||
|
||||
describe "next_cycle_start/2" do
|
||||
test "monthly: adds one month" do
|
||||
assert CalendarCycles.next_cycle_start(~D[2024-01-01], :monthly) == ~D[2024-02-01]
|
||||
assert CalendarCycles.next_cycle_start(~D[2024-02-01], :monthly) == ~D[2024-03-01]
|
||||
assert CalendarCycles.next_cycle_start(~D[2024-12-01], :monthly) == ~D[2025-01-01]
|
||||
end
|
||||
|
||||
test "quarterly: adds three months" do
|
||||
assert CalendarCycles.next_cycle_start(~D[2024-01-01], :quarterly) == ~D[2024-04-01]
|
||||
assert CalendarCycles.next_cycle_start(~D[2024-04-01], :quarterly) == ~D[2024-07-01]
|
||||
assert CalendarCycles.next_cycle_start(~D[2024-07-01], :quarterly) == ~D[2024-10-01]
|
||||
assert CalendarCycles.next_cycle_start(~D[2024-10-01], :quarterly) == ~D[2025-01-01]
|
||||
end
|
||||
|
||||
test "half_yearly: adds six months" do
|
||||
assert CalendarCycles.next_cycle_start(~D[2024-01-01], :half_yearly) == ~D[2024-07-01]
|
||||
assert CalendarCycles.next_cycle_start(~D[2024-07-01], :half_yearly) == ~D[2025-01-01]
|
||||
end
|
||||
|
||||
test "yearly: adds one year" do
|
||||
assert CalendarCycles.next_cycle_start(~D[2024-01-01], :yearly) == ~D[2025-01-01]
|
||||
assert CalendarCycles.next_cycle_start(~D[2023-01-01], :yearly) == ~D[2024-01-01]
|
||||
end
|
||||
end
|
||||
|
||||
describe "current_cycle?/2" do
|
||||
test "returns true when today is within cycle" do
|
||||
today = Date.utc_today()
|
||||
cycle_start = CalendarCycles.calculate_cycle_start(today, :monthly)
|
||||
|
||||
assert CalendarCycles.current_cycle?(cycle_start, :monthly) == true
|
||||
end
|
||||
|
||||
test "returns true when today equals cycle start" do
|
||||
today = Date.utc_today()
|
||||
cycle_start = today
|
||||
|
||||
# For monthly, if today is the 1st, it's the cycle start
|
||||
if today.day == 1 do
|
||||
assert CalendarCycles.current_cycle?(cycle_start, :monthly) == true
|
||||
end
|
||||
end
|
||||
|
||||
test "returns true when today equals cycle end" do
|
||||
today = Date.utc_today()
|
||||
cycle_start = CalendarCycles.calculate_cycle_start(today, :monthly)
|
||||
cycle_end = CalendarCycles.calculate_cycle_end(cycle_start, :monthly)
|
||||
|
||||
# If today is the last day of the month, it's the cycle end
|
||||
if today == cycle_end do
|
||||
assert CalendarCycles.current_cycle?(cycle_start, :monthly) == true
|
||||
end
|
||||
end
|
||||
|
||||
test "returns false when today is before cycle start" do
|
||||
future_date = Date.add(Date.utc_today(), 35)
|
||||
cycle_start = CalendarCycles.calculate_cycle_start(future_date, :monthly)
|
||||
|
||||
assert CalendarCycles.current_cycle?(cycle_start, :monthly) == false
|
||||
end
|
||||
|
||||
test "returns false when today is after cycle end" do
|
||||
past_date = Date.add(Date.utc_today(), -35)
|
||||
cycle_start = CalendarCycles.calculate_cycle_start(past_date, :monthly)
|
||||
|
||||
assert CalendarCycles.current_cycle?(cycle_start, :monthly) == false
|
||||
end
|
||||
describe "current_cycle?/3" do
|
||||
# Basic examples are covered by doctests
|
||||
|
||||
test "works for all interval types" do
|
||||
today = Date.utc_today()
|
||||
today = ~D[2024-03-15]
|
||||
|
||||
for interval <- [:monthly, :quarterly, :half_yearly, :yearly] do
|
||||
cycle_start = CalendarCycles.calculate_cycle_start(today, interval)
|
||||
result = CalendarCycles.current_cycle?(cycle_start, interval)
|
||||
result = CalendarCycles.current_cycle?(cycle_start, interval, today)
|
||||
|
||||
assert result == true, "Expected current cycle for #{interval} with start #{cycle_start}"
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
describe "last_completed_cycle?/2" do
|
||||
test "returns true when cycle ended yesterday" do
|
||||
yesterday = Date.add(Date.utc_today(), -1)
|
||||
cycle_start = CalendarCycles.calculate_cycle_start(yesterday, :monthly)
|
||||
cycle_end = CalendarCycles.calculate_cycle_end(cycle_start, :monthly)
|
||||
|
||||
# Only test if yesterday was actually the cycle end
|
||||
if yesterday == cycle_end do
|
||||
assert CalendarCycles.last_completed_cycle?(cycle_start, :monthly) == true
|
||||
end
|
||||
end
|
||||
|
||||
test "returns false when cycle is still current" do
|
||||
describe "current_cycle?/2 wrapper" do
|
||||
test "calls current_cycle?/3 with Date.utc_today()" do
|
||||
today = Date.utc_today()
|
||||
cycle_start = CalendarCycles.calculate_cycle_start(today, :monthly)
|
||||
|
||||
assert CalendarCycles.last_completed_cycle?(cycle_start, :monthly) == false
|
||||
end
|
||||
# This test verifies the wrapper works, but uses actual today
|
||||
# The real testing happens in current_cycle?/3 tests above
|
||||
result = CalendarCycles.current_cycle?(cycle_start, :monthly)
|
||||
|
||||
test "returns false when cycle is in the future" do
|
||||
future_date = Date.add(Date.utc_today(), 35)
|
||||
cycle_start = CalendarCycles.calculate_cycle_start(future_date, :monthly)
|
||||
|
||||
assert CalendarCycles.last_completed_cycle?(cycle_start, :monthly) == false
|
||||
assert result == true
|
||||
end
|
||||
end
|
||||
|
||||
describe "last_completed_cycle?/3" do
|
||||
# Basic examples are covered by doctests
|
||||
|
||||
test "returns false when next cycle has also ended" do
|
||||
# Use a date from two cycles ago
|
||||
past_date = Date.add(Date.utc_today(), -65)
|
||||
cycle_start = CalendarCycles.calculate_cycle_start(past_date, :monthly)
|
||||
# Two cycles ago: cycle ended, but next cycle also ended
|
||||
today = ~D[2024-05-15]
|
||||
cycle_start = ~D[2024-03-01]
|
||||
# Cycle ended 2024-03-31, next cycle ended 2024-04-30, today is 2024-05-15
|
||||
|
||||
assert CalendarCycles.last_completed_cycle?(cycle_start, :monthly) == false
|
||||
assert CalendarCycles.last_completed_cycle?(cycle_start, :monthly, today) == false
|
||||
end
|
||||
|
||||
test "works correctly for quarterly intervals" do
|
||||
# Test with a known past quarter
|
||||
# Q1 2024 ended on 2024-03-31
|
||||
# Q2 2024 ends on 2024-06-30
|
||||
# Today is 2024-04-15 (after Q1 ended, before Q2 ended)
|
||||
today = ~D[2024-04-15]
|
||||
past_quarter_start = ~D[2024-01-01]
|
||||
|
||||
assert CalendarCycles.last_completed_cycle?(past_quarter_start, :quarterly, today) == true
|
||||
end
|
||||
|
||||
test "returns false when cycle ended on the given date" do
|
||||
# Cycle ends on today, so it's still current, not completed
|
||||
today = ~D[2024-03-31]
|
||||
cycle_start = ~D[2024-03-01]
|
||||
|
||||
assert CalendarCycles.last_completed_cycle?(cycle_start, :monthly, today) == false
|
||||
end
|
||||
end
|
||||
|
||||
describe "last_completed_cycle?/2 wrapper" do
|
||||
test "calls last_completed_cycle?/3 with Date.utc_today()" do
|
||||
today = Date.utc_today()
|
||||
cycle_start = CalendarCycles.calculate_cycle_start(today, :monthly)
|
||||
|
||||
if Date.compare(today, CalendarCycles.calculate_cycle_end(past_quarter_start, :quarterly)) ==
|
||||
:gt do
|
||||
# Check if next quarter hasn't ended yet
|
||||
next_quarter_start = CalendarCycles.next_cycle_start(past_quarter_start, :quarterly)
|
||||
next_quarter_end = CalendarCycles.calculate_cycle_end(next_quarter_start, :quarterly)
|
||||
# This test verifies the wrapper works, but uses actual today
|
||||
# The real testing happens in last_completed_cycle?/3 tests above
|
||||
result = CalendarCycles.last_completed_cycle?(cycle_start, :monthly)
|
||||
|
||||
if Date.compare(today, next_quarter_end) in [:lt, :eq] do
|
||||
assert CalendarCycles.last_completed_cycle?(past_quarter_start, :quarterly) == true
|
||||
end
|
||||
end
|
||||
# Result depends on actual today, so we just verify it's a boolean
|
||||
assert is_boolean(result)
|
||||
end
|
||||
end
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue