code_corps

v0.0.1

code_corps v0.0.1 CodeCorps.Policy.Helpers View Source

Holds helpers for extracting record relationships and determining roles for authorization policies.

Link to this section Summary

Functions

administered_by?(project, user)

Determines if the provided project is being administered by the provided User

contributed_by?(project, user)

Determines if the provided project is being contributed to by the provided User

get_conversation(arg1)

Retrieves conversation from associated record

get_membership(project, user)

Returns CodeCorps.ProjectUser for specified CodeCorps.Project and CodeCorps.User, or nil

get_message(arg1)

Retrieves message from associated record

get_organization(arg1)

Retrieves an organization record, from a model struct, or an Ecto.Changeset containing an organization_id field

get_project(arg1)

Retrieves a project record, from a model struct, or an Ecto.Changeset containing a project_id field

get_role(changeset)

Retrieves the role field from a CodeCorps.ProjectUser struct or an Ecto.Changeset

get_task(arg1)

Retrieves task from associated record

owned_by?(project, user)

Determines if the provided organization or project is owned by the provided user

task_authored_by?(task, user)

Determines if the provided task was authored by the provided user

Link to this section Functions

Link to this function administered_by?(project, user) View Source 
administered_by?(nil | CodeCorps.Project.t(), CodeCorps.User.t()) :: boolean()

Determines if the provided project is being administered by the provided User

Returns true if the user is an admin or higher member of the project

Link to this function contributed_by?(project, user) View Source 
contributed_by?(nil | CodeCorps.Project.t(), CodeCorps.User.t()) :: boolean()

Determines if the provided project is being contributed to by the provided User

Returns true if the user is a contributor or higher member of the project

Link to this function get_conversation(arg1) View Source 
get_conversation(Ecto.Changeset.t() | CodeCorps.ConversationPart.t() | map()) :: CodeCorps.Conversation.t()

Retrieves conversation from associated record

Link to this function get_membership(project, user) View Source 
get_membership(CodeCorps.Project.t(), CodeCorps.User.t()) ::
  nil |
  CodeCorps.ProjectUser.t()

Returns CodeCorps.ProjectUser for specified CodeCorps.Project and CodeCorps.User, or nil

Link to this function get_message(arg1) View Source 
get_message(Ecto.Changeset.t() | CodeCorps.Conversation.t() | map()) :: CodeCorps.Message.t()

Retrieves message from associated record

Link to this function get_organization(arg1) View Source 
get_organization(struct() | Ecto.Changeset.t() | any()) :: CodeCorps.Organization.t()

Retrieves an organization record, from a model struct, or an Ecto.Changeset containing an organization_id field

Returns CodeCorps.Organization

Link to this function get_project(arg1) View Source 
get_project(struct() | Ecto.Changeset.t() | any()) :: CodeCorps.Project.t()

Retrieves a project record, from a model struct, or an Ecto.Changeset containing a project_id field

Returns CodeCorps.Project

Link to this function get_role(changeset) View Source 
get_role(nil | CodeCorps.ProjectUser.t() | Ecto.Changeset.t()) ::
  String.t() |
  nil

Retrieves the role field from a CodeCorps.ProjectUser struct or an Ecto.Changeset

Link to this function get_task(arg1) View Source 
get_task(Ecto.Changeset.t() | CodeCorps.TaskSkill.t() | CodeCorps.UserTask.t() | map()) :: CodeCorps.Task.t()

Retrieves task from associated record

Link to this function owned_by?(project, user) View Source 
owned_by?(nil | CodeCorps.Organization.t() | CodeCorps.Project.t(), CodeCorps.User.t()) :: boolean()

Determines if the provided organization or project is owned by the provided user

Link to this function task_authored_by?(task, user) View Source 
task_authored_by?(CodeCorps.Task.t(), CodeCorps.User.t()) :: boolean()

Determines if the provided task was authored by the provided user