cafkafk/seidr
cafkafk/seidr
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

test(git): fixed doc tests for git.rs

Browse source 
Adding git to the library file makes the doctests run.

Turns out they were very broken.

This commit sets us up for a refactor, with setter and getters.

Signed-off-by: Christina Sørensen <christina@cafkafk.com>
This commit is contained in:
Christina Sørensen 2023-07-07 06:37:09 +02:00
parent c9b00adb57
commit 1768cd93a8
Signed by: cafkafk
GPG key ID: CDDC792F655251ED
1 changed files with 16 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
src/git.rs
View file

@ -108,9 +108,9 @@ pub struct GitRepo {
/// Represents a single operation on a repository /// Represents a single operation on a repository
pub struct SeriesItem<'series> { pub struct SeriesItem<'series> {
/// The string to be displayed to the user /// The string to be displayed to the user
operation: &'series str, pub operation: &'series str,
/// The closure representing the actual operation /// The closure representing the actual operation
closure: Box<dyn Fn(&GitRepo) -> (bool)>, pub closure: Box<dyn Fn(&GitRepo) -> (bool)>,
} }
//////////////////////////////////// ////////////////////////////////////
@ -171,7 +171,7 @@ impl Link {
impl GitRepo { impl GitRepo {
/// Clones the repository to its specified folder. /// Clones the repository to its specified folder.
fn clone(&self) -> bool { pub fn clone(&self) -> bool {
if self if self
.flags .flags
.as_ref() .as_ref()
@ -193,7 +193,7 @@ impl GitRepo {
} }
} }
/// Pulls the repository if able. /// Pulls the repository if able.
fn pull(&self) -> bool { pub fn pull(&self) -> bool {
if self if self
.flags .flags
.as_ref() .as_ref()
@ -213,7 +213,7 @@ impl GitRepo {
} }
} }
/// Adds all files in the repository. /// Adds all files in the repository.
fn add_all(&self) -> bool { pub fn add_all(&self) -> bool {
if self if self
.flags .flags
.as_ref() .as_ref()
@ -241,7 +241,7 @@ impl GitRepo {
/// use status() instead of output(), as that makes using the native editor /// use status() instead of output(), as that makes using the native editor
/// easy /// easy
#[allow(dead_code)] #[allow(dead_code)]
fn commit(&self) -> bool { pub fn commit(&self) -> bool {
if self if self
.flags .flags
.as_ref() .as_ref()
@ -261,7 +261,7 @@ impl GitRepo {
} }
} }
/// Tries to commit changes with a message argument. /// Tries to commit changes with a message argument.
fn commit_with_msg(&self, msg: &str) -> bool { pub fn commit_with_msg(&self, msg: &str) -> bool {
if self if self
.flags .flags
.as_ref() .as_ref()
@ -283,7 +283,7 @@ impl GitRepo {
} }
} }
/// Attempts to push the repository. /// Attempts to push the repository.
fn push(&self) -> bool { pub fn push(&self) -> bool {
if self if self
.flags .flags
.as_ref() .as_ref()
@ -445,6 +445,9 @@ impl Config {
/// Here is an example of how an associated method could use this function. /// Here is an example of how an associated method could use this function.
/// ///
/// ``` /// ```
/// use gg::git::SeriesItem;
/// use gg::git::GitRepo;
///
/// let series: Vec<SeriesItem> = vec![ /// let series: Vec<SeriesItem> = vec![
/// SeriesItem { /// SeriesItem {
/// operation: "pull", /// operation: "pull",
@ -463,7 +466,7 @@ impl Config {
/// closure: Box::new(move |repo: &GitRepo| repo.push()), /// closure: Box::new(move |repo: &GitRepo| repo.push()),
/// }, /// },
/// ]; /// ];
/// self.series_on_all(series); /// // e.g. use self.series_on_all(series);
/// ``` /// ```
pub fn series_on_all(&self, closures: Vec<SeriesItem>) { pub fn series_on_all(&self, closures: Vec<SeriesItem>) {
for category in self.categories.values() { for category in self.categories.values() {
@ -496,6 +499,9 @@ impl Config {
/// Here is an example of how an associated method could use this function. /// Here is an example of how an associated method could use this function.
/// ///
/// ``` /// ```
/// use gg::git::GitRepo;
/// use gg::git::SeriesItem;
///
/// let series: Vec<SeriesItem> = vec![ /// let series: Vec<SeriesItem> = vec![
/// SeriesItem { /// SeriesItem {
/// operation: "pull", /// operation: "pull",
@ -514,7 +520,7 @@ impl Config {
/// closure: Box::new(move |repo: &GitRepo| repo.push()), /// closure: Box::new(move |repo: &GitRepo| repo.push()),
/// }, /// },
/// ]; /// ];
/// self.all_on_all(series); /// // self.all_on_all(series);
/// ``` /// ```
pub fn all_on_all(&self, closures: Vec<SeriesItem>) { pub fn all_on_all(&self, closures: Vec<SeriesItem>) {
for category in self.categories.values() { for category in self.categories.values() {