add quoting to split_part

[patkearns10]

This is a:

• bug fix PR with no breaking changes — please ensure the base branch is main
• new functionality — please ensure the base branch is the latest dev/ branch
• a breaking change — please ensure the base branch is the latest dev/ branch

Description & motivation

https://dbt-labs.slack.com/archives/C010X3HKX2L/p1648149203621259

❔ Hi! Quick question about the split_part macro in dbt-utils:
documentation says this {{ dbt_utils.split_part(string_text='1,2,3', delimiter_text=',', part_number=1) }}
but I get an error unless I put the delimiter_text inside a double quote and a single quote like this {{ dbt_utils.split_part(string_text='1,2,3', delimiter_text="','", part_number=1) }} is this expected?

Made an update to add quoting as arguments.
I did this in a way that is nonbreaking to current usage, but adds functionality if you want to avoid weird input syntax "','"

Checklist

• I have verified that these changes work locally on the following warehouses (Note: it's okay if you do not have access to all warehouses, this helps us understand what has been covered)
  • BigQuery
  • Postgres
  • Redshift
  • Snowflake
• I followed guidelines to ensure that my changes will work on "non-core" adapters by:
  • dispatching any new macro(s) so non-core adapters can also use them (e.g. the star() source)
  • using the limit_zero() macro in place of the literal string: limit 0
  • using dbt_utils.type_* macros instead of explicit datatypes (e.g. dbt_utils.type_timestamp() instead of TIMESTAMP
• I have updated the README.md (if applicable)
• I have added tests & descriptions to my models (and macros if applicable)
• I have added an entry to CHANGELOG.md

[patkearns10]

before making changes:

Add quoting to both input fields:

add integration tests:

updated docs:

[joellabes]

@patkearns10 I had a look at the standard set across other macros, and things that need quotes to be passed through (e.g. datediff) all require double quotes. I think this is actually a documentation issue, not something that needs to be fixed in code.

I'm equally unexcited by adding quoting params in this macro as i was lowercase params in the last one - it means that now there's two ways to do the same thing; how do i know which one to use? What happens if I provide conflicting arguments?

{{ dbt_utils.split_part("'fixed_string'", "'_'", quote_string=False) }} -- equivalent, which one is better?
{{ dbt_utils.split_part('fixed_string', "'_'", quote_string=True) }} -- equivalent, which one is better?

{{ dbt_utils.split_part("'fixed_string'", "'_'", quote_string=True) }} -- NOW THERE'S TOO MANY QUOTES 😭 

As a side note, this would have been another good place to use the table-powered tests as opposed to checking the rendered string; if/when #513 moves forward, we wouldn't want this test to start failing for a non-breaking change.

I'm happy to either close this or see it repurposed into a documentation PR (or for you to point out the reasons I've got this wrong!) Sorry that the work (and you added tests! on the first go! ⭐ ) don't get to see the light of day - this is another reminder for me to get a move on with the contribution guidelines that ask for issues in advance of PRs 😬

[patkearns10]

No worries - I'll change this to just a documentation update!

[patkearns10]

All set here @joellabes

[joellabes]

⭐ thanks @patkearns10!