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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
use crate::fs;
use crate::PackageJson;
use anyhow::{format_err, Result};
use std::env;
use std::path::{Path, PathBuf};

pub const PACKAGE_JSON_FILENAME: &str = "package.json";

/// A manager for manipulating `package.json` file.
#[derive(Debug, Default)]
pub struct PackageJsonManager {
  file_path: Option<PathBuf>,
  json: PackageJson,
}

impl PackageJsonManager {
  /// Constructs a new, empty `PackageJsonManager`.
  pub fn new() -> Self {
    Default::default()
  }

  /// Constructs a new, empty `PackageJsonManger` with the specified `package.json` file path.
  /// ```
  /// use package_json::PackageJsonManager;
  /// let mut manager = PackageJsonManager::with_file_path("/path/to/package.json");
  ///
  pub fn with_file_path<FilePath>(path: FilePath) -> Self
  where
    FilePath: AsRef<Path>,
  {
    Self {
      file_path: Some(path.as_ref().to_path_buf()),
      json: PackageJson::default(),
    }
  }

  /// Try to locate the closest `package.json` file from [current working directory][std::env::current_dir] to sys root.
  pub fn locate_closest(&mut self) -> Result<PathBuf> {
    env::current_dir().map(|cwd| self.locate_closest_from(cwd))?
  }

  /// Try to locate the closest `package.json` file from specific directory to sys root.
  pub fn locate_closest_from<P: AsRef<Path>>(&mut self, from: P) -> Result<PathBuf> {
    fs::find_closest_file(PACKAGE_JSON_FILENAME, from).map(|file_path| {
      self.file_path = Some(file_path);
      self.file_path.as_ref().unwrap().to_owned()
    })
  }

  /// Specify the `package.json` file path which is used to read and write.
  pub fn set_file_path<FilePath: AsRef<Path>>(&mut self, file_path: FilePath) {
    self.file_path = Some(file_path.as_ref().to_path_buf());
  }

  /// Get the located file path after `locate_closest` or `locate_closest_from` evaluated.
  pub fn get_file_path(&mut self) -> Option<&Path> {
    self.file_path.as_deref()
  }

  /// Take the located file path out of `PackageJsonManager`, leaving a `None` in its place.
  pub fn take_file_path(&mut self) -> Option<PathBuf> {
    self.file_path.take()
  }

  /// Call file reader to read `package.json` file.
  fn read(&mut self) -> Result<()> {
    self
      .file_path
      .as_ref()
      .map(|file_path| {
        fs::read_json(file_path).map(|json| {
          self.json = json;
        })
      })
      .unwrap_or_else(|| {
        Err(format_err!(
          "Couldn't find an available {} file.",
          PACKAGE_JSON_FILENAME
        ))
      })
  }

  ///
  /// Evaluate `package.json` parser and return the immutable `PackageJson` reference.
  ///
  /// Note: It always reads the file again. In the most case, you should call `as_ref` to get a immutable reference if you have read it before.
  /// ```
  /// use package_json::PackageJsonManager;
  /// let mut manager = PackageJsonManager::new();
  /// if manager.locate_closest().is_ok() {
  ///   assert!(manager.read_ref().is_ok());
  /// }
  /// ```
  pub fn read_ref(&mut self) -> Result<&PackageJson> {
    self.read().map(|_| &self.json)
  }

  /// Evaluate `package.json` parser and return the mutable `PackageJson` reference.
  ///
  /// Note: It always reads the file again. In the most case, you should call `as_mut` to get a mutable reference if you have read it before.
  /// ```
  /// use package_json::PackageJsonManager;
  /// let mut manager = PackageJsonManager::new();
  /// if manager.locate_closest().is_ok() {
  ///   assert!(manager.read_mut().is_ok());
  /// }
  /// ```
  pub fn read_mut(&mut self) -> Result<&mut PackageJson> {
    self.read().map(|_| &mut self.json)
  }

  /// Use the current `package.json` content to write the target `package.json` file.
  /// ```
  /// use package_json::PackageJsonManager;
  /// let mut manager = PackageJsonManager::new();
  /// if manager.locate_closest().is_ok() {
  ///   if let Ok(mut json) = manager.read_mut() {
  ///     json.name = "new name".to_string();
  ///     json.version = "1.0.0".to_string();
  ///   }
  ///   manager.write().expect("Couldn't write package.json");
  /// }
  /// ```
  pub fn write(&mut self) -> Result<()> {
    self
      .file_path
      .as_ref()
      .map(|file_path| fs::write_json(file_path, &self.json))
      .unwrap_or_else(|| {
        Err(format_err!(
          "Couldn't find an available {} file.",
          PACKAGE_JSON_FILENAME
        ))
      })
  }

  /// Write the current `package.json` content to the specific `package.json` file.
  /// ```
  /// use package_json::PackageJsonManager;
  /// use std::path::Path;
  /// let mut manager = PackageJsonManager::new();
  /// if manager.locate_closest().is_ok() {
  ///   if let Ok(mut json) = manager.read_mut() {
  ///     json.name = "new name".to_string();
  ///     json.version = "1.0.0".to_string();
  ///   }
  ///   manager
  ///     .write_to(&Path::new("/path/to/package.json"))
  ///     .expect("Couldn't write package.json");
  /// }
  /// ```
  pub fn write_to(&mut self, file_path: &Path) -> Result<()> {
    fs::write_json(file_path, &self.json)
  }
}

impl AsRef<PackageJson> for PackageJsonManager {
  /// Return a immutable reference to the current `PackageJson` struct.
  fn as_ref(&self) -> &PackageJson {
    &self.json
  }
}

impl AsMut<PackageJson> for PackageJsonManager {
  /// Return a mutable reference to the current `PackageJson` struct.
  fn as_mut(&mut self) -> &mut PackageJson {
    &mut self.json
  }
}

#[test]
fn test_new() {
  use std::path::PathBuf;

  let mut manager = PackageJsonManager::new();
  assert_eq!(manager.file_path, None);

  let file_path = PathBuf::from("/path/to/package.json");
  manager.set_file_path(&file_path);
  assert_eq!(manager.file_path, Some(file_path.to_owned()));
  assert_eq!(manager.get_file_path(), Some(file_path.as_ref()));
  assert_eq!(manager.take_file_path(), Some(file_path.to_owned()));
  assert_eq!(manager.file_path, None);
}

#[test]
fn test_readable() {
  use crate::PACKAGE_JSON_FILENAME;
  use std::env::current_dir;
  use std::fs::{create_dir_all, File};
  use std::io::Write;
  use tempfile::tempdir_in;

  let mut manager = PackageJsonManager::new();
  assert!(manager.read_ref().is_err(), "found an available file.");
  assert!(
    manager.get_file_path().is_none(),
    "found an available file."
  );
  assert!(
    manager.locate_closest().is_err(),
    "found an available file."
  );

  let dir = tempdir_in(current_dir().unwrap()).expect("create temp_dir failed!");
  let file_path = dir.path().join(format!("a/b/c/{}", PACKAGE_JSON_FILENAME));
  let file_dir = file_path.parent().unwrap();
  let deeper_file_dir = file_dir.join("d/e/f");
  create_dir_all(file_dir).expect("create a/b/c dir failed!");
  create_dir_all(deeper_file_dir.as_path()).expect("create d/e/f dir field!");

  let mut valid_file = File::create(&file_path).expect("create file failed!");
  let valid_json = r#"{
"name": "test",
"version": "0.0.1"
}"#;

  valid_file
    .write_all(valid_json.as_bytes())
    .expect("write json failed");

  for (dir, expect) in [
    (dir.path(), None),
    (file_dir, Some(file_path.to_owned())),
    (deeper_file_dir.as_path(), Some(file_path.to_owned())),
  ] {
    assert_eq!(manager.locate_closest_from(dir).ok(), expect);
    if expect.is_some() {
      assert!(manager.read_ref().is_ok(), "read file failed.");
      assert_eq!(manager.get_file_path().map(|p| p.to_path_buf()), expect);

      if let Ok(json) = manager.read_ref() {
        assert_eq!(json.name, "test");
        assert_eq!(json.version, "0.0.1");
      }

      let handler = manager.as_ref();
      assert_eq!(handler.name, "test");
      assert_eq!(handler.version, "0.0.1");
      assert!(!handler.private);
    } else {
      assert!(manager.read_ref().is_err(), "read field successful.")
    }
  }
}

#[test]
fn test_writable() {
  use crate::PACKAGE_JSON_FILENAME;
  use std::env::current_dir;
  use std::fs::{create_dir_all, File};
  use std::io::Write;
  use tempfile::tempdir_in;

  let mut manager = PackageJsonManager::new();
  assert!(manager.write().is_err(), "found an available file.");

  let dir = tempdir_in(current_dir().unwrap()).expect("create temp_dir failed!");
  let file_path = dir.path().join(format!("a/b/c/{}", PACKAGE_JSON_FILENAME));
  let file_dir = file_path.parent().unwrap();
  create_dir_all(file_dir).expect("create a/b/c dir failed!");

  let mut valid_file = File::create(&file_path).expect("create file failed!");
  let valid_json = r#"{
"name": "test",
"version": "0.0.1"
}"#;

  valid_file
    .write_all(valid_json.as_bytes())
    .expect("write json failed");

  manager.set_file_path(&file_path);

  // case `read_mut`
  {
    let file_writer = manager.read_mut();
    assert!(
      file_writer.is_ok(),
      "{}",
      format!("create file writer failed: {:?}", file_writer)
    );
    if let Ok(mut json) = file_writer {
      json.name = "test2".to_string();
      json.version = "0.0.2".to_string();
      assert!(manager.write().is_ok());
    }
    let file_reader = manager.as_ref();
    assert_eq!(file_reader.name, "test2");
    assert_eq!(file_reader.version, "0.0.2");
  }

  // case `as_mut`
  {
    let mut mutable_handler = manager.as_mut();
    mutable_handler.name = "test3".to_string();
    mutable_handler.version = "0.0.3".to_string();
    let file_reader = manager.as_ref();
    assert_eq!(file_reader.name, "test3");
    assert_eq!(file_reader.version, "0.0.3");
  }
}