Skip to content

Commit

Permalink
Move paradox directory to upgraded path
Browse files Browse the repository at this point in the history
  • Loading branch information
wsargent committed Dec 3, 2024
1 parent 18753ae commit c2f9330
Show file tree
Hide file tree
Showing 41 changed files with 12 additions and 178 deletions.
16 changes: 8 additions & 8 deletions build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ val catsEffectVersion = "3.5.7"
lazy val root = (project in file("."))
.enablePlugins(ParadoxPlugin) // https://developer.lightbend.com/docs/paradox/current/index.html
.enablePlugins(ParadoxSitePlugin) // https://www.scala-sbt.org/sbt-site/generators/paradox.html
.enablePlugins(SitePreviewPlugin) // https://www.scala-sbt.org/sbt-site/generators/paradox.html
.enablePlugins(SiteScaladocPlugin) // https://www.scala-sbt.org/sbt-site/api-documentation.html#scaladoc
.enablePlugins(ScalaUnidocPlugin) // https://github.com/sbt/sbt-unidoc#how-to-unify-scaladoc
.enablePlugins(GhpagesPlugin) // https://github.com/sbt/sbt-ghpages
Expand All @@ -20,7 +21,7 @@ lazy val root = (project in file("."))
"-doc-version", version.value,
"-doc-footer", "",
"-sourcepath", (sourceDirectory in Compile).value.getPath, // needed for scaladoc to strip the location of the linked source path
"-doc-source-url", s"https://github.com/wsargent/ocaps/blob/${version.value}/ocaps/src/main€{FILE_PATH}.scala",
"-doc-source-url", s"https://github.com/tersesystems/ocaps/blob/${version.value}/ocaps/src/main€{FILE_PATH}.scala",
"-implicits",
"-diagrams", // requires graphviz
"-groups"
Expand All @@ -38,20 +39,19 @@ lazy val root = (project in file("."))
// siteSourceDirectory := target.value / "generated-stuff",

// paradox settings
paradoxProperties in Paradox ++= Map(
paradoxProperties ++= Map(
"version" -> stableVersion.value,
"snip.examples.base_dir" -> s"${(sourceDirectory in Test).value}/scala/ocaps/examples",
),
paradoxDirectives += MermaidDirective,
// https://github.com/lightbend/paradox/issues/139
sourceDirectory in Paradox in paradoxTheme := sourceDirectory.value / "paradox" / "_template",
paradoxTheme := Some(builtinParadoxTheme("generic")),
paradoxRoots := List("index.html"),


libraryDependencies += "org.slf4j" % "slf4j-api" % "1.7.25" % Test,
libraryDependencies += "org.slf4j" % "slf4j-api" % "2.0.16" % Test,
// https://mvnrepository.com/artifact/ch.qos.logback/logback-classic
libraryDependencies += "ch.qos.logback" % "logback-classic" % "1.2.3" % Test,
libraryDependencies += "ch.qos.logback" % "logback-classic" % "1.5.12" % Test,
libraryDependencies += "org.scalatest" %% "scalatest" % "3.2.19" % Test,
libraryDependencies += "org.typelevel" %% "cats-core" % catsVersion % "tut, test",
libraryDependencies += "org.typelevel" %% "cats-core" % catsVersion % Test,

git.remoteRepo := "[email protected]:tersesystems/ocaps.git",

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ val writer: Writer = ocaps.macros.attenuate[Writer](capabilities)
val caller = new Caller(reader, writer)
```

You can see a complete @ref:[attenuation example](../examples/attenuation.md) for more details. Also see the [gatekeeper example](../examples/gatekeeper.md).
You can see a complete @ref:[attenuation example](../examples/attenuation.md) for more details. Also see the @ref:[gatekeeper example](../examples/gatekeeper.md).

Composition is not the only way of arranging capabilities, of course. Joe Duffy has a great [post](http://joeduffyblog.com/2015/11/10/objects-as-secure-capabilities/) where he discusses the practical aspects of capabilities:

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions src/main/scala/ocaps/macros.scala
Original file line number Diff line number Diff line change
Expand Up @@ -63,12 +63,12 @@ object macros {
* object.
*
* @param target
* the object to forward to. Must have methods matching the name and type of [[T]]'s abstract
* the object to forward to. Must have methods matching the name and type of T's abstract
* methods.
* @tparam T
* the type of the trait or abstract class to implement
* @return
* an instance of [[T]] with all abstract methods implemented by forwarding to `target`.
* an instance of T with all abstract methods implemented by forwarding to `target`.
*/
def forward[T](target: Any): T = macro impl.forward[T]

Expand Down
File renamed without changes.
File renamed without changes.
166 changes: 0 additions & 166 deletions src/paradox/_template/page.st

This file was deleted.

2 changes: 1 addition & 1 deletion version.sbt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
version in ThisBuild := "0.2.1-SNAPSHOT"
ThisBuild / version := "1.0.0-SNAPSHOT"

0 comments on commit c2f9330

Please sign in to comment.