finchie/cli_framework - Change V5S5K33ALIEG5ZABUSAPO4ULHEBFDB2PLTW27A4BFS342SJG7URQC

Add basic error handling for invalid paths in proc_macro attribute

Makes it much clearer what the problem is, and where to find the invalid path

Created by finchie on July 3, 2024

V5S5K33ALIEG5ZABUSAPO4ULHEBFDB2PLTW27A4BFS342SJG7URQC

Dependencies

In channels

main

Change contents

Replacement in fluent_embed/src/lib.rs at line 13 [4.74]

B:BD[3.1387] → [2.4390:4453]

pub fn attribute_groups(path_literal: &syn::LitStr) -> Group {

[3.1387]

[2.4453]

pub fn attribute_groups(path_literal: &syn::LitStr) -> Result<Group, wax::GlobError> {

Replacement in fluent_embed/src/lib.rs at line 20 [4.74]

B:BD[2.4658] → [2.4658:4715]

    let glob = wax::Glob::new(&attribute_glob).unwrap();

[2.4658]

[2.4715]

    let glob = wax::Glob::new(&attribute_glob)?;

Replacement in fluent_embed/src/lib.rs at line 23 [4.74]
B:BD[2.4837] → [2.4837:4883]
```
        let entry = potential_entry.unwrap();
```
[2.4837]
[2.4883]
```
        let entry = potential_entry?;
```
Replacement in fluent_embed/src/lib.rs at line 36 [4.74]
B:BD[2.5428] → [2.5428:5472]
```
    Group::new(locale!("en-US"), resources)
```
[2.5428]
[2.5472]
```
    Ok(Group::new(locale!("en-US"), resources))
```

Replacement in fluent_embed/src/lib.rs at line 39 [4.74]

B:BD[2.5475] → [2.5475:5596]

pub fn localize(path: &syn::LitStr, derive_input: &DeriveInput) -> TokenStream {
    let group = attribute_groups(path);

[2.5475]

[2.5596]

pub fn localize(
    path: &syn::LitStr,
    derive_input: &DeriveInput,
) -> Result<TokenStream, wax::GlobError> {
    let group = attribute_groups(path)?;

Replacement in fluent_embed/src/lib.rs at line 52 [4.74]
B:BD[2.5915] → [2.5915:5928]
```
    quote! {
```
[2.5915]
[2.5928]
```
    Ok(quote! {
```
Replacement in fluent_embed/src/lib.rs at line 59 [4.74]
B:BD[2.6110] → [2.6110:6116]
```
    }
```
[2.6110]
[2.6116]
```
    })
```
Insertion in cli_macros/src/lib.rs at line 4 [5.72]
[5.160]
[5.160]
```
use proc_macro_error::{emit_error, proc_macro_error};
```
Replacement in cli_macros/src/lib.rs at line 6 [5.72]
B:BD[5.178] → [2.7171:7214]
```
use syn::{parse_macro_input, DeriveInput};
```
[5.178]
[5.206]
```
use syn::parse_macro_input;
use wax::GlobError;
```
Insertion in cli_macros/src/lib.rs at line 10 [5.72]
[5.231]
[5.231]
```
#[proc_macro_error]
```

Replacement in cli_macros/src/lib.rs at line 13 [5.72]

∅:D[2.7285] → [5.307:378]

B:BD[5.307] → [5.307:378]

B:BD[5.378] → [2.7286:7350]

    let parsed_attribute: syn::LitStr = parse_macro_input!(attribute);
    let parsed_input = parse_macro_input!(item as DeriveInput);

[2.7285]

[5.441]

    let derive_attribute: syn::LitStr = parse_macro_input!(attribute);
    let derive_input = parse_macro_input!(item);

Replacement in cli_macros/src/lib.rs at line 16 [5.72]

B:BD[5.442] → [2.7351:7434]

    let implementation = fluent_embed::localize(&parsed_attribute, &parsed_input);

[5.442]

[5.600]

    let implementation = match fluent_embed::localize(&derive_attribute, &derive_input) {
        Ok(implementation) => implementation,
        Err(glob_error) => {
            // Emit the relevant error messages
            match glob_error {
                GlobError::Build(_build_error) => todo!(),
                GlobError::Walk(walk_error) => {
                    // Generate help text
                    let help = if let Some(path) = walk_error.path() {
                        let path_name = path.to_str().unwrap();
                        // Might hit an error if file exists but insufficient permissions
                        match path.try_exists() {
                            Ok(true) => {
                                format!("the path `{path_name}` exists, but unable to access it")
                            }
                            _ => format!("the path `{path_name}` doesn't seem to exist"),
                        }
                    } else {
                        String::from("no associated path")
                    };
                    emit_error! { derive_attribute, "error at depth {} while walking path", walk_error.depth();
                        help = help;
                    }
                }
            };
            // Generate a minimal `localize()` implementation so the error is self-contained
            let ident = &derive_input.ident;
            quote! {
                impl #ident {
                    fn localize(&self) -> String {
                        unimplemented!("Encountered error in proc-macro")
                    }
                }
            }
        }
    };

Insertion in cli_macros/Cargo.toml at line 14 [5.711]
[5.888]
[2.7484]
```
proc-macro-error = "1.0.4"
```
Insertion in cli_macros/Cargo.toml at line 18 [5.711]
[5.954]
[5.971]
```
wax = "0.6.0"
```
Insertion in Cargo.lock at line 34 [7.4277]
[6.18]
[2.7525]
```
 "proc-macro-error",
```
Replacement in Cargo.lock at line 37 [7.4277]
B:BD[5.1218] → [5.1218:1226]
```
 "syn",
```
[5.1218]
[8.1244]
```
 "syn 2.0.48",
 "wax",
```
Replacement in Cargo.lock at line 69 [7.4277]
B:BD[5.1465] → [5.1465:1473]
```
 "syn",
```
[5.1465]
[5.1473]
```
 "syn 2.0.48",
```
Replacement in Cargo.lock at line 118 [7.4277]
B:BD[4.1978] → [4.1978:1986]
```
 "syn",
```
[4.1978]
[8.1952]
```
 "syn 2.0.48",
```
Replacement in Cargo.lock at line 230 [7.4277]
B:BD[5.3660] → [5.3660:3668]
```
 "syn",
```
[5.3660]
[8.1961]
```
 "syn 2.0.48",
```
Replacement in Cargo.lock at line 349 [7.4277]
B:BD[7.4478] → [7.4478:4486]
```
 "syn",
```
[7.4478]
[7.4486]
```
 "syn 2.0.48",
```

Replacement in Cargo.lock at line 368 [7.4277]

B:BD[9.518] → [9.518:526]

 "syn",

[9.518]

[9.526]

 "syn 2.0.48",
]
[[package]]
name = "proc-macro-error"
version = "1.0.4"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "da25490ff9892aab3fcf7c36f08cfb902dd3e71ca0f9f9517bea02a73a5ce38c"
dependencies = [
 "proc-macro-error-attr",
 "proc-macro2",
 "quote",
 "syn 1.0.109",
 "version_check",
]
[[package]]
name = "proc-macro-error-attr"
version = "1.0.4"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a1be40180e52ecc98ad80b184934baf3d0d29f979574e439af5a55274b35f869"
dependencies = [
 "proc-macro2",
 "quote",
 "version_check",

Replacement in Cargo.lock at line 468 [7.4277]
B:BD[5.4330] → [5.4330:4338]
```
 "syn",
```
[5.4330]
[5.4338]
```
 "syn 2.0.48",
```

Insertion in Cargo.lock at line 485 [7.4277]

[7.4972]

version = "1.0.109"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "72b64191b275b66ffe2469e8af2c1cfe3bafa67b529ead792a6d0160888b4237"
dependencies = [
 "proc-macro2",
 "unicode-ident",
]
[[package]]
name = "syn"

Replacement in Cargo.lock at line 512 [7.4277]
B:BD[5.4991] → [5.4991:4999]
```
 "syn",
```
[5.4991]
[4.2222]
```
 "syn 2.0.48",
```
Replacement in Cargo.lock at line 523 [7.4277]
B:BD[4.2256] → [4.2256:2275]
```
version = "1.0.56"
```
[4.2256]
[4.2275]
```
version = "1.0.61"
```

Replacement in Cargo.lock at line 525 [7.4277]

B:BD[4.2340] → [4.2340:2418]

checksum = "d54378c645627613241d077a3a79db965db602882668f9136ac42af9ecb730ad"

[4.2340]

[4.2418]

checksum = "c546c80d6be4bc6a00c0f01730c08df82eaa7a7a61f11d656526506112cc1709"

Replacement in Cargo.lock at line 532 [7.4277]
B:BD[4.2479] → [4.2479:2498]
```
version = "1.0.56"
```
[4.2479]
[4.2498]
```
version = "1.0.61"
```

Replacement in Cargo.lock at line 534 [7.4277]

B:BD[4.2563] → [4.2563:2641]

checksum = "fa0faa943b50f3db30a20aa7e265dbc66076993efed8463e8de414e5d06d3471"

[4.2563]

[4.2641]

checksum = "46c3384250002a6d5af4d114f2845d37b57521033f30d5c3f46c4d70e1197533"

Replacement in Cargo.lock at line 538 [7.4277]
B:BD[4.2684] → [4.2684:2692]
```
 "syn",
```
[4.2684]
[4.2692]
```
 "syn 2.0.48",
```

Insertion in Cargo.lock at line 568 [7.4277]

[8.4184]


[[package]]
name = "version_check"
version = "0.9.4"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "49874b5167b65d7193b8aba1567f5c7d93d001cafc34600cee003eda787e483f"

Replacement in Cargo.lock at line 657 [7.4277]
B:BD[5.5938] → [5.5938:5946]
```
 "syn",
```
[5.5938]
[5.5946]
```
 "syn 2.0.48",
```
Replacement in Cargo.lock at line 678 [7.4277]
B:BD[5.6438] → [5.6438:6446]
```
 "syn",
```
[5.6438]
[5.6446]
```
 "syn 2.0.48",
```
Replacement in Cargo.lock at line 701 [7.4277]
B:BD[5.6959] → [5.6959:6967]
```
 "syn",
```
[5.6959]
[5.6967]
```
 "syn 2.0.48",
```

Add basic error handling for invalid paths in proc_macro attribute

Dependencies

In channels

Change contents

Replacement in fluent_embed/src/lib.rs at line 13 [4.74]

Replacement in fluent_embed/src/lib.rs at line 20 [4.74]

Replacement in fluent_embed/src/lib.rs at line 23 [4.74]

Replacement in fluent_embed/src/lib.rs at line 36 [4.74]

Replacement in fluent_embed/src/lib.rs at line 39 [4.74]

Replacement in fluent_embed/src/lib.rs at line 52 [4.74]

Replacement in fluent_embed/src/lib.rs at line 59 [4.74]

Insertion in cli_macros/src/lib.rs at line 4 [5.72]

Replacement in cli_macros/src/lib.rs at line 6 [5.72]

Insertion in cli_macros/src/lib.rs at line 10 [5.72]

Replacement in cli_macros/src/lib.rs at line 13 [5.72]

Replacement in cli_macros/src/lib.rs at line 16 [5.72]

Insertion in cli_macros/Cargo.toml at line 14 [5.711]

Insertion in cli_macros/Cargo.toml at line 18 [5.711]

Insertion in Cargo.lock at line 34 [7.4277]

Replacement in Cargo.lock at line 37 [7.4277]

Replacement in Cargo.lock at line 69 [7.4277]

Replacement in Cargo.lock at line 118 [7.4277]

Replacement in Cargo.lock at line 230 [7.4277]

Replacement in Cargo.lock at line 349 [7.4277]

Replacement in Cargo.lock at line 368 [7.4277]

Replacement in Cargo.lock at line 468 [7.4277]

Insertion in Cargo.lock at line 485 [7.4277]

Replacement in Cargo.lock at line 512 [7.4277]

Replacement in Cargo.lock at line 523 [7.4277]

Replacement in Cargo.lock at line 525 [7.4277]

Replacement in Cargo.lock at line 532 [7.4277]

Replacement in Cargo.lock at line 534 [7.4277]

Replacement in Cargo.lock at line 538 [7.4277]

Insertion in Cargo.lock at line 568 [7.4277]

Replacement in Cargo.lock at line 657 [7.4277]

Replacement in Cargo.lock at line 678 [7.4277]

Replacement in Cargo.lock at line 701 [7.4277]