Redesign (#1)

[ilslv]

Part of #1

Synopsis

Provide new Parser, Runner and Writer abstractions and tools to leverage them.

Solution

• Parser trait
  • parser::Basic impl
• Runner trait
  • runner::Basic impl
• Writer trait
  • writer::Basic impl
  • writer::Summary impl
  • writer::Normalize impl
  • WriterExt trait
• Update cucumber_rust_codegen

Checklist

• Created PR:
  • In draft mode
  • Name contains Draft: prefix
  • Name contains issue reference
  • Has k:: labels applied
  • Has assignee
• Documentation is updated (if required)
• Tests are updated (if required)
• Changes conform code style
• CHANGELOG entry is added (if required)
• FCM (final commit message) is posted
  • and approved
• Review is completed and changes are approved
• Before merge:
  • Milestone is set
  • PR's name and description are correct and up-to-date
  • Draft: prefix is removed
  • All temporary labels are removed

[ilslv]

FCM

Redesign (#1, #2)

- introduce `Parser` trait and `parser::Basic` implementation
- introduce `Runner` trait and `runner::Basic` implementation 
- introduce `Writer` trait and `writer::Basic`, `writer::Summary`, `writer::Normalized` implementations

Additionally:
- update book and add CI testing and deployment for it

Book link

Resolved Issues

• 126 — uses # language: comment to deduce language
• 123 — writer::FailOnSkipped
• 119 — writer::Basic pretty-prints only if terminal was detected
• 103 — can be done by Cucumber::filter_run_and_exit()
• 102 — Cucumber::language()
• 88 — not applicable anymore
• 86 — fixed
• 71 — not applicable anymore
• 80 — parsing errors are propagated to the Writer
• 64 — can be done with regex
• 63 — pretty well-documented now
• 62 — asciinema demonstration added
• 56 — writer::Basic has really minimal output

Not resolved yet, but provided more tools for it

• 127 — can be done with custom Writer
• 50 — can be done with custom Writer

TODO

• Ask maintainer to include CRATESIO_TOKEN as GitHub secret

[ilslv]

@tyranron also as described in the docs, Parser should override default language, if comment # language: present. Added that as part of this PR.

Corresponding issue in upstream: 126

[tyranron]

@ilslv this is finally approved! Don't merge it, however. This branch will go to upstream directly. I'll prepare the PR shortly.

Go ahead and integrate it to our projects.

[tyranron]

@ilslv yet still found some style issues to be resolved:

1. In the Book we need to start example steps from lowercase letter to comply with official Cucumber tutorials and don't spread unusual style in examples:

     Scenario: If we feed a hungry cat it will no longer be hungry
       Given a hungry cat
       When I feed the cat
       Then the cat is not hungry

2. We've stripped out the file names and line numbers. But the original idea was to still keep them for failing tests, so the once could easily find the problematic .feature file. From the attached images in the Book I see that for failing tests they're stripped too. Please, return.

Unpleasant part is to recreate SVG images. 😥

[tyranron]

@ilslv

1. Please, re-check and do update all the GIFs across project carefully. Only failed has been updated.

2. In summary counts of failed/skipped/succeed should be highlighted with the correspondent color. Also, we should show statictics by scenarios, and skip rules/errors if there is none.
   
   It would be even better to preserve the previous style with bold text:
   

Do 1 after 2.

[ilslv]

@tyranron I've also separated FailOnSkipped Writer, as before that Summarized just failed in case of skipped step, but didn't show, which of them are failed skips or allowed. Now, FailOnSkipped alters events by itself, so skipped steps are only those, that were allowed.
Because of that, additional refactoring was done to separate writer::term::Styles and writer::Fallible

[tyranron]

@ilslv 👍

Just renamed writer::Fallible to writer::Failure, as the former confuses about being itself fallible rather than taliking about execution failures.