migratex 0.2.2

Agnostic migration toolkit library.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102

// This file is part of "Migratex - A Migrations Toolkit".
//
// This source code is licensed under the MIT license, please view the LICENSE
// file distributed with this source code. For the full
// information and documentation: https://github.com/nicolab/migratex
// -----------------------------------------------------------------------------

#[cfg(feature = "json")]
use serde;

/// The status of a migration.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[cfg_attr(feature = "json", derive(serde::Serialize, serde::Deserialize))]
pub enum MetaStatus {
    Clean,
    Migrating,
    Failed,
}

impl Default for MetaStatus {
    fn default() -> Self {
        Self::Clean
    }
}

pub trait Metadata {
    //
    // -- CORE: logical fields
    //

    /// Migration version.
    fn version(&self) -> i32;
    fn version_mut(&mut self) -> &mut i32;

    /// Application version.
    /// By default, it is the project `package.version` field (Cargo).
    fn app_version(&self) -> &str;
    fn app_version_mut(&mut self) -> &mut String;

    /// Migration status.
    fn status(&self) -> MetaStatus;
    fn status_mut(&mut self) -> &mut MetaStatus;

    /// Creation date (first usage).
    fn created_at(&self) -> &str;
    fn created_at_mut(&mut self) -> &mut String;

    /// Last update date.
    fn updated_at(&self) -> &str;
    fn updated_at_mut(&mut self) -> &mut String;

    //
    // -- Helpers (with default implementations)
    //

    /// Get the status as a string.
    fn to_status_str(&self) -> &str {
        match self.status() {
            MetaStatus::Clean => "Clean",
            MetaStatus::Migrating => "Migrating",
            MetaStatus::Failed => "Failed",
        }
    }

    /// Update `updated_at` with current time.
    fn touch_updated(&mut self) {
        *self.updated_at_mut() = chrono::Utc::now().to_rfc3339();
    }

    /// Set the version and update `updated_at`.
    fn set_version(&mut self, v: i32) {
        *self.version_mut() = v;
        self.touch_updated();
    }

    /// Set the app_version and update `updated_at`.
    fn set_app_version(&mut self, v: String) {
        *self.app_version_mut() = v;
        self.touch_updated();
    }

    /// Set the status and update `updated_at`.
    fn set_status(&mut self, s: MetaStatus) {
        *self.status_mut() = s;
        self.touch_updated();
    }

    /// Set the status to `Clean` and update `updated_at`.
    fn mark_clean(&mut self) {
        self.set_status(MetaStatus::Clean);
    }

    /// Set the status to `Migrating` and update `updated_at`.
    fn mark_migrating(&mut self) {
        self.set_status(MetaStatus::Migrating);
    }

    /// Set the status to `Failed` and update `updated_at`.
    fn mark_failed(&mut self) {
        self.set_status(MetaStatus::Failed);
    }
}