rspec/rules/S1075/java/rule.adoc

43 lines
1.1 KiB
Plaintext
Raw Normal View History

2020-06-30 12:47:33 +02:00
include::../description.adoc[]
== Noncompliant Code Example
----
public class Foo {
public Collection<User> listUsers() {
File userList = new File("/home/mylogin/Dev/users.txt"); // Non-Compliant
Collection<User> users = parse(userList);
return users;
}
}
----
== Compliant Solution
----
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;
}
}
----
include::../see.adoc[]
ifdef::rspecator-view[]
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::rspecator-view[]