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

Create an AsciiDoc Reporter #54

Open
janschaefer opened this issue Jan 11, 2015 · 6 comments
Open

Create an AsciiDoc Reporter #54

janschaefer opened this issue Jan 11, 2015 · 6 comments

Comments

@janschaefer
Copy link
Contributor

Having a reporter that generates AsciiDoc would have several benefits:

  • The result can be transformed into many other formats like HTML or PDF
  • The resulting files could be included in an overall AsciiDoc documentation that is completely separate from JGIven and could be even maintained by non-developers.
@janschaefer janschaefer added this to the v0.7.0 milestone Jan 11, 2015
@janschaefer janschaefer changed the title Create a AsciiDoc Reporter Createn a AsciiDoc Reporter Jan 11, 2015
@janschaefer janschaefer changed the title Createn a AsciiDoc Reporter Create an AsciiDoc Reporter Jan 11, 2015
@janschaefer
Copy link
Contributor Author

@janschaefer janschaefer modified the milestones: v0.7.0, v0.7.1 Feb 10, 2015
@janschaefer janschaefer modified the milestones: v0.7.2, v0.7.1 Apr 13, 2015
@janschaefer janschaefer modified the milestones: v0.7.3, v0.7.2 May 5, 2015
@janschaefer janschaefer modified the milestones: v0.8.0, v0.7.3 Jul 2, 2015
@janschaefer janschaefer removed this from the v0.8.0 milestone Aug 2, 2015
@ahus1
Copy link
Contributor

ahus1 commented Jan 31, 2016

I see that the AsciiDocReportModelVisitor implements ReportModelHandler, while a lot of others implement ReportModelVisitor that can access more details from the report. Can you please share your thoughts on how this should work?

How would I acccess information from tags and attachments and put them into the asciidoc report?

@janschaefer
Copy link
Contributor Author

The AsciiDoc reporter is really alpha state. If you want to work on that you are free to change the implementation however you want :-)

@Airblader
Copy link
Contributor

Airblader commented Jul 9, 2016

I think the best way to go here is to first come up with an example asciidoc document to get a feeling for what generated documents should look like. That's what I'll start with, anyway. :-)

A first few tests show me, however, that we will need to deliver some theme / style file. At least for reference. For example, for formatting reasons I'd use a table for displaying a scenario, but inside the asciidoc document there's no way to turn off parity-dependent backgrounds (odd / even rows). :-( Using a plain paragraph just doesn't look all that good.

Edit: Actually I don't like tables for the scenario anymore. I think verses may be a better choice. I'll just keep working on a draft and present it when it's finished.

@janschaefer janschaefer added this to the Backlog / Unplanned milestone Mar 31, 2017
@rdmueller
Copy link

cool feature. Is there still someone working on it?
Is there somewhere a demo of a report which shows what already has been done?

@janschaefer
Copy link
Contributor Author

No, nobody is working on this. There is an early state that implements some basic features (AsciiDocReportGenerator). There is a also a rudimentary test that it works (AsciiDocReportGeneratorTest)

johthor added a commit to johthor/JGiven that referenced this issue May 24, 2023
This should provide the example as requested in TNG#54.
johthor added a commit to eCubeGmbH/JGiven that referenced this issue Jul 19, 2023
Issue: TNG#54
Signed-off-by: Johannes Thorn <2544827+johthor@users.noreply.github.com>
johthor added a commit to eCubeGmbH/JGiven that referenced this issue Jul 24, 2023
Issue: TNG#54
Signed-off-by: Johannes Thorn <2544827+johthor@users.noreply.github.com>
johthor added a commit to eCubeGmbH/JGiven that referenced this issue Dec 28, 2023
Issue: TNG#54
Signed-off-by: Johannes Thorn <2544827+johthor@users.noreply.github.com>
johthor added a commit to johthor/JGiven that referenced this issue Jan 23, 2024
These will be used prepare a hierarchical tag overview.

Issue: TNG#54
Signed-off-by: Johannes Thorn <2544827+johthor@users.noreply.github.com>
johthor added a commit to johthor/JGiven that referenced this issue Jan 23, 2024
Issue: TNG#54
Signed-off-by: Johannes Thorn <2544827+johthor@users.noreply.github.com>
johthor added a commit to johthor/JGiven that referenced this issue Jan 23, 2024
Issue: TNG#54
Signed-off-by: Johannes Thorn <2544827+johthor@users.noreply.github.com>
johthor added a commit to johthor/JGiven that referenced this issue Jan 23, 2024
Issue: TNG#54
Signed-off-by: Johannes Thorn <2544827+johthor@users.noreply.github.com>
johthor added a commit to johthor/JGiven that referenced this issue Jan 23, 2024
Issue: TNG#54
Signed-off-by: Johannes Thorn <2544827+johthor@users.noreply.github.com>
johthor added a commit to johthor/JGiven that referenced this issue Feb 28, 2024
Issue: TNG#54
Signed-off-by: Johannes Thorn <2544827+johthor@users.noreply.github.com>
johthor added a commit to johthor/JGiven that referenced this issue Feb 28, 2024
Issue: TNG#54
Signed-off-by: Johannes Thorn <2544827+johthor@users.noreply.github.com>
johthor added a commit to johthor/JGiven that referenced this issue Feb 28, 2024
Issue: TNG#54
Signed-off-by: Johannes Thorn <2544827+johthor@users.noreply.github.com>
johthor added a commit to johthor/JGiven that referenced this issue Apr 18, 2024
Issue: TNG#54
Signed-off-by: Johannes Thorn <2544827+johthor@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants