SCM-Manager/scm-ui/ui-components/src/repos/changesets/ChangesetAuthor.tsx

/*
 * MIT License
 *
 * Copyright (c) 2020-present Cloudogu GmbH and Contributors
 *
 * 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.
 */
import React, { FC } from "react";
import { Changeset, Person } from "@scm-manager/ui-types";
import { useTranslation } from "react-i18next";
import { useBinder } from "@scm-manager/ui-extensions";
import { EXTENSION_POINT } from "../../avatar/Avatar";
import styled from "styled-components";
import CommaSeparatedList from "../../CommaSeparatedList";
import ContributorAvatar from "./ContributorAvatar";

type Props = {
  changeset: Changeset;
};

type PersonProps = {
  person: Person;
  className?: string;
  displayTextOnly?: boolean;
};

const useAvatar = (person: Person): string | undefined => {
  const binder = useBinder();
  const factory: (person: Person) => string | undefined = binder.getExtension(EXTENSION_POINT);
  if (factory) {
    return factory(person);
  }
};

const AvatarList = styled.span`
  & > :not(:last-child) {
    margin-right: 0.25em;
  }
`;

type PersonAvatarProps = {
  person: Person;
  avatar: string;
};

const ContributorWithAvatar: FC<PersonAvatarProps> = ({ person, avatar }) => {
  const [t] = useTranslation("repos");
  if (person.mail) {
    return (
      <a href={"mailto:" + person.mail} title={t("changeset.contributors.mailto") + " " + person.mail}>
        <ContributorAvatar src={avatar} alt={person.name} />
      </a>
    );
  }
  return <ContributorAvatar src={avatar} alt={person.name} title={person.name} />;
};

export const SingleContributor: FC<PersonProps> = ({ person, className, displayTextOnly }) => {
  const [t] = useTranslation("repos");
  const avatar = useAvatar(person);
  if (!displayTextOnly && avatar) {
    return <ContributorWithAvatar person={person} avatar={avatar} />;
  }
  if (person.mail) {
    return (
      <a
        className={className}
        href={"mailto:" + person.mail}
        title={t("changeset.contributors.mailto") + " " + person.mail}
      >
        {person.name}
      </a>
    );
  }
  return <span className={className}>{person.name}</span>;
};

type PersonsProps = {
  persons: ReadonlyArray<Person>;
  label: string;
  displayTextOnly?: boolean;
};

const Contributors: FC<PersonsProps> = ({ persons, label, displayTextOnly }) => {
  const binder = useBinder();

  const [t] = useTranslation("repos");
  if (persons.length === 1) {
    return (
      <>
        {t(label)} <SingleContributor person={persons[0]} displayTextOnly={displayTextOnly} />
      </>
    );
  }

  const avatarFactory = binder.getExtension(EXTENSION_POINT);
  if (avatarFactory) {
    return (
      <>
        {t(label)}{" "}
        <AvatarList>
          {persons.map(p => (
            <ContributorWithAvatar key={p.name} person={p} avatar={avatarFactory(p)} />
          ))}
        </AvatarList>
      </>
    );
  } else {
    return (
      <>
        {t(label)}{" "}
        <a title={persons.map(person => "- " + person.name).join("\n")}>
          {t("changeset.contributors.more", { count: persons.length })}
        </a>
      </>
    );
  }
};

const emptyListOfContributors: ReadonlyArray<Person> = [];

const ChangesetAuthor: FC<Props> = ({ changeset }) => {
  const binder = useBinder();

  const getCoAuthors = () => {
    return filterContributorsByType("Co-authored-by");
  };

  const getCommitters = () => {
    return filterContributorsByType("Committed-by");
  };

  const filterContributorsByType = (type: string) => {
    if (changeset.contributors) {
      return changeset.contributors.filter(p => p.type === type).map(contributor => contributor.person);
    }
    return emptyListOfContributors;
  };

  const authorLine = [];
  if (changeset.author) {
    authorLine.push(
      <Contributors persons={[changeset.author]} label={"changeset.contributors.authoredBy"} displayTextOnly={true} />
    );
  }

  const commiters = getCommitters();
  if (commiters.length > 0) {
    authorLine.push(<Contributors persons={commiters} label={"changeset.contributors.committedBy"} />);
  }

  const coAuthors = getCoAuthors();
  if (coAuthors.length > 0) {
    authorLine.push(<Contributors persons={coAuthors} label={"changeset.contributors.coAuthoredBy"} />);
  }

  // extensions
  const extensions = binder.getExtensions("changesets.author.suffix", { changeset });
  if (extensions) {
    authorLine.push(...extensions);
  }

  return <CommaSeparatedList>{authorLine}</CommaSeparatedList>;
};

export default ChangesetAuthor;