PaperTiger.Store.Plans (PaperTiger v0.9.20)

View Source

ETS-backed storage for Plan resources.

Uses the shared store pattern via use PaperTiger.Store which provides:

  • GenServer wraps ETS table
  • Reads go directly to ETS (concurrent, fast)
  • Writes go through GenServer (serialized, safe)

Architecture

  • ETS Table: :paper_tiger_plans (public, read_concurrency: true)
  • GenServer: Serializes writes, handles initialization
  • Shared Implementation: All CRUD operations via PaperTiger.Store

Examples

# Direct read (no GenServer bottleneck)
{:ok, plan} = PaperTiger.Store.Plans.get("plan_123")

# Serialized write
plan = %{id: "plan_123", product: "prod_123", ...}
{:ok, plan} = PaperTiger.Store.Plans.insert(plan)

# Query helpers (direct ETS access)
plans = PaperTiger.Store.Plans.find_by_product("prod_123")
active_plans = PaperTiger.Store.Plans.find_active()

Summary

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

clear()

Clears all plans from the store (all namespaces).

clear_namespace(namespace)

Clears all plans for a specific namespace.

count()

Counts total plans in current namespace.

delete(id)

Deletes a plan from the store.

find_active()

Finds active plans.

find_by_product(product_id)

Finds plans by product ID.

get(id)

Retrieves a plan by ID.

insert(item)

Inserts a plan into the store.

list(opts \\ %{})

Lists all plans with optional pagination.

list_namespace(namespace)

Returns all items in a specific namespace.

prefix()

Returns the ID prefix for this resource.

start_link(opts \\ [])

Starts the plan store GenServer.

table_name()

Returns the ETS table name for this store.

update(item)

Updates a plan in the store.

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

clear()

@spec clear() :: :ok

Clears all plans from the store (all namespaces).

Serialized write - goes through GenServer.

Useful for test cleanup. Note: This clears ALL data, not just the current namespace. For namespace-specific cleanup, use clear_namespace/1.

clear_namespace(namespace)

@spec clear_namespace(pid() | :global) :: :ok

Clears all plans for a specific namespace.

Used by PaperTiger.Test to clean up after each test.

count()

@spec count() :: non_neg_integer()

Counts total plans in current namespace.

Direct ETS access - does not go through GenServer.

delete(id)

@spec delete(String.t()) :: :ok

Deletes a plan from the store.

Serialized write - goes through GenServer. Data is scoped to the current test namespace.

find_active()

@spec find_active() :: [map()]

Finds active plans.

Direct ETS access - does not go through GenServer.

find_by_product(product_id)

@spec find_by_product(String.t()) :: [map()]

Finds plans by product ID.

Direct ETS access - does not go through GenServer.

get(id)

@spec get(String.t()) :: {:ok, map()} | {:error, :not_found}

Retrieves a plan by ID.

Direct ETS access - does not go through GenServer. Data is scoped to the current test namespace.

insert(item)

@spec insert(map()) :: {:ok, map()}

Inserts a plan into the store.

Serialized write - goes through GenServer to prevent race conditions. Data is scoped to the current test namespace.

list(opts \\ %{})

@spec list(keyword() | map()) :: PaperTiger.List.t()

Lists all plans with optional pagination.

Direct ETS access - does not go through GenServer. Data is scoped to the current test namespace.

Options

  • :limit - Number of items (default: 10, max: 100)
  • :starting_after - Cursor for pagination
  • :ending_before - Reverse cursor

list_namespace(namespace)

@spec list_namespace(pid() | :global) :: [map()]

Returns all items in a specific namespace.

Useful for debugging test isolation.

prefix()

@spec prefix() :: String.t() | nil

Returns the ID prefix for this resource.

start_link(opts \\ [])

@spec start_link(keyword()) :: GenServer.on_start()

Starts the plan store GenServer.

table_name()

@spec table_name() :: atom()

Returns the ETS table name for this store.

update(item)

@spec update(map()) :: {:ok, map()}

Updates a plan in the store.

Serialized write - goes through GenServer. Data is scoped to the current test namespace.