rspec/rules/S1075/java/rule.adoc

52 lines
1.2 KiB
Plaintext
Raw Normal View History

2020-06-30 12:47:33 +02:00
include::../description.adoc[]
2023-10-18 11:18:09 +02:00
== How to fix it
=== Code examples
==== Noncompliant code example
2020-06-30 12:47:33 +02:00
2023-10-18 11:18:09 +02:00
[source,java,diff-id=1,diff-type=noncompliant]
2020-06-30 12:47:33 +02:00
----
public class Foo {
public Collection<User> listUsers() {
2021-06-09 15:24:12 +02:00
File userList = new File("/home/mylogin/Dev/users.txt"); // Noncompliant
2020-06-30 12:47:33 +02:00
Collection<User> users = parse(userList);
return users;
}
}
----
2023-10-18 11:18:09 +02:00
==== Compliant solution
2020-06-30 12:47:33 +02:00
2023-10-18 11:18:09 +02:00
[source,java,diff-id=1,diff-type=compliant]
2020-06-30 12:47:33 +02:00
----
public class Foo {
// Configuration is a class that returns customizable properties: it can be mocked to be injected during tests.
private Configuration config;
public Foo(Configuration myConfig) {
this.config = myConfig;
}
public Collection<User> listUsers() {
// Find here the way to get the correct folder, in this case using the Configuration object
String listingFolder = config.getProperty("myApplication.listingFolder");
// and use this parameter instead of the hard coded path
File userList = new File(listingFolder, "users.txt"); // Compliant
Collection<User> users = parse(userList);
return users;
}
}
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
'''
endif::env-github,rspecator-view[]