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

Enhance RIDDL Documentation Diagrams #463

Merged
merged 22 commits into from
Dec 16, 2023
Merged

Enhance RIDDL Documentation Diagrams #463

merged 22 commits into from
Dec 16, 2023

Conversation

reid-spencer
Copy link
Contributor

This PR supports:

  • A Diagrams Pass to pre-compute diagram content
  • Various Diagram types to be used by Hugo pass

reid-spencer and others added 13 commits October 13, 2023 15:08
Signed-off-by: reidspencer <reid.spencer@yoppworks.com>
Signed-off-by: reidspencer <reid.spencer@yoppworks.com>
Signed-off-by: reidspencer <reid.spencer@yoppworks.com>
Signed-off-by: reidspencer <reid.spencer@yoppworks.com>
* Add it to Hugo list of passes to run
* Set it up for at least 3 kinds of needed diagrams
* Just a shell for implementation at this point

Signed-off-by: reidspencer <reid.spencer@yoppworks.com>
Signed-off-by: reidspencer <reid.spencer@yoppworks.com>
Signed-off-by: reidspencer <reid.spencer@yoppworks.com>
Signed-off-by: reidspencer <reid.spencer@yoppworks.com>
* Writing Files is put out as a stage
* Individual file writing times are emitted if verbose or debug
* Writing timing for each of the top level indices
* Place the messages summary in the Types section

Signed-off-by: reidspencer <reid.spencer@yoppworks.com>
* Consolidate name and link in one column
* Fix the RunRiddlcOnArbitraryTest test case
@reid-spencer reid-spencer linked an issue Oct 27, 2023 that may be closed by this pull request
@reid-spencer reid-spencer self-assigned this Oct 27, 2023
@reid-spencer reid-spencer added the enhancement New feature or request label Oct 27, 2023
@reid-spencer reid-spencer added this to the 1.0 - First Full Release milestone Oct 27, 2023
@reid-spencer reid-spencer changed the title Add Diagram Construction & Usage Enhance RIDDL Documentation Diagrams Oct 27, 2023
reid-spencer and others added 8 commits October 27, 2023 17:21
Signed-off-by: reidspencer <reid.spencer@yoppworks.com>
# Conflicts:
#	diagrams/src/test/scala/com/reactific/riddl/diagrams/mermaid/UseCaseDiagramTest.scala
#	hugo/src/main/scala/com/reactific/riddl/hugo/HugoPass.scala
* Fix UseCaseDiagramSupport name
* API changes

Signed-off-by: reidspencer <reid.spencer@yoppworks.com>
Signed-off-by: reidspencer <reid.spencer@yoppworks.com>
Signed-off-by: reidspencer <reid.spencer@yoppworks.com>
Copy link

github-actions bot commented Dec 16, 2023

Pull Request Test Coverage Report for Build 7233654219

  • 127 of 259 (49.03%) changed or added relevant lines in 18 files are covered.
  • 133 unchanged lines in 46 files lost coverage.
  • Overall coverage decreased (-0.6%) to 59.746%

Changes Missing Coverage Covered Lines Changed/Added Lines %
diagrams/src/main/scala/com/ossuminc/riddl/diagrams/mermaid/UseCaseDiagramSupport.scala 1 2 50.0%
hugo/src/main/scala/com/ossuminc/riddl/hugo/MessagesPass.scala 6 7 85.71%
language/src/main/scala/com/ossuminc/riddl/language/parsing/StreamingParser.scala 0 1 0.0%
hugo/src/main/scala/com/ossuminc/riddl/hugo/HugoCommand.scala 1 3 33.33%
language/src/main/scala/com/ossuminc/riddl/language/parsing/RiddlOptions.scala 0 2 0.0%
passes/src/main/scala/com/ossuminc/riddl/passes/resolve/ReferenceMap.scala 0 2 0.0%
passes/src/main/scala/com/ossuminc/riddl/passes/validate/ValidationPass.scala 8 10 80.0%
hugo/src/main/scala/com/ossuminc/riddl/hugo/ToDoListPass.scala 14 17 82.35%
hugo/src/main/scala/com/ossuminc/riddl/hugo/MarkdownWriter.scala 15 19 78.95%
diagrams/src/main/scala/com/ossuminc/riddl/diagrams/mermaid/UseCaseDiagram.scala 7 18 38.89%
Files with Coverage Reduction New Missed Lines %
commands/src/main/scala/com/ossuminc/riddl/commands/OnChangeCommand.scala 1 27.18%
commands/src/main/scala/com/ossuminc/riddl/commands/PassCommand.scala 1 65.63%
diagrams/src/main/scala/com/ossuminc/riddl/diagrams/mermaid/EntityRelationshipDiagram.scala 1 6.67%
language/src/main/scala/com/ossuminc/riddl/language/AST.scala 1 59.46%
language/src/main/scala/com/ossuminc/riddl/language/parsing/EntityParser.scala 1 77.78%
language/src/main/scala/com/ossuminc/riddl/language/parsing/FunctionParser.scala 1 67.86%
language/src/main/scala/com/ossuminc/riddl/language/parsing/NoWhiteSpaceParsers.scala 1 55.56%
language/src/main/scala/com/ossuminc/riddl/language/parsing/ProjectorParser.scala 1 75.0%
language/src/main/scala/com/ossuminc/riddl/language/parsing/Readability.scala 1 77.27%
language/src/main/scala/com/ossuminc/riddl/language/parsing/RiddlOptions.scala 1 15.63%
Totals Coverage Status
Change from base Build 7233650214: -0.6%
Covered Lines: 4567
Relevant Lines: 7644

💛 - Coveralls

Signed-off-by: Reid Spencer <reid-spencer@users.noreply.github.com>
@reid-spencer reid-spencer merged commit cdedb96 into main Dec 16, 2023
1 check passed
@reid-spencer reid-spencer deleted the add-stream-diagram branch December 16, 2023 18:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Enhance RIDDL Documentation Output
1 participant