feat: create organizations slug

lib/atomic/activities.ex

@@ -8,6 +8,7 @@ defmodule Atomic.Activities do
   alias Atomic.Activities.Activity
   alias Atomic.Activities.ActivityEnrollment
   alias Atomic.Activities.Speaker
+  alias Atomic.Organizations
 
   @doc """
   Returns the list of activities.
@@ -141,7 +142,27 @@ defmodule Atomic.Activities do
   end
 
   @doc """
-  Returns true if the maximum number of enrollments has been reached.
+    Returns the list of organizations ids that are associated with an activity.
+
+    ## Examples
+
+        iex> get_activity_organizations!(activity)
+        [19d7c9e5-4212-4f59-a097-28aaa33c2621, ...]
+
+        iex> get_activity_organizations!(activity)
+        ** (Ecto.NoResultsError)
+  """
+  def get_activity_organizations!(activity, preloads \\ [:departments]) do
+    Repo.preload(activity, preloads)
+    |> Map.get(:departments, [])
+    |> Enum.map(& &1.organization_id)
+    |> Enum.map(fn id ->
+      Organizations.get_organization!(id).slug
+    end)
+  end
+
+  @doc """
+    Verifies the maximum number of enrollments for an activity.
 
     ## Examples
 

lib/atomic/organizations.ex

@@ -121,6 +121,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.
 
@@ -261,7 +286,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,7 +7,7 @@ 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
 
   @derive {
@@ -26,6 +26,7 @@ defmodule Atomic.Organizations.Organization do
     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,
@@ -64,6 +65,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
 
@@ -77,4 +79,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

@@ -2,25 +2,28 @@ defmodule AtomicWeb.Config do
   @moduledoc """
   Web configuration for our pages.
   """
+
   alias Atomic.Accounts
+  alias Atomic.Organizations
   alias AtomicWeb.Router.Helpers, as: Routes
 
   # User is not logged in
-  def pages(conn, nil, _current_organization) do
-    default_pages(conn)
+  def pages(conn, nil, current_organization) do
+    default_pages(conn, current_organization)
   end
 
   # User is logged in
   def pages(conn, current_user, current_organization) do
+
     if has_permissions?(current_user, current_organization) do
       admin_pages(conn, current_organization)
     else
-      user_pages(conn)
+      user_pages(conn, current_organization)
     end
   end
 
-  def user_pages(conn) do
-    default_pages(conn) ++
+  def user_pages(conn, current_organization) do
+    default_pages(conn, current_organization) ++
       [
         %{
           key: :scanner,
@@ -33,34 +36,34 @@ defmodule AtomicWeb.Config do
   end
 
   def admin_pages(conn, current_organization) do
-    default_pages(conn) ++
+    default_pages(conn, current_organization) ++
       [
         %{
           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: []
         },
         %{
@@ -73,7 +76,7 @@ defmodule AtomicWeb.Config do
       ]
   end
 
-  def default_pages(conn) do
+  def default_pages(conn, current_organization) do
     [
       %{
         key: :home,
@@ -96,6 +99,33 @@ defmodule AtomicWeb.Config do
         url: Routes.activity_index_path(conn, :index),
         tabs: []
       },
+      %{
+        key: :departments,
+        title: "Departments",
+        icon: :cube,
+        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.slug),
+        tabs: []
+      },
+      %{
+        key: :memberships,
+        title: "Memberships",
+        icon: :user_add,
+        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),
+      },
       %{
         key: :announcements,
         title: "Announcements",
@@ -113,14 +143,81 @@ defmodule AtomicWeb.Config do
     ]
   end
 
+  def user_pages(conn, current_organization, current_user) do
+    [
+      %{
+        key: :home,
+        title: "Home",
+        icon: :home,
+        url: Routes.home_index_path(conn, :index),
+        tabs: []
+      },
+      %{
+        key: :calendar,
+        title: "Calendar",
+        icon: :calendar,
+        url: Routes.calendar_show_path(conn, :show),
+        tabs: []
+      },
+      %{
+        key: :activities,
+        title: "Activities",
+        icon: :academic_cap,
+        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.slug),
+        tabs: []
+      },
+      %{
+        key: :partners,
+        title: "Partners",
+        icon: :user_group,
+        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.slug),
+        tabs: []
+      },
+      %{
+        key: :organizations,
+        title: "Organizations",
+        icon: :office_building,
+        url: Routes.organization_index_path(conn, :index),
+        tabs: []
+      },
+      %{
+        key: :user,
+        title: "Profile",
+        icon: :user,
+        url: Routes.user_show_path(conn, :show, current_user.handle),
+        tabs: []
+      },
+      %{
+        key: :logout,
+        title: "Logout",
+        icon: :logout,
+        url: Routes.user_session_path(conn, :delete),
+        tabs: []
+      }
+    ]
+  end
   # Returns true if the user has permissions to access the organization admin pages
   defp has_permissions?(_current_user, nil), do: false
 
   defp has_permissions?(current_user, current_organization) do
     Accounts.has_master_permissions?(current_user.id) ||
       Accounts.has_permissions_inside_organization?(
         current_user.id,
-        current_organization.id
+        current_organization.slug
       )
   end
 end

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

@@ -11,7 +11,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>
@@ -47,7 +47,7 @@
     <!-- When there aren't any activities -->
     <%= if @empty? and @has_permissions? 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 %>
       <!-- Activities listing -->

lib/atomic_web/live/activity_live/show.ex

@@ -6,18 +6,21 @@ defmodule AtomicWeb.ActivityLive.Show do
   alias Atomic.Activities.ActivityEnrollment
 
   @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, socket |> assign(:id, id)}
+    {:ok,
+     socket
+     |> assign(:id, id)
+     |> assign(:slug, slug)}
   end
 
   @impl true
-  def handle_params(%{"id" => id}, _, socket) do
-    activity = Activities.get_activity!(id, [:speakers, :organization])
+  def handle_params(%{"slug" => slug, "id" => id}, _, socket) do
+    activity = Activities.get_activity!(id, [:speakers, :departments])
 
     entries = [
       %{

lib/atomic_web/live/announcement_live/index.ex

@@ -9,7 +9,14 @@ defmodule AtomicWeb.AnnouncementLive.Index do
   alias Atomic.Organizations
 
   @impl true
-  def mount(_params, _session, socket) do
+  def mount(%{"slug" => slug}, _session, socket) do
+    organization = Organizations.get_organization_by_slug(slug)
+
+    socket =
+      socket
+      |> assign(:organization, organization)
+      |> assign(:announcements, Organizations.list_announcements_by_organization_id(organization.id))
+
     {:ok, socket}
   end