Moved demonstration app out of root and into samples folder (slackhq#170

)

In preparation for creating additional sample/demonstration apps,
created a top level samples directory and populated with existing
demonstration app

.github/CONTRIBUTING.md

@@ -8,7 +8,7 @@ discussion.
 
 Check out this repo with Android Studio. It's a standard gradle project and conventional to checkout.
 
-The primary project is `circuit`. The primary sample is `sample`.
+The primary project is `circuit`. The primary sample is `samples/star`.
 
 This project is written in Kotlin and should only use Kotlin.
 

.github/workflows/ci.yml

@@ -47,7 +47,7 @@ jobs:
         id: gradle
         uses: gradle/gradle-build-action@v2
         with:
-          arguments: check :sample:assembleDebug :sample:assembleDebugAndroidTest
+          arguments: check :samples:star:assembleDebug :samples:star:assembleDebugAndroidTest
           gradle-home-cache-cleanup: true
           cache-read-only: false
 
@@ -84,11 +84,11 @@ jobs:
           target: 'aosp_atd'
           channel: canary # Necessary for ATDs
           script: |
-            adb uninstall com.slack.circuit.sample || true
-            adb uninstall com.slack.circuit.sample.androidTest || true
+            adb uninstall com.slack.circuit.star || true
+            adb uninstall com.slack.circuit.star.androidTest || true
             ./gradlew connectedDebugAndroidTest
-            adb uninstall com.slack.circuit.sample || true
-            adb uninstall com.slack.circuit.sample.androidTest || true
+            adb uninstall com.slack.circuit.star || true
+            adb uninstall com.slack.circuit.star.androidTest || true
 
       - name: (Fail-only) Bundle the build report
         if: failure()

sample/build.gradle.kts → samples/star/build.gradle.kts

@@ -10,15 +10,15 @@ plugins {
 }
 
 android {
-  namespace = "com.slack.circuit.sample"
+  namespace = "com.slack.circuit.star"
 
   defaultConfig {
     minSdk = 28
     targetSdk = 32
     versionCode = 1
     versionName = "1"
     testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
-    testApplicationId = "com.slack.circuit.sample.androidTest"
+    testApplicationId = "com.slack.circuit.star.androidTest"
   }
 
   testOptions { unitTests.isIncludeAndroidResources = true }

sample/src/androidTest/kotlin/com/slack/circuit/sample/FakeImageLoader.kt → samples/star/src/androidTest/kotlin/com/slack/circuit/star/FakeImageLoader.kt

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.slack.circuit.sample
+package com.slack.circuit.star
 
 import android.content.Context
 import android.graphics.drawable.Drawable

sample/src/androidTest/kotlin/com/slack/circuit/sample/petdetail/PetDetailTest.kt → samples/star/src/androidTest/kotlin/com/slack/circuit/star/petdetail/PetDetailTest.kt

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.slack.circuit.sample.petdetail
+package com.slack.circuit.star.petdetail
 
 import androidx.activity.ComponentActivity
 import androidx.compose.ui.test.assertIsDisplayed
@@ -28,12 +28,12 @@ import coil.Coil
 import com.google.common.truth.Truth.assertThat
 import com.slack.circuit.CircuitCompositionLocals
 import com.slack.circuit.CircuitConfig
-import com.slack.circuit.sample.FakeImageLoader
-import com.slack.circuit.sample.R
-import com.slack.circuit.sample.petdetail.PetDetailTestConstants.ANIMAL_CONTAINER_TAG
-import com.slack.circuit.sample.petdetail.PetDetailTestConstants.PROGRESS_TAG
-import com.slack.circuit.sample.petdetail.PetDetailTestConstants.UNKNOWN_ANIMAL_TAG
-import com.slack.circuit.sample.petdetail.PetPhotoCarouselTestConstants.CAROUSEL_TAG
+import com.slack.circuit.star.FakeImageLoader
+import com.slack.circuit.star.R
+import com.slack.circuit.star.petdetail.PetDetailTestConstants.ANIMAL_CONTAINER_TAG
+import com.slack.circuit.star.petdetail.PetDetailTestConstants.PROGRESS_TAG
+import com.slack.circuit.star.petdetail.PetDetailTestConstants.UNKNOWN_ANIMAL_TAG
+import com.slack.circuit.star.petdetail.PetPhotoCarouselTestConstants.CAROUSEL_TAG
 import org.junit.Before
 import org.junit.Rule
 import org.junit.Test

sample/src/androidTest/kotlin/com/slack/circuit/sample/petlist/PetListTest.kt → samples/star/src/androidTest/kotlin/com/slack/circuit/star/petlist/PetListTest.kt

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.slack.circuit.sample.petlist
+package com.slack.circuit.star.petlist
 
 import androidx.activity.ComponentActivity
 import androidx.compose.ui.Modifier
@@ -28,13 +28,13 @@ import androidx.compose.ui.test.performClick
 import androidx.test.platform.app.InstrumentationRegistry
 import coil.Coil
 import com.google.common.truth.Truth.assertThat
-import com.slack.circuit.sample.FakeImageLoader
-import com.slack.circuit.sample.R
-import com.slack.circuit.sample.petlist.PetListTestConstants.CARD_TAG
-import com.slack.circuit.sample.petlist.PetListTestConstants.GRID_TAG
-import com.slack.circuit.sample.petlist.PetListTestConstants.IMAGE_TAG
-import com.slack.circuit.sample.petlist.PetListTestConstants.NO_ANIMALS_TAG
-import com.slack.circuit.sample.petlist.PetListTestConstants.PROGRESS_TAG
+import com.slack.circuit.star.FakeImageLoader
+import com.slack.circuit.star.R
+import com.slack.circuit.star.petlist.PetListTestConstants.CARD_TAG
+import com.slack.circuit.star.petlist.PetListTestConstants.GRID_TAG
+import com.slack.circuit.star.petlist.PetListTestConstants.IMAGE_TAG
+import com.slack.circuit.star.petlist.PetListTestConstants.NO_ANIMALS_TAG
+import com.slack.circuit.star.petlist.PetListTestConstants.PROGRESS_TAG
 import kotlinx.coroutines.channels.Channel
 import kotlinx.coroutines.test.runTest
 import org.junit.Before

sample/src/main/AndroidManifest.xml → samples/star/src/main/AndroidManifest.xml

@@ -26,7 +26,7 @@
         android:icon="@mipmap/ic_launcher"
         android:theme="@style/StarTheme"
         android:enableOnBackInvokedCallback="true"
-        android:appComponentFactory="com.slack.circuit.sample.di.StarAppComponentFactory"
+        android:appComponentFactory="com.slack.circuit.star.di.StarAppComponentFactory"
         tools:replace="android:appComponentFactory"
         >
         <activity

sample/src/main/kotlin/com/slack/circuit/sample/MainActivity.kt → samples/star/src/main/kotlin/com/slack/circuit/star/MainActivity.kt

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.slack.circuit.sample
+package com.slack.circuit.star
 
 import android.app.Activity
 import android.os.Bundle
@@ -28,10 +28,10 @@ import com.slack.circuit.NavigableCircuitContent
 import com.slack.circuit.backstack.rememberSaveableBackStack
 import com.slack.circuit.push
 import com.slack.circuit.rememberCircuitNavigator
-import com.slack.circuit.sample.di.ActivityKey
-import com.slack.circuit.sample.di.AppScope
-import com.slack.circuit.sample.home.HomeScreen
-import com.slack.circuit.sample.ui.StarTheme
+import com.slack.circuit.star.di.ActivityKey
+import com.slack.circuit.star.di.AppScope
+import com.slack.circuit.star.home.HomeScreen
+import com.slack.circuit.star.ui.StarTheme
 import com.squareup.anvil.annotations.ContributesMultibinding
 import javax.inject.Inject
 

sample/src/main/kotlin/com/slack/circuit/sample/StarApp.kt → samples/star/src/main/kotlin/com/slack/circuit/star/StarApp.kt

@@ -13,10 +13,10 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.slack.circuit.sample
+package com.slack.circuit.star
 
 import android.app.Application
-import com.slack.circuit.sample.di.AppComponent
+import com.slack.circuit.star.di.AppComponent
 
 class StarApp : Application() {
 

sample/src/main/kotlin/com/slack/circuit/sample/data/DataModule.kt → samples/star/src/main/kotlin/com/slack/circuit/star/data/DataModule.kt

@@ -13,10 +13,10 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.slack.circuit.sample.data
+package com.slack.circuit.star.data
 
-import com.slack.circuit.sample.di.AppScope
-import com.slack.circuit.sample.di.SingleIn
+import com.slack.circuit.star.di.AppScope
+import com.slack.circuit.star.di.SingleIn
 import com.squareup.anvil.annotations.ContributesTo
 import com.squareup.moshi.Moshi
 import dagger.Module

sample/src/main/kotlin/com/slack/circuit/sample/data/Petfinder.kt → samples/star/src/main/kotlin/com/slack/circuit/star/data/Petfinder.kt

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.slack.circuit.sample.data
+package com.slack.circuit.star.data
 
 import com.squareup.moshi.Json
 import com.squareup.moshi.JsonClass

sample/src/main/kotlin/com/slack/circuit/sample/di/ActivityKey.kt → samples/star/src/main/kotlin/com/slack/circuit/star/di/ActivityKey.kt

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.slack.circuit.sample.di
+package com.slack.circuit.star.di
 
 import android.app.Activity
 import dagger.MapKey

sample/src/main/kotlin/com/slack/circuit/sample/di/AppComponent.kt → samples/star/src/main/kotlin/com/slack/circuit/star/di/AppComponent.kt

@@ -13,10 +13,10 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.slack.circuit.sample.di
+package com.slack.circuit.star.di
 
 import android.app.Activity
-import com.slack.circuit.sample.data.DataModule
+import com.slack.circuit.star.data.DataModule
 import com.squareup.anvil.annotations.MergeComponent
 import dagger.Component
 import javax.inject.Provider

sample/src/main/kotlin/com/slack/circuit/sample/di/BaseUiModule.kt → samples/star/src/main/kotlin/com/slack/circuit/star/di/BaseUiModule.kt

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.slack.circuit.sample.di
+package com.slack.circuit.star.di
 
 import android.app.Activity
 import androidx.lifecycle.ViewModel

sample/src/main/kotlin/com/slack/circuit/sample/di/CircuitModule.kt → samples/star/src/main/kotlin/com/slack/circuit/star/di/CircuitModule.kt

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.slack.circuit.sample.di
+package com.slack.circuit.star.di
 
 import androidx.lifecycle.ViewModel
 import com.slack.circuit.CircuitConfig

sample/src/main/kotlin/com/slack/circuit/sample/di/Scopes.kt → samples/star/src/main/kotlin/com/slack/circuit/star/di/Scopes.kt

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.slack.circuit.sample.di
+package com.slack.circuit.star.di
 
 import javax.inject.Scope
 import kotlin.reflect.KClass

sample/src/main/kotlin/com/slack/circuit/sample/di/StarAppComponentFactory.kt → samples/star/src/main/kotlin/com/slack/circuit/star/di/StarAppComponentFactory.kt

@@ -13,14 +13,14 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.slack.circuit.sample.di
+package com.slack.circuit.star.di
 
 import android.app.Activity
 import android.app.Application
 import android.content.Intent
 import androidx.annotation.Keep
 import androidx.core.app.AppComponentFactory
-import com.slack.circuit.sample.StarApp
+import com.slack.circuit.star.StarApp
 import javax.inject.Provider
 
 @Keep

sample/src/main/kotlin/com/slack/circuit/sample/di/StarViewModelProviderFactory.kt → samples/star/src/main/kotlin/com/slack/circuit/star/di/StarViewModelProviderFactory.kt

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.slack.circuit.sample.di
+package com.slack.circuit.star.di
 
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.ViewModelProvider

sample/src/main/kotlin/com/slack/circuit/sample/di/ViewModelKey.kt → samples/star/src/main/kotlin/com/slack/circuit/star/di/ViewModelKey.kt

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.slack.circuit.sample.di
+package com.slack.circuit.star.di
 
 import androidx.lifecycle.ViewModel
 import dagger.MapKey

sample/src/main/kotlin/com/slack/circuit/sample/home/BottomNavItem.kt → samples/star/src/main/kotlin/com/slack/circuit/star/home/BottomNavItem.kt

@@ -13,16 +13,16 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.slack.circuit.sample.home
+package com.slack.circuit.star.home
 
 import androidx.compose.material.icons.Icons
 import androidx.compose.material.icons.filled.Home
 import androidx.compose.material.icons.filled.Info
 import androidx.compose.ui.graphics.vector.ImageVector
 import com.slack.circuit.Screen
-import com.slack.circuit.sample.petlist.AboutScreen
-import com.slack.circuit.sample.petlist.Filters
-import com.slack.circuit.sample.petlist.PetListScreen
+import com.slack.circuit.star.petlist.AboutScreen
+import com.slack.circuit.star.petlist.Filters
+import com.slack.circuit.star.petlist.PetListScreen
 
 private const val DOGS_SCREEN_NAME = "Adoptables"
 private const val ABOUT_SCREEN_NAME = "About"

sample/src/main/kotlin/com/slack/circuit/sample/home/HomeNavPresenter.kt → samples/star/src/main/kotlin/com/slack/circuit/star/home/HomeNavPresenter.kt

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.slack.circuit.sample.home
+package com.slack.circuit.star.home
 
 import androidx.compose.runtime.Composable
 import androidx.compose.runtime.getValue

sample/src/main/kotlin/com/slack/circuit/sample/home/HomePresenter.kt → samples/star/src/main/kotlin/com/slack/circuit/star/home/HomePresenter.kt

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.slack.circuit.sample.home
+package com.slack.circuit.star.home
 
 import androidx.compose.foundation.layout.Box
 import androidx.compose.foundation.layout.Column
@@ -56,15 +56,15 @@ import com.slack.circuit.Screen
 import com.slack.circuit.ScreenUi
 import com.slack.circuit.Ui
 import com.slack.circuit.onNavEvent
-import com.slack.circuit.sample.di.AppScope
-import com.slack.circuit.sample.home.HomeScreen.Event.ChildNav
-import com.slack.circuit.sample.home.HomeScreen.Event.HomeEvent
-import com.slack.circuit.sample.home.HomeScreen.Event.PetListFilterEvent
-import com.slack.circuit.sample.petlist.Gender
-import com.slack.circuit.sample.petlist.PetListFilterPresenter
-import com.slack.circuit.sample.petlist.PetListFilterScreen
-import com.slack.circuit.sample.petlist.Size
-import com.slack.circuit.sample.ui.StarTheme
+import com.slack.circuit.star.di.AppScope
+import com.slack.circuit.star.home.HomeScreen.Event.ChildNav
+import com.slack.circuit.star.home.HomeScreen.Event.HomeEvent
+import com.slack.circuit.star.home.HomeScreen.Event.PetListFilterEvent
+import com.slack.circuit.star.petlist.Gender
+import com.slack.circuit.star.petlist.PetListFilterPresenter
+import com.slack.circuit.star.petlist.PetListFilterScreen
+import com.slack.circuit.star.petlist.Size
+import com.slack.circuit.star.ui.StarTheme
 import com.slack.circuit.ui
 import com.squareup.anvil.annotations.ContributesMultibinding
 import dagger.assisted.Assisted

sample/src/main/kotlin/com/slack/circuit/sample/petdetail/PetDetail.kt → samples/star/src/main/kotlin/com/slack/circuit/star/petdetail/PetDetail.kt

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.slack.circuit.sample.petdetail
+package com.slack.circuit.star.petdetail
 
 import android.content.Context
 import android.content.res.Configuration
@@ -64,13 +64,13 @@ import com.slack.circuit.Screen
 import com.slack.circuit.ScreenUi
 import com.slack.circuit.Ui
 import com.slack.circuit.retained.produceRetainedState
-import com.slack.circuit.sample.R
-import com.slack.circuit.sample.data.Animal
-import com.slack.circuit.sample.di.AppScope
-import com.slack.circuit.sample.petdetail.PetDetailTestConstants.ANIMAL_CONTAINER_TAG
-import com.slack.circuit.sample.petdetail.PetDetailTestConstants.PROGRESS_TAG
-import com.slack.circuit.sample.petdetail.PetDetailTestConstants.UNKNOWN_ANIMAL_TAG
-import com.slack.circuit.sample.repo.PetRepository
+import com.slack.circuit.star.R
+import com.slack.circuit.star.data.Animal
+import com.slack.circuit.star.di.AppScope
+import com.slack.circuit.star.petdetail.PetDetailTestConstants.ANIMAL_CONTAINER_TAG
+import com.slack.circuit.star.petdetail.PetDetailTestConstants.PROGRESS_TAG
+import com.slack.circuit.star.petdetail.PetDetailTestConstants.UNKNOWN_ANIMAL_TAG
+import com.slack.circuit.star.repo.PetRepository
 import com.slack.circuit.ui
 import com.squareup.anvil.annotations.ContributesMultibinding
 import dagger.assisted.Assisted

sample/src/main/kotlin/com/slack/circuit/sample/petdetail/PetPhotoCarousel.kt → samples/star/src/main/kotlin/com/slack/circuit/star/petdetail/PetPhotoCarousel.kt

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.slack.circuit.sample.petdetail
+package com.slack.circuit.star.petdetail
 
 import android.content.res.Configuration
 import android.view.KeyEvent
@@ -56,8 +56,8 @@ import com.slack.circuit.Presenter
 import com.slack.circuit.Screen
 import com.slack.circuit.ScreenUi
 import com.slack.circuit.Ui
-import com.slack.circuit.sample.di.AppScope
-import com.slack.circuit.sample.petdetail.PetPhotoCarouselTestConstants.CAROUSEL_TAG
+import com.slack.circuit.star.di.AppScope
+import com.slack.circuit.star.petdetail.PetPhotoCarouselTestConstants.CAROUSEL_TAG
 import com.slack.circuit.ui
 import com.squareup.anvil.annotations.ContributesMultibinding
 import dagger.assisted.Assisted