Module: Middleman::Sitemap::Extensions::Traversal

Included in:
Resource
Defined in:
middleman-core/lib/middleman-core/sitemap/extensions/traversal.rb

Instance Method Summary collapse

Instance Method Details

#childrenArray<Middleman::Sitemap::Resource>

This resource's child resources



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
# File 'middleman-core/lib/middleman-core/sitemap/extensions/traversal.rb', line 44

def children
  return [] unless directory_index?

  base_path = if eponymous_directory?
    eponymous_directory_path
  else
    path.sub(@app.config[:index_file].to_s, '')
  end

  prefix = %r{^#{base_path.sub("/", "\\/")}}

  @store.resources.select do |sub_resource|
    if sub_resource.path == path || sub_resource.path !~ prefix
      false
    else
      inner_path = sub_resource.path.sub(prefix, '')
      parts = inner_path.split('/')
      if parts.length == 1
        true
      elsif parts.length == 2
        parts.last == @app.config[:index_file]
      else
        false
      end
    end
  end
end

#directory_index?Boolean

Whether this resource is either a directory index, or has the same name as an existing directory in the source

Returns:

  • (Boolean)


81
82
83
# File 'middleman-core/lib/middleman-core/sitemap/extensions/traversal.rb', line 81

def directory_index?
  path.include?(@app.config[:index_file]) || path =~ /\/$/ || eponymous_directory?
end

#eponymous_directory?Boolean

Whether the resource has the same name as a directory in the source (e.g., if the resource is named 'gallery.html' and a path exists named 'gallery/', this would return true)

Returns:

  • (Boolean)


88
89
90
91
92
93
94
95
96
# File 'middleman-core/lib/middleman-core/sitemap/extensions/traversal.rb', line 88

def eponymous_directory?
  if !path.end_with?("/#{@app.config[:index_file]}") && destination_path.end_with?("/#{@app.config[:index_file]}")
    return true
  end

  @app.files.by_type(:source).watchers.any? do |source|
    (source.directory + Pathname(eponymous_directory_path)).directory?
  end
end

#eponymous_directory_pathString

The path for this resource if it were a directory, and not a file (e.g., for 'gallery.html' this would return 'gallery/')

Returns:

  • (String)


101
102
103
# File 'middleman-core/lib/middleman-core/sitemap/extensions/traversal.rb', line 101

def eponymous_directory_path
  path.sub(ext, '/').sub(/\/$/, '') + '/'
end

#parentMiddleman::Sitemap::Resource?

This resource's parent resource



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# File 'middleman-core/lib/middleman-core/sitemap/extensions/traversal.rb', line 17

def parent
  root = path.sub(/^#{::Regexp.escape(traversal_root)}/, '')
  parts = root.split('/')

  tail = parts.pop
  is_index = (tail == @app.config[:index_file])

  if parts.empty?
    return is_index ? nil : @store.find_resource_by_path(@app.config[:index_file])
  end

  test_expr = parts.join('\\/')
  # eponymous reverse-lookup
  found = @store.resources.find do |candidate|
    candidate.path =~ %r{^#{test_expr}(?:\.[a-zA-Z0-9]+|\/)$}
  end

  if found
    found
  else
    parts.pop if is_index
    @store.find_resource_by_destination_path("#{parts.join('/')}/#{@app.config[:index_file]}")
  end
end

#siblingsArray<Middleman::Sitemap::Resource>

This resource's sibling resources



74
75
76
77
# File 'middleman-core/lib/middleman-core/sitemap/extensions/traversal.rb', line 74

def siblings
  return [] unless parent
  parent.children.reject { |p| p == self }
end

#traversal_rootObject



5
6
7
8
9
10
11
12
13
# File 'middleman-core/lib/middleman-core/sitemap/extensions/traversal.rb', line 5

def traversal_root
  root = if !@app.extensions[:i18n]
    '/'
  else
    @app.extensions[:i18n].path_root(::I18n.locale)
  end

  root.sub(/^\//, '')
end