You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
analytics/lib/plausible/stats/comparisons.ex

71 lines
2.1 KiB
Elixir

defmodule Plausible.Stats.Comparisons do
@moduledoc """
This module provides functions for comparing query periods.
It allows you to compare a given period with a previous period or with the
same period from the previous year. For example, you can compare this month's
main graph with last month or with the same month from last year.
"""
alias Plausible.Stats
@modes ~w(previous_period year_over_year)
@disallowed_periods ~w(realtime all)
@type mode() :: String.t() | nil
@spec compare(
Plausible.Site.t(),
Stats.Query.t(),
mode(),
NaiveDateTime.t() | nil
) :: {:ok, Stats.Query.t()} | {:error, :not_supported}
def compare(
%Plausible.Site{} = site,
%Stats.Query{} = source_query,
mode,
now \\ nil
) do
if valid_mode?(source_query, mode) do
now = now || Timex.now(site.timezone)
{:ok, do_compare(source_query, mode, now)}
else
{:error, :not_supported}
end
end
defp do_compare(source_query, "year_over_year", now) do
start_date = Date.add(source_query.date_range.first, -365)
end_date = earliest(source_query.date_range.last, now) |> Date.add(-365)
range = Date.range(start_date, end_date)
%Stats.Query{source_query | date_range: range}
end
defp do_compare(source_query, "previous_period", now) do
last = earliest(source_query.date_range.last, now)
diff_in_days = Date.diff(source_query.date_range.first, last) - 1
new_first = Date.add(source_query.date_range.first, diff_in_days)
new_last = Date.add(last, diff_in_days)
range = Date.range(new_first, new_last)
%Stats.Query{source_query | date_range: range}
end
defp earliest(a, b) do
if Date.compare(a, b) in [:eq, :lt], do: a, else: b
end
@spec valid_mode?(Stats.Query.t(), mode()) :: boolean()
@doc """
Returns whether the source query and the selected mode support comparisons.
For example, the realtime view doesn't support comparisons. Additionally, only
#{inspect(@modes)} are supported.
"""
def valid_mode?(%Stats.Query{period: period}, mode) do
mode in @modes && period not in @disallowed_periods
end
end