Use nio Files/Paths instead of Strings #727

staudtMarius · 2023-01-26T11:06:09Z

Resolves #723

sonatype-lift · 2023-01-26T11:11:57Z

src/main/java/edu/ie3/datamodel/io/csv/BufferedCsvWriter.java

   */
-  public BufferedCsvWriter(
-      String filePath, String[] headLineElements, String csvSep, boolean append)
+  public BufferedCsvWriter(Path filePath, String[] headLineElements, String csvSep, boolean append)


AvoidObjectArrays: Avoid accepting a String[]; consider an Iterable instead

ℹ️ Learn about @sonatype-lift commands

You can reply with the following commands. For example, reply with @sonatype-lift ignoreall to leave out all findings.

Command Usage

@sonatype-lift ignore Leave out the above finding from this PR

@sonatype-lift ignoreall Leave out all the existing findings from this PR

@sonatype-lift exclude <file|issue|path|tool> Exclude specified file|issue|path|tool from Lift findings by updating your config.toml file

Note: When talking to LiftBot, you need to refresh the page to see its response.
_{Click here to add LiftBot to another repo.}

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2023-01-26T11:11:59Z

src/main/java/edu/ie3/datamodel/io/csv/CsvFileDefinition.java


  public CsvFileDefinition(
-      String fileName, String directoryPath, String[] headLineElements, String csvSep) {
+      String fileName, Path directoryPath, String[] headLineElements, String csvSep) {


AvoidObjectArrays: Avoid accepting a String[]; consider an Iterable instead

ℹ️ Learn about @sonatype-lift commands

You can reply with the following commands. For example, reply with @sonatype-lift ignoreall to leave out all findings.

Command Usage

@sonatype-lift ignore Leave out the above finding from this PR

@sonatype-lift ignoreall Leave out all the existing findings from this PR

@sonatype-lift exclude <file|issue|path|tool> Exclude specified file|issue|path|tool from Lift findings by updating your config.toml file

Note: When talking to LiftBot, you need to refresh the page to see its response.
_{Click here to add LiftBot to another repo.}

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2023-01-26T11:12:01Z

src/main/java/edu/ie3/datamodel/io/connectors/CsvFileConnector.java

   */
  public BufferedReader initReader(Class<? extends UniqueEntity> clz) throws FileNotFoundException {
-    String filePath = null;
+    Path filePath = null;


Var: Non-constant variable missing @var annotation

Suggested change

Path filePath = null;

@Var Path filePath = null;

ℹ️ Learn about @sonatype-lift commands

You can reply with the following commands. For example, reply with @sonatype-lift ignoreall to leave out all findings.

Command Usage

@sonatype-lift ignore Leave out the above finding from this PR

@sonatype-lift ignoreall Leave out all the existing findings from this PR

@sonatype-lift exclude <file|issue|path|tool> Exclude specified file|issue|path|tool from Lift findings by updating your config.toml file

Note: When talking to LiftBot, you need to refresh the page to see its response.
_{Click here to add LiftBot to another repo.}

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2023-01-26T11:12:03Z

src/main/java/edu/ie3/datamodel/io/naming/DefaultDirectoryHierarchy.java

-              FilenameUtils.concat(
-                  this.projectDirectory.toString(), maybeSubDirectory.get().getRelPath()));
-      String relPath = this.baseDirectory.relativize(fullPath).toString();
+          Paths.get(this.projectDirectory.toString()).resolve(maybeSubDirectory.get().getRelPath());


PATH_TRAVERSAL_IN: This API (java/nio/file/Paths.get(Ljava/lang/String;[Ljava/lang/String;)Ljava/nio/file/Path;) reads a file whose location might be specified by user input

ℹ️ Learn about @sonatype-lift commands

You can reply with the following commands. For example, reply with @sonatype-lift ignoreall to leave out all findings.

Command Usage

@sonatype-lift ignore Leave out the above finding from this PR

@sonatype-lift ignoreall Leave out all the existing findings from this PR

@sonatype-lift exclude <file|issue|path|tool> Exclude specified file|issue|path|tool from Lift findings by updating your config.toml file

Note: When talking to LiftBot, you need to refresh the page to see its response.
_{Click here to add LiftBot to another repo.}

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2023-01-26T11:12:05Z

src/main/java/edu/ie3/datamodel/io/naming/DefaultDirectoryHierarchy.java

-    String baseDirectoryNormalized =
-        FilenameUtils.normalizeNoEndSeparator(baseDirectory, true) + FILE_SEPARATOR;
-    this.baseDirectory = Paths.get(baseDirectoryNormalized).toAbsolutePath();
+    Path baseDirectoryNormalized = Path.of(FilenameUtils.normalizeNoEndSeparator(baseDirectory.toString(), true));


💬 3 similar findings have been found in this PR

Varifier: Consider using var here to avoid boilerplate.

Suggested change

Path baseDirectoryNormalized = Path.of(FilenameUtils.normalizeNoEndSeparator(baseDirectory.toString(), true));

var baseDirectoryNormalized = Path.of(FilenameUtils.normalizeNoEndSeparator(baseDirectory.toString(), true));

🔎 Expand here to view all instances of this finding

File Path Line Number

src/main/java/edu/ie3/datamodel/io/connectors/CsvFileConnector.java 110

src/main/java/edu/ie3/datamodel/io/connectors/CsvFileConnector.java 279

src/main/java/edu/ie3/datamodel/io/connectors/CsvFileConnector.java 301

Visit the Lift Web Console to find more details in your report.

ℹ️ Learn about @sonatype-lift commands

You can reply with the following commands. For example, reply with @sonatype-lift ignoreall to leave out all findings.

Command Usage

@sonatype-lift ignore Leave out the above finding from this PR

@sonatype-lift ignoreall Leave out all the existing findings from this PR

@sonatype-lift exclude <file|issue|path|tool> Exclude specified file|issue|path|tool from Lift findings by updating your config.toml file

Note: When talking to LiftBot, you need to refresh the page to see its response.
_{Click here to add LiftBot to another repo.}

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2023-01-26T11:12:07Z

🛠 Lift Auto-fix

Some of the Lift findings in this PR can be automatically fixed. You can download and apply these changes in your local project directory of your branch to review the suggestions before committing.¹

# Download the patch
curl https://lift.sonatype.com/api/patch/github.com/ie3-institute/PowerSystemDataModel/727.diff -o lift-autofixes.diff

# Apply the patch with git
git apply lift-autofixes.diff

# Review the changes
git diff

Want it all in a single command? Open a terminal in your project's directory and copy and paste the following command:

curl https://lift.sonatype.com/api/patch/github.com/ie3-institute/PowerSystemDataModel/727.diff | git apply

Once you're satisfied commit and push your changes in your project.

You can preview the patch by opening the patch URL in the browser. ↩

sonatype-lift · 2023-01-27T10:52:46Z

src/main/java/edu/ie3/datamodel/io/naming/DefaultDirectoryHierarchy.java

-    String baseDirectoryNormalized =
-        FilenameUtils.normalizeNoEndSeparator(baseDirectory, true) + FILE_SEPARATOR;
-    this.baseDirectory = Paths.get(baseDirectoryNormalized).toAbsolutePath();
+    Path baseDirectoryNormalized =


Varifier: Consider using var here to avoid boilerplate.

Suggested change

Path baseDirectoryNormalized =

var baseDirectoryNormalized =

ℹ️ Learn about @sonatype-lift commands

You can reply with the following commands. For example, reply with @sonatype-lift ignoreall to leave out all findings.

Command Usage

@sonatype-lift ignore Leave out the above finding from this PR

@sonatype-lift ignoreall Leave out all the existing findings from this PR

@sonatype-lift exclude <file|issue|path|tool> Exclude specified file|issue|path|tool from Lift findings by updating your config.toml file

Note: When talking to LiftBot, you need to refresh the page to see its response.
_{Click here to add LiftBot to another repo.}

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

…strings' into ms/#723-use-nio-file-instead-of-strings

This reverts commit d819893.

Switching from string file path to nio Paths.

97c474b

staudtMarius added the code quality Code readability or structure is improved label Jan 26, 2023

staudtMarius added this to the Version 4.0 milestone Jan 26, 2023

staudtMarius self-assigned this Jan 26, 2023

sonatype-lift bot reviewed Jan 26, 2023

View reviewed changes

Adapting some tests.

3a5e400

sonatype-lift bot reviewed Jan 27, 2023

View reviewed changes

staudtMarius added 5 commits February 3, 2023 11:45

Adapting some tests.

c561ff4

Adding markdown support to docs.

d819893

fmt

aec3583

Merge remote-tracking branch 'origin/ms/#723-use-nio-file-instead-of-…

3484004

…strings' into ms/#723-use-nio-file-instead-of-strings

Revert "Adding markdown support to docs."

6c8f51c

This reverts commit d819893.

staudtMarius closed this Feb 7, 2023

staudtMarius deleted the ms/#723-use-nio-file-instead-of-strings branch February 7, 2023 10:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Use nio Files/Paths instead of Strings #727

Use nio Files/Paths instead of Strings #727

Uh oh!

staudtMarius commented Jan 26, 2023

Uh oh!

sonatype-lift bot Jan 26, 2023

Uh oh!

sonatype-lift bot Jan 26, 2023

Uh oh!

sonatype-lift bot Jan 26, 2023

Uh oh!

sonatype-lift bot Jan 26, 2023

Uh oh!

sonatype-lift bot Jan 26, 2023

Uh oh!

sonatype-lift bot commented Jan 26, 2023

Uh oh!

sonatype-lift bot Jan 27, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Command	Usage
`@sonatype-lift ignore`	Leave out the above finding from this PR
`@sonatype-lift ignoreall`	Leave out all the existing findings from this PR
`@sonatype-lift exclude <file\|issue\|path\|tool>`	Exclude specified `file\|issue\|path\|tool` from Lift findings by updating your config.toml file

	Path baseDirectoryNormalized = Path.of(FilenameUtils.normalizeNoEndSeparator(baseDirectory.toString(), true));
	var baseDirectoryNormalized = Path.of(FilenameUtils.normalizeNoEndSeparator(baseDirectory.toString(), true));

Use nio Files/Paths instead of Strings #727

Use nio Files/Paths instead of Strings #727

Uh oh!

Conversation

staudtMarius commented Jan 26, 2023

Uh oh!

sonatype-lift bot Jan 26, 2023

Choose a reason for hiding this comment

Uh oh!

sonatype-lift bot Jan 26, 2023

Choose a reason for hiding this comment

Uh oh!

sonatype-lift bot Jan 26, 2023

Choose a reason for hiding this comment

Uh oh!

sonatype-lift bot Jan 26, 2023

Choose a reason for hiding this comment

Uh oh!

sonatype-lift bot Jan 26, 2023

Choose a reason for hiding this comment

Uh oh!

sonatype-lift bot commented Jan 26, 2023

🛠 Lift Auto-fix

Footnotes

Uh oh!

sonatype-lift bot Jan 27, 2023

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant