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:



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/middleman-core/sitemap/extensions/traversal.rb', line 26

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.index_file}", "")
    prefix    = %r|^#{base_path.sub("/", "\\/")}|
  end

  store.resources.select do |sub_resource|
    if sub_resource.path == self.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.index_file
      else
        false
      end
    end
  end
end

#directory_index? ⇒ Boolean

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

Returns:

  • (Boolean) 


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

def directory_index?
  path.include?(app.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) 


70
71
72
73
74
75
76
 
# File 'lib/middleman-core/sitemap/extensions/traversal.rb', line 70

def eponymous_directory?
  if !path.end_with?("/#{app.index_file}") && destination_path.end_with?("/#{app.index_file}")
    return true
  end
  full_path = File.join(app.source_dir, eponymous_directory_path)
  !!(File.exists?(full_path) && File.directory?(full_path))
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:



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

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

#parent ⇒ Middleman::Sitemap::Resource?

This resource’s parent resource

Returns:



10
11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/middleman-core/sitemap/extensions/traversal.rb', line 10

def parent
  parts = path.split("/")
  parts.pop if path.include?(app.index_file)

  return nil if parts.length < 1

  parts.pop
  parts << app.index_file

  parent_path = "/" + parts.join("/")

  store.find_resource_by_destination_path(parent_path)
end

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

This resource’s sibling resources

Returns:



56
57
58
59
 
# File 'lib/middleman-core/sitemap/extensions/traversal.rb', line 56

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