android trinity

Android-Trinité

Il s'agit de minuscules framework avec une grande partie du code d'échafaudage (avec de beaux utilitaires et du code source préparé) requis pour démarrer une nouvelle application Android.

Arrière-plan ?

Oui, Android Studio pourrait créer un projet pour vous, mais il manque des pièces, que je finis toujours par ajouter à chaque projet que je crée. Ce petit cadre (je dirais que le code d'échafaudage) vise à résoudre ce problème en rendant facile et rapide pour créer un projet Android avec les blocs de construction fondamentaux. Vérifiez la section TODO ci-dessous pour plus d'informations sur l'évolution et les progrès.

Que fournit Android-Trinity? ?

Liberté. Il utilise des outils standard mais organisé de manière à faciliter le développement d'Android. Vous pouvez refacter ou changer quoi que ce soit, mais l'idée est d'avoir un point de départ robuste. Tout le câblage est fait pour vous avec la flexibilité d'être modifié en fonction de vos besoins.

• Kotlin DSL par défaut à Gradle Build System Leve.
• Rapport de code d'analyse statique (Detekt).
• Rapport de couverture du code (JACOCO).
• Classes de base: BaseActivity et BaseFragments .
• Barre d'outils avec styles prédéfinis.
• Clases de test prédéfinies: UnitTest , AndroidTest , AcceptanceTest .
• Gradle Scripts pré-compilé (dossier buildScr ) organisé par des aspects:
  • compilation.gradle.kts
  • infrastructure.gradle.kts
  • quality.gradle.kts
  • variants.gradle.kts
• Gestion des dépendances en un seul endroit: Dependencies.kt
• Leakcanary pour la détection des fuites.
• Variants de construction prédéfinis (vérifiez variants.gradle.kts fichier)
  • Types de construction:
    • DEBUG
    • RELEASE
  • Saveurs de produit:
    • DEV
    • INTERNAL
    • PUBLIC
• Kotlin Coroutines
• Un cadre de drapeaux de fonction compact

Qu'inclut Android-Trinity? (susceptible de changer si nécessaire dans les futures versions)

• Di Vous devez choisir votre cadre d'injection de dépendance.
• Pas de cadre de navigation.
• Aucune bibliothèque LiveData et ViewModel car certains ingénieurs peuvent utiliser d'autres approches au niveau de l'interface utilisateur comme MVI, MVP, etc.
• Pas de flux de kotlin.
• Aucune mise en page d'interface utilisateur pour la prise en charge de la tablette ou du téléviseur Android.

Tâches de gradle prédéfinis

• ./gradlew runStaticAnalysis
• ./gradlew runTestCoverage
• ./gradlew runUnitTests
• ./gradlew runAcceptanceTests
• ./gradlew compileApp
• ./gradlew runApp

Comment l'utiliser?

À l'époque, il y a quelques étapes manuelles impliquées car nous sommes à un stade très précoce. Mais nous croyons à l'évolution des logiciels, non? Alors restez à l'écoute et vérifiez les sections de la liste des listes et des tâches .

• Étape 1: Cliquez sur pour créer un nouveau dépôt.
• Étape 2: Importez le projet dans Android Studio
• Étape 3: Renommer les packages en fonction de vos besoins. com.fernandocejas.sample par défaut.

Utilisation des aides de test

Disons que vous voulez écrire des tests (et vous devriez toujours le faire), comme mentionné, il y a 3 classes qui entrent en jeu et ici des exemples de leur utilisation:

• UnitTest.kt : Classe de base de test d'unité qui configure des simulations pour vous (vous n'utilisez que l'annotation @Mockk )

 class FeatureFlagTest : UnitTest () {

    @Mockk prival val yourMock

    @Test
    fun `given a feature flag, when it is activated, then executes given logic block` () {
        val activeFlag = ActiveFeatureFlag ()
        val fakeNavigator = mockk< Navigator >(relaxed = true )

        activeFlag whenActivated {
            fakeNavigator.doSomething()
            fakeNavigator.navigateToActiveFeature()
            fakeNavigator.doSomething()
        }

        verify(exactly = 1 ) { fakeNavigator.navigateToActiveFeature() }
        verify(exactly = 2 ) { fakeNavigator.doSomething() }
    }

• AndroidTest.kt : classe de base de test d'intégration qui configure des simulations pour vous (vous n'utilisez que l'annotation @Mockk ). Vous pouvez utiliser ces classes lorsque ce sont des composants Android impliqués. Il est sauvegardé par Robolectric.

 class YourTestClass : AndroidTest () {

    @Mockk prival val yourMock

    @Test
    fun `given something, when something happens, then do something` () {
        TODO ()
    }

• AcceptanceTest.kt : Classe de base de test UI qui configure l'espresso pour vous

 class MainActivityTest : AcceptanceTest ( MainActivity : :class.java) {

    @Test
    fun checkToolBarTest () {
        onView(withId( R .id.toolbar)).check(matches(isDisplayed()))
    }
}

Fonctionnalités

Android-Trinity comprend un cadre de drapeaux de fonctions hors ligne simple avec une API très simple générée au moment de la compilation. Si vous souhaitez plus d'informations, reportez-vous à la demande de traction introduite. (Todo: ajouter plus de documentation)

Exemple de son utilisation:

 Flag . Hello whenActivated { displayGreeting( R .string.hello) }

Rapports de qualité: analyse statique

• L'outil choisi ici est Detekt en raison de sa nature pour Kotlin.
• La tâche Gradlew et sa configuration ont pu être trouvées dans le fichier quality.gradle.kts .
• Les règles de Cconfiguration sont dans Config / Detekt / Detekt.yml.

Rapports de qualité: couverture du code

• L'outil choisi ici est Jacoco en raison de sa nature et de sa popularité dans la communauté.
• La tâche Gradlew et sa configuration ont pu être trouvées dans le fichier quality.gradle.kts .

Liste de TOD

• Gradle Tâches pour publier sur Google Play: App Bundles.
• Automatiser le processus à partir de l'utilisation de la section: IDEA: ./gradlew setupProject
• Fondeurs de fonction locale.
• Renommez les packages par défaut à io.android-trinity ou io.android.trinity .
• ???
• ???

Comment contribuer

Rien n'est réglé ici et les choses peuvent changer et évoluer en fonction du travail et des exigences communautaires. Donc, si vous souhaitez contribuer, n'hésitez pas à ouvrir un problème et à l'étiqueter correctement: bug , amélioration , etc. ou envoyer un PR. Veuillez les deux avec de bonnes descriptions de l'intention, afin de faciliter l'examen

Licence

 Copyright 2021 Fernando Cejas

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.