Module: Brief::Document::Rendering

Extended by:
ActiveSupport::Concern
Included in:
Brief::Document
Defined in:
lib/brief/document/rendering.rb

Instance Method Summary collapse

Instance Method Details

#script_contents(options = {}) ⇒ Object 



34
35
36
37
38
39
40
 
# File 'lib/brief/document/rendering.rb', line 34

def script_contents(options={})
  <<-EOF
  <script type="text/javascript">
  Brief.documents['#{ self.relative_path }'] = #{ to_model.as_json(options).to_json };
  </script>
  EOF
end

#script_preamble ⇒ Object 



22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/brief/document/rendering.rb', line 22

def script_preamble
  <<-EOF
  <script type="text/javascript">
  if(typeof(global)==="undefined"){
    global = window
  }
  global.Brief = global.Brief || {}
  Brief.documents = Brief.documents || {}
  </script>
  EOF
end

#to_html(options = {}) ⇒ Object

Documents can be rendered into HTML.

They will first be put through a Nokogiri processor pipeline which allows us to wrap things in section containers, apply data attributes, and other things to the HTML so that the output HTML retains its relationship to the underlying data and document structure.



48
49
50
51
52
53
54
55
56
57
 
# File 'lib/brief/document/rendering.rb', line 48

def to_html(options = {})
  html = if options[:wrap] == false
    unwrapped_html
  else
    wrapper = options.fetch(:wrapper, 'div')
    "#{script_preamble if options[:script] && !options[:skip_preamble]}<#{ wrapper } data-brief-model='#{ model_class.type_alias }' data-brief-path='#{ relative_path }'>#{ unwrapped_html }</#{wrapper}>#{ script_contents(options) if options[:script]}"
  end

  html.respond_to?(:html_safe) ? html.html_safe : html.to_s
end

#unwrapped_html ⇒ Object 



59
60
61
62
63
64
 
# File 'lib/brief/document/rendering.rb', line 59

def unwrapped_html
  # remove annoying linebreaks from paragraphs
  parser.css("p br").remove() unless Brief.configuration.preserve_gfm_line_breaks

  parser.to_html
end