Class: Docs::Grunt::EntriesFilter

Inherits:
EntriesFilter show all
Defined in:
lib/docs/filters/grunt/entries.rb

Constant Summary

Constants inherited from Filter

Filter::SCHEME_RGX

Instance Method Summary collapse

Methods inherited from EntriesFilter

#build_entries, #build_entry, #call, #default_entry, #entries, #name, #path, #type

Methods inherited from Filter

#absolute_url_string?, #at_css, #at_xpath, #base_url, #css, #current_url, #fragment_url_string?, #initial_page?, #parse_html, #relative_url_string?, #root_page?, #root_path, #root_url, #slug, #subpath, #subpath_to, #xpath

Instance Method Details

#additional_entriesObject


16
17
18
19
20
21
22
23
24
25
26
27
# File 'lib/docs/filters/grunt/entries.rb', line 16

def additional_entries
  return [] unless subpath.starts_with?('api')

  css('h3').each_with_object [] do |node, entries|
    name = node.content
    name.remove! %r{\s.+\z}

    next if name == self.name

    entries << [name, node['id']]
  end
end

#get_nameObject


4
5
6
# File 'lib/docs/filters/grunt/entries.rb', line 4

def get_name
  at_css('h1').content
end

#get_typeObject


8
9
10
11
12
13
14
# File 'lib/docs/filters/grunt/entries.rb', line 8

def get_type
  if name.starts_with?('grunt') || name == 'Inside Tasks'
    name
  else
    'Miscellaneous'
  end
end

#include_default_entry?Boolean


29
30
31
# File 'lib/docs/filters/grunt/entries.rb', line 29

def include_default_entry?
  name != 'Inside Tasks'
end