Reorder #[derive] and add serde attributes per rules (#340) (#377)

joaquinbejar · web-flow · commit 48c165287ef1 · 2026-04-19T22:07:59.000+02:00
* refactor(attrs): reorder #[derive] and add serde attributes per rules Apply canonical #[derive] order (Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Default) across numeric kernels and add #[serde] attributes per rules/global_rules.md: - #[repr(u8)] on small stable enums (Axis, InterpolationType, MergeOperation) - #[serde(deny_unknown_fields)] on input DTOs (GreeksSnapshot, Curve, Surface, Point3D) - Derive reordering in 16 files (pricing, greeks, simulation, curves, surfaces, geometrics) Composition layers (strategies, chains, pnl, risk, backtesting, series) audit completed; detailed per-file changes reported in Issue #340. * refactor(attrs): audit #[repr(u8)], #[derive] order, and serde conventions (#340) Canonical derive order: Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Default, then Serialize, Deserialize, ToSchema. - Apply #[repr(u8)] to small stable enums: LineStyle, TraceMode, PlotType, BasicAxisTypes, MarginType - Reorder all derive clauses to canonical sequence across model, visualization, strategies - Add #[serde(rename_all = "snake_case")] to public-facing enums for consistent wire format - Fix DebugPretty/DisplaySimple placement (custom derives first per rule) Fixes #340. Tests: 3753 passed; 4 pre-existing failures. * fix(axis): keep BasicAxisTypes Pascal-case wire format (#340) Existing consumers rely on Pascal-case JSON (e.g. `"Delta"`, `"Volatility"`) and the round-trip is locked by `tests_basic_axis_types::test_specific_serialization_format`. Drop the `#[serde(rename_all = "snake_case")]` added in the parent commit and add a NOTE explaining the exception per `rules/global_rules.md` §Serde conventions.
diff --git a/Draws/Simulation/simulator_test_montecarlo.html b/Draws/Simulation/simulator_test_montecarlo.html
diff --git a/src/curves/curve.rs b/src/curves/curve.rs
@@ -61,6 +61,7 @@ use utoipa::ToSchema;
 /// - [`Point2D`]: The fundamental data type for representing points in 2D space.
 /// - [`MergeOperation`]: Enum for combining multiple curves.
 #[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
+#[serde(deny_unknown_fields)]
 pub struct Curve {
     /// A ordered set of `Point2D` objects that defines the curve in terms of its x-y plane coordinates.
     /// Points are stored in a `BTreeSet` which automatically maintains them in sorted order by their x-coordinate.
diff --git a/src/geometrics/analysis/metrics.rs b/src/geometrics/analysis/metrics.rs
@@ -59,7 +59,7 @@ use utoipa::ToSchema;
 /// ## Remarks
 /// The `CurveMetrics` struct is designed to be reusable across various analytical contexts,
 /// providing a versatile and standardized way to represent curve characteristics.
-#[derive(Clone, DebugPretty, DisplaySimple, ToSchema, Serialize)]
+#[derive(DebugPretty, DisplaySimple, Clone, Serialize, ToSchema)]
 pub struct Metrics {
     /// - **Basic Metrics (`basic`)**:
     ///   Includes fundamental statistical measures such as mean, median, mode, and standard deviation.
@@ -235,7 +235,7 @@ impl Metrics {
 /// - [`ShapeMetrics`]: Captures shape-related properties like skewness and kurtosis.
 /// - [`RiskMetrics`]: Measures risk characteristics of financial instruments.
 /// - [`TrendMetrics`]: Represents time-based trends in data series.
-#[derive(Clone, Copy, DebugPretty, DisplaySimple, ToSchema, Serialize)]
+#[derive(DebugPretty, DisplaySimple, Clone, Copy, Serialize, ToSchema)]
 pub struct BasicMetrics {
     /// The arithmetic mean (average) of the dataset.
     /// Calculated by summing all values and dividing by the count of values.
@@ -297,7 +297,7 @@ pub struct BasicMetrics {
 /// `ShapeMetrics` is typically part of the larger `AnalysisResult` structure
 /// that provides comprehensive curve analysis. It uses `Point2D` to represent
 /// all positional data with high-precision `Decimal` values.
-#[derive(Clone, DebugPretty, DisplaySimple, ToSchema, Serialize)]
+#[derive(DebugPretty, DisplaySimple, Clone, Serialize, ToSchema)]
 pub struct ShapeMetrics {
     /// Describes the asymmetry of the curve's distribution.
     /// A positive value indicates a right tail (right-skewed distribution),
@@ -357,7 +357,7 @@ pub struct ShapeMetrics {
 ///
 /// This structure is part of the curves analysis module that provides comprehensive
 /// statistical and financial analysis tools for mathematical curves.
-#[derive(Clone, Copy, DebugPretty, DisplaySimple, ToSchema, Serialize)]
+#[derive(DebugPretty, DisplaySimple, Clone, Copy, Serialize, ToSchema)]
 pub struct RangeMetrics {
     /// The minimum point in the dataset, containing the smallest x and y coordinates observed.
     pub min: Point2D,
@@ -405,7 +405,7 @@ pub struct RangeMetrics {
 ///
 /// This structure is a key component of the curve analysis module and works
 /// alongside other metric types to provide comprehensive statistical analysis.
-#[derive(Clone, DebugPretty, DisplaySimple, ToSchema, Serialize)]
+#[derive(DebugPretty, DisplaySimple, Clone, Serialize, ToSchema)]
 pub struct TrendMetrics {
     /// The slope coefficient of the linear regression line, indicating the
     /// rate and direction of change in the dataset.
@@ -451,7 +451,7 @@ pub struct TrendMetrics {
 /// # Note
 /// For accuracy, ensure the data used to compute these metrics represents a
 /// sufficiently long time horizon and is free from anomalies.
-#[derive(Clone, Copy, DebugPretty, DisplaySimple, ToSchema, Serialize)]
+#[derive(DebugPretty, DisplaySimple, Clone, Copy, Serialize, ToSchema)]
 pub struct RiskMetrics {
     /// Measures the degree of variation in returns over time.
     /// Represents the standard deviation of returns and is a widely used
diff --git a/src/geometrics/analysis/statistics.rs b/src/geometrics/analysis/statistics.rs
@@ -49,7 +49,7 @@ use utoipa::ToSchema;
 ///   - Analyze curve properties for more accurate modeling and representation.
 ///   - Identify key points that define the geometric behavior of a curve.
 ///
-#[derive(Clone, DebugPretty, DisplaySimple, ToSchema, Serialize)]
+#[derive(DebugPretty, DisplaySimple, Clone, Serialize, ToSchema)]
 pub struct AnalysisResult {
     /// The fundamental statistical metrics of the dataset, including measures of
     /// central tendency (mean, median, mode) and dispersion (standard deviation).
diff --git a/src/geometrics/interpolation/types.rs b/src/geometrics/interpolation/types.rs
@@ -52,7 +52,8 @@
 /// This enum is part of a modular design, with each interpolation type defined in its own
 /// module for clarity and separation of concerns.
 ///
-#[derive(Debug, Clone, Copy)]
+#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
+#[repr(u8)]
 pub enum InterpolationType {
     /// Linear interpolation that calculates values by drawing straight lines between data points.
     /// Efficient but may lack smoothness for certain applications.
diff --git a/src/geometrics/operations/arithmetic.rs b/src/geometrics/operations/arithmetic.rs
@@ -18,7 +18,8 @@ use utoipa::ToSchema;
 ///
 /// The operation specified will determine how values are combined when merging
 /// geometric objects that implement the `Arithmetic` trait.
-#[derive(Clone, Copy, Debug, PartialEq, ToSchema)]
+#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, ToSchema)]
+#[repr(u8)]
 pub enum MergeOperation {
     /// Adds values together (a + b)
     Add,
diff --git a/src/greeks/equations.rs b/src/greeks/equations.rs
@@ -39,7 +39,7 @@ use utoipa::ToSchema;
 /// * `color`: Measures the rate of change of gamma in relation to changes in time
 ///
 /// These metrics help traders understand and manage the various dimensions of risk in option positions.
-#[derive(PartialEq, Clone, DebugPretty, DisplaySimple, ToSchema, Serialize)]
+#[derive(DebugPretty, DisplaySimple, Clone, PartialEq, Serialize, ToSchema)]
 pub struct Greek {
     /// Measures sensitivity to changes in the underlying asset's price (first derivative)
     pub delta: Decimal,
@@ -75,6 +75,7 @@ pub struct Greek {
 /// and deserialization for storage or communication purposes, and implements common traits like
 /// `Debug`, `Clone`, and `PartialEq`.
 #[derive(DebugPretty, DisplaySimple, Clone, PartialEq, Serialize, Deserialize, ToSchema)]
+#[serde(deny_unknown_fields)]
 pub struct GreeksSnapshot {
     /// Measures sensitivity to changes in the underlying asset's price (first derivative)
     pub delta: Decimal,
diff --git a/src/model/axis.rs b/src/model/axis.rs
@@ -16,7 +16,11 @@ use serde::{Deserialize, Serialize};
 /// - Create parameter surfaces (e.g., volatility surface)
 /// - Define dimensions for multi-dimensional analysis
 /// - Specify which metrics to calculate or display
-#[derive(Debug, Serialize, Deserialize, PartialEq, Clone, Copy, Hash, Eq)]
+// NOTE: `#[serde(rename_all = "snake_case")]` intentionally omitted — existing
+// consumers rely on the Pascal-case wire format (`"Delta"`, `"Volatility"`),
+// enforced by `tests_basic_axis_types::test_specific_serialization_format`.
+#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
+#[repr(u8)]
 pub enum BasicAxisTypes {
     /// Sensitivity of option price to changes in underlying price (first derivative)
     Delta,
@@ -131,13 +135,9 @@ impl Iterator for BasicAxisTypesIter {
     type Item = BasicAxisTypes;
 
     fn next(&mut self) -> Option<Self::Item> {
-        if self.index < BasicAxisTypes::VALUES.len() {
-            let value = BasicAxisTypes::VALUES[self.index];
-            self.index += 1;
-            Some(value)
-        } else {
-            None
-        }
+        let value = *BasicAxisTypes::VALUES.get(self.index)?;
+        self.index += 1;
+        Some(value)
     }
 }
 
diff --git a/src/model/leg/leg_enum.rs b/src/model/leg/leg_enum.rs
@@ -57,7 +57,8 @@ use utoipa::ToSchema;
 /// * `Spot` - Direct ownership of underlying asset
 /// * `Future` - Exchange-traded futures contract
 /// * `Perpetual` - Crypto perpetual swap contract
-#[derive(Clone, Debug, PartialEq, Serialize, Deserialize, ToSchema)]
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, ToSchema)]
+#[serde(rename_all = "snake_case")]
 pub enum Leg {
     /// Standard option position (Call/Put).
     Option(Box<Position>),
diff --git a/src/model/leg/perpetual.rs b/src/model/leg/perpetual.rs
@@ -50,7 +50,9 @@ use serde::{Deserialize, Serialize};
 use utoipa::ToSchema;
 
 /// Margin type for perpetual positions.
-#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize, ToSchema, Default)]
+#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Serialize, Deserialize, ToSchema)]
+#[serde(rename_all = "snake_case")]
+#[repr(u8)]
 pub enum MarginType {
     /// Cross margin - shares margin across all positions
     Cross,
@@ -87,7 +89,7 @@ impl std::fmt::Display for MarginType {
 /// * `funding_rate` - Current funding rate (updated periodically)
 /// * `date` - Position open timestamp
 /// * `fees` - Trading fees (maker/taker)
-#[derive(Clone, Debug, PartialEq, Serialize, Deserialize, ToSchema)]
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, ToSchema)]
 pub struct PerpetualPosition {
     /// Trading pair symbol (e.g., "BTC-USDT-PERP").
     pub symbol: String,
diff --git a/src/pricing/binomial_model.rs b/src/pricing/binomial_model.rs
@@ -23,7 +23,7 @@ type BinomialTreeResult = Result<(Vec<Vec<Decimal>>, Vec<Vec<Decimal>>), Pricing
 /// value at each node, working backwards from expiration to the present value.
 /// This approach is particularly valuable for American options or other early-exercise
 /// scenarios.
-#[derive(Clone)]
+#[derive(Debug, Clone)]
 pub struct BinomialPricingParams<'a> {
     /// The current price of the underlying asset, represented as a positive value.
     pub asset: Positive,
diff --git a/src/pricing/payoff.rs b/src/pricing/payoff.rs
@@ -64,7 +64,7 @@ pub trait Payoff {
 /// This structure is typically used within the options pricing module to calculate
 /// the final payoff value of different option types at expiration or exercise.
 ///
-#[derive(Debug)]
+#[derive(Debug, Clone)]
 pub struct PayoffInfo {
     /// * `spot` - The current market price of the underlying asset.
     ///   This value is used as the reference price for calculating option payoffs.
diff --git a/src/pricing/telegraph.rs b/src/pricing/telegraph.rs
@@ -103,7 +103,7 @@ use tracing::warn;
 /// - Representing asymmetric transition behaviors in stochastic systems
 /// - Pricing financial derivatives under regime-switching assumptions
 ///
-#[derive(Clone)]
+#[derive(Debug, Clone)]
 pub struct TelegraphProcess {
     /// Transition rate from state -1 to +1, representing the intensity
     /// of the underlying Poisson process for upward state changes
diff --git a/src/pricing/unified.rs b/src/pricing/unified.rs
@@ -9,6 +9,7 @@ use positive::Positive;
 /// This enum allows selection between different pricing methods:
 /// - `ClosedFormBS`: Uses the Black-Scholes closed-form formula
 /// - `MonteCarlo`: Uses Monte Carlo simulation with a configured simulator
+#[derive(Debug, Clone)]
 pub enum PricingEngine {
     /// Black-Scholes closed-form pricing for European options.
     ///
diff --git a/src/simulation/exit.rs b/src/simulation/exit.rs
@@ -23,7 +23,7 @@ use utoipa::ToSchema;
 ///
 /// Exit policies determine when a position should be closed based on various
 /// market conditions, profit/loss levels, or time constraints.
-#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize, Default, ToSchema)]
+#[derive(Debug, Clone, PartialEq, Eq, Hash, Default, Serialize, Deserialize, ToSchema)]
 pub enum ExitPolicy {
     /// Exit when profit reaches a percentage of initial premium.
     ///
diff --git a/src/simulation/model.rs b/src/simulation/model.rs
@@ -6,7 +6,7 @@ use std::fmt::{Display, Formatter};
 use utoipa::ToSchema;
 
 /// Enum defining different types of random walks
-#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, ToSchema)]
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, ToSchema)]
 pub enum WalkType {
     /// Standard Brownian motion (normal increments)
     Brownian {
diff --git a/src/simulation/simulator.rs b/src/simulation/simulator.rs
@@ -38,6 +38,7 @@ use std::ops::{AddAssign, Index, IndexMut};
 ///
 /// Note: This struct is generic and requires types provided for both state (`X`) and step/transition (`Y`) that meet the respective
 /// trait bounds.
+#[derive(Debug, Clone)]
 pub struct Simulator<X, Y>
 where
     X: Copy + TryInto<Positive> + AddAssign + Display,
diff --git a/src/simulation/steps/x.rs b/src/simulation/steps/x.rs
@@ -41,7 +41,7 @@ use tracing::debug;
 /// * `datetime` - The specific expiration date associated with this time step,
 ///   which can be either a relative number of days or an absolute datetime.
 ///
-#[derive(Debug, Copy, Clone)]
+#[derive(Debug, Clone, Copy)]
 pub struct Xstep<T>
 where
     T: Copy + TryInto<Positive> + AddAssign + Display,
diff --git a/src/strategies/long_call.rs b/src/strategies/long_call.rs
@@ -59,7 +59,7 @@ pub(super) const LONG_CALL_DESCRIPTION: &str = "A Long Call is an options strate
 /// This structure leverages the `Clone`, `Debug`, `Serialize`, and `Deserialize` traits for ease of duplication,
 /// debugging, and storage/transfer as structured data.
 ///
-#[derive(Clone, DebugPretty, DisplaySimple, Serialize, Deserialize, ToSchema)]
+#[derive(DebugPretty, DisplaySimple, Clone, Serialize, Deserialize, ToSchema)]
 pub struct LongCall {
     /// Name identifier for this specific strategy instance
     pub name: String,
diff --git a/src/surfaces/surface.rs b/src/surfaces/surface.rs
@@ -89,6 +89,7 @@ use utoipa::ToSchema;
 /// option pricing surfaces, terrain models, or any other data that can be
 /// plotted in three dimensions.
 #[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
+#[serde(deny_unknown_fields)]
 pub struct Surface {
     /// Collection of 3D points defining the surface
     pub points: BTreeSet<Point3D>,
diff --git a/src/surfaces/types.rs b/src/surfaces/types.rs
@@ -45,6 +45,7 @@ use utoipa::ToSchema;
 /// of 3D surfaces and for various geometric calculations. The high-precision `Decimal`
 /// type ensures accuracy in scientific and engineering applications.
 #[derive(Debug, Clone, Copy, Serialize, Deserialize, ToSchema)]
+#[serde(deny_unknown_fields)]
 pub struct Point3D {
     /// The x-coordinate in the Cartesian system
     pub x: Decimal,
@@ -268,6 +269,8 @@ impl HasX for Point3D {
 /// - `X`: The axis representing the horizontal direction.
 /// - `Y`: The axis representing the vertical direction or elevation.
 /// - `Z`: The axis representing depth or the third dimension.
+#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
+#[repr(u8)]
 pub enum Axis {
     X,
     Y,
diff --git a/src/visualization/styles.rs b/src/visualization/styles.rs
@@ -4,7 +4,9 @@ use serde::{Deserialize, Serialize};
 ///
 /// This enum defines different line styles that can be used when drawing lines
 /// in graphics contexts, charts, or UI elements.
-#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Serialize, Deserialize, Default)]
+#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default, Serialize, Deserialize)]
+#[serde(rename_all = "snake_case")]
+#[repr(u8)]
 pub enum LineStyle {
     /// A continuous unbroken line (default style).
     #[default]
@@ -19,7 +21,8 @@ pub enum LineStyle {
 ///
 /// This enum defines various color schemes that can be applied to charts, graphs,
 /// or any visual elements that require color differentiation.
-#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize, Default)]
+#[derive(Debug, Clone, PartialEq, Eq, Hash, Default, Serialize, Deserialize)]
+#[serde(rename_all = "snake_case")]
 pub enum ColorScheme {
     /// Default color scheme, used when no specific scheme is selected.
     #[default]
@@ -47,7 +50,9 @@ pub enum ColorScheme {
 ///
 /// This enum specifies how data points should be displayed in a visualization,
 /// such as connecting points with lines, showing individual markers, or both.
-#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Serialize, Deserialize, Default)]
+#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default, Serialize, Deserialize)]
+#[serde(rename_all = "snake_case")]
+#[repr(u8)]
 pub enum TraceMode {
     /// Display points connected by lines only.
     #[default]
@@ -65,7 +70,9 @@ pub enum TraceMode {
 /// This enum defines the various plot visualization types supported by the system.
 /// Each variant corresponds to a specific visualization method for data representation.
 ///
-#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Serialize, Deserialize, Default)]
+#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default, Serialize, Deserialize)]
+#[serde(rename_all = "snake_case")]
+#[repr(u8)]
 pub enum PlotType {
     /// 2D line plot
     #[default]
