Skip to content

Latest commit

 

History

History
221 lines (149 loc) · 9.43 KB

README.md

File metadata and controls

221 lines (149 loc) · 9.43 KB
Raw

Gravatar-Android

Build status License: MPL 2.0

The Gravatar Android SDK is a library that provides a set of UI components and utilities to fetch and display Gravatar images and profile data in Android applications.

Getting started

Hi there! If you're here because you want to integrate the Gravatar SDK into your Android application, please take a look at our Get Started guide. You'll find a quick overview of how to get an API key and use the library in your projects.

Architecture

This project contains the source code for the Gravatar SDK library and a demo app. The demo app aims to achieve two different goals. On the one hand, it demonstrates how to use the Gravatar SDK library. On the other hand it serves as a testbed for the library.

Gravatar SDK Architecture

The SDK is still in its early stages, but we can identify the following modules:

Gravatar (Core)

The core functionality of the Gravatar SDK library. It provides a set of classes and methods to interact with the Gravatar API.

  • Gravatar API clients: A set of classes and methods to interact with the Gravatar API. It's responsible for handling the network requests and parsing the responses.
  • Gravatar Utils: A set of utility classes and methods to handle the Gravatar URLs, the Gravatar profile, etc.

Gravatar UI

A set of UI components to display the Gravatar images, profiles or information in general. Those components are implemented in Jetpack Compose and can contain logic to interact with the Gravatar API client.

  • Gravatar UI components: A set of UI components to display the Gravatar images, profiles or information in general. Those components are implemented in Jetpack Compose and can contain logic to interact with the Gravatar API client.

QuickEditor

The QuickEditor module contains tools and UI components to quickly edit the Gravatar profile.

Dependency Injection

We decided to go with a manual injection basically for two main reasons:

  • We avoid adding a new project dependency and possible conflicts while integrating the SDK.
  • The expected size and complexity of the SDK allow manual injection without too much trouble.

If you need to inject classes, you can use the GravatarSdkContainer class as the entry point. This class is responsible for all the DI in the SDK.

Tests

Run unit tests on your machine via the following command:

./gradlew test

Screenshot Tests

We use Roborazzi to take screenshots of the UI components. The screenshots are stored in the screenshotsTests directory. To regenerate the screenshots, run the following command:

./gradlew :gravatar-ui:recordRoborazziDebug -Pscreenshot

To compare the screenshots, run the following command:

./gradlew :gravatar-ui:verifyRoborazziDebug -Pscreenshot

Coding Style

We use Ktlint to enforce a consistent coding style. It is integrated into the project as a Gradle plugin using the jlleitschuh/ktlint-gradle wrapper.

⚠️Please make sure that ktlintCheck is happy with your changes before submitting a PR.

Check the style of the whole project or just the desired module (library or demo app) with the following commands:

./gradlew ktlintCheck
./gradlew :gravatar:ktlintCheck
./gradlew :gravatar-ui:ktlintCheck
./gradlew :quickeditor:ktlintCheck
./gradlew :app:ktlintCheck

You can also try to let Ktlint fix the code style issues. Just use:

./gradlew ktlintFormat
./gradlew :gravatar:ktlintFormat
./gradlew :gravatar-ui:ktlintFormat
./gradlew :quickeditor:ktlintFormat
./gradlew :app:ktlintFormat

Code static analysis

We use Detekt to perform static code analysis. You can run Detekt via a gradle command:

./gradlew detekt
./gradlew :gravatar:detekt
./gradlew :gravatar-ui:detekt
./gradlew :quickeditor:detekt
./gradlew :app:detekt

Explicit API mode

Explicit API mode is enabled in strict mode for the library. This means that the compiler performs additional checks that help make the library's API clearer and more consistent.

Those errors will force us to take care of the visibility modifiers in order to limit the public classes/methods of the API to the minimum required.

By default, Android Studio will show a warning, Redundant visibility modifier.

Redundant visibility modifier

You can remove the warning by changing the setting for this project in: Settings -> Editor -> Inspections -> Kotlin -> Redundant Constructors -> Redundant visibility modifier.

Generating API code from OpenApi definitions

We use OpenAPI Generator to generate the API code from the OpenAPI definitions.

The SDK project has integrated the OpenAPI Generator Gradle plugin to generate the API code from the OpenAPI definitions. The plugin is configured in the build.gradle.kts file.

The OpenAPI definitions are located in the openapi directory. In the same directory, you can find the templates directory, which contains the custom templates used by the OpenAPI Generator to generate the code that the Gravatar library needs. You can obtain the default templates by running the following command:

openapi-generator author template -g kotlin --library jvm-retrofit2

The OpenAPI Generator documentation provides more information about the templates.

The generator's output folder is the build directory. However, as we don't need all the generated files, the Gradle task has been modified to move only the desired code to the gravatar module. In addition, the last step of the task is to format the generated code with Ktlint.

Important: Do not manually modify the com.gravatar.api folder. The OpenAPI Generator will overwrite it.

To regerate the code you can use the following gradlew task:

./gradlew :gravatar:openApiGenerate

Publishing

The SDK is published to the Automattic's S3 instance via publish-to-s3 Gradle plugin.

The published version is calculated depending on the Git context, in this order:

  • if there's a tag, version is <tag name>
  • if there's a PR, version is <pr number>-<commit hash>
  • else <branch name>-<commit hash>

To use the repository, it's needed to add the custom repository:

repositories {
    maven {
        url "https://a8c-libs.s3.amazonaws.com/android"
    }
    // Jitpack is used to fetch the uCrop library. Required only for gravatar-quickeditor module.
    maven {
        url "https://jitpack.io"
        content {
            includeModule("com.github.yalantis", "ucrop")
        }
    }
}

dependencies {
    implementation ("com.gravatar:gravatar:<version>")
    // OR
    implementation ("com.gravatar:gravatar-ui:<version>")
    // OR
    implementation ("com.gravatar:gravatar-quickeditor:<version>")
}

Generating the API documentation

We're using kdoc to document the library's code. Dokka has been setup to generate html documentation from kdoc. To generate the HTML docs in docs/dokka/, run the following command:

./gradlew dokkaHtmlMultiModule

Here is the most recent release of the Gravatar-SDK-Android API documentation generated by Dokka.

Release process

We're following Semantic Versioning for the releases. Here is the process to create a new release:

  1. Generate a new release branch: git checkout -b release/x.x.x.
  2. Update version number versionName to x.x.x in the root build.gradle.kts file.
  3. Build the Dokka documentation: ./gradlew dokkaHtmlMultiModule and commit the generated files to the git repository.
  4. Open a PR, wait for a review, merge the PR on approval.
  5. Pull the trunk branch and tag the git commit with the version number: git tag -a x.x.x -m "Release x.x.x"
  6. Push the new tag: git push --tags.
  7. Go to the GitHub releases page and create a new release with the tag name and the release notes.

Contributing

Read our Contributing Guide to learn about reporting issues, contributing code, and more ways to contribute.

License

Gravatar-SDK-Android is an open source project covered by the Mozilla Public License Version 2.0.