Module: ViewSourceMap

Defined in:
lib/view_source_map.rb,
lib/view_source_map/version.rb

Defined Under Namespace

Classes: Railtie

Constant Summary collapse

VERSION = 
"0.1.3"

Class Method Summary collapse

Class Method Details

.attach ⇒ Object 



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/view_source_map.rb', line 10

def self.attach
  return if defined?(@attached) && @attached
  @attached = true
  ActionView::PartialRenderer.class_eval do
    def render_with_path_comment(context, options, block)
      content = render_without_path_comment(context, options, block)
      return content if ViewSourceMap.force_disabled?(options)

      if @lookup_context.rendered_format == :html
        if options[:layout]
          name = "#{options[:layout]}(layout)"
        else
          path = Pathname.new(@template.identifier)
          name = path.relative_path_from(Rails.root)
        end
        "<!-- BEGIN #{name} -->\n#{content}<!-- END #{name} -->".html_safe
      else
        content
      end
    end
    alias_method :render_without_path_comment, :render
    alias_method :render, :render_with_path_comment
  end

  ActionView::TemplateRenderer.class_eval do
    def render_template_with_path_comment(template, layout_name = nil, locals = {})
      view, locals = @view, locals || {}

      render_with_layout(layout_name, locals) do |layout|
        instrument(:template, :identifier => template.identifier, :layout => layout.try(:virtual_path)) do
          content = template.render(view, locals) { |*name| view._layout_for(*name) }
          return content if ViewSourceMap.force_disabled?(locals)

          if @lookup_context.rendered_format == :html && template.class != ActionView::Template::Text && !template.identifier.to_s.empty?
            path = Pathname.new(template.identifier)
            name = path.relative_path_from(Rails.root)
            "<!-- BEGIN #{name} -->\n#{content}<!-- END #{name} -->".html_safe
          else
            content
          end
        end
      end
    end
    alias_method :render_template_without_path_comment, :render_template
    alias_method :render_template, :render_template_with_path_comment
  end
end

.detach ⇒ Object 



58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/view_source_map.rb', line 58

def self.detach
  return unless @attached
  @attached = false
  ActionView::PartialRenderer.class_eval do
    undef_method :render_with_path_comment
    alias_method :render, :render_without_path_comment
  end

  ActionView::TemplateRenderer.class_eval do
    undef_method :render_template_with_path_comment
    alias_method :render_template, :render_template_without_path_comment
  end
end

.force_disabled?(options) ⇒ Boolean

Returns:

  • (Boolean) 


72
73
74
75
76
77
 
# File 'lib/view_source_map.rb', line 72

def self.force_disabled?(options)
  return false if options.nil?
  return true  if options[:view_source_map] == false
  return false if options[:locals].nil?
  options[:locals][:view_source_map] == false
end