-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactoring to support parsing choices safely
- Sayable.Group, to preserve a grouping - Make Choice an ADT, and move it to top level - Move assigning logic into ChoiceMenu and move it to top level - Factor out choiceMenuSayable - Tested ParseChoices
- Loading branch information
Showing
11 changed files
with
173 additions
and
112 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
package simpleivr | ||
|
||
sealed trait Choice[+A] { | ||
def maybeDtmf: Option[DTMF] | ||
def label: Sayable | ||
def value: A | ||
def map[B](f: A => B): Choice[B] | ||
} | ||
|
||
object Choice { | ||
case class Unassigned[+A](label: Sayable, value: A) extends Choice[A] { | ||
override def maybeDtmf = None | ||
override def map[B](f: A => B) = copy(value = f(value)) | ||
} | ||
case class Assigned[+A](dtmf: DTMF, label: Sayable, value: A) extends Choice[A] { | ||
override def maybeDtmf = Some(dtmf) | ||
override def map[B](f: A => B) = copy(value = f(value)) | ||
} | ||
def apply[A](label: Sayable, value: A): Choice[A] = Unassigned(label, value) | ||
def apply[A](dtmf: DTMF, label: Sayable, value: A): Choice[A] = Assigned(dtmf, label, value) | ||
|
||
def unapply[A](choice: Choice[A]) = Some((choice.maybeDtmf, choice.label, choice.value)) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
package simpleivr | ||
|
||
case class ChoiceMenu[A](title: Sayable, choices: Seq[Choice[A]]) { | ||
private def assignNums(choices: List[Choice[A]], nums: List[DTMF]): List[Choice.Assigned[A]] = choices match { | ||
case Nil => Nil | ||
case (c @ Choice.Assigned(dtmf, _, _)) :: rest => c :: assignNums(rest, nums.filter(_ != dtmf)) | ||
case Choice.Unassigned(label, value) :: rest => | ||
if (nums.nonEmpty) | ||
Choice.Assigned(nums.head, label, value) :: assignNums(rest, nums.tail) | ||
else { | ||
println("ERROR: No num available for choices: " + choices) | ||
assignNums(rest, nums) | ||
} | ||
} | ||
|
||
lazy val assigned = | ||
assignNums(choices.toList, DTMF.digits.toList.filterNot(n => choices exists (_.maybeDtmf contains n))) | ||
} | ||
|
||
object ChoiceMenu { | ||
def apply[A](title: Sayable, dummy: Null = null)(choices: Choice[A]*): ChoiceMenu[A] = | ||
new ChoiceMenu(title, choices) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
package simpleivr | ||
|
||
import org.scalatest.{FunSuite, Matchers} | ||
|
||
|
||
class ChoiceMenuTests extends FunSuite with Matchers { | ||
test("assigned") { | ||
def defined(key: DTMF) = Choice(key, Sayable.Empty, ()) | ||
|
||
def auto = Choice(Sayable.Empty, ()) | ||
|
||
val choices = List(defined(DTMF.`1`), auto, defined(DTMF.`2`), auto, auto, auto, auto, auto, auto, auto) | ||
|
||
val choiceMenu = ChoiceMenu(Sayable.Empty, choices) | ||
|
||
val actual = choiceMenu.assigned.map(_.dtmf) | ||
|
||
val expected = | ||
List(DTMF.`1`, DTMF.`3`, DTMF.`2`, DTMF.`4`, DTMF.`5`, DTMF.`6`, DTMF.`7`, DTMF.`8`, DTMF.`9`, DTMF.`0`) | ||
|
||
actual shouldBe expected | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
33 changes: 33 additions & 0 deletions
33
testing/src/main/scala/simpleivr/testing/ParseChoices.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
package simpleivr.testing | ||
|
||
import simpleivr.Sayable.{Group, Many, Single} | ||
import simpleivr.{DTMF, Pause, Sayable} | ||
|
||
|
||
trait ParseChoices { | ||
private object digit { | ||
def unapply(sayable: Sayable): Option[DTMF] = sayable match { | ||
case Sayable("one") => Some(DTMF.`1`) | ||
case Sayable("two") => Some(DTMF.`2`) | ||
case Sayable("three") => Some(DTMF.`3`) | ||
case Sayable("four") => Some(DTMF.`4`) | ||
case Sayable("five") => Some(DTMF.`5`) | ||
case Sayable("six") => Some(DTMF.`6`) | ||
case Sayable("seven") => Some(DTMF.`7`) | ||
case Sayable("eight") => Some(DTMF.`8`) | ||
case Sayable("nine") => Some(DTMF.`9`) | ||
case Sayable("zero") => Some(DTMF.`0`) | ||
case Sayable("pound") => Some(DTMF.`#`) | ||
case Sayable("star") => Some(DTMF.*) | ||
} | ||
} | ||
|
||
def parseChoices(sayable: Sayable): List[(DTMF, Sayable)] = | ||
sayable match { | ||
case s: Single => Nil | ||
case Many(Pause(_) +: Sayable("Press") +: digit(d) +: label) => List(d -> Sayable(label)) | ||
case Many(Pause(_) +: label :+ Sayable("Press") :+ digit(d)) => List(d -> Sayable(label)) | ||
case Many(sayables) => sayables.flatMap(parseChoices).toList | ||
case Group(s) => parseChoices(s) | ||
} | ||
} |
33 changes: 33 additions & 0 deletions
33
testing/src/test/scala/simpleivr/testing/ParseChoiceTests.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
package simpleivr.testing | ||
|
||
import org.scalatest.FunSuite | ||
import simpleivr._ | ||
|
||
|
||
class ParseChoiceTests extends FunSuite with ParseChoices { | ||
test("parseChoices") { | ||
object S extends DummySayables { | ||
val `do one thing`, `do something else` = speak | ||
} | ||
|
||
val ivrChoices = new IvrChoices(S) | ||
import ivrChoices._ | ||
|
||
val choices = | ||
List( | ||
Choice.Assigned(DTMF.`1`, S.`do one thing`, ()), | ||
Choice.Assigned(DTMF.`2`, S.`do something else`, ()) | ||
) | ||
|
||
val choiceMenu = ChoiceMenu(Sayable.Empty, choices) | ||
val pauseMs = 750 | ||
val labelFirstParsed = parseChoices(choiceMenuSayable(choiceMenu, pauseMs, SayChoice.LabelFirst)) | ||
println(">>") | ||
val labelLastParsed = parseChoices(choiceMenuSayable(choiceMenu, pauseMs, SayChoice.LabelLast)) | ||
println("<<") | ||
|
||
assert(labelFirstParsed == labelLastParsed) | ||
|
||
assert(labelFirstParsed == choices.map(c => c.dtmf -> c.label)) | ||
} | ||
} |