thot-local 0.10.0-intermediate

Local functionality for Thot data management and analysis software.
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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177

//! Project and project settings.
use crate::common::{project_file_of, project_settings_file_of};
use crate::result::Result;
use crate::system::settings::user_settings::UserSettings;
use cluFlock::FlockLock;
use serde::{Deserialize, Serialize};
use settings_manager::local_settings::{LocalSettings, LockSettingsFile};
use settings_manager::result::{
    Error as SettingsError, LocalSettingsError, Result as SettingsResult,
};
use settings_manager::settings::Settings;
use settings_manager::system_settings::SystemSettings;
use settings_manager::types::Priority as SettingsPriority;
use std::fs::File;
use std::path::{Path, PathBuf};
use thot_core::project::Project as CoreProject;
use thot_core::types::{Creator, UserId, UserPermissions};

// ***************
// *** Project ***
// ***************

/// Represents a Thot project.
#[derive(Serialize, Deserialize, Debug)]
pub struct Project {
    #[serde(skip)]
    _file_lock: Option<FlockLock<File>>,

    #[serde(skip)]
    _base_path: Option<PathBuf>,

    pub properties: CoreProject,
}

impl Project {
    /// Creates a new Project.
    pub fn new(name: &str) -> Result<Self> {
        // get active user
        let settings = UserSettings::load()?;
        let creator = match settings.active_user {
            None => None,
            Some(uid) => Some(UserId::Id(uid)),
        };
        let creator = Creator::User(creator);

        let mut properties = CoreProject::new(name);
        properties.creator = creator;

        Ok(Project {
            _file_lock: None,
            _base_path: None,
            properties,
        })
    }
}

impl Default for Project {
    fn default() -> Self {
        // attempt to create new project
        let new_prj = Project::new("");
        if let Ok(prj) = new_prj {
            return prj;
        }

        // if fail, create manually
        Project {
            _file_lock: None,
            _base_path: None,
            properties: CoreProject::default(),
        }
    }
}

impl Settings for Project {
    fn store_lock(&mut self, lock: FlockLock<File>) {
        self._file_lock = Some(lock);
    }

    fn controls_file(&self) -> bool {
        self._file_lock.is_some()
    }

    fn priority(&self) -> SettingsPriority {
        SettingsPriority::Project
    }
}

impl LocalSettings for Project {
    fn rel_path() -> SettingsResult<PathBuf> {
        Ok(project_file_of(Path::new("")))
    }

    fn base_path(&self) -> SettingsResult<PathBuf> {
        self._base_path
            .clone()
            .ok_or(SettingsError::LocalSettingsError(
                LocalSettingsError::PathNotSet,
            ))
    }

    fn set_base_path(&mut self, path: PathBuf) -> SettingsResult {
        self._base_path = Some(path);
        Ok(())
    }
}

impl LockSettingsFile for Project {}

// ************************
// *** Project Settings ***
// ************************

/// Settings for a Thot project.
///
/// # Fields
#[derive(Serialize, Deserialize, Default, Debug)]
pub struct ProjectSettings {
    #[serde(skip)]
    _file_lock: Option<FlockLock<File>>,

    #[serde(skip)]
    _base_path: Option<PathBuf>,

    permissions: Vec<UserPermissions>,
}

impl ProjectSettings {
    /// Creates a new project settings.
    pub fn new() -> Self {
        ProjectSettings {
            _file_lock: None,
            _base_path: None,

            permissions: Vec::new(),
        }
    }
}

impl Settings for ProjectSettings {
    fn store_lock(&mut self, lock: FlockLock<File>) {
        self._file_lock = Some(lock);
    }

    fn controls_file(&self) -> bool {
        self._file_lock.is_some()
    }

    fn priority(&self) -> SettingsPriority {
        SettingsPriority::Project
    }
}

impl LocalSettings for ProjectSettings {
    fn rel_path() -> SettingsResult<PathBuf> {
        Ok(project_settings_file_of(Path::new("")))
    }

    fn base_path(&self) -> SettingsResult<PathBuf> {
        match self._base_path.clone() {
            Some(path) => Ok(path),
            None => Err(SettingsError::LocalSettingsError(
                LocalSettingsError::PathNotSet,
            )),
        }
    }

    fn set_base_path(&mut self, path: PathBuf) -> SettingsResult {
        self._base_path = Some(path);
        Ok(())
    }
}

impl LockSettingsFile for ProjectSettings {}

#[cfg(test)]
#[path = "./project_test.rs"]
mod project_test;