Rename macro to context

andrewhickman · andrewhickman · commit 27fcd5b1115a · 2020-03-29T17:04:55.000+01:00
diff --git a/README.md b/README.md
@@ -11,7 +11,7 @@
 An attribute macro to add context to errors from a function.
 
 ```
-#[error_context("failed to parse config at `{}`", path.display())]
+#[context("failed to parse config at `{}`", path.display())]
 pub fn parse_config(path: &Path) -> anyhow::Result<u32> {
     let text = read_to_string(path)?;
     Ok(text.parse()?)
diff --git a/examples/context.rs b/examples/context.rs
@@ -1,9 +1,9 @@
 use std::fs::read_to_string;
 use std::path::Path;
 
-use fn_error_context::error_context;
+use fn_error_context::context;
 
-#[error_context("failed to parse config at `{}`", path.as_ref().display())]
+#[context("failed to parse config at `{}`", path.as_ref().display())]
 pub fn parse_config(path: impl AsRef<Path>) -> anyhow::Result<u32> {
     let text = read_to_string(path.as_ref())?;
     Ok(text.parse()?)
diff --git a/src/lib.rs b/src/lib.rs
@@ -1,10 +1,12 @@
+// #![deny(missing_docs)]
+
 extern crate proc_macro;
 
 use proc_macro::TokenStream;
 use quote::quote;
 
 #[proc_macro_attribute]
-pub fn error_context(args: TokenStream, input: TokenStream) -> TokenStream {
+pub fn context(args: TokenStream, input: TokenStream) -> TokenStream {
     let args: proc_macro2::TokenStream = args.into();
     let mut input = syn::parse_macro_input!(input as syn::ItemFn);
 
diff --git a/tests/arg.rs b/tests/arg.rs
@@ -1,6 +1,6 @@
-use fn_error_context::error_context;
+use fn_error_context::context;
 
-#[error_context("context")]
+#[context("context")]
 fn do_stuff(arg: u32) -> anyhow::Result<()> {
     anyhow::bail!("error {}", arg)
 }
diff --git a/tests/arg_pattern.rs b/tests/arg_pattern.rs
@@ -1,6 +1,6 @@
-use fn_error_context::error_context;
+use fn_error_context::context;
 
-#[error_context("context")]
+#[context("context")]
 fn do_stuff((x, y): (i32, u32)) -> anyhow::Result<()> {
     anyhow::bail!("error {} {}", x, y)
 }
diff --git a/tests/as_ref.rs b/tests/as_ref.rs
@@ -1,6 +1,6 @@
-use fn_error_context::error_context;
+use fn_error_context::context;
 
-#[error_context("context {}", arg.as_ref())]
+#[context("context {}", arg.as_ref())]
 fn do_stuff(arg: impl AsRef<str>) -> anyhow::Result<()> {
     anyhow::bail!("error {}", arg.as_ref())
 }
diff --git a/tests/failure.rs b/tests/failure.rs
@@ -1,6 +1,6 @@
-use fn_error_context::error_context;
+use fn_error_context::context;
 
-#[error_context("context")]
+#[context("context")]
 fn do_stuff() -> failure::Fallible<()> {
     failure::bail!("error")
 }
diff --git a/tests/fmt_args.rs b/tests/fmt_args.rs
@@ -1,6 +1,6 @@
-use fn_error_context::error_context;
+use fn_error_context::context;
 
-#[error_context("context {}", arg)]
+#[context("context {}", arg)]
 fn do_stuff(arg: u32) -> anyhow::Result<()> {
     anyhow::bail!("error {}", arg)
 }
diff --git a/tests/fmt_missing_arg.rs b/tests/fmt_missing_arg.rs
@@ -1,6 +1,6 @@
-use fn_error_context::error_context;
+use fn_error_context::context;
 
-#[error_context("{}")]
+#[context("{}")]
 fn do_stuff() -> anyhow::Result<()> {
     anyhow::bail!("error")
 }
diff --git a/tests/fmt_missing_arg.stderr b/tests/fmt_missing_arg.stderr
@@ -1,5 +1,5 @@
 error: 1 positional argument in format string, but no arguments were given
- --> $DIR/fmt_missing_arg.rs:3:18
+ --> $DIR/fmt_missing_arg.rs:3:12
   |
-3 | #[error_context("{}")]
-  |                  ^^
+3 | #[context("{}")]
+  |            ^^
diff --git a/tests/fmt_named_arg.rs b/tests/fmt_named_arg.rs
@@ -1,6 +1,6 @@
-use fn_error_context::error_context;
+use fn_error_context::context;
 
-#[error_context("context {arg}", arg = arg)]
+#[context("context {arg}", arg = arg)]
 fn do_stuff(arg: u32) -> anyhow::Result<()> {
     anyhow::bail!("error {}", arg)
 }
diff --git a/tests/fmt_unused_arg.rs b/tests/fmt_unused_arg.rs
@@ -1,6 +1,6 @@
-use fn_error_context::error_context;
+use fn_error_context::context;
 
-#[error_context("context", 1)]
+#[context("context", 1)]
 fn do_stuff() -> anyhow::Result<()> {
     anyhow::bail!("error")
 }
diff --git a/tests/fmt_unused_arg.stderr b/tests/fmt_unused_arg.stderr
@@ -1,7 +1,7 @@
 error: argument never used
- --> $DIR/fmt_unused_arg.rs:3:28
+ --> $DIR/fmt_unused_arg.rs:3:22
   |
-3 | #[error_context("context", 1)]
-  |                 ---------  ^ argument never used
-  |                 |
-  |                 formatting specifier missing
+3 | #[context("context", 1)]
+  |           ---------  ^ argument never used
+  |           |
+  |           formatting specifier missing
diff --git a/tests/inherent.rs b/tests/inherent.rs
@@ -1,9 +1,9 @@
-use fn_error_context::error_context;
+use fn_error_context::context;
 
 struct Foo(u32);
 
 impl Foo {
-    #[error_context("context")]
+    #[context("context")]
     fn do_stuff(&self) -> anyhow::Result<()> {
         anyhow::bail!("error {}", self.0)
     }
diff --git a/tests/missing_fmt.rs b/tests/missing_fmt.rs
@@ -1,6 +1,6 @@
-use fn_error_context::error_context;
+use fn_error_context::context;
 
-#[error_context]
+#[context]
 fn do_stuff() -> anyhow::Result<()> {
     anyhow::bail!("error")
 }
diff --git a/tests/missing_fmt.stderr b/tests/missing_fmt.stderr
@@ -1,7 +1,7 @@
 error: requires at least a format string argument
  --> $DIR/missing_fmt.rs:3:1
   |
-3 | #[error_context]
-  | ^^^^^^^^^^^^^^^^
+3 | #[context]
+  | ^^^^^^^^^^
   |
   = note: this error originates in a macro outside of the current crate (in Nightly builds, run with -Z external-macro-backtrace for more info)
diff --git a/tests/non_copy_arg.rs b/tests/non_copy_arg.rs
@@ -1,6 +1,6 @@
-use fn_error_context::error_context;
+use fn_error_context::context;
 
-#[error_context("context")]
+#[context("context")]
 fn do_stuff(arg: String) -> anyhow::Result<()> {
     anyhow::bail!("error {}", arg)
 }
diff --git a/tests/non_copy_fmt_arg.rs b/tests/non_copy_fmt_arg.rs
@@ -1,6 +1,6 @@
-use fn_error_context::error_context;
+use fn_error_context::context;
 
-#[error_context("context {}", arg)]
+#[context("context {}", arg)]
 fn do_stuff(arg: String) -> anyhow::Result<()> {
     anyhow::bail!("error {}", arg)
 }
diff --git a/tests/simple.rs b/tests/simple.rs
@@ -1,6 +1,6 @@
-use fn_error_context::error_context;
+use fn_error_context::context;
 
-#[error_context("context")]
+#[context("context")]
 fn do_stuff() -> anyhow::Result<()> {
     anyhow::bail!("error")
 }

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`		`-use fn_error_context::error_context;`
	`1`	`+use fn_error_context::context;`
`2`	`2`
`3`		`-#[error_context("context")]`
	`3`	`+#[context("context")]`
`4`	`4`	`fn do_stuff(arg: u32) -> anyhow::Result<()> {`
`5`	`5`	`anyhow::bail!("error {}", arg)`
`6`	`6`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`error: 1 positional argument in format string, but no arguments were given`
`2`		`- --> $DIR/fmt_missing_arg.rs:3:18`
	`2`	`+ --> $DIR/fmt_missing_arg.rs:3:12`
`3`	`3`	`\|`
`4`		`-3 \| #[error_context("{}")]`
`5`		`- \| ^^`
	`4`	`+3 \| #[context("{}")]`
	`5`	`+ \| ^^`