From c2f93302603de353e41c8b067a8851fb76044cd9 Mon Sep 17 00:00:00 2001 From: Will Sargent Date: Tue, 3 Dec 2024 12:41:17 -0800 Subject: [PATCH] Move paradox directory to upgraded path --- build.sbt | 16 +- src/{paradox/guide => }/designing.md | 0 .../assets/javascripts/mermaid-load.js | 0 .../javascripts/mermaid/7.1.2/mermaid.js | 0 .../javascripts/mermaid/7.1.2/mermaid.min.js | 0 .../mermaid/7.1.2/mermaid.min.js.map | 0 .../mermaid/8.0.0-rc.8/mermaid.core.js | 0 .../javascripts/mermaid/8.0.0-rc.8/mermaid.js | 0 .../mermaid/8.0.0-rc.8/mermaid.min.js | 0 .../assets/stylesheets/mermaid.custom.css | 0 .../paradox/examples/abstraction.md | 0 .../paradox/examples/amplification.md | 0 .../paradox/examples/attenuation.md | 0 .../paradox/examples/composition.md | 0 .../paradox/examples/construction/access.md | 0 .../examples/construction/composition.md | 0 .../paradox/examples/construction/effects.md | 0 .../paradox/examples/construction/index.md | 0 .../paradox/examples/construction/subtypes.md | 0 src/{ => main}/paradox/examples/delegation.md | 0 .../paradox/examples/dynamic_seal.md | 0 src/{ => main}/paradox/examples/expiration.md | 0 src/{ => main}/paradox/examples/gatekeeper.md | 0 src/{ => main}/paradox/examples/horton.md | 0 src/{ => main}/paradox/examples/index.md | 0 src/{ => main}/paradox/examples/membrane.md | 0 src/{ => main}/paradox/examples/modulation.md | 0 src/{ => main}/paradox/examples/revocation.md | 0 src/{ => main}/paradox/guide/authorization.md | 2 +- src/{ => main}/paradox/guide/confinement.md | 0 src/{ => main}/paradox/guide/construction.md | 0 src/{ => main}/paradox/guide/index.md | 0 src/{ => main}/paradox/guide/introduction.md | 0 src/{ => main}/paradox/guide/management.md | 0 src/{ => main}/paradox/index.md | 0 src/{ => main}/paradox/running.md | 0 src/main/scala/ocaps/macros.scala | 4 +- src/{paradox => }/mermaid.md | 0 src/{paradox/guide => }/notes.md | 0 src/paradox/_template/page.st | 166 ------------------ version.sbt | 2 +- 41 files changed, 12 insertions(+), 178 deletions(-) rename src/{paradox/guide => }/designing.md (100%) rename src/{ => main}/paradox/assets/javascripts/mermaid-load.js (100%) rename src/{ => main}/paradox/assets/javascripts/mermaid/7.1.2/mermaid.js (100%) rename src/{ => main}/paradox/assets/javascripts/mermaid/7.1.2/mermaid.min.js (100%) rename src/{ => main}/paradox/assets/javascripts/mermaid/7.1.2/mermaid.min.js.map (100%) rename src/{ => main}/paradox/assets/javascripts/mermaid/8.0.0-rc.8/mermaid.core.js (100%) rename src/{ => main}/paradox/assets/javascripts/mermaid/8.0.0-rc.8/mermaid.js (100%) rename src/{ => main}/paradox/assets/javascripts/mermaid/8.0.0-rc.8/mermaid.min.js (100%) rename src/{ => main}/paradox/assets/stylesheets/mermaid.custom.css (100%) rename src/{ => main}/paradox/examples/abstraction.md (100%) rename src/{ => main}/paradox/examples/amplification.md (100%) rename src/{ => main}/paradox/examples/attenuation.md (100%) rename src/{ => main}/paradox/examples/composition.md (100%) rename src/{ => main}/paradox/examples/construction/access.md (100%) rename src/{ => main}/paradox/examples/construction/composition.md (100%) rename src/{ => main}/paradox/examples/construction/effects.md (100%) rename src/{ => main}/paradox/examples/construction/index.md (100%) rename src/{ => main}/paradox/examples/construction/subtypes.md (100%) rename src/{ => main}/paradox/examples/delegation.md (100%) rename src/{ => main}/paradox/examples/dynamic_seal.md (100%) rename src/{ => main}/paradox/examples/expiration.md (100%) rename src/{ => main}/paradox/examples/gatekeeper.md (100%) rename src/{ => main}/paradox/examples/horton.md (100%) rename src/{ => main}/paradox/examples/index.md (100%) rename src/{ => main}/paradox/examples/membrane.md (100%) rename src/{ => main}/paradox/examples/modulation.md (100%) rename src/{ => main}/paradox/examples/revocation.md (100%) rename src/{ => main}/paradox/guide/authorization.md (98%) rename src/{ => main}/paradox/guide/confinement.md (100%) rename src/{ => main}/paradox/guide/construction.md (100%) rename src/{ => main}/paradox/guide/index.md (100%) rename src/{ => main}/paradox/guide/introduction.md (100%) rename src/{ => main}/paradox/guide/management.md (100%) rename src/{ => main}/paradox/index.md (100%) rename src/{ => main}/paradox/running.md (100%) rename src/{paradox => }/mermaid.md (100%) rename src/{paradox/guide => }/notes.md (100%) delete mode 100644 src/paradox/_template/page.st diff --git a/build.sbt b/build.sbt index 8d99ed8..8fdd995 100644 --- a/build.sbt +++ b/build.sbt @@ -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 @@ -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" @@ -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 := "git@github.com:tersesystems/ocaps.git", diff --git a/src/paradox/guide/designing.md b/src/designing.md similarity index 100% rename from src/paradox/guide/designing.md rename to src/designing.md diff --git a/src/paradox/assets/javascripts/mermaid-load.js b/src/main/paradox/assets/javascripts/mermaid-load.js similarity index 100% rename from src/paradox/assets/javascripts/mermaid-load.js rename to src/main/paradox/assets/javascripts/mermaid-load.js diff --git a/src/paradox/assets/javascripts/mermaid/7.1.2/mermaid.js b/src/main/paradox/assets/javascripts/mermaid/7.1.2/mermaid.js similarity index 100% rename from src/paradox/assets/javascripts/mermaid/7.1.2/mermaid.js rename to src/main/paradox/assets/javascripts/mermaid/7.1.2/mermaid.js diff --git a/src/paradox/assets/javascripts/mermaid/7.1.2/mermaid.min.js b/src/main/paradox/assets/javascripts/mermaid/7.1.2/mermaid.min.js similarity index 100% rename from src/paradox/assets/javascripts/mermaid/7.1.2/mermaid.min.js rename to src/main/paradox/assets/javascripts/mermaid/7.1.2/mermaid.min.js diff --git a/src/paradox/assets/javascripts/mermaid/7.1.2/mermaid.min.js.map b/src/main/paradox/assets/javascripts/mermaid/7.1.2/mermaid.min.js.map similarity index 100% rename from src/paradox/assets/javascripts/mermaid/7.1.2/mermaid.min.js.map rename to src/main/paradox/assets/javascripts/mermaid/7.1.2/mermaid.min.js.map diff --git a/src/paradox/assets/javascripts/mermaid/8.0.0-rc.8/mermaid.core.js b/src/main/paradox/assets/javascripts/mermaid/8.0.0-rc.8/mermaid.core.js similarity index 100% rename from src/paradox/assets/javascripts/mermaid/8.0.0-rc.8/mermaid.core.js rename to src/main/paradox/assets/javascripts/mermaid/8.0.0-rc.8/mermaid.core.js diff --git a/src/paradox/assets/javascripts/mermaid/8.0.0-rc.8/mermaid.js b/src/main/paradox/assets/javascripts/mermaid/8.0.0-rc.8/mermaid.js similarity index 100% rename from src/paradox/assets/javascripts/mermaid/8.0.0-rc.8/mermaid.js rename to src/main/paradox/assets/javascripts/mermaid/8.0.0-rc.8/mermaid.js diff --git a/src/paradox/assets/javascripts/mermaid/8.0.0-rc.8/mermaid.min.js b/src/main/paradox/assets/javascripts/mermaid/8.0.0-rc.8/mermaid.min.js similarity index 100% rename from src/paradox/assets/javascripts/mermaid/8.0.0-rc.8/mermaid.min.js rename to src/main/paradox/assets/javascripts/mermaid/8.0.0-rc.8/mermaid.min.js diff --git a/src/paradox/assets/stylesheets/mermaid.custom.css b/src/main/paradox/assets/stylesheets/mermaid.custom.css similarity index 100% rename from src/paradox/assets/stylesheets/mermaid.custom.css rename to src/main/paradox/assets/stylesheets/mermaid.custom.css diff --git a/src/paradox/examples/abstraction.md b/src/main/paradox/examples/abstraction.md similarity index 100% rename from src/paradox/examples/abstraction.md rename to src/main/paradox/examples/abstraction.md diff --git a/src/paradox/examples/amplification.md b/src/main/paradox/examples/amplification.md similarity index 100% rename from src/paradox/examples/amplification.md rename to src/main/paradox/examples/amplification.md diff --git a/src/paradox/examples/attenuation.md b/src/main/paradox/examples/attenuation.md similarity index 100% rename from src/paradox/examples/attenuation.md rename to src/main/paradox/examples/attenuation.md diff --git a/src/paradox/examples/composition.md b/src/main/paradox/examples/composition.md similarity index 100% rename from src/paradox/examples/composition.md rename to src/main/paradox/examples/composition.md diff --git a/src/paradox/examples/construction/access.md b/src/main/paradox/examples/construction/access.md similarity index 100% rename from src/paradox/examples/construction/access.md rename to src/main/paradox/examples/construction/access.md diff --git a/src/paradox/examples/construction/composition.md b/src/main/paradox/examples/construction/composition.md similarity index 100% rename from src/paradox/examples/construction/composition.md rename to src/main/paradox/examples/construction/composition.md diff --git a/src/paradox/examples/construction/effects.md b/src/main/paradox/examples/construction/effects.md similarity index 100% rename from src/paradox/examples/construction/effects.md rename to src/main/paradox/examples/construction/effects.md diff --git a/src/paradox/examples/construction/index.md b/src/main/paradox/examples/construction/index.md similarity index 100% rename from src/paradox/examples/construction/index.md rename to src/main/paradox/examples/construction/index.md diff --git a/src/paradox/examples/construction/subtypes.md b/src/main/paradox/examples/construction/subtypes.md similarity index 100% rename from src/paradox/examples/construction/subtypes.md rename to src/main/paradox/examples/construction/subtypes.md diff --git a/src/paradox/examples/delegation.md b/src/main/paradox/examples/delegation.md similarity index 100% rename from src/paradox/examples/delegation.md rename to src/main/paradox/examples/delegation.md diff --git a/src/paradox/examples/dynamic_seal.md b/src/main/paradox/examples/dynamic_seal.md similarity index 100% rename from src/paradox/examples/dynamic_seal.md rename to src/main/paradox/examples/dynamic_seal.md diff --git a/src/paradox/examples/expiration.md b/src/main/paradox/examples/expiration.md similarity index 100% rename from src/paradox/examples/expiration.md rename to src/main/paradox/examples/expiration.md diff --git a/src/paradox/examples/gatekeeper.md b/src/main/paradox/examples/gatekeeper.md similarity index 100% rename from src/paradox/examples/gatekeeper.md rename to src/main/paradox/examples/gatekeeper.md diff --git a/src/paradox/examples/horton.md b/src/main/paradox/examples/horton.md similarity index 100% rename from src/paradox/examples/horton.md rename to src/main/paradox/examples/horton.md diff --git a/src/paradox/examples/index.md b/src/main/paradox/examples/index.md similarity index 100% rename from src/paradox/examples/index.md rename to src/main/paradox/examples/index.md diff --git a/src/paradox/examples/membrane.md b/src/main/paradox/examples/membrane.md similarity index 100% rename from src/paradox/examples/membrane.md rename to src/main/paradox/examples/membrane.md diff --git a/src/paradox/examples/modulation.md b/src/main/paradox/examples/modulation.md similarity index 100% rename from src/paradox/examples/modulation.md rename to src/main/paradox/examples/modulation.md diff --git a/src/paradox/examples/revocation.md b/src/main/paradox/examples/revocation.md similarity index 100% rename from src/paradox/examples/revocation.md rename to src/main/paradox/examples/revocation.md diff --git a/src/paradox/guide/authorization.md b/src/main/paradox/guide/authorization.md similarity index 98% rename from src/paradox/guide/authorization.md rename to src/main/paradox/guide/authorization.md index 2b2da9a..0674927 100644 --- a/src/paradox/guide/authorization.md +++ b/src/main/paradox/guide/authorization.md @@ -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: diff --git a/src/paradox/guide/confinement.md b/src/main/paradox/guide/confinement.md similarity index 100% rename from src/paradox/guide/confinement.md rename to src/main/paradox/guide/confinement.md diff --git a/src/paradox/guide/construction.md b/src/main/paradox/guide/construction.md similarity index 100% rename from src/paradox/guide/construction.md rename to src/main/paradox/guide/construction.md diff --git a/src/paradox/guide/index.md b/src/main/paradox/guide/index.md similarity index 100% rename from src/paradox/guide/index.md rename to src/main/paradox/guide/index.md diff --git a/src/paradox/guide/introduction.md b/src/main/paradox/guide/introduction.md similarity index 100% rename from src/paradox/guide/introduction.md rename to src/main/paradox/guide/introduction.md diff --git a/src/paradox/guide/management.md b/src/main/paradox/guide/management.md similarity index 100% rename from src/paradox/guide/management.md rename to src/main/paradox/guide/management.md diff --git a/src/paradox/index.md b/src/main/paradox/index.md similarity index 100% rename from src/paradox/index.md rename to src/main/paradox/index.md diff --git a/src/paradox/running.md b/src/main/paradox/running.md similarity index 100% rename from src/paradox/running.md rename to src/main/paradox/running.md diff --git a/src/main/scala/ocaps/macros.scala b/src/main/scala/ocaps/macros.scala index cd80917..6381a4c 100644 --- a/src/main/scala/ocaps/macros.scala +++ b/src/main/scala/ocaps/macros.scala @@ -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] diff --git a/src/paradox/mermaid.md b/src/mermaid.md similarity index 100% rename from src/paradox/mermaid.md rename to src/mermaid.md diff --git a/src/paradox/guide/notes.md b/src/notes.md similarity index 100% rename from src/paradox/guide/notes.md rename to src/notes.md diff --git a/src/paradox/_template/page.st b/src/paradox/_template/page.st deleted file mode 100644 index b460b0b..0000000 --- a/src/paradox/_template/page.st +++ /dev/null @@ -1,166 +0,0 @@ -$! - Copyright (c) 2016-2017 Martin Donath - Copyright (c) 2017 Jonas Fonseca - - Permission is hereby granted, free of charge, to any person obtaining a copy - of this software and associated documentation files (the "Software"), to - deal in the Software without restriction, including without limitation the - rights to use, copy, modify, merge, publish, distribute, sublicense, and/or - sell copies of the Software, and to permit persons to whom the Software is - furnished to do so, subject to the following conditions: - - The above copyright notice and this permission notice shall be included in - all copies or substantial portions of the Software. - - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE - AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING - FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS - IN THE SOFTWARE. -!$ - - - - - - - - - - $partials/language()$ - - $ if (page.properties.("description")) $ - - $ elseif (page.properties.("project.description")) $ - - $ endif $ - $ if (page.properties.("material.canonical.url")) $ - - $ endif $ - $ if (page.properties.("author")) $ - - $ elseif (page.properties.("material.author")) $ - - $ endif $ - - $ if (page.properties.("title")) $ - $page.properties.("title")$ - $ elseif (page.title) $ - $page.title$$ if (!page.home.active) $ · $page.home.title$$ endif $ - $ else $ - $page.home.title$ - $ endif $ - - - $ if (page.properties.("material.color.primary")) $ - - $ endif $ - - - - - $ if (page.properties.("material.font.text")) $ - - - - - $ endif $ - - $ if (page.properties.("material.custom.stylesheet")) $ - - $ endif $ - - - - - - $partials/header()$ -
- $ if (page.properties.("material.hero")) $ - $partials/hero()$ - $ endif $ -
-
-
-
-
- $partials/nav()$ -
-
-
- $ if (page.subheaders) $ -
-
-
- $partials/toc()$ -
-
-
- $ endif $ -
-
-
- $page.content$ -
- $ if (page.source_url) $ - - $ endif $ -
- - $page.properties.("project.version.short")$ - -
-
-
-
-
- $partials/footer()$ -
- - - $! - - The ending "." enables search to work without providing the site URL, since the - theme JavaScript fetches the index by concatenating the base URL to an absolute - path: "/search/search_index.json". - - It originally was "./" but this breaks previewSite because it leads to a double - slash when fetching the index, i.e. ".//search/...". To complete the workaround - all locations in the search index now start with a "/" so the JavaScript can - safely do: `url.base + doc.location`. - - !$ - - - - - - - $ if (page.properties.("material.custom.javascript")) $ - - $ endif $ - $ if (page.properties.("material.google.analytics")) $ - $partials/integrations/analytics()$ - $ endif $ - - \ No newline at end of file diff --git a/version.sbt b/version.sbt index cfeb331..a5f65fc 100644 --- a/version.sbt +++ b/version.sbt @@ -1 +1 @@ -version in ThisBuild := "0.2.1-SNAPSHOT" +ThisBuild / version := "1.0.0-SNAPSHOT"