android trinity

Android-Trinity

Esta é uma pequena estrutura com grande parte do código de andaime (com alguns utilitários agradáveis ​​e código -fonte preparado) necessário para iniciar um novo aplicativo Android.

Fundo ?

Sim, o Android Studio pode criar um projeto para você, mas faltam peças, o que eu sempre acabo adicionando a todos os projetos que eu criar. Essa pequena estrutura (eu diria que ainda tem o código de andaimes) visa resolver isso, facilitando e rápido o projeto Android com os blocos de construção fundamentais. Verifique a seção TODO abaixo para obter mais informações sobre a evolução e o progresso.

O que o Android-Trinity fornece? ?

Liberdade. Ele usa ferramentas padrão, mas organizado de tal maneira que facilite o desenvolvimento do Android. Você pode refatorar ou alterar qualquer coisa, exceto a idéia é ter um ponto de partida robusto. Toda a fiação é feita para você com a flexibilidade de ser modificado de acordo com suas necessidades.

• Kotlin DSL Por padrão no Gradle Build System Leve.
• Relatório de código de analisis estático (DetEkt).
• Relatório de cobertura de código (Jacoco).
• Classes de base: BaseActivity e BaseFragments .
• Barra de ferramentas com estilos predefinidos.
• Clases de teste pré-setup: UnitTest , AndroidTest , AcceptanceTest .
• Scripts gradle pré-compilados (pasta buildScr ) organizados por aspectos:
  • compilation.gradle.kts
  • infrastructure.gradle.kts
  • quality.gradle.kts
  • variants.gradle.kts
• Gerenciamento de dependências em um só lugar: Dependencies.kt
• Vazamento para detecção de vazamentos.
• Variantes de construção predefinidas (arquivo de check variants.gradle.kts )
  • Tipos de construção:
    • DEBUG
    • RELEASE
  • Sabores de produto:
    • DEV
    • INTERNAL
    • PUBLIC
• Coroutines Kotlin
• Uma estrutura de sinalizadores de recursos compactos

O que o Android-Trinity não inclui? (provavelmente mudará, se necessário, em versões futuras)

• Di. Você deve escolher sua estrutura de injeção de dependência.
• Sem estrutura de navegação.
• Nenhuma biblioteca de LiveData e ViewModel pois alguns engenheiros podem usar outras abordagens no nível da interface do usuário, como MVI, MVP, etc.
• Sem fluxo de Kotlin.
• Não há layouts de interface do usuário para suporte para tablet ou Android TV.

Tarefas graduadas predefinidas

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

Como usá -lo?

Na época, existem algumas etapas manuais envolvidas, pois estamos em um estágio muito inicial. Mas acreditamos na evolução do software, certo? Portanto, fique atento e verifique as seções de como contribuir e de listas de TODO .

• Etapa 1: clique para criar um novo repositório.
• Etapa 2: importe o projeto no Android Studio
• Etapa 3: renomeie os pacotes de acordo com suas necessidades. com.fernandocejas.sample por padrão.

Usando ajudantes de teste

Digamos que você queira escrever testes (e você sempre deve fazer), como mencionado, há três classes que entram em jogo e aqui exemplos de seu uso:

• UnitTest.kt : classe base de teste de unidade, que configura zombar para você (você usa apenas a anotação @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 : Integration Test Base Class, que configura zombar para você (você usa apenas a anotação @Mockk ). Você pode usar essas classes quando elas são componentes do Android envolvidos. É apoiado pelo robolétrico.

 class YourTestClass : AndroidTest () {

    @Mockk prival val yourMock

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

• AcceptanceTest.kt : Teste da interface do usuário Classe Base que configure Espresso para você

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

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

Sinalizadores de recursos

O Android-Trinity inclui uma estrutura simples de sinalizadores offline com uma API muito simples gerada no momento da compilação. Se você deseja mais informações, consulte a solicitação de tração introduzida. (TODO: Adicione mais documentação)

Exemplo de seu uso:

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

Relatórios de qualidade: análise estática

• A ferramenta escolhida aqui é detectada devido à sua natureza para Kotlin.
• A tarefa gradlew e sua configuração podem ser encontrados no arquivo de quality.gradle.kts .
• As regras do CCONFIGURAÇÃO ESTÃO EM CONFIG/DETEKT/DETEKT.YML.

Relatórios de qualidade: cobertura de código

• A ferramenta escolhida aqui é Jacoco devido à sua natureza e popularidade na comunidade.
• A tarefa gradlew e sua configuração podem ser encontrados no arquivo de quality.gradle.kts .

Lista de tarefas

• Tarefas gradle para publicar no Google Play: pacotes de aplicativos.
• Automatize o processo de como usar a seção: IDEA: ./gradlew setupProject
• Sinalizadores de recursos locais.
• Renomeie os pacotes padrão para io.android-trinity ou io.android.trinity .
• ???
• ???

Como contribuir

Nada é definido em pedra aqui e as coisas podem mudar e evoluir com base no trabalho e requisitos da comunidade. Portanto, se você deseja contribuir, sinta -se à vontade para abrir um problema e rotulá -lo corretamente: bug , aprimoramento , etc. ou envie um pr. Por favor, ambos com boas descrições da intenção, a fim de facilitar a revisão

Licença

 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.