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

Allow for type input of frozen strings #909

Merged
merged 1 commit into from
Oct 8, 2023

Conversation

mikelkew
Copy link
Contributor

Summary

Some codebases follow the convention of enforcing frozen string literals, e.g. by using a # frozen_string_literal: true magic comment or via RUBYOPT.

The current implementation of the type API Command breaks when this is the case, as it mutates the string passed to it to add a newline.

Details

To avoid this, this PR tweaks the implementation to use interpolation rather than mutating the string input value.

Motivation and Context

Allows the type API Command to be used in codebases that enforce frozen string literals.

How Has This Been Tested?

I've added a test case to the existing specs for Aruba::Api::Commands#run_command to assert that frozen strings can be passed as an input value.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Internal change (refactoring, test improvements, developer experience or update of dependencies)

Checklist:

  • I've added tests for my code
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.

Use interpolation rather than mutation on string input value to
support codebases using frozen strings.
@mvz mvz merged commit 9143d04 into cucumber:main Oct 8, 2023
@aslakhellesoy
Copy link
Contributor

Hi @mikelkew,

Thanks for your making your first contribution to Cucumber, and welcome to the Cucumber committers team! You can now push directly to this repo and all other repos under the cucumber organization! 🍾

In return for this generous offer we hope you will:

  • ✅ Continue to use branches and pull requests. When someone on the core team approves a pull request (yours or someone else's), you're welcome to merge it yourself.
  • 💚 Commit to setting a good example by following and upholding our code of conduct in your interactions with other collaborators and users.
  • 💬 Join the community Slack channel to meet the rest of the team and make yourself at home.
  • ℹ️ Don't feel obliged to help, just do what you can if you have the time and the energy.
  • 🙋 Ask if you need anything. We're looking for feedback about how to make the project more welcoming, so please tell us!

On behalf of the Cucumber core team,
Aslak Hellesøy
Creator of Cucumber

@mvz
Copy link
Contributor

mvz commented Oct 8, 2023

Thanks, @mikelkew!

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.

3 participants