mirror of https://github.com/freeCodeCamp/devdocs
parent
1eaf12b94e
commit
1ac3dd93dd
@ -1,104 +1,38 @@
|
||||
module Docs
|
||||
class Node
|
||||
class EntriesFilter < Docs::EntriesFilter
|
||||
REPLACE_NAMES = {
|
||||
'addons' => 'C/C++ Addons',
|
||||
'debugger' => 'Debugger',
|
||||
'deprecations' => 'Deprecated APIs',
|
||||
'modules' => 'module' }
|
||||
|
||||
REPLACE_TYPES = {
|
||||
'C++ Addons' => 'Miscellaneous',
|
||||
'C/C++ Addons' => 'Miscellaneous',
|
||||
'Debugger' => 'Miscellaneous',
|
||||
'Deprecated APIs' => 'Miscellaneous',
|
||||
'Tracing' => 'Miscellaneous',
|
||||
'os' => 'OS',
|
||||
'StringDecoder' => 'String Decoder',
|
||||
'TLS (SSL)' => 'TLS/SSL',
|
||||
'UDP / Datagram Sockets' => 'UDP/Datagram',
|
||||
'VM (Executing JavaScript)' => 'VM',
|
||||
'Executing JavaScript' => 'VM' }
|
||||
|
||||
def get_name
|
||||
REPLACE_NAMES[slug] || slug
|
||||
type
|
||||
end
|
||||
|
||||
def get_type
|
||||
type = at_css('h1').content.strip
|
||||
type.remove! %r{\[.*\]}
|
||||
REPLACE_TYPES[type] || "#{type.first.upcase}#{type[1..-1]}"
|
||||
at_css('h2').content.strip
|
||||
end
|
||||
|
||||
def additional_entries
|
||||
return [] if type == 'Miscellaneous'
|
||||
|
||||
klass = nil
|
||||
entries = []
|
||||
|
||||
css('> [id]').each do |node|
|
||||
next if node.name == 'h1'
|
||||
|
||||
klass = nil if node.name == 'h2'
|
||||
name = node.content.strip
|
||||
name.remove! %r{\s*\[src\]}
|
||||
|
||||
# Skip constructors
|
||||
if name.start_with? 'new '
|
||||
next
|
||||
end
|
||||
|
||||
# Ignore most global objects (found elsewhere)
|
||||
if type == 'Global Objects'
|
||||
entries << [name, node['id']] if name.start_with?('_') || name == 'global'
|
||||
next
|
||||
end
|
||||
css('h3 > code, h4 > code, h5 > code').each do |node|
|
||||
|
||||
# Classes
|
||||
if name.gsub! 'Class: ', ''
|
||||
name.remove! 'events.' # EventEmitter
|
||||
klass = name
|
||||
entries << [name, node['id']]
|
||||
next
|
||||
case node.parent.child.content
|
||||
when /Class/
|
||||
entries << ["Class #{node.parent['id']}", node.parent['id'], type]
|
||||
when /Event/
|
||||
entries << ["Event #{node.parent['id']}", node.parent['id'], type]
|
||||
end
|
||||
|
||||
# Events
|
||||
if name.sub! %r{\AEvent: '(.+)'\z}, '\1'
|
||||
name << " event (#{klass || type})"
|
||||
entries << [name, node['id']]
|
||||
if node.parent.child.is_a?(Nokogiri::XML::Text)
|
||||
next
|
||||
else
|
||||
entries << [node.parent['id'], node.parent['id'], type]
|
||||
end
|
||||
|
||||
name.gsub! %r{\(.*?\);?}, '()'
|
||||
name.gsub! %r{\[.+?\]}, '[]'
|
||||
name.remove! 'assert(), ' # assert/assert.ok
|
||||
|
||||
# Skip all that start with an uppercase letter ("Example") or include a space ("exports alias")
|
||||
next unless (name.first.upcase! && !name.include?(' ')) || name.start_with?('Class Method')
|
||||
|
||||
# Differentiate server classes (http, https, net, etc.)
|
||||
name.sub!('server.') { "#{(klass || 'https').sub('.', '_').downcase}." }
|
||||
# Differentiate socket classes (net, dgram, etc.)
|
||||
name.sub!('socket.') { "#{klass.sub('.', '_').downcase}." }
|
||||
|
||||
name.remove! 'Class Method:'
|
||||
name.sub! 'buf.', 'buffer.'
|
||||
name.sub! 'buf[', 'buffer['
|
||||
name.sub! 'child.', 'childprocess.'
|
||||
name.sub! 'decoder.', 'stringdecoder.'
|
||||
name.sub! 'emitter.', 'eventemitter.'
|
||||
name.sub! %r{\Arl\.}, 'interface.'
|
||||
name.sub! 'rs.', 'readstream.'
|
||||
name.sub! 'ws.', 'writestream.'
|
||||
|
||||
# Skip duplicates (listen, connect, etc.)
|
||||
unless name == entries[-1].try(:first) || name == entries[-2].try(:first)
|
||||
entries << [name, node['id']]
|
||||
end
|
||||
end
|
||||
|
||||
entries
|
||||
end
|
||||
|
||||
end
|
||||
end
|
||||
end
|
||||
|
@ -0,0 +1,104 @@
|
||||
module Docs
|
||||
class Node
|
||||
class OldEntriesFilter < Docs::EntriesFilter
|
||||
REPLACE_NAMES = {
|
||||
'addons' => 'C/C++ Addons',
|
||||
'debugger' => 'Debugger',
|
||||
'deprecations' => 'Deprecated APIs',
|
||||
'modules' => 'module' }
|
||||
|
||||
REPLACE_TYPES = {
|
||||
'C++ Addons' => 'Miscellaneous',
|
||||
'C/C++ Addons' => 'Miscellaneous',
|
||||
'Debugger' => 'Miscellaneous',
|
||||
'Deprecated APIs' => 'Miscellaneous',
|
||||
'Tracing' => 'Miscellaneous',
|
||||
'os' => 'OS',
|
||||
'StringDecoder' => 'String Decoder',
|
||||
'TLS (SSL)' => 'TLS/SSL',
|
||||
'UDP / Datagram Sockets' => 'UDP/Datagram',
|
||||
'VM (Executing JavaScript)' => 'VM',
|
||||
'Executing JavaScript' => 'VM' }
|
||||
|
||||
def get_name
|
||||
REPLACE_NAMES[slug] || slug
|
||||
end
|
||||
|
||||
def get_type
|
||||
type = at_css('h1').content.strip
|
||||
type.remove! %r{\[.*\]}
|
||||
REPLACE_TYPES[type] || "#{type.first.upcase}#{type[1..-1]}"
|
||||
end
|
||||
|
||||
def additional_entries
|
||||
return [] if type == 'Miscellaneous'
|
||||
|
||||
klass = nil
|
||||
entries = []
|
||||
|
||||
css('> [id]').each do |node|
|
||||
next if node.name == 'h1'
|
||||
|
||||
klass = nil if node.name == 'h2'
|
||||
name = node.content.strip
|
||||
name.remove! %r{\s*\[src\]}
|
||||
|
||||
# Skip constructors
|
||||
if name.start_with? 'new '
|
||||
next
|
||||
end
|
||||
|
||||
# Ignore most global objects (found elsewhere)
|
||||
if type == 'Global Objects'
|
||||
entries << [name, node['id']] if name.start_with?('_') || name == 'global'
|
||||
next
|
||||
end
|
||||
|
||||
# Classes
|
||||
if name.gsub! 'Class: ', ''
|
||||
name.remove! 'events.' # EventEmitter
|
||||
klass = name
|
||||
entries << [name, node['id']]
|
||||
next
|
||||
end
|
||||
|
||||
# Events
|
||||
if name.sub! %r{\AEvent: '(.+)'\z}, '\1'
|
||||
name << " event (#{klass || type})"
|
||||
entries << [name, node['id']]
|
||||
next
|
||||
end
|
||||
|
||||
name.gsub! %r{\(.*?\);?}, '()'
|
||||
name.gsub! %r{\[.+?\]}, '[]'
|
||||
name.remove! 'assert(), ' # assert/assert.ok
|
||||
|
||||
# Skip all that start with an uppercase letter ("Example") or include a space ("exports alias")
|
||||
next unless (name.first.upcase! && !name.include?(' ')) || name.start_with?('Class Method')
|
||||
|
||||
# Differentiate server classes (http, https, net, etc.)
|
||||
name.sub!('server.') { "#{(klass || 'https').sub('.', '_').downcase}." }
|
||||
# Differentiate socket classes (net, dgram, etc.)
|
||||
name.sub!('socket.') { "#{klass.sub('.', '_').downcase}." }
|
||||
|
||||
name.remove! 'Class Method:'
|
||||
name.sub! 'buf.', 'buffer.'
|
||||
name.sub! 'buf[', 'buffer['
|
||||
name.sub! 'child.', 'childprocess.'
|
||||
name.sub! 'decoder.', 'stringdecoder.'
|
||||
name.sub! 'emitter.', 'eventemitter.'
|
||||
name.sub! %r{\Arl\.}, 'interface.'
|
||||
name.sub! 'rs.', 'readstream.'
|
||||
name.sub! 'ws.', 'writestream.'
|
||||
|
||||
# Skip duplicates (listen, connect, etc.)
|
||||
unless name == entries[-1].try(:first) || name == entries[-2].try(:first)
|
||||
entries << [name, node['id']]
|
||||
end
|
||||
end
|
||||
|
||||
entries
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
Loading…
Reference in new issue