source.rs

// Copyright (c) The Amphitheatre Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use utoipa::ToSchema;

/// Your characters can depend on other partners from other registries,
/// git repositories, or subdirectories on your local file system.
#[derive(Clone, Debug, Default, Deserialize, Serialize, JsonSchema, Eq, Hash, PartialEq, ToSchema)]
pub struct GitReference {
    /// Source code repository the partner should be cloned from.
    /// e.g. https://github.com/amphitheatre-app/amphitheatre.git.
    pub repo: String,
    /// Git branch the partner should be cloned from. eg. master or main
    #[serde(skip_serializing_if = "Option::is_none")]
    pub branch: Option<String>,
    /// Git tag the partner should be cloned from. eg. v1.0
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tag: Option<String>,
    /// A commit hash like rev = "4c59b707", or a named reference exposed by
    /// the remote repository such as rev = "refs/pull/493/head". What references
    /// are available varies by where the repo is hosted.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub rev: Option<String>,
    /// Relative path from the repo root to the configuration file.
    /// eg. getting-started/.amp.toml. default is `.amp.toml`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub path: Option<String>,
}

impl GitReference {
    pub fn new(repo: String) -> Self {
        Self {
            repo,
            ..Default::default()
        }
    }

    /// The Uniform Resource Identifier of this Source.
    #[inline]
    pub fn uri(&self) -> String {
        let mut url = self.repo.clone();
        let reference = self.reference();

        if reference.is_some() || self.path.is_some() {
            url.push('#');
        }

        if let Some(reference) = reference {
            url.push_str(reference.as_str());
        }

        if let Some(path) = &self.path {
            url.push(':');
            url.push_str(path.as_str());
        }

        url
    }

    pub fn reference(&self) -> Option<String> {
        if self.branch.is_some() {
            return self.branch.to_owned();
        }

        if self.tag.is_some() {
            return self.tag.to_owned();
        }

        self.rev.to_owned()
    }

    pub fn rev(&self) -> String {
        self.rev.clone().unwrap_or("Unknown-Revision-Hash".to_string())
    }
}