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

// Copyright (c) 2021-2022 Miguel Barreto and others
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

//! This module defines [CreateDirective].
extern crate strict_yaml_rust;

use crate::create::action::CreateAction;
use crate::filesystem::FileSystemDirective;
use dotfiles_core::action::ActionParser;
use dotfiles_core::action::SKIP_IN_CI_SETTING;
use dotfiles_core::directive::DirectiveData;
use dotfiles_core::directive::HasDirectiveData;
use dotfiles_core::error::DotfilesError;
use dotfiles_core::settings::initialize_settings_object;
use dotfiles_core::settings::Setting;
use dotfiles_core::yaml_util;
use dotfiles_core_macros::Directive;
use filesystem::FakeFileSystem;
use filesystem::FileSystem;
use filesystem::OsFileSystem;
use std::marker::PhantomData;
use std::path::Path;

use strict_yaml_rust::StrictYaml;

/// Constant for the name of the `create` directive.
pub const DIRECTIVE_NAME: &str = "create";
/// Constant for the name of the [`create_parent_dirs`](CreateAction::create_parent_dirs) Setting
/// which forces to create all parent directories if necessary.
pub const CREATE_PARENT_DIRS_SETTING: &str = "create_parent_dirs";
/// Constant for the name of the [`directory`](CreateAction::directory) argument that contains the
/// name of the directory to create
pub const DIR_SETTING: &str = "dir";

/// Initializes the default configuration for the [CreateDirective]
pub fn init_directive_data() -> DirectiveData {
  DirectiveData::from(
    DIRECTIVE_NAME.into(),
    initialize_settings_object(&[
      (
        CREATE_PARENT_DIRS_SETTING.to_owned(),
        Setting::Boolean(false),
      ),
      (SKIP_IN_CI_SETTING.to_owned(), Setting::Boolean(false)),
    ]),
  )
}

/// A directive that can build [CreateAction]s to create directories in the filesystem.
#[derive(Directive, Clone)]
pub struct CreateDirective<'a, F: FileSystem + Default> {
  fs: F,
  data: DirectiveData,
  phantom: PhantomData<&'a F>,
}
/// [CreateDirective] that uses the native [OsFileSystem].
pub type NativeCreateDirective<'a> = CreateDirective<'a, OsFileSystem>;
/// [CreateDirective] that uses the native [FakeFileSystem] for testing.
pub type FakeCreateDirective<'a> = CreateDirective<'a, FakeFileSystem>;

impl<'a, F: FileSystem + Default> FileSystemDirective<'a, F> for CreateDirective<'a, F> {
  fn fs(&self) -> &F {
    &self.fs
  }

  fn mut_fs(&mut self) -> &mut F {
    &mut self.fs
  }
}

impl<'a, F: FileSystem + Default> Default for CreateDirective<'a, F> {
  fn default() -> Self {
    Self {
      fs: Default::default(),
      data: init_directive_data(),
      phantom: Default::default(),
    }
  }
}

impl<'a, F: FileSystem + Default> ActionParser<'a> for CreateDirective<'a, F> {
  type ActionType = CreateAction<'a, F>;

  fn parse_action(
    &'a self,
    settings: &std::collections::HashMap<String, Setting>,
    yaml: &StrictYaml,
    current_dir: &Path,
  ) -> Result<CreateAction<F>, DotfilesError> {
    CreateAction::<'a, F>::new(
      self.fs(),
      yaml_util::get_boolean_setting_from_yaml_or_context(
        SKIP_IN_CI_SETTING,
        yaml,
        settings,
        self.defaults(),
      )?,
      yaml_util::get_string_content_or_keyed_value(yaml, Some(DIR_SETTING))?,
      yaml_util::get_boolean_setting_from_yaml_or_context(
        CREATE_PARENT_DIRS_SETTING,
        yaml,
        settings,
        self.defaults(),
      )?,
      current_dir.to_owned(),
    )
  }
}