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.

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

Add option to specify modifier in the worksheet API #492

Merged
merged 1 commit into from
May 11, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 0 additions & 1 deletion cli/src/main/scala/mdoc/internal/cli/CliEnrichments.scala
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ import scala.meta.Input
import scala.meta.Position
import scala.meta.io.AbsolutePath
import scala.meta.io.RelativePath
import mdoc.internal.cli.Settings
import scala.meta.internal.io.PathIO
import scala.util.control.NonFatal
import coursierapi.Dependency
Expand Down
1 change: 1 addition & 0 deletions mdoc-interfaces/src/main/scala/mdoc/interfaces/Mdoc.java
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
public abstract class Mdoc {

public abstract EvaluatedWorksheet evaluateWorksheet(String filename, String text);
public abstract EvaluatedWorksheet evaluateWorksheet(String filename, String text, String modifier);
public abstract Mdoc withWorkingDirectory(Path workingDirectory);
public abstract Mdoc withClasspath(List<Path> classpath);
public abstract Mdoc withScalacOptions(List<String> options);
Expand Down
35 changes: 23 additions & 12 deletions mdoc/src/main/scala/mdoc/internal/worksheets/Mdoc.scala
Original file line number Diff line number Diff line change
@@ -1,20 +1,22 @@
package mdoc.internal.worksheets

import java.{util => ju}
import java.io.File
import java.io.PrintStream
import java.nio.file.Path
import mdoc.internal.pos.PositionSyntax._
import mdoc.{interfaces => i}
import coursierapi.Logger
import mdoc.MainSettings
import mdoc.internal.cli.Context
import mdoc.internal.cli.Settings
import scala.meta.internal.io.PathIO
import mdoc.internal.io.ConsoleReporter
import mdoc.internal.markdown.MarkdownCompiler
import scala.meta.inputs.Input
import mdoc.internal.markdown.Modifier
import mdoc.internal.pos.PositionSyntax._
import mdoc.internal.worksheets.Compat._
import mdoc.MainSettings
import coursierapi.Logger
import mdoc.{interfaces => i}

import java.io.File
import java.io.PrintStream
import java.nio.file.Path
import java.{util => ju}
import scala.meta.inputs.Input
import scala.meta.internal.io.PathIO

class Mdoc(settings: MainSettings) extends i.Mdoc {

Expand Down Expand Up @@ -46,10 +48,19 @@ class Mdoc(settings: MainSettings) extends i.Mdoc {
}
}

def evaluateWorksheet(filename: String, text: String): EvaluatedWorksheet =
def evaluateWorksheet(filename: String, text: String): i.EvaluatedWorksheet = {
new WorksheetProvider(settings.settings).evaluateWorksheet(
Input.VirtualFile(filename, text),
context(),
modifier = None
)
}

def evaluateWorksheet(filename: String, text: String, modifier: String): i.EvaluatedWorksheet =
new WorksheetProvider(settings.settings).evaluateWorksheet(
Input.VirtualFile(filename, text),
context()
context(),
Modifier(modifier)
)

private def context(): Context = {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,10 @@ class WorksheetProvider(settings: Settings) {

def evaluateWorksheet(
input: Input.VirtualFile,
ctx: Context
ctx: Context,
modifier: Option[Modifier]
): EvaluatedWorksheet = {
val sectionInput = SectionInput(input, ctx)
val sectionInput = SectionInput(input, modifier.getOrElse(Modifier.Default()), ctx)
val sectionInputs = List(sectionInput)
val file = InputFile.fromRelativeFilename(input.path, settings)
val instrumented = Instrumenter.instrument(file, sectionInputs, settings, reporter)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,27 @@ class WorksheetSuite extends BaseSuite {
|""".stripMargin
)

checkDiagnostics(
"value-class",
"""|object Foo {
| case class Bar(b: Int) extends AnyVal
|}""".stripMargin,
"",
modifier = Some("reset-object")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it possible to add multiple modifiers?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is! Added a test to demonstrate it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome

)

checkDecorations(
"multi-mods",
"""|object Foo {
| case class Bar(b: Int) extends AnyVal
|}
|
|Foo.Bar(1)
|""".stripMargin,
"",
modifier = Some("reset-object:compile-only")
)

checkDecorations(
"lazy",
"""
Expand Down Expand Up @@ -404,11 +425,12 @@ class WorksheetSuite extends BaseSuite {
options: TestOptions,
original: String,
expected: String,
compat: Map[String, String] = Map.empty
compat: Map[String, String] = Map.empty,
modifier: Option[String] = None
): Unit = {
test(options) {
val filename = options.name + ".scala"
val worksheet = mdoc.evaluateWorksheet(filename, original)
val worksheet = evaluateWorksheet(filename, original, modifier)
val input = Input.VirtualFile(options.name, original)
val out = new StringBuilder()
var i = 0
Expand All @@ -435,11 +457,12 @@ class WorksheetSuite extends BaseSuite {
options: TestOptions,
original: String,
expected: String,
compat: Map[String, String] = Map.empty
compat: Map[String, String] = Map.empty,
modifier: Option[String] = None
): Unit = {
test(options) {
val filename = options.name + ".scala"
val worksheet = mdoc.evaluateWorksheet(filename, original)
val worksheet = evaluateWorksheet(filename, original, modifier)
val statements = worksheet.statements().asScala.sortBy(_.position().startLine())
val input = Input.VirtualFile(options.name, original)
val out = new StringBuilder()
Expand Down Expand Up @@ -468,4 +491,13 @@ class WorksheetSuite extends BaseSuite {
assertNoDiff(obtained, Compat(expected, compat))
}
}

private def evaluateWorksheet(filename: String, original: String, modifier: Option[String]) = {
modifier match {
case Some(mod) =>
mdoc.evaluateWorksheet(filename, original, mod)
case None =>
mdoc.evaluateWorksheet(filename, original)
}
}
}