MightyPork/elefren-fork
1
0
Fork 1
Code Issues Pull Requests Releases Wiki Activity

feat(macros): add compile tests to the doc comments

Browse Source
This commit is contained in:
Paul Woolcock
2018-08-29 12:20:42 -04:00
parent 46871da4c1
commit 2a6e922da7
1 changed files with 80 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/macros.rs
+80 -8
View File
@@ -19,9 +19,27 @@ macro_rules! paged_routes {
(($method:ident) $name:ident: $url:expr => $ret:ty, $($rest:tt)*) => { (($method:ident) $name:ident: $url:expr => $ret:ty, $($rest:tt)*) => {
doc_comment! { doc_comment! {
concat!( concat!(
"Equivalent to `/api/v1/", "Equivalent to `/api/v1/",
$url, $url,
"`\n# Errors\nIf `access_token` is not set."), "`\n# Errors\nIf `access_token` is not set.",
"\n",
"```no_run",
"# extern crate elefren;\n",
"# use elefren::prelude::*;\n",
"# fn main() -> Result<(), Box<::std::error::Error>> {\n",
"# let data = Data {\n",
"# base: \"https://example.com\".into(),\n",
"# client_id: \"taosuah\".into(),\n",
"# client_secret: \"htnjdiuae\".into(),\n",
"# redirect: \"https://example.com\".into(),\n",
"# token: \"tsaohueaheis\".into(),\n",
"# };\n",
"let client = Mastodon::from(data);\n",
"client.", stringify!($name), "();\n",
"# Ok(())\n",
"# }\n",
"```"
),
fn $name(&self) -> Result<Page<$ret, H>> { fn $name(&self) -> Result<Page<$ret, H>> {
let url = self.route(concat!("/api/v1/", $url)); let url = self.route(concat!("/api/v1/", $url));
let response = self.send( let response = self.send(
@@ -81,8 +99,8 @@ macro_rules! route {
concat!( concat!(
"Equivalent to `/api/v1/", "Equivalent to `/api/v1/",
$url, $url,
"`\n# Errors\nIf `access_token` is not set."), "`\n# Errors\nIf `access_token` is not set.",
),
fn $name(&self, $($param: $typ,)*) -> Result<$ret> { fn $name(&self, $($param: $typ,)*) -> Result<$ret> {
let form_data = json!({ let form_data = json!({
@@ -116,7 +134,25 @@ macro_rules! route {
concat!( concat!(
"Equivalent to `/api/v1/", "Equivalent to `/api/v1/",
$url, $url,
"`\n# Errors\nIf `access_token` is not set."), "`\n# Errors\nIf `access_token` is not set.",
"\n",
"```no_run",
"# extern crate elefren;\n",
"# use elefren::prelude::*;\n",
"# fn main() -> Result<(), Box<::std::error::Error>> {\n",
"# let data = Data {\n",
"# base: \"https://example.com\".into(),\n",
"# client_id: \"taosuah\".into(),\n",
"# client_secret: \"htnjdiuae\".into(),\n",
"# redirect: \"https://example.com\".into(),\n",
"# token: \"tsaohueaheis\".into(),\n",
"# };\n",
"let client = Mastodon::from(data);\n",
"client.", stringify!($name), "();\n",
"# Ok(())\n",
"# }\n",
"```"
),
fn $name(&self) -> Result<$ret> { fn $name(&self) -> Result<$ret> {
self.$method(self.route(concat!("/api/v1/", $url))) self.$method(self.route(concat!("/api/v1/", $url)))
} }
@@ -136,7 +172,25 @@ macro_rules! route_id {
concat!( concat!(
"Equivalent to `/api/v1/", "Equivalent to `/api/v1/",
$url, $url,
"`\n# Errors\nIf `access_token` is not set."), "`\n# Errors\nIf `access_token` is not set.",
"\n",
"```no_run",
"# extern crate elefren;\n",
"# use elefren::prelude::*;\n",
"# fn main() -> Result<(), Box<::std::error::Error>> {\n",
"# let data = Data {\n",
"# base: \"https://example.com\".into(),\n",
"# client_id: \"taosuah\".into(),\n",
"# client_secret: \"htnjdiuae\".into(),\n",
"# redirect: \"https://example.com\".into(),\n",
"# token: \"tsaohueaheis\".into(),\n",
"# };\n",
"let client = Mastodon::from(data);\n",
"client.", stringify!($name), "(42);\n",
"# Ok(())\n",
"# }\n",
"```"
),
fn $name(&self, id: u64) -> Result<$ret> { fn $name(&self, id: u64) -> Result<$ret> {
self.$method(self.route(&format!(concat!("/api/v1/", $url), id))) self.$method(self.route(&format!(concat!("/api/v1/", $url), id)))
} }
@@ -152,7 +206,25 @@ macro_rules! paged_routes_with_id {
concat!( concat!(
"Equivalent to `/api/v1/", "Equivalent to `/api/v1/",
$url, $url,
"`\n# Errors\nIf `access_token` is not set."), "`\n# Errors\nIf `access_token` is not set.",
"\n",
"```no_run",
"# extern crate elefren;\n",
"# use elefren::prelude::*;\n",
"# fn main() -> Result<(), Box<::std::error::Error>> {\n",
"# let data = Data {\n",
"# base: \"https://example.com\".into(),\n",
"# client_id: \"taosuah\".into(),\n",
"# client_secret: \"htnjdiuae\".into(),\n",
"# redirect: \"https://example.com\".into(),\n",
"# token: \"tsaohueaheis\".into(),\n",
"# };\n",
"let client = Mastodon::from(data);\n",
"client.", stringify!($name), "(\"some-id\");\n",
"# Ok(())\n",
"# }\n",
"```"
),
fn $name(&self, id: &str) -> Result<Page<$ret, H>> { fn $name(&self, id: &str) -> Result<Page<$ret, H>> {
let url = self.route(&format!(concat!("/api/v1/", $url), id)); let url = self.route(&format!(concat!("/api/v1/", $url), id));
let response = self.send( let response = self.send(