Skip to content

Should the Record unapply method always return Some? #55

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

Open
marcgrr wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Should the Record unapply method always return Some? #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 14 additions & 0 deletions scala/generator-test/src/test/scala/org/coursera/courier/generator/RecordGeneratorTest.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ import org.coursera.records.test.Empty
import org.coursera.records.test.Empty2
import org.coursera.records.test.InlineOptionalRecord
import org.coursera.records.test.InlineRecord
import org.coursera.records.test.Message
import org.coursera.records.test.Simple
import org.coursera.records.test.SimpleMap
import org.coursera.records.test.WithComplexTypeDefaults
Expand Down Expand Up @@ -470,4 +471,17 @@ class RecordGeneratorTest extends GeneratorTest with SchemaFixtures {
// Fortunately, nothing should depend solely on hashCode() for determining whether two
// records match.
}

@Test
def testUnapplyReturnsSomeType(): Unit = {
// If the unapply method returns Option[X] instead of Some[X], then the scala compiler turns
// off match exhaustivity checking for match statements that use the unapply method. This test
// This test asserts that the unapply method returns Some[X], so that we get better
// exhaustivity checking for match statements involving courier records.
assertCompiles("""
val record = Message("hello", "hello world")
Message.unapply(record): Some[(String, String)]
""")
}

}
9 changes: 2 additions & 7 deletions scala/generator/src/main/twirl/org/coursera/courier/templates/RecordClass.scala.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,13 +203,8 @@ object @(record.scalaType) extends RecordCompanion[@(record.scalaType)] {
def unapply(record: @(record.scalaType)): Boolean = true
}
case i if i <= 22 => { @* Scala tuples only exist up to Tuple22. *@
def unapply(record: @(record.scalaType)): Option[(@(record.fieldsAsTypeParams))] = {
try {
Some((@(record.prefixedFieldParams("record."))))
} catch {
case cast: TemplateOutputCastException => None
case notPresent: RequiredFieldNotPresentException => None
}
def unapply(record: @(record.scalaType)): Some[(@(record.fieldsAsTypeParams))] = {
Some((@(record.prefixedFieldParams("record."))))
}
}
case _ => {
Expand Down