Use tilde heredocs for readability #317
Conversation
spec/unit/puppet-strings/yard/handlers/ruby/function_handler_spec.rb
Outdated
Show resolved
Hide resolved
danielparks
force-pushed
the
format_heredoccs
branch
from
6bc5f17 to
e18c86f
Compare
danielparks
force-pushed
the
format_heredoccs
branch
3 times, most recently
from
3e59fcd to
d59619d
Compare
|
Updated the tests to work and added lengthy comments (maybe I shouldn’t wrap at 80 characters?). I also updated the commit message in hope that it will help some future fool:
As I said, I’m inclined to ignore this, even though it pains me deep inside. |
| # it often isn’t enough. | ||
| # | ||
| # Given that this occurs only in old-style functions, it’s probably not | ||
| # worth pursuing. |
There was a problem hiding this comment.
One of the problematic tests.
|
@danielparks Might be worth rebasing this PR when you get five minutes. Then we can merge it. |
This changes most heredocs to use the tilde syntax with variable
interpolation off. It indents the contents of the heredoc along with the
final symbol.
To maintain these changes, it enables `Layout/HeredocIndentation` and
`Layout/ClosingHeredocIndentation` in Rubocop.
The tilde syntax smartly strips the indentation, and allows for
different indention of the closing identifier:
```ruby
"test\n" == <<~'END'
test
END
```
This syntax was introduced in Ruby 2.3.0, so this will not pose
compatibility problems.
### Tests that should fail
Note that two tests couldn’t be updated to a more common heredoc format
to avoid failing.
It appears there is a problem with the way YARD parses parameters with
defaults with a heredoc ([YARD #779][]). There is a work-around for that
issue in `PuppetStrings::Yard::Handlers::Ruby::Base`, but it can’t work
in these cases because YARD doesn’t provide enough source to read the
whole heredoc content.
Given that these are tests of the Puppet 3 style functions, it’s
probably not worth pursuing this issue.
[YARD #779]: lsegal/yard#779
danielparks
force-pushed
the
format_heredoccs
branch
from
d59619d to
2b01d3a
Compare
|
💯 @danielparks 💯 |
This changes most heredocs to use the tilde syntax with variable interpolation off. It indents the contents of the heredoc along with the final symbol.
To maintain these changes, it enables
Layout/HeredocIndentationandLayout/ClosingHeredocIndentationin Rubocop.The tilde syntax smartly strips the indentation, and allows for different indention of the closing identifier:
This syntax was introduced in Ruby 2.3.0, so this will not pose compatibility problems.