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

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

Instance Method Summary collapse

Instance Method Details

#children ⇒ Array<Middleman::Sitemap::Resource>

This resource's child resources

Returns:



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/middleman-core/sitemap/extensions/traversal.rb', line 32

def children
  return [] unless directory_index?

  if eponymous_directory?
    base_path = eponymous_directory_path
    prefix    = %r{^#{base_path.sub("/", "\\/")}}
  else
    base_path = path.sub("#{@app.config[:index_file]}", '')
    prefix    = %r{^#{base_path.sub("/", "\\/")}}
  end

  @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) 


69
70
71
 
# File 'lib/middleman-core/sitemap/extensions/traversal.rb', line 69

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) 


76
77
78
79
80
81
82
83
84
 
# File 'lib/middleman-core/sitemap/extensions/traversal.rb', line 76

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_path ⇒ String

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) 


89
90
91
 
# File 'lib/middleman-core/sitemap/extensions/traversal.rb', line 89

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

#parent ⇒ Middleman::Sitemap::Resource?

This resource's parent resource

Returns:



7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/middleman-core/sitemap/extensions/traversal.rb', line 7

def parent
  parts = path.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

#siblings ⇒ Array<Middleman::Sitemap::Resource>

This resource's sibling resources

Returns:



62
63
64
65
 
# File 'lib/middleman-core/sitemap/extensions/traversal.rb', line 62

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