Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Look for a registry in the current directory if one is not provided #17

Merged
merged 1 commit into from
May 22, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Look for a registry in the current directory if one is not provided
Clippy started complaining that the `Error` type was too big, so this
commit also starts boxing some of the errors.
  • Loading branch information
shepmaster committed May 22, 2024
commit 966ef4fc9bfec8e23717f7a2f64725b6ce4382df
106 changes: 88 additions & 18 deletions src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ use serde::{Deserialize, Serialize};
use snafu::prelude::*;
use std::{
collections::{BTreeMap, BTreeSet},
fmt,
env, fmt,
fs::{self, File},
io::{self, BufRead, BufReader, BufWriter, Read, Write},
path::{Component, Path, PathBuf},
Expand Down Expand Up @@ -69,7 +69,7 @@ struct InitArgs {
struct AddArgs {
/// path to the registry to modify
#[argh(option)]
registry: PathBuf,
registry: Option<PathBuf>,

#[argh(positional)]
path: PathBuf,
Expand All @@ -82,7 +82,7 @@ struct AddArgs {
struct RemoveArgs {
/// path to the registry to modify
#[argh(option)]
registry: PathBuf,
registry: Option<PathBuf>,

// FUTURE: Allow removing all versions at once?
/// the version of the crate
Expand All @@ -100,7 +100,7 @@ struct RemoveArgs {
struct GenerateHtmlArgs {
/// path to the registry to modify
#[argh(option)]
registry: PathBuf,
registry: Option<PathBuf>,
}

/// Yank a version of a crate from the registry
Expand All @@ -110,7 +110,7 @@ struct GenerateHtmlArgs {
struct YankArgs {
/// path to the registry to modify
#[argh(option)]
registry: PathBuf,
registry: Option<PathBuf>,

/// undo a previous yank
#[argh(switch)]
Expand All @@ -132,7 +132,7 @@ struct YankArgs {
struct ListArgs {
/// path to the registry to list
#[argh(option)]
registry: PathBuf,
registry: Option<PathBuf>,
}

#[snafu::report]
Expand All @@ -158,25 +158,46 @@ fn main() -> Result<(), Error> {
enum Error {
#[snafu(display("Could not initialize global variables"))]
#[snafu(context(false))]
Global { source: GlobalError },
Global {
#[snafu(source(from(GlobalError, Box::new)))]
source: Box<GlobalError>,
},

#[snafu(transparent)]
Initialize { source: DoInitializeError },
Initialize {
#[snafu(source(from(DoInitializeError, Box::new)))]
source: Box<DoInitializeError>,
},

#[snafu(transparent)]
Open { source: OpenError },
Open {
#[snafu(source(from(DiscoverRegistryError, Box::new)))]
source: Box<DiscoverRegistryError>,
},

#[snafu(transparent)]
Add { source: AddError },
Add {
#[snafu(source(from(AddError, Box::new)))]
source: Box<AddError>,
},

#[snafu(transparent)]
Remove { source: RemoveError },
Remove {
#[snafu(source(from(RemoveError, Box::new)))]
source: Box<RemoveError>,
},

#[snafu(transparent)]
Html { source: HtmlError },
Html {
#[snafu(source(from(HtmlError, Box::new)))]
source: Box<HtmlError>,
},

#[snafu(transparent)]
Yank { source: YankError },
Yank {
#[snafu(source(from(YankError, Box::new)))]
source: Box<YankError>,
},
}

trait UnwrapOrDialog<T> {
Expand Down Expand Up @@ -306,7 +327,7 @@ enum DoInitializeError {
}

fn do_add(global: &Global, add: AddArgs) -> Result<(), Error> {
let r = Registry::open(&add.registry)?;
let r = discover_registry(add.registry)?;

r.add(global, &add.path)?;
r.maybe_generate_html()?;
Expand All @@ -315,7 +336,7 @@ fn do_add(global: &Global, add: AddArgs) -> Result<(), Error> {
}

fn do_remove(_global: &Global, rm: RemoveArgs) -> Result<(), Error> {
let r = Registry::open(&rm.registry)?;
let r = discover_registry(rm.registry)?;

r.remove(rm.name, rm.version)?;
r.maybe_generate_html()?;
Expand All @@ -324,13 +345,13 @@ fn do_remove(_global: &Global, rm: RemoveArgs) -> Result<(), Error> {
}

fn do_generate_html(_global: &Global, html: GenerateHtmlArgs) -> Result<(), Error> {
let r = Registry::open(html.registry)?;
let r = discover_registry(html.registry)?;
r.generate_html()?;
Ok(())
}

fn do_yank(_global: &Global, yank: YankArgs) -> Result<(), Error> {
let r = Registry::open(yank.registry)?;
let r = discover_registry(yank.registry)?;

r.yank(yank.name, yank.version, !yank.undo)?;
r.maybe_generate_html()?;
Expand All @@ -339,7 +360,7 @@ fn do_yank(_global: &Global, yank: YankArgs) -> Result<(), Error> {
}

fn do_list(_global: &Global, list: ListArgs) -> Result<(), Error> {
let r = Registry::open(list.registry)?;
let r = discover_registry(list.registry)?;

let crates = r.list_all().unwrap();

Expand Down Expand Up @@ -384,6 +405,46 @@ fn do_list(_global: &Global, list: ListArgs) -> Result<(), Error> {
Ok(())
}

fn discover_registry(path: Option<PathBuf>) -> Result<Registry, DiscoverRegistryError> {
use discover_registry_error::*;

match path {
Some(p) => Registry::open(p).context(OpenSnafu),
None => {
let cwd = env::current_dir().context(CurrentDirSnafu)?;

match Registry::open(cwd) {
Ok(r) => Ok(r),
Err(e) if e.is_not_found() => FallbackNotFoundSnafu.fail(),
Err(e) => Err(e).context(FallbackOpenSnafu)?,
}
}
}
}

#[derive(Debug, Snafu)]
#[snafu(module)]
enum DiscoverRegistryError {
#[snafu(display("Could not open the specified registry"))]
Open { source: OpenError },

#[snafu(display("Could not determine the current directory, {}", Self::TRY_THIS))]
CurrentDir { source: io::Error },

#[snafu(display(
"The current directory does not contain a registry, {}",
Self::TRY_THIS,
))]
FallbackNotFound,

#[snafu(display("Could not open the registry in the current directory"))]
FallbackOpen { source: OpenError },
}

impl DiscoverRegistryError {
const TRY_THIS: &'static str = "please use the `--registry` command line option";
}

#[derive(Debug)]
struct Registry {
path: PathBuf,
Expand Down Expand Up @@ -727,6 +788,15 @@ enum OpenError {
},
}

impl OpenError {
fn is_not_found(&self) -> bool {
match self {
Self::Read { source, .. } => source.kind() == io::ErrorKind::NotFound,
Self::Deserialize { .. } => false,
}
}
}

#[derive(Debug, Snafu)]
#[snafu(module)]
enum AddError {
Expand Down