Module: Card::Format::Render

Included in:
Card::Format
Defined in:
lib/card/format/render.rb

Overview

View rendering methods.

Instance Method Summary collapse

Instance Method Details

#add_debug_info(view, method, rendered) ⇒ Object 



49
50
51
52
53
54
55
 
# File 'lib/card/format/render.rb', line 49

def add_debug_info view, method, rendered
  return rendered unless show_debug_info?
  <<-HTML
    <view-debug view='#{card.name}##{view}' src='#{pretty_path method.source_location}' module='#{method.owner}'/>
    #{rendered}
  HTML
end

#api_render(match, opts) ⇒ Object 



113
114
115
116
117
118
119
 
# File 'lib/card/format/render.rb', line 113

def api_render match, opts
  view = match[3] ? match[4] : opts.shift
  args = opts[0] ? opts.shift.clone : {}
  optional_render_args(args, opts) if match[2]
  args[:skip_perms] = true if match[1]
  render view, args
end

#current_view(view) ⇒ Object 



141
142
143
144
145
146
147
 
# File 'lib/card/format/render.rb', line 141

def current_view view
  old_view = @current_view
  @current_view = view
  yield
ensure
  @current_view = old_view
end

#expand_stubs(cached_content) ⇒ Object 



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/card/format/render.rb', line 96

def expand_stubs cached_content
  return cached_content unless cached_content.is_a? String

  conto = Card::Content.new cached_content, self, chunk_list: :stub
  conto.process_each_chunk do |stub_hash|
    yield(stub_hash)
  end

  if conto.pieces.size == 1
    # for stubs in json format this converts a single stub back
    # to it's original type (e.g. a hash)
    conto.pieces.first.to_s
  else
    conto.to_s
  end
end

#final_render(view, args) ⇒ Object 



41
42
43
44
45
46
47
 
# File 'lib/card/format/render.rb', line 41

def final_render view, args
  current_view(view) do
    method = view_method view
    rendered = method.arity.zero? ? method.call : method.call(args)
    add_debug_info view, method, rendered
  end
end

#optional_render_args(args, opts) ⇒ Object 



121
122
123
 
# File 'lib/card/format/render.rb', line 121

def optional_render_args args, opts
  args[:optional] = opts.shift || :show
end

#prepare_stub_nest(stub_hash) {|stub_card, , stub_options, | ... } ⇒ Object

Yields:

  • (stub_card, , stub_options, ) 


87
88
89
90
91
92
93
94
 
# File 'lib/card/format/render.rb', line 87

def prepare_stub_nest stub_hash
  stub_card = Card.fetch_from_cast stub_hash[:cast]
  stub_options = stub_hash[:options]
  if stub_card&.key.present? && stub_card.key == card.key
    stub_options[:nest_name] ||= "_self"
  end
  yield stub_card, stub_hash[:mode], stub_options, stub_hash[:override]
end

#pretty_path(source_location) ⇒ Object 



61
62
63
64
 
# File 'lib/card/format/render.rb', line 61

def pretty_path source_location
  source_location.first.gsub(%r{^.+mod\d+-([^/]+)}, '\1: ') + ':' +
    source_location.second.to_s
end

#render(view, args = {}) ⇒ Object 



6
7
8
9
10
11
12
13
14
15
 
# File 'lib/card/format/render.rb', line 6

def render view, args={}
  voo = View.new self, view, args, @voo
  with_voo voo do
    voo.process do |final_view, options|
      final_render final_view, options
    end
  end
rescue => e
  rescue_view e, view
end

#show_debug_info? ⇒ Boolean

Returns:

  • (Boolean) 


57
58
59
 
# File 'lib/card/format/render.rb', line 57

def show_debug_info?
  Env.params[:debug] == "view"
end

#show_view?(view, default_viz = :show) ⇒ Boolean

Returns:

  • (Boolean) 


35
36
37
38
39
 
# File 'lib/card/format/render.rb', line 35

def show_view? view, default_viz=:show
  voo.process_visibility_options # trigger viz processing
  visibility = voo.viz_hash[view] || default_viz
  visibility == :show
end

#stub_render(cached_content) ⇒ Object 



79
80
81
82
83
84
85
 
# File 'lib/card/format/render.rb', line 79

def stub_render cached_content
  expand_stubs cached_content do |stub_hash|
    prepare_stub_nest(stub_hash) do |stub_card, mode, options, override|
      with_nest_mode(mode) { nest stub_card, options, override }
    end
  end
end

#supports_view?(view) ⇒ Boolean

Returns:

  • (Boolean) 


133
134
135
 
# File 'lib/card/format/render.rb', line 133

def supports_view? view
  respond_to? view_method_name(view)
end

#view_cache_setting(view) ⇒ Object

setting (:alway, :never, :nested) designated in view definition



71
72
73
74
75
76
77
 
# File 'lib/card/format/render.rb', line 71

def view_cache_setting view
  method = self.class.view_cache_setting_method view
  coded_setting = respond_to?(method) ? send(method) : :standard
  return :never if coded_setting == :never
  # seems unwise to override a hard-coded "never"
  (voo && voo.cache) || coded_setting
end

#view_caching? ⇒ Boolean

Returns:

  • (Boolean) 


66
67
68
 
# File 'lib/card/format/render.rb', line 66

def view_caching?
  true
end

#view_method(view) ⇒ Object 



125
126
127
128
129
130
131
 
# File 'lib/card/format/render.rb', line 125

def view_method view
  unless supports_view? view
    voo.unsupported_view = view
    view = :unsupported_view
  end
  method view_method_name(view)
end

#view_method_name(view) ⇒ Object 



137
138
139
 
# File 'lib/card/format/render.rb', line 137

def view_method_name view
  "_view_#{view}"
end

#view_options_with_defaults(view, options) ⇒ Object 



25
26
27
28
29
 
# File 'lib/card/format/render.rb', line 25

def view_options_with_defaults view, options
  default_method = "default_#{view}_args"
  send default_method, options if respond_to? default_method
  options
end

#voo ⇒ Object 



31
32
33
 
# File 'lib/card/format/render.rb', line 31

def voo
  @voo
end

#with_voo(voo) ⇒ Object 



17
18
19
20
21
22
23
 
# File 'lib/card/format/render.rb', line 17

def with_voo voo
  old_voo = @voo
  @voo = voo
  result = yield
  @voo = old_voo
  result
end