backbone-bucket 0.4.0

Bucket Bounded Context: File Storage Module for Backbone Framework
Documentation
//! State machine for UserQuota workflow
//!
//! Generated by metaphor-schema

use serde::{Deserialize, Serialize};
use std::str::FromStr;

/// States for UserQuota workflow
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum UserQuotaState {
    /// Initial state
    /// Final state
    Normal,
    /// Final state
    Exceeded,
}

impl Default for UserQuotaState {
    fn default() -> Self {
        Self::Normal
    }
}

impl std::fmt::Display for UserQuotaState {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::Normal => write!(f, "normal"),
            Self::Exceeded => write!(f, "exceeded"),
        }
    }
}

impl FromStr for UserQuotaState {
    type Err = StateMachineError;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s.to_lowercase().as_str() {
            "normal" => Ok(Self::Normal),
            "exceeded" => Ok(Self::Exceeded),
            _ => Err(StateMachineError::InvalidState(s.to_string())),
        }
    }
}

impl UserQuotaState {
    /// Check if this is the initial state
    pub fn is_initial(&self) -> bool {
        matches!(self, Self::Normal)
    }

    /// Check if this is a final state
    pub fn is_final(&self) -> bool {
        matches!(self, Self::Normal | Self::Exceeded)
    }

    /// Get all possible states
    pub fn all() -> Vec<Self> {
        vec![
            Self::Normal,
            Self::Exceeded,
        ]
    }
}

/// Transitions for UserQuota workflow
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum UserQuotaTransition {
    /// normal -> exceeded
    Exceed,
    /// exceeded -> normal
    Restore,
}

impl std::fmt::Display for UserQuotaTransition {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::Exceed => write!(f, "exceed"),
            Self::Restore => write!(f, "restore"),
        }
    }
}

impl FromStr for UserQuotaTransition {
    type Err = StateMachineError;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s.to_lowercase().as_str() {
            "exceed" => Ok(Self::Exceed),
            "restore" => Ok(Self::Restore),
            _ => Err(StateMachineError::InvalidTransition(s.to_string())),
        }
    }
}

impl UserQuotaTransition {
    /// Get the target state of this transition
    pub fn target_state(&self) -> UserQuotaState {
        match self {
            Self::Exceed => UserQuotaState::Exceeded,
            Self::Restore => UserQuotaState::Normal,
        }
    }

    /// Get all transitions
    pub fn all() -> Vec<Self> {
        vec![
            Self::Exceed,
            Self::Restore,
        ]
    }

    /// Get allowed roles for this transition
    pub fn allowed_roles(&self) -> &'static [&'static str] {
        match self {
            Self::Exceed => &["system"],
            Self::Restore => &["system"],
        }
    }
}

use super::StateMachineError;

/// State machine for UserQuota workflow
#[derive(Debug, Clone)]
pub struct UserQuotaStateMachine {
    current_state: UserQuotaState,
}

impl UserQuotaStateMachine {
    /// Create a new state machine with initial state
    pub fn new() -> Self {
        Self {
            current_state: UserQuotaState::default(),
        }
    }

    /// Create from an existing state
    pub fn from_state(state: UserQuotaState) -> Self {
        Self { current_state: state }
    }

    /// Get the current state
    pub fn current_state(&self) -> UserQuotaState {
        self.current_state
    }

    /// Check if a transition is allowed from the current state
    pub fn can_transition(&self, transition: UserQuotaTransition) -> bool {
        match (self.current_state, transition) {
            (UserQuotaState::Normal, UserQuotaTransition::Exceed) => true,
            (UserQuotaState::Exceeded, UserQuotaTransition::Restore) => true,
            _ => false,
        }
    }

    /// Check if a transition is allowed for a given role
    pub fn can_transition_with_role(&self, transition: UserQuotaTransition, role: &str) -> bool {
        if !self.can_transition(transition) {
            return false;
        }

        let allowed_roles = transition.allowed_roles();
        if allowed_roles.is_empty() {
            return true; // No role restriction
        }

        allowed_roles.iter().any(|r| *r == role || *r == "*")
    }

    /// Apply a transition, returning the new state
    pub fn transition(&mut self, transition: UserQuotaTransition) -> Result<UserQuotaState, StateMachineError> {
        if !self.can_transition(transition) {
            return Err(StateMachineError::TransitionNotAllowed {
                transition: transition.to_string(),
                from: self.current_state.to_string(),
            });
        }

        self.current_state = transition.target_state();
        Ok(self.current_state)
    }

    /// Apply a transition with role check
    pub fn transition_with_role(&mut self, transition: UserQuotaTransition, role: &str) -> Result<UserQuotaState, StateMachineError> {
        // Check basic transition validity first
        if !self.can_transition(transition) {
            return Err(StateMachineError::TransitionNotAllowed {
                transition: transition.to_string(),
                from: self.current_state.to_string(),
            });
        }

        // Check role authorization
        if !self.can_transition_with_role(transition, role) {
            return Err(StateMachineError::RoleNotAuthorized {
                role: role.to_string(),
                transition: transition.to_string(),
            });
        }

        self.current_state = transition.target_state();
        Ok(self.current_state)
    }

    /// Get all available transitions from the current state
    pub fn available_transitions(&self) -> Vec<UserQuotaTransition> {
        UserQuotaTransition::all()
            .into_iter()
            .filter(|t| self.can_transition(*t))
            .collect()
    }

    /// Get all available transitions for a given role
    pub fn available_transitions_for_role(&self, role: &str) -> Vec<UserQuotaTransition> {
        UserQuotaTransition::all()
            .into_iter()
            .filter(|t| self.can_transition_with_role(*t, role))
            .collect()
    }

    /// Attempt to transition directly to a target state.
    ///
    /// Finds any transition that leads to the target state and applies it.
    /// Returns Err if no valid transition leads from current state to target.
    pub fn transition_to_state(&mut self, target: UserQuotaState) -> Result<UserQuotaState, StateMachineError> {
        let valid = UserQuotaTransition::all().into_iter()
            .filter(|t| self.can_transition(*t))
            .find(|t| t.target_state() == target);
        match valid {
            Some(t) => self.transition(t),
            None => Err(StateMachineError::TransitionNotAllowed {
                transition: target.to_string(),
                from: self.current_state.to_string(),
            }),
        }
    }
}

impl Default for UserQuotaStateMachine {
    fn default() -> Self {
        Self::new()
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_initial_state() {
        let sm = UserQuotaStateMachine::new();
        assert_eq!(sm.current_state(), UserQuotaState::Normal);
        assert!(sm.current_state().is_initial());
    }

    #[test]
    fn test_valid_transition() {
        let mut sm = UserQuotaStateMachine::from_state(UserQuotaState::Normal);
        assert!(sm.can_transition(UserQuotaTransition::Exceed));
        let result = sm.transition(UserQuotaTransition::Exceed);
        assert!(result.is_ok());
        assert_eq!(sm.current_state(), UserQuotaState::Exceeded);
    }

    #[test]
    fn test_invalid_transition() {
        let mut sm = UserQuotaStateMachine::from_state(UserQuotaState::Normal);
        // Restore is not valid from Normal state
        let result = sm.transition(UserQuotaTransition::Restore);
        assert!(result.is_err());
    }

    #[test]
    fn test_state_parsing() {
        let state: UserQuotaState = "normal".parse().unwrap();
        assert_eq!(state, UserQuotaState::Normal);
    }

    #[test]
    fn test_available_transitions() {
        let sm = UserQuotaStateMachine::new();
        let available = sm.available_transitions();
        // Should have at least some transitions available from initial state
        assert!(!available.is_empty() || sm.current_state().is_final());
    }
}