Merge branch 'develop' into rl/schemas-models-migrations

CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

@@ -11,7 +11,7 @@ The following software is required to be installed on your system:
 
 - [Erlang 25+](https://www.erlang.org/downloads)
 - [Elixir 1.14+](https://elixir-lang.org/install.html)
-- [PostgreSQL 13+](https://www.postgresql.org/download/)(^See [this section](#-docker) for setting up with docker.)
+- [PostgreSQL 13+](https://www.postgresql.org/download/)(see [this section](#-docker) for setting up with docker)
 
 We recommend using [asdf version manager][asdf-vm] to install and manage all
 the programming languages' requirements.
@@ -25,6 +25,7 @@ First, clone the repository:
 ```
 git clone git@github.com:cesium/atomic.git
 cd atomic
+git checkout develop
 ```
 
 Then, run the setup script to get all dependencies configured. Make sure the database is up and running.
@@ -71,7 +72,7 @@ PostgreSQL up and running.
 If you want to setup the required database using docker containers you can
 easily do it with [docker-compose](https://docs.docker.com/compose/install/).
 
-Create and start the database containers.
+Create and start the database containers. You should use `linux.yml` if running on Linux and `darwin.yml` if running on macOS.
 
 ```
 cp .env.dev.sample .env.dev
@@ -106,3 +107,4 @@ uses.
 - [Elixir School Course](https://elixirschool.com/en/)
 - [Phoenix Guides Overview](https://hexdocs.pm/phoenix/overview.html)
 - [Phoenix Documentation](https://hexdocs.pm/phoenix)
+- [Ecto Documentation](https://hexdocs.pm/ecto)

LICENSE.txt

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2023 CeSIUM - Centro de Estudantes de Eng. Informática
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

README.md

@@ -1,20 +1,32 @@
+[contributing]: CONTRIBUTING.md
+[code_of_conduct]: CODE_OF_CONDUCT.md
+[license]: LICENSE.txt
+[ci-style-badge]: https://github.com/cesium/atomic/actions/workflows/style.yml/badge.svg
+[ci-style-link]: https://github.com/cesium/atomic/actions/workflows/style.yml
+[ci-test-badge]: https://github.com/cesium/atomic/actions/workflows/test.yml/badge.svg
+[ci-test-link]: https://github.com/cesium/atomic/actions/workflows/test.yml
+
 # Atomic
 
-To start your Phoenix server:
+> :atom_symbol: De-engineered bifurcated intranet
+
+[![Style CI][ci-style-badge]][ci-style-link]
+[![Test CI][ci-test-badge]][ci-test-link]
+
+## 🤝 Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
 
-  * Install dependencies with `mix deps.get`
-  * Create and migrate your database with `mix ecto.setup`
-  * Start Phoenix endpoint with `mix phx.server` or inside IEx with `iex -S mix phx.server`
+Please note we have a [code of conduct][code_of_conduct], please follow it in all your interactions with the project.
 
-Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
+We have a [contributing guide][contributing] to help you get started.
 
-Ready to run in production? Please [check our deployment guides](https://hexdocs.pm/phoenix/deployment.html).
+## 📝 License
 
-## Learn more
+<img src=".github/brand/cesium-DARK.svg#gh-light-mode-only" width="300">
+<img src=".github/brand/cesium-LIGHT.svg#gh-dark-mode-only" width="300">
 
-  * Official website: https://www.phoenixframework.org/
-  * Guides: https://hexdocs.pm/phoenix/overview.html
-  * Docs: https://hexdocs.pm/phoenix
-  * Forum: https://elixirforum.com/c/phoenix-forum
-  * Source: https://github.com/phoenixframework/phoenix
+Copyright (c) 2023 CeSIUM - Centro de Estudantes de Eng. Informática
 
+This project is licensed under the MIT License - see the [LICENSE][license]
+file for details.

lib/atomic/accounts.ex

@@ -24,6 +24,22 @@ defmodule Atomic.Accounts do
     Repo.get_by(User, email: email)
   end
 
+  @doc """
+  Gets a user by handle.
+
+  ## Examples
+
+      iex> get_user_by_handle("foo_bar")
+      %User{}
+
+      iex> get_user_by_handle("unknown")
+      nil
+
+  """
+  def get_user_by_handle(handle) when is_binary(handle) do
+    Repo.get_by(User, handle: handle)
+  end
+
   @doc """
   Gets a user by email and password.
 
@@ -195,6 +211,19 @@ defmodule Atomic.Accounts do
     User.email_changeset(user, attrs)
   end
 
+  @doc """
+  Returns an `%Ecto.Changeset{}` for changing the user handle.
+
+  ## Examples
+
+      iex> change_user_handle(user)
+      %Ecto.Changeset{data: %User{}}
+
+  """
+  def change_user_handle(user, attrs \\ %{}) do
+    User.handle_changeset(user, attrs)
+  end
+
   @doc """
   Emulates that the email will change without actually changing
   it in the database.

lib/atomic/accounts/user.ex

@@ -9,14 +9,15 @@ defmodule Atomic.Accounts.User do
   alias Atomic.Organizations.{Membership, Organization}
   alias Atomic.Uploaders.ProfilePicture
 
-  @required_fields ~w(email password)a
+  @required_fields ~w(email handle password)a
   @optional_fields ~w(name role confirmed_at course_id default_organization_id)a
 
   @roles ~w(admin student)a
 
   schema "users" do
     field :name, :string
     field :email, :string
+    field :handle, :string
     field :password, :string, virtual: true, redact: true
     field :hashed_password, :string, redact: true
     field :confirmed_at, :naive_datetime
@@ -53,6 +54,7 @@ defmodule Atomic.Accounts.User do
     user
     |> cast(attrs, @required_fields ++ @optional_fields)
     |> validate_email()
+    |> validate_handle()
     |> validate_password(opts)
   end
 
@@ -79,6 +81,20 @@ defmodule Atomic.Accounts.User do
     |> unique_constraint(:email)
   end
 
+  defp validate_handle(changeset) do
+    changeset
+    |> validate_required([:handle])
+    |> validate_format(:handle, ~r/^[a-zA-Z0-9_.]+$/,
+      message:
+        Gettext.gettext(
+          "must only contain alphanumeric characters, numbers, underscores and periods"
+        )
+    )
+    |> validate_length(:handle, min: 3, max: 30)
+    |> unsafe_validate_unique(:handle, Atomic.Repo)
+    |> unique_constraint(:handle)
+  end
+
   defp validate_password(changeset, opts) do
     changeset
     |> validate_required([:password])
@@ -119,6 +135,21 @@ defmodule Atomic.Accounts.User do
     end
   end
 
+  @doc """
+  A user changeset for changing the handle.
+
+  It requires the handle to change otherwise an error is added.
+  """
+  def handle_changeset(user, attrs) do
+    user
+    |> cast(attrs, [:handle])
+    |> validate_handle()
+    |> case do
+      %{changes: %{handle: _}} = changeset -> changeset
+      %{} = changeset -> add_error(changeset, :handle, "did not change")
+    end
+  end
+
   @doc """
   A user changeset for changing the password.
 

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

@@ -30,7 +30,11 @@
               <%= for membership <- @memberships do %>
                 <tr>
                   <td class="whitespace-nowrap py-4 pl-4 pr-3 text-sm font-medium text-gray-900 sm:pl-6"><%= membership.number %></td>
-                  <td class="whitespace-nowrap px-3 py-4 text-sm text-gray-500"><%= membership.user.name %></td>
+                  <td class="whitespace-nowrap px-3 py-4 text-sm text-gray-500">
+                    <%= live_redirect to: Routes.user_show_path(@socket, :show, membership.user.handle) do %>
+                      <%= membership.user.name %>
+                    <% end %>
+                  </td>
                   <td class="whitespace-nowrap px-3 py-4 text-sm text-gray-500"><%= membership.user.email %></td>
                   <td class="whitespace-nowrap px-3 py-4 text-sm text-gray-500">Phone number</td>
                   <td class="whitespace-nowrap px-3 py-4 text-sm text-gray-500"><%= display_date(membership.inserted_at) %> <%= display_time(membership.inserted_at) %></td>

lib/atomic_web/live/user_live/show.ex

@@ -0,0 +1,36 @@
+defmodule AtomicWeb.UserLive.Show do
+  use AtomicWeb, :live_view
+
+  alias Atomic.Accounts
+
+  @impl true
+  def mount(_params, _session, socket) do
+    {:ok, socket}
+  end
+
+  @impl true
+  def handle_params(%{"handle" => user_handle}, _, socket) do
+    user = Accounts.get_user_by_handle(user_handle)
+
+    is_current_user =
+      Map.has_key?(socket.assigns, :current_user) and socket.assigns.current_user.id == user.id
+
+    organizations = Accounts.get_user_organizations(user)
+
+    entries = [
+      %{
+        name: gettext("%{name}", name: user.name),
+        route: Routes.user_show_path(socket, :show, user_handle)
+      }
+    ]
+
+    {:noreply,
+     socket
+     |> assign(:page_title, user.name)
+     |> assign(:current_page, :profile)
+     |> assign(:breadcrumb_entries, entries)
+     |> assign(:user, user)
+     |> assign(:organizations, organizations)
+     |> assign(:is_current_user, is_current_user)}
+  end
+end