Fix issue#3: Custom lint rules failed to work caused by Android X migrating

Author: yongce

android_project_common.gradle

@@ -74,7 +74,7 @@ ext {
             'guava'            : "23.5-android",
 
             // debug
-            'leakcanary'       : "1.5.4",
+            'leakcanary'       : "1.6.3",
             'stetho'           : "1.5.0",
             'ktlint'           : "0.29.0",
 

archLintRules/build.gradle

@@ -1,7 +1,4 @@
-apply plugin: 'java-library'
-
-sourceCompatibility = JavaVersion.VERSION_1_8
-targetCompatibility = JavaVersion.VERSION_1_8
+apply plugin: 'kotlin'
 
 dependencies {
     compileOnly "com.android.tools.lint:lint-api:${versions.lintLib}"
@@ -18,3 +15,11 @@ jar {
         attributes("Lint-Registry-v2": "me.ycdev.android.arch.lint.MyIssueRegistry")
     }
 }
+
+test {
+    testLogging {
+        events "passed", "skipped", "failed", "standardOut", "standardError"
+        outputs.upToDateWhen { false }
+        showStandardStreams = true
+    }
+}

archLintRules/src/main/java/me/ycdev/android/arch/lint/MyBaseActivityDetector.java

@@ -0,0 +1,38 @@
+package me.ycdev.android.arch.lint
+
+import com.android.tools.lint.detector.api.Category
+import com.android.tools.lint.detector.api.Implementation
+import com.android.tools.lint.detector.api.Issue
+import com.android.tools.lint.detector.api.JavaContext
+import com.android.tools.lint.detector.api.Scope
+import com.android.tools.lint.detector.api.Severity
+import me.ycdev.android.arch.lint.base.InheritDetectorBase
+import org.jetbrains.uast.UElement
+import java.util.HashSet
+
+class MyBaseActivityDetector : InheritDetectorBase() {
+    override val applicableClasses: List<String> = arrayListOf("android.app.Activity")
+
+    override val wrapperClasses: HashSet<String> = hashSetOf(
+        "me.ycdev.android.arch.activity.BaseActivity",
+        "me.ycdev.android.arch.activity.PreferenceBaseActivity",
+        "me.ycdev.android.arch.activity.AppCompatBaseActivity"
+    )
+
+    override fun reportViolation(context: JavaContext, element: UElement) {
+        context.report(
+            ISSUE, element, context.getNameLocation(element),
+            "Please use the base classes for Activity."
+        )
+    }
+
+    companion object {
+        internal val ISSUE = Issue.create(
+            "MyBaseActivity",
+            "Base classes for Activity should be used.",
+            "Please use the base classes for Activity." + " So that we can do some unified behaviors.",
+            Category.CORRECTNESS, 5, Severity.ERROR,
+            Implementation(MyBaseActivityDetector::class.java, Scope.JAVA_FILE_SCOPE)
+        )
+    }
+}

archLintRules/src/main/java/me/ycdev/android/arch/lint/MyBaseActivityDetector.kt

@@ -0,0 +1,36 @@
+package me.ycdev.android.arch.lint
+
+import com.android.tools.lint.detector.api.Category
+import com.android.tools.lint.detector.api.Implementation
+import com.android.tools.lint.detector.api.Issue
+import com.android.tools.lint.detector.api.JavaContext
+import com.android.tools.lint.detector.api.Scope
+import com.android.tools.lint.detector.api.Severity
+import me.ycdev.android.arch.lint.base.WrapperDetectorBase
+import org.jetbrains.uast.UElement
+
+class MyBroadcastHelperDetector : WrapperDetectorBase() {
+    override val applicableMethods = arrayListOf("registerReceiver", "sendBroadcast")
+
+    override val wrapperClassName = "me.ycdev.android.lib.common.wrapper.BroadcastHelper"
+
+    override val targetClassNames = arrayOf("android.content.Context")
+
+    override fun reportViolation(context: JavaContext, element: UElement) {
+        context.report(
+            ISSUE, element, context.getLocation(element),
+            "Please use the wrapper class 'BroadcastHelper'."
+        )
+    }
+
+    companion object {
+        internal val ISSUE = Issue.create(
+            "MyBroadcastHelper",
+            "BroadcastHelper should be used.",
+            "Please use the wrapper class 'BroadcastHelper' to register broadcast receivers"
+                    + " and send broadcasts to avoid security issues.",
+            Category.CORRECTNESS, 5, Severity.ERROR,
+            Implementation(MyBroadcastHelperDetector::class.java, Scope.JAVA_FILE_SCOPE)
+        )
+    }
+}

archLintRules/src/main/java/me/ycdev/android/arch/lint/MyBroadcastHelperDetector.java

@@ -0,0 +1,70 @@
+package me.ycdev.android.arch.lint
+
+import com.android.tools.lint.detector.api.Category
+import com.android.tools.lint.detector.api.Implementation
+import com.android.tools.lint.detector.api.Issue
+import com.android.tools.lint.detector.api.JavaContext
+import com.android.tools.lint.detector.api.Scope
+import com.android.tools.lint.detector.api.Severity
+import me.ycdev.android.arch.lint.base.WrapperDetectorBase
+import org.jetbrains.uast.UElement
+
+class MyIntentHelperDetector : WrapperDetectorBase() {
+    override val applicableMethods = arrayListOf(
+        "hasExtra",
+        "getBooleanArrayExtra",
+        "getBooleanExtra",
+        "getBundleExtra",
+        "getByteArrayExtra",
+        "getByteExtra",
+        "getCharArrayExtra",
+        "getCharExtra",
+        "getCharSequenceArrayExtra",
+        "getCharSequenceArrayListExtra",
+        "getCharSequenceExtra",
+        "getDoubleArrayExtra",
+        "getDoubleExtra",
+        "getExtra",
+        "getExtras",
+        "getFloatArrayExtra",
+        "getFloatExtra",
+        "getIBinderExtra",
+        "getIntArrayExtra",
+        "getIBinderExtra",
+        "getIntArrayExtra",
+        "getIntegerArrayListExtra",
+        "getIntExtra",
+        "getLongArrayExtra",
+        "getLongExtra",
+        "getParcelableArrayExtra",
+        "getParcelableArrayListExtra",
+        "getParcelableExtra",
+        "getSerializableExtra",
+        "getShortArrayExtra",
+        "getShortExtra",
+        "getStringArrayExtra",
+        "getStringArrayListExtra",
+        "getStringExtra"
+    )
+
+    override val wrapperClassName = "me.ycdev.android.lib.common.wrapper.IntentHelper"
+
+    override val targetClassNames = arrayOf("android.content.Intent")
+
+    override fun reportViolation(context: JavaContext, element: UElement) {
+        context.report(
+            ISSUE, element, context.getLocation(element),
+            "Please use the wrapper class 'IntentHelper'."
+        )
+    }
+
+    companion object {
+        internal val ISSUE = Issue.create(
+            "MyIntentHelper",
+            "IntentHelper should be used.",
+            "Please use the wrapper class 'IntentHelper' to get Intent extras" + " to avoid security issues.",
+            Category.CORRECTNESS, 5, Severity.ERROR,
+            Implementation(MyIntentHelperDetector::class.java, Scope.JAVA_FILE_SCOPE)
+        )
+    }
+}