Rename crate to speka

Flowneee · Aug 7, 2024 · a18a30f · a18a30f
1 parent af90c55
commit a18a30f
Show file tree

Hide file tree

Showing 44 changed files with 73 additions and 62 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,5 +3,5 @@ All notable changes to this project will be documented in the changelog of the r
 This project follows the [Semantic Versioning standard](https://semver.org/).
 
 For the changelogs of the crates see:
-- okapi-operation: [./okapi-operation/CHANGELOG.md](./okapi-operation/CHANGELOG.md)
-- okapi-operation-macro: [./okapi-operation-macro/CHANGELOG.md](./okapi-operation-macro/CHANGELOG.md)
+- speka: [./speka/CHANGELOG.md](./speka/CHANGELOG.md)
+- speka-macro: [./speka-macro/CHANGELOG.md](./speka-macro/CHANGELOG.md)
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,7 +1,7 @@
 [workspace]
 resolver = "2"
 members = [
-    "./okapi-operation-macro",
-    "./okapi-operation",
-    "./okapi-examples"
+    "./speka",
+    "./speka-examples",
+    "./speka-macro",
 ]
diff --git a/README.md b/README.md
@@ -1,17 +1,17 @@
-# `okapi-operation`
+# `speka`
 
-[![Crates.io](https://img.shields.io/crates/v/okapi-operation)](https://crates.io/crates/okapi-operation)
-[![docs.rs](https://img.shields.io/docsrs/okapi-operation/latest)](https://docs.rs/okapi-operation/latest)
-![CI](https://github.com/Flowneee/okapi-operation/actions/workflows/ci.yml/badge.svg)
+[![Crates.io](https://img.shields.io/crates/v/speka)](https://crates.io/crates/speka)
+[![docs.rs](https://img.shields.io/docsrs/speka/latest)](https://docs.rs/speka/latest)
+![CI](https://github.com/Flowneee/speka/actions/workflows/ci.yml/badge.svg)
 
 Library which allow to generate OpenAPI's operation definitions (using types from `okapi` crate) with procedural
-macro `#[openapi]`.
+macro `#[openapi]` (formerly named `okapi-operation`, see https://github.com/Flowneee/speka/issues/17).
 
 ## Example (with axum-integration feature).
 
 ```rust,no_run
 use axum::{extract::Query, Json};
-use okapi_operation::{axum_integration::*, *};
+use speka::{axum_integration::*, *};
 use serde::Deserialize;
 
 #[derive(Deserialize, JsonSchema)]
@@ -70,6 +70,6 @@ fn main() {
 
 * [ ] support examples on MediaType or Parameter (examples supported on types via `JsonSchema` macro)
 * [ ] support inferring schemas of parameters from function definitions
-* [ ] support for renaming or changing paths to okapi/schemars/okapi-operations in macro
+* [ ] support for renaming or changing paths to okapi/schemars/spekas in macro
 * [ ] more examples
 * [ ] ...
diff --git a/publish.sh b/publish.sh
@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+set -e
+set -x
+
+publish_crate() {
+    cargo publish -p $1
+}
+
+publish_crate speka-macro
+publish_crate speka
diff --git a/okapi-examples/Cargo.toml → speka-examples/Cargo.toml b/okapi-examples/Cargo.toml → speka-examples/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name = "okapi-examples"
+name = "speka-examples"
 version = "0.1.0"
 edition = "2021"
 
@@ -10,5 +10,5 @@ axum = "0.7"
 axum-extra = { version = "0.9", features = ["typed-header"] }
 tokio = { version = "1", features = ["full"] }
 serde = { version = "1", features = ["derive"] }
-okapi-operation = { path = "../okapi-operation", features = ["axum", "yaml"] }
-okapi-operation-macro = { path = "../okapi-operation-macro", features = ["axum"] }
+speka = { path = "../speka", features = ["axum", "yaml"] }
+speka-macro = { path = "../speka-macro", features = ["axum"] }
diff --git a/okapi-examples/src/main.rs → speka-examples/src/main.rs b/okapi-examples/src/main.rs → speka-examples/src/main.rs
@@ -1,5 +1,5 @@
 use axum::{extract::Query, Json};
-use okapi_operation::{axum_integration::*, *};
+use speka::{axum_integration::*, *};
 use serde::Deserialize;
 
 #[derive(Deserialize, JsonSchema)]

diff --git a/okapi-operation-macro/.gitignore → speka-macro/.gitignore b/okapi-operation-macro/.gitignore → speka-macro/.gitignore
diff --git a/okapi-operation-macro/CHANGELOG.md → speka-macro/CHANGELOG.md b/okapi-operation-macro/CHANGELOG.md → speka-macro/CHANGELOG.md
@@ -9,7 +9,7 @@ This project follows the [Semantic Versioning standard](https://semver.org/).
  - Request body detection from function arguments for specific frameworks (i.e. axum);
  - `#[body]` attribute as replacement for `#[request_body]` (now considered deprecated);
  - Updates `syn` crate to version 2;
- - `crate` attribute to support renaming base crate, by default `okapi_operation`;
+ - `crate` attribute to support renaming base crate, by default `speka`;
  - `#[openapi]` macro takes care of reimporting necessary types and traits from base crate.
 
 ### Removed

diff --git a/okapi-operation-macro/Cargo.toml → speka-macro/Cargo.toml b/okapi-operation-macro/Cargo.toml → speka-macro/Cargo.toml
@@ -1,14 +1,14 @@
 [package]
-name = "okapi-operation-macro"
-description = "Macro implementation for okapi-operation"
+name = "speka-macro"
+description = "Macro implementation for speka"
 version = "0.2.0"
 authors = ["Andrey Kononov flowneee3@gmail.com"]
 edition = "2021"
 license = "MIT"
 keywords = ["rust", "openapi", "swagger", "axum"]
 categories = ["web-programming"]
 readme = "../README.md"
-repository = "https://github.com/Flowneee/okapi-operation"
+repository = "https://github.com/Flowneee/speka"
 
 [lib]
 proc-macro = true

diff --git a/okapi-operation-macro/src/error.rs → speka-macro/src/error.rs b/okapi-operation-macro/src/error.rs → speka-macro/src/error.rs
diff --git a/okapi-operation-macro/src/lib.rs → speka-macro/src/lib.rs b/okapi-operation-macro/src/lib.rs → speka-macro/src/lib.rs
diff --git a/...i-operation-macro/src/operation/cookie.rs → speka-macro/src/operation/cookie.rs b/...i-operation-macro/src/operation/cookie.rs → speka-macro/src/operation/cookie.rs
diff --git a/...tion-macro/src/operation/external_docs.rs → speka-macro/src/operation/external_docs.rs b/...tion-macro/src/operation/external_docs.rs → speka-macro/src/operation/external_docs.rs
diff --git a/...i-operation-macro/src/operation/header.rs → speka-macro/src/operation/header.rs b/...i-operation-macro/src/operation/header.rs → speka-macro/src/operation/header.rs
diff --git a/okapi-operation-macro/src/operation/mod.rs → speka-macro/src/operation/mod.rs b/okapi-operation-macro/src/operation/mod.rs → speka-macro/src/operation/mod.rs
@@ -31,7 +31,7 @@ mod security;
 //  - support for generic functions
 
 static DEFAULT_OPENAPI_ATTRIBUTE_NAME: &str = "openapi";
-static DEFAULT_CRATE_NAME: &str = "okapi_operation";
+static DEFAULT_CRATE_NAME: &str = "speka";
 
 thread_local! {
     pub static MACRO_ATTRIBUTE_NAME: RefCell<String> = RefCell::new(DEFAULT_OPENAPI_ATTRIBUTE_NAME.into());

diff --git a/...eration-macro/src/operation/parameters.rs → speka-macro/src/operation/parameters.rs b/...eration-macro/src/operation/parameters.rs → speka-macro/src/operation/parameters.rs
diff --git a/okapi-operation-macro/src/operation/path.rs → speka-macro/src/operation/path.rs b/okapi-operation-macro/src/operation/path.rs → speka-macro/src/operation/path.rs
diff --git a/okapi-operation-macro/src/operation/query.rs → speka-macro/src/operation/query.rs b/okapi-operation-macro/src/operation/query.rs → speka-macro/src/operation/query.rs
diff --git a/...peration-macro/src/operation/reference.rs → speka-macro/src/operation/reference.rs b/...peration-macro/src/operation/reference.rs → speka-macro/src/operation/reference.rs
diff --git a/...-macro/src/operation/request_body/axum.rs → ...-macro/src/operation/request_body/axum.rs b/...-macro/src/operation/request_body/axum.rs → ...-macro/src/operation/request_body/axum.rs
diff --git a/...n-macro/src/operation/request_body/mod.rs → ...a-macro/src/operation/request_body/mod.rs b/...n-macro/src/operation/request_body/mod.rs → ...a-macro/src/operation/request_body/mod.rs
diff --git a/...operation-macro/src/operation/response.rs → speka-macro/src/operation/response.rs b/...operation-macro/src/operation/response.rs → speka-macro/src/operation/response.rs
diff --git a/...operation-macro/src/operation/security.rs → speka-macro/src/operation/security.rs b/...operation-macro/src/operation/security.rs → speka-macro/src/operation/security.rs
diff --git a/okapi-operation-macro/src/utils.rs → speka-macro/src/utils.rs b/okapi-operation-macro/src/utils.rs → speka-macro/src/utils.rs
diff --git a/okapi-operation/.gitignore → speka/.gitignore b/okapi-operation/.gitignore → speka/.gitignore
diff --git a/okapi-operation/CHANGELOG.md → speka/CHANGELOG.md b/okapi-operation/CHANGELOG.md → speka/CHANGELOG.md
diff --git a/okapi-operation/Cargo.toml → speka/Cargo.toml b/okapi-operation/Cargo.toml → speka/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name = "okapi-operation"
+name = "speka"
 description = "Procedural macro for generating OpenAPI operation specification (using okapi)"
 version = "0.3.0-rc3"
 authors = ["Andrey Kononov flowneee3@gmail.com"]
@@ -8,10 +8,10 @@ license = "MIT"
 keywords = ["rust", "openapi", "swagger", "axum"]
 categories = ["web-programming"]
 readme = "../README.md"
-repository = "https://github.com/Flowneee/okapi-operation"
+repository = "https://github.com/Flowneee/speka"
 
 [dependencies]
-okapi-operation-macro = { path = "../okapi-operation-macro", version = "0.2", optional = true }
+speka-macro = { path = "../speka-macro", version = "0.2", optional = true }
 
 anyhow = "1"
 bytes = "1.4"
@@ -36,10 +36,10 @@ serde = { version = "1", features = ["derive"] }
 [features]
 default = ["macro"]
 
-macro = ["okapi-operation-macro"]
+macro = ["speka-macro"]
 yaml = ["serde_yaml"]
 
-axum = ["dep:axum", "paste", "tower", "okapi-operation-macro/axum"]
+axum = ["dep:axum", "paste", "tower", "speka-macro/axum"]
 # Deprecated, use feature `axum` instead
 axum-integration = ["axum"]
 

diff --git a/okapi-operation/docs/axum_integration.md → speka/docs/axum_integration.md b/okapi-operation/docs/axum_integration.md → speka/docs/axum_integration.md
@@ -15,7 +15,7 @@ This is example from root of this crate, but this time with [`axum_integration`]
 
 ```no_run
 use axum::{extract::Query, Json};
-use okapi_operation::{axum_integration::*, *};
+use speka::{axum_integration::*, *};
 use serde::Deserialize;
 
 #[derive(Deserialize, JsonSchema)]
@@ -72,7 +72,7 @@ If you need to customize builder template, you can either:
 
 ```no_run
 use axum::{extract::Query, Json};
-use okapi_operation::{axum_integration::*, *};
+use speka::{axum_integration::*, *};
 use serde::Deserialize;
 
 #[tokio::main]

diff --git a/okapi-operation/docs/root.md → speka/docs/root.md b/okapi-operation/docs/root.md → speka/docs/root.md
@@ -1,6 +1,6 @@
-# `okapi-operation`
+# `speka`
 
-- [`okapi-operation`](#-okapi-operation-)
+- [`speka`](#-speka-)
   * [Example (using axum, but without axum_integration feature)](#example-using-axum-but-without-axum_integration-feature)
   * [`openapi` macro](#openapi-macro)
     + [Minimal example](#minimal-example)
@@ -39,7 +39,7 @@ use axum::{
     routing::{get, post},
     Json, Router,
 };
-use okapi_operation::*;
+use speka::*;
 use serde::Deserialize;
 
 #[derive(Deserialize, JsonSchema)]
@@ -107,7 +107,7 @@ Since most attributes taken from OpenAPI specification directly, refer to [OpenA
 Macro doesn't have any mandatory attributes.
 
 ```compile
-# use okapi_operation::*;
+# use speka::*;
 #[openapi]
 async fn handler() {}
 ```
@@ -119,7 +119,7 @@ All attributes is translated into same fields of [`okapi::openapi3::Operation`].
 Tags is provided as single string, which later is separated by comma.
 
 ```no_run
-# use okapi_operation::*;
+# use speka::*;
 #[openapi(
     summary = "Simple handler",
     description = "Simple handler, demonstrating how to use operation attributes",
@@ -135,7 +135,7 @@ async fn handler() {}
 External documentation can be set for operation. It is translated to [`okapi::openapi3::ExternalDocs`].
 
 ```no_run
-# use okapi_operation::*;
+# use speka::*;
 #[openapi(
     external_docs(
         url = "https://example.com",
@@ -170,7 +170,7 @@ This definition translated to [`okapi::openapi3::Parameter`] with [`okapi::opena
 * schema (path, mandatory) - path to type of parameter.
 
 ```no_run
-# use okapi_operation::*;
+# use speka::*;
 #[openapi(
     parameters(
         header(
@@ -201,7 +201,7 @@ async fn handler() {}
 * schema (path, mandatory) - path to type of parameter.
 
 ```no_run
-# use okapi_operation::*;
+# use speka::*;
 #[openapi(
     parameters(
         query(
@@ -233,7 +233,7 @@ async fn handler() {}
 Unlike header and query parameters, all path parameters is mandatory.
 
 ```no_run
-# use okapi_operation::*;
+# use speka::*;
 #[openapi(
     parameters(
         path(
@@ -261,7 +261,7 @@ async fn handler() {}
 * schema (path, mandatory) - path to type of parameter.
 
 ```no_run
-# use okapi_operation::*;
+# use speka::*;
 #[openapi(
     parameters(
         cookie(
@@ -281,7 +281,7 @@ async fn handler() {}
 #### Reference
 
 ```no_run
-# use okapi_operation::*;
+# use speka::*;
 #[openapi(
     parameters(
         reference = "#/components/parameters/ReusableHeader"
@@ -295,7 +295,7 @@ async fn handler() {}
 Specifying multiple parameters is supported:
 
 ```no_run
-# use okapi_operation::*;
+# use speka::*;
 #[openapi(
     parameters(
         header(
@@ -338,7 +338,7 @@ Request body definition have following attributes:
 * content (path, optional) - path to type, which schema should be used. If not speified, argument's type is used.
 
 ```no_run
-# use okapi_operation::*;
+# use speka::*;
 # use okapi::schemars::*;
 # struct Json<T>(T);
 # impl_to_media_types_for_wrapper!(Json<T>, "application/json");
@@ -384,7 +384,7 @@ Responses can be:
 Return type should implement [`ToResponses`] trait.
 
 ```no_run
-# use okapi_operation::*;
+# use speka::*;
 # use okapi::schemars::*;
 # struct Json<T>(T);
 # impl_to_media_types_for_wrapper!(Json<T>, "application/json");
@@ -405,7 +405,7 @@ async fn handler() -> Json<Response> {
 If return type doesn't implement [`ToResponses`], it can be ignored with special attribute `ignore_return_type`:
 
 ```no_run
-# use okapi_operation::*;
+# use speka::*;
 #[openapi(
     responses(
         ignore_return_type = true,
@@ -433,7 +433,7 @@ Single response have following attributes:
 * headers (list, optional) - list of headers (definition is the same as in request parameters). References to header is also allowed.
 
 ```no_run
-# use okapi_operation::*;
+# use speka::*;
 # use okapi::schemars::*;
 # struct Json<T>(T);
 # impl_to_media_types_for_wrapper!(Json<T>, "application/json");
@@ -474,7 +474,7 @@ async fn handler() {
 Responses can be generated from type, which implement [`ToResponses`]:
 
 ```no_run
-# use okapi_operation::*;
+# use speka::*;
 # use okapi::schemars::*;
 # struct Json<T>(T);
 # impl_to_media_types_for_wrapper!(Json<T>, "application/json");
@@ -504,7 +504,7 @@ Reference to response have following attributes:
 * reference (string, mandatory).
 
 ```no_run
-# use okapi_operation::*;
+# use speka::*;
 #[openapi(
     responses(
         reference(
@@ -530,7 +530,7 @@ first occurence is used. Responses merged in following order:
 * from types.
 
 ```no_run
-# use okapi_operation::*;
+# use speka::*;
 # use okapi::schemars::*;
 # struct Json<T>(T);
 # impl_to_media_types_for_wrapper!(Json<T>, "application/json");
@@ -572,7 +572,7 @@ Security scheme have following attributes:
 If multiple schemes specified, they are combined as OR. AND is not currently supported.
 
 ```no_run
-# use okapi_operation::*;
+# use speka::*;
 #[openapi(
     security(
         security_scheme(
@@ -592,7 +592,7 @@ async fn handler() {}
 For convenience this crate provide builder-like [`OpenApiBuilder`] type for creating OpenAPI specification:
 
 ```rust
-# use okapi_operation::*;
+# use speka::*;
 # use okapi::schemars::*;
 # use http::Method;
 # struct Json<T>(T);
@@ -638,6 +638,6 @@ assert!(generate_openapi_specification().is_ok());
 
 * [ ] support examples on MediaType or Parameter (examples supported on types via `JsonSchema` macro)
 * [ ] support inferring schemas of parameters from function definitions
-* [ ] support for renaming or changing paths to okapi/schemars/okapi-operations in macro
+* [ ] support for renaming or changing paths to okapi/schemars/spekas in macro
 * [ ] more examples
 * [ ] ...
diff --git a/...on/src/axum_integration/handler_traits.rs → speka/src/axum_integration/handler_traits.rs b/...on/src/axum_integration/handler_traits.rs → speka/src/axum_integration/handler_traits.rs
diff --git a/...ion/src/axum_integration/method_router.rs → speka/src/axum_integration/method_router.rs b/...ion/src/axum_integration/method_router.rs → speka/src/axum_integration/method_router.rs
diff --git a/okapi-operation/src/axum_integration/mod.rs → speka/src/axum_integration/mod.rs b/okapi-operation/src/axum_integration/mod.rs → speka/src/axum_integration/mod.rs
diff --git a/...ration/src/axum_integration/operations.rs → speka/src/axum_integration/operations.rs b/...ration/src/axum_integration/operations.rs → speka/src/axum_integration/operations.rs
diff --git a/...-operation/src/axum_integration/router.rs → speka/src/axum_integration/router.rs b/...-operation/src/axum_integration/router.rs → speka/src/axum_integration/router.rs
@@ -77,7 +77,7 @@ where
     /// # Example
     ///
     /// ```rust
-    /// # use okapi_operation::{*, axum_integration::*};
+    /// # use speka::{*, axum_integration::*};
     /// #[openapi]
     /// async fn handler() {}
     ///
@@ -134,7 +134,7 @@ where
     /// # Example
     ///
     /// ```rust
-    /// # use okapi_operation::{*, axum_integration::*};
+    /// # use speka::{*, axum_integration::*};
     /// #[openapi]
     /// async fn handler() {}
     /// let handler_router = Router::new().route("/", get(openapi_handler!(handler)));
@@ -184,7 +184,7 @@ where
     /// # Example
     ///
     /// ```rust
-    /// # use okapi_operation::{*, axum_integration::*};
+    /// # use speka::{*, axum_integration::*};
     /// #[openapi]
     /// async fn handler() {}
     /// let handler_router = Router::new().route("/another_handler", get(openapi_handler!(handler)));
@@ -368,7 +368,7 @@ where
     /// # Example
     ///
     /// ```rust
-    /// # use okapi_operation::{*, axum_integration::*};
+    /// # use speka::{*, axum_integration::*};
     /// #[openapi]
     /// async fn handler() {}
     ///

diff --git a/...ation/src/axum_integration/trait_impls.rs → speka/src/axum_integration/trait_impls.rs b/...ation/src/axum_integration/trait_impls.rs → speka/src/axum_integration/trait_impls.rs
diff --git a/...i-operation/src/axum_integration/utils.rs → speka/src/axum_integration/utils.rs b/...i-operation/src/axum_integration/utils.rs → speka/src/axum_integration/utils.rs
diff --git a/okapi-operation/src/axum_integration/yaml.rs → speka/src/axum_integration/yaml.rs b/okapi-operation/src/axum_integration/yaml.rs → speka/src/axum_integration/yaml.rs
diff --git a/okapi-operation/src/builder.rs → speka/src/builder.rs b/okapi-operation/src/builder.rs → speka/src/builder.rs
diff --git a/okapi-operation/src/components.rs → speka/src/components.rs b/okapi-operation/src/components.rs → speka/src/components.rs