Add warning to suggest to use inline classes when a class has single property #716

aktsay6 · 2021-01-19T12:40:27Z

What's done:

Logic made
Added warn tests

This pull request closes #698

Actions checklist

Fixme

Since it is still experimental feature it shouldn't be fixed

### What's done: * Logic made * Added warn tests

codecov · 2021-01-19T12:51:16Z

Codecov Report

Merging #716 (824af31) into master (00a00ae) will decrease coverage by 0.02%.
The diff coverage is 75.00%.

@@             Coverage Diff              @@
##             master     #716      +/-   ##
============================================
- Coverage     80.15%   80.12%   -0.03%     
- Complexity     1922     1944      +22     
============================================
  Files            91       92       +1     
  Lines          4958     4982      +24     
  Branches       1584     1595      +11     
============================================
+ Hits           3974     3992      +18     
  Misses          241      241              
- Partials        743      749       +6

Flag	Coverage Δ	Complexity Δ
unittests	`80.12% <75.00%> (-0.03%)`	`0.00 <22.00> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ	Complexity Δ
...at-rules/src/main/kotlin/generated/WarningNames.kt	`0.00% <ø> (ø)`	`0.00 <0.00> (ø)`
...uleset/rules/chapter6/classes/InlineClassesRule.kt	`72.72% <72.72%> (ø)`	`22.00 <22.00> (?)`
...tlin/org/cqfn/diktat/ruleset/constants/Warnings.kt	`97.76% <100.00%> (+0.01%)`	`11.00 <0.00> (ø)`
...cqfn/diktat/ruleset/rules/DiktatRuleSetProvider.kt	`93.39% <100.00%> (+0.06%)`	`11.00 <0.00> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 00a00ae...824af31. Read the comment docs.

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/classes/InlineClassesRule.kt

### What's done: * Fixed bugs

diktat-analysis.yml

info/guide/guide-chapter-6.md

diktat-rules/src/test/kotlin/org/cqfn/diktat/ruleset/chapter6/InlineClassesWarnTest.kt

petertrr · 2021-01-20T09:04:14Z

diktat-rules/src/test/kotlin/org/cqfn/diktat/ruleset/chapter6/InlineClassesWarnTest.kt

+
+    @Test
+    @Tag(WarningNames.INLINE_CLASS_CAN_BE_USED)
+    fun `should not trigger on class with internal constructor`() {


Are you sure it's prohibited? IDEA doesn't seem to highlight it in red.

As IDEA highlighted, constructor should be public, otherwise class can't be inline

idk, my idea doesn't :)

Strange, I have this

IntelliJ IDEA 2020.3 (Ultimate Edition)
Build #IU-203.5981.155, built on December 1, 2020

hmm, do you try this code in diktat? I would expect results to be the same with same kotlin version. Which version of kotlin plugin do you have in idea? My is 203-1.4.30-RC-IJ6682.9 for idea 2020.3.2. Let's check if this code compiles with kotlin 1.4.21.

Now I have 1.4.21 and this code doesn't compile

OK, that is a bug in IDEA plugin. Maybe, it'll be allowed in 1.4.30, but let's allow only public for now.

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/classes/InlineClassesRule.kt

info/guide/guide-chapter-6.md

### What's done: * Fixed bugs

petertrr · 2021-01-20T15:13:15Z

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/classes/InlineClassesRule.kt

        } else if (classPsi.getProperties().isEmpty() && classPsi.hasExplicitPrimaryConstructor()) {
            return classPsi.primaryConstructorParameters.size == 1 &&
                    !classPsi.primaryConstructorParameters.first().node.hasChildOfType(VAR_KEYWORD) &&
-                    classPsi.primaryConstructorModifierList == null
+                    classPsi.primaryConstructor?.visibilityModifierType()?.value ?: "public" == "public"


Suggested change

classPsi.primaryConstructor?.visibilityModifierType()?.value ?: "public" == "public"

classPsi.primaryConstructor?.visibilityModifierType()?.value?.let { it == "public" } ?: true

Maybe, something like this?

### What's done: * Fixed bugs

# Conflicts: # diktat-rules/src/main/kotlin/generated/WarningNames.kt

orchestr7

go go go

### What's done: * Fixed bugs

kentr0w

lgfm

orchestr7 · 2021-01-26T10:42:32Z

info/guide/guide-chapter-6.md

@@ -357,6 +357,9 @@ fun main() {
 }
 ```

+### <a name="r6.1.12"></a> 6.1.12 Prefer Inline classes when a class has a single property


example?
Bad example - Good example

and more info about inline classes

orchestr7 · 2021-01-26T10:44:34Z

diktat-rules/src/test/kotlin/org/cqfn/diktat/ruleset/utils/RulesConfigYamlTest.kt

@@ -17,6 +17,7 @@ import kotlinx.serialization.encodeToString
 * Special test that checks that developer has not forgotten to add his warning to a diktat-analysis.yml
 * This file is needed to be in tact with latest changes in Warnings.kt
 */
+@Suppress("INLINE_CLASS_CAN_BE_USED")


may be inline this Test?

orchestr7

please look at comments

### What's done: * Fixed bugs

# Conflicts: # diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/DiktatRuleSetProvider.kt

### What's done: * Fixed bugs

orchestr7

lgtm

feature/inline-classes(#698)

bf7133e

### What's done: * Logic made * Added warn tests

aktsay6 added the enhancement New feature or request label Jan 19, 2021

aktsay6 requested review from petertrr, kentr0w and orchestr7 January 19, 2021 12:40

kentr0w requested changes Jan 19, 2021

View reviewed changes

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/classes/InlineClassesRule.kt Outdated Show resolved Hide resolved

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/classes/InlineClassesRule.kt Outdated Show resolved Hide resolved

kentr0w requested changes Jan 19, 2021

View reviewed changes

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/classes/InlineClassesRule.kt Outdated Show resolved Hide resolved

kentr0w requested changes Jan 19, 2021

View reviewed changes

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/classes/InlineClassesRule.kt Outdated Show resolved Hide resolved

aktsay6 added 5 commits January 19, 2021 16:57

feature/inline-classes(#698)

0db1a08

### What's done: * Fixed bugs

feature/inline-classes(#698)

3a3e1a2

### What's done: * Fixed bugs

feature/inline-classes(#698)

7816893

### What's done: * Fixed bugs

feature/inline-classes(#698)

41da95c

### What's done: * Fixed bugs

feature/inline-classes(#698)

262c513

### What's done: * Fixed bugs

petertrr requested changes Jan 20, 2021

View reviewed changes

petertrr reviewed Jan 20, 2021

View reviewed changes

info/guide/guide-chapter-6.md Outdated Show resolved Hide resolved

aktsay6 added 2 commits January 20, 2021 16:39

feature/inline-classes(#698)

8869988

### What's done: * Fixed bugs

feature/inline-classes(#698)

91568a2

### What's done: * Fixed bugs

petertrr reviewed Jan 20, 2021

View reviewed changes

aktsay6 added 3 commits January 21, 2021 11:03

feature/inline-classes(#698)

ca994dd

### What's done: * Fixed bugs

feature/inline-classes(#698)

79d7a2c

### What's done: * Fixed bugs

Merge branch 'master' into feature/inline-classes(#698)

edc0fa9

# Conflicts: # diktat-rules/src/main/kotlin/generated/WarningNames.kt

orchestr7 requested changes Jan 21, 2021

View reviewed changes

petertrr approved these changes Jan 21, 2021

View reviewed changes

aktsay6 added 3 commits January 21, 2021 17:29

feature/inline-classes(#698)

00e135b

### What's done: * Fixed bugs

feature/inline-classes(#698)

5d41510

### What's done: * Fixed bugs

feature/inline-classes(#698)

f4d0ca4

### What's done: * Fixed bugs

aktsay6 requested review from orchestr7 and kentr0w January 21, 2021 15:41

kentr0w approved these changes Jan 25, 2021

View reviewed changes

Merge branch 'master' into feature/inline-classes(#698)

fea5172

orchestr7 reviewed Jan 26, 2021

View reviewed changes

orchestr7 requested changes Jan 26, 2021

View reviewed changes

aktsay6 added 4 commits January 26, 2021 16:23

feature/inline-classes(#698)

fadb4b2

### What's done: * Fixed bugs

feature/inline-classes(#698)

7bc2826

### What's done: * Fixed bugs

Merge branch 'master' into feature/inline-classes(#698)

50c12b8

# Conflicts: # diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/DiktatRuleSetProvider.kt

feature/inline-classes(#698)

a786c82

### What's done: * Fixed bugs

aktsay6 requested a review from orchestr7 January 26, 2021 13:35

feature/inline-classes(#698)

55295a2

### What's done: * Fixed bugs

orchestr7 approved these changes Jan 27, 2021

View reviewed changes

Merge branch 'master' into feature/inline-classes(#698)

824af31

aktsay6 merged commit 05c3ebb into master Jan 27, 2021

aktsay6 deleted the feature/inline-classes(#698) branch January 27, 2021 09:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add warning to suggest to use inline classes when a class has single property #716

Add warning to suggest to use inline classes when a class has single property #716

aktsay6 commented Jan 19, 2021

codecov bot commented Jan 19, 2021 •

edited

Loading

petertrr Jan 20, 2021

aktsay6 Jan 20, 2021

petertrr Jan 20, 2021

aktsay6 Jan 20, 2021

petertrr Jan 20, 2021

aktsay6 Jan 21, 2021

petertrr Jan 21, 2021

petertrr Jan 20, 2021

orchestr7 left a comment

kentr0w left a comment

orchestr7 Jan 26, 2021 •

edited

Loading

orchestr7 Jan 26, 2021

orchestr7 left a comment

orchestr7 left a comment

	classPsi.primaryConstructor?.visibilityModifierType()?.value ?: "public" == "public"
	classPsi.primaryConstructor?.visibilityModifierType()?.value?.let { it == "public" } ?: true

Add warning to suggest to use inline classes when a class has single property #716

Add warning to suggest to use inline classes when a class has single property #716

Conversation

aktsay6 commented Jan 19, 2021

What's done:

Actions checklist

Fixme

codecov bot commented Jan 19, 2021 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

orchestr7 left a comment

Choose a reason for hiding this comment

kentr0w left a comment

Choose a reason for hiding this comment

orchestr7 Jan 26, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

orchestr7 left a comment

Choose a reason for hiding this comment

orchestr7 left a comment

Choose a reason for hiding this comment

codecov bot commented Jan 19, 2021 •

edited

Loading

orchestr7 Jan 26, 2021 •

edited

Loading