Parsing issues with yield?

[AliOsm]

I have the following ERB template:

<section>
  <div class="flex flex-col pb-4 mx-auto">
    <div class="w-full bg-white rounded-lg shadow sm:max-w-lg md:mt-0 xl:p-0 dark:bg-gray-800 dark:border dark:border-gray-700">
      <div class="p-6 space-y-4 sm:p-8 md:space-y-6">
        <%= yield %>
      </div>
    </div>
  </div>
</section>

When I save it, erb-formatter VSCode extension shows the following:

Failed in line 8 ==> ERROR: Unmatched close tag, tried with ["div", "</div>"], but ["%erb%", "yield"] was on the stack

But in other templates like the following one:

<%# locals: (text:, url:, args: {}) %>

<%= link_to url, **{ class: "flex items-center text-sm font-medium text-primary-600 dark:text-primary-500 hover:underline", **args } do %>
  <%= yield %>

    <%= text %>
  <% end %>

No issues happens and the formatter works, but the formatting is not correct, I'm pasting the formatted template.

I think erb-formatter has some issues with yield with used with HTML tags.

[AliOsm]

The same issue happens with this template also:

<div id="flash">
  <% flash.each do |type, message| %>
    <% next unless message.is_a?(String) %>

    <% case type %>
    <% when "alert" %>
      <%= render("shared/alert_flash", message: message) %>
    <% when "notice" %>
      <%= render("shared/notice_flash", message: message) %>
    <% end %>
  <% end %>
</div>

The error is:

Failed in line 12 ==> ERROR: Unmatched close tag, tried with ["div", "</div>"], but ["%erb%", "flash.each do |type, message|"] was on the stack

[AliOsm]

For this template:

<section>
  <div class="flex flex-col pb-4 mx-auto">
    <div class="w-full bg-white rounded-lg shadow sm:max-w-lg md:mt-0 xl:p-0 dark:bg-gray-800 dark:border dark:border-gray-700">
      <div class="p-6 space-y-4 sm:p-8 md:space-y-6">
        <%= yield %>
      </div>
    </div>
  </div>
</section>

Adding <% end %> after the yield line fixes the issue, but the page is not rendering any more :3

[IbraheemTuffaha]

I'm facing the same issue
I tried closing the yield tag with an end tag and the formatter is working
But as you said, the code no longer renders, instead of gives an error :)

[IbraheemTuffaha]

I dug a bit into the code and I found this case statement:

erb-formatter/lib/erb/formatter.rb

Lines 308 to 326 in 8c1c7b2

	case ruby_code
	when RUBY_CLOSE_BLOCK
	full_erb_tag = "#{erb_open}#{ruby_code} #{erb_close}"
	tag_stack_pop('%erb%', ruby_code)
	html << (erb_pre_match.match?(/\s+\z/) ? indented(full_erb_tag) : full_erb_tag)
	when RUBY_REOPEN_BLOCK
	full_erb_tag = "#{erb_open}#{ruby_code} #{erb_close}"
	tag_stack_pop('%erb%', ruby_code)
	html << (erb_pre_match.match?(/\s+\z/) ? indented(full_erb_tag) : full_erb_tag)
	tag_stack_push('%erb%', ruby_code)
	when RUBY_OPEN_BLOCK
	full_erb_tag = "#{erb_open}#{ruby_code} #{erb_close}"
	html << (erb_pre_match.match?(/\s+\z/) ? indented(full_erb_tag) : full_erb_tag)
	tag_stack_push('%erb%', ruby_code)
	else
	ruby_code = format_ruby(ruby_code, autoclose: false)
	full_erb_tag = "#{erb_open}#{ruby_code} #{erb_close}"
	html << (erb_pre_match.match?(/\s+\z/) ? indented(full_erb_tag) : full_erb_tag)
	end

So the issue here is that the yield tag should be handled in else I believe, but it's being handled in when RUBY_OPEN_BLOCK
I tried replicating the code in else into a when right at the start, where this one checks if the tag starts with yield:

 when /\Ayield\b/ 
   ruby_code = format_ruby(ruby_code, autoclose: false) 
   full_erb_tag = "#{erb_open}#{ruby_code} #{erb_close}" 
   html << (erb_pre_match.match?(/\s+\z/) ? indented(full_erb_tag) : full_erb_tag) 

So final code looked like this:

 case ruby_code 
 when /\Ayield\b/ 
   ruby_code = format_ruby(ruby_code, autoclose: false) 
   full_erb_tag = "#{erb_open}#{ruby_code} #{erb_close}" 
   html << (erb_pre_match.match?(/\s+\z/) ? indented(full_erb_tag) : full_erb_tag) 
 when RUBY_CLOSE_BLOCK 
   full_erb_tag = "#{erb_open}#{ruby_code} #{erb_close}" 
   ...

The formatter seemed to start working correctly
I'm not sure if this solution is generic enough to cover all cases though
Also, I'm sure it's not the cleanest way to handle this case for sure :)

[IbraheemTuffaha]

I'm facing a similar issue when there's a ruby code with next unless:

<% flash.each do |type, message| %>
  <% next unless message.is_a?(String) %>
  <div ... >
    ...
  </div>
<% end %>

For some reason, erb-formatter thinks that the next unless statement is an opening tag and pushed the whole div inside one tab

[edusurf10]

what solution for this problem?

[lakim]

I have the same issue with yield.
It's very weird, because I thought it was working before. But when I install previous versions up to 0.5.0, I have the same error.

[elia]

@IbraheemTuffaha could you please send a PR with your solution? I can't fix it right now, and I'm happy to accept it, even if it's not "optimal" and only improves the situation. 🙏

[lakim]

I've tried your branch @IbraheemTuffaha and I confirm that it fixes my issue. 🙏

[anthmatic]

Just wanted to add that I'm also having the same issue with when tags:

<% when "something" %>

causes this error:

Failed in line 37 ==> ERROR: Unmatched close tag, tried with ["div", "</div>"], but ["%erb%", "when \\"something\\""] was on the stack

[IbraheemTuffaha]

Just wanted to add that I'm also having the same issue with when tags:

<% when "something" %>

causes this error:

Failed in line 37 ==> ERROR: Unmatched close tag, tried with ["div", "</div>"], but ["%erb%", "when \\"something\\""] was on the stack

@anthmatic
It should be correctly handled here:

erb-formatter/lib/erb/formatter.rb

Line 313 in a7ce8b4

when RUBY_REOPEN_BLOCK

Which is defined here:

erb-formatter/lib/erb/formatter.rb

Line 65 in a7ce8b4

RUBY_REOPEN_BLOCK = /\A(else|elsif\b(.*)|when\b(.*))\z/

Are you sure you closed the whole case statement properly?

<% case var %>
<% when "bar" %>
  ...
<% when "foo" %>
  ...
<% end %>

[lakim]

Just wanted to add that I'm also having the same issue with when tags:

<% when "something" %>

causes this error:

Failed in line 37 ==> ERROR: Unmatched close tag, tried with ["div", "</div>"], but ["%erb%", "when \\"something\\""] was on the stack

I also had issues with case/when, and this was the only syntax that worked:

<% case var
   when "bar" %>
  ...
<% when "foo" %>
  ...
<% end %>

But it now seems to work with @IbraheemTuffaha 's PR.

@elia do you think you can merge it?

[IbraheemTuffaha]

Should be closed now after #53 is merged?

[elia]

Fixed by #53