|
| 1 | +defmodule PhoenixKit.Settings.Queries do |
| 2 | + @moduledoc """ |
| 3 | + Ecto queries for Settings context. |
| 4 | +
|
| 5 | + This module encapsulates all database queries for settings management, |
| 6 | + providing a centralized location for query logic. |
| 7 | + """ |
| 8 | + |
| 9 | + import Ecto.Query |
| 10 | + |
| 11 | + alias PhoenixKit.RepoHelper |
| 12 | + alias PhoenixKit.Settings.Setting |
| 13 | + |
| 14 | + # Single record queries |
| 15 | + |
| 16 | + @doc """ |
| 17 | + Gets a setting record by key. |
| 18 | +
|
| 19 | + ## Examples |
| 20 | +
|
| 21 | + iex> PhoenixKit.Settings.Queries.get_setting_by_key("time_zone") |
| 22 | + %Setting{key: "time_zone", value: "0"} |
| 23 | +
|
| 24 | + iex> PhoenixKit.Settings.Queries.get_setting_by_key("non_existent") |
| 25 | + nil |
| 26 | + """ |
| 27 | + def get_setting_by_key(key) when is_binary(key) do |
| 28 | + repo().get_by(Setting, key: key) |
| 29 | + end |
| 30 | + |
| 31 | + # Multiple records queries |
| 32 | + |
| 33 | + @doc """ |
| 34 | + Lists all settings ordered by key. |
| 35 | +
|
| 36 | + ## Examples |
| 37 | +
|
| 38 | + iex> PhoenixKit.Settings.Queries.list_settings() |
| 39 | + [%Setting{key: "date_format", value: "Y-m-d"}, %Setting{key: "time_zone", value: "0"}, ...] |
| 40 | + """ |
| 41 | + def list_settings do |
| 42 | + Setting |
| 43 | + |> order_by([s], s.key) |
| 44 | + |> repo().all() |
| 45 | + end |
| 46 | + |
| 47 | + @doc """ |
| 48 | + Gets all settings as a list of {key, value} tuples. |
| 49 | +
|
| 50 | + ## Examples |
| 51 | +
|
| 52 | + iex> PhoenixKit.Settings.Queries.list_settings_key_values() |
| 53 | + [{"time_zone", "0"}, {"date_format", "Y-m-d"}] |
| 54 | + """ |
| 55 | + def list_settings_key_values do |
| 56 | + Setting |
| 57 | + |> select([s], {s.key, s.value}) |
| 58 | + |> repo().all() |
| 59 | + end |
| 60 | + |
| 61 | + @doc """ |
| 62 | + Lists settings for specific keys as a list of {key, value} tuples. |
| 63 | +
|
| 64 | + ## Examples |
| 65 | +
|
| 66 | + iex> PhoenixKit.Settings.Queries.list_settings_key_values_by_keys(["time_zone", "date_format"]) |
| 67 | + [{"time_zone", "0"}, {"date_format", "Y-m-d"}] |
| 68 | + """ |
| 69 | + def list_settings_key_values_by_keys(keys) when is_list(keys) do |
| 70 | + Setting |
| 71 | + |> where([s], s.key in ^keys) |
| 72 | + |> select([s], {s.key, s.value}) |
| 73 | + |> repo().all() |
| 74 | + end |
| 75 | + |
| 76 | + @doc """ |
| 77 | + Lists setting records for specific keys. |
| 78 | +
|
| 79 | + ## Examples |
| 80 | +
|
| 81 | + iex> PhoenixKit.Settings.Queries.list_settings_by_keys(["time_zone"]) |
| 82 | + [%Setting{key: "time_zone", value: "0"}] |
| 83 | + """ |
| 84 | + def list_settings_by_keys(keys) when is_list(keys) do |
| 85 | + Setting |
| 86 | + |> where([s], s.key in ^keys) |
| 87 | + |> repo().all() |
| 88 | + end |
| 89 | + |
| 90 | + @doc """ |
| 91 | + Lists settings by keys with JSON priority as a list of {key, value} tuples. |
| 92 | +
|
| 93 | + Returns a list where value_json is used if present, otherwise falls back to |
| 94 | + the string value. |
| 95 | +
|
| 96 | + ## Examples |
| 97 | +
|
| 98 | + iex> PhoenixKit.Settings.Queries.list_settings_with_json_priority_by_keys(["theme"]) |
| 99 | + [{"theme", %{"primary" => "#3b82f6"}}] |
| 100 | + """ |
| 101 | + def list_settings_with_json_priority_by_keys(keys) when is_list(keys) do |
| 102 | + Setting |
| 103 | + |> where([s], s.key in ^keys) |
| 104 | + |> repo().all() |
| 105 | + |> Enum.map(fn setting -> |
| 106 | + value = if setting.value_json, do: setting.value_json, else: setting.value |
| 107 | + {setting.key, value} |
| 108 | + end) |
| 109 | + end |
| 110 | + |
| 111 | + # Write operations |
| 112 | + |
| 113 | + @doc """ |
| 114 | + Inserts a new setting. |
| 115 | +
|
| 116 | + ## Examples |
| 117 | +
|
| 118 | + iex> %Setting{} |> Setting.changeset(%{key: "theme", value: "dark"}) |
| 119 | + ...> |> PhoenixKit.Settings.Queries.insert_setting() |
| 120 | + {:ok, %Setting{}} |
| 121 | + """ |
| 122 | + def insert_setting(changeset) do |
| 123 | + repo().insert(changeset) |
| 124 | + end |
| 125 | + |
| 126 | + @doc """ |
| 127 | + Updates an existing setting. |
| 128 | +
|
| 129 | + ## Examples |
| 130 | +
|
| 131 | + iex> setting |> Setting.update_changeset(%{value: "light"}) |
| 132 | + ...> |> PhoenixKit.Settings.Queries.update_setting() |
| 133 | + {:ok, %Setting{}} |
| 134 | + """ |
| 135 | + def update_setting(changeset) do |
| 136 | + repo().update(changeset) |
| 137 | + end |
| 138 | + |
| 139 | + # Transaction |
| 140 | + |
| 141 | + @doc """ |
| 142 | + Executes a transaction with multiple operations. |
| 143 | +
|
| 144 | + ## Examples |
| 145 | +
|
| 146 | + iex> Ecto.Multi.new() |
| 147 | + ...> |> multi_operation() |
| 148 | + ...> |> PhoenixKit.Settings.Queries.transaction() |
| 149 | + {:ok, result} |
| 150 | + """ |
| 151 | + def transaction(multi) do |
| 152 | + repo().transaction(multi) |
| 153 | + end |
| 154 | + |
| 155 | + # Private functions |
| 156 | + |
| 157 | + defp repo do |
| 158 | + RepoHelper.repo() |
| 159 | + end |
| 160 | +end |
0 commit comments