Mastodon
/
pachli-android
mirror of https://github.com/pachli/pachli-android.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

refactor: Use com.google.android.material.appbar.MaterialToolbar 

The previous code used `androidx.appcompat.widget.Toolbar` in a several
places.

It's better to use `MaterialToolbar` as that plays better with other
Material components.

Update the usage throughout the project.

In addition, implement a lint check that will prevent any future use
from creeping back in.

Fixes #28
This commit is contained in:
sanao 2023-11-05 21:51:37 +09:00 committed by GitHub
parent f8877909ca
commit 4b7eb2419e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
14 changed files with 211 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/workflows/ci.yml vendored
View File

@ -38,7 +38,7 @@ jobs:
run: ./gradlew app:lintOrangeDebug
- name: Test
run: ./gradlew app:testOrangeDebugUnitTest
run: ./gradlew app:testOrangeDebugUnitTest checks:test
- name: Build
run: ./gradlew app:buildOrangeDebug

2
app/build.gradle
View File

@ -217,4 +217,6 @@ dependencies {
androidTestImplementation libs.androidx.test.junit
androidTestImplementation libs.hilt.android.testing
androidTestImplementation libs.androidx.test.core.ktx
lintChecks project(":checks")
}

2
app/src/main/res/layout/activity_account.xml
View File

@ -427,7 +427,7 @@
</androidx.constraintlayout.widget.ConstraintLayout>
<!-- top margin equal to statusbar size will be set programmatically -->
<androidx.appcompat.widget.Toolbar
<com.google.android.material.appbar.MaterialToolbar
android:id="@+id/accountToolbar"
android:layout_width="match_parent"
android:layout_height="wrap_content"

4
app/src/main/res/layout/activity_compose.xml
View File

@ -6,7 +6,7 @@
android:layout_width="match_parent"
android:layout_height="match_parent">
<androidx.appcompat.widget.Toolbar
<com.google.android.material.appbar.MaterialToolbar
android:id="@+id/toolbar"
android:layout_width="match_parent"
android:layout_height="wrap_content"
@ -71,7 +71,7 @@
app:tint="@color/tusky_orange_light"
app:tooltipText="@string/hint_media_description_missing"
android:visibility="invisible" />
</androidx.appcompat.widget.Toolbar>
</com.google.android.material.appbar.MaterialToolbar>
<androidx.core.widget.NestedScrollView
android:id="@+id/composeMainScrollView"

2
app/src/main/res/layout/activity_login.xml
View File

@ -95,7 +95,7 @@
</LinearLayout>
</ScrollView>
<androidx.appcompat.widget.Toolbar
<com.google.android.material.appbar.MaterialToolbar
android:id="@+id/toolbar"
android:layout_width="match_parent"
android:layout_height="?attr/actionBarSize"

4
app/src/main/res/layout/activity_login_webview.xml
View File

@ -9,7 +9,7 @@
android:layout_width="match_parent"
android:layout_height="wrap_content">
<androidx.appcompat.widget.Toolbar
<com.google.android.material.appbar.MaterialToolbar
android:id="@+id/loginToolbar"
android:layout_width="match_parent"
android:layout_height="wrap_content" />
@ -49,4 +49,4 @@
</LinearLayout>
</androidx.coordinatorlayout.widget.CoordinatorLayout>
</androidx.coordinatorlayout.widget.CoordinatorLayout>

2
app/src/main/res/layout/activity_search.xml
View File

@ -13,7 +13,7 @@
app:liftOnScrollTargetViewId="@id/pages"
app:layout_collapseMode="pin">
<androidx.appcompat.widget.Toolbar
<com.google.android.material.appbar.MaterialToolbar
android:id="@+id/toolbar"
android:layout_width="match_parent"
android:layout_height="?attr/actionBarSize"

4
app/src/main/res/layout/activity_view_media.xml
View File

@ -11,7 +11,7 @@
android:layout_width="match_parent"
android:layout_height="match_parent" />
<androidx.appcompat.widget.Toolbar
<com.google.android.material.appbar.MaterialToolbar
android:id="@+id/toolbar"
android:layout_width="match_parent"
android:layout_height="?attr/actionBarSize"
@ -27,4 +27,4 @@
android:layout_gravity="center"
android:visibility="gone" />
</FrameLayout>
</FrameLayout>

1
checks/.gitignore vendored Normal file
View File

@ -0,0 +1 @@
/build

36
checks/build.gradle Normal file
View File

@ -0,0 +1,36 @@
plugins {
id "java-library"
id "kotlin"
id "com.android.lint"
}
lintOptions {
htmlReport(true)
htmlOutput(file("lint-report.html"))
textReport(true)
absolutePaths(false)
ignoreTestSources(true)
}
jar {
manifest {
attributes("Lint-Registry-v2": "app.pachli.lint.checks.LintRegistry")
}
}
dependencies {
compileOnly("org.jetbrains.kotlin:kotlin-stdlib-jdk7:1.3.61")
// Derived from the AGP version. If the AGP version is X.Y.Z the version
// here must by X+23.Y.Z.
// See https://github.com/googlesamples/android-custom-lint-rules#lint-version
def lintVersion = "31.1.2" // = AGP 8.1.2
// For a description of the below dependencies, see the main project README
compileOnly("com.android.tools.lint:lint-api:$lintVersion")
compileOnly("com.android.tools.lint:lint-checks:$lintVersion")
testImplementation("com.android.tools.lint:lint:$lintVersion")
testImplementation("com.android.tools.lint:lint-tests:$lintVersion")
testImplementation("junit:junit:4.13.2")
}

58
checks/src/main/java/app/pachli/lint/checks/AndroidxToolbarDetector.kt Normal file
View File

@ -0,0 +1,58 @@
package app.pachli.lint.checks
import com.android.tools.lint.detector.api.Category
import com.android.tools.lint.detector.api.Detector
import com.android.tools.lint.detector.api.Implementation
import com.android.tools.lint.detector.api.Issue
import com.android.tools.lint.detector.api.LintFix
import com.android.tools.lint.detector.api.Scope
import com.android.tools.lint.detector.api.Severity
import com.android.tools.lint.detector.api.XmlContext
import com.android.tools.lint.detector.api.XmlScanner
import org.w3c.dom.Element
class AndroidxToolbarDetector : Detector(), XmlScanner {
override fun getApplicableElements(): Collection<String> {
return listOf(ANDROIDX_TOOLBAR)
}
override fun visitElement(context: XmlContext, element: Element) {
val quickFixData = LintFix.create()
.name("Replace with `com.google.android.material.appbar.MaterialToolbar`")
.replace()
.text(element.localName)
.with("com.google.android.material.appbar.MaterialToolbar")
.independent(true)
.build()
context.report(
issue = ISSUE,
scope = element,
location = context.getElementLocation(element),
message = "Use `com.google.android.material.appbar.MaterialToolbar` instead of `androidx.appcompat.widget.Toolbar`",
quickfixData = quickFixData,
)
}
companion object {
private const val ANDROIDX_TOOLBAR = "androidx.appcompat.widget.Toolbar"
@JvmField
val ISSUE: Issue = Issue.create(
id = "AndroidxToolbarDetector",
briefDescription = "Don't use `androidx.appcompat.widget.Toolbar` in this project",
explanation = """
Use `com.google.android.material.appbar.MaterialToolbar` instead of
`androidx.appcompat.widget.Toolbar` to ensure it works as expected with
other Material components. See https://developer.android.com/reference/com/google/android/material/appbar/MaterialToolbar
""",
category = Category.CORRECTNESS,
priority = 6,
severity = Severity.WARNING,
implementation = Implementation(
AndroidxToolbarDetector::class.java,
Scope.RESOURCE_FILE_SCOPE,
),
)
}
}

14
checks/src/main/java/app/pachli/lint/checks/LintRegistry.kt Normal file
View File

@ -0,0 +1,14 @@
package app.pachli.lint.checks
import com.android.tools.lint.client.api.IssueRegistry
import com.android.tools.lint.detector.api.CURRENT_API
import com.android.tools.lint.detector.api.Issue
@Suppress("UnstableApiUsage")
class LintRegistry : IssueRegistry() {
override val issues: List<Issue>
get() = listOf(AndroidxToolbarDetector.ISSUE)
override val api: Int
get() = CURRENT_API
}

89
checks/src/test/java/app/pachli/lint/checks/AndroidxToolbarDetectorTest.kt Normal file
View File

@ -0,0 +1,89 @@
package app.pachli.lint.checks
import com.android.tools.lint.checks.infrastructure.TestFiles.xml
import com.android.tools.lint.checks.infrastructure.TestLintTask.lint
import org.junit.Test
class AndroidxToolbarDetectorTest {
@Test
fun testError() {
lint().files(
xml(
"res/layout/test.xml",
"""<?xml version="1.0" encoding="utf-8"?>
<androidx.coordinatorlayout.widget.CoordinatorLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto"
xmlns:tools="http://schemas.android.com/tools"
android:layout_width="match_parent"
android:layout_height="match_parent"
tools:context="app.pachli.components.search.SearchActivity">
<com.google.android.material.appbar.AppBarLayout
android:layout_width="match_parent"
android:layout_height="wrap_content"
app:liftOnScroll="true"
app:liftOnScrollTargetViewId="@id/pages"
app:layout_collapseMode="pin">
<androidx.appcompat.widget.Toolbar
android:id="@+id/toolbar"
android:layout_width="match_parent"
android:layout_height="?attr/actionBarSize"
app:contentInsetStartWithNavigation="0dp"
app:layout_scrollFlags="scroll|snap|enterAlways"
app:navigationIcon="?attr/homeAsUpIndicator" />
</com.google.android.material.appbar.AppBarLayout>
</androidx.coordinatorlayout.widget.CoordinatorLayout>
""",
).indented(),
).issues(AndroidxToolbarDetector.ISSUE).allowMissingSdk().run().expectWarningCount(1)
.expect(
"""res/layout/test.xml:16: Warning: Use com.google.android.material.appbar.MaterialToolbar instead of androidx.appcompat.widget.Toolbar [AndroidxToolbarDetector]
<androidx.appcompat.widget.Toolbar
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
0 errors, 1 warnings
""",
)
}
@Test
fun testNoError() {
lint().files(
xml(
"res/layout/test.xml",
"""<?xml version="1.0" encoding="utf-8"?>
<androidx.coordinatorlayout.widget.CoordinatorLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto"
xmlns:tools="http://schemas.android.com/tools"
android:layout_width="match_parent"
android:layout_height="match_parent"
tools:context="app.pachli.components.search.SearchActivity">
<com.google.android.material.appbar.AppBarLayout
android:layout_width="match_parent"
android:layout_height="wrap_content"
app:layout_collapseMode="pin"
app:liftOnScroll="true"
app:liftOnScrollTargetViewId="@id/pages">
<com.google.android.material.appbar.MaterialToolbar
android:id="@+id/toolbar"
android:layout_width="match_parent"
android:layout_height="?attr/actionBarSize"
app:contentInsetStartWithNavigation="0dp"
app:layout_scrollFlags="scroll|snap|enterAlways"
app:navigationIcon="?attr/homeAsUpIndicator" />
</com.google.android.material.appbar.AppBarLayout>
</androidx.coordinatorlayout.widget.CoordinatorLayout>
""",
).indented(),
).issues(AndroidxToolbarDetector.ISSUE)
.allowMissingSdk()
.run()
.expectWarningCount(0)
}
}

1
settings.gradle
View File

@ -20,3 +20,4 @@ enableFeaturePreview("STABLE_CONFIGURATION_CACHE")
include ':app'
include ':tools:mklanguages'
include ':checks'