Unexpected behaviour with quote_representation = '"'

[sid-maddy]

Description

Even with quote_representation = '"' set in the config file, yamlfix quotes already double-quoted values with single quotes.

Steps to reproduce

.yamlfix.toml

quote_representation = '"'

file_with_double_quoted_integer_value.yaml

port: "80"

$ yamlfix --config-file .yamlfix.toml file_with_double_quoted_integer_value.yaml

Current behavior

yamlfix quotes the port value with single quotes.

file_with_double_quoted_integer_value.yaml

---
port: '80'

FWIW, with quote_basic_values = true also set in the config file, it exhibits the desired behaviour.

---
port: "80"

Desired behaviour

yamlfix keeps the port value quoted with double quotes (even without setting quote_basic_values = true.)

Environment

$ yamlfix --version
------------------------------------------------------------------
     yamlfix: 1.12.0
     Python: 3.11.4
     Platform: macOS-13.4.1-arm64-arm-64bit
------------------------------------------------------------------

[lyz-code]

Hi @sid-maddy thanks for taking the time to open an issue, I reproduced the bug myself but after a quick look I haven't found a quick way to fix this issue as ruyaml doesn't allow us to set which character to use when quoting.

You can try with the next test (to be added to tests/unit/test_adapter_yaml.py):

    @pytest.mark.parametrize("quote_representation", quote_representations)
    def test_quote_values_without_quote_basic_values(self, quote_representation: str) -> None:
        """Quote only scalar values with configurable quote representation."""
        source = dedent(
            """\
            port: '80'
            """
        )
        quote = quote_representation
        fixed_source = dedent(
            f"""\
            ---
            port: {quote}80{quote}
            """
        )
        config = YamlfixConfig()
        config.quote_representation = quote_representation

        result = fix_code(source, config)

        assert result == fixed_source

And inspire yourself on _configure_quotation_for_basic_values at src/yamlfix/adapters

[jasonwbarnett]

@lyz-code maybe remove the config until the feature is fixed? I just ran into this today and it would have saved me time if the option simply wasn't available and/or it was documented that this is a known gap.

[stephan-henningsen]

That was a fun. How about adding a note to the documentation that this feature doesn't work?

[stephan-henningsen]

I took the liberty to open an issue in ruyaml. The problem is that I don't have any insight in the inner working and relation between yamlfix and ruyaml. I hope someone (*poke* @lyz-code) could fill in the missing details so we could get this thing rolling ;)