Module: Sinatra::MarkupPlugin::FormatHelpers

Defined in:
lib/sinatra/markup_plugin/format_helpers.rb

Instance Method Summary collapse

Instance Method Details

#escape_html(text) ⇒ Object Also known as: h, sanitize_html

Returns escaped text to protect against malicious content



6
7
8
 
# File 'lib/sinatra/markup_plugin/format_helpers.rb', line 6

def escape_html(text)
  Rack::Utils.escape_html(text)
end

#escape_javascript(html_content) ⇒ Object Also known as: js_escape, js_escape_html, escape_for_javascript

Used in xxxx.js.erb files to escape html so that it can be passed to javascript from sinatra escape_javascript(“<h1>Hey</h1>”)



60
61
62
63
64
65
66
 
# File 'lib/sinatra/markup_plugin/format_helpers.rb', line 60

def escape_javascript(html_content)
  return '' unless html_content
  javascript_mapping = { '\\' => '\\\\', '</' => '<\/', "\r\n" => '\n', "\n" => '\n' }
  javascript_mapping.merge("\r" => '\n', '"' => '\\"', "'" => "\\'")
  escaped_string = html_content.gsub(/(\\|<\/|\r\n|[\n\r"'])/) { javascript_mapping[$1] }
  "\"#{escaped_string}\""
end

#h!(text, blank_text = '&nbsp;') ⇒ Object

Returns escaped text to protect against malicious content Returns blank if the text is empty



14
15
16
17
 
# File 'lib/sinatra/markup_plugin/format_helpers.rb', line 14

def h!(text, blank_text = '&nbsp;')
  return blank_text if text.nil? || text.empty?
  h text
end

#relative_time_ago(from_time) ⇒ Object

Returns relative time in words referencing the given date relative_time_ago(Time.now) => ‘about a minute ago’



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/sinatra/markup_plugin/format_helpers.rb', line 42

def relative_time_ago(from_time)
  distance_in_minutes = (((Time.now - from_time.to_time).abs)/60).round
  case distance_in_minutes
    when 0..1 then 'about a minute'
    when 2..44 then "#{distance_in_minutes} minutes"
    when 45..89 then 'about 1 hour'
    when 90..1439 then "about #{(distance_in_minutes.to_f / 60.0).round} hours"
    when 1440..2879 then '1 day'
    when 2880..43199 then "#{(distance_in_minutes / 1440).round} days"
    when 43200..86399 then 'about 1 month'
    when 86400..525599 then "#{(distance_in_minutes / 43200).round} months"
    when 525600..1051199 then 'about 1 year'
    else "over #{(distance_in_minutes / 525600).round} years"
  end
end

#time_in_words(date) ⇒ Object Also known as: time_ago

Smart time helper which returns relative text representing times for recent dates and absolutes for dates that are far removed from the current date time_in_words(10.days.ago) => ‘10 days ago’



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/sinatra/markup_plugin/format_helpers.rb', line 23

def time_in_words(date)
  date = date.to_date
  date = Date.parse(date, true) unless /Date.*/ =~ date.class.to_s
  days = (date - Date.today).to_i

  return 'today'     if days >= 0 and days < 1
  return 'tomorrow'  if days >= 1 and days < 2
  return 'yesterday' if days >= -1 and days < 0

  return "in #{days} days"      if days.abs < 60 and days > 0
  return "#{days.abs} days ago" if days.abs < 60 and days < 0

  return date.strftime('%A, %B %e') if days.abs < 182
  return date.strftime('%A, %B %e, %Y')
end