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.

Sign up for GitHub

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

Don't add canEqual and equals if users already defined them #212

Merged
merged 3 commits into from
Jan 20, 2025
Merged

Don't add canEqual and equals if users already defined them #212

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e4384f3
NIT refactoring
alexarchambault Jan 16, 2025
54a87d8
NIT Refactoring
alexarchambault Jan 16, 2025
5fae974
Don't add canEqual and equals if users already defined them
alexarchambault Jan 17, 2025
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
118 changes: 50 additions & 68 deletions src/main/scala/dataclass/Macros.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,65 +33,38 @@ private[dataclass] class Macros(val c: Context) extends ImplTransformers {
tq"${t.name}"
}

val hasToString = {
def hasMethod(
methodName: String,
hasArgs: Boolean = false
): Boolean = {
def fromStats =
stats.exists {
case DefDef(_, nme, tparams, vparamss, _, _)
if nme.decodedName.toString == "toString" && tparams.isEmpty && vparamss
.forall(_.isEmpty) =>
if nme.decodedName.toString == methodName &&
tparams.isEmpty &&
(
hasArgs && vparamss.map(_.length).sum == 1 ||
vparamss.forall(_.isEmpty)
) =>
true
case t @ ValDef(_, name, _, _)
if name.decodedName.toString == "toString" =>
if !hasArgs && name.decodedName.toString == methodName =>
true
case _ =>
false
}

val fromFields =
allParams.exists(_.name.decodedName.toString() == "toString")
val fromFields = !hasArgs &&
allParams.exists(_.name.decodedName.toString() == methodName)

fromFields || fromStats
}

val hasHashCode = {
def fromStats =
stats.exists {
case DefDef(_, nme, tparams, vparamss, _, _)
if nme.decodedName.toString == "hashCode" && tparams.isEmpty && vparamss
.forall(_.isEmpty) =>
true
case t @ ValDef(_, name, _, _)
if name.decodedName.toString == "hashCode" =>
true
case _ =>
false
}

val fromFields =
allParams.exists(_.name.decodedName.toString() == "hashCode")

fromFields || fromStats
}

val hasTuple = {
def fromStats =
stats.exists {
case DefDef(_, nme, tparams, vparamss, _, _)
if nme.decodedName.toString == "tuple" && tparams.isEmpty && vparamss
.forall(_.isEmpty) =>
true
case t @ ValDef(_, name, _, _)
if name.decodedName.toString == "tuple" =>
true
case _ =>
false
}

val fromFields =
allParams.exists(_.name.decodedName.toString() == "tuple")

fromFields || fromStats
}
val hasToString = hasMethod("toString")
val hasHashCode = hasMethod("hashCode")
val hasTuple = hasMethod("tuple")
val hasCanEqual = hasMethod("canEqual", hasArgs = true)
val hasEquals = hasMethod("equals", hasArgs = true)

val namedArgs = paramss.map(_.map { p =>
q"${p.name}=this.${p.name}"
Expand Down Expand Up @@ -158,29 +131,37 @@ private[dataclass] class Macros(val c: Context) extends ImplTransformers {
tq"({type L[..$tparams0]=$WildcardType})#L"
}

val equalMethods = {
val fldChecks = paramss.flatten
.map { param =>
q"this.${param.name} == other.${param.name}"
}
.foldLeft[Tree](q"true")((a, b) => q"$a && $b")
val canEqualMethod =
if (hasCanEqual) Nil
else {
val hashCheck =
if (cachedHashCode) q"obj.hashCode == hashCode" else q"true"
Seq(
q"""
override def canEqual(obj: Any): _root_.scala.Boolean =
obj != null && obj.isInstanceOf[$tpname[..$wildcardedTparams]] && $hashCheck
"""
)
}

val hashCheck =
if (cachedHashCode) q"obj.hashCode == hashCode" else q"true"
Seq(
q"""
override def canEqual(obj: Any): _root_.scala.Boolean =
obj != null && obj.isInstanceOf[$tpname[..$wildcardedTparams]] && $hashCheck
""",
q"""
override def equals(obj: Any): _root_.scala.Boolean =
this.eq(obj.asInstanceOf[AnyRef]) || canEqual(obj) && {
val other = obj.asInstanceOf[$tpname[..$wildcardedTparams]]
$fldChecks
}
"""
)
}
val equalsMethod =
if (hasEquals) Nil
else {
val fldChecks = paramss.flatten
.map { param =>
q"this.${param.name} == other.${param.name}"
}
.foldLeft[Tree](q"true")((a, b) => q"$a && $b")
Seq(
q"""
override def equals(obj: Any): _root_.scala.Boolean =
this.eq(obj.asInstanceOf[AnyRef]) || canEqual(obj) && {
val other = obj.asInstanceOf[$tpname[..$wildcardedTparams]]
$fldChecks
}
"""
)
}

val hashCodeMethod =
if (hasHashCode) Nil
Expand Down Expand Up @@ -420,7 +401,8 @@ private[dataclass] class Macros(val c: Context) extends ImplTransformers {
..$stats
..$setters
..$toStringMethod
..$equalMethods
..$canEqualMethod
..$equalsMethod
..$hashCodeMethod
..$tupleMethod
..$productMethods
Expand Down
73 changes: 73 additions & 0 deletions src/test/scala/dataclass/MoreFieldsTests.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,6 +259,79 @@ object MoreFieldsTests extends TestSuite {
}
}

"has equals" - {
"def" - {
@data class Foo(password: String) {
override def equals(obj: Any): Boolean =
obj.isInstanceOf[Foo] && (
password == obj.asInstanceOf[Foo].password ||
obj.asInstanceOf[Foo].password == "special"
)
}

val foo = Foo("aa")
val other = Foo("bb")
val specialFoo = Foo("special")
val equalsCopy = foo == foo.withPassword("aa")
assert(equalsCopy)
val equalsOther = foo == other
assert(!equalsOther)
val equalsSpecial = foo == specialFoo
assert(equalsSpecial)
}

"two-arg" - {
@data class Foo(password: String) {
def equals(obj: Any, thing: Any): Boolean =
true
}

val foo = Foo("aa")
val other = Foo("bb")
val specialFoo = Foo("special")
val equalsCopy = foo == foo.withPassword("aa")
assert(equalsCopy)
val equalsOther = foo == other
assert(!equalsOther)
val equalsSpecial = foo == specialFoo
assert(!equalsSpecial)
}
}

"has canEqual" - {
"def" - {
@data class Foo(password: String) {
override def canEqual(obj: Any): Boolean =
obj.isInstanceOf[Foo] || obj.toString == "Foo"
}

val foo = Foo("aa")
val other = Foo("bb")
val canEqualOther = foo.canEqual(other)
assert(canEqualOther)
val canEqualRandomString = foo.canEqual("thing")
assert(!canEqualRandomString)
val canEqualSpecialString = foo.canEqual("Foo")
assert(canEqualSpecialString)
}

"two-arg" - {
@data class Foo(password: String) {
def canEqual(obj: Any, thing: Any): Boolean =
obj.isInstanceOf[Foo] || obj.toString == "Foo"
}

val foo = Foo("aa")
val other = Foo("bb")
val canEqualOther = foo.canEqual(other)
assert(canEqualOther)
val canEqualRandomString = foo.canEqual("thing")
assert(!canEqualRandomString)
val canEqualSpecialString = foo.canEqual("Foo")
assert(!canEqualSpecialString)
}
}

"override val with default" - {
class Repository {
def versionsCheckHasModule: Boolean = false
Expand Down
Loading