Escape backslashes in search and replacement

[lens0021]

Fixes #589.

[Ph0enixKM]

Wow! Tested and this works. Thanks! 🙌

[Mte90]

@lens0021 the tests doesn't work. Can you check what is happening or you need help?

[Mte90]

tests does't work

[Mte90]

So I think that the bash generated is not very ok.

#!/usr/bin/env bash
# Written in [Amber](https://amber-lang.com/)
# version: 0.3.5-alpha
# date: 2024-11-15 17:31:52
replace__0_v0() {
    local source=$1
    local search=$2
    local replace=$3
    __AMBER_VAL_0=$(echo ${search//\\/\\\\})
    __AS=$?
    search="${__AMBER_VAL_0}"
    __AMBER_VAL_1=$(echo ${replace//\\/\\\\})
    __AS=$?
    replace="${__AMBER_VAL_1}"
    __AMBER_VAL_2=$(echo ${source//${search}/${replace}})
    __AS=$?
    __AF_replace0_v0="${__AMBER_VAL_2}"
    return 0
}
# Output
# apple apple
# apple

replace__0_v0 "banana banana" "banana" "apple"
__AF_replace0_v0__8_10="${__AF_replace0_v0}"
echo "${__AF_replace0_v0__8_10}"
replace__0_v0 "\\" "\\" "apple"
__AF_replace0_v0__9_10="${__AF_replace0_v0}"
echo "${__AF_replace0_v0__9_10}"

This is an example of the bash generated for the replace test, https://www.shellcheck.net/ with that code report the various lines.

This amber code: search = trust $ \$\{search//\\\\/\\\\\\\\} $ generates __AMBER_VAL_0=$(${search//\\/\\\\}) but it should be __AMBER_VAL_0=${search//\\/\\\\}.
Do you have suggestions @Ph0enixKM?

[Ph0enixKM]

@lens0021 @Mte90 It seems that only the replace_once fails. It fails also on my local machine. When I modify the contents of said function to:

/// Replaces the first occurrence of a pattern in the content with the provided replace text.
pub fun replace_once(source, search, replace) {
    search = trust $ echo \$\{{nameof search}//\\\\/\\\\\\\\} $
    replace = trust $ echo \$\{{nameof replace}//\\\\/\\\\\\\\} $
    return trust $ echo \$\{{nameof source}/{search}/{replace}} $
}

echo replace_once("Hello, World\\", "World\\", "Rust")

It suddenly works.

[Ph0enixKM]

But still these two tests fail:

    tests::stdlib::test_stdlib_src_tests_stdlib_replace_regex_basic_ab
    tests::stdlib::test_stdlib_src_tests_stdlib_replace_regex_ext_ab

I can't investigate this problem further now. Maybe later today or tomorrow I can play around it

[Mte90]

the tests are still failing

[lens0021]

There are some changes on bash 5.2

$ docker run --rm -v $PWD:/tmp bash:5.1.16 bash /tmp/replace_once.sh
Succinctly\
$ docker run --rm -v $PWD:/tmp bash:5.2.0 bash /tmp/replace_once.sh
Succeeded

I will try to write a compatible code...

[lens0021]

I know this is dirty. When #622 is resolved, this could be improved.

[lens0021]

Now the both versions are supported.

$ cargo run -- build src/tests/stdlib/replace_once.ab src/tests/stdlib/replace_once.sh
   Compiling amber v0.3.5-alpha (/usr/local/git/amber)
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 2.52s
     Running `target/debug/amber build src/tests/stdlib/replace_once.ab src/tests/stdlib/rep
lace_once.sh`

$ docker run --rm -v $PWD:/tmp bash:5.1.16 bash /tmp/src/tests/stdlib/replace_once.sh
Succeeded

$ docker run --rm -v $PWD:/tmp bash:5.2.0 bash /tmp/src/tests/stdlib/replace_once.sh
Succeeded

[hdwalters]

To confirm that replace replaces multiple instances, may I suggest testing multiple occurrences of the search text:

echo replace("\\ \\", "\\", "apple")
echo replace("\\banana\\", "\\", "\\\\")

[hdwalters]

You might also consider cloning the modified test, and overwriting replace_once.ab, with adjusted expected output.

[lens0021]

Added tests for replace_once and edited text.ab to make the test pass, though I did not know why it was broken.

[hdwalters]

I'm still not entirely happy with these tests:

1. I had in mind that both test files would contain calls to replace and replace_once, with identical parameters, to show the differences in behaviour.
2. Each function call should test a specific use case; they don't all have to contain backslashes!
3. Each function call should contain multiple copies of the search text.

[hdwalters]

For example:

import * from "std/text"

// Output
// TWO TWO TWO
// a\\b\\c\\d
// first..second..third..fourth

main {
    echo replace("one one one", "one", "TWO")
    echo replace("a\\b\\c\\d", "\\", "\\\\")
    echo replace("first\nsecond\nthird\nfourth", "\n", "..")
}

[lens0021]

• replace(text, "\n", replace) seems to be broken.

[hdwalters]

Perhaps this comment would be better placed above the bash_version function definition, as it's defined once but called multiple times?

[hdwalters]

Also, now you've moved the BASH_VERSINFO test to a helper function, you no longer need the allow_absurd_cast annotation here.

[hdwalters]

I'm still not entirely happy with these tests:

1. I had in mind that both test files would contain calls to replace and replace_once, with identical parameters, to show the differences in behaviour.
2. Each function call should test a specific use case; they don't all have to contain backslashes!
3. Each function call should contain multiple copies of the search text.

[hdwalters]

For example:

import * from "std/text"

// Output
// TWO TWO TWO
// a\\b\\c\\d
// first..second..third..fourth

main {
    echo replace("one one one", "one", "TWO")
    echo replace("a\\b\\c\\d", "\\", "\\\\")
    echo replace("first\nsecond\nthird\nfourth", "\n", "..")
}

[hdwalters]

For example:

import * from "std/text"

// Output
// TWO one one
// a\\b\c\d
// first..second
// third
// fourth

main {
    echo replace_once("one one one", "one", "TWO")
    echo replace_once("a\\b\\c\\d", "\\", "\\\\")
    echo replace_once("first\nsecond\nthird\nfourth", "\n", "..")
}

The base branch was changed.