rbox 0.1.7

Rust library for interacting with the local and export data of Pioneers Rekordbox DJ software
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
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346

// Copyright (C) 2026 Dylan Jones
// SPDX-License-Identifier: GPL-3.0-only

use rbox::xml::*;
use tempfile::NamedTempFile;

mod common;

#[test]
fn test_read_xml() -> anyhow::Result<()> {
    let path = common::setup_rekordbox_xml_path();
    let _xml = RekordboxXml::load(path.path());
    Ok(())
}

#[test]
fn test_write_xml() -> anyhow::Result<()> {
    let path = common::setup_rekordbox_xml_path();
    let out = NamedTempFile::new_in(common::get_temp_root_dir())?;
    let xml = RekordboxXml::load(path.path());
    // Write to input file
    xml.dump()?;
    // Write to new file
    xml.dump_copy(out.path())?;
    Ok(())
}

// ---- Tracks -------------------------------------------------------------------------------------

#[test]
fn test_get_tracks() -> anyhow::Result<()> {
    let path = common::setup_rekordbox_xml_path();
    let mut xml = RekordboxXml::load(path.path());

    let tracks = xml.get_tracks();
    assert_eq!(tracks.len(), 6);
    Ok(())
}

#[test]
fn test_get_track() -> anyhow::Result<()> {
    let path = common::setup_rekordbox_xml_path();
    let mut xml = RekordboxXml::load(path.path());

    let track1 = xml.get_track(0);
    assert!(track1.is_some());

    let track_none = xml.get_track(6);
    assert!(track_none.is_none());
    Ok(())
}

#[test]
fn test_get_track_by_id() -> anyhow::Result<()> {
    let path = common::setup_rekordbox_xml_path();
    let mut xml = RekordboxXml::load(path.path());

    let track = xml.get_track_by_id("253529738");
    assert!(track.is_some());

    let track_none = xml.get_track_by_id("12345");
    assert!(track_none.is_none());

    Ok(())
}

#[test]
fn test_get_track_location_decode() -> anyhow::Result<()> {
    let path = common::setup_rekordbox_xml_path();
    let mut xml = RekordboxXml::load(path.path());

    let track = xml.get_track_by_id("253529738").unwrap();
    let location = &track.location;
    let expected = "C:/Music/PioneerDJ/Demo Tracks/Demo Track 1.mp3";
    assert_eq!(location, expected);

    Ok(())
}

#[test]
fn test_get_track_location_encode() -> anyhow::Result<()> {
    let path = common::setup_rekordbox_xml_path();
    let out = NamedTempFile::new_in(common::get_temp_root_dir())?;
    let track_id = "253529738";
    let mut xml = RekordboxXml::load(path.path());

    let track = xml.get_track_by_id(&track_id).unwrap();
    let new_location = "C:/Music/PioneerDJ/Demo Tracks/Demo Track 2.mp3";
    track.location = new_location.to_string();

    // Dump xml file and reload
    xml.dump_copy(&out)?;
    let mut xml2 = RekordboxXml::load(out.path());
    let track = xml2.get_track_by_id(&track_id).unwrap();
    assert_eq!(track.location, new_location);

    Ok(())
}

#[test]
fn test_get_track_by_location() -> anyhow::Result<()> {
    let path = common::setup_rekordbox_xml_path();
    let mut xml = RekordboxXml::load(path.path());

    let loc = "C:/Music/PioneerDJ/Demo Tracks/Demo Track 1.mp3";
    let track = xml.get_track_by_location(loc);
    assert!(track.is_some());

    let loc = "C:/Music/PioneerDJ/Demo Tracks/Demo Track.mp3";
    let track = xml.get_track_by_location(loc);
    assert!(track.is_none());

    Ok(())
}

#[test]
fn test_get_track_by_key() -> anyhow::Result<()> {
    let path = common::setup_rekordbox_xml_path();
    let mut xml = RekordboxXml::load(path.path());
    let id = "253529738";
    let loc = "C:/Music/PioneerDJ/Demo Tracks/Demo Track 1.mp3";

    let track = xml.get_track_by_key(loc, PlaylistKeyType::Location);
    assert!(track.is_some());

    let track = xml.get_track_by_key(id, PlaylistKeyType::TrackID);
    assert!(track.is_some());

    Ok(())
}

#[test]
fn test_add_track() -> anyhow::Result<()> {
    let path = common::setup_rekordbox_xml_path();
    let mut xml = RekordboxXml::load(path.path());
    let id = "1234567";
    let loc = "C:/Music/PioneerDJ/Demo Tracks/Demo Track.mp3";

    let tracks = xml.get_tracks();
    assert_eq!(tracks.len(), 6);

    let new_track = Track::new(id, loc);
    xml.add_track(new_track);

    let tracks = xml.get_tracks();
    assert_eq!(tracks.len(), 7);

    let track = xml.get_track_by_id(id);
    assert!(track.is_some());

    Ok(())
}

#[test]
fn test_new_track() -> anyhow::Result<()> {
    let path = common::setup_rekordbox_xml_path();
    let mut xml = RekordboxXml::load(path.path());
    let id = "1234567";
    let loc = "C:/Music/PioneerDJ/Demo Tracks/Demo Track.mp3";

    let tracks = xml.get_tracks();
    assert_eq!(tracks.len(), 6);

    xml.new_track(id, loc);

    let tracks = xml.get_tracks();
    assert_eq!(tracks.len(), 7);

    let track = xml.get_track_by_id(id);
    assert!(track.is_some());

    Ok(())
}

#[test]
fn test_remove_track() -> anyhow::Result<()> {
    let path = common::setup_rekordbox_xml_path();
    let mut xml = RekordboxXml::load(path.path());
    let id = "253529738";

    let tracks = xml.get_tracks();
    assert_eq!(tracks.len(), 6);

    xml.remove_track(id)?;

    let tracks = xml.get_tracks();
    assert_eq!(tracks.len(), 5);

    Ok(())
}

// ---- Playlists ----------------------------------------------------------------------------------

#[test]
fn test_new_playlist_folder_node() -> anyhow::Result<()> {
    let folder = PlaylistNode::folder("Test Folder");
    assert_eq!(folder.name, "Test Folder");
    assert_eq!(folder.node_type, PlaylistNodeType::Folder);
    assert!(folder.nodes.is_some());
    assert!(folder.tracks.is_none());
    Ok(())
}

#[test]
fn test_new_playlist_node() -> anyhow::Result<()> {
    let playlist = PlaylistNode::playlist("Test Playlist", PlaylistKeyType::TrackID);
    assert_eq!(playlist.name, "Test Playlist");
    assert_eq!(playlist.node_type, PlaylistNodeType::Playlist);
    assert!(playlist.tracks.is_some());
    assert!(playlist.nodes.is_none());
    assert_eq!(playlist.key_type, Some(PlaylistKeyType::TrackID));
    Ok(())
}

#[test]
fn test_add_node_to_folder() -> anyhow::Result<()> {
    let mut folder = PlaylistNode::folder("Parent Folder");
    let child_folder = PlaylistNode::folder("Child Folder");
    folder.add_node(child_folder);
    assert_eq!(folder.nodes.as_ref().unwrap().len(), 1);
    assert_eq!(folder.nodes.as_ref().unwrap()[0].name, "Child Folder");
    Ok(())
}

#[test]
fn test_add_track_to_playlist() -> anyhow::Result<()> {
    let mut playlist = PlaylistNode::playlist("Test Playlist", PlaylistKeyType::TrackID);
    playlist.add_track_key("123")?;
    assert_eq!(playlist.tracks.as_ref().unwrap().len(), 1);
    assert_eq!(playlist.tracks.as_ref().unwrap()[0].key, "123");
    Ok(())
}

#[test]
fn test_remove_node_from_folder() -> anyhow::Result<()> {
    let mut folder = PlaylistNode::folder("Parent Folder");
    folder.add_node(PlaylistNode::folder("Child Folder"));
    folder.remove_node(0).unwrap();
    assert!(folder.nodes.as_ref().unwrap().is_empty());
    Ok(())
}

#[test]
fn test_remove_track_from_playlist() -> anyhow::Result<()> {
    let mut playlist = PlaylistNode::playlist("Test Playlist", PlaylistKeyType::TrackID);
    playlist.add_track_key("123")?;
    playlist.remove_track("123")?;
    assert!(playlist.tracks.as_ref().unwrap().is_empty());
    Ok(())
}

#[test]
fn test_get_child_by_path() -> anyhow::Result<()> {
    let mut root = PlaylistNode::folder("Root");
    root.new_folder("Child Folder")?;
    let child = root.get_child_by_path(vec!["Child Folder".to_string()])?;
    assert!(child.is_some());
    assert_eq!(child.unwrap().name, "Child Folder");

    let child = root.get_child_by_path(vec!["Nonexistent".to_string()])?;
    assert!(child.is_none());

    Ok(())
}

#[test]
fn test_find_child() -> anyhow::Result<()> {
    let mut root = PlaylistNode::folder("Root");
    root.new_folder("Child Folder 1").unwrap();
    root.new_folder("Child Folder 2").unwrap();

    let node = root.find_child("Child Folder 1")?;
    assert!(node.is_some());

    let node = root.find_child("Child Folder 2")?;
    assert!(node.is_some());

    let node = root.find_child("Child Folder 3")?;
    assert!(node.is_none());
    Ok(())
}

#[test]
fn test_clear_tracks_in_playlist() -> anyhow::Result<()> {
    let mut playlist = PlaylistNode::playlist("Test Playlist", PlaylistKeyType::TrackID);
    playlist.add_track_key("123").unwrap();
    playlist.add_track_key("456").unwrap();
    playlist.clear_tracks().unwrap();
    assert!(playlist.tracks.as_ref().unwrap().is_empty());
    Ok(())
}

#[test]
fn test_clear_nodes_in_folder() -> anyhow::Result<()> {
    let mut folder = PlaylistNode::folder("Parent Folder");
    folder.new_folder("Child Folder 1").unwrap();
    folder.new_folder("Child Folder 2").unwrap();
    folder.clear_nodes().unwrap();
    assert!(folder.nodes.as_ref().unwrap().is_empty());
    Ok(())
}

#[test]
fn test_playlist_node_mutability() -> anyhow::Result<()> {
    let out = NamedTempFile::new_in(common::testdata_dir())?;
    let path = common::setup_rekordbox_xml_path();
    let mut xml = RekordboxXml::load(path.path());

    let root = xml.get_playlist_root();
    let node = root.find_child("Test")?.unwrap();

    // Change name
    node.name = "Renamed".to_string();

    xml.dump_copy(&out)?;

    let mut xml2 = RekordboxXml::load(&out.path());
    let root2 = xml2.get_playlist_root();
    let node2 = root2.find_child("Renamed")?;
    assert!(node2.is_some());

    Ok(())
}

#[test]
fn test_folder_node_mutability() -> anyhow::Result<()> {
    let out = NamedTempFile::new_in(common::testdata_dir())?;
    let path = common::setup_rekordbox_xml_path();
    let mut xml = RekordboxXml::load(path.path());

    let root = xml.get_playlist_root();
    let folder = root.new_folder("Folder")?;
    folder.new_playlist("Playlist", PlaylistKeyType::TrackID)?;

    xml.dump_copy(&out)?;

    let mut xml2 = RekordboxXml::load(&out.path());
    let root2 = xml2.get_playlist_root();
    let folder2 = root2.find_child("Folder")?;
    assert!(folder2.is_some());
    let folder2 = folder2.unwrap();
    assert_eq!(folder2.node_type, PlaylistNodeType::Folder);
    assert_eq!(folder2.nodes.as_ref().unwrap().len(), 1);

    Ok(())
}