Current section

Files

Jump to
combo lib combo router resource.ex
Raw

lib/combo/router/resource.ex

defmodule Combo.Router.Resource do
@moduledoc false
alias Combo.Router.Resource
@default_param_key "id"
@actions [:index, :edit, :new, :show, :create, :update, :delete]
@doc """
The `Combo.Router.Resource` struct. It stores:
* `:path` - the path as string (not normalized)
* `:param` - the param to be used in routes (not normalized)
* `:controller` - the controller as an atom
* `:actions` - a list of actions as atoms
* `:route` - the context for resource routes
* `:member` - the context for member routes
* `:collection` - the context for collection routes
"""
defstruct [:path, :actions, :param, :route, :controller, :member, :collection, :singleton]
@type t :: %Resource{}
@doc """
Builds a resource struct.
"""
def build(path, controller, options) when is_atom(controller) and is_list(options) do
path = Combo.Router.Scope.validate_path(path)
alias = Keyword.get(options, :alias)
param = Keyword.get(options, :param, @default_param_key)
name = Keyword.get(options, :name, Combo.Naming.resource_name(controller, "Controller"))
as = Keyword.get(options, :as, name)
private = Keyword.get(options, :private, %{})
assigns = Keyword.get(options, :assigns, %{})
singleton = Keyword.get(options, :singleton, false)
actions = extract_actions(options, singleton)
route = [as: as, private: private, assigns: assigns]
collection = [path: path, as: as, private: private, assigns: assigns]
member_path = if singleton, do: path, else: Path.join(path, ":#{name}_#{param}")
member = [path: member_path, as: as, alias: alias, private: private, assigns: assigns]
%Resource{
path: path,
actions: actions,
param: param,
route: route,
member: member,
collection: collection,
controller: controller,
singleton: singleton
}
end
defp extract_actions(opts, singleton) do
only = Keyword.get(opts, :only)
except = Keyword.get(opts, :except)
cond do
only ->
supported_actions = validate_actions(:only, singleton, only)
supported_actions -- (supported_actions -- only)
except ->
supported_actions = validate_actions(:except, singleton, except)
supported_actions -- except
true ->
default_actions(singleton)
end
end
defp validate_actions(type, singleton, actions) do
supported_actions = default_actions(singleton)
unless actions -- supported_actions == [] do
raise ArgumentError, """
invalid :#{type} action(s) passed to resources.
supported#{if singleton, do: " singleton", else: ""} actions: #{inspect(supported_actions)}
got: #{inspect(actions)}
"""
end
supported_actions
end
defp default_actions(true = _singleton), do: @actions -- [:index]
defp default_actions(false = _singleton), do: @actions
end