Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add PetFinder Module for database example #1099

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ plugins {
id("artifacts-check")
id("dependency-guard")
alias(libs.plugins.ktlint)
alias(libs.plugins.com.android.application) apply false
alias(libs.plugins.org.jetbrains.kotlin.android) apply false
}

shardConnectedCheckTasks(project)
Expand Down
6 changes: 6 additions & 0 deletions gradle/libs.versions.toml
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,8 @@ timber = "5.0.1"
truth = "1.1.5"
turbine = "1.0.0"
vanniktech-publish = "0.25.2"
agp = "7.4.2"
org-jetbrains-kotlin-android = "1.8.10"

[plugins]

Expand All @@ -100,6 +102,8 @@ kotlin-serialization = { id = "org.jetbrains.kotlin.plugin.serialization", versi
ktlint = { id = "com.rickbusarow.ktlint", version.ref = "ktlint-gradle" }
kotlinx-apiBinaryCompatibility = { id = "org.jetbrains.kotlinx.binary-compatibility-validator", version.ref = "kotlinx-binary-compatibility" }
mavenPublish = { id = "com.vanniktech.maven.publish", version.ref = "vanniktech-publish" }
com-android-application = { id = "com.android.application", version.ref = "agp" }
org-jetbrains-kotlin-android = { id = "org.jetbrains.kotlin.android", version.ref = "org-jetbrains-kotlin-android" }

[libraries]

Expand Down Expand Up @@ -254,5 +258,7 @@ truth = { module = "com.google.truth:truth", version.ref = "truth" }
turbine = { module = "app.cash.turbine:turbine", version.ref = "turbine" }

vanniktech-publish = { module = "com.vanniktech:gradle-maven-publish-plugin", version.ref = "vanniktech-publish" }
ui-test-manifest = { group = "androidx.compose.ui", name = "ui-test-manifest" }
material3 = { group = "androidx.compose.material3", name = "material3" }

[bundles]
1 change: 1 addition & 0 deletions samples/petfinder/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/build
70 changes: 70 additions & 0 deletions samples/petfinder/build.gradle.kts
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
@Suppress("DSL_SCOPE_VIOLATION") // TODO: Remove once KTIJ-19369 is fixed
plugins {
alias(libs.plugins.com.android.application)
alias(libs.plugins.org.jetbrains.kotlin.android)
}

android {
namespace = "com.squareup.sample.petfinder"
compileSdk = 33

defaultConfig {
applicationId = "com.squareup.sample.petfinder"
minSdk = 24
targetSdk = 33
versionCode = 1
versionName = "1.0"

testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
vectorDrawables {
useSupportLibrary = true
}
}

buildTypes {
release {
isMinifyEnabled = false
proguardFiles(
getDefaultProguardFile("proguard-android-optimize.txt"),
"proguard-rules.pro"
)
}
}
compileOptions {
sourceCompatibility = JavaVersion.VERSION_1_8
targetCompatibility = JavaVersion.VERSION_1_8
}
kotlinOptions {
jvmTarget = "1.8"
}
buildFeatures {
compose = true
}
composeOptions {
kotlinCompilerExtensionVersion = "1.4.3"
}
packagingOptions {
resources {
excludes += "/META-INF/{AL2.0,LGPL2.1}"
}
}
}

dependencies {

implementation(libs.androidx.core)
implementation(libs.androidx.lifecycle.ktx)
implementation(libs.androidx.activity.compose)
implementation(platform(libs.androidx.compose.bom))
implementation(libs.androidx.compose.ui)
implementation(libs.androidx.compose.ui.graphics)
implementation(libs.androidx.compose.ui.tooling.preview)
implementation(libs.material3)
testImplementation(libs.junit)
androidTestImplementation(libs.androidx.test.junit)
androidTestImplementation(libs.androidx.test.espresso.core)
androidTestImplementation(platform(libs.androidx.compose.bom))
androidTestImplementation(libs.androidx.compose.ui.test.junit4)
debugImplementation(libs.androidx.compose.ui.tooling)
debugImplementation(libs.ui.test.manifest)
}
21 changes: 21 additions & 0 deletions samples/petfinder/proguard-rules.pro
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Add project specific ProGuard rules here.
# You can control the set of applied configuration files using the
# proguardFiles setting in build.gradle.
#
# For more details, see
# http://developer.android.com/guide/developing/tools/proguard.html

# If your project uses WebView with JS, uncomment the following
# and specify the fully qualified class name to the JavaScript interface
# class:
#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
# public *;
#}

# Uncomment this to preserve the line number information for
# debugging stack traces.
#-keepattributes SourceFile,LineNumberTable

# If you keep the line number information, uncomment this to
# hide the original source file name.
#-renamesourcefileattribute SourceFile
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
package com.squareup.sample.petfinder

import androidx.test.platform.app.InstrumentationRegistry
import androidx.test.ext.junit.runners.AndroidJUnit4

import org.junit.Test
import org.junit.runner.RunWith

import org.junit.Assert.*

/**
* Instrumented test, which will execute on an Android device.
*
* See [testing documentation](http://d.android.com/tools/testing).
*/
@RunWith(AndroidJUnit4::class)
class ExampleInstrumentedTest {
@Test
fun useAppContext() {
// Context of the app under test.
val appContext = InstrumentationRegistry.getInstrumentation().targetContext
assertEquals("com.squareup.sample.petfinder", appContext.packageName)
}
}
24 changes: 24 additions & 0 deletions samples/petfinder/src/main/AndroidManifest.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android">

<application
android:allowBackup="true"
android:icon="@mipmap/ic_launcher"
android:label="@string/app_name"
android:roundIcon="@mipmap/ic_launcher_round"
android:supportsRtl="true"
android:theme="@style/Theme.Workflow">
<activity
android:name=".MainActivity"
android:exported="true"
android:label="@string/app_name"
android:theme="@style/Theme.Workflow">
<intent-filter>
<action android:name="android.intent.action.MAIN" />

<category android:name="android.intent.category.LAUNCHER" />
</intent-filter>
</activity>
</application>

</manifest>
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
package com.squareup.sample.petfinder

import android.os.Bundle
import androidx.activity.ComponentActivity
import androidx.activity.compose.setContent
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.material3.MaterialTheme
import androidx.compose.material3.Surface
import androidx.compose.material3.Text
import androidx.compose.runtime.Composable
import androidx.compose.ui.Modifier
import androidx.compose.ui.tooling.preview.Preview
import com.squareup.sample.petfinder.theme.WorkflowTheme

class MainActivity : ComponentActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContent {
WorkflowTheme {
// A surface container using the 'background' color from the theme
Surface(
modifier = Modifier.fillMaxSize(),
color = MaterialTheme.colorScheme.background
) {
Greeting("Android")
}
}
}
}
}

@Composable
fun Greeting(name: String, modifier: Modifier = Modifier) {
Text(
text = "Hello $name!",
modifier = modifier
)
}

@Preview(showBackground = true)
@Composable
fun GreetingPreview() {
WorkflowTheme {
Greeting("Android")
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
package com.squareup.sample.petfinder.domain

data class Address (
val address1: Any? = null,
val address2: Any? = null,
val city: String,
val state: String,
val postcode: String,
val country: String
)
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
package com.squareup.sample.petfinder.domain

data class Adoption (
val policy: String? = null,
val url: String? = null
)
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
package com.squareup.sample.petfinder.domain

data class Animal (
val id: Long,
val organizationId: String,
val url: String,
val type: String,
val species: String,
val breeds: Breeds,
val colors: Colors,
val age: String,
val gender: String,
val size: String,
val coat: String,
val name: String,
val description: String,
val photos: List<Photo>,
val videos: List<Video>,
val status: String,
val attributes: Attributes,
val environment: Environment,
val tags: List<String>,
val contact: Contact,
val publishedAt: String,
val distance: Double,
)
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
package com.squareup.sample.petfinder.domain

data class Attributes (
val spayedNeutered: Boolean,
val houseTrained: Boolean,
val declawed: Boolean,
val specialNeeds: Boolean,
val shotsCurrent: Boolean
)
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
package com.squareup.sample.petfinder.domain

data class Breeds (
val primary: String,
val secondary: Any? = null,
val mixed: Boolean,
val unknown: Boolean
)
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
package com.squareup.sample.petfinder.domain

data class Colors (
val primary: String,
val secondary: Any? = null,
val tertiary: Any? = null
)
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
package com.squareup.sample.petfinder.domain

data class Contact (
val email: String,
val phone: String,
val address: Address
)
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
package com.squareup.sample.petfinder.domain

data class Environment (
val children: Boolean,
val dogs: Boolean,
val cats: Boolean
)
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
package com.squareup.sample.petfinder.domain

data class Hours (
val monday: String? = null,
val tuesday: String? = null,
val wednesday: String? = null,
val thursday: String? = null,
val friday: String? = null,
val saturday: String? = null,
val sunday: String? = null
)
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
package com.squareup.sample.petfinder.domain

data class Organization (
val id: String,
val name: String,
val email: String,
val phone: String,
val address: Address,
val hours: Hours,
val url: String,
val website: String? = null,
val missionStatement: Any? = null,
val adoption: Adoption,
val socialMedia: SocialMedia,
val photos: List<Photo>,
val distance: Double,
)
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
package com.squareup.sample.petfinder.domain

data class Photo (
val small: String,
val medium: String,
val large: String,
val full: String
)
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
package com.squareup.sample.petfinder.domain

data class SocialMedia (
val facebook: String? = null,
val twitter: String? = null,
val youtube: String? = null,
val instagram: String? = null,
val pinterest: String? = null
)
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
package com.squareup.sample.petfinder.domain

data class Video (
val embed: String
)
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
package com.squareup.sample.petfinder.theme

import androidx.compose.ui.graphics.Color

val Purple80 = Color(0xFFD0BCFF)
val PurpleGrey80 = Color(0xFFCCC2DC)
val Pink80 = Color(0xFFEFB8C8)

val Purple40 = Color(0xFF6650a4)
val PurpleGrey40 = Color(0xFF625b71)
val Pink40 = Color(0xFF7D5260)
Loading
Loading