Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

New functions STR_SUBSTRING_AFTER and STR_SUBSTRING_BEFORE #513

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

New functions STR_SUBSTRING_AFTER and STR_SUBSTRING_BEFORE #513

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1fd6200
New functions STR_SUBSTRING_AFTER/BEFORE
oswaldobapvicjr Oct 24, 2024
e2977d1
Update functions.md
oswaldobapvicjr Oct 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 16 additions & 14 deletions docs/references/functions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,20 +33,22 @@ Available through the _ExpressionConfiguration.StandardFunctionsDictionary_ cons

### String Functions

| Name | Description |
|-------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
| STR_CONTAINS(string, substring) | Returns true if the string contains the substring (case-insensitive) |
| STR_ENDS_WITH(string, substring) | Returns true if the string ends with the substring (case-sensitive) |
| STR_FORMAT(format [,argument, ...]) | Returns a formatted string using the specified format string and arguments, using the configured locale |
| STR_LEFT(value, n) | Returns the first n characters from the left of the given string |
| STR_LENGTH(string) | Returns the length of the string |
| STR_LOWER(value) | Converts the given value to lower case |
| STR_MATCHES(string, pattern) | Returns true if the string matches the RegEx pattern |
| STR_RIGHT(value, n) | Returns the last n characters from the left of the given string |
| STR_STARTS_WITH(string, substring) | Returns true if the string starts with the substring (case-sensitive) |
| STR_SUBSTRING(string, start[, end]) | Returns a substring of the given string, starting at the _start_ index and ending at the _end_ index (the end of the string if not specified) |
| STR_TRIM(string) | Returns the given string with all leading and trailing space removed. |
| STR_UPPER(value) | Converts the given value to upper case |
| Name | Description |
|-----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
| STR_CONTAINS(string, substring) | Returns true if the string contains the substring (case-insensitive) |
| STR_ENDS_WITH(string, substring) | Returns true if the string ends with the substring (case-sensitive) |
| STR_FORMAT(format [,argument, ...]) | Returns a formatted string using the specified format string and arguments, using the configured locale |
| STR_LEFT(value, n) | Returns the first n characters from the left of the given string |
| STR_LENGTH(string) | Returns the length of the string |
| STR_LOWER(value) | Converts the given value to lower case |
| STR_MATCHES(string, pattern) | Returns true if the string matches the RegEx pattern |
| STR_RIGHT(value, n) | Returns the last n characters from the left of the given string |
| STR_STARTS_WITH(string, substring) | Returns true if the string starts with the substring (case-sensitive) |
| STR_SUBSTRING(string, start[, end]) | Returns a substring of the given string, starting at the _start_ index and ending at the _end_ index (the end of the string if not specified) |
| STR_SUBSTRING_AFTER(string, separator) | Returns the substring after the first occurrence of the _separator_ string on the given _string_ |
| STR_SUBSTRING_BEFORE(string, separator) | Returns the substring before the first occurrence of the _separator_ string on the given _string_ |
| STR_TRIM(string) | Returns the given string with all leading and trailing space removed. |
| STR_UPPER(value) | Converts the given value to upper case |

### Trigonometric Functions

Expand Down
4 changes: 4 additions & 0 deletions src/main/java/com/ezylang/evalex/config/ExpressionConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@
import com.ezylang.evalex.functions.string.StringMatchesFunction;
import com.ezylang.evalex.functions.string.StringRightFunction;
import com.ezylang.evalex.functions.string.StringStartsWithFunction;
import com.ezylang.evalex.functions.string.StringSubstringAfterFunction;
import com.ezylang.evalex.functions.string.StringSubstringBeforeFunction;
import com.ezylang.evalex.functions.string.StringSubstringFunction;
import com.ezylang.evalex.functions.string.StringTrimFunction;
import com.ezylang.evalex.functions.string.StringUpperFunction;
Expand Down Expand Up @@ -280,6 +282,8 @@ public class ExpressionConfiguration {
Map.entry("STR_RIGHT", new StringRightFunction()),
Map.entry("STR_STARTS_WITH", new StringStartsWithFunction()),
Map.entry("STR_SUBSTRING", new StringSubstringFunction()),
Map.entry("STR_SUBSTRING_AFTER", new StringSubstringAfterFunction()),
Map.entry("STR_SUBSTRING_BEFORE", new StringSubstringBeforeFunction()),
Map.entry("STR_TRIM", new StringTrimFunction()),
Map.entry("STR_UPPER", new StringUpperFunction()),
// date time functions
Expand Down
51 changes: 51 additions & 0 deletions src/main/java/com/ezylang/evalex/functions/string/StringSubstringAfterFunction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
/*
Copyright 2012-2024 Udo Klimaschewski

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package com.ezylang.evalex.functions.string;

import com.ezylang.evalex.EvaluationException;
import com.ezylang.evalex.Expression;
import com.ezylang.evalex.data.EvaluationValue;
import com.ezylang.evalex.functions.AbstractFunction;
import com.ezylang.evalex.functions.FunctionParameter;
import com.ezylang.evalex.parser.Token;

/**
* Returns the substring after the first occurrence of another (separator) string, or an empty
* string if the first string does not contain the second string.
*
* <p>For example: {@code STR_SUBSTRING_AFTER("2024/07/15", "/")} returns {@code "07/15"}.
*
* @author oswaldobapvicjr
*/
@FunctionParameter(name = "string")
@FunctionParameter(name = "separator")
public class StringSubstringAfterFunction extends AbstractFunction {
private static final String STR_EMPTY = "";

@Override
public EvaluationValue evaluate(
Expression expression, Token functionToken, EvaluationValue... parameterValues)
throws EvaluationException {
String string = parameterValues[0].getStringValue();
String separator = parameterValues[1].getStringValue();
return expression.convertValue(substringAfter(string, separator));
}

private String substringAfter(String string, String separator) {
int position = string.indexOf(separator);
return (position == -1) ? STR_EMPTY : string.substring(position + separator.length());
}
}
49 changes: 49 additions & 0 deletions src/main/java/com/ezylang/evalex/functions/string/StringSubstringBeforeFunction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
/*
Copyright 2012-2024 Udo Klimaschewski

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package com.ezylang.evalex.functions.string;

import com.ezylang.evalex.EvaluationException;
import com.ezylang.evalex.Expression;
import com.ezylang.evalex.data.EvaluationValue;
import com.ezylang.evalex.functions.AbstractFunction;
import com.ezylang.evalex.functions.FunctionParameter;
import com.ezylang.evalex.parser.Token;

/**
* Returns the substring before the first occurrence of another (separator) string, or the original
* string if it does not contain the second string.
*
* <p>For example: {@code STR_SUBSTRING_BEFORE("2024/07/15", "/")} returns {@code "2024"}.
*
* @author oswaldobapvicjr
*/
@FunctionParameter(name = "string")
@FunctionParameter(name = "separator")
public class StringSubstringBeforeFunction extends AbstractFunction {
@Override
public EvaluationValue evaluate(
Expression expression, Token functionToken, EvaluationValue... parameterValues)
throws EvaluationException {
String string = parameterValues[0].getStringValue();
String separator = parameterValues[1].getStringValue();
return expression.convertValue(substringBefore(string, separator));
}

private String substringBefore(String string, String separator) {
int position = string.indexOf(separator);
return (position == -1) ? string : string.substring(0, position);
}
}
31 changes: 31 additions & 0 deletions src/test/java/com/ezylang/evalex/functions/string/StringFunctionsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,37 @@ void testMatches(String expression, String expectedResult)
assertExpressionHasExpectedResult(expression, expectedResult);
}

@ParameterizedTest
@CsvSource(
delimiter = ':',
value = {
"STR_SUBSTRING_AFTER(\"myFile.json\", \".\") : json",
"STR_SUBSTRING_AFTER(\"2024/07/15\", \"/\") : 07/15",
"STR_SUBSTRING_AFTER(\"2024/07/15\", \"20\") : 24/07/15",
"STR_SUBSTRING_AFTER(\"test\", \"\") : 'test'",
"STR_SUBSTRING_AFTER(\"test\", \"a\") : ''",
"STR_SUBSTRING_AFTER(\"\", \"\") : ''"
})
void testSubstringAfter(String expression, String expectedResult)
throws EvaluationException, ParseException {
assertExpressionHasExpectedResult(expression, expectedResult);
}

@ParameterizedTest
@CsvSource(
delimiter = ':',
value = {
"STR_SUBSTRING_BEFORE(\"myFile.json\", \".\") : myFile",
"STR_SUBSTRING_BEFORE(\"2024/07/15\", \"/\") : 2024",
"STR_SUBSTRING_BEFORE(\"test\", \"\") : ''",
"STR_SUBSTRING_BEFORE(\"test\", \"a\") : 'test'",
"STR_SUBSTRING_BEFORE(\"\", \"\") : ''"
})
void testSubstringBefore(String expression, String expectedResult)
throws EvaluationException, ParseException {
assertExpressionHasExpectedResult(expression, expectedResult);
}

@ParameterizedTest
@CsvSource(
delimiter = ':',
Expand Down