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

Keep necessary quotes around private constants #14

Merged
merged 2 commits into from
Oct 29, 2024
Merged

Keep necessary quotes around private constants #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7702a98
add back quotes when package.yml line begins with - ::
perryqh Oct 29, 2024
1e9e6cd
bumping version
perryqh Oct 29, 2024
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
2 changes: 1 addition & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[package]
name = "pks"
version = "0.2.22"
version = "0.2.23"
edition = "2021"
description = "Welcome! Please see https://github.com/rubyatscale/pks for more information!"
license = "MIT"
Expand Down
106 changes: 75 additions & 31 deletions src/packs/pack.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ use std::{

use anyhow::Context;
use core::hash::Hash;
use regex::Regex;
use serde::{Deserialize, Deserializer, Serialize, Serializer};
use serde_yaml::Value;

Expand Down Expand Up @@ -395,17 +396,26 @@ fn is_default_public_folder(value: &Option<PathBuf>) -> bool {
}
}

pub fn serialize_pack(pack: &Pack) -> String {
pub fn serialize_pack(pack: &Pack) -> anyhow::Result<String> {
let serialized_pack = serde_yaml::to_string(&pack).unwrap();
if serialized_pack == "{}\n" {
"".to_owned()
Ok("".to_owned())
} else {
serialized_pack
add_back_necessary_quotes(serialized_pack)
}
}

// serde_yaml doesn't add quotes around all constants, which isn't a problem
//unless the constant starts with ::
fn add_back_necessary_quotes(
serialized_pack: String,
) -> anyhow::Result<String> {
let re = Regex::new("- (::.+)")?;
Ok(re.replace_all(&serialized_pack, "- \"$1\"").to_string())
}

pub fn write_pack_to_disk(pack: &Pack) -> anyhow::Result<()> {
let serialized_pack = serialize_pack(pack);
let serialized_pack = serialize_pack(pack)?;
let pack_dir = pack.yml.parent().ok_or_else(|| {
anyhow::Error::new(std::io::Error::new(
std::io::ErrorKind::NotFound,
Expand Down Expand Up @@ -469,13 +479,13 @@ mod tests {
use super::*;
use pretty_assertions::assert_eq;

fn reserialize_pack(pack_yml: &str) -> String {
fn reserialize_pack(pack_yml: &str) -> anyhow::Result<String> {
let deserialized_pack = serde_yaml::from_str::<Pack>(pack_yml).unwrap();
serialize_pack(&deserialized_pack)
}

#[test]
fn test_serde_sorted_dependencies() {
fn test_serde_sorted_dependencies() -> anyhow::Result<()> {
let pack_yml = r#"
# some comment
dependencies:
Expand All @@ -484,7 +494,7 @@ dependencies:
- packs/b
"#;

let actual = reserialize_pack(pack_yml);
let actual = reserialize_pack(pack_yml)?;

let expected = r#"
dependencies:
Expand All @@ -494,11 +504,12 @@ dependencies:
"#
.trim_start();

assert_eq!(expected, actual)
assert_eq!(expected, actual);
Ok(())
}

#[test]
fn test_serde_with_enforcements() {
fn test_serde_with_enforcements() -> anyhow::Result<()> {
let pack_yml = r#"
# some comment
enforce_privacy: true
Expand All @@ -510,7 +521,7 @@ dependencies:
foobar: true
"#;

let actual = reserialize_pack(pack_yml);
let actual = reserialize_pack(pack_yml)?;

let expected = r#"
enforce_privacy: true
Expand All @@ -523,11 +534,12 @@ foobar: true
"#
.trim_start();

assert_eq!(expected, actual)
assert_eq!(expected, actual);
Ok(())
}

#[test]
fn test_serde_with_arbitrary_client_keys() {
fn test_serde_with_arbitrary_client_keys() -> anyhow::Result<()> {
let pack_yml = r#"
# some comment
dependencies:
Expand All @@ -537,7 +549,7 @@ dependencies:
foobar: true
"#;

let actual = reserialize_pack(pack_yml);
let actual = reserialize_pack(pack_yml)?;

let expected = r#"
dependencies:
Expand All @@ -548,11 +560,12 @@ foobar: true
"#
.trim_start();

assert_eq!(expected, actual)
assert_eq!(expected, actual);
Ok(())
}

#[test]
fn test_serde_with_duplicate_dependencies() {
fn test_serde_with_duplicate_dependencies() -> anyhow::Result<()> {
let pack_yml = r#"
dependencies:
- packs/a
Expand All @@ -562,7 +575,7 @@ dependencies:
- packs/a
"#;

let actual = reserialize_pack(pack_yml);
let actual = reserialize_pack(pack_yml)?;

let expected = r#"
dependencies:
Expand All @@ -571,19 +584,20 @@ dependencies:
"#
.trim_start();

assert_eq!(expected, actual)
assert_eq!(expected, actual);
Ok(())
}

#[test]
fn test_serde_with_explicitly_empty_visible() {
fn test_serde_with_explicitly_empty_visible() -> anyhow::Result<()> {
let pack_yml = r#"
visible_to:
- packs/c
- packs/a
- packs/b
"#;

let actual = reserialize_pack(pack_yml);
let actual = reserialize_pack(pack_yml)?;

let expected = r#"
visible_to:
Expand All @@ -593,18 +607,19 @@ visible_to:
"#
.trim_start();

assert_eq!(expected, actual)
assert_eq!(expected, actual);
Ok(())
}

#[test]
fn test_serde_with_metadata() {
fn test_serde_with_metadata() -> anyhow::Result<()> {
let pack_yml = r#"
enforce_dependencies: false
metadata:
foobar: true
"#;

let actual = reserialize_pack(pack_yml);
let actual = reserialize_pack(pack_yml)?;

let expected = r#"
enforce_dependencies: false
Expand All @@ -613,29 +628,31 @@ metadata:
"#
.trim_start();

assert_eq!(expected, actual)
assert_eq!(expected, actual);
Ok(())
}

#[test]
fn test_serde_with_owner() {
fn test_serde_with_owner() -> anyhow::Result<()> {
let pack_yml = r#"
owner: Foobar
enforce_dependencies: true
"#;

let actual = reserialize_pack(pack_yml);
let actual = reserialize_pack(pack_yml)?;

let expected = r#"
owner: Foobar
enforce_dependencies: true
"#
.trim_start();

assert_eq!(expected, actual)
assert_eq!(expected, actual);
Ok(())
}

#[test]
fn test_serde_with_enforcement_globs() {
fn test_serde_with_enforcement_globs() -> anyhow::Result<()> {
let pack_yml = r#"
enforcement_globs_ignore:
- enforcements:
Expand Down Expand Up @@ -682,7 +699,7 @@ enforcement_globs_ignore:
]
);

let reserialized = reserialize_pack(pack_yml);
let reserialized = reserialize_pack(pack_yml)?;
let re_pack: Result<Pack, _> = serde_yaml::from_str(&reserialized);
let re_pack = re_pack.unwrap();
assert_eq!(pack, re_pack);
Expand All @@ -697,17 +714,19 @@ enforcement_globs_ignore:
})
);
assert_eq!(pack.ignores_for_enforcement("nope"), None);
Ok(())
}

#[test]
fn test_serde_with_empty_pack() {
fn test_serde_with_empty_pack() -> anyhow::Result<()> {
let pack_yml = r#""#;

let actual = reserialize_pack(pack_yml);
let actual = reserialize_pack(pack_yml)?;

let expected = r#""#.trim_start();

assert_eq!(expected, actual)
assert_eq!(expected, actual);
Ok(())
}

#[test]
Expand All @@ -723,6 +742,31 @@ enforcement_globs_ignore:
assert_eq!(expected, actual)
}

#[test]
fn test_serde_with_necessary_quotes_in_ignored_private_constants(
) -> anyhow::Result<()> {
let pack_yml = r#"
ignored_private_constants:
- "::Necessary::Quotes::Constant"
- "Unnecessary::Quotes::Constant"
- "::Another::Necessary::Last::Necessary::Constant"
- "::Necessary"
"#;

let actual = reserialize_pack(pack_yml)?;
let expected = r#"
ignored_private_constants:
- "::Another::Necessary::Last::Necessary::Constant"
- "::Necessary"
- "::Necessary::Quotes::Constant"
- Unnecessary::Quotes::Constant
"#
.trim_start();

assert_eq!(expected, actual);
Ok(())
}

#[test]
fn test_all_recorded_violations() -> anyhow::Result<()> {
let root = test_util::get_absolute_root(
Expand Down
Loading