Make linked-hash-map an optional dependency (#23)

Author: msrd0

Cargo.toml

@@ -18,13 +18,13 @@ include = ["src/**/*", "LICENSE", "crates-io.md"]
 
 [dependencies]
 indexmap = "1.7"
-linked-hash-map = "0.5.4"
 openapi_type_derive = { path = "./derive", version = "0.2.5" }
 openapiv3 = "=1.0.0"
 serde_json = "1.0"
 
 # optional dependencies / features
 chrono = { version = "0.4.19", default-features = false, optional = true }
+linked-hash-map = { version = "0.5.4", optional = true }
 time = { version = "0.3.4", features = ["serde-human-readable"], optional = true }
 uuid = { version = "0.8.2", optional = true }
 

README.md

@@ -29,7 +29,7 @@ This repository contains the following crates:
 
 # openapi_type
 
-This crate gives static type information for primitives and commonly used types from the standard library and a few other commonly used libraries like `chrono`, `time` and `uuid`. Also, it provides a derive macro for structs and enums to gain access to their static type information at runtime.
+This crate gives static type information for primitives and commonly used types from the standard library and other commonly used libraries `chrono`, `indexmap`, `linked-hash-map`, `time` and `uuid` when the according feature is enabled. Also, it provides a derive macro for structs and enums to gain access to their static type information at runtime.
 
 The core of this crate is the [`OpenapiType`][__link0] trait. It has one static function, [`schema`][__link1], which returns an [`OpenapiSchema`][__link2]. This assembles the static type information in a way that is convenient to use for a generated OpenAPI specification, but can also be utilized in other use cases as well.
 

crates-io.md

@@ -1,6 +1,6 @@
 # openapi_type [![Rust 1.56+](https://img.shields.io/badge/rustc-1.56+-orange.svg)](https://blog.rust-lang.org/2021/10/21/Rust-1.56.0.html) [![License Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0) [![GitHub](https://img.shields.io/badge/Code-On%20Github-blue?logo=GitHub)](https://github.com/msrd0/openapi_type)
 
-This crate gives static type information for primitives and commonly used types from the standard library and a few other commonly used libraries like `chrono`, `time` and `uuid`. Also, it provides a derive macro for structs and enums to gain access to their static type information at runtime.
+This crate gives static type information for primitives and commonly used types from the standard library and other commonly used libraries `chrono`, `indexmap`, `linked-hash-map`, `time` and `uuid` when the according feature is enabled. Also, it provides a derive macro for structs and enums to gain access to their static type information at runtime.
 
 The core of this crate is the [`OpenapiType`][__link0] trait. It has one static function, [`schema`][__link1], which returns an [`OpenapiSchema`][__link2]. This assembles the static type information in a way that is convenient to use for a generated OpenAPI specification, but can also be utilized in other use cases as well.
 

src/impls.rs

@@ -1,6 +1,5 @@
 use crate::{OpenapiSchema, OpenapiType};
 use indexmap::{IndexMap, IndexSet};
-use linked_hash_map::LinkedHashMap;
 use openapiv3::{
 	AdditionalProperties, ArrayType, IntegerType, NumberFormat, NumberType, ObjectType, ReferenceOr, SchemaKind,
 	StringFormat, StringType, Type, VariantOrUnknownOrEmpty
@@ -230,7 +229,12 @@ fn map_schema<K: OpenapiType, T: OpenapiType>() -> OpenapiSchema {
 impl_openapi_type!(
 	BTreeMap<K: OpenapiType, T: OpenapiType>,
 	HashMap<K: OpenapiType, T: OpenapiType, S: BuildHasher>,
-	IndexMap<K: OpenapiType, T: OpenapiType>,
-	LinkedHashMap<K: OpenapiType, T: OpenapiType, S: BuildHasher>
+	IndexMap<K: OpenapiType, T: OpenapiType>
+	=> map_schema::<K, T>()
+);
+
+#[cfg(feature = "linked-hash-map")]
+impl_openapi_type!(
+	linked_hash_map::LinkedHashMap<K: OpenapiType, T: OpenapiType, S: BuildHasher>
 	=> map_schema::<K, T>()
 );

src/lib.rs

@@ -4,8 +4,9 @@
 #![cfg_attr(feature = "cargo-clippy", allow(clippy::tabs_in_doc_comments))]
 #![doc = r##"
 This crate gives static type information for primitives and commonly used types from the standard
-library and a few other commonly used libraries like `chrono`, `time` and `uuid`. Also, it provides
-a derive macro for structs and enums to gain access to their static type information at runtime.
+library and other commonly used libraries `chrono`, `indexmap`, `linked-hash-map`, `time` and
+`uuid` when the according feature is enabled. Also, it provides a derive macro for structs and
+enums to gain access to their static type information at runtime.
 
 The core of this crate is the [`OpenapiType`] trait. It has one static function,
 [`schema`](OpenapiType::schema), which returns an [`OpenapiSchema`]. This assembles the static

tests/std_types.rs

@@ -1,5 +1,4 @@
 use indexmap::{IndexMap, IndexSet};
-use linked_hash_map::LinkedHashMap;
 use openapi_type::OpenapiType;
 use serde_json::Value;
 use std::{
@@ -213,20 +212,29 @@ test_type!(BTreeSet<String>, IndexSet<String>, HashSet<String> = {
 	"uniqueItems": true
 });
 
-test_type!(
-	BTreeMap<isize, String>,
-	HashMap<isize, String>,
-	IndexMap<isize, String>,
-	LinkedHashMap<isize, String> = {
-		"type": "object",
-		"properties": {
-			"default": {
-				"type": "integer"
-			}
-		},
-		"required": ["default"],
-		"additionalProperties": {
-			"type": "string"
+test_type!(BTreeMap<isize, String>, HashMap<isize, String>, IndexMap<isize, String> = {
+	"type": "object",
+	"properties": {
+		"default": {
+			"type": "integer"
 		}
+	},
+	"required": ["default"],
+	"additionalProperties": {
+		"type": "string"
 	}
-);
+});
+
+#[cfg(feature = "linked-hash-map")]
+test_type!(linked_hash_map::LinkedHashMap<isize, String> = {
+	"type": "object",
+	"properties": {
+		"default": {
+			"type": "integer"
+		}
+	},
+	"required": ["default"],
+	"additionalProperties": {
+		"type": "string"
+	}
+});