aboutsummaryrefslogtreecommitdiffstats
path: root/build/hv-collector-analysis/src/main/kotlin/org/onap/dcae/collectors/veshv/analysis/PublicModifiersInImpl.kt
blob: 027cadea2fac9954164b2de6a4ca1bb586364298 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
/*
 * ============LICENSE_START=======================================================
 * dcaegen2-collectors-veshv
 * ================================================================================
 * Copyright (C) 2019 NOKIA
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * ============LICENSE_END=========================================================
 */
package org.onap.dcae.collectors.veshv.analysis

import io.gitlab.arturbosch.detekt.api.*
import org.jetbrains.kotlin.psi.*
import org.jetbrains.kotlin.psi.psiUtil.isPublic

class PublicModifiersInImpl(config: Config = Config.empty) : Rule(config) {
    override val issue: Issue = Issue(javaClass.simpleName, Severity.Maintainability,
            ISSUE_DESCRIPTION, Debt(mins=10))

    override fun visitKtFile(file: KtFile) {
        super.visitKtFile(file)

        if(file.packageFqName.toString().contains("impl")) {
            ImplVisitor.also {
                file.accept(it)
                if(it.publicDeclarations.isNotEmpty()){
                    for(entity in it.publicDeclarations)
                        report(CodeSmell(issue, entity, REPORT_MESSAGE))
                    it.publicDeclarations.clear()
                }
            }
        }
    }

    companion object {
        private val REPORT_MESSAGE =  """
                                Implementation package members cannot have public declarations.
                                Please, add `internal` modifier for this element to disallow usage outside of module
                            """.trimIndent()
        private const val ISSUE_DESCRIPTION = "Reports public modifiers inside '*.impl' package."
    }
}

private object ImplVisitor: DetektVisitor(){
    var publicDeclarations = mutableListOf<Entity>()

    override fun visitClassOrObject(classOrObject: KtClassOrObject) {
        if(classOrObject.isTopLevel() && classOrObject.isPublic){
            publicDeclarations.add(Entity.from(classOrObject))
        }
    }

    override fun visitNamedFunction(function: KtNamedFunction) {
        if(function.isTopLevel && function.isPublic){
            publicDeclarations.add(Entity.from(function))
        }
    }

    override fun visitProperty(property: KtProperty) {
        if(property.isTopLevel && property.isPublic) publicDeclarations.add(Entity.from(property))
    }
}