Question marks in a query don't match number of arguments lint check by geralt-encore · Pull Request #220 · square/sqlbrite

geralt-encore · 2017-11-12T16:27:11Z

This is my first lint check so I am not sure if I've covered all the cases. I was using Timber lint checks as a reference. I'll appreciate any feedback!

JakeWharton · 2017-11-21T20:59:44Z

Thanks! I'll take a look soon here. If you're feeling generous you can rebase on the latest master for build fixes and version updates.

geralt-encore · 2017-11-22T10:24:11Z

Rebased generously :)

JakeWharton

This is great. I only have some small nits.

JakeWharton · 2017-11-29T03:00:17Z

checks/src/main/java/com/squareup/sqlbrite3/BriteIssueRegistry.kt

@@ -0,0 +1,23 @@
+/*
+ * Copyright (C) 2015 Square, Inc.


JakeWharton · 2017-11-29T03:00:35Z

checks/src/main/java/com/squareup/sqlbrite3/SqlBriteArgCountDetector.kt

@@ -0,0 +1,74 @@
+/*
+ * Copyright (C) 2015 Square, Inc.


JakeWharton · 2017-11-29T03:01:41Z

checks/src/main/java/com/squareup/sqlbrite3/SqlBriteArgCountDetector.kt

+        "Number of provided arguments doesn't match number " +
+            "of arguments specified in query",
+        "When providing arguments to query you need to provide the same amount of" +
+            "arguments that is specified in query.",


nit: missing space between "of" and "arguments" inside the concatenation. I would prefer it after "of" similar to the above string.

JakeWharton · 2017-11-29T03:02:21Z

checks/src/main/java/com/squareup/sqlbrite3/SqlBriteArgCountDetector.kt

+    val evaluator = context.evaluator
+
+    if (evaluator.isMemberInClass(method, BRITE_DATABASE)) {
+      // skip non varargs overloads


super nit: can you capitalize your comments and add periods? comments should be sentences.

JakeWharton · 2017-11-29T03:03:52Z

checks/src/main/java/com/squareup/sqlbrite3/SqlBriteArgCountDetector.kt

+      val questionMarksCount = sql.count { it == '?' }
+      if (argumentsCount != questionMarksCount) {
+        context.report(ISSUE, call, context.getLocation(call), "Wrong argument count, " +
+            "query $sql requires $questionMarksCount arguments, but was provided" +


can you hoist the "arguments" word here and on the next line out to two local variables and check whether or not the respective count variable is 1. If so, make it the singular "argument" and if it's not 1 make it "arguments". It's a small detail, but an easy one to fix.

JakeWharton · 2017-11-29T03:04:28Z

checks/src/test/java/com/squareup/sqlbrite3/SqlBriteArgCountDetectorTest.kt

@@ -0,0 +1,203 @@
+/*
+ * Copyright (C) 2015 Square, Inc.


JakeWharton · 2017-11-29T03:06:45Z

settings.gradle

 include ':sqlbrite'
 include ':sqlbrite-kotlin'
 include ':sample'
+include ':checks'


nit: can you name this 'lint-checks' or 'sqlbrite-lint'? 'checks' is a bit vague.

JakeWharton · 2017-11-29T03:07:51Z

@jrodbx when you get back from vacation can you take a quick look at this?

geralt-encore · 2017-11-29T08:16:49Z

Cool! Thanks for the review.

vanniktech · 2017-11-29T09:33:31Z

sqlbrite-lint/src/main/java/com/squareup/sqlbrite3/SqlBriteArgCountDetector.kt

+        Category.MESSAGES,
+        9,
+        Severity.ERROR,
+        Implementation(SqlBriteArgCountDetector::class.java, Scope.JAVA_FILE_SCOPE))


We probably also want to run this lint check in test sources. This can be done using EnumSet.of(JAVA_FILE, TEST_SOURCES))

vanniktech · 2017-11-29T09:38:26Z

sqlbrite-lint/src/main/java/com/squareup/sqlbrite3/SqlBriteArgCountDetector.kt

+
+  private fun UCallExpression.isQueryMethod() = methodName == QUERY_METHOD_NAME
+
+  private fun String.pluralize(count: Int) = if (count == 1) this else this + "s"


There's already this function in LintUtils.pluralize but unfortuantely it's private :( we could request it to be made public

vanniktech · 2017-11-29T09:39:25Z

sqlbrite-lint/src/test/java/com/squareup/sqlbrite3/SqlBriteArgCountDetectorTest.kt

+class SqlBriteArgCountDetectorTest : LintDetectorTest() {
+
+  companion object {
+    private val BRITE_DATABASE_STUB = TestFiles.java(


nit: also statically import?

vanniktech · 2017-11-29T09:40:05Z

sqlbrite-lint/src/test/java/com/squareup/sqlbrite3/SqlBriteArgCountDetectorTest.kt

+import com.android.tools.lint.checks.infrastructure.LintDetectorTest
+import com.android.tools.lint.checks.infrastructure.TestFiles
+
+class SqlBriteArgCountDetectorTest : LintDetectorTest() {


since you're using the new way of testing by using lint() you no longer need to extend from LintDetectorTest however you'll then need to use Junit4 and add the @test annotation on all of the methods

vanniktech · 2017-11-29T09:40:28Z

sqlbrite-lint/src/test/java/com/squareup/sqlbrite3/SqlBriteArgCountDetectorTest.kt

+
+  override fun getIssues() = listOf(SqlBriteArgCountDetector.ISSUE)
+
+  fun testCleanCaseWithWithQueryAsLiteral() {


Here it's this then:

@Test fun cleanCaseWithWithQueryAsLiteral() {

vanniktech · 2017-11-29T09:41:52Z

sqlbrite-lint/src/test/java/com/squareup/sqlbrite3/SqlBriteArgCountDetectorTest.kt

+              }
+            """.trimIndent()))
+        .run()
+        .expect("src/test/pkg/Test.java:11: " +


You could use the """ here with trimMargin() similiar to:

.expect(""" |res/layout/random.xml: Warning: Layout does not start with one of the following prefixes: activity_, view_, fragment_, dialog_, bottom_sheet_, adapter_item_, divider_, space_ [WrongLayoutName] |0 errors, 1 warnings """.trimMargin())

I don't know, I think that I got an idea how the function works, but I just can't make it work. Tbh, not even sure if it brings more readability than regular string concatenation in that case

vanniktech · 2017-11-29T13:22:47Z

sqlbrite-lint/src/test/java/com/squareup/sqlbrite3/SqlBriteArgCountDetectorTest.kt


              }
            """.trimIndent()))
+        .detector(SqlBriteArgCountDetector())


no need for passing the detctor as the issues function takes the Issue which has an implementation that links to SqlBriteArgCountDetector Implementation(SqlBriteArgCountDetector::class.java, EnumSet.of(JAVA_FILE, TEST_SOURCES)))

jrodbx

LGTM with a few requests!

jrodbx · 2017-12-09T23:46:21Z

build.gradle

+  lintChecks = "com.android.tools.lint:lint-checks:${versions.lint}"
+  lint = "com.android.tools.lint:lint:${versions.lint}"
+  lintTests = "com.android.tools.lint:lint-tests:${versions.lint}"
+  lintTestUtils = "com.android.tools:testutils:${versions.lint}"


delete. testutils is pulled in transitively by lint-tests

jrodbx · 2017-12-09T23:48:48Z

sqlbrite-lint/build.gradle

+
+  testCompile rootProject.ext.junit
+  testCompile rootProject.ext.lint
+  testCompile rootProject.ext.lintTests


testCompile => testImplementation now that this project is using Android Gradle Plugin 3.0.

jrodbx · 2017-12-09T23:48:55Z

sqlbrite-lint/build.gradle

+  testCompile rootProject.ext.junit
+  testCompile rootProject.ext.lint
+  testCompile rootProject.ext.lintTests
+  testCompile rootProject.ext.lintTestUtils


jrodbx · 2017-12-09T23:49:07Z

sqlbrite-lint/src/main/java/com/squareup/sqlbrite3/SqlBriteArgCountDetector.kt

+
+      // Position of sql parameter depends on method.
+      val sql = evaluateString(context,
+          call.valueArguments[if (call.isQueryMethod()) 0 else 1], true) ?: return


jrodbx · 2017-12-09T23:50:23Z

sqlbrite-lint/src/test/java/com/squareup/sqlbrite3/SqlBriteArgCountDetectorTest.kt

+              import com.squareup.sqlbrite3.BriteDatabase;
+
+              public class Test {
+


nit: remove blank line after each test class's opening brace/before QUERY declaration

geralt-encore · 2017-12-10T10:59:17Z

Thanks for the review @jrodbx !

JakeWharton · 2017-12-12T03:58:24Z

sqlbrite-lint/src/main/java/com/squareup/sqlbrite3/SqlBriteArgCountDetector.kt

+import com.android.tools.lint.detector.api.Severity
+import com.intellij.psi.PsiMethod
+import org.jetbrains.uast.UCallExpression
+import java.util.*


nit: expand this to individual imports. we don't allow star imports

JakeWharton

Some final small things from me. Otherwise let's get this merged.

JakeWharton · 2017-12-16T00:49:16Z

settings.gradle

 include ':sqlbrite'
 include ':sqlbrite-kotlin'
 include ':sample'
+include ':sqlbrite-lint'


super nit: can you move this up so it's properly alphabetized with the other sqlbrite-prefixed modules. "sample" is intentionally last

JakeWharton · 2017-12-16T00:50:00Z

sqlbrite-lint/build.gradle

+apply plugin: 'kotlin'
+
+dependencies {
+  compileOnly rootProject.ext.kotlinStdLib


This should be implementation since, in theory, future versions of lint could not be based on Kotlin and thus not have the stdlib already on the classpath.

If I mark it as implementation instead of compileOnly I have this error:

Execution failed for task :sqlbrite:prepareLintJar. Found more than one jar in the 'lintChecks' configuration. Only one file is supported. If using a separate Gradle project, make sure compilation dependencies are using compileOnly

That's... interesting. I mean it makes sense, but I guess we have to assume that lint will always contain the Kotlin stdlib as a result.

JakeWharton · 2017-12-16T00:50:21Z

sqlbrite-lint/build.gradle

+dependencies {
+  compileOnly rootProject.ext.kotlinStdLib
+  compileOnly rootProject.ext.lintApi
+  compileOnly rootProject.ext.lintChecks


@jrodbx We need both of these? Also is compileOnly correct for both?

At least in the official custom lint rule sample, they have it like that.
https://github.com/googlesamples/android-custom-lint-rules/blob/master/android-studio-3/checks/build.gradle

compileOnly is correct for both, since the runtime will provide the classes; however, good catch on the unnecessary lintChecks dependency. that's only needed when you're referencing/subclassing from the standard lint checks.

@geralt-encore it doesn't appear that you're relying on the standard lint checks, so you can remove the lintChecks dependency.

@jrodbx thanks for the explanation! Wasn't sure about this dependency

JakeWharton · 2017-12-18T14:52:21Z

Thanks!

Question marks in a query don't match number of arguments lint check

c4f9c3f

JakeWharton approved these changes Nov 29, 2017

View reviewed changes

Fix PR comments

d1a3999

vanniktech reviewed Nov 29, 2017

View reviewed changes

Fix more PR comments

a9439c9

vanniktech reviewed Nov 29, 2017

View reviewed changes

Remove unnecessary detector call in tests

3b88397

vanniktech approved these changes Nov 29, 2017

View reviewed changes

jrodbx approved these changes Dec 9, 2017

View reviewed changes

geralt-encore added 2 commits December 10, 2017 12:59

Fix comments

244a9b7

Fix tests

2b506b3

JakeWharton approved these changes Dec 12, 2017

View reviewed changes

Fix star import

37be373

JakeWharton approved these changes Dec 16, 2017

View reviewed changes

geralt-encore added 2 commits December 16, 2017 17:08

Fix comment

26c4ae5

Remove lint checks dependency

8a7ac86

JakeWharton approved these changes Dec 18, 2017

View reviewed changes

JakeWharton merged commit 9ba06a9 into square:master Dec 18, 2017

JakeWharton mentioned this pull request Dec 18, 2017

Lint checks for runtime assertions and common errors. #58

Open

6 tasks

geralt-encore deleted the lint branch December 20, 2017 10:45


		private fun UCallExpression.isQueryMethod() = methodName == QUERY_METHOD_NAME

		private fun String.pluralize(count: Int) = if (count == 1) this else this + "s"


		override fun getIssues() = listOf(SqlBriteArgCountDetector.ISSUE)

		fun testCleanCaseWithWithQueryAsLiteral() {

		import com.squareup.sqlbrite3.BriteDatabase;

		public class Test {

Conversation

geralt-encore commented Nov 12, 2017

Uh oh!

JakeWharton commented Nov 21, 2017

Uh oh!

geralt-encore commented Nov 22, 2017

Uh oh!

JakeWharton left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JakeWharton commented Nov 29, 2017

Uh oh!

geralt-encore commented Nov 29, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jrodbx left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

geralt-encore commented Dec 10, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JakeWharton left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

geralt-encore Dec 16, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

geralt-encore Dec 16, 2017 •

edited

Loading