Rename numeric attribute to auto_operators; doc cleanups (#31)

README.md

@@ -13,12 +13,15 @@ println!("{}", timestamp); // Timestamp(1701620628123456789)
 
 ## Features
 
-- Derive trait:
-  - `StrongType`: Create a named strong type. The macro automatically implement common traits like `Clone`, `Debug`, `Default`, `PartialEq`, `PartialOrd`, `Send`, `Sync`, and `Display` (unless the `custom_display` attribute is used to override it). Additionally, depending on the underlying data type, strong-typed structs may also implement `Copy`, `Eq`, `Ord`, `Hash`. For example, if the underlying type is a primitive data type like `i32` or `bool`, these additional traits will be implemented. This allows the strong types to inherit useful behaviors from their underlying types, while still maintaining their distinct identity at the type level.
+- **Derive trait:**
+  - `StrongType`: Create a named strong type. 
+     - The macro automatically implement common traits like `Clone`, `Debug`, `Default`, `PartialEq`, `PartialOrd`, `Send`, and `Sync`. It also implements `Display` by default, unless overridden by the custom_display attribute. 
+     - Conditionally, based on the underlying data type, traits like `Copy`, `Eq`, `Ord`, `Hash` may also be implemented. For primitive data types like `i32` or `bool`, these additional traits will be automatically included.
+     - Numeric types (integer and floating-point) additionally implement methods like `min()`, `max()`, and, for floating-point types, `nan()`.
 
-- Attributes:
-  - `numeric`: Extend `StrongType` with arithmetic/logical operations.
-  - `custom_display`: Provides flexibility for users to manually implement `Display` instead of using the default display format.
+- **Attributes:**
+  - `auto_operators`: Automatically implements relevant arithmetic (for numeric types) or logical (for boolean types) operators.
+  - `custom_display`: Allows users to manually implement the `Display` trait, providing an alternative to the default display format.
 
 ## Installation
 Add `strong-type` to your `Cargo.toml`:
@@ -87,7 +90,7 @@ assert_eq!(map.len(), 2);
 use strong_type::StrongType;
 
 #[derive(StrongType)]
-#[numeric]
+#[auto_operators]
 struct Second(i32);
 
 let x = Second::new(2);
@@ -108,7 +111,7 @@ assert_eq!(x + y, Second(5));
 use strong_type::StrongType;
 
 #[derive(StrongType)]
-#[numeric]
+#[auto_operators]
 struct IsTrue(bool);
 
 let x = IsTrue::new(true);

strong-type-derive/src/detail/mod.rs

@@ -22,4 +22,4 @@ pub(crate) use min_max::implement_min_max;
 pub(crate) use nan::implement_nan;
 pub(crate) use negate::implement_negate;
 pub(crate) use underlying_type::{get_type_group, get_type_ident, UnderlyingTypeGroup};
-pub(crate) use utils::{has_custom_display, has_numeric};
+pub(crate) use utils::{has_auto_operators, has_custom_display};

strong-type-derive/src/detail/utils.rs

@@ -1,10 +1,10 @@
 use syn::DeriveInput;
 
-pub(crate) fn has_numeric(input: &DeriveInput) -> bool {
+pub(crate) fn has_auto_operators(input: &DeriveInput) -> bool {
     input
         .attrs
         .iter()
-        .any(|attr| attr.path().is_ident("numeric"))
+        .any(|attr| attr.path().is_ident("auto_operators"))
 }
 
 pub(crate) fn has_custom_display(input: &DeriveInput) -> bool {

strong-type-derive/src/lib.rs

@@ -6,7 +6,7 @@ use syn::{parse_macro_input, DeriveInput};
 
 use crate::strong_type::expand_strong_type;
 
-#[proc_macro_derive(StrongType, attributes(numeric, custom_display))]
+#[proc_macro_derive(StrongType, attributes(auto_operators, custom_display))]
 pub fn strong_type(input: TokenStream) -> TokenStream {
     let input = parse_macro_input!(input as DeriveInput);
     expand_strong_type(input).into()

strong-type-derive/src/strong_type.rs

@@ -1,5 +1,5 @@
 use crate::detail::{
-    get_type_group, get_type_ident, has_custom_display, has_numeric, implement_arithmetic,
+    get_type_group, get_type_ident, has_auto_operators, has_custom_display, implement_arithmetic,
     implement_basic, implement_basic_primitive, implement_basic_string, implement_bool_ops,
     implement_display, implement_hash, implement_min_max, implement_nan, implement_negate,
     UnderlyingTypeGroup,
@@ -61,7 +61,7 @@ pub(super) fn expand_strong_type(input: DeriveInput) -> TokenStream {
         }
     }
 
-    if has_numeric(&input) {
+    if has_auto_operators(&input) {
         match &group {
             UnderlyingTypeGroup::Int | UnderlyingTypeGroup::Float => {
                 ast.extend(implement_arithmetic(name));
@@ -73,7 +73,7 @@ pub(super) fn expand_strong_type(input: DeriveInput) -> TokenStream {
             UnderlyingTypeGroup::Bool => {
                 ast.extend(implement_bool_ops(name));
             }
-            _ => panic!("Non-numeric type: {value_type}"),
+            _ => {}
         }
     }
 

strong-type-tests/tests/numeric.rs → strong-type-tests/tests/auto_operators.rs

@@ -5,7 +5,7 @@ mod tests {
     #[test]
     fn test_int_arithmetic() {
         #[derive(StrongType)]
-        #[numeric]
+        #[auto_operators]
         struct Second(i32);
 
         let x = Second::new(2);
@@ -104,7 +104,7 @@ mod tests {
     #[test]
     fn test_float_arithmetic() {
         #[derive(StrongType)]
-        #[numeric]
+        #[auto_operators]
         struct Second(f64);
 
         let x = Second::new(2.0);
@@ -168,7 +168,7 @@ mod tests {
     #[test]
     fn test_bool_ops() {
         #[derive(StrongType)]
-        #[numeric]
+        #[auto_operators]
         struct IsTrue(bool);
 
         let x = IsTrue::new(true);

strong-type-tests/tests/tests.rs

@@ -1,3 +1,3 @@
+mod auto_operators;
 mod display;
-mod numeric;
 mod strong_type;