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

[Ruby] - Remove all custom ruby code (Port logic to Cucumber-Ruby) #94

Merged
merged 25 commits into from
Jan 8, 2024

Conversation

luke-hill
Copy link
Contributor

@luke-hill luke-hill commented Jan 5, 2024

Description

Amending the Ruby portion of the CCK to only contain generic items such as features and miscellaneous files.
(The miscellaneous files will be shared but not consumed yet downstream)

Items to complete

  • CCK
    • Check we're not publishing any bespoke ruby code in the gem (Should only have the single namespace CCK::Examples with a few minor links to determine files
    • Changelog entry here
  • Cucumber Ruby
    • Get companion PR into a state where it's 80% complete.
    • Locally test the companion PR will run and validate the code "if" the code here is released

🏷️ What kind of change is this?

  • 🏦 Refactoring/debt/DX (improvement to code design, tooling, documentation etc. without changing behaviour)
  • ⚡ New feature (non-breaking change which adds new behaviour)
  • 💥 Breaking change (incompatible changes to the API)

♻️ Anything particular you want feedback on?

Will tag once this is good to be reviewed

📋 Checklist:

  • I agree to respect and uphold the Cucumber Community Code of Conduct
  • I've changed the behaviour of the code
    • I have added/updated tests to cover my changes.
  • My change requires a change to the documentation.
    • I have updated the documentation accordingly.
  • Users should know about my change
    • I have added an entry to the "Unreleased" section of the CHANGELOG, linking to this pull request.

This text was originally generated from a template, then edited by hand. You can modify the template here.

@luke-hill luke-hill requested a review from davidjgoss January 5, 2024 16:11
@luke-hill
Copy link
Contributor Author

This is now ready to review and is essentially completed. The companion PR is about 85% done.

Copy link
Contributor

@davidjgoss davidjgoss left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't speak authoritatively to the Ruby code itself but the direction looks right.

@luke-hill
Copy link
Contributor Author

Essentially the ruby code remaining is to do 1 of the 3 things (That also have some simple tests).

  • CCK::Examples#gherkin - returns an array of the name of every gherkin example we have in the CCK. Currently returns ['undefined', 'stack-traces' e.t.c.]
  • CCK::Examples#markdown - returns an array of the name of every markdown example we have in the CCK. Currently returns ['markdown']
  • CCK::Examples#feature_code_for - returns the path for a specific name of a feature or throws an error. NB: This returns the path in the gem

@luke-hill luke-hill merged commit 284bfdd into main Jan 8, 2024
7 checks passed
@luke-hill luke-hill deleted the feature/purge_ruby_support branch January 8, 2024 10:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants