JavaScript is disabled, refresh for a better experience. ambee/giterated

ambee/giterated

Git repository hosting, collaboration, and discovery for the Fediverse.

Incomplete repository branches request

View files Patch

erremilia - ⁨2⁩ years ago

parent: tbd commit: ⁨6872fbf⁩

⁨giterated-models/src/repository/mod.rs⁩ - ⁨13513⁩ bytes
Raw
1 use std::fmt::{Display, Formatter};
2 use std::str::FromStr;
3
4 use serde::{Deserialize, Serialize};
5
6 use crate::object::GiteratedObject;
7
8 use super::{instance::Instance, user::User};
9
10 mod operations;
11 mod settings;
12 mod values;
13
14 pub use operations::*;
15 pub use settings::*;
16 pub use values::*;
17
18 /// A repository, defined by the instance it exists on along with
19 /// its owner and name.
20 ///
21 /// # Textual Format
22 /// A repository's textual reference is defined as:
23 ///
24 /// `{owner: User}/{name: String}@{instance: Instance}`
25 ///
26 /// # Examples
27 /// For the repository named `foo` owned by `barson:giterated.dev` on the instance
28 /// `giterated.dev`, the following [`Repository`] initialization would
29 /// be valid:
30 ///
31 /// ```
32 //# use giterated_models::model::repository::Repository;
33 //# use giterated_models::model::instance::Instance;
34 //# use giterated_models::model::user::User;
35 /// let repository = Repository {
36 /// owner: User::from_str("barson:giterated.dev").unwrap(),
37 /// name: String::from("foo"),
38 /// instance: Instance::from_str("giterated.dev").unwrap()
39 /// };
40 ///
41 /// // This is correct
42 /// assert_eq!(Repository::from_str("barson:giterated.dev/[email protected]").unwrap(), repository);
43 /// ```
44 #[derive(Hash, Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
45 pub struct Repository {
46 pub owner: User,
47 pub name: String,
48 /// Instance the repository is on
49 pub instance: Instance,
50 }
51
52 impl Display for Repository {
53 fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
54 f.write_str(&format!("{}/{}@{}", self.owner, self.name, self.instance))
55 }
56 }
57
58 impl GiteratedObject for Repository {
59 fn object_name() -> &'static str {
60 "repository"
61 }
62
63 fn from_object_str(object_str: &str) -> Result<Self, anyhow::Error> {
64 Ok(Repository::from_str(object_str)?)
65 }
66 }
67
68 impl TryFrom<String> for Repository {
69 type Error = RepositoryParseError;
70
71 fn try_from(value: String) -> Result<Self, Self::Error> {
72 Self::from_str(&value)
73 }
74 }
75
76 impl FromStr for Repository {
77 type Err = RepositoryParseError;
78
79 fn from_str(s: &str) -> Result<Self, Self::Err> {
80 let mut by_ampersand = s.split('@');
81 let mut path_split = by_ampersand.next().ok_or(RepositoryParseError)?.split('/');
82
83 let instance = Instance::from_str(by_ampersand.next().ok_or(RepositoryParseError)?)
84 .map_err(|_| RepositoryParseError)?;
85 let owner = User::from_str(path_split.next().ok_or(RepositoryParseError)?)
86 .map_err(|_| RepositoryParseError)?;
87 let name = path_split.next().ok_or(RepositoryParseError)?.to_string();
88
89 Ok(Self {
90 instance,
91 owner,
92 name,
93 })
94 }
95 }
96
97 #[derive(Debug, thiserror::Error)]
98 #[error("no parse!")]
99 pub struct RepositoryParseError;
100
101 /// Visibility of the repository to the general eye
102 #[derive(PartialEq, Eq, Debug, Hash, Serialize, Deserialize, Clone, sqlx::Type)]
103 #[sqlx(type_name = "visibility", rename_all = "lowercase")]
104 pub enum RepositoryVisibility {
105 Public,
106 Unlisted,
107 Private,
108 }
109
110 /// Implements [`Display`] for [`RepositoryVisiblity`] using [`Debug`]
111 impl Display for RepositoryVisibility {
112 fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
113 write!(f, "{:?}", self)
114 }
115 }
116
117 #[derive(Clone, Debug, Serialize, Deserialize)]
118 pub struct RepositoryView {
119 /// Name of the repository
120 ///
121 /// This is different than the [`Repository`] name,
122 /// which may be a path.
123 pub name: String,
124 /// Owner of the Repository
125 pub owner: User,
126 /// Repository description
127 pub description: Option<Description>,
128 /// Repository visibility
129 pub visibility: Visibility,
130 /// Default branch of the repository
131 pub default_branch: DefaultBranch,
132 /// Last commit made to the repository
133 pub latest_commit: Option<LatestCommit>,
134 /// Repository statistics
135 pub stats: RepositoryStatistics,
136 /// Revision of the displayed tree
137 pub tree_rev: Option<String>,
138 /// Repository tree
139 pub tree: Vec<RepositoryTreeEntry>,
140 }
141
142 /// Generic repository statistics
143 #[derive(Clone, Debug, Serialize, Deserialize)]
144 pub struct RepositoryStatistics {
145 /// Amount of commits made to this branch in the repository
146 pub commits: usize,
147 /// Amount of branches the repository has
148 pub branches: usize,
149 /// Amount of tags the repository has
150 pub tags: usize,
151 }
152
153 /// Repository branch
154 #[derive(Clone, Debug, Serialize, Deserialize)]
155 pub struct RepositoryBranch {
156 /// Full reference name
157 pub name: String,
158 }
159
160 #[derive(Clone, Debug, Serialize, Deserialize)]
161 pub struct RepositoryFile {
162 /// ID of the file
163 pub id: String,
164 /// Content of the file
165 pub content: Vec<u8>,
166 /// If the file is binary or not
167 pub binary: bool,
168 /// File size in bytes
169 pub size: usize,
170 }
171
172 #[derive(Clone, Debug, Serialize, Deserialize)]
173 pub struct RepositoryDiff {
174 /// "to" side of the diff commit
175 pub new_commit: Commit,
176 /// Total number of files changed
177 pub files_changed: usize,
178 /// Total number of insertions
179 pub insertions: usize,
180 /// Total number of deletions
181 pub deletions: usize,
182 /// List of changed files
183 pub files: Vec<RepositoryDiffFile>,
184 }
185
186 /// Represents the type of change made to a [`RepositoryDiffFile`]
187 #[derive(Clone, Debug, Serialize, Deserialize)]
188 pub enum RepositoryDiffFileStatus {
189 /// No changes
190 Unmodified,
191 Added,
192 Deleted,
193 /// Content changed between old and new
194 Modified,
195 /// Renamed between old and new
196 Renamed,
197 /// Copied from another old entry
198 Copied,
199 /// Ignored item in workdir
200 Ignored,
201 /// Untracked item in workdir
202 Untracked,
203 /// Type of file changed between old and new
204 Typechange,
205 /// File is unreadable
206 Unreadable,
207 /// File in the index is conflicted
208 Conflicted,
209 }
210
211 impl From<git2::Delta> for RepositoryDiffFileStatus {
212 fn from(status: git2::Delta) -> Self {
213 match status {
214 git2::Delta::Unmodified => Self::Unmodified,
215 git2::Delta::Added => Self::Added,
216 git2::Delta::Deleted => Self::Deleted,
217 git2::Delta::Modified => Self::Modified,
218 git2::Delta::Renamed => Self::Renamed,
219 git2::Delta::Copied => Self::Copied,
220 git2::Delta::Ignored => Self::Ignored,
221 git2::Delta::Untracked => Self::Untracked,
222 git2::Delta::Typechange => Self::Typechange,
223 git2::Delta::Unreadable => Self::Unreadable,
224 git2::Delta::Conflicted => Self::Conflicted,
225 }
226 }
227 }
228
229 /// Represents a single file of a diff
230 #[derive(Clone, Debug, Serialize, Deserialize)]
231 pub struct RepositoryDiffFile {
232 /// The type of change made to this file
233 pub status: RepositoryDiffFileStatus,
234 /// "From" side of the diff, can be nonexistent if file for example got added for the first time
235 pub old_file_info: Option<RepositoryDiffFileInfo>,
236 /// "To" side of the diff, can be nonexistent if file got removed
237 pub new_file_info: Option<RepositoryDiffFileInfo>,
238 /// Individual chunks of changes in this file
239 pub chunks: Vec<RepositoryDiffFileChunk>,
240 }
241
242 /// Represents one side of a file diff [`RepositoryDiffFile`]
243 #[derive(Clone, Debug, Serialize, Deserialize)]
244 pub struct RepositoryDiffFileInfo {
245 /// ID of the file
246 pub id: String,
247 /// Path of the entry relative to the working directory of the repository
248 pub path: String,
249 /// Size in bytes
250 pub size: u64,
251 /// If the file is binary or not
252 pub binary: bool,
253 }
254
255 /// Represents a single chunk of a file diff [`RepositoryDiffFile`]
256 #[derive(Clone, Debug, Serialize, Deserialize)]
257 pub struct RepositoryDiffFileChunk {
258 /// Header of the chunk
259 pub header: Option<String>,
260 /// Starting line number of the old file
261 pub old_start: u32,
262 /// Number of lines in "from" side of this chunk
263 pub old_lines: u32,
264 /// Starting line number of the new file
265 pub new_start: u32,
266 /// Number of lines in "to" side of this chunk
267 pub new_lines: u32,
268 /// Lines of the chunk
269 pub lines: Vec<RepositoryChunkLine>,
270 }
271
272 /// Represents the change type of the [`RepositoryChunkLine`], incomplete of what git actually provides.
273 #[derive(Clone, Debug, Serialize, Deserialize)]
274 pub enum RepositoryChunkLineType {
275 Context,
276 Addition,
277 Deletion,
278 }
279
280 impl From<git2::DiffLineType> for RepositoryChunkLineType {
281 fn from(line_type: git2::DiffLineType) -> Self {
282 match line_type {
283 git2::DiffLineType::Context => Self::Context,
284 git2::DiffLineType::Addition => Self::Addition,
285 git2::DiffLineType::Deletion => Self::Deletion,
286 _ => Self::Context,
287 }
288 }
289 }
290
291 /// Represents a single line of a [`RepositoryDiffFileChunk`]
292 #[derive(Clone, Debug, Serialize, Deserialize)]
293 pub struct RepositoryChunkLine {
294 /// Type of change the line is
295 pub change_type: RepositoryChunkLineType,
296 /// Content of the line
297 pub content: String,
298 /// Line number in old file
299 pub old_line_num: Option<u32>,
300 /// Line number in new file
301 pub new_line_num: Option<u32>,
302 }
303
304 #[derive(Debug, Clone, Serialize, Deserialize)]
305 pub enum RepositoryObjectType {
306 Tree,
307 Blob,
308 }
309
310 /// Stored info for our tree entries
311 #[derive(Debug, Clone, Serialize, Deserialize)]
312 pub struct RepositoryTreeEntry {
313 /// ID of the tree/blob
314 pub id: String,
315 /// Name of the tree/blob
316 pub name: String,
317 /// Type of the tree entry
318 pub object_type: RepositoryObjectType,
319 /// Git supplies us with the mode at all times, and people like it displayed.
320 pub mode: i32,
321 /// File size
322 pub size: Option<usize>,
323 /// Last commit made to the tree/blob
324 pub last_commit: Option<Commit>,
325 }
326
327 impl RepositoryTreeEntry {
328 // I love you Emilia <3
329 pub fn new(id: &str, name: &str, object_type: RepositoryObjectType, mode: i32) -> Self {
330 Self {
331 id: id.to_string(),
332 name: name.to_string(),
333 object_type,
334 mode,
335 size: None,
336 last_commit: None,
337 }
338 }
339 }
340
341 #[derive(Debug, Clone, Serialize, Deserialize)]
342 pub struct RepositoryTreeEntryWithCommit {
343 pub tree_entry: RepositoryTreeEntry,
344 pub commit: Commit,
345 }
346
347 /// Info about a git commit
348 #[derive(PartialEq, Hash, Eq, Debug, Clone, Serialize, Deserialize)]
349 pub struct Commit {
350 /// Unique commit ID
351 pub oid: String,
352 /// Shortened abbreviated OID
353 /// This starts at the git config's "core.abbrev" length (default 7 characters) and
354 /// iteratively extends to a longer string if that length is ambiguous. The
355 /// result will be unambiguous (at least until new objects are added to the repository).
356 pub short_oid: String,
357 /// First paragraph of the full message
358 pub summary: Option<String>,
359 /// Everything in the full message apart from the first paragraph
360 pub body: Option<String>,
361 /// All commit id's of the parents of this commit
362 pub parents: Vec<String>,
363 /// Who created the commit
364 pub author: CommitSignature,
365 /// Who committed the commit
366 pub committer: CommitSignature,
367 /// Time when the commit happened
368 pub time: chrono::NaiveDateTime,
369 }
370
371 /// Gets all info from [`git2::Commit`] for easy use
372 impl From<git2::Commit<'_>> for Commit {
373 fn from(commit: git2::Commit<'_>) -> Self {
374 Self {
375 oid: commit.id().to_string(),
376 // This shouldn't ever fail, as we already know the object has an oid.
377 short_oid: commit
378 .as_object()
379 .short_id()
380 .unwrap()
381 .as_str()
382 .unwrap()
383 .to_string(),
384 summary: commit.summary().map(|summary| summary.to_string()),
385 body: commit.body().map(|body| body.to_string()),
386 parents: commit
387 .parents()
388 .map(|parent| parent.id().to_string())
389 .collect::<Vec<String>>(),
390 author: commit.author().into(),
391 committer: commit.committer().into(),
392 time: chrono::NaiveDateTime::from_timestamp_opt(commit.time().seconds(), 0).unwrap(),
393 }
394 }
395 }
396
397 /// Git commit signature
398 #[derive(PartialEq, Hash, Eq, Debug, Clone, Serialize, Deserialize)]
399 pub struct CommitSignature {
400 pub name: Option<String>,
401 pub email: Option<String>,
402 pub time: chrono::NaiveDateTime,
403 }
404
405 /// Converts the signature from git2 into something usable without explicit lifetimes.
406 impl From<git2::Signature<'_>> for CommitSignature {
407 fn from(signature: git2::Signature<'_>) -> Self {
408 Self {
409 name: signature.name().map(|name| name.to_string()),
410 email: signature.email().map(|email| email.to_string()),
411 time: chrono::NaiveDateTime::from_timestamp_opt(signature.when().seconds(), 0).unwrap(),
412 }
413 }
414 }
415
416 #[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
417 pub struct RepositorySummary {
418 pub repository: Repository,
419 pub owner: User,
420 pub visibility: RepositoryVisibility,
421 pub description: Option<String>,
422 pub last_commit: Option<Commit>,
423 }
424
425 #[derive(Clone, Debug, Serialize, Deserialize)]
426 pub struct IssueLabel {
427 pub name: String,
428 pub color: String,
429 }
430
431 #[derive(Clone, Debug, Serialize, Deserialize)]
432 pub struct RepositoryIssue {
433 pub author: User,
434 pub id: u64,
435 pub title: String,
436 pub contents: String,
437 pub labels: Vec<IssueLabel>,
438 }
439