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.

Sign up for GitHub

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

ISSUE-16 - Moving function to create cargo geiger PackageId to utils #139

Merged
merged 1 commit into from
Nov 15, 2020
Merged

ISSUE-16 - Moving function to create cargo geiger PackageId to utils #139

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
70 changes: 11 additions & 59 deletions cargo-geiger/src/scan.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ mod rs_file;
use crate::args::Args;
use crate::format::print_config::PrintConfig;
use crate::graph::Graph;
use crate::utils::{CargoMetadataParameters, ToCargoCoreDepKind, ToPackageId};
use crate::utils::{
CargoMetadataParameters, ToCargoCoreDepKind, ToCargoGeigerPackageId,
};

pub use rs_file::RsFileMetricsWrapper;

Expand All @@ -22,7 +24,6 @@ use cargo_geiger_serde::{
use petgraph::visit::EdgeRef;
use std::collections::{HashMap, HashSet};
use std::path::PathBuf;
use url::Url;

/// Provides a more terse and searchable name for the wrapped generic
/// collection.
Expand Down Expand Up @@ -179,21 +180,21 @@ fn package_metrics(
while !indices.is_empty() {
let i = indices.pop().unwrap();
let package_id = graph.graph[i].clone();
let mut package = PackageInfo::new(from_cargo_package_id(
cargo_metadata_parameters,
package_id.clone(),
package_set,
));
let mut package =
PackageInfo::new(package_id.to_cargo_geiger_package_id(
cargo_metadata_parameters.krates,
package_set,
));
for edge in graph.graph.edges(i) {
let dep_index = edge.target();
if visited.insert(dep_index) {
indices.push(dep_index);
}
let dep = from_cargo_package_id(
cargo_metadata_parameters,
graph.graph[dep_index].clone(),
let dep = graph.graph[dep_index].to_cargo_geiger_package_id(
cargo_metadata_parameters.krates,
package_set,
);

package.add_dependency(
dep,
from_cargo_dependency_kind(
Expand All @@ -216,55 +217,6 @@ fn package_metrics(
package_metrics
}

fn from_cargo_package_id(
cargo_metadata_parameters: &CargoMetadataParameters,
cargo_metadata_package_id: cargo_metadata::PackageId,
package_set: &PackageSet,
) -> cargo_geiger_serde::PackageId {
let package_id = cargo_metadata_package_id
.to_package_id(cargo_metadata_parameters.krates, package_set);
let source = package_id.source_id();
let source_url = source.url();
// Canonicalize paths as cargo does not seem to do so on all platforms.
let source_url = if source_url.scheme() == "file" {
match source_url.to_file_path() {
Ok(p) => {
let p = p
.canonicalize()
.expect("A package source path could not be canonicalized");
Url::from_file_path(p)
.expect("A URL could not be created from a file path")
}
Err(_) => source_url.clone(),
}
} else {
source_url.clone()
};
let source = if source.is_git() {
cargo_geiger_serde::Source::Git {
url: source_url,
rev: source
.precise()
.expect("Git revision should be known")
.to_string(),
}
} else if source.is_path() {
cargo_geiger_serde::Source::Path(source_url)
} else if source.is_registry() {
cargo_geiger_serde::Source::Registry {
name: source.display_registry_name(),
url: source_url,
}
} else {
panic!("Unsupported source type: {:?}", source)
};
cargo_geiger_serde::PackageId {
name: package_id.name().to_string(),
version: package_id.version().clone(),
source,
}
}

fn from_cargo_dependency_kind(kind: DepKind) -> DependencyKind {
match kind {
DepKind::Normal => DependencyKind::Normal,
Expand Down
8 changes: 8 additions & 0 deletions cargo-geiger/src/utils.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,14 @@ pub trait ToCargoCoreDepKind {
fn to_cargo_core_dep_kind(&self) -> DepKind;
}

pub trait ToCargoGeigerPackageId {
fn to_cargo_geiger_package_id(
&self,
krates: &Krates,
package_set: &PackageSet,
) -> cargo_geiger_serde::PackageId;
}

pub trait ToCargoMetadataDependencyKind {
fn to_cargo_metadata_dependency_kind(&self) -> DependencyKind;
}
Expand Down
91 changes: 89 additions & 2 deletions cargo-geiger/src/utils/metadata.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@ use super::{
GetPackageNameFromCargoMetadataPackageId,
GetPackageVersionFromCargoMetadataPackageId, GetRoot,
MatchesIgnoringSource, Replacement, ToCargoCoreDepKind,
ToCargoMetadataPackageId, ToPackageId,
ToCargoGeigerPackageId, ToCargoMetadataPackageId, ToPackage, ToPackageId,
};

use crate::utils::ToPackage;
use cargo::core::dependency::DepKind;
use cargo::core::{Package, PackageId, PackageSet, Resolve};
use cargo_metadata::DependencyKind;
use krates::Krates;
use std::collections::HashSet;
use std::path::PathBuf;
use url::Url;

impl DepsNotReplaced for cargo_metadata::Metadata {
fn deps_not_replaced(
Expand Down Expand Up @@ -95,6 +95,56 @@ impl ToCargoCoreDepKind for DependencyKind {
}
}

impl ToCargoGeigerPackageId for cargo_metadata::PackageId {
fn to_cargo_geiger_package_id(
&self,
krates: &Krates,
package_set: &PackageSet,
) -> cargo_geiger_serde::PackageId {
let package_id = self.to_package_id(krates, package_set);
let source = package_id.source_id();
let source_url = source.url();
// Canonicalize paths as cargo does not seem to do so on all platforms.
let source_url = if source_url.scheme() == "file" {
match source_url.to_file_path() {
Ok(p) => {
let p = p.canonicalize().expect(
"A package source path could not be canonicalized",
);
Url::from_file_path(p)
.expect("A URL could not be created from a file path")
}
Err(_) => source_url.clone(),
}
} else {
source_url.clone()
};
let source = if source.is_git() {
cargo_geiger_serde::Source::Git {
url: source_url,
rev: source
.precise()
.expect("Git revision should be known")
.to_string(),
}
} else if source.is_path() {
cargo_geiger_serde::Source::Path(source_url)
} else if source.is_registry() {
cargo_geiger_serde::Source::Registry {
name: source.display_registry_name(),
url: source_url,
}
} else {
panic!("Unsupported source type: {:?}", source)
};
cargo_geiger_serde::PackageId {
name: package_id.name().to_string(),
version: package_id.version().clone(),
source,
}
}
}

impl ToPackage for cargo_metadata::PackageId {
fn to_package(&self, krates: &Krates, package_set: &PackageSet) -> Package {
let package_id = self.to_package_id(krates, package_set);
Expand Down Expand Up @@ -274,6 +324,43 @@ mod metadata_tests {
)
}

#[rstest]
fn to_cargo_geiger_package_id_test() {
let args = FeaturesArgs::default();
let config = Config::default().unwrap();
let manifest_path: Option<PathBuf> = None;
let workspace = get_workspace(&config, manifest_path).unwrap();
let package = workspace.current().unwrap();
let mut registry = get_registry(&config, &package).unwrap();

let (package_set, _) =
resolve(&args, package.package_id(), &mut registry, &workspace)
.unwrap();

let (krates, metadata) = construct_krates_and_metadata();

let root_package = metadata.root_package().unwrap();

let cargo_geiger_package_id = root_package
.id
.to_cargo_geiger_package_id(&krates, &package_set);

assert_eq!(cargo_geiger_package_id.name, root_package.name);

assert_eq!(
cargo_geiger_package_id.version.major,
root_package.version.major
);
assert_eq!(
cargo_geiger_package_id.version.minor,
root_package.version.minor
);
assert_eq!(
cargo_geiger_package_id.version.patch,
root_package.version.patch
);
}

#[rstest]
fn to_package_id_test() {
let args = FeaturesArgs::default();
Expand Down