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.

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

Switch HashMap to BTreeMap, lints #25

Merged
merged 1 commit into from
Nov 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<a name="v0.4.0"></a>
### v0.4.0 (2022-11-19)
* Switch all `HashMap` to `BTreeMap` for consistent serialization ordering

<a name="v0.3.4"></a>
### v0.3.4 (2022-11-15)
* Add proper `Error` implementation to `Bounds` and `Center` parsing errors
Expand Down
9 changes: 8 additions & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "tilejson"
version = "0.3.4"
version = "0.4.0"
description = "Library for serializing the TileJSON file format"
authors = [
"Stepan Kuzmin <[email protected]>",
Expand All @@ -20,3 +20,10 @@ serde = { version = "1", features = ["derive"] }
serde_json = "1"
serde_tuple = "0.5"
thiserror = "1"

[lints.rust]
unsafe_code = "forbid"
unused_qualifications = "warn"

[lints.clippy]
pedantic = "warn"
12 changes: 3 additions & 9 deletions src/bounds.rs
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ impl Display for Bounds {
/// # use std::str::FromStr;
/// let bounds = Bounds::new(-1.5, -2.5, 3.5, 4.5);
/// assert_eq!(bounds.to_string(), "-1.5,-2.5,3.5,4.5");
/// assert_eq!(format!("{:.2}", bounds), "-1.50,-2.50,3.50,4.50");
/// assert_eq!(format!("{bounds:.2}"), "-1.50,-2.50,3.50,4.50");
/// assert_eq!(Bounds::from_str(&bounds.to_string()).unwrap(), bounds);
/// ```
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
Expand Down Expand Up @@ -322,15 +322,9 @@ impl FromStr for Bounds {
let mut values = s.split(',');
let mut result = [0.; 4];
for val in &mut result {
*val = values
.next()
.ok_or(ParseBoundsError::BadLen)?
.trim()
.parse()?;
*val = values.next().ok_or(BadLen)?.trim().parse()?;
}
values
.next()
.map_or(Ok(result.into()), |_| Err(ParseBoundsError::BadLen))
values.next().map_or(Ok(result.into()), |_| Err(BadLen))
}
}

Expand Down
2 changes: 1 addition & 1 deletion src/center.rs
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ impl Display for Center {
/// # use std::str::FromStr;
/// let center = Center::new(1.5, -2.5, 8);
/// assert_eq!(center.to_string(), "1.5,-2.5,8");
/// assert_eq!(format!("{:.2}", center), "1.50,-2.50,8");
/// assert_eq!(format!("{center:.2}"), "1.50,-2.50,8");
/// assert_eq!(Center::from_str(&center.to_string()).unwrap(), center);
/// ```
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
Expand Down
34 changes: 31 additions & 3 deletions src/tilejson.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
use std::collections::HashMap;
use std::collections::BTreeMap;

use serde::{Deserialize, Serialize};
use serde_json::Value;
Expand Down Expand Up @@ -204,7 +204,7 @@ pub struct TileJSON {

/// Any unrecognized fields will be stored here
#[serde(flatten)]
pub other: HashMap<String, Value>,
pub other: BTreeMap<String, Value>,
}

impl TileJSON {
Expand Down Expand Up @@ -353,6 +353,34 @@ mod tests {
);
}

#[test]
fn test_other() {
let tilejson_str = r#"{
"tilejson": "3.0.0",
"attribution": "",
"name": "compositing",
"scheme": "tms",
"tiles": [
"http://localhost:8888/foo/{z}/{x}/{y}.png"
],
"foo": "foo value",
"bar": "bar value"
}"#;

let tilejson: TileJSON = serde_json::from_str(tilejson_str).unwrap();
let mut expected = tilejson! {
tilejson: "3.0.0".to_string(),
tiles: vec!["http://localhost:8888/foo/{z}/{x}/{y}.png".to_string()],
attribution: "".to_string(),
name: "compositing".to_string(),
scheme: "tms".to_string(),
};
expected.other.insert("foo".to_string(), "foo value".into());
expected.other.insert("bar".to_string(), "bar value".into());

assert_eq!(tilejson, expected);
}

#[test]
fn test_writing() {
let source = "http://localhost:8888/foo/{z}/{x}/{y}.png";
Expand All @@ -371,7 +399,7 @@ mod tests {

let vl = VectorLayer::new(
"a".to_string(),
HashMap::from([("b".to_string(), "c".to_string())]),
BTreeMap::from([("b".to_string(), "c".to_string())]),
);
let tj = tilejson! {
source.to_string(),
Expand Down
8 changes: 4 additions & 4 deletions src/vector_layer.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
use std::collections::HashMap;
use std::collections::BTreeMap;

use serde::{Deserialize, Serialize};
use serde_json::Value;
Expand Down Expand Up @@ -66,7 +66,7 @@ pub struct VectorLayer {
/// Each value (description) MUST be a string that describes the underlying data.
/// If no fields are present, the fields key MUST be an empty object.
/// <https://github.com/mapbox/tilejson-spec/tree/master/3.0.0#332-fields>
pub fields: HashMap<String, String>,
pub fields: BTreeMap<String, String>,

/// A string representing a human-readable description of the entire layer's contents.
///
Expand All @@ -90,11 +90,11 @@ pub struct VectorLayer {

/// Any unrecognized fields will be stored here.
#[serde(flatten)]
pub other: HashMap<String, Value>,
pub other: BTreeMap<String, Value>,
}

impl VectorLayer {
pub fn new(id: String, fields: HashMap<String, String>) -> Self {
pub fn new(id: String, fields: BTreeMap<String, String>) -> Self {
Self {
id,
fields,
Expand Down