rspec/rules/S2639/java/rule.adoc

22 lines
1.0 KiB
Plaintext
Raw Normal View History

2020-06-30 12:48:07 +02:00
Regular expressions are powerful but tricky, and even those long used to using them can make mistakes.
The following should not be used as regular expressions:
2020-12-23 14:59:06 +01:00
* ``.`` - matches any single character. Used in ``replaceAll``, it matches _everything_
* ``|`` - normally used as an option delimiter. Used stand-alone, it matches the space between characters
* ``File.separator`` - matches the platform-specific file path delimiter. On Windows, this will be taken as an escape character
2020-06-30 12:48:07 +02:00
== Noncompliant Code Example
----
String str = "/File|Name.txt";
String clean = str.replaceAll(".",""); // Noncompliant; probably meant to remove only dot chars, but returns an empty string
String clean2 = str.replaceAll("|","_"); // Noncompliant; yields _/_F_i_l_e_|_N_a_m_e_._t_x_t_
String clean3 = str.replaceAll(File.separator,""); // Noncompliant; exception on Windows
String clean4 = str.replaceFirst(".",""); // Noncompliant;
String clean5 = str.replaceFirst("|","_"); // Noncompliant;
String clean6 = str.replaceFirst(File.separator,""); // Noncompliant;
----