Skip to content

Commit b84cb3c

Browse files
louisjdmartinlouisjdmartin
committed
Refactor attributes to private
1 parent cbac5fe commit b84cb3c

File tree

13 files changed

+454
-209
lines changed

13 files changed

+454
-209
lines changed

‎src/main/java/fr/cnes/sonar/plugins/icode/check/ICodeSensor.java‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -121,14 +121,14 @@ public void execute(SensorContext sensorContext) {
121121

122122
// Handles issues.
123123
for (final AnalysisRule rule : analysisProject.getAnalysisRules()) {
124-
if(isRuleActive(activeRules, rule.analysisRuleId)) { // manage active rules
124+
if(isRuleActive(activeRules, rule.getAnalysisRuleId())) { // manage active rules
125125
saveIssue(sensorContext, scannedFiles, rule);
126-
} else if (ICodeMetricsProcessor.isMetric(rule.analysisRuleId)) { // manage trivial measures
126+
} else if (ICodeMetricsProcessor.isMetric(rule.getAnalysisRuleId())) { // manage trivial measures
127127
ICodeMetricsProcessor.saveMeasure(sensorContext, scannedFiles, rule);
128128
} else { // log ignored data
129129
LOGGER.info(String.format(
130130
"An issue for rule '%s' was detected by i-Code but this rule is deactivated in current analysis.",
131-
rule.analysisRuleId));
131+
rule.getAnalysisRuleId()));
132132
}
133133
}
134134

@@ -193,32 +193,32 @@ protected int runICode(final String command) throws IOException, InterruptedExce
193193
static void saveIssue(final SensorContext context, final Map<String, InputFile> files, final AnalysisRule issue) {
194194

195195
// Retrieve the file containing the issue.
196-
final InputFile inputFile = files.getOrDefault(issue.result.fileName, null);
196+
final InputFile inputFile = files.getOrDefault(issue.getResult().getFileName(), null);
197197

198198
if(inputFile!=null) {
199199
// Retrieve the ruleKey if it exists.
200-
final RuleKey ruleKey = RuleKey.of(ICodeRulesDefinition.getRepositoryKeyForLanguage(inputFile.language()), issue.analysisRuleId);
200+
final RuleKey ruleKey = RuleKey.of(ICodeRulesDefinition.getRepositoryKeyForLanguage(inputFile.language()), issue.getAnalysisRuleId());
201201

202202
// Create a new issue for SonarQube, but it must be saved using NewIssue.save().
203203
final NewIssue newIssue = context.newIssue();
204204
// Create a new location for this issue.
205205
final NewIssueLocation newIssueLocation = newIssue.newLocation();
206206

207207
// Calculate the line number of the issue (must be between 1 and max, otherwise 1).
208-
int issueLine = Integer.parseInt(issue.result.resultLine);
208+
int issueLine = Integer.parseInt(issue.getResult().getResultLine());
209209
issueLine = issueLine > 0 && issueLine <= inputFile.lines() ? issueLine : 1;
210210

211211
// Set trivial issue's attributes from AnalysisRule fields.
212212
newIssueLocation.on(inputFile);
213213
newIssueLocation.at(inputFile.selectLine(issueLine));
214-
newIssueLocation.message(issue.result.resultMessage);
214+
newIssueLocation.message(issue.getResult().getResultMessage());
215215
newIssue.forRule(ruleKey);
216216
newIssue.at(newIssueLocation);
217217
newIssue.save();
218218
} else {
219219
LOGGER.error(String.format(
220220
"Issue '%s' on file '%s' has not been saved because source file was not found.",
221-
issue.analysisRuleId, issue.result.fileName
221+
issue.getAnalysisRuleId(), issue.getResult().getFileName()
222222
));
223223
}
224224

@@ -239,14 +239,14 @@ protected Map<String, InputFile> getScannedFiles(final FileSystem fileSystem, fi
239239
// Looks for each file in file system, print an error if not found.
240240
for(final AnalysisFile file : files) {
241241
// Checks if the file system contains a file with corresponding path (relative or absolute).
242-
FilePredicate predicate = fileSystem.predicates().hasPath(file.fileName);
242+
FilePredicate predicate = fileSystem.predicates().hasPath(file.getFileName());
243243
InputFile inputFile = fileSystem.inputFile(predicate);
244244
if(inputFile!=null) {
245-
result.put(file.fileName, inputFile);
245+
result.put(file.getFileName(), inputFile);
246246
} else {
247247
LOGGER.error(String.format(
248248
"The source file '%s' was not found.",
249-
file.fileName
249+
file.getFileName()
250250
));
251251
}
252252
}

‎src/main/java/fr/cnes/sonar/plugins/icode/languages/ICodeQualityProfiles.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ private void createBuiltInProfile(final Context context, final String language,
6868
final RulesDefinition rules = (RulesDefinition) XmlHandler.unmarshal(stream, RulesDefinition.class);
6969
// Activate all i-Code CNES rules.
7070
for(final Rule rule : rules.getRules()) {
71-
defaultProfile.activateRule(ICodeRulesDefinition.getRepositoryKeyForLanguage(language), rule.key);
71+
defaultProfile.activateRule(ICodeRulesDefinition.getRepositoryKeyForLanguage(language), rule.getKey());
7272
}
7373
// Save the default profile.
7474
defaultProfile.setDefault(true);

‎src/main/java/fr/cnes/sonar/plugins/icode/measures/ICodeMetricsProcessor.java‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -73,13 +73,13 @@ public static void saveMeasure(final SensorContext context, final Map<String, In
7373
// Create a new measure from the scan context.
7474
final NewMeasure<Integer> newMeasure = context.newMeasure();
7575
// i-Code rule id.
76-
final String metricKey = rule.analysisRuleId;
76+
final String metricKey = rule.getAnalysisRuleId();
7777
// Determine if a measure is relative to a file or a method.
78-
final String metricScope = rule.result.resultTypePlace;
78+
final String metricScope = rule.getResult().getResultTypePlace();
7979
// Component concerned by the measure.
80-
final String metricComponent = rule.result.fileName;
80+
final String metricComponent = rule.getResult().getFileName();
8181
// Component concerned by the measure.
82-
final String measureValue = rule.result.resultValue;
82+
final String measureValue = rule.getResult().getResultValue();
8383

8484
// Is true if the metric must be interpreted by the plugin.
8585
boolean isCalculated = false;
@@ -142,8 +142,8 @@ public static void saveExtraMeasures(final SensorContext context, final Map<Stri
142142

143143
// Collect all measures on methods into specific list
144144
for(final AnalysisRule rule : project.getAnalysisRules()) {
145-
final String type = rule.result.resultTypePlace;
146-
final String id = rule.analysisRuleId;
145+
final String type = rule.getResult().getResultTypePlace();
146+
final String id = rule.getAnalysisRuleId();
147147
if(id.contains(COMMON_METRICS_KEY_PART) && type.equals("method")) {
148148
final List<AnalysisRule> sub = measures.getOrDefault(id, new ArrayList<>());
149149
sub.add(rule);
@@ -182,7 +182,7 @@ private static void computeFunctions(final SensorContext context, final Map<Stri
182182

183183
// Compute number of functions by file.
184184
for(final AnalysisRule measure : rawMeasures) {
185-
final String file = measure.result.fileName;
185+
final String file = measure.getResult().getFileName();
186186
Integer sum = functions.getOrDefault(file, 0) + 1;
187187
functions.put(file, sum);
188188
}
@@ -213,8 +213,8 @@ private static void computeComplexity(final SensorContext context, final Map<Str
213213

214214
// Compute complexity sum value by file.
215215
for(final AnalysisRule measure : rawMeasures) {
216-
final String file = measure.result.fileName;
217-
final Integer value = Double.valueOf((measure.result.resultValue)).intValue();
216+
final String file = measure.getResult().getFileName();
217+
final Integer value = Double.valueOf((measure.getResult().getResultValue())).intValue();
218218
Integer sum = complexity.getOrDefault(file, 0);
219219
sum += value;
220220
complexity.put(file, sum);
@@ -246,8 +246,8 @@ private static void computeNesting(final SensorContext context, final Map<String
246246

247247
// compute max nesting value by file
248248
for(final AnalysisRule measure : rawMeasures) {
249-
final String file = measure.result.fileName;
250-
final Integer value = Double.valueOf((measure.result.resultValue)).intValue();
249+
final String file = measure.getResult().getFileName();
250+
final Integer value = Double.valueOf((measure.getResult().getResultValue())).intValue();
251251
Integer max = nesting.getOrDefault(file, 0);
252252
max = Math.max(max,value);
253253
nesting.put(file, max);

‎src/main/java/fr/cnes/sonar/plugins/icode/model/AnalysisFile.java‎

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,22 @@
2525
* @author lequal
2626
*/
2727
public class AnalysisFile {
28-
public String language;
29-
public String fileName;
28+
private String language;
29+
private String fileName;
30+
31+
public String getLanguage() {
32+
return language;
33+
}
34+
35+
public void setLanguage(String language) {
36+
this.language = language;
37+
}
38+
39+
public String getFileName() {
40+
return fileName;
41+
}
42+
43+
public void setFileName(String fileName) {
44+
this.fileName = fileName;
45+
}
3046
}

‎src/main/java/fr/cnes/sonar/plugins/icode/model/AnalysisInformations.java‎

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,31 @@
2525
* @author lequal
2626
*/
2727
public class AnalysisInformations {
28-
public String analysisConfigurationId;
29-
public String analysisDate;
30-
public String author;
28+
private String analysisConfigurationId;
29+
private String analysisDate;
30+
private String author;
31+
32+
public String getAnalysisConfigurationId() {
33+
return analysisConfigurationId;
34+
}
35+
36+
public void setAnalysisConfigurationId(String analysisConfigurationId) {
37+
this.analysisConfigurationId = analysisConfigurationId;
38+
}
39+
40+
public String getAnalysisDate() {
41+
return analysisDate;
42+
}
43+
44+
public void setAnalysisDate(String analysisDate) {
45+
this.analysisDate = analysisDate;
46+
}
47+
48+
public String getAuthor() {
49+
return author;
50+
}
51+
52+
public void setAuthor(String author) {
53+
this.author = author;
54+
}
3155
}

‎src/main/java/fr/cnes/sonar/plugins/icode/model/AnalysisProject.java‎

Lines changed: 49 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,11 @@
2828
* @author lequal
2929
*/
3030
public class AnalysisProject {
31-
public String analysisProjectName;
32-
public String analysisProjectVersion;
33-
public AnalysisInformations analysisInformations;
34-
public AnalysisFile[] analysisFile;
35-
public AnalysisRule[] analysisRule;
31+
private String analysisProjectName;
32+
private String analysisProjectVersion;
33+
private AnalysisInformations analysisInformations;
34+
private AnalysisFile[] analysisFile;
35+
private AnalysisRule[] analysisRule;
3636

3737
/**
3838
* Getter for accessing analysis rules (issues).
@@ -41,8 +41,8 @@ public class AnalysisProject {
4141
public List<AnalysisRule> getAnalysisRules() {
4242
// Retrieve issues (called rules)
4343
List<AnalysisRule> rules;
44-
if(analysisRule!=null) {
45-
rules = Arrays.asList(analysisRule);
44+
if(getAnalysisRule() !=null) {
45+
rules = Arrays.asList(getAnalysisRule());
4646
} else {
4747
rules = new ArrayList<>();
4848
}
@@ -56,11 +56,51 @@ public List<AnalysisRule> getAnalysisRules() {
5656
public List<AnalysisFile> getAnalysisFiles() {
5757
// Retrieve files
5858
List<AnalysisFile> files;
59-
if(analysisFile!=null) {
60-
files = Arrays.asList(analysisFile);
59+
if(getAnalysisFile() !=null) {
60+
files = Arrays.asList(getAnalysisFile());
6161
} else {
6262
files = new ArrayList<>();
6363
}
6464
return files;
6565
}
66+
67+
public String getAnalysisProjectName() {
68+
return analysisProjectName;
69+
}
70+
71+
public void setAnalysisProjectName(String analysisProjectName) {
72+
this.analysisProjectName = analysisProjectName;
73+
}
74+
75+
public String getAnalysisProjectVersion() {
76+
return analysisProjectVersion;
77+
}
78+
79+
public void setAnalysisProjectVersion(String analysisProjectVersion) {
80+
this.analysisProjectVersion = analysisProjectVersion;
81+
}
82+
83+
public AnalysisInformations getAnalysisInformations() {
84+
return analysisInformations;
85+
}
86+
87+
public void setAnalysisInformations(AnalysisInformations analysisInformations) {
88+
this.analysisInformations = analysisInformations;
89+
}
90+
91+
public AnalysisFile[] getAnalysisFile() {
92+
return analysisFile;
93+
}
94+
95+
public void setAnalysisFile(AnalysisFile[] analysisFile) {
96+
this.analysisFile = analysisFile;
97+
}
98+
99+
public AnalysisRule[] getAnalysisRule() {
100+
return analysisRule;
101+
}
102+
103+
public void setAnalysisRule(AnalysisRule[] analysisRule) {
104+
this.analysisRule = analysisRule;
105+
}
66106
}

‎src/main/java/fr/cnes/sonar/plugins/icode/model/AnalysisRule.java‎

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,24 @@
2626
*/
2727
public class AnalysisRule {
2828

29-
public String analysisRuleId;
30-
public Result result;
29+
public String getAnalysisRuleId() {
30+
return analysisRuleId;
31+
}
32+
33+
public Result getResult() {
34+
return result;
35+
}
36+
37+
private String analysisRuleId;
38+
39+
public void setAnalysisRuleId(String analysisRuleId) {
40+
this.analysisRuleId = analysisRuleId;
41+
}
42+
43+
public void setResult(Result result) {
44+
this.result = result;
45+
}
46+
47+
private Result result;
3148

3249
}

‎src/main/java/fr/cnes/sonar/plugins/icode/model/Result.java‎

Lines changed: 62 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,67 @@
2525
*/
2626
public class Result {
2727

28-
public String resultId;
29-
public String fileName;
30-
public String resultLine;
31-
public String resultTypePlace;
32-
public String resultNamePlace;
33-
public String resultValue;
34-
public String resultMessage;
28+
private String resultId;
29+
private String fileName;
30+
private String resultLine;
31+
private String resultTypePlace;
32+
private String resultNamePlace;
33+
private String resultValue;
34+
private String resultMessage;
3535

36+
public String getResultId() {
37+
return resultId;
38+
}
39+
40+
public void setResultId(String resultId) {
41+
this.resultId = resultId;
42+
}
43+
44+
public String getFileName() {
45+
return fileName;
46+
}
47+
48+
public void setFileName(String fileName) {
49+
this.fileName = fileName;
50+
}
51+
52+
public String getResultLine() {
53+
return resultLine;
54+
}
55+
56+
public void setResultLine(String resultLine) {
57+
this.resultLine = resultLine;
58+
}
59+
60+
public String getResultTypePlace() {
61+
return resultTypePlace;
62+
}
63+
64+
public void setResultTypePlace(String resultTypePlace) {
65+
this.resultTypePlace = resultTypePlace;
66+
}
67+
68+
public String getResultNamePlace() {
69+
return resultNamePlace;
70+
}
71+
72+
public void setResultNamePlace(String resultNamePlace) {
73+
this.resultNamePlace = resultNamePlace;
74+
}
75+
76+
public String getResultValue() {
77+
return resultValue;
78+
}
79+
80+
public void setResultValue(String resultValue) {
81+
this.resultValue = resultValue;
82+
}
83+
84+
public String getResultMessage() {
85+
return resultMessage;
86+
}
87+
88+
public void setResultMessage(String resultMessage) {
89+
this.resultMessage = resultMessage;
90+
}
3691
}

0 commit comments

Comments
 (0)