mirror of
https://github.com/cargo-bins/cargo-binstall.git
synced 2025-05-08 13:10:03 +00:00
Split crates and clean up structure of codebase (#294)
Co-authored-by: Jiahao XU <Jiahao_XU@outlook.com>
This commit is contained in:
Félix Saparelli
GitHub
parent
bf700f9012
commit
4b00f5f143
88 changed files with 2989 additions and 1423 deletions
|
|
@ -1,324 +0,0 @@
|
|||
use std::{
|
||||
borrow, cmp,
|
||||
collections::{btree_set, BTreeSet},
|
||||
fs, hash,
|
||||
io::{self, Seek, Write},
|
||||
iter::{IntoIterator, Iterator},
|
||||
path::{Path, PathBuf},
|
||||
};
|
||||
|
||||
use compact_str::CompactString;
|
||||
use miette::Diagnostic;
|
||||
use semver::Version;
|
||||
use serde::{Deserialize, Serialize};
|
||||
use thiserror::Error;
|
||||
use url::Url;
|
||||
|
||||
use crate::{cargo_home, cratesio_url, create_if_not_exist, FileLock};
|
||||
|
||||
#[derive(Clone, Debug, Serialize, Deserialize)]
|
||||
pub struct MetaData {
|
||||
pub name: CompactString,
|
||||
pub version_req: CompactString,
|
||||
pub current_version: Version,
|
||||
pub source: Source,
|
||||
pub target: CompactString,
|
||||
pub bins: Vec<CompactString>,
|
||||
|
||||
/// Forwards compatibility. Unknown keys from future versions
|
||||
/// will be stored here and retained when the file is saved.
|
||||
///
|
||||
/// We use an `Vec` here since it is never accessed in Rust.
|
||||
#[serde(flatten, with = "tuple_vec_map")]
|
||||
pub other: Vec<(CompactString, serde_json::Value)>,
|
||||
}
|
||||
|
||||
impl borrow::Borrow<str> for MetaData {
|
||||
fn borrow(&self) -> &str {
|
||||
&self.name
|
||||
}
|
||||
}
|
||||
|
||||
impl PartialEq for MetaData {
|
||||
fn eq(&self, other: &Self) -> bool {
|
||||
self.name == other.name
|
||||
}
|
||||
}
|
||||
impl Eq for MetaData {}
|
||||
|
||||
impl PartialOrd for MetaData {
|
||||
fn partial_cmp(&self, other: &Self) -> Option<cmp::Ordering> {
|
||||
self.name.partial_cmp(&other.name)
|
||||
}
|
||||
}
|
||||
|
||||
impl Ord for MetaData {
|
||||
fn cmp(&self, other: &Self) -> cmp::Ordering {
|
||||
self.name.cmp(&other.name)
|
||||
}
|
||||
}
|
||||
|
||||
impl hash::Hash for MetaData {
|
||||
fn hash<H>(&self, state: &mut H)
|
||||
where
|
||||
H: hash::Hasher,
|
||||
{
|
||||
self.name.hash(state)
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Copy, Clone, Serialize, Deserialize)]
|
||||
pub enum SourceType {
|
||||
Git,
|
||||
Path,
|
||||
Registry,
|
||||
}
|
||||
|
||||
#[derive(Clone, Debug, Serialize, Deserialize)]
|
||||
pub struct Source {
|
||||
pub source_type: SourceType,
|
||||
pub url: Url,
|
||||
}
|
||||
|
||||
impl Source {
|
||||
pub fn cratesio_registry() -> Source {
|
||||
Self {
|
||||
source_type: SourceType::Registry,
|
||||
url: cratesio_url().clone(),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Diagnostic, Error)]
|
||||
pub enum Error {
|
||||
#[error(transparent)]
|
||||
Io(#[from] io::Error),
|
||||
|
||||
#[error(transparent)]
|
||||
SerdeJsonParse(#[from] serde_json::Error),
|
||||
}
|
||||
|
||||
pub fn append_to_path<Iter>(path: impl AsRef<Path>, iter: Iter) -> Result<(), Error>
|
||||
where
|
||||
Iter: IntoIterator<Item = MetaData>,
|
||||
{
|
||||
let mut file = FileLock::new_exclusive(create_if_not_exist(path.as_ref())?)?;
|
||||
// Move the cursor to EOF
|
||||
file.seek(io::SeekFrom::End(0))?;
|
||||
|
||||
write_to(&mut file, &mut iter.into_iter())
|
||||
}
|
||||
|
||||
pub fn append<Iter>(iter: Iter) -> Result<(), Error>
|
||||
where
|
||||
Iter: IntoIterator<Item = MetaData>,
|
||||
{
|
||||
append_to_path(default_path()?, iter)
|
||||
}
|
||||
|
||||
pub fn write_to(
|
||||
file: &mut FileLock,
|
||||
iter: &mut dyn Iterator<Item = MetaData>,
|
||||
) -> Result<(), Error> {
|
||||
let writer = io::BufWriter::with_capacity(512, file);
|
||||
|
||||
let mut ser = serde_json::Serializer::new(writer);
|
||||
|
||||
for item in iter {
|
||||
item.serialize(&mut ser)?;
|
||||
}
|
||||
|
||||
ser.into_inner().flush()?;
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub fn default_path() -> Result<PathBuf, Error> {
|
||||
let dir = cargo_home()?.join("binstall");
|
||||
|
||||
fs::create_dir_all(&dir)?;
|
||||
|
||||
Ok(dir.join("crates-v1.json"))
|
||||
}
|
||||
|
||||
#[derive(Debug)]
|
||||
pub struct Records {
|
||||
file: FileLock,
|
||||
/// Use BTreeSet to dedup the metadata
|
||||
data: BTreeSet<MetaData>,
|
||||
}
|
||||
|
||||
impl Records {
|
||||
fn load_impl(&mut self) -> Result<(), Error> {
|
||||
let reader = io::BufReader::with_capacity(1024, &mut self.file);
|
||||
let stream_deser = serde_json::Deserializer::from_reader(reader).into_iter();
|
||||
|
||||
for res in stream_deser {
|
||||
let item = res?;
|
||||
|
||||
self.data.replace(item);
|
||||
}
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub fn load_from_path(path: impl AsRef<Path>) -> Result<Self, Error> {
|
||||
let mut this = Self {
|
||||
file: FileLock::new_exclusive(create_if_not_exist(path.as_ref())?)?,
|
||||
data: BTreeSet::default(),
|
||||
};
|
||||
this.load_impl()?;
|
||||
Ok(this)
|
||||
}
|
||||
|
||||
pub fn load() -> Result<Self, Error> {
|
||||
Self::load_from_path(default_path()?)
|
||||
}
|
||||
|
||||
/// **Warning: This will overwrite all existing records!**
|
||||
pub fn overwrite(mut self) -> Result<(), Error> {
|
||||
self.file.rewind()?;
|
||||
write_to(&mut self.file, &mut self.data.into_iter())?;
|
||||
|
||||
let len = self.file.stream_position()?;
|
||||
self.file.set_len(len)?;
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub fn get(&self, value: impl AsRef<str>) -> Option<&MetaData> {
|
||||
self.data.get(value.as_ref())
|
||||
}
|
||||
|
||||
pub fn contains(&self, value: impl AsRef<str>) -> bool {
|
||||
self.data.contains(value.as_ref())
|
||||
}
|
||||
|
||||
/// Adds a value to the set.
|
||||
/// If the set did not have an equal element present, true is returned.
|
||||
/// If the set did have an equal element present, false is returned,
|
||||
/// and the entry is not updated.
|
||||
pub fn insert(&mut self, value: MetaData) -> bool {
|
||||
self.data.insert(value)
|
||||
}
|
||||
|
||||
pub fn replace(&mut self, value: MetaData) -> Option<MetaData> {
|
||||
self.data.replace(value)
|
||||
}
|
||||
|
||||
pub fn remove(&mut self, value: impl AsRef<str>) -> bool {
|
||||
self.data.remove(value.as_ref())
|
||||
}
|
||||
|
||||
pub fn take(&mut self, value: impl AsRef<str>) -> Option<MetaData> {
|
||||
self.data.take(value.as_ref())
|
||||
}
|
||||
|
||||
pub fn len(&self) -> usize {
|
||||
self.data.len()
|
||||
}
|
||||
|
||||
pub fn is_empty(&self) -> bool {
|
||||
self.data.is_empty()
|
||||
}
|
||||
}
|
||||
|
||||
impl<'a> IntoIterator for &'a Records {
|
||||
type Item = &'a MetaData;
|
||||
|
||||
type IntoIter = btree_set::Iter<'a, MetaData>;
|
||||
|
||||
fn into_iter(self) -> Self::IntoIter {
|
||||
self.data.iter()
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod test {
|
||||
use super::*;
|
||||
use crate::target::TARGET;
|
||||
|
||||
use tempfile::NamedTempFile;
|
||||
|
||||
macro_rules! assert_records_eq {
|
||||
($records:expr, $metadata_set:expr) => {
|
||||
assert_eq!($records.len(), $metadata_set.len());
|
||||
for (record, metadata) in $records.into_iter().zip($metadata_set.iter()) {
|
||||
assert_eq!(record, metadata);
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn rw_test() {
|
||||
let target = CompactString::from(TARGET);
|
||||
|
||||
let named_tempfile = NamedTempFile::new().unwrap();
|
||||
let path = named_tempfile.path();
|
||||
|
||||
let metadata_vec = [
|
||||
MetaData {
|
||||
name: "a".into(),
|
||||
version_req: "*".into(),
|
||||
current_version: Version::new(0, 1, 0),
|
||||
source: Source::cratesio_registry(),
|
||||
target: target.clone(),
|
||||
bins: vec!["1".into(), "2".into()],
|
||||
other: Default::default(),
|
||||
},
|
||||
MetaData {
|
||||
name: "b".into(),
|
||||
version_req: "0.1.0".into(),
|
||||
current_version: Version::new(0, 1, 0),
|
||||
source: Source::cratesio_registry(),
|
||||
target: target.clone(),
|
||||
bins: vec!["1".into(), "2".into()],
|
||||
other: Default::default(),
|
||||
},
|
||||
MetaData {
|
||||
name: "a".into(),
|
||||
version_req: "*".into(),
|
||||
current_version: Version::new(0, 2, 0),
|
||||
source: Source::cratesio_registry(),
|
||||
target: target.clone(),
|
||||
bins: vec!["1".into()],
|
||||
other: Default::default(),
|
||||
},
|
||||
];
|
||||
|
||||
append_to_path(&path, metadata_vec.clone()).unwrap();
|
||||
|
||||
let mut iter = metadata_vec.into_iter();
|
||||
iter.next().unwrap();
|
||||
|
||||
let mut metadata_set: BTreeSet<_> = iter.collect();
|
||||
|
||||
let mut records = Records::load_from_path(&path).unwrap();
|
||||
assert_records_eq!(&records, &metadata_set);
|
||||
|
||||
records.remove("b");
|
||||
assert_eq!(records.len(), metadata_set.len() - 1);
|
||||
records.overwrite().unwrap();
|
||||
|
||||
metadata_set.remove("b");
|
||||
let records = Records::load_from_path(&path).unwrap();
|
||||
assert_records_eq!(&records, &metadata_set);
|
||||
// Drop the exclusive file lock
|
||||
drop(records);
|
||||
|
||||
let new_metadata = MetaData {
|
||||
name: "b".into(),
|
||||
version_req: "0.1.0".into(),
|
||||
current_version: Version::new(0, 1, 1),
|
||||
source: Source::cratesio_registry(),
|
||||
target,
|
||||
bins: vec!["1".into(), "2".into()],
|
||||
other: Default::default(),
|
||||
};
|
||||
append_to_path(&path, [new_metadata.clone()]).unwrap();
|
||||
metadata_set.insert(new_metadata);
|
||||
|
||||
let records = Records::load_from_path(&path).unwrap();
|
||||
assert_records_eq!(&records, &metadata_set);
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue