Ruler
Ruler is a Gradle plugin which helps you analyze the size of your Android apps.
Motivation
App size is an important metric which directly correlates with business metrics like install conversion rate. Measuring app size is straightforward, but knowing what contributes to it is not. Especially in bigger projects with hundreds or thousands of modules and third-party dependencies. Ruler provides a convenient way to find out how much each module and dependency contributes to the total size of your app by running a single Gradle task.
Usage
Follow the following steps to start using Ruler in your project.
Adding the plugin
First you need to add the Ruler Gradle plugin to the buildscript classpath in your top-level build.gradle file:
buildscript {
repositories {
maven {
google()
mavenCentral()
}
}
dependencies {
classpath("com.spotify.ruler:ruler-gradle-plugin:0.2.0")
}
}
You also have to apply the plugin in the build.gradle of your application module:
plugins {
id("com.android.application")
id("com.spotify.ruler")
}
Configuring the plugin
When using app bundles, Google Play will generate optimized APKs for each device. This means that the size of an APK depends on the specifications of the device that's downloading it. You can configure which device specifications should be used for the analysis in the build.gradle of your application module:
ruler {
abi.set("arm64-v8a")
locale.set("en")
screenDensity.set(480)
sdkVersion.set(27)
}
Running the task
Once this is done, analyze<VariantName>Bundle tasks will be added for each of your app variants. Running this task will build the app and generate a HTML report, which you can use to analyze your app size. It will also generate a JSON report, in case you want to further process the data.
Project structure
Ruler is built with Kotlin and contains multiple modules:
- ruler-gradle-plugin: Core Gradle plugin where the APK parsing, dependency handling and attribution logic lives.
- ruler-frontend: React template used for the HTML report, built with Kotlin JS.
- ruler-models: Common models shared between the Gradle plugin and the frontend, built with Kotlin Multiplatform.
Working with this project
The project is set up like a standard Gradle project. You can build it using ./gradlew assemble and run the tests with ./gradlew test.
There is also a sample project, which shows the usage of the plugin. Because the way this sample project is set up, the initial build can fail if you bump the plugin version. To fix this, you have to publish the plugin to your local Maven repository by running ./gradlew publishToMavenLocal -PwithoutSample.
When working on the frontend, you can start a development server by running ./gradlew browserRun, which will show a report filled with dummy data to make development easier.
Code of conduct
This project adheres to the Open Code of Conduct. By participating, you are expected to honor this code.
License
Copyright 2021 Spotify AB
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.
| 
| 
| 
|
| 
|
345 Dec 10, 2022
4 Dec 15, 2022
506 Jan 8, 2023
21 Oct 3, 2022
1.4k Dec 29, 2022
853 Dec 21, 2022
960 Dec 18, 2022
12 Nov 5, 2022
560 Jan 8, 2023
3.9k Dec 30, 2022
3k Dec 29, 2022
16 Nov 3, 2022
3 Sep 11, 2021
8 Jan 2, 2023
1 Nov 12, 2021
705 Nov 25, 2022
36 May 29, 2022
6 Jul 29, 2022