rez-next-package 0.3.0

Advanced package management with complete package.py parsing and 100% Rez compatibility
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
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
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
//! Package serialization (save) logic.

use crate::Package;
use chrono::Utc;
use flate2::write::GzEncoder;
use flate2::Compression;
use rez_next_common::RezCoreError;
use std::fs;
use std::io::Write;
use std::path::Path;

use super::types::{PackageContainer, PackageFormat, PackageMetadata, SerializationOptions};

pub struct PackageSaver;

impl PackageSaver {
    /// Save a package to a file with options
    pub fn save_to_file_with_options(
        package: &Package,
        path: &Path,
        format: PackageFormat,
        options: Option<SerializationOptions>,
    ) -> Result<(), RezCoreError> {
        let opts = options.unwrap_or_default();

        let container = if opts.include_metadata {
            let mut metadata = PackageMetadata::new(format.default_filename().to_string());
            metadata.set_original_path(path.to_string_lossy().to_string());
            PackageContainer::with_metadata(package.clone(), metadata)
        } else {
            PackageContainer::new(package.clone(), format.default_filename().to_string())
        };

        let content = Self::save_container_to_string(&container, format, &opts)?;

        if format.supports_compression() {
            Self::write_compressed_file(path, &content, opts.compression_level)?;
        } else {
            fs::write(path, content).map_err(|e| {
                RezCoreError::PackageParse(format!(
                    "Failed to write file {}: {}",
                    path.display(),
                    e
                ))
            })?;
        }

        Ok(())
    }

    /// Save a package to a file (legacy method)
    pub fn save_to_file(
        package: &Package,
        path: &Path,
        format: PackageFormat,
    ) -> Result<(), RezCoreError> {
        Self::save_to_file_with_options(package, path, format, None)
    }

    /// Save a package to a string
    pub fn save_to_string(
        package: &Package,
        format: PackageFormat,
    ) -> Result<String, RezCoreError> {
        match format {
            PackageFormat::Yaml | PackageFormat::YamlCompressed => Self::save_to_yaml(package),
            PackageFormat::Json | PackageFormat::JsonCompressed => Self::save_to_json(package),
            PackageFormat::Python => Self::save_to_python(package),
            PackageFormat::Binary => Self::save_to_binary(package),
            PackageFormat::Toml => Self::save_to_toml(package, &SerializationOptions::new()),
            PackageFormat::Xml => Self::save_to_xml(package, &SerializationOptions::new()),
        }
    }

    /// Save a package to YAML format
    pub fn save_to_yaml(package: &Package) -> Result<String, RezCoreError> {
        serde_yaml::to_string(package)
            .map_err(|e| RezCoreError::PackageParse(format!("Failed to serialize to YAML: {}", e)))
    }

    /// Save a package to JSON format
    pub fn save_to_json(package: &Package) -> Result<String, RezCoreError> {
        serde_json::to_string_pretty(package)
            .map_err(|e| RezCoreError::PackageParse(format!("Failed to serialize to JSON: {}", e)))
    }

    /// Save a package to Python format (simplified)
    pub fn save_to_python(package: &Package) -> Result<String, RezCoreError> {
        Self::save_to_python_with_options(package, &SerializationOptions::minimal())
    }

    /// Save container to string with options
    pub fn save_container_to_string(
        container: &PackageContainer,
        format: PackageFormat,
        options: &SerializationOptions,
    ) -> Result<String, RezCoreError> {
        let filtered_package = if options.include_only.is_some() || options.exclude_fields.is_some()
        {
            Self::apply_field_filters(&container.package, options)?
        } else {
            container.package.clone()
        };

        match format {
            PackageFormat::Yaml | PackageFormat::YamlCompressed => {
                if options.include_metadata {
                    let container_with_filtered = PackageContainer {
                        package: filtered_package,
                        metadata: container.metadata.clone(),
                        schema_version: container.schema_version.clone(),
                    };
                    Self::save_container_to_yaml(&container_with_filtered, options)
                } else {
                    Self::save_to_yaml_with_options(&filtered_package, options)
                }
            }
            PackageFormat::Json | PackageFormat::JsonCompressed => {
                if options.include_metadata {
                    let container_with_filtered = PackageContainer {
                        package: filtered_package,
                        metadata: container.metadata.clone(),
                        schema_version: container.schema_version.clone(),
                    };
                    Self::save_container_to_json(&container_with_filtered, options)
                } else {
                    Self::save_to_json_with_options(&filtered_package, options)
                }
            }
            PackageFormat::Python => Self::save_to_python_with_options(&filtered_package, options),
            PackageFormat::Binary => Self::save_to_binary(&filtered_package),
            PackageFormat::Toml => Self::save_to_toml(&filtered_package, options),
            PackageFormat::Xml => Self::save_to_xml(&filtered_package, options),
        }
    }

    /// Apply field filters to package
    fn apply_field_filters(
        package: &Package,
        options: &SerializationOptions,
    ) -> Result<Package, RezCoreError> {
        let mut filtered = package.clone();

        if let Some(ref exclude_fields) = options.exclude_fields {
            for field in exclude_fields {
                match field.as_str() {
                    "description" => filtered.description = None,
                    "help" => filtered.help = None,
                    "authors" => filtered.authors.clear(),
                    "tools" => filtered.tools.clear(),
                    _ => {}
                }
            }
        }

        if let Some(ref include_only) = options.include_only {
            let mut new_package = Package::new(filtered.name.clone());

            for field in include_only {
                match field.as_str() {
                    "name" => {}
                    "version" => new_package.version = filtered.version.clone(),
                    "description" => new_package.description = filtered.description.clone(),
                    "authors" => new_package.authors = filtered.authors.clone(),
                    "requires" => new_package.requires = filtered.requires.clone(),
                    "build_requires" => {
                        new_package.build_requires = filtered.build_requires.clone()
                    }
                    "variants" => new_package.variants = filtered.variants.clone(),
                    "tools" => new_package.tools = filtered.tools.clone(),
                    _ => {}
                }
            }

            filtered = new_package;
        }

        Ok(filtered)
    }

    fn save_container_to_yaml(
        container: &PackageContainer,
        _options: &SerializationOptions,
    ) -> Result<String, RezCoreError> {
        serde_yaml::to_string(container).map_err(|e| {
            RezCoreError::PackageParse(format!("Failed to serialize container to YAML: {}", e))
        })
    }

    fn save_container_to_json(
        container: &PackageContainer,
        options: &SerializationOptions,
    ) -> Result<String, RezCoreError> {
        if options.pretty_print {
            serde_json::to_string_pretty(container)
        } else {
            serde_json::to_string(container)
        }
        .map_err(|e| {
            RezCoreError::PackageParse(format!("Failed to serialize container to JSON: {}", e))
        })
    }

    fn save_to_yaml_with_options(
        package: &Package,
        options: &SerializationOptions,
    ) -> Result<String, RezCoreError> {
        let raw = serde_yaml::to_string(package).map_err(|e| {
            RezCoreError::PackageParse(format!("Failed to serialize to YAML: {}", e))
        })?;

        if !options.pretty_print {
            return Ok(raw);
        }

        let mut output = String::with_capacity(raw.len() + 64);
        output.push_str("# ---\n");
        for line in raw.lines() {
            if line.starts_with("- ") {
                output.push_str("  ");
            }
            output.push_str(line);
            output.push('\n');
        }
        Ok(output)
    }

    fn save_to_json_with_options(
        package: &Package,
        options: &SerializationOptions,
    ) -> Result<String, RezCoreError> {
        if options.pretty_print {
            serde_json::to_string_pretty(package)
        } else {
            serde_json::to_string(package)
        }
        .map_err(|e| RezCoreError::PackageParse(format!("Failed to serialize to JSON: {}", e)))
    }

    pub(super) fn save_to_python_with_options(
        package: &Package,
        options: &SerializationOptions,
    ) -> Result<String, RezCoreError> {
        let mut content = String::new();

        if options.include_metadata && options.include_timestamps {
            content.push_str(&format!(
                "# Generated by rez-next serializer at {}\n",
                Utc::now().to_rfc3339()
            ));
            content.push_str("# Do not edit manually\n\n");
        }

        content.push_str(&format!("name = \"{}\"\n", package.name));

        if let Some(ref version) = package.version {
            content.push_str(&format!("version = \"{}\"\n", version.as_str()));
        }

        if let Some(ref description) = package.description {
            content.push_str(&format!("description = \"{}\"\n", description));
        }

        if !package.authors.is_empty() {
            content.push_str("authors = [\n");
            for author in &package.authors {
                content.push_str(&format!("    \"{}\",\n", author));
            }
            content.push_str("]\n");
        }

        if !package.requires.is_empty() {
            content.push_str("requires = [\n");
            for req in &package.requires {
                content.push_str(&format!("    \"{}\",\n", req));
            }
            content.push_str("]\n");
        }

        if !package.build_requires.is_empty() {
            content.push_str("build_requires = [\n");
            for req in &package.build_requires {
                content.push_str(&format!("    \"{}\",\n", req));
            }
            content.push_str("]\n");
        }

        if !package.variants.is_empty() {
            content.push_str("variants = [\n");
            for variant in &package.variants {
                content.push_str("    [");
                for (i, req) in variant.iter().enumerate() {
                    if i > 0 {
                        content.push_str(", ");
                    }
                    content.push_str(&format!("\"{}\"", req));
                }
                content.push_str("],\n");
            }
            content.push_str("]\n");
        }

        if !package.tools.is_empty() {
            content.push_str("tools = [\n");
            for tool in &package.tools {
                content.push_str(&format!("    \"{}\",\n", tool));
            }
            content.push_str("]\n");
        }

        Ok(content)
    }

    /// Save a package as a base64-wrapped bincode payload.
    fn save_to_binary(package: &Package) -> Result<String, RezCoreError> {
        use base64::Engine as _;

        let binary_data = bincode::serde::encode_to_vec(package, bincode::config::standard())
            .map_err(|e| {
                RezCoreError::PackageParse(format!("Failed to serialize to binary: {}", e))
            })?;

        Ok(base64::engine::general_purpose::STANDARD.encode(binary_data))
    }

    fn save_to_toml(
        package: &Package,
        _options: &SerializationOptions,
    ) -> Result<String, RezCoreError> {
        toml::to_string(package)
            .map_err(|e| RezCoreError::PackageParse(format!("Failed to serialize to TOML: {}", e)))
    }

    fn save_to_xml(
        package: &Package,
        options: &SerializationOptions,
    ) -> Result<String, RezCoreError> {
        let mut content = String::new();

        if options.pretty_print {
            content.push_str("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n");
        }

        content.push_str("<package>\n");
        content.push_str(&format!("  <name>{}</name>\n", package.name));

        if let Some(ref version) = package.version {
            content.push_str(&format!("  <version>{}</version>\n", version.as_str()));
        }

        if let Some(ref description) = package.description {
            content.push_str(&format!("  <description>{}</description>\n", description));
        }

        if !package.authors.is_empty() {
            content.push_str("  <authors>\n");
            for author in &package.authors {
                content.push_str(&format!("    <author>{}</author>\n", author));
            }
            content.push_str("  </authors>\n");
        }

        if !package.requires.is_empty() {
            content.push_str("  <requires>\n");
            for req in &package.requires {
                content.push_str(&format!("    <requirement>{}</requirement>\n", req));
            }
            content.push_str("  </requires>\n");
        }

        content.push_str("</package>\n");

        Ok(content)
    }

    /// Write compressed file
    pub(super) fn write_compressed_file(
        path: &Path,
        content: &str,
        compression_level: u32,
    ) -> Result<(), RezCoreError> {
        let file = fs::File::create(path).map_err(|e| {
            RezCoreError::PackageParse(format!(
                "Failed to create compressed file {}: {}",
                path.display(),
                e
            ))
        })?;

        let compression = Compression::new(compression_level);
        let mut encoder = GzEncoder::new(file, compression);
        encoder.write_all(content.as_bytes()).map_err(|e| {
            RezCoreError::PackageParse(format!(
                "Failed to write compressed file {}: {}",
                path.display(),
                e
            ))
        })?;

        encoder.finish().map_err(|e| {
            RezCoreError::PackageParse(format!(
                "Failed to finish compressed file {}: {}",
                path.display(),
                e
            ))
        })?;

        Ok(())
    }
}

/// Convert YAML value to JSON value
pub fn yaml_to_json_value(yaml_value: serde_yaml::Value) -> serde_json::Value {
    match yaml_value {
        serde_yaml::Value::Null => serde_json::Value::Null,
        serde_yaml::Value::Bool(b) => serde_json::Value::Bool(b),
        serde_yaml::Value::Number(n) => {
            if let Some(i) = n.as_i64() {
                serde_json::Value::Number(serde_json::Number::from(i))
            } else if let Some(f) = n.as_f64() {
                serde_json::Number::from_f64(f)
                    .map(serde_json::Value::Number)
                    .unwrap_or(serde_json::Value::Null)
            } else {
                serde_json::Value::Null
            }
        }
        serde_yaml::Value::String(s) => serde_json::Value::String(s),
        serde_yaml::Value::Sequence(seq) => {
            let json_array: Vec<serde_json::Value> =
                seq.into_iter().map(yaml_to_json_value).collect();
            serde_json::Value::Array(json_array)
        }
        serde_yaml::Value::Mapping(map) => {
            let mut json_object = serde_json::Map::new();
            for (k, v) in map {
                if let serde_yaml::Value::String(key) = k {
                    json_object.insert(key, yaml_to_json_value(v));
                }
            }
            serde_json::Value::Object(json_object)
        }
        serde_yaml::Value::Tagged(_) => serde_json::Value::Null,
    }
}