Render helper with block containing Arbre element. #64

varyonic · 2017-03-03T16:40:19Z

This PR fixes #46 following the first option suggested by Sean. It monkey-patches ActionView::Base#capture so that the output of Arbre elements is not lost inside a Rails helper block, and it modifies Arbre::Element#method_missing to capture the output of Rails helper calls into text_nodes.

houndci-bot · 2017-03-03T16:40:30Z

lib/arbre/rails/template_handler.rb

+    # and https://github.com/rails/rails/pull/18024#commitcomment-8975180
+    value = value.to_s if value.is_a?(Arbre::Element)
+
+    if string = buffer.presence || value and string.is_a?(String)


Use && instead of and.

houndci-bot · 2017-03-03T16:40:31Z

lib/arbre/rails/template_handler.rb

@@ -1,3 +1,19 @@
+class ActionView::Base


Missing frozen string literal comment.
Use nested module/class definitions instead of compact style.

Fivell · 2017-03-04T16:04:53Z

@varyonic , is it still WIP ?

houndci-bot · 2017-09-20T20:46:36Z

lib/arbre/element.rb

+      within(Element.new) { s = helpers.send(name, *args, &block) }
+      s.is_a?(Element) ? s.to_s : s
+    end
+


Extra empty line detected at class body end.

houndci-bot · 2017-09-20T20:46:37Z

lib/arbre/element.rb

+    # We do not want such elements added to self, so we push a dummy
+    # current_arbre_element.
+    def helper_capture(name, *args, &block)
+      s = ''


Prefer double-quoted strings unless you need single quotes to avoid extra backslashes for escaping.

houndci-bot · 2017-09-20T20:46:37Z

lib/arbre/element.rb

@@ -177,11 +177,21 @@ def method_missing(name, *args, &block)
      elsif assigns && assigns.has_key?(name)
        assigns[name]
      elsif helpers.respond_to?(name)
-        helpers.send(name, *args, &block)
+        value = helper_capture(name, *args, &block)


Useless assignment to variable - value.

houndci-bot · 2017-09-20T20:46:46Z

spec/rails/integration/rendering_spec.rb

+    get "/test/render_page_with_helpers"
+    expect(response).to be_success
+    expect(body).to eq <<-EOS
+<span>before h1 link</span>


Use 2 spaces for indentation in a heredoc by using <<~ instead of <<-.

houndci-bot · 2017-09-21T19:21:39Z

spec/rails/integration/rendering_spec.rb

+    get "/test/render_page_with_helpers"
+    expect(response).to be_success
+    expect(body).to eq <<~EOS
+<span>before h1 link</span>


Use 2 spaces for indentation in a heredoc by using <<~ instead of <<~.

houndci-bot · 2017-09-21T19:21:39Z

lib/arbre/rails/template_handler.rb

@@ -1,3 +1,20 @@
+# frozen_string_literal: true
+ActionView::Base.class_eval do


Add an empty line after magic comments.

varyonic · 2017-09-21T19:52:17Z

lib/arbre/rails/template_handler.rb

+    # Override to handle Arbre elements inside helper blocks.
+    # See https://github.com/rails/rails/issues/17661
+    # and https://github.com/rails/rails/pull/18024#commitcomment-8975180
+    value = value.to_s if value.is_a?(Arbre::Element)


Copied ActionView::Helpers::CaptureHelper.capture and added this line to convert Arbre::Element#to_s so the output is not lost.

varyonic · 2017-09-21T19:57:10Z

I was overcomplicating things by trying to eliminate text_node. link_to works with text_node and now the arbre inside the link_to block is captured and displayed in the order expected.

houndci-bot · 2017-09-21T20:04:37Z

spec/rails/integration/rendering_spec.rb

+    get "/test/render_page_with_helpers"
+    expect(response).to be_success
+    expect(body).to eq <<EOS
+<span>before h1 link</span>


Use 2 spaces for indentation in a heredoc by using <<~ instead of <<.

seanlinsley

This looks good to me! 😄 Could you write a changelog entry? It might also be valuable to document how to use Rails helpers with Arbre as a new section in the README.

seanlinsley · 2018-01-01T02:23:33Z

lib/arbre/rails/template_handler.rb

@@ -1,3 +1,21 @@
+# frozen_string_literal: true
+
+ActionView::Base.class_eval do


Perhaps this should be moved to its own file, named something like lib/arbre/rails/capture.rb

seanlinsley · 2018-01-01T02:48:50Z

One concern with the monkeypatch is that it doesn't call the original implementation, so another gem that overrode capture would be in contention with Arbre.

This might work as an alternative:

ActionView::Base.prepend Module.new {
  def capture(*args)
    super *args do
      value = yield *args
      value = value.to_s if value.is_a? Arbre::Element
      value
    end
  end
}

I'm not sure if with_output_buffer is needed; since this basically just wraps the block in another block, the original implementation's call to with_output_buffer should theoretically be enough.

varyonic · 2018-02-10T16:28:36Z

I'm going to take this as approved and consider the suggestions for later.

…_block_in_arbre_template" This reverts commit 465fc4a, reversing changes made to a3349fb. # Conflicts: # spec/rails/integration/rendering_spec.rb # spec/rails/templates/arbre/page_with_helpers.arb

This change implements activeadmin/arbre#64 https://github.com/activeadmin/arbre/pull/64/files which was reverted. The initial PR was reverted because you could potentially get duplicate renders in certain situations. The workaround I can see is to return nil from the block if this occurs. I think this is an acceptable workaround for this library.

houndci-bot reviewed Mar 3, 2017

View reviewed changes

varyonic mentioned this pull request Jul 30, 2017

Improving memory efficiency activeadmin/activeadmin#5113

Closed

varyonic mentioned this pull request Aug 28, 2017

Remove MethodOrProcHelper from FormBuilder activeadmin/activeadmin#5084

Merged

varyonic force-pushed the 46_rails_tag_helper_with_block_in_arbre_template branch from b79aec4 to 6fc0d29 Compare September 20, 2017 20:46

houndci-bot reviewed Sep 20, 2017

View reviewed changes

varyonic force-pushed the 46_rails_tag_helper_with_block_in_arbre_template branch from 6fc0d29 to 3f467ab Compare September 21, 2017 19:21

houndci-bot reviewed Sep 21, 2017

View reviewed changes

varyonic force-pushed the 46_rails_tag_helper_with_block_in_arbre_template branch 2 times, most recently from 6fc0d29 to c5840c0 Compare September 21, 2017 19:33

varyonic changed the title ~~[WIP] Render helper with block.~~ Render helper with block. Sep 21, 2017

varyonic changed the title ~~Render helper with block.~~ Render helper with block containing Arbre element. Sep 21, 2017

varyonic commented Sep 21, 2017

View reviewed changes

varyonic force-pushed the 46_rails_tag_helper_with_block_in_arbre_template branch from c5840c0 to 82fb896 Compare September 21, 2017 20:04

houndci-bot reviewed Sep 21, 2017

View reviewed changes

varyonic force-pushed the 46_rails_tag_helper_with_block_in_arbre_template branch from 82fb896 to ed8db93 Compare September 21, 2017 20:10

activeadmin deleted a comment from houndci-bot Sep 21, 2017

varyonic requested review from Fivell, javierjulio and deivid-rodriguez September 21, 2017 20:19

Render helper with block.

fbb048e

varyonic force-pushed the 46_rails_tag_helper_with_block_in_arbre_template branch from ed8db93 to fbb048e Compare September 21, 2017 21:00

varyonic requested a review from timoschilling October 17, 2017 19:34

seanlinsley approved these changes Jan 1, 2018

View reviewed changes

varyonic merged commit 465fc4a into activeadmin:master Feb 10, 2018

varyonic deleted the 46_rails_tag_helper_with_block_in_arbre_template branch June 4, 2018 17:37

deivid-rodriguez mentioned this pull request Apr 11, 2019

Nested Form Fields Rendered Twice in 1.2.0 Release #119

Closed

seanlinsley mentioned this pull request Apr 11, 2019

Custom helper methods aren't rendered in 1.2.0 #120

Closed

varyonic restored the 46_rails_tag_helper_with_block_in_arbre_template branch January 14, 2022 21:00

varyonic deleted the 46_rails_tag_helper_with_block_in_arbre_template branch January 10, 2023 19:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Render helper with block containing Arbre element. #64

Render helper with block containing Arbre element. #64

varyonic commented Mar 3, 2017 •

edited

Loading

houndci-bot Mar 3, 2017

houndci-bot Mar 3, 2017

Fivell commented Mar 4, 2017

houndci-bot Sep 20, 2017

houndci-bot Sep 20, 2017

houndci-bot Sep 20, 2017

houndci-bot Sep 20, 2017

houndci-bot Sep 21, 2017

houndci-bot Sep 21, 2017

varyonic Sep 21, 2017

varyonic commented Sep 21, 2017

houndci-bot Sep 21, 2017

seanlinsley left a comment

seanlinsley Jan 1, 2018

seanlinsley commented Jan 1, 2018

varyonic commented Feb 10, 2018

		@@ -1,3 +1,20 @@
		# frozen_string_literal: true
		ActionView::Base.class_eval do

		@@ -1,3 +1,21 @@
		# frozen_string_literal: true

		ActionView::Base.class_eval do

Render helper with block containing Arbre element. #64

Render helper with block containing Arbre element. #64

Conversation

varyonic commented Mar 3, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Fivell commented Mar 4, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

varyonic commented Sep 21, 2017

Choose a reason for hiding this comment

seanlinsley left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

seanlinsley commented Jan 1, 2018

varyonic commented Feb 10, 2018

varyonic commented Mar 3, 2017 •

edited

Loading