feat: create organizations slug

lib/atomic/activities.ex

@@ -9,6 +9,7 @@ defmodule Atomic.Activities do
   alias Atomic.Activities.Enrollment
   alias Atomic.Activities.Session
   alias Atomic.Activities.Speaker
+  alias Atomic.Organizations
 
   @doc """
   Returns the list of activities.
@@ -100,8 +101,11 @@ defmodule Atomic.Activities do
   """
   def get_session_organizations!(session, preloads \\ [:departments]) do
     Repo.preload(session, preloads)
-    |> Map.get(:departments, [])
+    |> Map.get(:departments)
     |> Enum.map(& &1.organization_id)
+    |> Enum.map(fn id ->
+      Organizations.get_organization!(id).slug
+    end)
   end
 
   @doc """

lib/atomic/organizations.ex

@@ -81,6 +81,31 @@ defmodule Atomic.Organizations do
     |> Repo.update()
   end
 
+  @doc """
+  Gets an organization by slug.
+
+  ## Examples
+      iex> get_organization_by_slug("foo_bar")
+      %Organization{}
+      iex> get_organization_by_slug("unknown")
+      nil
+
+  """
+  def get_organization_by_slug(slug) when is_binary(slug) do
+    Repo.get_by(Organization, slug: slug)
+  end
+
+  @doc """
+  Returns an `%Ecto.Changeset{}` for changing the organization slug.
+
+  ## Examples
+      iex> change_organization_slug(organization)
+      %Ecto.Changeset{data: %Organization{}}
+  """
+  def change_organization_slug(organization, attrs \\ %{}) do
+    Organization.slug_changeset(organization, attrs)
+  end
+
   @doc """
   Updates an organization card image.
 
@@ -213,7 +238,7 @@ defmodule Atomic.Organizations do
       nil
 
   """
-  def get_role(user_id, organization_id) do
+  def get_role(user_id, organization_id) when is_binary(user_id) and is_binary(organization_id) do
     Membership
     |> where([m], m.user_id == ^user_id and m.organization_id == ^organization_id)
     |> Repo.one()

lib/atomic/organizations/organization.ex

@@ -7,14 +7,15 @@ defmodule Atomic.Organizations.Organization do
   alias Atomic.Organizations.{Announcement, Board, Card, Department, Membership, Partner}
   alias Atomic.Uploaders
 
-  @required_fields ~w(name description)a
+  @required_fields ~w(name slug description)a
   @optional_fields ~w(card_image logo)a
 
   schema "organizations" do
     field :name, :string
     field :description, :string
     field :card_image, Uploaders.Card.Type
     field :logo, Uploaders.Logo.Type
+    field :slug, :string
 
     has_many :departments, Department,
       on_replace: :delete_if_exists,
@@ -53,6 +54,7 @@ defmodule Atomic.Organizations.Organization do
     |> cast_embed(:card, with: &Card.changeset/2)
     |> cast_attachments(attrs, [:card_image, :logo])
     |> validate_required(@required_fields)
+    |> validate_slug()
     |> unique_constraint(:name)
   end
 
@@ -66,4 +68,30 @@ defmodule Atomic.Organizations.Organization do
     organization
     |> cast_attachments(attrs, [:logo])
   end
+
+  @doc """
+    An organization changeset for changing the slug.
+    It requires the slug to change otherwise an error is added.
+  """
+  def slug_changeset(organization, attrs) do
+    organization
+    |> cast(attrs, [:slug])
+    |> validate_slug()
+    |> case do
+      %{changes: %{slug: _}} = changeset -> changeset
+      %{} = changeset -> add_error(changeset, :slug, "did not change")
+    end
+  end
+
+  defp validate_slug(changeset) do
+    changeset
+    |> validate_required([:slug])
+    |> validate_format(:slug, ~r/^[a-zA-Z0-9_.]+$/,
+      message:
+        gettext("must only contain alphanumeric characters, numbers, underscores and periods")
+    )
+    |> validate_length(:slug, min: 3, max: 30)
+    |> unsafe_validate_unique(:slug, Atomic.Repo)
+    |> unique_constraint(:slug)
+  end
 end

lib/atomic_web/config.ex

@@ -8,7 +8,10 @@ defmodule AtomicWeb.Config do
   def pages(conn, current_organization, current_user) do
     if current_organization do
       if current_user.role in [:admin] or
-           Organizations.get_role(current_user.id, current_organization.id) in [:admin, :owner] do
+           Organizations.get_role(current_user.id, current_organization.id) in [
+             :admin,
+             :owner
+           ] do
         admin_pages(conn, current_organization, current_user)
       else
         user_pages(conn, current_organization, current_user)
@@ -50,35 +53,35 @@ defmodule AtomicWeb.Config do
         key: :activities,
         title: "Activities",
         icon: :academic_cap,
-        url: Routes.activity_index_path(conn, :index, current_organization.id),
+        url: Routes.activity_index_path(conn, :index, current_organization.slug),
         tabs: []
       },
       %{
         key: :departments,
         title: "Departments",
         icon: :cube,
-        url: Routes.department_index_path(conn, :index, current_organization.id),
+        url: Routes.department_index_path(conn, :index, current_organization.slug),
         tabs: []
       },
       %{
         key: :partners,
         title: "Partners",
         icon: :user_group,
-        url: Routes.partner_index_path(conn, :index, current_organization.id),
+        url: Routes.partner_index_path(conn, :index, current_organization.slug),
         tabs: []
       },
       %{
         key: :memberships,
         title: "Memberships",
         icon: :user_add,
-        url: Routes.membership_index_path(conn, :index, current_organization.id),
+        url: Routes.membership_index_path(conn, :index, current_organization.slug),
         tabs: []
       },
       %{
         key: :board,
         title: "Board",
         icon: :users,
-        url: Routes.board_index_path(conn, :index, current_organization.id),
+        url: Routes.board_index_path(conn, :index, current_organization.slug),
         tabs: []
       },
       %{
@@ -132,28 +135,28 @@ defmodule AtomicWeb.Config do
         key: :activities,
         title: "Activities",
         icon: :academic_cap,
-        url: Routes.activity_index_path(conn, :index, current_organization.id),
+        url: Routes.activity_index_path(conn, :index, current_organization.slug),
         tabs: []
       },
       %{
         key: :departments,
         title: "Departments",
         icon: :cube,
-        url: Routes.department_index_path(conn, :index, current_organization.id),
+        url: Routes.department_index_path(conn, :index, current_organization.slug),
         tabs: []
       },
       %{
         key: :partners,
         title: "Partners",
         icon: :user_group,
-        url: Routes.partner_index_path(conn, :index, current_organization.id),
+        url: Routes.partner_index_path(conn, :index, current_organization.slug),
         tabs: []
       },
       %{
         key: :board,
         title: "Board",
         icon: :users,
-        url: Routes.board_index_path(conn, :index, current_organization.id),
+        url: Routes.board_index_path(conn, :index, current_organization.slug),
         tabs: []
       },
       %{

lib/atomic_web/live/activity_live/index.ex

@@ -10,15 +10,16 @@ defmodule AtomicWeb.ActivityLive.Index do
 
   @impl true
   def mount(params, _session, socket) do
-    {:ok, assign(socket, :sessions, list_sessions(params["organization_id"]))}
+    organization = Organizations.get_organization_by_slug(params["slug"])
+    {:ok, assign(socket, :sessions, list_sessions(organization.id))}
   end
 
   @impl true
   def handle_params(params, _url, socket) do
     entries = [
       %{
         name: gettext("Activities"),
-        route: Routes.activity_index_path(socket, :index, params["organization_id"])
+        route: Routes.activity_index_path(socket, :index, params["slug"])
       }
     ]
 
@@ -60,7 +61,7 @@ defmodule AtomicWeb.ActivityLive.Index do
   end
 
   defp apply_action(socket, :index, params) do
-    organization = Organizations.get_organization!(params["organization_id"])
+    organization = Organizations.get_organization_by_slug(params["slug"])
 
     socket
     |> assign(:page_title, "#{organization.name}'s Activities")

lib/atomic_web/live/activity_live/index.html.heex

@@ -10,7 +10,7 @@
         <%= if not @empty and @has_permissions do %>
           <div class="hidden lg:border-orange-500 lg:block">
             <%= live_patch("+ New Activity",
-              to: Routes.activity_new_path(@socket, :new, @current_organization),
+              to: Routes.activity_new_path(@socket, :new, @current_organization.slug),
               class: "border-2 rounded-md bg-white text-lg border-orange-500 py-2 px-3.5 text-sm font-medium text-orange-500 shadow-sm hover:bg-orange-500 hover:text-white"
             ) %>
           </div>
@@ -32,15 +32,15 @@
     </div>
     <%= if @empty do %>
       <div class="mt-32">
-        <.empty_state id="empty_state" url={Routes.activity_new_path(@socket, :new, @current_organization)} plural_placeholder="activities" placeholder="activity" />
+        <.empty_state id="empty_state" url={Routes.activity_new_path(@socket, :new, @current_organization.slug)} plural_placeholder="activities" placeholder="activity" />
       </div>
     <% else %>
       <div>
         <div class="overflow-hidden bg-white">
           <ul role="list" class="divide-y divide-zinc-200">
             <%= for session <- @sessions do %>
               <li>
-                <%= live_redirect to: Routes.activity_show_path(@socket, :show, @current_organization, session), class: "block hover:bg-zinc-50", replace: false do %>
+                <%= live_redirect to: Routes.activity_show_path(@socket, :show, @current_organization.slug, session), class: "block hover:bg-zinc-50", replace: false do %>
                   <div class="px-4 py-4 lg:px-6">
                     <div class="flex items-center justify-between">
                       <p class="truncate text-sm font-medium text-zinc-900">

lib/atomic_web/live/activity_live/show.ex

@@ -7,35 +7,37 @@ defmodule AtomicWeb.ActivityLive.Show do
   alias AtomicWeb.MismatchError
 
   @impl true
-  def mount(%{"id" => id}, _session, socket) do
+  def mount(%{"slug" => slug, "id" => id}, _session, socket) do
     if connected?(socket) do
       Activities.subscribe("new_enrollment")
       Activities.subscribe("deleted_enrollment")
     end
 
-    {:ok, assign(socket, :id, id)}
+    {:ok,
+     socket
+     |> assign(:id, id)
+     |> assign(:slug, slug)}
   end
 
   @impl true
-  def handle_params(%{"organization_id" => organization_id, "id" => id}, _, socket) do
+  def handle_params(%{"slug" => slug, "id" => id}, _, socket) do
     session = Activities.get_session!(id, [:activity, :speakers, :departments])
-
     activity = Activities.get_activity!(session.activity_id, [:sessions])
 
     organizations = Activities.get_session_organizations!(session, [:departments])
 
     entries = [
       %{
         name: gettext("Activities"),
-        route: Routes.activity_index_path(socket, :index, organization_id)
+        route: Routes.activity_index_path(socket, :index, slug)
       },
       %{
         name: activity.title,
-        route: Routes.activity_show_path(socket, :show, organization_id, session.id)
+        route: Routes.activity_show_path(socket, :show, slug, session.id)
       }
     ]
 
-    if organization_id in organizations do
+    if slug in organizations do
       {:noreply,
        socket
        |> assign(

lib/atomic_web/live/activity_live/show.html.heex

@@ -1,12 +1,6 @@
 <%= if @live_action in [:edit] do %>
-  <.modal return_to={Routes.activity_show_path(@socket, :show, @current_organization, @activity)}>
-    <.live_component module={AtomicWeb.ActivityLive.FormComponent} id={@activity.id} title={@page_title} action={@live_action} activity={@activity} return_to={Routes.activity_show_path(@socket, :show, @current_organization, @activity)} />
-  </.modal>
-<% end %>
-
-<%= if @live_action in [:edit] do %>
-  <.modal return_to={Routes.activity_show_path(@socket, :show, @current_organization, @activity)}>
-    <.live_component module={AtomicWeb.ActivityLive.FormComponent} id={@activity.id} organization={@current_organization} title={@page_title} action={@live_action} activity={@activity} return_to={Routes.activity_show_path(@socket, :show, @current_organization, @activity)} />
+  <.modal return_to={Routes.activity_show_path(@socket, :show, @current_organization.slug, @activity)}>
+    <.live_component module={AtomicWeb.ActivityLive.FormComponent} id={@activity.id} title={@page_title} action={@live_action} activity={@activity} return_to={Routes.activity_show_path(@socket, :show, @current_organization.slug, @activity)} />
   </.modal>
 <% end %>
 
@@ -117,7 +111,7 @@
                             <%= Accounts.extract_initials(speaker.name) %>
                           </span>
                         </span>
-                        <%= live_redirect to: Routes.speaker_show_path(@socket, :show, @current_organization, speaker), class: "text-md text-blue-500" do %>
+                        <%= live_redirect to: Routes.speaker_show_path(@socket, :show, @current_organization.slug, speaker), class: "text-md text-blue-500" do %>
                           <%= Accounts.extract_first_last_name(speaker.name) %>
                         <% end %>
                       </div>
@@ -169,7 +163,7 @@
 
 <div class="flex flex-row space-x-1">
   <%= if @current_user.role in [:admin] or Organizations.is_admin?(@current_user, @session.departments) do %>
-    <%= live_patch to: Routes.activity_edit_path(@socket, :edit, @activity, @current_organization), class: "button" do %>
+    <%= live_patch to: Routes.activity_edit_path(@socket, :edit, @current_organization.slug, @activity), class: "button" do %>
       <div type="button" class="inline-flex justify-center py-2 px-4 w-fit text-sm font-medium text-gray-700 bg-white rounded-md border border-gray-300 shadow-sm hover:bg-gray-50" id="sort-menu-button" aria-expanded="false" aria-haspopup="true">
         <Heroicons.Solid.pencil class="mr-3 w-5 h-5 text-gray-400" /> Edit
       </div>

lib/atomic_web/live/announcement_live/index.ex

@@ -9,11 +9,13 @@ defmodule AtomicWeb.AnnouncementLive.Index do
   alias Atomic.Organizations.Announcement
 
   @impl true
-  def mount(%{"organization_id" => organization_id}, _session, socket) do
+  def mount(%{"slug" => slug}, _session, socket) do
+    organization = Organizations.get_organization_by_slug(slug)
+
     socket =
       socket
-      |> assign(:organization, Organizations.get_organization!(organization_id))
-      |> assign(:announcements, list_announcements(organization_id))
+      |> assign(:organization, organization)
+      |> assign(:announcements, list_announcements(organization.id))
 
     {:ok, socket}
   end
@@ -23,7 +25,7 @@ defmodule AtomicWeb.AnnouncementLive.Index do
     entries = [
       %{
         name: gettext("Announcement"),
-        route: Routes.announcement_index_path(socket, :index, params["organization_id"])
+        route: Routes.announcement_index_path(socket, :index, params["slug"])
       }
     ]
 
@@ -65,7 +67,7 @@ defmodule AtomicWeb.AnnouncementLive.Index do
   end
 
   defp apply_action(socket, :index, params) do
-    organization = Organizations.get_organization!(params["organization_id"])
+    organization = Organizations.get_organization_by_slug(params["slug"])
 
     socket
     |> assign(:page_title, "#{organization.name}'s Announcement")

lib/atomic_web/live/announcement_live/index.html.heex

@@ -15,7 +15,7 @@
       <%= if not @empty and @has_permissions do %>
         <div class="hidden lg:border-orange-500 lg:block">
           <%= live_patch("+ New Announcement",
-            to: Routes.announcement_new_path(@socket, :new, @current_organization),
+            to: Routes.announcement_new_path(@socket, :new, @current_organization.slug),
             class: "border-2 rounded-md bg-white text-lg border-orange-500 py-2 px-3.5 text-sm font-medium text-orange-500 shadow-sm hover:bg-orange-500 hover:text-white"
           ) %>
         </div>
@@ -35,12 +35,12 @@
 
 <%= if @empty do %>
   <div class="mt-32">
-    <.empty_state id="empty_state" url={Routes.announcement_new_path(@socket, :new, @current_organization)} placeholder="announcement" />
+    <.empty_state id="empty_state" url={Routes.announcement_new_path(@socket, :new, @current_organization.slug)} placeholder="announcement" />
   </div>
 <% else %>
   <ul role="list" class="relative z-0 divide-y divide-gray-200">
     <%= for announcement <- @announcements do %>
-      <.announcement organization={@current_organization} announcement={announcement} url={Routes.announcement_show_path(@socket, :show, @current_organization, announcement.id)} />
+      <.announcement organization={@current_organization} announcement={announcement} url={Routes.announcement_show_path(@socket, :show, @current_organization.slug, announcement.id)} />
     <% end %>
   </ul>
 <% end %>