Module: Middleman::NavTree::Helpers

Defined in:
lib/middleman-navtree/helpers.rb

Overview

NavTree-related helpers that are available to the Middleman application in config.rb and in templates.

Instance Method Summary collapse

Instance Method Details

#discover_title(page = current_page) ⇒ Object

Utility helper for getting the page title for display in the navtree. Based on this: forum.middlemanapp.com/t/using-heading-from-page-as-title/44/3 1) Use the title from frontmatter metadata, or 2) peek into the page to find the H1, or 3) Use the home_title option (if this is the home page–defaults to “Home”), or 4) fallback to a filename-based-title



130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/middleman-navtree/helpers.rb', line 130

def discover_title(page = current_page)
  if page.data.title
    return page.data.title # Frontmatter title
  elsif match = page.render({:layout => false, :no_images => true}).match(/<h.+>(.*?)<\/h1>/)
    return match[1] # H1 title
  elsif page.url == '/'
    return extensions[:navtree].options[:home_title]
  else
    filename = page.url.split(/\//).last.gsub('%20', ' ').titleize
    return filename.chomp(File.extname(filename))
  end
end

#first_page?(pagelist) ⇒ Boolean

Helper for use in pagination methods.

Returns:

  • (Boolean) 


78
79
80
 
# File 'lib/middleman-navtree/helpers.rb', line 78

def first_page?(pagelist)
  return true if get_current_position_in_page_list(pagelist) == 0
end

#flatten_source_tree(value, k = [], level = 0, flat_tree = []) ⇒ Object

Method to flatten the source tree, for use in pagination methods.



88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/middleman-navtree/helpers.rb', line 88

def flatten_source_tree(value, k = [], level = 0, flat_tree = [])
  if value.is_a?(String)
    # This is a child item (a file).
    flat_tree.push(sitemap.extensionless_path(value))
  elsif value.is_a?(Hash)
    # This is a parent item (a directory).
    value.each do |key, child|
      flatten_source_tree(child, key, level + 1, flat_tree)
    end
  end

  return flat_tree
end

#format_directory_name(dir_name) ⇒ Object

Format Directory name for display in navtree. Example Name: 1%20-%20sink-or_swim



116
117
118
119
120
121
122
 
# File 'lib/middleman-navtree/helpers.rb', line 116

def format_directory_name(dir_name)
  formatted_name = dir_name.gsub('%20', ' ') #=> 1 - sink-or_swim
  formatted_name.gsub!(/(?!\s)-(?!\s)/, ' ') #=> 1 - sink or_swim
  formatted_name.gsub!(/_/, ' ') #=> 1 - sink or swim
  # @todo: Find a way for titleize to not blow away ' - ' formatting.
  formatted_name.titleize! #=> 1 Sink or Swim
end

#get_current_position_in_page_list(pagelist) ⇒ Object

Helper for use in pagination methods.



103
104
105
106
107
108
109
110
111
112
 
# File 'lib/middleman-navtree/helpers.rb', line 103

def get_current_position_in_page_list(pagelist)
  pagelist.each_with_index do |page_path, index|
    if page_path == "/" + current_page.path
      return index
    end
  end
  # If we reach this line, the current page path wasn't in our page list and we'll
  # return false so the link generation is skipped.
  return FALSE
end

#last_page?(pagelist) ⇒ Boolean

Helper for use in pagination methods.

Returns:

  • (Boolean) 


83
84
85
 
# File 'lib/middleman-navtree/helpers.rb', line 83

def last_page?(pagelist)
  return true if pagelist[get_current_position_in_page_list(pagelist)] == pagelist[-1]
end

#next_link(sourcetree) ⇒ Object 



63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/middleman-navtree/helpers.rb', line 63

def next_link(sourcetree)
  pagelist = flatten_source_tree(sourcetree)
  position = get_current_position_in_page_list(pagelist)
  # Skip link generation if position is nil (meaning, the current page isn't in our
  # pagination pagelist).
  if position
    next_page = pagelist[position + 1]
    options = {:class => "next"}
    unless last_page?(pagelist)
      link_to("Next", next_page, options)
    end
  end
end

#previous_link(sourcetree) ⇒ Object

Pagination helpers @todo: One potential future feature is previous/next links for paginating on a

single level instead of a flattened tree. I don't need it but it seems pretty easy.



49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/middleman-navtree/helpers.rb', line 49

def previous_link(sourcetree)
  pagelist = flatten_source_tree(sourcetree)
  position = get_current_position_in_page_list(pagelist)
  # Skip link generation if position is nil (meaning, the current page isn't in our
  # pagination pagelist).
  if position
    prev_page = pagelist[position - 1]
    options = {:class => "previous"}
    unless first_page?(pagelist)
      link_to("Previous", prev_page, options)
    end
  end
end

#tree_to_html(value, depth = Float::INFINITY, key = nil, level = 0) ⇒ Object

A recursive helper for converting source tree data from into HTML



7
8
9
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
 
# File 'lib/middleman-navtree/helpers.rb', line 7

def tree_to_html(value, depth = Float::INFINITY, key = nil, level = 0)
  html = ''

  if value.is_a?(String)
    # This is a file.
    # Get the Sitemap resource for this file.
    # note: sitemap.extensionless_path converts the path to its 'post-build' extension.
    this_resource = sitemap.find_resource_by_path(sitemap.extensionless_path(value))
    # Define string for active states.
    active = this_resource == current_page ? 'active' : ''
    title = discover_title(this_resource)
    link = link_to(title, this_resource)
    html << "<li class='child #{active}'>#{link}</li>"
  else
    # This is the first level source directory. We treat it special because
    # it has no key and needs no list item.
    if key.nil?
      value.each do |newkey, child|
        html << tree_to_html(child, depth, newkey, level + 1)
      end
    # Continue rendering deeper levels of the tree, unless restricted by depth.
    elsif depth >= (level + 1)
      # This is a directory.
      # The directory has a key and should be listed in the page hieararcy with HTML.
      dir_name = format_directory_name(key)
      html << "<li class='parent'><span class='parent-label'>#{dir_name}</span>"
      html << '<ul>'

      # Loop through all the directory's contents.
      value.each do |newkey, child|
        html << tree_to_html(child, depth, newkey, level + 1)
      end
      html << '</ul>'
      html << '</li>'
    end
  end
  return html
end