reduce code duplication of DTOs validations - oop

I have the following two data classes
data class CreateMedicDto(
val firstName: String,
val lastName: String,
val pin: String,
val address: String?,
val birthDate: LocalDate,
val specialty: Specialty,
)
data class UpdateMedicDto(
val firstName: String,
val lastName: String,
val address: String?,
val birthDate: LocalDate,
val specialty: Specialty,
)
The only difference is that the second one is missing pin field. The reason for that is that in case of update I do not want to allow the possibility to change the pin by using making use of the language and framework features.
Currently, in this form, I will need to validate both of them:
fun validateMedic(
input: CreateMedicDto,
): MedicValidationResult? {
with(input) {
if (checkLengthBetween1And50(input.firstName)) return MedicValidationResult.InvalidFirstNameLength
if (checkLengthBetween1And50(input.lastName)) return MedicValidationResult.InvalidLastNameLength
address?.let {
if (checkLengthGreaterThan500(it)) return MedicValidationResult.InvalidAddressLength
}
if (checkDateValidity(birthDate)) return MedicValidationResult.InvalidBirthDate
}
return null
}
fun validateMedic(
input: UpdateMedicDto,
): MedicValidationResult? {
with(input) {
if (checkLengthBetween1And50(input.firstName)) return MedicValidationResult.InvalidFirstNameLength
if (checkLengthBetween1And50(input.lastName)) return MedicValidationResult.InvalidLastNameLength
address?.let {
if (checkLengthGreaterThan500(it)) return MedicValidationResult.InvalidAddressLength
}
if (checkDateValidity(birthDate)) return MedicValidationResult.InvalidBirthDate
}
return null
}
The code is almost identical, only the input parameter type is different.
The question is how can I reduce it to a single function?
I have some solutions but there are also some reasons for that I would not like to use them:
Inherit CreateMedicDto from UpdateMedicDto. This may easily solve the problem but it doesn't really make much sense to say that CreateMedicDto is an UpdateMedicDto
Make that pin field nullable. With this approach I abandon the language null-safety feature and I am going to rely on a parameter which says "create" or "update"
Both extending a common class. The third class is actually useless and can't find a proper name for it
Any better approaches to still benefit from the type safety?

Your option 3 is called an abstract class. abstract means it cannot be instantiated, but also that it can have abstract members (properties and functions with no implementation or initial value).
An option 4 would be to create a common interface for both of them.
But in both cases, there will still be duplication of all the property names because you have to override them. But it fixes the duplication at your validation functions.
Option 3 example:
abstract class MedicDto {
abstract val firstName: String
abstract val lastName: String
abstract val pin: String
abstract val address: String?
abstract val birthDate: LocalDate
abstract val specialty: Specialty
}
data class CreateMedicDto(
override val firstName: String,
override val lastName: String,
val pin: String,
override val address: String?,
override val birthDate: LocalDate,
override val specialty: Specialty,
): MedicDto()
data class UpdateMedicDto(
override val firstName: String,
override val lastName: String,
override val address: String?,
override val birthDate: LocalDate,
override val specialty: Specialty,
): MedicDto()
Option 4 example:
interface MedicDto {
val firstName: String
val lastName: String
val pin: String
val address: String?
val birthDate: LocalDate
val specialty: Specialty
}
data class CreateMedicDto(
override val firstName: String,
override val lastName: String,
val pin: String,
override val address: String?,
override val birthDate: LocalDate,
override val specialty: Specialty,
): MedicDto
data class UpdateMedicDto(
override val firstName: String,
override val lastName: String,
override val address: String?,
override val birthDate: LocalDate,
override val specialty: Specialty,
): MedicDto

Related

Why retrofit returns null in response body?

Get null response results in response body. Using retrofit, dagger and repository. Why get null in response I don't know. My model seem right. Whats the problem?
MainViewModel.kt
#HiltViewModel
class MainViewModel#Inject constructor(
private val repository: MovieRepository,
#ApplicationContext private val context: Context
) : ViewModel() {
val movieList = MutableLiveData<Resource<Movie>>()
fun getAllMovies(movieName: String) {
movieList.postValue(Resource.Loading())
viewModelScope.launch {
try {
if (hasInternetConnection(context)) {
val response = repository.getMovies(movieName, "ffe9123f")
movieList.postValue(Resource.Success(response.body()!!))
} else
movieList.postValue(Resource.Error("Internet yok"))
} catch (ex: Exception) {
when (ex) {
is IOException -> movieList.postValue(Resource.Error("Network Failure " + ex.localizedMessage))
else -> movieList.postValue(Resource.Error("Conversion Error"))
}
}
}
}
}
Resource.kt
sealed class Resource<T>(
val data: T? = null,
val message: String? = null
) {
class Success<T>(data: T): Resource<T>(data)
class Error<T>(message: String, data: T? = null): Resource<T>(data, message)
class Loading<T> : Resource<T>()
}
MovieRepository.kt
#Singleton
class MovieRepository #Inject constructor(private val movieAppService: MovieAppService) {
suspend fun getMovies(title: String, aKey: String): Response<Movie> = withContext(
Dispatchers.IO
) {
val movies = movieAppService.getMovies(title = title, aKey = aKey)
movies
}
Movie.kt
data class Movie(
val title: String,
val year: String,
val rated: String,
val released: String,
val runtime: String,
val genre: String,
val director: String,
val writer: String,
val actors: String,
val plot: String,
val language: String,
val country: String,
val awards: String,
val poster: String,
val ratings: List<Rating>,
val metascore: String,
val imdbRating: String,
val imdbVotes: String,
val imdbID: String,
val type: String,
val dvd: String,
val boxOffice: String,
val production: String,
val website: String,
val response: String
)
MovieAppService.kt
interface MovieAppService {
companion object {
const val ENDPOINT = "http://www.omdbapi.com/"
}
#GET(".")
suspend fun getMovies(#Query("t") title: String,#Query("apikey") aKey: String): Response<Movie>
}
{"Title":"A Beautiful Mind","Year":"2001","Rated":"PG-13","Released":"04 Jan 2002","Runtime":"135 min","Genre":"Biography, Drama","Director":"Ron Howard","Writer":"Akiva Goldsman, Sylvia Nasar","Actors":"Russell Crowe, Ed Harris, Jennifer Connelly","Plot":"After John Nash, a brilliant but asocial mathematician, accepts secret work in cryptography, his life takes a turn for the nightmarish.","Language":"English","Country":"United States","Awards":"Won 4 Oscars. 37 wins & 69 nominations total","Poster":"https://m.media-amazon.com/images/M/MV5BMzcwYWFkYzktZjAzNC00OGY1LWI4YTgtNzc5MzVjMDVmNjY0XkEyXkFqcGdeQXVyMTQxNzMzNDI#._V1_SX300.jpg","Ratings":[{"Source":"Internet Movie Database","Value":"8.2/10"},{"Source":"Rotten Tomatoes","Value":"74%"},{"Source":"Metacritic","Value":"72/100"}],"Metascore":"72","imdbRating":"8.2","imdbVotes":"908,920","imdbID":"tt0268978","Type":"movie","DVD":"25 Jun 2002","BoxOffice":"$170,742,341","Production":"N/A","Website":"N/A","Response":"True"}
Movie model is wrong. I didn't realize the starting letter is uppercase letter.
Movie.kt
data class Movie(
val Title: String,
val Year: String,
val Rated: String,
val Released: String,
val Runtime: String,
val Genre: String,
val Director: String,
val Writer: String,
val Actors: String,
val Plot: String,
val Language: String,
val Country: String,
val Awards: String,
val Poster: String,
val Ratings: List<Rating>,
val Metascore: String,
val imdbRating: String,
val imdbVotes: String,
val imdbID: String,
val Type: String,
val Dvd: String,
val boxOffice: String,
val Production: String,
val Website: String,
val Response: String
)

Attempt to invoke interface method 'int java.util.List.size()' on a null object reference on passing Parcelable in Intent Kotlin

So I have a sample app that is currently using Retrofit to fetch data and display it in a recyclerview with its custom adapter. I want to pass the data to the a more details page when I click on a character name on my recyclerView. I found some tutorials and decided to use the Parcelize annotation like this:
#Parcelize data class Character (
val charID: Long,
val name: String,
val birthday: String,
val occupation: List<String>,
val img: String,
val status: String,
val nickname: String,
val appearance: List<Long>,
val portrayed: String,
val category: String,
val betterCallSaulAppearance: List<Long> ) : Parcelable
My adapter looks like this:
override fun onBindViewHolder(holder: ViewHolder, position: Int) {
val character = characters[position]
holder.characterNameText.text = character.name
holder.characterNameText.setOnClickListener {
holder.passData(character)
}
}
override fun getItemCount() = characters.size
class ViewHolder(itemView : View) : RecyclerView.ViewHolder(itemView) {
val characterNameText = itemView.findViewById<TextView>(R.id.character_name)
fun passData(character : Character) {
val intent = Intent(itemView.context, CharacterDetails::class.java)
intent.putExtra(CHARACTER, character)
itemView.context.startActivity(intent)
}
}
And in the CharacterDetails Activity it looks like this:
companion object {
const val CHARACTER = "character"
}
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_character_details)
val bundle = intent.extras
val character = bundle!!.getParcelable<Character>(CHARACTER)
val characterName = findViewById<TextView>(R.id.character_details_name)
Yet I get a
java.lang.NullPointerException: Attempt to invoke interface method 'int java.util.List.size()' on a null object reference
at com.example.myapplication.models.Character.writeToParcel(Unknown Source:85)
I'm still new to this so I really need your help.Thanks!
Obviously, the error caused by the list reference of the data class is null. You can modify the code like this.
#Parcelize data class Character (
val charID: Long,
val name: String,
val birthday: String,
val occupation: List<String>?,
val img: String,
val status: String,
val nickname: String,
val appearance: List<Long>?,
val portrayed: String,
val category: String,
val betterCallSaulAppearance: List<Long>? ) : Parcelable

How to ignore kotlin delegated property using Room ```#Ignore``` annotation

I want to add a delegated property to my Composition class, as follows
#Entity
data class Composition(
val author: String="",
val background: String?,
val description: String="",
val downloadURL: String="",
val duration: String="",
val headPortrait: String?,
#PrimaryKey val id: String,
val isLike: Boolean,
val likeAmount: String="",
val playingAmount: Int=0,
val replyAmount: String?,
val showStyle: String?,
val title: String?,
val userId: String?,
val commentAmount: String?,
val cover: String=""
){
val showDuration by lazy{
val minutes = duration.toInt() /60
val seconds =duration.toInt()%60
"$minutes:$seconds"
}
}
But there gona be a compile error because delegated property can not be saved in database. So i want to
add an
Ignore annotation to this field. What a pity that Androidstuio will throws a complain "This annotation is not applicable to target 'member property with delegate" . Who has ideas for this problem?
As user IR42 points out in his comment, you can use #delegate:Ignore.

Return different object types from pre-existing classes in kotlin

I am working with a method which return different kind of objects and I am using the Any type to achieve this.
the method looks like this:
override fun presentNativeItem(dcsItem: DCSItem): Any {
var type = dcsItem?.type?.toUpperCase()
return when (type) {
DSCType.NAVMENU.name -> buildNavMenu(dcsItem)
DSCType.NAVLINK.name -> buildNavLink(dcsItem)
DSCType.IMAGE.name -> buildImage(dcsItem)
else -> throw IllegalStateException("Unknown Type ${dcsItem?.type} of NavItem")
}
}
The model of the classes is just like:
abstract class NavItem {
abstract val attributes: String
abstract val text: String
abstract val hasChildren: Boolean
abstract val childrenIds: List<Int>?
abstract val items: List<NavItem>?
abstract val hasImages: Boolean
abstract val image: String?
}
data class NavMenu(override val items: List<NavItem>?,
override var image: String?,
override val attributes: String,
override val text: String,
override val hasChildren: Boolean,
override val childrenIds: List<Int>?,
override val hasImages: Boolean) : NavItem()
data class NavLink(override val items: List<NavItem>?,
val shortText: String?,
override var image: String?,
override val attributes: String,
override val text: String,
override val hasChildren: Boolean,
override val childrenIds: List<Int>?,
override val hasImages: Boolean) : NavItem()
And finally I am using this method in the next way:
override fun getNavItemById(dCSServiceContext: DCSServiceContext): Single<Any> {
return scribeProvider.getNavItemById(dCSServiceContext).map { navItem ->
scribePresenter.presentNativeItem(navItem)
}
}
I have read about sealed classes, but you have to create classes with a constructor inside the sealed classes, I have this model which I can't modify because it is used in several places.
Any ideas?
Thanks!
Wrap the different return types in a sealed class hierarchy and return NativeItem from your function:
sealed class NativeItem
class NavMenuItem(val menu: NavMenu) : NativeItem()
class NavLinkItem(val link: NavLink) : NativeItem()
class ImageItem(val image: Image) : NativeItem()

Best practice for handling null types in classes when mapping classes together

I am using Kotlin 1.30. I have the following entity classes that will be populated from the API. And some of the properties could be null from the API so I have declared them using the safe null type.
However, I will map this entity class to my domain model class. And just wondering what is the best way to handle the null types?
I have 2 ideas on how to do this when I map the classes.
declare all the equivalent properties as safe null types
use the elivs operator to return either a empty string or a emptylist
In the following snippet I am using the elvis operator. Just wondering what is the best practice for this?
class LoginResponseDomainMapperImp : LoginResponseDomainMapper {
override fun map(entity: LoginResponseEntity): LoginResponse {
return LoginResponse(
entity.token ?: "",
mapUsers(entity.user),
mapEnterprises(entity.enterprises ?: emptyList()),
mapVendors(entity.vendors ?: emptyList()))
}
private fun mapUsers(userEntity: UserEntity?): User {
return User(
userEntity?.id,
userEntity?.email,
userEntity?.firstName,
userEntity?.lastName,
userEntity?.phone,
userEntity?.address,
userEntity?.dob,
userEntity?.customer,
userEntity?.enterpriseIds ?: emptyList(),
userEntity?.vendorIds ?: emptyList())
}
private fun mapEnterprises(enterprisesEntity: List<EnterprisesEntity>): List<Enterprises> {
val enterpriseList = mutableListOf<Enterprises>()
enterprisesEntity.forEach {
val enterprise = Enterprises(
it.id,
it.enterpriseName,
it.typeLabel,
it.country,
it.imageId,
it.managers,
it.members,
it.stripe,
it.locations)
enterpriseList.add(enterprise)
}
return enterpriseList.toList()
}
private fun mapVendors(vendorsEntity: List<VendorsEntity>): List<Vendors> {
val vendorList = mutableListOf<Vendors>()
vendorsEntity.forEach {
val vendor = Vendors(
it.id,
it.vendorName,
it.typeLabel,
it.userRole,
it.latitude,
it.longitude,
it.partner,
it.country,
it.imageId,
it.stripe)
vendorList.add(vendor)
}
return vendorList.toList()
}
}
Entity class that will populate from the API, so any of these could be null
data class LoginResponseEntity(
#SerializedName("token") val token: String?,
#SerializedName("user") val user: UserEntity?,
#SerializedName("enterprises") val enterprises: List<EnterprisesEntity>?,
#SerializedName("vendors") val vendors: List<VendorsEntity>?)
data class UserEntity(
#SerializedName("id") val id: String?,
#SerializedName("email") val email: String?,
#SerializedName("first_name") val firstName: String?,
#SerializedName("last_name") val lastName: String?,
#SerializedName("phone") val phone: String?,
#SerializedName("address") val address: String?,
#SerializedName("dob") val dob: String?,
#SerializedName("customer") val customer: String?,
#SerializedName("enterprise_ids") val enterpriseIds: List<String>?,
#SerializedName("vendor_ids") val vendorIds: List<String>?)
data class EnterprisesEntity(
#SerializedName("id") val id: String?,
#SerializedName("enterprise_name") val enterpriseName: String?,
#SerializedName("type_label") val typeLabel: String?,
#SerializedName("referral_code") val referralCode: String?,
#SerializedName("country") val country: String?,
#SerializedName("image_id") val imageId: String?,
#SerializedName("managers") val managers: List<String>?,
#SerializedName("members") val members: List<String>?,
#SerializedName("stripe") val stripe: Boolean,
#SerializedName("locations") val locations: List<String>?)
data class VendorsEntity(
#SerializedName("id") val id: String?,
#SerializedName("vendor_name") val vendorName: String?,
#SerializedName("type_label") val typeLabel: String?,
#SerializedName("user_role") val userRole: String?,
#SerializedName("latitude") val latitude: Float,
#SerializedName("longitude") val longitude: Float,
#SerializedName("partner") val partner: Boolean,
#SerializedName("country") val country: String?,
#SerializedName("image_id") val imageId: String?,
#SerializedName("stripe") val stripe: Boolean)
Data model class in the domain, Its it better to declare them all safe null types?
data class LoginResponse(
val token: String,
val user: User?,
val enterprises: List<Enterprises>,
val vendors: List<Vendors>)
data class User(
val id: String?,
val email: String?,
val firstName: String?,
val lastName: String?,
val phone: String?,
val address: String?,
val dob: String?,
val customer: String?,
val enterpriseIds: List<String>,
val vendorIds: List<String>)
data class Enterprises(
val id: String,
val enterpriseName: String,
val typeLabel: String,
val country: String,
val imageId: String,
val managers: List<String>,
val members: List<String>,
val stripe: Boolean,
val locations: List<String>)
data class Vendors(
val id: String,
val vendorName: String,
val typeLabel: String?,
val userRole: String,
val latitude: Float,
val longitude: Float,
val partner: Boolean,
val country: String?,
val imageId: String,
val stripe: Boolean)
First of all there are no safe null types in Kotlin. A variable is either nullable or not.
If the API delivers null values, either by absence or by setting them explicitely null, your data classes should reflect that in the way that those variables are nullable (question mark ? right after the data type).
The moment you map those data classes to your entities (domain model) you should handle the null case properly. Since it is a valid case, that the API serves null values, which you expect, you should handle that case by assigning a default value.
Using the elvis operator is just a way to deal with nullable types elegantely, but if you use it, remains your choice.
If you declare all the properties as nullable that's not much better than Java, even when you access them with the null safety operator. If your JSON properties have null value, that means that in your business logic they don't always have a value, and is your responsibility to handle that, by fallback to a default value (i.e. emptyList() or ""), or maybe something more complicated like redirecting to a sign in screen.