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
178
179
180
181
182
183
184
185
// 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 [BrewDirective].

extern crate strict_yaml_rust;

use crate::brew::action::BrewAction;
#[cfg(target_os = "macos")]
use crate::brew::action::MacAppStoreItem;
use dotfiles_core::action::ActionParser;
use dotfiles_core::action::SKIP_IN_CI_SETTING;
use dotfiles_core::directive::DirectiveData;
use dotfiles_core::error::add_directive_error_prefix;
use dotfiles_core::error::DotfilesError;
#[cfg(target_os = "macos")]
use dotfiles_core::error::ErrorType;
use dotfiles_core::settings::initialize_settings_object;
use dotfiles_core::settings::Setting;
use dotfiles_core::settings::Settings;
use dotfiles_core::yaml_util::*;
use dotfiles_core_macros::Directive;

use std::marker::PhantomData;
use std::path::Path;
use strict_yaml_rust::StrictYaml;

/// Name of the Brew directive
pub const DIRECTIVE_NAME: &str = "brew";
/// force casks
pub const FORCE_CASKS_SETTING: &str = "force_casks";
/// adopt casks to deal with previously installed apps
pub const ADOPT_CASKS_SETTING: &str = "adopt_casks";

/// The string that identifies the list of taps to install
pub const TAP_SETTING: &str = "tap";
/// The string that identifies the list of formulae to install
pub const FORMULA_SETTING: &str = "formula";
/// The string that identifies the list of casks to install
pub const CASK_SETTING: &str = "cask";

/// Initialize the defaults for the BrewDirective.
pub fn init_directive_data() -> DirectiveData {
  DirectiveData::from(
    DIRECTIVE_NAME.into(),
    initialize_settings_object(&[
      (FORCE_CASKS_SETTING.to_owned(), Setting::Boolean(false)),
      (ADOPT_CASKS_SETTING.to_owned(), Setting::Boolean(false)),
      (SKIP_IN_CI_SETTING.to_owned(), Setting::Boolean(false)),
    ]),
  )
}

/// A directive that can build [BrewAction]s to install formulae, casks
#[derive(Directive, Clone)]
pub struct BrewDirective<'a> {
  data: DirectiveData,
  phantom_data: PhantomData<&'a DirectiveData>,
}

impl<'a> Default for BrewDirective<'a> {
  fn default() -> BrewDirective<'a> {
    BrewDirective::<'a> {
      data: init_directive_data(),
      phantom_data: PhantomData,
    }
  }
}

impl<'a> ActionParser<'a> for BrewDirective<'a> {
  type ActionType = BrewAction<'a>;

  fn parse_action(
    &'a self,
    context_settings: &Settings,
    yaml: &StrictYaml,
    _: &Path,
  ) -> Result<BrewAction<'a>, DotfilesError> {
    let force_casks = get_boolean_setting_from_yaml_or_context(
      FORCE_CASKS_SETTING,
      yaml,
      context_settings,
      self.data.defaults(),
    )?;
    let adopt_casks = get_boolean_setting_from_yaml_or_context(
      ADOPT_CASKS_SETTING,
      yaml,
      context_settings,
      self.data.defaults(),
    )?;
    let skip_in_ci = get_boolean_setting_from_yaml_or_context(
      SKIP_IN_CI_SETTING,
      yaml,
      context_settings,
      self.data.defaults(),
    )?;
    let taps = get_optional_string_array_from_yaml_hash(TAP_SETTING, yaml)?;
    let formulae = get_optional_string_array_from_yaml_hash(FORMULA_SETTING, yaml)?;
    let casks = get_optional_string_array_from_yaml_hash(CASK_SETTING, yaml)?;
    #[cfg(target_os = "macos")]
    let mas_apps = process_value_from_yaml_hash("mas", yaml, |mas_yaml| {
      fold_hash_until_first_err(
        mas_yaml,
        Ok(Vec::<MacAppStoreItem>::new()),
        |key, val| {
          Ok((
            val
              .to_owned()
              .into_string()
              .ok_or(DotfilesError::from_wrong_yaml(
                "Mac App Store app ID is not a string as expected".into(),
                val.to_owned(),
                StrictYaml::String("".into()),
              ))
              .and_then(|id| {
                id.parse::<i64>().map_err(|_| {
                  DotfilesError::from(
                    format!("{id} is not a valid Mac App Store app id"),
                    ErrorType::InconsistentConfigurationError,
                  )
                })
              })?,
            key,
          ))
        },
        |mut list, item| {
          list.push(MacAppStoreItem::from(item));
          Ok(list)
        },
      )
    })
    .map_or_else(
      |err| {
        if err.is_missing_config("mas") {
          Ok(Vec::new())
        } else {
          Err(err)
        }
      },
      Ok,
    )?;

    Ok(BrewAction::new(
      skip_in_ci,
      force_casks,
      adopt_casks,
      taps,
      formulae,
      casks,
      #[cfg(target_os = "macos")]
      mas_apps,
    ))
  }

  /// Parse the list of actions from yaml, in this case it's only one action so
  /// this function only wraps [BrewDirective::parse_action]
  fn parse_action_list(
    &'a self,
    context_settings: &Settings,
    yaml: &StrictYaml,
    current_dir: &Path,
  ) -> Result<Vec<BrewAction<'a>>, DotfilesError> {
    Ok(vec![add_directive_error_prefix(
      self,
      self.parse_action(context_settings, yaml, current_dir),
    )?])
  }
}