feat: create organizations slug #393

MarioRodrigues10 · 2023-08-27T01:43:24Z

No description provided.

reviewpad · 2023-08-27T01:44:28Z

AI-Generated Summary: This pull request involves many changes across the AtomicWeb Elixir application relating to the handling of organizations.

The primary change is a structural shift in the routing system. It moves from using organization IDs (organization_id) to using organization handles (handle) in the route paths. This change in identifiers has been implemented throughout numerous live view modules of various features such as Activities, Departments, Partnerships, Memberships, Boards, Home, Speakers, Announcements, and Organizations. Changes in these places resulted in modifications in the mount/3, handle_params/3 and apply_action/3 functions, and in the routing helper methods.

Other notable changes include:

The core Organization model now includes a new required field 'handle', with corresponding changes in associated tests, fixtures, and migrations.
Numerous modules now rely on new functions get_organization_by_handle/1, get_organization!/1 and change_organization_handle/2 which were added to the Organizations module to manage organizations by their handles.
Some updates in tests and seeds where the new 'handle' attribute has been added.
A few refactoring changes identified, including: removal of an unnecessary blank line, simplification of preloading data, removal of duplicate code, and improvements of code readability.

The overall aim appears to increase the readability of the URLs, possibly by making identifiers within the URL more user-friendly, and to enforce unique handles for each organization to avoid routing issues.

These alterations would significantly affect the functionality and performance of the application, and thorough tests should be conducted to ensure the routing works as expected without negatively impacting the user experience or system performance.

lib/atomic/organizations/organization.ex

danielsp45 · 2023-08-30T19:41:29Z

lib/atomic/organizations/organization.ex

+  defp validate_slug(changeset) do
+    changeset
+    |> validate_required([:slug])
+    |> validate_format(:slug, ~r/^[a-zA-Z0-9_.]+$/,


Is it a good idea to allow case sensitive slugs?

I agree they should be case insensitive. Meaning "cesium" and "CeSIUM" both stand for the same slug.

…anization-handle

lib/atomic/activities.ex

ruilopesm · 2023-08-31T22:17:29Z

lib/atomic/organizations.ex

+
+  ## Examples
+      iex> get_organization_by_slug("foo_bar")
+      %Organization{}


Suggested change

%Organization{}

%Organization{}

ruilopesm · 2023-08-31T22:23:45Z

lib/atomic/organizations.ex

@@ -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


Why this change?

ruilopesm · 2023-08-31T22:31:12Z

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),


Additionally, interpolated ~p values are encoded via the Phoenix.Param protocol. For example, a %Post{} struct in your application may derive the Phoenix.Param protocol to generate slug-based paths rather than ID based ones. This allows you to use ~p"/posts/#{post}" rather than ~p"/posts/#{post.slug}" throughout your application. See the Phoenix.Param documentation for more details.

What about implementing this? Then we would only need to write @current_organization instead of @current_organization.slug 💡

Don't forget to implement this 🙏🏼

ruilopesm · 2023-08-31T22:31:52Z

lib/atomic_web/live/activity_live/show.ex

+     |> assign(:id, id)
+     |> assign(:slug, slug)}


Why are these assigns needed?

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

ruilopesm · 2023-08-31T22:35:39Z

priv/repo/migrations/2022000000000_create_organizations.exs

@@ -13,5 +14,6 @@ defmodule Atomic.Repo.Migrations.CreateOrganizations do
    end

    create unique_index(:organizations, [:name])


We don't need an index by name. I know it was not added now, but, please, remove it 🙏🏼

ruilopesm · 2023-09-23T17:24:47Z

lib/atomic/activities.ex

+  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


We don't need this anymore, since an activity is, for now, associated to only one organization.

ruilopesm · 2023-09-23T17:25:43Z

lib/atomic_web/config.ex

+      %{
+        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),
+      },


These are admin pages. Why are you adding them here?

ruilopesm · 2023-09-23T17:26:11Z

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),


Don't forget to implement this 🙏🏼

diogogmatos · 2023-11-10T12:40:11Z

Create Organizations Slug

diogogmatos · 2023-11-10T12:40:12Z

Create Organizations Slug

joaodiaslobo · 2024-02-22T17:44:31Z

Will be done in the future

feat: create organizations handle

312d500

MarioRodrigues10 self-assigned this Aug 27, 2023

MarioRodrigues10 linked an issue Aug 27, 2023 that may be closed by this pull request

Create organizations handle #353

Open

2 tasks

MarioRodrigues10 added this to the 1.0.0 milestone Aug 27, 2023

reviewpad bot requested review from danielsp45, feliciofilipe, joaodiaslobo, ruilopesm and ruioliveira02 August 27, 2023 01:43

MarioRodrigues10 added enhancement New feature or improvements frontend Frontend related backend Backend related database Database related labels Aug 27, 2023

feliciofilipe changed the title ~~feat: create organizations handle~~ feat: create organizations handler Aug 29, 2023

feliciofilipe reviewed Aug 29, 2023

View reviewed changes

lib/atomic/organizations/organization.ex Outdated Show resolved Hide resolved

change handle to slug

f8366c6

ruilopesm mentioned this pull request Aug 30, 2023

Change user handle to slug #399

Closed

ruilopesm removed this from the 1.0.0 milestone Aug 30, 2023

danielsp45 reviewed Aug 30, 2023

View reviewed changes

MarioRodrigues10 added 2 commits August 31, 2023 13:43

Merge branch 'develop' of github.com:cesium/atomic into mr/create-org…

e4d5e2b

…anization-handle

Fix tests

a9597b5

ruilopesm reviewed Aug 31, 2023

View reviewed changes

ruilopesm changed the title ~~feat: create organizations handler~~ feat: create organizations slug Sep 1, 2023

MarioRodrigues10 added 3 commits September 6, 2023 19:22

Rebase with recent updates

2d53906

Remove duplicated function

7dd666a

rebase and updates

e53a92e

ruilopesm reviewed Sep 23, 2023

View reviewed changes

joaodiaslobo closed this Feb 22, 2024

ruilopesm deleted the mr/create-organization-handle branch August 6, 2024 11:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: create organizations slug #393

feat: create organizations slug #393

MarioRodrigues10 commented Aug 27, 2023

reviewpad bot commented Aug 27, 2023

danielsp45 Aug 30, 2023

ruilopesm Aug 30, 2023

ruilopesm Aug 31, 2023

ruilopesm Aug 31, 2023

ruilopesm Aug 31, 2023

ruilopesm Sep 23, 2023

ruilopesm Aug 31, 2023

ruilopesm Aug 31, 2023

ruilopesm Sep 23, 2023

ruilopesm Sep 23, 2023

ruilopesm Sep 23, 2023

diogogmatos commented Nov 10, 2023

diogogmatos commented Nov 10, 2023

joaodiaslobo commented Feb 22, 2024

		@@ -13,5 +14,6 @@ defmodule Atomic.Repo.Migrations.CreateOrganizations do
		end

		create unique_index(:organizations, [:name])

feat: create organizations slug #393

feat: create organizations slug #393

Conversation

MarioRodrigues10 commented Aug 27, 2023

reviewpad bot commented Aug 27, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

diogogmatos commented Nov 10, 2023

diogogmatos commented Nov 10, 2023

joaodiaslobo commented Feb 22, 2024