Class: Card::Format::HtmlFormat

Inherits:
Card::Format show all
Defined in:
mod/core/format/html_format.rb

Direct Known Subclasses

EmailHtmlFormat, RssFormat

Constant Summary collapse

LAYOUTS =

builtin layouts allow for rescue / testing

Mod::Loader.load_layouts.merge "none" => "{{_main}}"

Constants inherited from Card::Format

VIEW_VARS

Instance Attribute Summary collapse

Attributes inherited from Card::Format

#card, #error_status, #form, #main_opts, #parent

Instance Method Summary collapse

Methods inherited from Card::Format

#controller, #include_set_format_modules, #initialize, #method_missing, #page, #params, #pass_method_to_template_object, #require_card_to_initialize!, #respond_to_missing?, #session, #tagged, #template, #to_sym

Methods included from Registration

#class_from_name, #extract_class_vars, #extract_view_tags, #format_ancestry, #format_class, #format_class_name, #format_sym, #interpret_view_opts, #new, #register, #tagged, #view_cache_setting_method

Methods included from Error

#debug_error, #error_cardname, #rendering_error, #rescue_view

Methods included from Content

#add_class, #css_classes, #format_date, #get_content_object, #id_counter, #output, #prepend_class, #process_content, #unique_id

Methods included from ContextNames

#add_name_context, #context_names, #context_names_from_params, #context_names_from_parent, #context_names_to_params, #initial_context_names, #title_in_context

Methods included from Render

#add_debug_info, #api_render, #current_view, #expand_stubs, #final_render, #optional_render_args, #prepare_stub_nest, #pretty_path, #render, #show_debug_info?, #show_view?, #stub_render, #supports_view?, #view_cache_setting, #view_caching?, #view_method, #view_method_name, #view_options_with_defaults, #voo, #with_voo

Methods included from Permission

#assign_view_error_status, #check_view, #handle_view_denial, #ok?, #ok_view, #permitted_view, #subformats_nested_too_deeply?, #task_denied_for_view, #unknown_disqualifies_view?, #view_always_permitted?, #view_for_unknown

Methods included from Nest

#content_nest, #content_view?, #field_nest, #implicit_nest_view, #interpret_nest_options, #nest, #nest_recursion_risk?, #nest_render, #nest_subformat, #reuse_format?

Methods included from Nest::Mode

#configured_view_in_closed_mode, #hide_view_in_edit_mode?, #modal_nest_view, #nest_mode, #view_in_closed_mode, #view_in_edit_mode, #with_nest_mode

Methods included from Nest::Subformat

#depth, #field_subformat, #root, #subformat

Methods included from Nest::Main

#already_mained?, #main!, #main_nest, #main_nest?, #main_nest_options, #wrap_main

Methods included from Nest::Fetch

#fetch_nested_card

Methods included from Env::Location

#card_path, #card_url, #page_path

Constructor Details

This class inherits a constructor from Card::Format

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Card::Format

Instance Attribute Details

#options_need_save ⇒ Object

Returns the value of attribute options_need_save.



10
11
12
 
# File 'mod/core/format/html_format.rb', line 10

def options_need_save
  @options_need_save
end

#skip_autosave ⇒ Object

Returns the value of attribute skip_autosave.



10
11
12
 
# File 'mod/core/format/html_format.rb', line 10

def skip_autosave
  @skip_autosave
end

#start_time ⇒ Object

Returns the value of attribute start_time.



10
11
12
 
# File 'mod/core/format/html_format.rb', line 10

def start_time
  @start_time
end

Instance Method Details

#default_item_view ⇒ Object 



32
33
34
 
# File 'mod/core/format/html_format.rb', line 32

def default_item_view
  :closed
end

#default_nest_view ⇒ Object 



27
28
29
30
 
# File 'mod/core/format/html_format.rb', line 27

def default_nest_view
  # FIXME: not sure this makes sense as a rule...
  card.rule(:default_html_view) || :titled
end

#first_head? ⇒ Boolean

Returns:

  • (Boolean) 


23
24
25
 
# File 'mod/core/format/html_format.rb', line 23

def first_head?
  @first_head ? false : (@first_head = true)
end

#focal? ⇒ Boolean

meaning the current card is the requested card

Returns:

  • (Boolean) 


19
20
21
 
# File 'mod/core/format/html_format.rb', line 19

def focal? # meaning the current card is the requested card
  show_layout? ? main? : depth.zero?
end

#get_layout_content(requested_layout) ⇒ Object

helper methods for layout view



37
38
39
40
41
42
43
44
45
 
# File 'mod/core/format/html_format.rb', line 37

def get_layout_content requested_layout
  Auth.as_bot do
    if requested_layout
      layout_from_card_or_code requested_layout
    else
      layout_from_rule
    end
  end
end

#html_escape_except_quotes(s) ⇒ Object 



70
71
72
73
74
 
# File 'mod/core/format/html_format.rb', line 70

def html_escape_except_quotes s
  # to be used inside single quotes (makes for readable json attributes)
  s.to_s.gsub(/&/, "&").gsub(/\'/, "'")
   .gsub(/>/, "&gt;").gsub(/</, "&lt;")
end

#layout_from_card_or_code(name) ⇒ Object 



55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'mod/core/format/html_format.rb', line 55

def layout_from_card_or_code name
  layout_card = Card.fetch name.to_s, skip_virtual: true,
                                      skip_modules: true
  if layout_card && layout_card.ok?(:read)
    layout_card.content
  elsif (hardcoded_layout = LAYOUTS[name])
    hardcoded_layout
  else
    content_tag(:h1, I18n.t(:unknown_layout, scope: "mod.core.format.html_format",
                                             name: name)) +
      I18n.t(:built_in, scope: "mod.core.format.html_format",
                        build_in_layouts: LAYOUTS.keys.join(', '))
  end
end

#layout_from_rule ⇒ Object 



47
48
49
50
51
52
53
 
# File 'mod/core/format/html_format.rb', line 47

def layout_from_rule
  if (rule = card.rule_card :layout) &&
     (rule.type_id == Card::PointerID) &&
     (layout_name = rule.item_names.first)
    layout_from_card_or_code layout_name
  end
end

#main? ⇒ Boolean

Returns:

  • (Boolean) 


15
16
17
 
# File 'mod/core/format/html_format.rb', line 15

def main?
  !@main.nil?
end

#mime_type ⇒ Object 



76
77
78
 
# File 'mod/core/format/html_format.rb', line 76

def mime_type
  "text/html"
end