Module: Pinmark::Wrapper

Defined in:
lib/pinmark/wrapper.rb

Class Method Summary collapse

Class Method Details

.escape(value) ⇒ Object 



36
37
38
 
# File 'lib/pinmark/wrapper.rb', line 36

def escape(value)
  CGI.escapeHTML(value.to_s).gsub("--", "--")
end

.wrap(component:, source:) ⇒ Object

Wrap a block’s HTML output in pinmark begin/end markers, pushing and popping the per-request tracker. When annotations are inactive (non-dev, or no tracker) the block is invoked verbatim and its return value passes through unchanged.

The block must return a String (or something coercible via #to_s).



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/pinmark/wrapper.rb', line 15

def wrap(component:, source:)
  tracker = Pinmark.tracker if Rails.env.development?
  return yield unless tracker

  id = tracker.push(component:, source:)
  parent_id = tracker.nodes.last[:parent_id]

  id_attr = escape(id)
  class_attr = escape(component)
  src_attr = escape(source)
  parent_attr = escape(parent_id)

  begin_marker = %(<!-- pinmark:begin id="#{id_attr}" class="#{class_attr}" src="#{src_attr}" parent="#{parent_attr}" -->)
  end_marker = %(<!-- pinmark:end id="#{id_attr}" -->)

  content = yield.to_s
  "#{begin_marker}#{content}#{end_marker}".html_safe
ensure
  tracker&.pop if id
end