Skip to content

Commit efc598b

Browse files
committed
models/krate: Adjust naming of fns that return Result
`valid` is a property name, which suggests that the fn returns a `bool`. If the fn returns a `Result` it's better to name the function like an action, e.g. `validate`.
1 parent cd1d40a commit efc598b

File tree

2 files changed

+29
-29
lines changed

2 files changed

+29
-29
lines changed

src/controllers/krate/publish.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ pub async fn publish(app: AppState, req: BytesRequest) -> AppResult<Json<GoodCra
238238
}
239239

240240
for (key, values) in features.iter() {
241-
Crate::valid_feature_name(key)?;
241+
Crate::validate_feature_name(key)?;
242242

243243
let num_features = values.len();
244244
if num_features > max_features {
@@ -253,7 +253,7 @@ pub async fn publish(app: AppState, req: BytesRequest) -> AppResult<Json<GoodCra
253253
}
254254

255255
for value in values.iter() {
256-
Crate::valid_feature(value)?;
256+
Crate::validate_feature(value)?;
257257
}
258258
}
259259

@@ -596,7 +596,7 @@ pub fn validate_dependency(dep: &EncodableCrateDependency) -> AppResult<()> {
596596
}
597597

598598
for feature in &dep.features {
599-
Crate::valid_feature(feature)?;
599+
Crate::validate_feature(feature)?;
600600
}
601601

602602
if let Some(registry) = &dep.registry {

src/models/krate.rs

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ impl Crate {
233233
/// 1. The name must be non-empty.
234234
/// 2. The first character must be a Unicode XID start character, `_`, or a digit.
235235
/// 3. The remaining characters must be Unicode XID characters, `_`, `+`, `-`, or `.`.
236-
pub fn valid_feature_name(name: &str) -> AppResult<()> {
236+
pub fn validate_feature_name(name: &str) -> AppResult<()> {
237237
if name.is_empty() {
238238
return Err(cargo_err("feature cannot be an empty"));
239239
}
@@ -267,20 +267,20 @@ impl Crate {
267267
}
268268

269269
/// Validates a whole feature string, `features = ["THIS", "and/THIS", "dep:THIS", "dep?/THIS"]`.
270-
pub fn valid_feature(name: &str) -> AppResult<()> {
270+
pub fn validate_feature(name: &str) -> AppResult<()> {
271271
if let Some((dep, dep_feat)) = name.split_once('/') {
272272
let dep = dep.strip_suffix('?').unwrap_or(dep);
273273
if !Crate::valid_dependency_name(dep) {
274274
return Err(cargo_err(&Crate::invalid_dependency_name_msg(dep)));
275275
}
276-
Crate::valid_feature_name(dep_feat)
276+
Crate::validate_feature_name(dep_feat)
277277
} else if let Some((_, dep)) = name.split_once("dep:") {
278278
if !Crate::valid_dependency_name(dep) {
279279
return Err(cargo_err(&Crate::invalid_dependency_name_msg(dep)));
280280
}
281281
return Ok(());
282282
} else {
283-
Crate::valid_feature_name(name)
283+
Crate::validate_feature_name(name)
284284
}
285285
}
286286

@@ -562,27 +562,27 @@ mod tests {
562562

563563
#[test]
564564
fn valid_feature_names() {
565-
assert_ok!(Crate::valid_feature("foo"));
566-
assert_ok!(Crate::valid_feature("1foo"));
567-
assert_ok!(Crate::valid_feature("_foo"));
568-
assert_ok!(Crate::valid_feature("_foo-_+.1"));
569-
assert_ok!(Crate::valid_feature("_foo-_+.1"));
570-
assert_err!(Crate::valid_feature(""));
571-
assert_err!(Crate::valid_feature("/"));
572-
assert_err!(Crate::valid_feature("%/%"));
573-
assert_ok!(Crate::valid_feature("a/a"));
574-
assert_ok!(Crate::valid_feature("32-column-tables"));
575-
assert_ok!(Crate::valid_feature("c++20"));
576-
assert_ok!(Crate::valid_feature("krate/c++20"));
577-
assert_err!(Crate::valid_feature("c++20/wow"));
578-
assert_ok!(Crate::valid_feature("foo?/bar"));
579-
assert_ok!(Crate::valid_feature("dep:foo"));
580-
assert_err!(Crate::valid_feature("dep:foo?/bar"));
581-
assert_err!(Crate::valid_feature("foo/?bar"));
582-
assert_err!(Crate::valid_feature("foo?bar"));
583-
assert_ok!(Crate::valid_feature("bar.web"));
584-
assert_ok!(Crate::valid_feature("foo/bar.web"));
585-
assert_err!(Crate::valid_feature("dep:0foo"));
586-
assert_err!(Crate::valid_feature("0foo?/bar.web"));
565+
assert_ok!(Crate::validate_feature("foo"));
566+
assert_ok!(Crate::validate_feature("1foo"));
567+
assert_ok!(Crate::validate_feature("_foo"));
568+
assert_ok!(Crate::validate_feature("_foo-_+.1"));
569+
assert_ok!(Crate::validate_feature("_foo-_+.1"));
570+
assert_err!(Crate::validate_feature(""));
571+
assert_err!(Crate::validate_feature("/"));
572+
assert_err!(Crate::validate_feature("%/%"));
573+
assert_ok!(Crate::validate_feature("a/a"));
574+
assert_ok!(Crate::validate_feature("32-column-tables"));
575+
assert_ok!(Crate::validate_feature("c++20"));
576+
assert_ok!(Crate::validate_feature("krate/c++20"));
577+
assert_err!(Crate::validate_feature("c++20/wow"));
578+
assert_ok!(Crate::validate_feature("foo?/bar"));
579+
assert_ok!(Crate::validate_feature("dep:foo"));
580+
assert_err!(Crate::validate_feature("dep:foo?/bar"));
581+
assert_err!(Crate::validate_feature("foo/?bar"));
582+
assert_err!(Crate::validate_feature("foo?bar"));
583+
assert_ok!(Crate::validate_feature("bar.web"));
584+
assert_ok!(Crate::validate_feature("foo/bar.web"));
585+
assert_err!(Crate::validate_feature("dep:0foo"));
586+
assert_err!(Crate::validate_feature("0foo?/bar.web"));
587587
}
588588
}

0 commit comments

Comments
 (0)