chore: Move "Context" under "error" module

This is part of a general goal I have of simplifying the top-level module
structure of the crate. The "Context" type is in relation to our
error-handling story, so it seems sensible to put it there.

Signed-off-by: Andrew Lilley Brinker <[email protected]>

hipcheck/src/analysis/mod.rs

@@ -1,6 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
 
-pub mod report_builder;
 pub mod result;
 pub mod score;
 

hipcheck/src/benchmarking.rs

@@ -10,6 +10,8 @@
 //!
 //! A macro is provided to automatically tag timings with the file and line number that they were created on.
 
+use crate::shell::Shell;
+pub use print_scope_time;
 use std::time::Instant;
 
 /// Structure used to track timing that will print its location and elapsed time when dropped.
@@ -55,7 +57,3 @@ macro_rules! print_scope_time {
 		))
 	};
 }
-
-pub(crate) use print_scope_time;
-
-use crate::shell::Shell;

hipcheck/src/cli.rs

@@ -4,7 +4,7 @@
 
 use crate::{
 	cache::repo_cache::{RepoCacheDeleteScope, RepoCacheListScope, RepoCacheSort},
-	context::Context,
+	error::Context,
 	error::Result,
 	hc_error,
 	session::pm,

hipcheck/src/command_util.rs

@@ -1,6 +1,9 @@
 // SPDX-License-Identifier: Apache-2.0
 
-use crate::{context::Context as _, error::Result, hc_error};
+use crate::{
+	error::{Context as _, Result},
+	hc_error,
+};
 use once_cell::sync::Lazy;
 use regex::Regex;
 use semver::Version;

hipcheck/src/config.rs

@@ -4,9 +4,8 @@
 
 use crate::{
 	analysis::score::*,
-	context::Context,
 	engine::HcEngine,
-	error::Result,
+	error::{Context, Result},
 	hc_error,
 	plugin::QueryResult,
 	policy::{

hipcheck/src/data/es_lint/command.rs

@@ -4,8 +4,7 @@ use std::{ffi::OsStr, process::Command};
 
 use crate::{
 	command_util::{log_args, DependentProgram},
-	context::Context as _,
-	error::Result,
+	error::{Context as _, Result},
 	hc_error,
 };
 

hipcheck/src/data/es_lint/mod.rs

@@ -1,10 +1,9 @@
 // SPDX-License-Identifier: Apache-2.0
 
-use std::{ffi::OsStr, path::Path};
-
-use crate::{context::Context as _, error::Result};
+use crate::error::{Context as _, Result};
 use command::ESLintCommand;
 use data::ESLintReports;
+use std::{ffi::OsStr, path::Path};
 
 pub mod command;
 pub mod data;

hipcheck/src/data/git/mod.rs

@@ -4,12 +4,11 @@ mod data;
 pub mod parse;
 mod query;
 
+pub use crate::data::git_command::*;
+use crate::error::{Context as _, Result};
 pub use data::*;
 use parse::*;
 pub use query::*;
-
-pub use crate::data::git_command::*;
-use crate::{context::Context as _, error::Result};
 use std::path::Path;
 
 pub fn get_git_version() -> Result<String> {

hipcheck/src/data/git/parse.rs

@@ -3,9 +3,8 @@
 #![allow(dead_code)]
 
 use crate::{
-	context::Context as _,
 	data::git::{Contributor, Diff, FileDiff, RawCommit},
-	error::{Error, Result},
+	error::{Context as _, Error, Result},
 };
 use chrono::{DateTime, FixedOffset};
 use nom::{

hipcheck/src/data/git/query/impls.rs

@@ -4,13 +4,12 @@
 
 use super::GitProvider;
 use crate::{
-	context::Context,
 	data::git::{
 		get_commits, get_commits_from_date, get_diffs, Commit, CommitContributor,
 		CommitContributorView, CommitDiff, CommitSigner, CommitSignerView, Contributor,
 		ContributorView, Diff, GitCommand, RawCommit, SignerKeyView, SignerNameView, SignerView,
 	},
-	error::{Error, Result},
+	error::{Context, Error, Result},
 };
 use chrono::prelude::*;
 use std::sync::Arc;

hipcheck/src/data/git_command.rs

@@ -1,6 +1,10 @@
 // SPDX-License-Identifier: Apache-2.0
 
-use crate::{command_util::log_git_args, context::Context as _, error::Result, hc_error};
+use crate::{
+	command_util::log_git_args,
+	error::{Context as _, Result},
+	hc_error,
+};
 use std::{
 	convert::AsRef, ffi::OsStr, iter::IntoIterator, ops::Not as _, path::Path, process::Command,
 };

hipcheck/src/data/github/graphql_pr.rs

@@ -5,12 +5,11 @@ use self::review::{
 	ReviewRepositoryPullRequestCommitsNodes as RawPullCommit, Variables,
 };
 use crate::{
-	context::Context,
 	data::{
 		git::{Contributor, RawCommit},
 		github::data::*,
 	},
-	error::{Error, Result},
+	error::{Context, Error, Result},
 	hc_error,
 	util::http::authenticated_agent::AuthenticatedAgent,
 };

hipcheck/src/data/github/mod.rs

@@ -6,13 +6,12 @@ mod graphql;
 mod graphql_pr;
 
 use crate::{
-	context::Context as _,
 	data::{
 		code_search::search_code_request,
 		git::parse::github_diff,
 		github::{data::*, graphql::get_all_reviews, graphql_pr::get_all_pr_reviews},
 	},
-	error::Result,
+	error::{Context as _, Result},
 	util::http::authenticated_agent::AuthenticatedAgent,
 };
 use std::sync::Arc;

hipcheck/src/data/mod.rs

@@ -16,8 +16,7 @@ mod query;
 pub use query::*;
 
 use crate::{
-	context::Context,
-	error::{Error, Result},
+	error::{Context, Error, Result},
 	hc_error,
 };
 use git::{get_commits_for_file, Commit, CommitContributor, Contributor, Diff};

hipcheck/src/data/modules.rs

@@ -2,8 +2,7 @@
 
 use crate::{
 	command_util::{log_args, DependentProgram},
-	context::Context as _,
-	error::{Error, Result},
+	error::{Context as _, Error, Result},
 	hc_error,
 };
 use pathbuf::pathbuf;

hipcheck/src/data/npm.rs

@@ -2,8 +2,7 @@
 
 use crate::{
 	command_util::{log_args, DependentProgram},
-	context::Context,
-	error::Result,
+	error::{Context, Result},
 	hc_error,
 	util::fs as file,
 };

hipcheck/src/data/query/pr_review.rs

@@ -5,13 +5,12 @@
 use super::github::GitHubProvider;
 use crate::{
 	config::ConfigSource,
-	context::Context,
 	data::{
 		get_pull_request_reviews_from_github, get_single_pull_request_review_from_github,
 		git::{Commit, CommitContributorView, CommitDiff, Contributor, ContributorView},
 		PullRequest, SinglePullRequest,
 	},
-	error::{Error, Result},
+	error::{Context, Error, Result},
 };
 use std::sync::Arc;
 

hipcheck/src/error.rs → hipcheck/src/error/mod.rs

@@ -10,6 +10,9 @@
 //! which error out aren't retried, as it always compares as equal to
 //! any other error.
 
+mod context;
+
+pub use crate::error::context::Context;
 use std::{
 	borrow::Cow,
 	error::Error as StdError,

hipcheck/src/main.rs

@@ -7,7 +7,6 @@ mod cache;
 mod cli;
 mod command_util;
 mod config;
-mod context;
 mod data;
 mod engine;
 mod error;
@@ -32,16 +31,13 @@ pub mod hipcheck {
 }
 
 use crate::{
-	analysis::{
-		report_builder::{build_report, Report},
-		score::score_results,
-	},
+	analysis::score::score_results,
 	cache::repo_cache::HcRepoCache,
 	cli::Format,
 	config::WeightTreeProvider,
-	context::Context as _,
-	error::{Error, Result},
+	error::{Context as _, Error, Result},
 	plugin::{Plugin, PluginExecutor, PluginWithConfig},
+	report::report_builder::{build_report, Report},
 	session::Session,
 	setup::{resolve_and_transform_source, SourceType},
 	shell::Shell,

hipcheck/src/metric/activity.rs

@@ -1,6 +1,9 @@
 // SPDX-License-Identifier: Apache-2.0
 
-use crate::{context::Context as _, error::Result, metric::MetricProvider};
+use crate::{
+	error::{Context as _, Result},
+	metric::MetricProvider,
+};
 use chrono::{prelude::*, Duration};
 use serde::{ser::SerializeStruct, Serialize, Serializer};
 use std::{result::Result as StdResult, sync::Arc};

hipcheck/src/metric/affiliation.rs

@@ -1,9 +1,8 @@
 // SPDX-License-Identifier: Apache-2.0
 
 use crate::{
-	context::Context as _,
 	data::git::{Commit, CommitContributorView},
-	error::{Error, Result},
+	error::{Context as _, Error, Result},
 	hc_error,
 	metric::MetricProvider,
 	util::fs as file,

hipcheck/src/metric/binary_detector/mod.rs

@@ -4,7 +4,11 @@ mod query;
 
 pub use query::*;
 
-use crate::{context::Context, error::Result, hc_error, util::fs::read_toml};
+use crate::{
+	error::{Context, Result},
+	hc_error,
+	util::fs::read_toml,
+};
 use content_inspector::{inspect, ContentType};
 use serde::{de::Visitor, Deserialize, Deserializer};
 use std::{

hipcheck/src/metric/binary_detector/query.rs

@@ -3,7 +3,8 @@
 //! A query group for binary file detection queries.
 
 use crate::{
-	config::PracticesConfigQuery, context::Context as _, error::Result,
+	config::PracticesConfigQuery,
+	error::{Context as _, Result},
 	metric::binary_detector::BinaryFileDetector,
 };
 use std::sync::Arc;

hipcheck/src/metric/churn.rs

@@ -1,9 +1,8 @@
 // SPDX-License-Identifier: Apache-2.0
 
 use crate::{
-	context::Context as _,
 	data::git::Commit,
-	error::Result,
+	error::{Context as _, Result},
 	hc_error,
 	metric::{
 		math::{mean, std_dev},

hipcheck/src/metric/commit_trust.rs

@@ -1,6 +1,9 @@
 // SPDX-License-Identifier: Apache-2.0
 
-use crate::{context::Context as _, error::Result, metric::MetricProvider};
+use crate::{
+	error::{Context as _, Result},
+	metric::MetricProvider,
+};
 use std::{collections::HashMap, sync::Arc};
 
 pub const TRUST_PHASE: &str = "commit trust";

hipcheck/src/metric/contributor_trust.rs

@@ -1,6 +1,9 @@
 // SPDX-License-Identifier: Apache-2.0
 
-use crate::{context::Context as _, error::Result, metric::MetricProvider};
+use crate::{
+	error::{Context as _, Result},
+	metric::MetricProvider,
+};
 use std::{collections::HashMap, sync::Arc};
 
 pub const TRUST_PHASE: &str = "contributor trust";

hipcheck/src/metric/entropy.rs

@@ -1,9 +1,8 @@
 // SPDX-License-Identifier: Apache-2.0
 
 use crate::{
-	context::Context as _,
 	data::git::{Commit, CommitDiff, FileDiff},
-	error::Result,
+	error::{Context as _, Result},
 	hc_error,
 	metric::{
 		math::{mean, std_dev},

hipcheck/src/metric/fuzz.rs

@@ -1,6 +1,10 @@
 // SPDX-License-Identifier: Apache-2.0
 
-use crate::{context::Context as _, data::Fuzz, error::Result, metric::MetricProvider};
+use crate::{
+	data::Fuzz,
+	error::{Context as _, Result},
+	metric::MetricProvider,
+};
 use serde::Serialize;
 use std::sync::Arc;
 

hipcheck/src/metric/identity.rs

@@ -1,6 +1,10 @@
 // SPDX-License-Identifier: Apache-2.0
 
-use crate::{context::Context as _, data::git::Commit, error::Result, metric::MetricProvider};
+use crate::{
+	data::git::Commit,
+	error::{Context as _, Result},
+	metric::MetricProvider,
+};
 use serde::Serialize;
 use std::sync::Arc;
 

hipcheck/src/metric/linguist/mod.rs

@@ -4,7 +4,10 @@ mod query;
 
 pub use query::*;
 
-use crate::{context::Context as _, error::Result, util::fs::read_toml};
+use crate::{
+	error::{Context as _, Result},
+	util::fs::read_toml,
+};
 use serde::{de::Visitor, Deserialize, Deserializer};
 use std::{convert::AsRef, fmt, fmt::Formatter, path::Path, result::Result as StdResult};
 

hipcheck/src/metric/linguist/query.rs

@@ -3,7 +3,8 @@
 //! A query group for source file language detection queries.
 
 use crate::{
-	config::LanguagesConfigQuery, context::Context, error::Result,
+	config::LanguagesConfigQuery,
+	error::{Context, Result},
 	metric::linguist::SourceFileDetector,
 };
 use std::sync::Arc;

hipcheck/src/metric/module.rs

@@ -1,6 +1,10 @@
 // SPDX-License-Identifier: Apache-2.0
 
-use crate::{context::Context as _, data::ModuleGraph, error::Result, metric::MetricProvider};
+use crate::{
+	data::ModuleGraph,
+	error::{Context as _, Result},
+	metric::MetricProvider,
+};
 use serde::Serialize;
 use std::sync::Arc;