Skip to content

Commit e039db9

Browse files
committed
import checkstyle and code optimization done
1 parent 012e17b commit e039db9

File tree

5 files changed

+265
-5
lines changed

5 files changed

+265
-5
lines changed

build.gradle

+14
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ plugins {
22
id 'org.springframework.boot' version '2.6.4'
33
id 'io.spring.dependency-management' version '1.0.11.RELEASE'
44
id 'java'
5+
id 'checkstyle'
56
}
67

78
group = 'az.unitech.development.exchange'
@@ -43,3 +44,16 @@ dependencyManagement {
4344
tasks.named('test') {
4445
useJUnitPlatform()
4546
}
47+
48+
checkstyle {
49+
toolVersion = "8.15"
50+
configFile = file("${rootProject.projectDir}/config/checkstyle/checkstyle.xml")
51+
ignoreFailures = false
52+
}
53+
54+
tasks.withType(Checkstyle) {
55+
reports {
56+
xml.enabled true
57+
html.enabled true
58+
}
59+
}

config/checkstyle/checkstyle.xml

+246
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,246 @@
1+
<?xml version="1.0"?>
2+
<!DOCTYPE module PUBLIC
3+
"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
4+
"https://checkstyle.org/dtds/configuration_1_3.dtd">
5+
6+
<module name="Checker">
7+
<property name="charset" value="UTF-8"/>
8+
9+
<property name="severity" value="error"/>
10+
11+
<property name="fileExtensions" value="java, properties, xml"/>
12+
<!-- Checks for whitespace -->
13+
<!-- See http://checkstyle.sf.net/config_whitespace.html -->
14+
<module name="FileTabCharacter">
15+
<property name="eachLine" value="true"/>
16+
</module>
17+
18+
<module name="TreeWalker">
19+
<module name="OuterTypeFilename"/>
20+
<module name="IllegalTokenText">
21+
<property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
22+
<property name="format"
23+
value="\\u00(09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/>
24+
<property name="message"
25+
value="Consider using special escape sequence instead of octal value or Unicode escaped value."/>
26+
</module>
27+
<module name="AvoidEscapedUnicodeCharacters">
28+
<property name="allowEscapesForControlCharacters" value="true"/>
29+
<property name="allowByTailComment" value="true"/>
30+
<property name="allowNonPrintableEscapes" value="true"/>
31+
</module>
32+
<module name="LineLength">
33+
<property name="max" value="100"/>
34+
<property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
35+
</module>
36+
<module name="AvoidStarImport"/>
37+
<module name="OneTopLevelClass"/>
38+
<module name="NoLineWrap"/>
39+
<module name="EmptyBlock">
40+
<property name="option" value="TEXT"/>
41+
<property name="tokens"
42+
value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
43+
</module>
44+
<!--<module name="NeedBraces"/>-->
45+
<module name="LeftCurly"/>
46+
<module name="RightCurly">
47+
<property name="id" value="RightCurlySame"/>
48+
<property name="tokens"
49+
value="LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE,
50+
LITERAL_DO"/>
51+
</module>
52+
<module name="RightCurly">
53+
<property name="id" value="RightCurlyAlone"/>
54+
<property name="option" value="alone"/>
55+
<property name="tokens"
56+
value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, STATIC_INIT,
57+
INSTANCE_INIT"/>
58+
</module>
59+
<module name="WhitespaceAround">
60+
<property name="allowEmptyConstructors" value="true"/>
61+
<property name="allowEmptyMethods" value="true"/>
62+
<property name="allowEmptyTypes" value="true"/>
63+
<property name="allowEmptyLoops" value="true"/>
64+
<message key="ws.notFollowed"
65+
value="WhitespaceAround: ''{0}'' is not followed by whitespace. Empty blocks may only be represented as '{}' when not part of a multi-block statement (4.1.3)"/>
66+
<message key="ws.notPreceded"
67+
value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
68+
</module>
69+
<module name="OneStatementPerLine"/>
70+
<module name="MultipleVariableDeclarations"/>
71+
<module name="ArrayTypeStyle"/>
72+
<module name="MissingSwitchDefault"/>
73+
<module name="FallThrough"/>
74+
<module name="UpperEll"/>
75+
<module name="ModifierOrder"/>
76+
<module name="EmptyLineSeparator">
77+
<property name="allowNoEmptyLineBetweenFields" value="true"/>
78+
</module>
79+
<module name="SeparatorWrap">
80+
<property name="id" value="SeparatorWrapDot"/>
81+
<property name="tokens" value="DOT"/>
82+
<property name="option" value="nl"/>
83+
</module>
84+
<module name="SeparatorWrap">
85+
<property name="id" value="SeparatorWrapComma"/>
86+
<property name="tokens" value="COMMA"/>
87+
<property name="option" value="EOL"/>
88+
</module>
89+
<module name="SeparatorWrap">
90+
<!-- ELLIPSIS is EOL until https://github.com/google/styleguide/issues/258 -->
91+
<property name="id" value="SeparatorWrapEllipsis"/>
92+
<property name="tokens" value="ELLIPSIS"/>
93+
<property name="option" value="EOL"/>
94+
</module>
95+
<module name="SeparatorWrap">
96+
<!-- ARRAY_DECLARATOR is EOL until https://github.com/google/styleguide/issues/259 -->
97+
<property name="id" value="SeparatorWrapArrayDeclarator"/>
98+
<property name="tokens" value="ARRAY_DECLARATOR"/>
99+
<property name="option" value="EOL"/>
100+
</module>
101+
<module name="SeparatorWrap">
102+
<property name="id" value="SeparatorWrapMethodRef"/>
103+
<property name="tokens" value="METHOD_REF"/>
104+
<property name="option" value="nl"/>
105+
</module>
106+
<module name="PackageName">
107+
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
108+
<message key="name.invalidPattern"
109+
value="Package name ''{0}'' must match pattern ''{1}''."/>
110+
</module>
111+
<module name="TypeName">
112+
<message key="name.invalidPattern"
113+
value="Type name ''{0}'' must match pattern ''{1}''."/>
114+
</module>
115+
<module name="MemberName">
116+
<property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
117+
<message key="name.invalidPattern"
118+
value="Member name ''{0}'' must match pattern ''{1}''."/>
119+
</module>
120+
<module name="ParameterName">
121+
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
122+
<message key="name.invalidPattern"
123+
value="Parameter name ''{0}'' must match pattern ''{1}''."/>
124+
</module>
125+
<module name="LambdaParameterName">
126+
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
127+
<message key="name.invalidPattern"
128+
value="Lambda parameter name ''{0}'' must match pattern ''{1}''."/>
129+
</module>
130+
<module name="CatchParameterName">
131+
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
132+
<message key="name.invalidPattern"
133+
value="Catch parameter name ''{0}'' must match pattern ''{1}''."/>
134+
</module>
135+
<module name="LocalVariableName">
136+
<property name="tokens" value="VARIABLE_DEF"/>
137+
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
138+
<message key="name.invalidPattern"
139+
value="Local variable name ''{0}'' must match pattern ''{1}''."/>
140+
</module>
141+
<module name="ClassTypeParameterName">
142+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
143+
<message key="name.invalidPattern"
144+
value="Class type name ''{0}'' must match pattern ''{1}''."/>
145+
</module>
146+
<module name="MethodTypeParameterName">
147+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
148+
<message key="name.invalidPattern"
149+
value="Method type name ''{0}'' must match pattern ''{1}''."/>
150+
</module>
151+
<module name="InterfaceTypeParameterName">
152+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
153+
<message key="name.invalidPattern"
154+
value="Interface type name ''{0}'' must match pattern ''{1}''."/>
155+
</module>
156+
<module name="NoFinalizer"/>
157+
<module name="GenericWhitespace">
158+
<message key="ws.followed"
159+
value="GenericWhitespace ''{0}'' is followed by whitespace."/>
160+
<message key="ws.preceded"
161+
value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
162+
<message key="ws.illegalFollow"
163+
value="GenericWhitespace ''{0}'' should followed by whitespace."/>
164+
<message key="ws.notPreceded"
165+
value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
166+
</module>
167+
<module name="Indentation">
168+
<property name="basicOffset" value="4"/>
169+
<property name="braceAdjustment" value="0"/>
170+
<property name="caseIndent" value="4"/>
171+
<property name="throwsIndent" value="8"/>
172+
<property name="lineWrappingIndentation" value="8"/>
173+
<property name="arrayInitIndent" value="4"/>
174+
</module>
175+
<!--<module name="AbbreviationAsWordInName">-->
176+
<!--<property name="ignoreFinal" value="false"/>-->
177+
<!--<property name="allowedAbbreviations" value="DP,MQ"/>-->
178+
<!--<property name="allowedAbbreviationLength" value="1"/>-->
179+
<!--</module>-->
180+
<module name="OverloadMethodsDeclarationOrder"/>
181+
<module name="VariableDeclarationUsageDistance"/>
182+
<module name="CustomImportOrder">
183+
<!--<property name="sortImportsInGroupAlphabetically" value="false"/>-->
184+
<property name="separateLineBetweenGroups" value="true"/>
185+
<property name="customImportOrderRules" value="THIRD_PARTY_PACKAGE###STATIC"/>
186+
</module>
187+
<module name="MethodParamPad"/>
188+
<module name="NoWhitespaceBefore">
189+
<property name="tokens"
190+
value="COMMA, SEMI, POST_INC, POST_DEC, DOT, ELLIPSIS, METHOD_REF"/>
191+
<property name="allowLineBreaks" value="true"/>
192+
</module>
193+
<module name="ParenPad"/>
194+
<module name="OperatorWrap">
195+
<property name="option" value="EOL"/>
196+
<property name="tokens"
197+
value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR,
198+
LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR, METHOD_REF "/>
199+
</module>
200+
<module name="AnnotationLocation">
201+
<property name="id" value="AnnotationLocationMostCases"/>
202+
<property name="tokens"
203+
value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
204+
</module>
205+
<module name="AnnotationLocation">
206+
<property name="id" value="AnnotationLocationVariables"/>
207+
<property name="tokens" value="VARIABLE_DEF"/>
208+
<property name="allowSamelineMultipleAnnotations" value="true"/>
209+
</module>
210+
<module name="NonEmptyAtclauseDescription"/>
211+
<module name="JavadocTagContinuationIndentation"/>
212+
<!--<module name="SummaryJavadoc">-->
213+
<!--<property name="forbiddenSummaryFragments"-->
214+
<!--value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>-->
215+
<!--</module>-->
216+
<!--<module name="JavadocParagraph"/>-->
217+
<module name="AtclauseOrder">
218+
<property name="tagOrder" value="@param, @return, @throws, @deprecated"/>
219+
<property name="target"
220+
value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
221+
</module>
222+
<module name="JavadocMethod">
223+
<property name="scope" value="public"/>
224+
<property name="allowMissingParamTags" value="true"/>
225+
<property name="allowMissingThrowsTags" value="true"/>
226+
<property name="allowMissingReturnTag" value="true"/>
227+
<property name="allowMissingJavadoc" value="true"/>
228+
<property name="minLineCount" value="2"/>
229+
<property name="allowedAnnotations" value="Override, Test, Bean"/>
230+
<property name="allowThrowsTagsForSubclasses" value="true"/>
231+
<property name="tokens" value="METHOD_DEF"/>
232+
</module>
233+
<module name="MethodName">
234+
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
235+
<message key="name.invalidPattern"
236+
value="Method name ''{0}'' must match pattern ''{1}''."/>
237+
</module>
238+
<module name="SingleLineJavadoc">
239+
<property name="ignoreInlineTags" value="false"/>
240+
</module>
241+
<module name="EmptyCatchBlock">
242+
<property name="exceptionVariableName" value="expected"/>
243+
</module>
244+
<!--<module name="CommentsIndentation"/>-->
245+
</module>
246+
</module>

src/main/java/az/unitech/development/exchange/config/properties/CurrencyClientProperties.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
@ConfigurationProperties("api")
1111
public class CurrencyClientProperties {
1212

13-
public FastForex fastForex= new FastForex();
13+
public FastForex fastForex = new FastForex();
1414

1515
@Data
1616
public static class FastForex {

src/main/java/az/unitech/development/exchange/dto/request/ExchangeRequest.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,11 @@ public boolean isToCurrencyUSD() {
2727
return "USD".equals(to);
2828
}
2929

30-
public void setFrom(String from){
30+
public void setFrom(String from) {
3131
this.from = from.toUpperCase();
3232
}
3333

34-
public void setTo(String to){
34+
public void setTo(String to) {
3535
this.to = to.toUpperCase();
3636
}
3737

src/test/java/az/unitech/development/exchange/service/ExchangeServiceTest.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,8 @@ void calculate_WhenFromCurrencyAndToCurrencyAnotherIsUSD() {
8282
exchangeRequest.setAmount(BigDecimal.valueOf(100));
8383

8484
var toUSD =
85-
exchangeRequest.getAmount()
86-
.divide(currencyMap.get(exchangeRequest.getFrom()), 4, RoundingMode.HALF_UP);
85+
exchangeRequest.getAmount().divide(
86+
currencyMap.get(exchangeRequest.getFrom()), 4, RoundingMode.HALF_UP);
8787

8888
var fromUSD = toUSD.multiply(currencyMap.get(exchangeRequest.getTo()),
8989
new MathContext(4, RoundingMode.HALF_UP));

0 commit comments

Comments
 (0)