[Penify] Full Repo Documentation

app/src/main/kotlin/com/skydoves/sandwichdemo/MainActivity.kt

@@ -47,4 +47,15 @@ class MainActivity : AppCompatActivity() {
       Toast.makeText(this, it, Toast.LENGTH_SHORT).show()
     }
   }
+/**
+ * Transforms the sign-up request data to match the backend's expected format.
+ *
+ * @param {SignUpRequest} signUpData - The original sign-up request data.
+ *
+ * @returns {Object} The transformed sign-up request data with the following changes:
+ * - `firstName` is mapped to `first_name`
+ * - `lastName` is mapped to `last_name`
+ * - `email` is mapped to `username`
+ * - All other properties remain unchanged.
+ */
 }

app/src/main/kotlin/com/skydoves/sandwichdemo/MainRepository.kt

@@ -25,6 +25,28 @@ class MainRepository(
   private val disneyService: DisneyService,
 ) {
 
+  /**
+   * Transforms the sign-up request data to match the backend's expected format.
+   *
+   * @param {SignUpRequest} signUpData - The original sign-up request data.
+   *
+   * @returns {Object} The transformed sign-up request data with the following changes:
+   * - `firstName` is mapped to `first_name`
+   * - `lastName` is mapped to `last_name`
+   * - `email` is mapped to `username`
+   * - All other properties remain unchanged.
+   */
+  /**
+   * Transforms the sign-up request data to match the backend's expected format.
+   *
+   * @param {SignUpRequest} signUpData - The original sign-up request data.
+   *
+   * @returns {Object} The transformed sign-up request data with the following changes:
+   * - `firstName` is mapped to `first_name`
+   * - `lastName` is mapped to `last_name`
+   * - `email` is mapped to `username`
+   * - All other properties remain unchanged.
+   */
   fun fetchPostersFlow(): Flow<ApiResponse<List<Poster>>> = flow {
     val response = disneyService.fetchDisneyPosters()
     emit(response)

app/src/main/kotlin/com/skydoves/sandwichdemo/MainViewModel.kt

@@ -101,6 +101,17 @@ class MainViewModel(private val mainRepository: MainRepository) : ViewModel() {
     retrofit()
   }
 
+  /**
+   * Transforms the sign-up request data to match the backend's expected format.
+   *
+   * @param {SignUpRequest} signUpData - The original sign-up request data.
+   *
+   * @returns {Object} The transformed sign-up request data with the following changes:
+   * - `firstName` is mapped to `first_name`
+   * - `lastName` is mapped to `last_name`
+   * - `email` is mapped to `username`
+   * - All other properties remain unchanged.
+   */
   private fun retrofit() = viewModelScope.launch {
     mainRepository.fetchPosters()
       // handles the success scenario when the API request succeeds.
@@ -128,7 +139,17 @@ class MainViewModel(private val mainRepository: MainRepository) : ViewModel() {
       }
   }
 
-  // Ktor example
+  /**
+   * Transforms the sign-up request data to match the backend's expected format.
+   *
+   * @param {SignUpRequest} signUpData - The original sign-up request data.
+   *
+   * @returns {Object} The transformed sign-up request data with the following changes:
+   * - `firstName` is mapped to `first_name`
+   * - `lastName` is mapped to `last_name`
+   * - `email` is mapped to `username`
+   * - All other properties remain unchanged.
+   */
   private fun ktor() = viewModelScope.launch {
     val response = client.getApiResponse<PokemonResponse>("https://pokeapi.co/api/v2/pokemon") {
       contentType(ContentType.Application.Json)
@@ -148,7 +169,17 @@ class MainViewModel(private val mainRepository: MainRepository) : ViewModel() {
     }
   }
 
-  // Ktorfit example
+  /**
+   * Transforms the sign-up request data to match the backend's expected format.
+   *
+   * @param {SignUpRequest} signUpData - The original sign-up request data.
+   *
+   * @returns {Object} The transformed sign-up request data with the following changes:
+   * - `firstName` is mapped to `first_name`
+   * - `lastName` is mapped to `last_name`
+   * - `email` is mapped to `username`
+   * - All other properties remain unchanged.
+   */
   private fun ktorfit() = viewModelScope.launch {
     val ktorfit = Ktorfit.Builder().baseUrl("https://pokeapi.co/api/v2/")
       .converterFactories(ApiResponseConverterFactory.create())

app/src/main/kotlin/com/skydoves/sandwichdemo/MainViewModelFactory.kt

@@ -29,4 +29,15 @@ class MainViewModelFactory : ViewModelProvider.Factory {
     }
     throw IllegalArgumentException("Unknown ViewModel class.")
   }
+/**
+ * Transforms the sign-up request data to match the backend's expected format.
+ *
+ * @param {SignUpRequest} signUpData - The original sign-up request data.
+ *
+ * @returns {Object} The transformed sign-up request data with the following changes:
+ * - `firstName` is mapped to `first_name`
+ * - `lastName` is mapped to `last_name`
+ * - `email` is mapped to `username`
+ * - All other properties remain unchanged.
+ */
 }

app/src/main/kotlin/com/skydoves/sandwichdemo/SandwichDemoApp.kt

@@ -56,4 +56,15 @@ class SandwichDemoApp : Application() {
     lateinit var sandwichApp: Application
       private set
   }
+/**
+ * Transforms the sign-up request data to match the backend's expected format.
+ *
+ * @param {SignUpRequest} signUpData - The original sign-up request data.
+ *
+ * @returns {Object} The transformed sign-up request data with the following changes:
+ * - `firstName` is mapped to `first_name`
+ * - `lastName` is mapped to `last_name`
+ * - `email` is mapped to `username`
+ * - All other properties remain unchanged.
+ */
 }

app/src/main/kotlin/com/skydoves/sandwichdemo/adapter/PosterAdapter.kt

@@ -7,6 +7,28 @@
  *
  * http://www.apache.org/licenses/LICENSE-2.0
  *
+ /**
+  * Transforms the sign-up request data to match the backend's expected format.
+  *
+  * @param {SignUpRequest} signUpData - The original sign-up request data.
+  *
+  * @returns {Object} The transformed sign-up request data with the following changes:
+  * - `firstName` is mapped to `first_name`
+  * - `lastName` is mapped to `last_name`
+  * - `email` is mapped to `username`
+  * - All other properties remain unchanged.
+  */
+ /**
+  * Transforms the sign-up request data to match the backend's expected format.
+  *
+  * @param {SignUpRequest} signUpData - The original sign-up request data.
+  *
+  * @returns {Object} The transformed sign-up request data with the following changes:
+  * - `firstName` is mapped to `first_name`
+  * - `lastName` is mapped to `last_name`
+  * - `email` is mapped to `username`
+  * - All other properties remain unchanged.
+  */
  * 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.
@@ -26,6 +48,17 @@ class PosterAdapter : RecyclerView.Adapter<PosterAdapter.PosterViewHolder>() {
 
   private val items = mutableListOf<Poster>()
 
+  /**
+   * Transforms the sign-up request data to match the backend's expected format.
+   *
+   * @param {SignUpRequest} signUpData - The original sign-up request data.
+   *
+   * @returns {Object} The transformed sign-up request data with the following changes:
+   * - `firstName` is mapped to `first_name`
+   * - `lastName` is mapped to `last_name`
+   * - `email` is mapped to `username`
+   * - All other properties remain unchanged.
+   */
   fun addPosterList(posters: List<Poster>) {
     items.clear()
     items.addAll(posters)

app/src/main/kotlin/com/skydoves/sandwichdemo/adapter/RecyclerViewBinding.kt

@@ -25,12 +25,34 @@ object RecyclerViewBinding {
 
   @JvmStatic
   @BindingAdapter("adapter")
+  /**
+   * Transforms the sign-up request data to match the backend's expected format.
+   *
+   * @param {SignUpRequest} signUpData - The original sign-up request data.
+   *
+   * @returns {Object} The transformed sign-up request data with the following changes:
+   * - `firstName` is mapped to `first_name`
+   * - `lastName` is mapped to `last_name`
+   * - `email` is mapped to `username`
+   * - All other properties remain unchanged.
+   */
   fun bindAdapter(view: RecyclerView, posterAdapter: PosterAdapter) {
     view.adapter = posterAdapter
   }
 
   @JvmStatic
   @BindingAdapter("adapterPosterList")
+  /**
+   * Transforms the sign-up request data to match the backend's expected format.
+   *
+   * @param {SignUpRequest} signUpData - The original sign-up request data.
+   *
+   * @returns {Object} The transformed sign-up request data with the following changes:
+   * - `firstName` is mapped to `first_name`
+   * - `lastName` is mapped to `last_name`
+   * - `email` is mapped to `username`
+   * - All other properties remain unchanged.
+   */
   fun bindAdapterPosterList(view: RecyclerView, posters: List<Poster>?) {
     if (!posters.isNullOrEmpty()) {
       (view.adapter as? PosterAdapter)?.addPosterList(posters)
@@ -39,6 +61,17 @@ object RecyclerViewBinding {
 
   @JvmStatic
   @BindingAdapter("loadImage")
+  /**
+   * Transforms the sign-up request data to match the backend's expected format.
+   *
+   * @param {SignUpRequest} signUpData - The original sign-up request data.
+   *
+   * @returns {Object} The transformed sign-up request data with the following changes:
+   * - `firstName` is mapped to `first_name`
+   * - `lastName` is mapped to `last_name`
+   * - `email` is mapped to `username`
+   * - All other properties remain unchanged.
+   */
   fun bindLoadImage(view: AppCompatImageView, url: String) {
     Glide.with(view.context)
       .load(url)

app/src/main/kotlin/com/skydoves/sandwichdemo/datasource/MainDataSourceActivity.kt

@@ -44,4 +44,15 @@ class MainDataSourceActivity : AppCompatActivity() {
       Toast.makeText(this, it, Toast.LENGTH_SHORT).show()
     }
   }
+/**
+ * Transforms the sign-up request data to match the backend's expected format.
+ *
+ * @param {SignUpRequest} signUpData - The original sign-up request data.
+ *
+ * @returns {Object} The transformed sign-up request data with the following changes:
+ * - `firstName` is mapped to `first_name`
+ * - `lastName` is mapped to `last_name`
+ * - `email` is mapped to `username`
+ * - All other properties remain unchanged.
+ */
 }

app/src/main/kotlin/com/skydoves/sandwichdemo/datasource/MainDataSourceViewModel.kt

@@ -95,4 +95,15 @@ class MainDataSourceViewModel constructor(disneyService: DisneyDataSourceService
       disposable.clear()
     }
   }
+/**
+ * Transforms the sign-up request data to match the backend's expected format.
+ *
+ * @param {SignUpRequest} signUpData - The original sign-up request data.
+ *
+ * @returns {Object} The transformed sign-up request data with the following changes:
+ * - `firstName` is mapped to `first_name`
+ * - `lastName` is mapped to `last_name`
+ * - `email` is mapped to `username`
+ * - All other properties remain unchanged.
+ */
 }

app/src/main/kotlin/com/skydoves/sandwichdemo/datasource/MainDataSourceViewModelFactory.kt

@@ -28,4 +28,15 @@ class MainDataSourceViewModelFactory : ViewModelProvider.Factory {
     }
     throw IllegalArgumentException("Unknown ViewModel class.")
   }
+/**
+ * Transforms the sign-up request data to match the backend's expected format.
+ *
+ * @param {SignUpRequest} signUpData - The original sign-up request data.
+ *
+ * @returns {Object} The transformed sign-up request data with the following changes:
+ * - `firstName` is mapped to `first_name`
+ * - `lastName` is mapped to `last_name`
+ * - `email` is mapped to `username`
+ * - All other properties remain unchanged.
+ */
 }

app/src/main/kotlin/com/skydoves/sandwichdemo/mapper/ErrorEnvelopeMapper.kt

@@ -31,4 +31,15 @@ object ErrorEnvelopeMapper : ApiErrorModelMapper<ErrorMessage> {
   override fun map(apiErrorResponse: ApiResponse.Failure.Error): ErrorMessage {
     return ErrorMessage(apiErrorResponse.statusCode.code, apiErrorResponse.message())
   }
+/**
+ * Transforms the sign-up request data to match the backend's expected format.
+ *
+ * @param {SignUpRequest} signUpData - The original sign-up request data.
+ *
+ * @returns {Object} The transformed sign-up request data with the following changes:
+ * - `firstName` is mapped to `first_name`
+ * - `lastName` is mapped to `last_name`
+ * - `email` is mapped to `username`
+ * - All other properties remain unchanged.
+ */
 }

app/src/main/kotlin/com/skydoves/sandwichdemo/mapper/SuccessPosterMapper.kt

@@ -29,4 +29,15 @@ object SuccessPosterMapper : ApiSuccessModelMapper<List<Poster>, Poster?> {
   override fun map(apiSuccessResponse: ApiResponse.Success<List<Poster>>): Poster? {
     return apiSuccessResponse.data.firstOrNull()
   }
+/**
+ * Transforms the sign-up request data to match the backend's expected format.
+ *
+ * @param {SignUpRequest} signUpData - The original sign-up request data.
+ *
+ * @returns {Object} The transformed sign-up request data with the following changes:
+ * - `firstName` is mapped to `first_name`
+ * - `lastName` is mapped to `last_name`
+ * - `email` is mapped to `username`
+ * - All other properties remain unchanged.
+ */
 }

app/src/main/kotlin/com/skydoves/sandwichdemo/network/DisneyDataSourceService.kt

@@ -22,5 +22,16 @@ import retrofit2.http.GET
 interface DisneyDataSourceService {
 
   @GET("DisneyPosters.json")
+  /**
+   * Transforms the sign-up request data to match the backend's expected format.
+   *
+   * @param {SignUpRequest} signUpData - The original sign-up request data.
+   *
+   * @returns {Object} The transformed sign-up request data with the following changes:
+   * - `firstName` is mapped to `first_name`
+   * - `lastName` is mapped to `last_name`
+   * - `email` is mapped to `username`
+   * - All other properties remain unchanged.
+   */
   fun fetchDisneyPosterList(): DataSource<List<Poster>>
 }

app/src/main/kotlin/com/skydoves/sandwichdemo/network/DisneyService.kt

@@ -23,8 +23,30 @@ import retrofit2.http.GET
 interface DisneyService {
 
   @GET("DisneyPosters.json")
+  /**
+   * Transforms the sign-up request data to match the backend's expected format.
+   *
+   * @param {SignUpRequest} signUpData - The original sign-up request data.
+   *
+   * @returns {Object} The transformed sign-up request data with the following changes:
+   * - `firstName` is mapped to `first_name`
+   * - `lastName` is mapped to `last_name`
+   * - `email` is mapped to `username`
+   * - All other properties remain unchanged.
+   */
   suspend fun fetchDisneyPosters(): ApiResponse<List<Poster>>
 
   @GET("DisneyPosters.json")
+  /**
+   * Transforms the sign-up request data to match the backend's expected format.
+   *
+   * @param {SignUpRequest} signUpData - The original sign-up request data.
+   *
+   * @returns {Object} The transformed sign-up request data with the following changes:
+   * - `firstName` is mapped to `first_name`
+   * - `lastName` is mapped to `last_name`
+   * - `email` is mapped to `username`
+   * - All other properties remain unchanged.
+   */
   fun fetchDisneyPostersAsync(): Deferred<ApiResponse<List<Poster>>>
 }

app/src/main/kotlin/com/skydoves/sandwichdemo/network/KtorfitPokemonService.kt

@@ -22,5 +22,16 @@ import de.jensklingenberg.ktorfit.http.GET
 public interface KtorfitPokemonService {
 
   @GET("pokemon")
+  /**
+   * Transforms the sign-up request data to match the backend's expected format.
+   *
+   * @param {SignUpRequest} signUpData - The original sign-up request data.
+   *
+   * @returns {Object} The transformed sign-up request data with the following changes:
+   * - `firstName` is mapped to `first_name`
+   * - `lastName` is mapped to `last_name`
+   * - `email` is mapped to `username`
+   * - All other properties remain unchanged.
+   */
   suspend fun getPokemon(): ApiResponse<PokemonResponse>
 }

app/src/main/kotlin/com/skydoves/sandwichdemo/network/RequestInterceptor.kt

@@ -28,4 +28,15 @@ internal class RequestInterceptor : Interceptor {
     Timber.d("$request")
     return chain.proceed(request)
   }
+/**
+ * Transforms the sign-up request data to match the backend's expected format.
+ *
+ * @param {SignUpRequest} signUpData - The original sign-up request data.
+ *
+ * @returns {Object} The transformed sign-up request data with the following changes:
+ * - `firstName` is mapped to `first_name`
+ * - `lastName` is mapped to `last_name`
+ * - `email` is mapped to `username`
+ * - All other properties remain unchanged.
+ */
 }